cisco_node_utils 1.6.0 → 1.7.0

data/lib/cisco_node_utils/bgp_neighbor.rb

@@ -27,7 +27,7 @@ module Cisco
   class RouterBgpNeighbor < NodeUtil
     attr_reader :nbr, :vrf, :asn
 
-    def initialize(asn, vrf, nbr, instantiate=true)
+    def initialize(asn, vrf, nbr, ra=nil, instantiate=true)
       fail TypeError unless nbr.is_a?(String)
       # for IP/prefix format, such as "1.1.1.1/24" or "2000:123:38::34/64",
       # we need to mask the address using prefix length, so that it becomes
@@ -35,7 +35,8 @@ module Cisco
       @nbr = Utils.process_network_mask(nbr)
       @asn = RouterBgp.validate_asnum(asn)
       @vrf = vrf
-      @get_args = @set_args = { asnum: @asn, nbr: @nbr }
+      @ra = ra
+      @get_args = @set_args = { asnum: @asn, nbr: @nbr, ra: @ra }
       @get_args[:vrf] = @set_args[:vrf] = vrf if vrf != 'default'
 
       create if instantiate
@@ -52,9 +53,9 @@ module Cisco
           next if neighbor_list.nil?
 
           hash[asn][vrf_id] = {}
-          neighbor_list.each do |nbr|
+          neighbor_list.each do |nbr, ra|
             hash[asn][vrf_id][nbr] = RouterBgpNeighbor.new(asn, vrf_id,
-                                                           nbr, false)
+                                                           nbr, ra, false)
           end
         end
       end
@@ -306,7 +307,9 @@ module Cisco
     end
 
     def remote_as
-      config_get('bgp_neighbor', 'remote_as', @get_args).to_s
+      tra = config_get('bgp_neighbor', 'remote_as', @get_args).to_s
+      tra = @ra if tra == default_remote_as && !@ra.nil?
+      tra
     end
 
     def default_remote_as

data/lib/cisco_node_utils/bgp_neighbor_af.rb

@@ -25,8 +25,8 @@ require_relative 'bgp'
 module Cisco
   # RouterBgpNeighborAF - node utility class for BGP per-neighbor, per-AF config
   class RouterBgpNeighborAF < NodeUtil
-    def initialize(asn, vrf, nbr, af, instantiate=true)
-      validate_args(asn, vrf, nbr, af)
+    def initialize(asn, vrf, nbr, af, ra=nil, instantiate=true)
+      validate_args(asn, vrf, nbr, af, ra)
       create if instantiate
     end
 
@@ -42,15 +42,16 @@ module Cisco
 
           nbrs = config_get('bgp_neighbor', 'all_neighbors', get_args)
           next if nbrs.nil?
-          nbrs.each do |nbr|
+          nbrs.each do |nbr, ra|
             af_hash[asn][vrf][nbr] = {}
             get_args[:nbr] = nbr
+            get_args[:ra] = ra
             afs = config_get('bgp_neighbor_af', 'all_afs', get_args)
 
             next if afs.nil?
             afs.each do |af|
               af_hash[asn][vrf][nbr][af] =
-                RouterBgpNeighborAF.new(asn, vrf, nbr, af, false)
+                RouterBgpNeighborAF.new(asn, vrf, nbr, af, ra, false)
             end
           end
         end
@@ -62,7 +63,7 @@ module Cisco
       return {}
     end
 
-    def validate_args(asn, vrf, nbr, af)
+    def validate_args(asn, vrf, nbr, af, ra)
       fail ArgumentError unless
         vrf.is_a?(String) && (vrf.length > 0)
       fail ArgumentError unless
@@ -81,12 +82,13 @@ module Cisco
       @asn = RouterBgp.validate_asnum(asn)
       @vrf = vrf
       @nbr = nbr
+      @ra = ra
       @afi, @safi = af
       set_args_keys_default
     end
 
     def set_args_keys_default
