cisco_node_utils 1.2.0 → 1.3.0

data/lib/cisco_node_utils/node_util.rb

@@ -15,31 +15,41 @@
 # limitations under the License.
 
 require_relative 'node'
+require_relative 'exceptions'
 
 module Cisco
   # NodeUtil - generic functionality for node utility subclasses to use
   class NodeUtil
-    # rubocop:disable Style/ClassVars
-    # We want this to be inherited to all child classes, it's a singleton.
-    @@node = nil
-    # rubocop:enable Style/ClassVars
-
     def self.node
-      # rubocop:disable Style/ClassVars
-      @@node ||= Cisco::Node.instance
-      # rubocop:enable Style/ClassVars
+      @node ||= Cisco::Node.instance
     end
 
     def node
       self.class.node
     end
 
+    def self.client
+      node.client
+    end
+
+    def client
+      node.client
+    end
+
     def self.config_get(*args)
       node.config_get(*args)
+    rescue Cisco::RequestFailed => e
+      e2 = e.class.new("[#{self}] #{e}", **e.kwargs)
+      e2.set_backtrace(e.backtrace)
+      raise e2
     end
 
     def config_get(*args)
       node.config_get(*args)
+    rescue Cisco::RequestFailed => e
+      e2 = e.class.new("[#{self}] #{e}", **e.kwargs)
+      e2.set_backtrace(e.backtrace)
+      raise e2
     end
 
     def self.config_get_default(*args)
@@ -52,14 +62,50 @@ module Cisco
 
     def self.config_set(*args)
       node.config_set(*args)
+    rescue Cisco::RequestFailed => e
+      e2 = e.class.new("[#{self}] #{e}", **e.kwargs)
+      e2.set_backtrace(e.backtrace)
+      raise e2
     end
 
     def config_set(*args)
       node.config_set(*args)
+    rescue Cisco::RequestFailed => e
+      e2 = e.class.new("[#{self}] #{e}", **e.kwargs)
+      e2.set_backtrace(e.backtrace)
+      raise e2
+    end
+
+    def self.supports?(api)
+      client.supports?(api)
+    end
+
+    def supports?(api)
+      client.supports?(api)
+    end
+
+    def self.platform
+      client.platform
+    end
+
+    def platform
+      client.platform
+    end
+
+    def get(**kwargs)
+      node.get(**kwargs)
+    rescue Cisco::RequestFailed => e
+      e2 = e.class.new("[#{self}] #{e}", **e.kwargs)
+      e2.set_backtrace(e.backtrace)
+      raise e2
+    end
+
+    def ios_xr?
+      platform == :ios_xr
     end
 
-    def show(*args)
-      node.show(*args)
+    def nexus?
+      platform == :nexus
     end
   end
 end

data/lib/cisco_node_utils/overlay_global.rb

@@ -51,6 +51,7 @@ module Cisco
     end
 
     def dup_host_ip_addr_detection_set(host_moves, timeout)
+      Feature.fabric_forwarding_enable
       Feature.nv_overlay_evpn_enable
       if host_moves == default_dup_host_ip_addr_detection_host_moves &&
          timeout == default_dup_host_ip_addr_detection_timeout
@@ -127,8 +128,7 @@ module Cisco
     def anycast_gateway_mac
       return nil unless Feature.nv_overlay_evpn_enabled?
       mac = config_get('overlay_global', 'anycast_gateway_mac')
-      # This value gets 0-padded when nvgened, so we need to convert it.
-      Utils.zero_pad_macaddr(mac).nil? ? default_anycast_gateway_mac : mac
+      mac.nil? || mac.empty? ? default_anycast_gateway_mac : mac.downcase
     end
 
     def anycast_gateway_mac=(mac_addr)

data/lib/cisco_node_utils/pim.rb

@@ -32,19 +32,7 @@ module Cisco
       @afi = Pim.afi_cli(afi)
       set_args_keys_default
 
-      Pim.feature_enable if instantiate
-    end
-
-    def self.feature_enabled
-      config_get('pim', 'feature')
-    rescue Cisco::CliError => e
-      # cmd will syntax reject when feature is not enabled
-      raise unless e.clierror =~ /Syntax error/
-      return false
-    end
-
-    def self.feature_enable
-      config_set('pim', 'feature')
+      Feature.pim_enable if instantiate
     end
 
     # self.pims returns a hash of all current pim objects.
@@ -99,6 +87,7 @@ module Cisco
     # For that reason destroy needs to explicitly set each property
     # to its default state.
     def destroy
+      return unless Feature.pim_enabled?
       self.ssm_range = ''
     end
 

data/lib/cisco_node_utils/pim_group_list.rb

@@ -93,7 +93,7 @@ module Cisco
     # Create pim grouplist instance
     # ---------------------------------
     def create
-      Pim.feature_enable unless Pim.feature_enabled
+      Feature.pim_enable
       set_args_keys(state: '')
       config_set('pim', 'group_list', @set_args)
     end

data/lib/cisco_node_utils/pim_rp_address.rb

@@ -87,7 +87,7 @@ module Cisco
     # Create pim rp_addr instance
     # ------------------------------
     def create
-      Pim.feature_enable unless Pim.feature_enabled
+      Feature.pim_enable
       set_args_keys(state: '')
       config_set('pim', 'rp_address', @set_args)
     end

data/lib/cisco_node_utils/platform.rb

@@ -19,6 +19,13 @@ require_relative 'node_util'
 module Cisco
   # Platform - class for gathering platform hardware and software information
   class Platform < NodeUtil
+    #
+    # NX: 7.0(3)I2(3) [build 7.0(3)I2(2.118)]
+    # XR: 6.1.1.04I
+    def self.image_version
+      config_get('show_version', 'version')
+    end
+
     # ex: 'n3500-uk9.6.0.2.A3.0.40.bin'
     def self.system_image
       config_get('show_version', 'boot_image')
@@ -50,23 +57,20 @@ module Cisco
     #       'used'  => '5909004K',
     #       'free'  => '10493248K' }
     def self.memory
-      total = config_get('memory', 'total')
-      used = config_get('memory', 'used')
-      free = config_get('memory', 'free')
-
-      fail 'failed to retrieve platform memory information' if
-        total.nil? || used.nil? || free.nil?
-
       {
-        'total' => total,
-        'used'  => used,
-        'free'  => free,
+        'total' => config_get('memory', 'total'),
+        'used'  => config_get('memory', 'used'),
+        'free'  => config_get('memory', 'free'),
       }
     end
 
     # Ex: 'Processor Board ID FOC15430TEY'
     def self.board
       config_get('show_version', 'board')
+    rescue RuntimeError => e
+      # Some Nexus platforms may fail to report this value.
+      return nil if /No key/ =~ e.message
+      raise
     end
 
     # Ex: '1 day(s), 21 hour(s), 46 minute(s), 54 second(s)'
@@ -79,6 +83,10 @@ module Cisco
     # Ex: '23113 usecs after  Mon Jul  1 15:24:29 2013'
     def self.last_reset
       config_get('show_version', 'last_reset_time')
+    rescue RuntimeError => e
+      # Some Nexus platforms may fail to report this value.
+      return nil if /No key/ =~ e.message
+      raise
     end
 
     # Ex: 'Reset Requested by CLI command reload'
@@ -93,7 +101,12 @@ module Cisco
     #       'sn'    => 'SAL1812NTBP' }
     def self.chassis
       node.cache_flush # TODO: investigate why this is needed
-      chas = config_get('inventory', 'chassis')
+      all = config_get('inventory', 'chassis')
+      return nil if all.nil?
+
+      # item['name'] value is "\"Chassis\"" on most platforms,
+      # but n5k/n6k use "Chassis" so make the quotes optional.
+      chas = all.find { |item| item['name'][/^"?Chassis"?$/] }
       return nil if chas.nil?
       {
         'descr' => chas['desc'].tr('"', ''),
@@ -112,16 +125,34 @@ module Cisco
     def self.inventory_of(type)
       node.cache_flush # TODO: investigate why this is needed
       inv = config_get('inventory', 'all')
-      return {} if inv.nil?
-      inv.select! { |x| x['name'].include? type }
-      return {} if inv.empty?
-      # match desired output format
       inv_hsh = {}
-      inv.each do |s|
-        inv_hsh[s['name'].tr('"', '')] = { 'descr' => s['desc'].tr('"', ''),
-                                           'pid'   => s['productid'],
-                                           'vid'   => s['vendorid'],
-                                           'sn'    => s['serialnum'] }
+      return inv_hsh if inv.nil?
+      if platform == :ios_xr
+        # XR gets a string so we have to process it directly
+        inv_arr = inv.scan(
+          /NAME:\s+"(#{type}[^"]*)",\s+
+           DESCR:\s+"([^"]*)"\s*
+           \n
+           PID:\s+(\S+)\s*,\s+
+           VID:\s+(\S+)\s*,\s+
+           SN:\s+(\S+)\s*/x).flatten
+        inv_arr.each do |entry|
+          inv_hsh[entry[0]] = { 'descr' => entry[1],
+                                'pid'   => entry[2],
+                                'vid'   => entry[3],
+                                'sn'    => entry[4] }
+        end
+      else
+        # Nexus gets structured output
+        inv.select! { |x| x['name'].include? type }
+        return inv_hsh if inv.empty?
+        # match desired output format
+        inv.each do |s|
+          inv_hsh[s['name'].tr('"', '')] = { 'descr' => s['desc'].tr('"', ''),
+                                             'pid'   => s['productid'],
+                                             'vid'   => s['vendorid'],
+                                             'sn'    => s['serialnum'] }
+        end
       end
       inv_hsh
     end
@@ -158,7 +189,7 @@ module Cisco
     #      { ... }}
     def self.virtual_services
       virts = config_get('virtual_service', 'services')
-      return [] if virts.nil?
+      return {} if virts.nil?
       # NXAPI returns hash instead of array if there's only 1
       virts = [virts] if virts.is_a? Hash
       # convert to expected format

data/lib/cisco_node_utils/portchannel_global.rb

@@ -27,6 +27,10 @@ module Cisco
       @name = name.downcase
     end
 
+    def to_s
+      "portchannel_global #{name}"
+    end
+
     def self.globals
       { 'default' => PortChannelGlobal.new('default') }
     end
@@ -35,6 +39,10 @@ module Cisco
     #                      PROPERTIES                      #
     ########################################################
 
+    def load_balance_type
+      config_get('portchannel_global', 'load_balance_type')
+    end
+
     def hash_distribution
       config_get('portchannel_global', 'hash_distribution')
     end
@@ -42,8 +50,6 @@ module Cisco
     def hash_distribution=(val)
       config_set('portchannel_global',
                  'hash_distribution', val)
-    rescue Cisco::CliError => e
-      raise "[#{@name}] '#{e.command}' : #{e.clierror}"
     end
 
     def default_hash_distribution
@@ -56,8 +62,6 @@ module Cisco
 
     def load_defer=(val)
       config_set('portchannel_global', 'load_defer', val)
-    rescue Cisco::CliError => e
-      raise "[#{@name}] '#{e.command}' : #{e.clierror}"
     end
 
     def default_load_defer
@@ -72,8 +76,6 @@ module Cisco
       fail TypeError unless state == true || state == false
       no_cmd = (state ? '' : 'no')
       config_set('portchannel_global', 'resilient', no_cmd)
-    rescue Cisco::CliError => e
-      raise "[#{@name}] '#{e.command}' : #{e.clierror}"
     end
 
     def default_resilient
@@ -105,10 +107,14 @@ module Cisco
         params = line.split
         lb_type = config_get('portchannel_global', 'load_balance_type')
         case lb_type.to_sym
+        when :no_rotate # n3k
+          _parse_no_rotate_params(hash, params, line)
         when :ethernet # n6k
           _parse_ethernet_params(hash, params)
         when :asymmetric # n7k
           _parse_asymmetric_params(hash, params, line)
+        when :no_hash # n8k
+          _parse_no_hash_params(hash, params)
         when :symmetry # n9k
           _parse_symmetry_params(hash, params, line)
         end
@@ -156,11 +162,6 @@ module Cisco
       port_channel_load_balance[:hash_poly]
     end
 
-    def default_hash_poly
-      config_get_default('portchannel_global',
-                         'hash_poly')
-    end
-
     def rotate
       port_channel_load_balance[:rotate]
     end
@@ -182,6 +183,19 @@ module Cisco
     def port_channel_load_balance=(bselect, bhash, hpoly, asy, sy, conc, rot)
       lb_type = config_get('portchannel_global', 'load_balance_type')
       case lb_type.to_sym
