cisco_node_utils 1.10.0 → 2.0.0

data/lib/cisco_node_utils/interface.rb

@@ -1085,7 +1085,7 @@ module Cisco
     end
 
     def storm_control_multicast=(val)
-      return if val == storm_control_broadcast
+      return if val == storm_control_multicast
       state = val == default_storm_control_multicast ? 'no' : ''
       level = val == default_storm_control_multicast ? '' : val
       config_set('interface', 'storm_control_multicast',
@@ -1102,7 +1102,7 @@ module Cisco
     end
 
     def storm_control_unicast=(val)
-      return if val == storm_control_broadcast
+      return if val == storm_control_unicast
       state = val == default_storm_control_unicast ? 'no' : ''
       level = val == default_storm_control_unicast ? '' : val
       config_set('interface', 'storm_control_unicast',
@@ -2025,7 +2025,7 @@ module Cisco
     end
 
     def vpc_peer_link=(state)
-      return if vpc_peerlink == state
+      return if vpc_peer_link == state
       no_cmd = (state ? '' : 'no')
       config_set('interface', 'vpc_peer_link', name: @name, state: no_cmd)
     end

data/lib/cisco_node_utils/interface_service_vni.rb

@@ -36,7 +36,7 @@ module Cisco
 
     def self.svc_vni_ids
       hash = {}
-      intf_list = config_get('interface', 'all_interfaces')
+      intf_list = config_get('interface_service_vni', 'all_interfaces')
       return hash if intf_list.nil?
 
       intf_list.each do |intf|

data/lib/cisco_node_utils/node.rb

@@ -237,6 +237,11 @@ module Cisco
       @instance ||= new
     end
 
+    # Allow instance cache to be reset
+    def self.reset_instance
+      @instance = nil
+    end
+
     def initialize
       @client = Cisco::Client.create
       @cmd_ref = nil
@@ -357,33 +362,17 @@ module Cisco
 
     def prod_qualifier(prod, inventory)
       case prod
-      when /N9K/
-        # Two datapoints are used to determine if the current n9k
-        # platform is a fretta based n9k or non-fretta.
+      when /N(3|9)K/
+        # one datapoint is used to determine if the current n9k/n3k
+        # platform is a fretta based or non-fretta.
         #
-        # 1) Image Version == 7.0(3)F*
-        # 2) Fabric Module == N9K-C9*-FM-R
-        if @cmd_ref
-          ver = os_version
-        else
-          ver = get(command:     'show version',
-                    data_format: :nxapi_structured)['kickstart_ver_str']
-        end
-        # Append -F for fretta platform.
+        # Module == *-R
         inventory.each do |row|
-          if row['productid'][/N9K-C9...-FM-R/] && ver[/7.0\(3\)F/]
+          if row['productid'][/-R/]
+            # Append -F for fretta platform.
             return prod.concat('-F') unless prod[/-F/]
           end
         end
-      when /N3K/
-        if @cmd_ref
-          ver = os_version
-        else
-          ver = get(command:     'show version',
-                    data_format: :nxapi_structured)['kickstart_ver_str']
-        end
-        # Append -F for fretta platform.
-        return prod.concat('-F') if ver[/7.0\(3\)F/] && !prod[/-F/]
       end
       prod
     end

data/lib/cisco_node_utils/node_util.rb

@@ -21,7 +21,7 @@ module Cisco
   # NodeUtil - generic functionality for node utility subclasses to use
   class NodeUtil
     def self.node
-      @node ||= Cisco::Node.instance
+      Cisco::Node.instance
     end
 
     def node

data/lib/cisco_node_utils/radius_global.rb

@@ -103,8 +103,7 @@ module Cisco
     def key
       str = config_get('radius_global', 'key')
       return if str.nil?
-      str = str.strip
-      Utils.add_quotes(str)
+      str.strip
     end
 
     def key_set(value, format)
@@ -119,10 +118,11 @@ module Cisco
       end
 
       if value.nil? && !key.nil?
+        value = Utils.add_quotes(key)
         config_set('radius_global',
                    'key',
                    state: 'no',
-                   key:   "#{key_format} #{key}")
+                   key:   "#{key_format} #{value}")
       elsif !format.nil?
         value = Utils.add_quotes(value)
         config_set('radius_global',

data/lib/cisco_node_utils/radius_server.rb

@@ -372,8 +372,7 @@ module Cisco
       return if val.nil? || val.empty?
       index = val.index('auth-port')
       val = val[0..index - 2] unless index.nil?
-      val = val.strip
-      Utils.add_quotes(val)
+      val.strip
     end
 
     def key_set(value, format)

data/lib/cisco_node_utils/route_map.rb

@@ -309,7 +309,7 @@ module Cisco
     # match source-protocol tcp udp
     def match_src_proto
       str = config_get('route_map', 'match_src_proto', @get_args)
-      str.empty? ? default_match_src_proto : str.split
+      str.empty? ? default_match_src_proto : str.split.sort
     end
 
     def match_src_proto=(list)

data/lib/cisco_node_utils/router_ospf_vrf.rb

@@ -41,11 +41,7 @@ module Cisco
       @router = router
       @name = name
       @parent = {}
-      if @name == 'default'
-        @get_args = @set_args = { name: @router }
-      else
-        @get_args = @set_args = { name: @router, vrf: @name }
-      end
+      set_args_keys_default
 
       create if instantiate
     end
@@ -87,6 +83,24 @@ module Cisco
       list.each { |key| @set_args.delete(key) }
     end
 
+    #
+    # Helper methods to delete @set_args hash keys
+    #
+    def set_args_keys_default
+      keys = { name: @router }
+      keys[:vrf] = @name unless @name == 'default'
+      @get_args = @set_args = keys
+    end
+
+    def set_args_keys(hash={}) # rubocop:disable Style/AccessorMethodName
+      set_args_keys_default
+      @set_args = @get_args.merge!(hash) unless hash.empty?
+    end
+
+    ########################################################
+    #                      PROPERTIES                      #
+    ########################################################
+
     def auto_cost
       match = config_get('ospf', 'auto_cost', @get_args)
       return default_auto_cost if match.nil?
@@ -168,6 +182,36 @@ module Cisco
       config_get_default('ospf', 'log_adjacency')
     end
 
+    #
+    # Redistribute
+    #
+
+    # Build an array of all redistribute commands currently on the device
+    def redistribute
+      c = config_get('ospf', 'redistribute', @get_args)
+      c.nil? ? nil : c.each(&:compact!).sort
+    end
+
+    # redistribute setter.
+    # Process a hash of redistribute commands from delta_add_remove().
+    def redistribute=(should)
+      delta_hash = Utils.delta_add_remove(should, redistribute)
+      return if delta_hash.values.flatten.empty?
+      [:add, :remove].each do |action|
+        Cisco::Logger.debug("redistribute delta #{@get_args}\n #{action}: " \
+                            "#{delta_hash[action]}")
+        delta_hash[action].each do |protocol, route_map|
+          state = (action == :add) ? '' : 'no'
+          set_args_keys(state: state, protocol: protocol, route_map: route_map)
+          config_set('ospf', 'redistribute', @set_args)
+        end
+      end
+    end
+
+    def default_redistribute
+      config_get_default('ospf', 'redistribute')
+    end
+
     def router_id
       config_get('ospf', 'router_id', @get_args)
     end

data/lib/cisco_node_utils/tacacs_global.rb

@@ -79,8 +79,7 @@ module Cisco
       return nil unless Feature.tacacs_enabled?
       str = config_get('tacacs_global', 'key')
       return TacacsGlobal.default_key if str.empty?
-      str = str[1].strip
-      Utils.add_quotes(str)
+      str[1].strip.gsub(/\"/, '')
     end
 
     # Get default encryption password

data/lib/cisco_node_utils/tacacs_server.rb

@@ -143,8 +143,7 @@ module Cisco
     def encryption_password
       str = config_get('tacacs_server', 'encryption_password')
       return TacacsServer.default_encryption_password if str.empty?
-      str = str[1].strip
-      Utils.add_quotes(str)
+      str[1].strip
     end
 
     # Get default encryption password

data/lib/cisco_node_utils/tacacs_server_host.rb

@@ -147,8 +147,7 @@ module Cisco
       return str if str.nil? || str.empty?
       index = str.index('port')
       str = str[0..index - 2] unless index.nil?
-      str = str.strip
-      Utils.add_quotes(str)
+      str.strip
     end
 
     def self.default_encryption_password

data/lib/cisco_node_utils/version.rb

@@ -14,7 +14,7 @@
 
 # Container module for version number only.
 module CiscoNodeUtils
-  VERSION = '1.10.0'
+  VERSION = '2.0.0'
   gem_version = Gem::Version.new(Gem::VERSION)
   min_gem_version = Gem::Version.new('2.1.0')
   fail 'Required rubygems version >= 2.1.0' if gem_version < min_gem_version

data/lib/cisco_node_utils/vlan.rb

@@ -229,7 +229,7 @@ module Cisco
       Feature.vn_segment_vlan_based_enable
       # Remove the existing mapping first as cli doesn't support overwriting.
       config_set('vlan', 'mapped_vni', vlan: @vlan_id,
-                         state: 'no', vni: vni)
+                         state: 'no', vni: vni) unless mapped_vni.to_s.empty?
       # Configure the new mapping
       state = vni == default_mapped_vni ? 'no' : ''
       config_set('vlan', 'mapped_vni', vlan: @vlan_id,

data/lib/cisco_node_utils/vxlan_vtep.rb

@@ -3,7 +3,7 @@
 #
 # November 2015, Deepak Cherian
 #
-# Copyright (c) 2015-2016 Cisco and/or its affiliates.
+# Copyright (c) 2015-2018 Cisco and/or its affiliates.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -181,10 +181,10 @@ module Cisco
     def multisite_border_gateway_interface=(val)
       set_args = { name: @name }
       set_args[:state] = val.empty? ? 'no' : ''
-      set_args[:lpbk_intf] = val.empty? ? 'loopback0' : val
+      # rubocop:disable LineLength
+      set_args[:lpbk_intf] = val.empty? ? multisite_border_gateway_interface : val
+      # rubocop:enable LineLength
       if set_args[:state] == 'no'
-        # 'no multisite border-gateway' doesn't work without interface
-        # defaulting to 'loopback0' still clears any configuration
         intf = multisite_border_gateway_interface
         unless intf == default_multisite_border_gateway_interface
           config_set('vxlan_vtep', 'multisite_bg_intf', set_args)
@@ -197,5 +197,90 @@ module Cisco
     def default_multisite_border_gateway_interface
       config_get_default('vxlan_vtep', 'multisite_bg_intf')
     end
+
+    def global_ingress_replication_bgp
+      config_get('vxlan_vtep', 'global_ingress_replication_bgp', name: @name)
+    end
+
+    def global_ingress_replication_bgp=(state)
+      set_args = { name: @name }
+      if state
+        set_args[:state] = ''
+        # Host reachability must be enabled for this property
+        unless VxlanVtep.new(@name).host_reachability == 'evpn'
+          fail "Dependency: vxlan_vtep host_reachability must be 'evpn'."
+        end
+        config_set('vxlan_vtep', 'global_ingress_replication_bgp', set_args)
+      else
+        set_args[:state] = 'no'
+        config_set('vxlan_vtep',
+                   'global_ingress_replication_bgp', set_args) if
+                   global_ingress_replication_bgp
+      end
+    end
+
+    def default_global_ingress_replication_bgp
+      config_get_default('vxlan_vtep', 'global_ingress_replication_bgp')
+    end
+
+    def global_suppress_arp
+      config_get('vxlan_vtep', 'global_suppress_arp', name: @name)
+    end
+
+    def global_suppress_arp=(state)
+      set_args = { name: @name }
+      if state
+        set_args[:state] = ''
+        # Host reachability must be enabled for this property
+        unless VxlanVtep.new(@name).host_reachability == 'evpn'
+          fail "Dependency: vxlan_vtep host_reachability must be 'evpn'."
+        end
+        Feature.nv_overlay_evpn_enable if
+        Feature.nv_overlay_evpn_supported? && !Feature.nv_overlay_evpn_enabled?
+        config_set('vxlan_vtep', 'global_suppress_arp', set_args)
+      else
+        set_args[:state] = 'no'
+        config_set('vxlan_vtep',
+                   'global_suppress_arp', set_args) if global_suppress_arp
+      end
+    end
+
+    def default_global_suppress_arp
+      config_get_default('vxlan_vtep', 'global_suppress_arp')
+    end
+
+    def global_mcast_group_l2
+      config_get('vxlan_vtep', 'global_mcast_group_l2', name: @name)
+    end
+
+    def global_mcast_group_l2=(val)
+      if val
+        set_args = { name: @name, ip: val, state: '' }
+      else
+        set_args = { name: @name, ip: '', state: 'no' }
+      end
+      config_set('vxlan_vtep', 'global_mcast_group_l2', set_args)
+    end
+
+    def default_global_mcast_group_l2
+      config_get_default('vxlan_vtep', 'global_mcast_group_l2')
+    end
+
+    def global_mcast_group_l3
+      config_get('vxlan_vtep', 'global_mcast_group_l3', name: @name)
+    end
+
+    def global_mcast_group_l3=(val)
+      if val
+        set_args = { name: @name, ip: val, state: '' }
+      else
+        set_args = { name: @name, ip: '', state: 'no' }
+      end
+      config_set('vxlan_vtep', 'global_mcast_group_l3', set_args)
+    end
+
+    def default_global_mcast_group_l3
+      config_get_default('vxlan_vtep', 'global_mcast_group_l3')
+    end
   end  # Class
 end    # Module

data/lib/cisco_node_utils/vxlan_vtep_vni.rb

@@ -3,7 +3,7 @@
 #
 # November 2015 Michael G Wiebe
 #
-# Copyright (c) 2015-2016 Cisco and/or its affiliates.
+# Copyright (c) 2015-2018 Cisco and/or its affiliates.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -252,6 +252,37 @@ module Cisco
       config_get_default('vxlan_vtep_vni', 'suppress_arp')
     end
 
+    def suppress_arp_disable
+      # suppress_arp_disable is really a boolean kind, however,
+      # since the get is looking for a string with 'disable'
+      # we have to treat it as string first and then massage it
+      # to boolean
+      str = config_get('vxlan_vtep_vni', 'suppress_arp_disable', @get_args)
+      str.nil? ? false : true
+    end
+
+    def suppress_arp_disable=(state)
+      if state
+        set_args_keys(state: '')
+        # Host reachability must be enabled for this property
+        unless VxlanVtep.new(@name).host_reachability == 'evpn'
+          fail "Dependency: vxlan_vtep host_reachability must be 'evpn'."
+        end
+        Feature.nv_overlay_evpn_enable if
+        Feature.nv_overlay_evpn_supported? && !Feature.nv_overlay_evpn_enabled?
+        config_set('vxlan_vtep_vni', 'suppress_arp_disable', @set_args)
+      else
+        set_args_keys(state: 'no')
+        # Remove suppress-arp-disable only if it is configured.
+        config_set('vxlan_vtep_vni', 'suppress_arp_disable', @set_args) if
+        suppress_arp_disable
+      end
+    end
+
+    def default_suppress_arp_disable
+      config_get_default('vxlan_vtep_vni', 'suppress_arp_disable')
+    end
+
     def suppress_uuc
       config_get('vxlan_vtep_vni', 'suppress_uuc', @get_args)
     end

data/spec/schema.yaml

@@ -12,6 +12,7 @@ mapping:
           - 'ios_xr'
           - 'nexus'
           # Product IDs
+          - 'C3048'
           - 'C3064'
           - 'C3132'
           - 'C3172'
@@ -31,6 +32,7 @@ mapping:
       # Platform and product filters
       ios_xr: *base
       nexus: *base
+      C3048: *base
       C3064: *base
       C3132: *base
       C3172: *base

data/tests/basetest.rb

@@ -85,6 +85,38 @@ class TestCase < Minitest::Test
     self.class.password
   end
 
+  def self.telnet_port
+    Cisco::Environment.environment[:telnet_port] || 23
+  end
+
+  def telnet_port
+    self.class.telnet_port
+  end
+
+  def self.port
+    Cisco::Environment.environment[:port] || address.split(':')[1]
+  end
+
+  def port
+    self.class.port
+  end
+
+  def self.transport
+    Cisco::Environment.environment[:transport] || 'http'
+  end
+
+  def transport
+    self.class.transport
+  end
+
+  def self.verify_mode
+    Cisco::Environment.environment[:verify_mode] || 'none'
+  end
+
+  def verify_mode
+    self.class.verify_mode
+  end
+
   def setup
     # Hack - populate environment from user-entered values from basetest.rb
     if Cisco::Environment.environments.empty?
@@ -92,13 +124,17 @@ class TestCase < Minitest::Test
         attr_writer :environments
       end
       Cisco::Environment.environments['default'] = {
-        host:     address.split(':')[0],
-        port:     address.split(':')[1],
-        username: username,
-        password: password,
+        host:        address.split(':')[0],
+        port:        port,
+        telnet_port: telnet_port,
+        transport:   transport,
+        verify_mode: verify_mode,
+        username:    username,
+        password:    password,
       }
     end
     @device = Net::Telnet.new('Host'    => address.split(':')[0],
+                              'Port'    => telnet_port,
                               'Timeout' => 240,
                               # NX-OS has a space after '#', IOS XR does not
                               'Prompt'  => /[$%#>] *\z/n,