-      keys = { asnum: @asn, nbr: @nbr, afi: @afi, safi: @safi }
+      keys = { asnum: @asn, nbr: @nbr, ra: @ra, afi: @afi, safi: @safi }
       keys[:vrf] = @vrf unless @vrf == 'default'
       @get_args = @set_args = keys
     end

data/lib/cisco_node_utils/cisco_cmn_utils.rb

@@ -367,5 +367,45 @@ module Cisco
         value.start_with?('"') && value.end_with?('"')
       value
     end # add_quotes
+
+    # This method is used in config_get for CLIs which
+    # have multiple properties in the same output
+    # Given a match_method which defines regex pattern and the
+    # match criteria, this method, extracts the value of
+    # a property with or without a prefix.
+    # For ex. if the regex pattern is something like:
+    # (?<action>\S+)?
+    # the property to extract is action and prefix is nil
+    # for (?<src_port>range \S+)
+    # the property to extract is src_port and prefix is range
+    def self.extract_value(match_method, prop, prefix=nil)
+      prefix = prop if prefix.nil?
+      mm = match_method
+
+      return nil if mm.nil?
+
+      return nil unless mm.names.include?(prop)
+
+      # extract and return value that follows prefix + <space>
+      regexp = Regexp.new("#{Regexp.escape(prefix)} (?<extracted>.*)")
+      value_match = regexp.match(mm[prop])
+      return nil if value_match.nil?
+      value_match[:extracted]
+    end
+
+    # This method is used in config_set for CLIs which
+    # can set multiple properties using the same CLI.
+    # This method attaches prefix to the given property
+    # when the prefix is different from the property name
+    # else it attaches property name itself. It also
+    # appends the value to be set.
+    # For ex. if the set_value is <precedence> <time_range>
+    # the prop for precedence could be 'precedence', and
+    # for time_range, the prop and prefix could be 'time_range'
+    # and 'time-range'
+    def self.attach_prefix(val, prop, prefix=nil)
+      prefix = prop.to_s if prefix.nil?
+      val.to_s.empty? ? val : "#{prefix} #{val}"
+    end
   end # class Utils
 end   # module Cisco

data/lib/cisco_node_utils/cmd_ref/bfd_global.yaml

@@ -43,7 +43,7 @@ fabricpath_vlan:
   default_value: 1
 
 interval:
-  _exclude: [N9k-F, N9k] # TBD: bug on n9k-f, n9k this is not working now
+  os_version: 'N9k-F:7.0.3.F2.1; N9k:7.0.3.I6.1'
   get_value: '/^bfd interval (\d+) min_rx (\d+) multiplier (\d+)$/'
   set_value: '<state> bfd interval <interval> min_rx <min_rx> multiplier <multiplier>'
   N3k:

data/lib/cisco_node_utils/cmd_ref/bgp.yaml

@@ -125,13 +125,15 @@ disable_policy_batching:
   default_value: false
 
 disable_policy_batching_ipv4:
-  _exclude: [ios_xr, N5k, N6k, N7k]
+  _exclude: [ios_xr, N5k, N6k]
+  os_version: 'N7k:8.1.1'
   get_value: '/^disable-policy-batching ipv4 prefix-list (\S+)$/'
   set_value: '<state> disable-policy-batching ipv4 prefix-list <prefix_list>'
   default_value: ""
 
 disable_policy_batching_ipv6:
-  _exclude: [ios_xr, N5k, N6k, N7k]
+  _exclude: [ios_xr, N5k, N6k]
+  os_version: 'N7k:8.1.1'
   get_value: '/^disable-policy-batching ipv6 prefix-list (\S+)$/'
   set_value: '<state> disable-policy-batching ipv6 prefix-list <prefix_list>'
   default_value: ""
@@ -275,7 +277,8 @@ maxas_limit:
 
 neighbor_down_fib_accelerate:
   # Note: Does not exist in IOS XR
-  _exclude: [ios_xr, N5k, N6k, N7k]
+  _exclude: [ios_xr, N5k, N6k]
+  os_version: 'N7k:8.1.1'
   kind: boolean
   get_value: 'neighbor-down fib-accelerate'
   set_value: '<state> neighbor-down fib-accelerate'
@@ -297,7 +300,8 @@ process_initialized:
   get_value: '/^BGP routing table information/'
 
 reconnect_interval:
-  _exclude: [ios_xr, N5k, N6k, N7k]
+  _exclude: [ios_xr, N5k, N6k]
+  os_version: 'N7k:8.1.1'
   kind: int
   get_value: 'reconnect-interval (\d+)'
   set_value: '<state> reconnect-interval <seconds>'

data/lib/cisco_node_utils/cmd_ref/bgp_af_aa.yaml

@@ -0,0 +1,38 @@
+# bgp_af_aa.yaml
+---
+_exclude: [ios_xr]
+
+_template:
+  context:
+    - "router bgp <asnum>"
+    - '(?)vrf <vrf>'
+    - 'address-family <afi> <safi>'
+  get_command: 'show running bgp all'
+
+advertise_map:
+  kind: string
+  default_value: ''
+
+aggr_addr:
+  get_value: '/^aggregate-address <address> (.*)$/'
+  set_value: "<state> aggregate-address <address> <as_set> <summ> <advertise> <suppress> <attribute>"
+
+all_aa:
+  multiple: true
+  get_value: '/^aggregate-address (\S+)/'
+
+as_set:
+  kind: boolean
+  default_value: false
+
+attribute_map:
+  kind: string
+  default_value: ''
+
+summary_only:
+  kind: boolean
+  default_value: false
+
+suppress_map:
+  kind: string
+  default_value: ''

data/lib/cisco_node_utils/cmd_ref/bgp_neighbor.yaml

@@ -5,7 +5,11 @@ _template:
     get_command: "show running router bgp"
   nexus:
     get_command: "show running bgp all"
-  context:
+  get_context:
+    - "router bgp <asnum>"
+    - "(?)vrf <vrf>"
+    - "neighbor <nbr>(?: remote-as <ra>)?"
+  set_context:
     - "router bgp <asnum>"
     - "(?)vrf <vrf>"
     - "neighbor <nbr>"
@@ -15,10 +19,10 @@ af:
 
 all_neighbors:
   multiple: true
-  context:
+  get_context:
     - "router bgp <asnum>"
     - "(?)vrf <vrf>"
-  get_value: '/^neighbor (\S+)$/'
+  get_value: '/^neighbor (\S+)(?:\s+remote-as (\d+))?$/'
 
 bfd:
   _exclude: [ios_xr]
@@ -71,7 +75,8 @@ local_as:
   default_value: 0
 
 log_neighbor_changes:
-  _exclude: [ios_xr, N5k, N6k, N7k]
+  _exclude: [ios_xr, N5k, N6k]
+  os_version: 'N7k:8.1.1'
   multiple: true # not actually, but we get an array of matches
   auto_default: false
   get_value: '/^log-neighbor-changes\s+??(\S+)?\s+??$/'

data/lib/cisco_node_utils/cmd_ref/bgp_neighbor_af.yaml

@@ -5,7 +5,12 @@ _template:
     get_command: 'show running bgp all'
   ios_xr:
     get_command: 'show run router bgp'
-  context:
+  get_context:
+    - 'router bgp <asnum>'
+    - '(?)vrf <vrf>'
+    - 'neighbor <nbr>(?: remote-as <ra>)?'
+    - 'address-family <afi> <safi>'
+  set_context:
     - 'router bgp <asnum>'
     - '(?)vrf <vrf>'
     - 'neighbor <nbr>'
@@ -40,10 +45,10 @@ advertise_map_non_exist:
 
 all_afs:
   multiple: true
