cisco_node_utils 1.4.1 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 564e7f738b94277341aac0cd79f9969311c1e7cd
-  data.tar.gz: 93ae60e8ff3348f14d1f7ad98125ad06bd535a1a
+  metadata.gz: a52015dedc4b7c5bf4c0124dced507351aecfbe1
+  data.tar.gz: 68b52a70c7478034e0a8ce9913e181bda17896bf
 SHA512:
-  metadata.gz: 8cde277306e924d1f0edce1549b6f3e835fb389098005770258ab3e4dd7c2b0301b22291516b174d44f270dd9d0041fd81356f8aed8c9ed91e88287eb5b89328
-  data.tar.gz: dcc9931ea33f770f3864a07c3b9e1859df09a7aa52e5003f97a0bd956fa0379e29d8970949732a8ece42eb92b82eb1f1e599cf6e2878e7339b15e502e91ebb6e
+  metadata.gz: 408c48ce5a0bf93fbcf5f5c10d24717561e475a03b8d6ca4fad6a49c4d237b6a20be6bfbdd4143deecec8a210a1916a7910efd29442ba13a9e67dde219f9070e
+  data.tar.gz: 4a436ce2bba7bdd3ecf5104a812605b0c3c7c557357c903574c48f018fcc938a8623c580732952b088689186ce77e26a8e4301c3399d970b84a00636a7b5fccd

data/CHANGELOG.md

@@ -1,6 +1,34 @@
 Changelog
 =========
 
+## [v1.5.0]
+
+### New feature support
+* Drill down capability into structured table output using command reference yaml (@mikewiebe)
+
+#### Cisco Resources
+* Hot Standby Router Protocol
+  * hsrp_global (@saichint)
+  * interface_hsrp_group (@saichint)
+
+### Added
+
+* Extend interface with attributes:
+   * `hsrp_bfd`
+   * `hsrp_delay_minimum`
+   * `hsrp_delay_reload`
+   * `hsrp_mac_refresh`
+   * `hsrp_use_bia`
+   * `hsrp_version`
+   * `pim_bfd`
+* Extend pim with attributes:
+   * `bfd`
+* Added support for Cisco NX-OS software releases `7.3(0)F1(1)` and `8.0(1)`
+
+### Changed
+
+### Removed
+
 ## [v1.4.1]
 
 ### Added
@@ -51,6 +79,7 @@ Changelog
    * `bfd`
 * Extend bgp_neighbor with attributes:
    * `bfd`
+* Cisco Nexus 8xxx platform support added to existing classes
 
 ### Changed
 * Deprecated `vlan` private-vlan properties and replaced with new methods. New file `vlan_DEPRECATED.rb` has been created to store the deprecated methods. The old -> new properties are:
@@ -368,6 +397,7 @@ Changelog
 [git-flow]: https://github.com/petervanderdoes/gitflow-avh
 [SimpleCov]: https://github.com/colszowka/simplecov
 
+[v1.5.0]: https://github.com/cisco/cisco-network-node-utils/compare/v1.4.1...v1.5.0
 [v1.4.1]: https://github.com/cisco/cisco-network-node-utils/compare/v1.4.0...v1.4.1
 [v1.4.0]: https://github.com/cisco/cisco-network-node-utils/compare/v1.3.0...v1.4.0
 [v1.3.0]: https://github.com/cisco/cisco-network-node-utils/compare/v1.2.0...v1.3.0

data/README.md

@@ -40,13 +40,14 @@ open source management tools.
 
 This CiscoNodeUtils gem release supports the following:
 
