cisco_node_utils 1.6.0 → 1.7.0

data/lib/cisco_node_utils/route_map.rb

@@ -453,31 +453,6 @@ module Cisco
       config_get_default('route_map', 'match_ipv4_route_src_prefix_list')
     end
 
-    # extract value of property from match ip multicast
-    def extract_value(type, prop, prefix=nil)
-      prefix = prop if prefix.nil?
-      match =
-        type == 'ipv4' ? match_ipv4_multicast_get : match_ipv6_multicast_get
-
-      # matching not found
-      return nil if match.nil? # no matching found
-
-      # property not defined for matching
-      return nil unless match.names.include?(prop)
-
-      # extract and return value that follows prefix + <space>
-      regexp = Regexp.new("#{Regexp.escape(prefix)} (?<extracted>.*)")
-      value_match = regexp.match(match[prop])
-      return nil if value_match.nil?
-      value_match[:extracted]
-    end
-
-    # prepend property name prefix/keyword to value
-    def attach_prefix(val, prop, prefix=nil)
-      prefix = prop.to_s if prefix.nil?
-      @set_args[prop] = val.to_s.empty? ? val : "#{prefix} #{val}"
-    end
-
     # match ip multicast source 242.1.1.1/32 group 239.2.2.2/32 rp 242.1.1.1/32
     #                    rp-type ASM
     # match ip multicast source 242.1.1.1/32 group-range
@@ -495,13 +470,13 @@ module Cisco
     end
 
     def match_ipv4_multicast_src_addr
-      val = extract_value('ipv4', 'src', 'source')
+      val = Utils.extract_value(match_ipv4_multicast_get, 'src', 'source')
       return default_match_ipv4_multicast_src_addr if val.nil?
       val
     end
 
     def match_ipv4_multicast_src_addr=(src_addr)
-      attach_prefix(src_addr, :source)
+      @set_args[:source] = Utils.attach_prefix(src_addr, :source)
     end
 
     def default_match_ipv4_multicast_src_addr
@@ -509,13 +484,13 @@ module Cisco
     end
 
     def match_ipv4_multicast_group_addr
-      val = extract_value('ipv4', 'grp', 'group')
+      val = Utils.extract_value(match_ipv4_multicast_get, 'grp', 'group')
       return default_match_ipv4_multicast_group_addr if val.nil?
       val
     end
 
     def match_ipv4_multicast_group_addr=(grp_addr)
-      attach_prefix(grp_addr, :group)
+      @set_args[:group] = Utils.attach_prefix(grp_addr, :group)
     end
 
     def default_match_ipv4_multicast_group_addr
@@ -523,13 +498,15 @@ module Cisco
     end
 
     def match_ipv4_multicast_group_range_begin_addr
-      val = extract_value('ipv4', 'grp_range_start', 'group-range')
+      val = Utils.extract_value(match_ipv4_multicast_get,
+                                'grp_range_start', 'group-range')
       return default_match_ipv4_multicast_group_range_begin_addr if val.nil?
       val
     end
 
     def match_ipv4_multicast_group_range_begin_addr=(begin_addr)
-      attach_prefix(begin_addr, :group_range, :'group-range')
+      @set_args[:group_range] =
+          Utils.attach_prefix(begin_addr, :group_range, :'group-range')
     end
 
     def default_match_ipv4_multicast_group_range_begin_addr
@@ -538,13 +515,13 @@ module Cisco
     end
 
     def match_ipv4_multicast_group_range_end_addr
-      val = extract_value('ipv4', 'grp_range_end', 'to')
+      val = Utils.extract_value(match_ipv4_multicast_get, 'grp_range_end', 'to')
       return default_match_ipv4_multicast_group_range_end_addr if val.nil?
       val
     end
 
     def match_ipv4_multicast_group_range_end_addr=(end_addr)
-      attach_prefix(end_addr, :to)
+      @set_args[:to] = Utils.attach_prefix(end_addr, :to)
     end
 
     def default_match_ipv4_multicast_group_range_end_addr
@@ -553,13 +530,13 @@ module Cisco
     end
 
     def match_ipv4_multicast_rp_addr
-      val = extract_value('ipv4', 'rp')
+      val = Utils.extract_value(match_ipv4_multicast_get, 'rp')
       return default_match_ipv4_multicast_rp_addr if val.nil?
       val
     end
 
     def match_ipv4_multicast_rp_addr=(rp_addr)
-      attach_prefix(rp_addr, :rp)
+      @set_args[:rp] = Utils.attach_prefix(rp_addr, :rp)
     end
 
     def default_match_ipv4_multicast_rp_addr
@@ -567,13 +544,13 @@ module Cisco
     end
 
     def match_ipv4_multicast_rp_type
-      val = extract_value('ipv4', 'rp_type', 'rp-type')
+      val = Utils.extract_value(match_ipv4_multicast_get, 'rp_type', 'rp-type')
       return default_match_ipv4_multicast_rp_type if val.nil?
       val
     end
 
     def match_ipv4_multicast_rp_type=(type)
-      attach_prefix(type, :rp_type, :'rp-type')
+      @set_args[:rp_type] = Utils.attach_prefix(type, :rp_type, :'rp-type')
     end
 
     def default_match_ipv4_multicast_rp_type
@@ -750,13 +727,13 @@ module Cisco
     end
 
     def match_ipv6_multicast_src_addr
-      val = extract_value('ipv6', 'src', 'source')
+      val = Utils.extract_value(match_ipv6_multicast_get, 'src', 'source')
       return default_match_ipv6_multicast_src_addr if val.nil?
       val
     end
 
     def match_ipv6_multicast_src_addr=(src_addr)
-      attach_prefix(src_addr, :source)
+      @set_args[:source] = Utils.attach_prefix(src_addr, :source)
     end
 
     def default_match_ipv6_multicast_src_addr
@@ -764,13 +741,13 @@ module Cisco
     end
 
     def match_ipv6_multicast_group_addr
-      val = extract_value('ipv6', 'grp', 'group')
+      val = Utils.extract_value(match_ipv6_multicast_get, 'grp', 'group')
       return default_match_ipv6_multicast_group_addr if val.nil?
       val
     end
 
     def match_ipv6_multicast_group_addr=(grp_addr)
-      attach_prefix(grp_addr, :group)
+      @set_args[:group] = Utils.attach_prefix(grp_addr, :group)
     end
 
     def default_match_ipv6_multicast_group_addr
@@ -778,13 +755,15 @@ module Cisco
     end
 
     def match_ipv6_multicast_group_range_begin_addr
-      val = extract_value('ipv6', 'grp_range_start', 'group-range')
+      val = Utils.extract_value(match_ipv6_multicast_get,
+                                'grp_range_start', 'group-range')
       return default_match_ipv6_multicast_group_range_begin_addr if val.nil?
       val
     end
 
     def match_ipv6_multicast_group_range_begin_addr=(begin_addr)
-      attach_prefix(begin_addr, :group_range, :'group-range')
+      @set_args[:group_range] =
+          Utils.attach_prefix(begin_addr, :group_range, :'group-range')
     end
 
     def default_match_ipv6_multicast_group_range_begin_addr
@@ -793,13 +772,13 @@ module Cisco
     end
 
     def match_ipv6_multicast_group_range_end_addr
-      val = extract_value('ipv6', 'grp_range_end', 'to')
+      val = Utils.extract_value(match_ipv6_multicast_get, 'grp_range_end', 'to')
       return default_match_ipv6_multicast_group_range_end_addr if val.nil?
       val
     end
 
     def match_ipv6_multicast_group_range_end_addr=(end_addr)
-      attach_prefix(end_addr, :to)
+      @set_args[:to] = Utils.attach_prefix(end_addr, :to)
     end
 
     def default_match_ipv6_multicast_group_range_end_addr
@@ -808,13 +787,13 @@ module Cisco
     end
 
     def match_ipv6_multicast_rp_addr
-      val = extract_value('ipv6', 'rp')
+      val = Utils.extract_value(match_ipv6_multicast_get, 'rp')
       return default_match_ipv6_multicast_rp_addr if val.nil?
       val
     end
 
     def match_ipv6_multicast_rp_addr=(rp_addr)
-      attach_prefix(rp_addr, :rp)
+      @set_args[:rp] = Utils.attach_prefix(rp_addr, :rp)
     end
 
     def default_match_ipv6_multicast_rp_addr
@@ -822,13 +801,13 @@ module Cisco
     end
 
     def match_ipv6_multicast_rp_type
-      val = extract_value('ipv6', 'rp_type', 'rp-type')
+      val = Utils.extract_value(match_ipv6_multicast_get, 'rp_type', 'rp-type')
       return default_match_ipv6_multicast_rp_type if val.nil?
       val
     end
 
     def match_ipv6_multicast_rp_type=(type)
-      attach_prefix(type, :rp_type, :'rp-type')
+      @set_args[:rp_type] = Utils.attach_prefix(type, :rp_type, :'rp-type')
     end
 
     def default_match_ipv6_multicast_rp_type
@@ -1596,14 +1575,17 @@ module Cisco
     end
 
     def set_metric_set(plus, bndw, del, reliability, eff_bw, mtu)