-  context:
+  get_context:
     - 'router bgp <asnum>'
     - '(?)vrf <vrf>'
-    - 'neighbor <nbr>'
+    - 'neighbor <nbr>(?: remote-as <ra>)?'
   get_value: '/^address-family (\S+) (\S+)$/'
 
 allowas_in:

data/lib/cisco_node_utils/cmd_ref/dhcp_relay_global.yaml

@@ -76,7 +76,8 @@ ipv4_sub_option_circuit_id_custom:
   default_value: false
 
 ipv4_sub_option_circuit_id_string:
-  _exclude: [N5k, N6k, N7k, N9k-F, N9k]
+  _exclude: [N5k, N6k, N7k, N9k-F]
+  os_version: 'N9k:7.0.3.I6.1'
   get_value: '/^ip dhcp relay sub-option circuit-id format-type string format (.*)$/'
   set_value: "<state> ip dhcp relay sub-option circuit-id format-type string <format> <word>"
   default_value: false

data/lib/cisco_node_utils/cmd_ref/feature.yaml

@@ -47,6 +47,11 @@ itd:
   get_value: '/^feature itd$/'
   set_value: "feature itd"
 
+lacp:
+  kind: boolean
+  get_value: '/^feature lacp$/'
+  set_value: "feature lacp"
+
 nv_overlay:
   # N3k - native vxlan support in a future release
   _exclude: [N3k]

data/lib/cisco_node_utils/cmd_ref/interface.yaml

@@ -360,6 +360,14 @@ pim_bfd:
   set_value: "<state> ip pim bfd-instance"
   default_value: false
 
+purge_config:
+  _exclude: [ios_xr]
+  multiple:
+  set_context: ~
+  set_value:   "default interface <name>"
+  get_command: "show running interface"
+  get_value:   '/(.*)/'
+
 pvlan_any:
   multiple:
   get_value: '/switchport private-vlan/'

data/lib/cisco_node_utils/cmd_ref/interface_channel_group.yaml

@@ -13,15 +13,19 @@ all_interfaces:
   get_value: '/^interface (Ethernet.*)/i'
 
 channel_group:
-  kind: int
   default_value: false
   nexus:
-    get_value: '/^channel-group (\d+)$/'
-    set_value: '<state> channel-group <group> <force>'
+    get_value: '/^channel-group (\d+)(?:\s+mode\s+(\S+))?$/'
+    set_value: '<state> channel-group <group> <force> <mode> <val>'
   ios_xr:
+    kind: int
     get_value: '/^bundle id (\d+).*$/'
     set_value: '<state> bundle id <group>'
 
+channel_group_mode:
+  _exclude: [ios_xr]
+  default_value: false
+
 description:
   kind: string
   get_value: '/^description (.*)/'

data/lib/cisco_node_utils/cmd_ref/inventory.yaml

@@ -21,16 +21,16 @@ productid:
   ios_xr:
     get_value: '/"Rack 0".*\n.*PID: ([^ ,]+)/'
   nexus:
-    get_value: ["name Chassis", "productid"]
+    get_value: ["name \"Chassis\"", "productid"]
 
 serialnum:
   ios_xr:
     get_value: '/"Rack 0".*\n.*SN: ([^ ,]+)/'
   nexus:
-    get_value: ["name Chassis", "serialnum"]
+    get_value: ["name \"Chassis\"", "serialnum"]
 
 versionid:
   ios_xr:
     get_value: '/"Rack 0".*\n.*VID: ([^ ,]+)/'
   nexus:
-    get_value: ["name Chassis", "vendorid"]
+    get_value: ["name \"Chassis\"", "vendorid"]

data/lib/cisco_node_utils/cmd_ref/ntp_auth_key.yaml