+      when :no_rotate # n3k
+        sym = sy ? 'symmetric' : ''
+        if bselect == 'src'
+          sel = 'source'
+        elsif bselect == 'dst'
+          sel = 'destination'
+        else
+          sel = 'source-dest'
+        end
+        sel_hash = sel + '-' + bhash
+        # port-channel load-balance ethernet source-dest-ip symmetric
+        config_set('portchannel_global', 'port_channel_load_balance',
+                   'ethernet', sel_hash, sym, '', '', '')
       when :ethernet # n6k
         if bselect == 'src'
           sel = 'source'
@@ -199,6 +213,12 @@ module Cisco
         # port-channel load-balance dst ip-l4port rotate 4 asymmetric
         config_set('portchannel_global', 'port_channel_load_balance',
                    bselect, bhash, 'rotate', rot.to_s, asym, '')
+      when :no_hash # n8k
+        # port-channel load-balance dst ip-l4port rotate 4
+        rot_str = rot.zero? ? '' : 'rotate'
+        rot_val = rot.zero? ? '' : rot.to_s
+        config_set('portchannel_global', 'port_channel_load_balance',
+                   bselect, bhash, rot_str, rot_val, '', '')
       when :symmetry # n9k
         sym = sy ? 'symmetric' : ''
         concat = conc ? 'concatenation' : ''
@@ -208,19 +228,58 @@ module Cisco
         config_set('portchannel_global', 'port_channel_load_balance',
                    bselect, bhash, rot_str, rot_val, concat, sym)
       end
-    rescue Cisco::CliError => e
-      raise "[#{@name}] '#{e.command}' : #{e.clierror}"
     end
 
-    # on n6k, the bundle hash and bundle select are
-    # merged into one and so we need to break them apart,
-    # also they are called source and destination instead of
-    # src and dst as in other devices, so we convert them
+    # N3k: The bundle hash and bundle select are merged into one output;
+    # also note that the field names are source & destination instead of
+    # src & dst as in other devices.
+    def _parse_no_rotate_params(hash, params, line)
+      sym = (line.include? 'symmetric') ? true : false
+
+      select_hash = params[1]
+      lparams = select_hash.split('-')
+      if lparams[0].downcase == 'destination'
+        bselect = 'dst'
+        bhash = lparams[1]
+        # there are bundles hashes like ip-gre which
+        # need extra processing
+        bhash += '-gre' if select_hash.include? 'gre'
+      else
+        if select_hash.include? '-dest-'
+          bselect = 'src-dst'
+          bhash = lparams[2]
+          bhash += '-gre' if select_hash.include? 'gre'
+          # there are bundles hashes like ip-only and
+          # port-only specific to src-dst
+          bhash += '-only' if select_hash.include? 'only'
+        else
+          bselect = 'src'
+          bhash = lparams[1]
+          # there are bundles hashes like ip-gre which
+          # need extra processing
+          bhash += '-gre' if select_hash.include? 'gre'
+        end
+      end
+      hash[:bundle_select] = bselect
+      hash[:bundle_hash] = bhash
+      hash[:symmetry] = sym
+      hash
+    end
+
+    # N5k/N6k: The bundle hash and bundle select are merged into one output;
+    # also note that the field names are source & destination instead of
+    # src & dst as in other devices.
     def _parse_ethernet_params(hash, params)
       hash_poly = params[2]
-      # hash_poly is not shown on the running config
-      # if it is default under some circumstatnces
+
+      # Depending on the chipset, hash_poly may have have a different
+      # default value within the same platform family (this is done to
+      # avoid polarization) but there is currently no command available
+      # to dynamically determine the default state. As a result the
+      # getter simply hard-codes a default value which means it may
+      # encounter occasional idempotence issues.
       hash_poly = hash_poly.nil? ? 'CRC10b' : hash_poly
+
       select_hash = params[1]
       lparams = select_hash.split('-')
       if lparams[0].downcase == 'destination'
@@ -258,6 +317,17 @@ module Cisco
       hash
     end
 
+    def _parse_no_hash_params(hash, params)
+      bselect = params[0]
+      bhash = params[1]
+      ri = params.index('rotate')
+      rotate = params[ri + 1].to_i
+      hash[:bundle_select] = bselect
+      hash[:bundle_hash] = bhash
+      hash[:rotate] = rotate
+      hash
+    end
+
     def _parse_symmetry_params(hash, params, line)
       bselect = params[0]
       bhash = params[1]