-      state = bndw ? '' : 'no'
+      set_args_keys(state: 'no', additive: '', bw: '', delay: '',
+                    rel: '', eff: '', mtu: '')
+      config_set('route_map', 'set_metric', @set_args)
+      return unless bndw
       additive = plus ? '+' : ''
       bw = bndw ? bndw : ''
       delay = del ? del : ''
       rel = reliability ? reliability : ''
       eff = eff_bw ? eff_bw : ''
       lmtu = mtu ? mtu : ''
-      set_args_keys(state: state, additive: additive, bw: bw, delay: delay,
+      set_args_keys(state: '', additive: additive, bw: bw, delay: delay,
                     rel: rel, eff: eff, mtu: lmtu)
       config_set('route_map', 'set_metric', @set_args)
     end

data/lib/cisco_node_utils/snmpuser.rb

@@ -241,7 +241,7 @@ module Cisco
         # Retrieve password hashes
         hashed_pw = SnmpUser.auth_password('dummy_user', @engine_id)
         if hashed_pw.nil?
-          fail "SNMP dummy user #{dummy_user} #{@engine_id} was configured " \
+          fail "SNMP dummy user dummy_user #{@engine_id} was configured " \
                "but password is missing?\n" \
                + @@node.get(command: 'show run snmp all')
         end
@@ -289,7 +289,7 @@ module Cisco
         dummyau = SnmpUser.auth_password('dummy_user', @engine_id)
         hashed_pw = SnmpUser.priv_password('dummy_user', @engine_id)
         if hashed_pw.nil?
-          fail "SNMP dummy user #{dummy_user} #{@engine_id} was configured " \
+          fail "SNMP dummy user dummy_user #{@engine_id} was configured " \
                "but password is missing?\n" \
                + @@node.get(command: 'show run snmp all')
         end

data/lib/cisco_node_utils/span_session.rb

@@ -0,0 +1,149 @@
+# Insert appropriate license here
+require_relative 'node_util'
+require_relative 'interface'
+
+module Cisco
+  # node utils class for SPAN (switchport analyzer) sessions
+  class SpanSession < NodeUtil
+    attr_reader :session_id
+
+    def initialize(session_id, instantiate=true)
+      validate_args(session_id.to_i)
+      create if instantiate
+    end
+
+    def self.sessions
+      hash = {}
+      all = config_get('span_session', 'all_sessions')
+      return hash if all.nil?
+
+      all.each do |id|
+        hash[id] = SpanSession.new(id, false)
+      end
+      hash
+    end
+
+    def validate_args(session_id)
+      fail TypeError unless session_id.is_a?(Integer)
+      @session_id = session_id
+    end
+
+    def create
+      config_set('span_session', 'create', id: @session_id)
+    end
+
+    def destroy
+      config_set('span_session', 'destroy', id: @session_id)
+    end
+
+    def description
+      config_get('span_session', 'description', id: @session_id)
+    end
+
+    def description=(val)
+      val = val.to_s
+      if val.empty?
+        config_set('span_session', 'description', id: @session_id,
+                    state: 'no', description: '')
+      else
+        config_set('span_session', 'description', id: @session_id,
+                    state: '', description: val)
+      end
+    end
+
+    def destination
+      config_get('span_session', 'destination', id: @session_id).downcase
+    end
+
+    def destination=(int)
+      # fail if int is not a valid interface
+      fail TypeError unless Interface.interfaces.key?(int.downcase)
+      config_set('span_session', 'destination', state: '', id: @session_id,
+                 intf_name: int)
+    end
+
+    def session_id
+      config_get('span_session', 'session_id')
+    end
+
+    def session_id=(id)
+      fail TypeError unless id.is_a?(Integer)
+      config_set('span_session', 'session_id', id: id, state: '')
+    end
+
+    def shutdown
+      config_get('span_session', 'shutdown', id: @session_id)
+    end
+
+    def shutdown=(bool)
+      fail TypeError unless bool.is_a?(Boolean)
+      config_set('span_session', 'shutdown', id: @session_id, shutdown: bool)
+    end
+
+    def source_interfaces
+      ints = config_get('span_session', 'source_interfaces', id: @session_id)
+      intf = []
+      ints.each { |i| intf << i.map(&:downcase) }
+      intf
+    end
+
+    def source_interfaces=(sources)
+      fail TypeError unless sources.is_a?(Hash)
+      delta_hash = Utils.delta_add_remove(sources.to_a, source_interfaces.to_a,
+                                          :updates_not_allowed)
+      return if delta_hash.values.flatten.empty?
+      [:remove, :add].each do |action|
+        delta_hash[action].each do |name, dir|
+          state = (action == :add) ? '' : 'no'
+          config_set('span_session', 'source_interfaces', id: @session_id,
+                     state: state, int_name: name, direction: dir)
+        end
+      end
+    end
+
+    def default_source_interfaces
+      config_get_default('span_session', 'source_interfaces')
+    end
+
+    def source_vlans
+      v = config_get('span_session', 'source_vlans', id: @session_id)
+      v.empty? ? v : [Utils.normalize_range_array(v[0]), v[1]]
+    end
+
+    def source_vlans=(sources)
+      fail TypeError unless sources.is_a?(Hash)
+      is = Utils.dash_range_to_elements(source_vlans[0]) unless
+        source_vlans.empty?
+      should = Utils.dash_range_to_elements(sources[:vlans])
+      direction = sources[:direction]
+      delta_hash = Utils.delta_add_remove(should, is)
+      [:add, :remove].each do |action|
+        delta_hash[action].each do |vlans|
+          state = (action == :add) ? '' : 'no'
+          config_set('span_session', 'source_vlans',
+                     id: @session_id, state: state,
+                     vlans: vlans, direction: direction)
+        end
+      end
+    end
+
+    def default_source_vlans
+      config_get_default('span_session', 'source_vlans')
+    end
+
+    def type
+      config_get('span_session', 'type', id: @session_id)
+    end
+
+    def type=(str)
+      valid_types = ['local', 'rspan', 'erspan-source']
+      fail TypeError unless valid_types.include?(str)
+      destroy # need to destroy session before changing type
+      if str.empty?
+        config_set('span_session', 'type', id: @session_id, type: 'local')
+      else
+        config_set('span_session', 'type', id: @session_id, type: str)
+      end
+    end
+  end # class
+end # module

data/lib/cisco_node_utils/upgrade.rb

@@ -58,10 +58,23 @@ module Cisco
       if image && uri
         config_get('upgrade', 'image_version', image: image, uri: uri)
       else
-        config_get('show_version', 'version').split(' ')[0]
+        version = config_get('show_version', 'version')
+        # show version displays version differently for release and
+        # development builds.
+        # Eg: release build
+        #       NXOS: version 7.0(3)I4(2)
+        # Eg: development build
+        #       NXOS: version 7.0(3)IFD6(1) [build 7.0(3)IGD7(0.65)]
+        return version unless version[/build\s+\S+/]
+        version.split(' ')[-1].split(']')[0]
       end
     end
 
+    # Return the nxos image installed on the device
+    def self.package
+      config_get('show_version', 'system_image')
+    end
+
     # Return true if box is online and config mode is ready to be used
     def self.box_online?
       output = config_set('upgrade', 'is_box_online')
@@ -85,32 +98,23 @@ module Cisco
     end
 
     # Attempts to upgrade the device to 'image'
-    def self.upgrade(version, image, uri='bootflash:', del_boot=false,
+    def self.upgrade(image, uri='bootflash:', del_boot=false,
                      force_all=false)
-      # Only 'bootflash:' is a supported URI. Fail otherwise.
-      fail "The Uri #{uri} is not supported" unless uri == 'bootflash:'
-      # IMPORTANT - Check if version of image equals the version provided.
-      # This is to avoid entering a loop with the Programmability Agent
-      # continuously trying to reload the device if versions don't match.
-      image_ver = image_version(image, uri)
-      err_str = "Version Mismatch.\n
-                 The version of the image:#{image_ver}\n
-                 The version provided:#{version}\n
-                 Aborting upgrade."
-      fail err_str unless image_ver.to_s.strip == version.to_s.strip
       delete_boot(uri) if del_boot
       force_all ? upgrade_str = 'upgrade_force' : upgrade_str = 'upgrade'
       begin
         Cisco::Logger.debug("Upgrading to version: #{image}")
         config_set('upgrade', upgrade_str, image: image, uri: uri)
-      rescue Cisco::RequestFailed
+      rescue Cisco::RequestFailed, Cisco::CliError => e1
+        # raise if install command failed
+        raise e1 if e1.class == Cisco::CliError
         # Catch 'Backend Processing Error'. Install continues inspite of the
         # error thrown. Resend install command and expect a CliError.
         begin
           config_set('upgrade', upgrade_str, image: image, uri: uri)
-        rescue Cisco::CliError => e
-          raise e unless
-            e.message.include?('Another install procedure may be in progress')
+        rescue Cisco::CliError => e2
+          raise e2 unless
+            e2.message.include?('Another install procedure may be in progress')
         end
       end
     end