@@ -0,0 +1,10 @@
+# ntp_auth_key
+---
+key:
+  multiple: true
+  default_value: []
+  nexus:
+    get_command: "show running-config all | include 'ntp authentication-key'"
+    # Returns <key>, <algorithm>, <password>, <mode>
+    get_value: '/^ntp authentication-key (\d+) (\w+) (\S+) (\d)/'
+    set_value: '<state> ntp authentication-key <key> <algorithm> <password> <mode>'

data/lib/cisco_node_utils/cmd_ref/ntp_config.yaml

@@ -3,6 +3,13 @@
 _template:
   get_command: "show running-config ntp"
 
+authenticate:
+  kind: boolean
+  default_value: false
+  nexus:
+    get_value: '/^ntp authenticate$/'
+    set_value: "<state> ntp authenticate"
+
 source_interface:
   default_value: ~
   nexus:
@@ -12,3 +19,9 @@ source_interface:
     context: ["ntp"]
     get_value: '/source\s+(.*)$/'
     set_value: '<state> source <source_interface>'
+
+trusted_key:
+  multiple:
+  nexus:
+    get_value: '/^ntp trusted-key\s+(\d+)$/'
+    set_value: "<state> ntp trusted-key <key>"

data/lib/cisco_node_utils/cmd_ref/ntp_server.yaml

@@ -5,6 +5,13 @@ _template:
     context: ["ntp"]
     get_command: "show running-config ntp"
 
+key:
+  multiple: true
+  default_value: []
+  nexus:
+    get_command: "show running-config all | include 'ntp server(.*)(key)'"
+    get_value: '/ntp server (\S+)/'
+
 prefer:
   multiple: true
   default_value: []
@@ -19,8 +26,9 @@ server:
   default_value: []
   nexus:
     get_command: "show running-config all | include 'ntp server'"
-    get_value: '/ntp server (\S+)/'
-    set_value: '<state> ntp server <ip> <prefer>'
+    # Returns <ip>, <prefer>, <vrf>, <key>, <minpoll>, <maxpoll>
+    get_value: '/^(?:ntp server )([^\s]+) (prefer )?(?:(?:use-vrf )([^\s]+))?(?:(?: key )(\d+))?(?:(?: minpoll )(\d+))?(?:(?: maxpoll )(\d+))?/'
+    set_value: '<state> ntp server <ip> <prefer> <vrf> <key> <minpoll> <maxpoll>'
   ios_xr:
     get_value: '/server (?:ipv6 )?(\S+)/'
     set_value: '<state> server <ip> <prefer>'

data/lib/cisco_node_utils/cmd_ref/overlay_global.yaml

@@ -1,8 +1,9 @@
 # overlay_global
 ---
-_exclude: [N3k, ios_xr]
+_exclude: [ios_xr]
 
 anycast_gateway_mac:
+  _exclude: [N3k]
   kind: string
   get_command: "show running all | inc 'fabric forwarding'"
   get_value: '/^fabric forwarding anycast-gateway-mac (\S+)$/'
@@ -10,17 +11,21 @@ anycast_gateway_mac:
   default_value: ""
 
 dup_host_ip_addr_detection:
+  _exclude: [N3k]
   get_command: "show running all | inc 'fabric forwarding'"
   get_value: '/^fabric forwarding dup-host-ip-addr-detection (\d+) (\d+)$/'
   set_value: "<state> fabric forwarding dup-host-ip-addr-detection <host_moves> <timeout>"
 
 dup_host_ip_addr_detection_host_moves:
+  _exclude: [N3k]
   default_value: 5
 
 dup_host_ip_addr_detection_timeout:
+  _exclude: [N3k]
   default_value: 180
 
 dup_host_mac_detection:
+  os_version: 'N3k:7.0.3.I6.1'
   get_command: 'show running | i l2rib'
   get_value: '/^l2rib dup-host-mac-detection (\d+) (\d+)$/'
   set_value: "l2rib dup-host-mac-detection <host_moves> <timeout>"