-Platform         | OS     | OS Version           |
------------------|--------|----------------------|
-Cisco Nexus N9k  | NX-OS  | 7.0(3)I2(1) and later
-Cisco Nexus N3k  | NX-OS  | 7.0(3)I2(1) and later
-Cisco Nexus N5k  | NX-OS  | 7.3(0)N1(1) and later
-Cisco Nexus N6k  | NX-OS  | 7.3(0)N1(1) and later
-Cisco Nexus N7k  | NX-OS  | 7.3(0)D1(1) and later
+Platform          | OS     | OS Version           |
+------------------|--------|----------------------|
+Cisco Nexus N9k   | NX-OS  | 7.0(3)I2(1) and later
+Cisco Nexus N3k   | NX-OS  | 7.0(3)I2(1) and later
+Cisco Nexus N5k   | NX-OS  | 7.3(0)N1(1) and later
+Cisco Nexus N6k   | NX-OS  | 7.3(0)N1(1) and later
+Cisco Nexus N7k   | NX-OS  | 7.3(0)D1(1) and later
+Cisco Nexus N9K-F | NX-OS  | 7.0(3)F1(1) and later
 
 Please note: For Cisco Nexus 3k and 9k platforms, a virtual Nexus N9000/N3000 may be helpful for development and testing. Users with a valid [cisco.com](http://cisco.com) user ID can obtain a copy of a virtual Nexus N9000/N3000 by sending their [cisco.com](http://cisco.com) user ID in an email to <get-n9kv@cisco.com>. If you do not have a [cisco.com](http://cisco.com) user ID please register for one at [https://tools.cisco.com/IDREG/guestRegistration](https://tools.cisco.com/IDREG/guestRegistration)
 

data/docs/README-maintainers.md

@@ -48,7 +48,6 @@ When we are considering publishing a new release, all of the following steps mus
     - N56xx
     - N6xxx
     - N7xxx
-    - N8xxx
     - N9xxx
 
 3. Triage any minitest failures.

data/lib/cisco_node_utils/aaa_authentication_login_service.rb

@@ -58,8 +58,8 @@ module Cisco
       if g_str.empty?
         # cannot remove default local, so do nothing in this case
         unless m == :local
-          unless node.product_id[/N8/]
-            # TBD: These 'no' commands currently error on N8k
+          unless node.product_id[/N9K-F/]
+            # TBD: These 'no' commands currently error on N9K-F
             #   no aaa authentication login console local
             #   no aaa authentication login console none
             config_set('aaa_auth_login_service', 'method',

data/lib/cisco_node_utils/bgp.rb

@@ -513,7 +513,7 @@ module Cisco
 
     def default_event_history_events
       if Utils.image_version?(/7.0.3.I2|I3|I4/) ||
-         Utils.chassis_pid?(/N(5|6|7|8)/)
+         node.product_id[/(N5|N6|N7|N9.*-F)/]
         config_get_default('bgp', 'event_history_events')
       else
         config_get('bgp', 'event_history_events_bytes', @get_args)
@@ -574,7 +574,7 @@ module Cisco
 
     def default_event_history_periodic
       if Utils.image_version?(/7.0.3.I2|I3|I4/) ||
-         Utils.chassis_pid?(/N(5|6|7|8)/)
+         node.product_id[/(N5|N6|N7|N9.*-F)/]
         config_get_default('bgp', 'event_history_periodic')
       else
         config_get('bgp', 'event_history_periodic_bytes', @get_args)

data/lib/cisco_node_utils/cisco_cmn_utils.rb

@@ -360,5 +360,21 @@ module Cisco
       end
       merged
     end # merge_range
+
+    # Add double quotes to string.
+    #
+    # Helper method to add a double quote to the beginning
+    # and end of a string.
+    #
+    # Nxapi adds an escape character to config lines that
+    # nvgen in this way in some but not all nxos releases.
+    #
+    # Input: String (Example 'foo')
+    # Returns: String with double quotes: (Example: '"foo"'
+    #
+    def self.add_quotes(string)
+      string = "\"#{string}\"" if image_version?(/8.0/)
+      string
+    end
   end # class Utils
 end   # module Cisco

data/lib/cisco_node_utils/client/utils.rb

@@ -144,7 +144,13 @@ class Cisco::Client
         fail "No match found for #{filter}" if data.length == 0
         data = data[0]
       else # data is array or hash
-        filter = filter.to_i if data.is_a? Array
+        if data.is_a? Array
+          final = []
+          data.each do |row|
+            final << row[filter]
+          end
+          return final
+        end
         fail "No key \"#{filter}\" in #{data}" if data[filter].nil?
         data = data[filter]
       end

data/lib/cisco_node_utils/cmd_ref/DEPRECATED.yaml

@@ -17,7 +17,7 @@ private_vlan_any:
 
 private_vlan_association:
   # DEPRECATED (REMOVING WITH RELEASE 2.0.0). USE 'pvlan_association'
-  _exclude: [N8k]
+  _exclude: [N9k-F]
   multiple: true
   get_command: "show vlan private-vlan"
   get_context: ~
@@ -28,7 +28,7 @@ private_vlan_association:
 
 private_vlan_mapping:
   # DEPRECATED (REMOVING WITH RELEASE 2.0.0). USE 'pvlan_mapping'
-  _exclude: [ios_xr, N8k]
+  _exclude: [ios_xr, N9k-F]
   multiple: true
   get_value: '/^private-vlan mapping (.*)$/'
   set_value: "<state> private-vlan mapping <vlans>"
@@ -36,7 +36,7 @@ private_vlan_mapping:
 
 private_vlan_type:
   # DEPRECATED (REMOVING WITH RELEASE 2.0.0). USE 'pvlan_type'
-  _exclude: [N8k]
+  _exclude: [N9k-F]
   kind: string
   get_command: 'show vlan private-vlan type'
   get_context: ~
@@ -47,14 +47,14 @@ private_vlan_type:
 
 switchport_mode_private_vlan_host:
   # DEPRECATED (REMOVING WITH RELEASE 2.0.0). USE 'switchport_pvlan_host'
-  _exclude: [ios_xr, N8k]
+  _exclude: [ios_xr, N9k-F]
   get_value: '/^switchport mode private-vlan (.*)$/'
   set_value: "<state> switchport mode private-vlan <mode>"
   default_value: :disabled
 
 switchport_mode_private_vlan_host_association:
   # DEPRECATED (REMOVING WITH RELEASE 2.0.0). USE 'switchport_pvlan_host_association'
-  _exclude: [ios_xr, N8k]
+  _exclude: [ios_xr, N9k-F]
   multiple: true
   get_value: '/^switchport private-vlan host-association (.*)$/'
   set_value: "<state> switchport private-vlan host-association <vlan_pr> <vlan_sec>"
@@ -62,7 +62,7 @@ switchport_mode_private_vlan_host_association:
 
 switchport_mode_private_vlan_host_promiscous:
   # DEPRECATED (REMOVING WITH RELEASE 2.0.0). USE 'switchport_pvlan_promiscuous'
-  _exclude: [ios_xr, N8k]
+  _exclude: [ios_xr, N9k-F]
   multiple: true
   get_value: '/^switchport private-vlan mapping (\d+.*)$/'
   set_value: "<state> switchport private-vlan mapping <vlan_pr> <vlans>"
@@ -70,7 +70,7 @@ switchport_mode_private_vlan_host_promiscous:
 
 switchport_mode_private_vlan_trunk_promiscuous:
   # DEPRECATED (REMOVING WITH RELEASE 2.0.0). USE 'switchport_pvlan_trunk_promiscuous'
-  _exclude: [ios_xr, N3k, N8k]
+  _exclude: [ios_xr, N3k, N9k-F]
   kind: boolean
   get_value: '/^switchport mode private-vlan trunk promiscuous$/'
   set_value: "<state> switchport mode private-vlan trunk promiscuous"
@@ -78,7 +78,7 @@ switchport_mode_private_vlan_trunk_promiscuous:
 
 switchport_mode_private_vlan_trunk_secondary:
   # DEPRECATED (REMOVING WITH RELEASE 2.0.0). USE 'switchport_pvlan_trunk_secondary'
-  _exclude: [ios_xr, N3k, N8k]
+  _exclude: [ios_xr, N3k, N9k-F]
   kind: boolean
   get_value: '/^switchport mode private-vlan trunk secondary$/'
   set_value: "<state> switchport mode private-vlan trunk secondary"
@@ -86,7 +86,7 @@ switchport_mode_private_vlan_trunk_secondary:
 
 switchport_private_vlan_association_trunk:
   # DEPRECATED (REMOVING WITH RELEASE 2.0.0). USE 'switchport_pvlan_trunk_association'
-  _exclude: [ios_xr, N3k, N8k]
+  _exclude: [ios_xr, N3k, N9k-F]
   multiple: true
   #get_value: '/^switchport private-vlan association trunk (.*) (.*)$/'
   get_value: '/^switchport private-vlan association trunk (.*)$/'
@@ -95,7 +95,7 @@ switchport_private_vlan_association_trunk:
 
 switchport_private_vlan_mapping_trunk:
   # DEPRECATED (REMOVING WITH RELEASE 2.0.0). USE 'switchport_pvlan_mapping_trunk'
-  _exclude: [ios_xr, N3k, N8k]
+  _exclude: [ios_xr, N3k, N9k-F]
   multiple: true
   get_value: '/^switchport private-vlan mapping trunk (.*)$/'
   set_value: "<state> switchport private-vlan mapping trunk <vlan_pr> <vlans>"
@@ -103,7 +103,7 @@ switchport_private_vlan_mapping_trunk:
 
 switchport_private_vlan_trunk_allowed_vlan:
   # DEPRECATED (REMOVING WITH RELEASE 2.0.0). USE 'switchport_pvlan_trunk_allowed_vlan'
-  _exclude: [ios_xr, N8k]
+  _exclude: [ios_xr, N9k-F]
   multiple: true
   get_value: '/^switchport private-vlan trunk allowed vlan (.*)$/'
   set_value: "<state> switchport private-vlan trunk allowed vlan <oper> <vlans>"
@@ -111,7 +111,7 @@ switchport_private_vlan_trunk_allowed_vlan:
 
 switchport_private_vlan_trunk_native_vlan:
   # DEPRECATED (REMOVING WITH RELEASE 2.0.0). USE 'switchport_pvlan_trunk_native_vlan'
-  _exclude: [ios_xr, N8k]
+  _exclude: [ios_xr, N9k-F]
   kind: int
   get_value: '/^switchport private-vlan trunk native vlan (.*)$/'
   set_value: "<state> switchport private-vlan trunk native vlan <vlan>"

data/lib/cisco_node_utils/cmd_ref/README_YAML.md

@@ -329,8 +329,8 @@ productid:
   ios_xr:
     get_value: '/PID: ([^ ,]+)/'
   nexus:
-    get_context: ["TABLE_inv", "ROW_inv", 0]
-    get_value: "productid"
+    get_context: ["TABLE_inv", "ROW_inv"]
+    get_value: ["name Chassis", "productid"]
 ```
 
 Using platform variants and product variants together:
@@ -361,7 +361,7 @@ productid:
   get_command: 'show inventory'
   nexus:
     get_data_format: nxapi_structured
-    get_context: ['TABLE_inv', 'ROW_inv', 0]
+    get_context: ['TABLE_inv', 'ROW_inv']
 ```
 
 ### `get_command`
@@ -378,7 +378,7 @@ area:
 
 ### `get_context`
 
-`get_context` is an optional sequence of tokens used to filter the output from the `get_command` down to the desired context where the `get_value` can be found. For CLI properties, these tokens are implicitly Regexps used to filter down through the hierarchical CLI output, while for `nxapi_structured` properties, the tokens are used as string keys.
+`get_context` is an optional sequence of tokens used to filter the output from the `get_command` down to the desired context where the `get_value` can be found. For CLI properties, these tokens are implicitly Regexps used to filter down through the hierarchical CLI output, while for `nxapi_structured` properties, the tokens are used as string keys. For `nxapi_structured` properties, both `get_context` and `get_value` can specify a sequence of tokens used to filter the output from the `get_command` down to the desired `get_value`.  This feature can be used to retrieve data from `TABLE` data the contains multiple `ROWS`.
 
 
 ```yaml
@@ -387,10 +387,38 @@ productid:
   get_command: 'show inventory'
   nexus:
     get_data_format: nxapi_structured
-    get_context: ['TABLE_inv', 'ROW_inv', 0]
-    get_value: 'productid'
+    get_context: ['TABLE_inv', 'ROW_inv']
+    get_value: ["name Chassis", "productid"]
     # config_get('inventory', 'productid') returns
-    # structured_output['TABLE_inv']['ROW_inv'][0]['productid']
+    # 'productid' for the row that contains 'name Chassis'
+```
+
+```yaml
+# vlan.yaml
+name:
+  get_command: "show vlan brief"
+  nexus:
+    kind: string
+    get_data_format: nxapi_structured
+    get_context: ["TABLE_vlanbriefxbrief", "ROW_vlanbriefxbrief"]
+    get_value: ["vlanshowbr-vlanid-utf <vlanid>", "vlanshowbr-vlanname"]
+    # config_get('vlan', 'name', @vlan_id) returns
+    # 'vlanshowbr-vlanname' for @vlan_id.
+    # NOTE: `<vlanid>` in the `get_value` is replaced by `@vlan_id` prior to lookup.
+```
+
+```yaml
+# vlan.yaml
+shutdown:
+  get_command: "show vlan brief"
+  nexus:
+    kind: boolean
+    get_data_format: nxapi_structured
+    get_context: ["TABLE_vlanbriefxbrief", "ROW_vlanbriefxbrief"]
+    get_value: ["vlanshowbr-vlanid-utf <vlanid>", "vlanshowbr-shutstate", '/^shutdown$/']
+    # config_get('vlan', 'shutdown', @vlan_id) returns
+    # true if data in 'vlanshowbr-shutstate' matches regex '/^shutdown$/' else false.
+    # NOTE: `<vlanid>` in the `get_value` is replaced by `@vlan_id` prior to lookup.
 ```
 
 ```yaml

data/lib/cisco_node_utils/cmd_ref/aaa_authorization_service.yaml

@@ -28,7 +28,7 @@ remove_local_auth:
   N3k: &remove_local_allowed
     default_only: true
   N9k: *remove_local_allowed
-  N8k: *remove_local_allowed
+  N9k-F: *remove_local_allowed
   N5k: *remove_local_allowed
   N6k: *remove_local_allowed
   N7k: *remove_local_allowed

data/lib/cisco_node_utils/cmd_ref/bfd_global.yaml

@@ -23,27 +23,27 @@ echo_rx_interval:
     default_value: 50
 
 fabricpath_interval:
-  _exclude: [N3k, N8k, N9k]
+  _exclude: [N3k, N9k-F, N9k]
   get_value: '/^bfd fabricpath interval (\d+) min_rx (\d+) multiplier (\d+)$/'
   set_value: '<state> bfd fabricpath interval <interval> min_rx <min_rx> multiplier <multiplier>'
   default_value: ['50', '50', '3']
 
 fabricpath_slow_timer:
-  _exclude: [N3k, N8k, N9k]
+  _exclude: [N3k, N9k-F, N9k]
   kind: int
   get_value: '/^bfd fabricpath slow-timer (\d+)$/'
   set_value: '<state> bfd fabricpath slow-timer <timer>'
   default_value: 2000
 
 fabricpath_vlan:
-  _exclude: [N3k, N8k, N9k]
+  _exclude: [N3k, N9k-F, N9k]
   kind: int
   get_value: '/^bfd fabricpath vlan (\d+)$/'
   set_value: '<state> bfd fabricpath vlan <vlan>'
   default_value: 1
 
 interval:
-  _exclude: [N8k, N9k] # TBD: bug on n8k, n9k this is not working now
+  _exclude: [N9k-F, N9k] # TBD: bug on n9k-f, n9k this is not working now
   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_af.yaml

@@ -11,7 +11,7 @@ _template:
     get_command: 'show running-config router bgp'
 
 additional_paths_install:
-  _exclude: [ios_xr, N3k, N8k, N9k]
+  _exclude: [ios_xr, N3k, N9k-F, N9k]
   kind: boolean
   get_value: '/^additional-paths install backup$/'
   set_value: '<state> additional-paths install backup'

data/lib/cisco_node_utils/cmd_ref/bgp_neighbor_af.yaml

@@ -189,7 +189,7 @@ soft_reconfiguration_in:
     get_value: '/^soft-reconfiguration inbound(?: always)?/'
     set_value: '<state> soft-reconfiguration inbound <always>'
   N3k: *soft_recon_always
-  N8k: *soft_recon_always
+  N9k-F: *soft_recon_always
   N9k: *soft_recon_always
   else:
     get_value: '/^soft-reconfiguration inbound/'

data/lib/cisco_node_utils/cmd_ref/bridge_domain.yaml

@@ -1,7 +1,7 @@
 # bridge_domain
 # bridge_domain feature is available only on n7k
 ---
-_exclude: [N3k, N5k, N6k, N8k, N9k, ios_xr]
+_exclude: [N3k, N5k, N6k, N9k-F, N9k, ios_xr]
 
 # For the below name, shutdown commands we are going to use show running-config
 # bridge-domain cli which displays as below

data/lib/cisco_node_utils/cmd_ref/bridge_domain_vni.yaml

@@ -1,6 +1,6 @@
 # bridge_domain
 ---
-_exclude: [N3k, N5k, N6k, N8k, N9k, ios_xr]
+_exclude: [N3k, N5k, N6k, N9k-F, N9k, ios_xr]
 
 create:
   set_value: "bridge-domain <bd>"

data/lib/cisco_node_utils/cmd_ref/dhcp_relay_global.yaml

@@ -47,7 +47,7 @@ ipv4_relay:
     default_value: false
   N6k: *relay_default_false
   N7k: *relay_default_true
-  N8k: *relay_default_true
+  N9k-F: *relay_default_true
   N9k: *relay_default_true
 
 ipv4_smart_relay:
@@ -57,7 +57,7 @@ ipv4_smart_relay:
   default_value: false
 
 ipv4_src_addr_hsrp:
-  _exclude: [N3k, N8k, N9k]
+  _exclude: [N3k, N9k-F, N9k]
   kind: boolean
   get_value: '/^ip dhcp relay source-address hsrp$/'
   set_value: "<state> ip dhcp relay source-address hsrp"
@@ -69,14 +69,14 @@ ipv4_src_intf:
   default_value: false
 
 ipv4_sub_option_circuit_id_custom:
-  _exclude: [N7k, N8k]
+  _exclude: [N7k, N9k-F]
   kind: boolean
   get_value: '/^ip dhcp relay sub-option circuit-id customized$/'
   set_value: "<state> ip dhcp relay sub-option circuit-id customized"
   default_value: false
 
 ipv4_sub_option_circuit_id_string:
-  _exclude: [N5k, N6k, N7k, N8k, N9k]
+  _exclude: [N5k, N6k, N7k, N9k-F, N9k]
   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
@@ -116,7 +116,7 @@ ipv6_relay:
     default_value: false
   N6k: *v6_relay_default_false
   N7k: *v6_relay_default_true
-  N8k: *v6_relay_default_true
+  N9k-F: *v6_relay_default_true
   N9k: *v6_relay_default_true
 
 ipv6_src_intf: