cisco_node_utils 1.10.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: db160cf1dedda53f077ad5e3c246a7106be834ea
-  data.tar.gz: 31eac56721204dbbf673355acaa1dd5591af3ed3
+  metadata.gz: 8500c855a9675c3c3ab5e581f06be1f67fb8074e
+  data.tar.gz: 0abf3dc4d719fa5282db36717571113f9ffdb617
 SHA512:
-  metadata.gz: d6330230a4a619e0e497d5c79d5757bfe3141e53605550033fdcfcb9f4e8cfafd93e8aa2a457fd4989ff40c636001f6a070475736abf30c1cd72eb0a09126db5
-  data.tar.gz: ac35c7431032dddce3c7fbc92c20028a6843fb25314e218925e1fa37610e6735e0a593e4aaa04ca2812182e20aa96a3d43205e436d5d2c655f850c828fddf78b
+  metadata.gz: 7ed3776cba64a9cbd4276a0c8034222a9d761f76f4a8b226e2af50fe8d1b1ac0c30d8cb698d1de1132e90435e7c20f6d05ea63216a379bb4da1913e5a6ee72b9
+  data.tar.gz: fc0a131d57d06626abdc777023b5a9637d15591997e8d88d05671f95a2efa8893b82c899fc4dc54e4f4407feac61befe7ba574a0c7438f3fe691cd1063605f60

data/.travis.yml

@@ -7,6 +7,8 @@ rvm:
   - 2.2.2
   - 2.1.6
   - 2.0.0-p648 # specify non-clang version of ruby
+before_install:
+ - gem install bundler -v '< 2'
 
 script:
  - bundle exec rake

data/CHANGELOG.md

@@ -1,6 +1,30 @@
 Changelog
 =========
 
+## [v2.0.0]
+
+### New Cisco Resources
+
+### Added
+* Extend nxapi client for https support
+   * `use_ssl` will be true when `transport` is `https`
+   * now makes use of `port` for custom nxapi ports
+* Extend router_ospf_vrf with attribute:
+   * `redistribute`
+* `reset_instance` method to node. Allows a single instance of nodeutils to reset the environment cache.
+* Extend vxlan_vtep_vni with attribute:
+  * `suppress_arp_disable`
+* Extend vxlan_vtep with attributes:
+  * `global_suppress_arp`
+  * `global_ingress_replication_bgp`
+  * `global_mcast_group_l2`
+  * `global_mcast_group_l3`
+
+### Removed
+  * Removed cache in `node_util.node`, which gave every inheriting class it's own cache.
+
+### Changed
+
 ## [v1.10.0]
 
 ### New Cisco Resources
@@ -587,6 +611,7 @@ Cisco::Environment.add_env('default', env)
 [git-flow]: https://github.com/petervanderdoes/gitflow-avh
 [SimpleCov]: https://github.com/colszowka/simplecov
 
+[v2.0.0]: https://github.com/cisco/cisco-network-node-utils/compare/v1.10.0...v2.0.0
 [v1.10.0]: https://github.com/cisco/cisco-network-node-utils/compare/v1.9.0...v1.10.0
 [v1.9.0]: https://github.com/cisco/cisco-network-node-utils/compare/v1.8.0...v1.9.0
 [v1.8.0]: https://github.com/cisco/cisco-network-node-utils/compare/v1.7.0...v1.8.0

data/lib/cisco_node_utils/bgp.rb

@@ -827,7 +827,7 @@ module Cisco
       # explicit values when removing the rd command. These restrictions are
       # not not needed in I3 and newer images.
       Feature.nv_overlay_evpn_enable if
-        Utils.nexus_i2_image || node.product_id[/N7/]
+        Utils.nexus_i2_image || node.product_id[/N[567]/]
 
       if rd == default_route_distinguisher
         return if route_distinguisher.empty?

data/lib/cisco_node_utils/cisco_cmn_utils.rb

@@ -113,6 +113,14 @@ module Cisco
       return true if Platform.chassis['pid'][ver_regexp]
     end
 
+    def self.fretta?
+      require_relative 'platform'
+      Platform.slots.each do |_x, row|
+        return true if row['pid'][/-R/]
+      end
+      false
+    end
+
     # Helper utility method for ip/prefix format networks.
     # For ip/prefix format '1.1.1.1/24' or '2000:123:38::34/64',
     # we need to mask the address using the prefix length so that they
@@ -362,9 +370,9 @@ module Cisco
     end # merge_range
 
     def self.add_quotes(value)
-      return value if image_version?(/7.3/)
-      value = "\"#{value}\"" unless
-        value.start_with?('"') && value.end_with?('"')
+      return value if image_version?(/7.3.[0-1]/) || value.nil?
+      value = "'#{value}'" unless
+        value.start_with?('"', "'") && value.end_with?('"', "'")
       value
     end # add_quotes
 

data/lib/cisco_node_utils/client/nxapi/client.rb

@@ -2,7 +2,7 @@
 #
 # November 2014, Glenn F. Matthews
 #
-# Copyright (c) 2014-2016 Cisco and/or its affiliates.
+# Copyright (c) 2014-2019 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.
@@ -60,7 +60,11 @@ class Cisco::Client::NXAPI < Cisco::Client
     else
       # Remote connection. This is primarily expected
       # when running e.g. from a Unix server as part of Minitest.
-      @http = Net::HTTP.new(@host)
+      @transport = kwargs[:transport] || 'http'
+      @verify_mode = kwargs[:verify_mode] || 'none'
+      @port.nil? ? @port = '' : @port = ":#{@port}"
+      uri = URI.parse("#{@transport}://#{@host}#{@port}")
+      @http = Net::HTTP.new(uri.host, uri.port)
     end
     # The default read time out is 60 seconds, which may be too short for
     # scaled configuration to apply. Change it to 300 seconds, which is
@@ -205,14 +209,18 @@ class Cisco::Client::NXAPI < Cisco::Client
     request = build_http_request(type, command)
 
     # send the request and get the response
-    debug("Sending HTTP request to NX-API at #{@http.address}:\n" \
+    debug("Sending #{@transport} request to NX-API at #{@http.address}:\n" \
           "#{request.to_hash}\n#{request.body}")
     read_timeout_check(request)
     tries = 2
     begin
-      # Explicitly use http to avoid EOFError
-      # http://stackoverflow.com/a/23080693
-      @http.use_ssl = false
+      if @transport == 'https'
+        debug('Setting use_ssl to true')
+        @http.use_ssl = true
+        @http.verify_mode = handle_verify_mode(@verify_mode)
+      else
+        @http.use_ssl = false
+      end
       response = @http.request(request)
     rescue Errno::ECONNREFUSED, Errno::ECONNRESET
       emsg = 'Connection refused or reset. Is the NX-API feature enabled?'
@@ -268,6 +276,32 @@ class Cisco::Client::NXAPI < Cisco::Client
   end
   private :build_http_request
 
+  # Returns the OpenSSL verify mode based on the verify_mode arguments
+  #
+  # @raise if verify_mode param is not `peer`, `client-once`, `fail-no-peer`
+  #        or `none`
+  #
+  # @param String verify mode to use
+  #
+  # @return OpenSSL::SSL verification mode
+  def handle_verify_mode(verify_mode)
+    case verify_mode
+    when 'peer'
+      OpenSSL::SSL::VERIFY_PEER
+    when 'client-once'
+      OpenSSL::SSL::VERIFY_CLIENT_ONCE
+    when 'fail-no-peer'
+      OpenSSL::SSL::VERIFY_FAIL_IF_NO_PEER_CERT
+    when 'none'
+      OpenSSL::SSL::VERIFY_NONE
+    else
+      fail "#{verify_mode} is not a valid mode, " \
+            'valid modes are: "none", "peer", ' \
+            '"client-once", "fail-no-peer"'
+    end
+  end
+  private :handle_verify_mode
+
   def handle_http_response(response)
     debug("HTTP Response: #{response.message}\n#{response.body}")
     case response

data/lib/cisco_node_utils/cmd_ref/acl.yaml

@@ -36,7 +36,7 @@ all_acls:
 
 fragments:
   # Note: The ACL 'fragments' keyword is independent of ACE 'fragments'
-  _exclude: [N5k, N6k]
+  _exclude: [N5k, N6k, N3k-F, N9k-F]
   get_value: '/fragments (\S+)$/'
   set_value: '<state> fragments <action>'
   default_value: ~

data/lib/cisco_node_utils/cmd_ref/banner.yaml

@@ -1,7 +1,11 @@
 # banner
 ---
 motd:
-  default_value: "User Access Verification\n"
+  N5k: &N6000
+    default_value: "Nexus 6000 Switch\n"
+  N6k: *N6000
+  else:
+    default_value: "User Access Verification\n"
   get_command: 'show banner motd'
   get_value: '/^.*$/m'
   set_value: '<state> banner motd <motd>'

data/lib/cisco_node_utils/cmd_ref/feature.yaml

@@ -31,8 +31,14 @@ fabric_forwarding:
   get_value: '/^feature fabric forwarding$/'
   set_value: "feature fabric forwarding"
 
+fabricpath:
+  _exclude: [N3k, N3k-F, N9k-F, N9k]
+  get_command: "show feature-set"
+  get_value: '/^fabricpath[\s\d]+(\w+)/'
+  set_value: "<state> feature-set fabricpath"
+
 fex:
-  _exclude: [C3064, C3132, N5k, N6k, N3k-F, N9k-F]
+  _exclude: [C3048, C3064, C3132, N5k, N6k, N3k-F, N9k-F]
   get_command: "show feature-set"
   get_value: '/^fex[\s\d]+(\w+)/'
   set_value: "<state> feature-set fex"
@@ -113,6 +119,7 @@ vni:
     set_value: 'feature vn-segment-vlan-based'
 
 vtp:
+  _exclude: [N3k-F, N9k-F]
   kind: boolean
   get_value: '/^feature vtp$/'
   set_value: "<state> feature vtp"

data/lib/cisco_node_utils/cmd_ref/interface_ospf.yaml

@@ -21,7 +21,7 @@ bfd:
   # no config at all so need to grab the optional
   # match to get the whole config for checking
   # the mode
-  get_value: '/^\s*ip ospf bfd *(?:\S+)?$/'
+  get_value: '/^\s*ip ospf bfd *(?:\S*)$/'
   set_value: '%s ip ospf bfd %s'
   default_value: ~
 

data/lib/cisco_node_utils/cmd_ref/interface_service_vni.yaml

@@ -11,6 +11,11 @@ _template:
     - 'interface <name>'
     - 'service instance <sid> vni'
 
+all_interfaces:
+  multiple:
+  get_context: ~
+  get_value: '/^interface (.*)/'
+
 all_service_vni_ids:
   multiple:
   get_context:

data/lib/cisco_node_utils/cmd_ref/inventory.yaml

@@ -41,5 +41,5 @@ versionid:
   nexus:
     get_value: ["name \"Chassis\"", "vendorid"]
   N5k: &vendorid5k
-    get_value: ["name Chassis", "serialnum"]
+    get_value: ["name Chassis", "vendorid"]
   N6k: *vendorid5k

data/lib/cisco_node_utils/cmd_ref/ospf.yaml

@@ -39,6 +39,13 @@ process_initialized:
   get_command: "show ip ospf stat"
   get_value: '/^No SAP is registered/' # Ospf is not initialized when seen
 
+redistribute:
+  # no support yet for redistribute maximum-prefix
+  multiple: true
+  get_value: '/^redistribute (\S+ ?\S+?) route-map (\S+)$/'
+  set_value: '<state> redistribute <protocol> route-map <route_map>'
+  default_value: []
+
 router:
   multiple: true
   get_command: "show running ospf"

data/lib/cisco_node_utils/cmd_ref/route_map.yaml

@@ -361,7 +361,7 @@ set_distance_local:
 
 # there is more than one space before delete on some platforms
 set_extcomm_list:
-  get_value: '/^set extcomm-list (\S+)(?:\s+)? delete$/'
+  get_value: '/^set extcomm-list (\S+)\s+delete$/'
   set_value: "<state> set extcomm-list <list> delete"
   default_value: false
 

data/lib/cisco_node_utils/cmd_ref/vtp.yaml

@@ -1,6 +1,6 @@
 # vtp
 ---
-_exclude: [ios_xr]
+_exclude: [ios_xr, N3k-F, N9k-F]
 
 # VTP behaves differently across the various Nexus platforms and as a
 # result it's not currently possible to use a single 'show running'

data/lib/cisco_node_utils/cmd_ref/vxlan_vtep.yaml

@@ -12,6 +12,36 @@ all_interfaces:
   get_context: ~
   get_value: '/^interface (.*)$/'
 
+global_ingress_replication_bgp:
+  _exclude: [N3k-F, N5k, N6k, N7k, N9k-F]
+  os_version: 'N9k:9.2'
+  kind: boolean
+  get_value: '/^global ingress-replication protocol bgp$/'
+  set_value: '<state> global ingress-replication protocol bgp'
+  default_value: false
+
+global_mcast_group_l2:
+  _exclude: [N3k-F, N5k, N6k, N7k]
+  os_version: 'N9k, N9k-F:9.2'
+  get_value: '/^global mcast-group (\S+) L2$/'
+  set_value: '<state> global mcast-group <ip> L2'
+  default_value: ~
+
+global_mcast_group_l3:
+  _exclude: [N3k-F, N5k, N6k, N7k, N9k-F]
+  os_version: 'N9k:9.2'
+  get_value: '/^global mcast-group (\S+) L3$/'
+  set_value: '<state> global mcast-group <ip> L3'
+  default_value: ~
+
+global_suppress_arp:
+  _exclude: [N3k-F, N5k, N6k, N7k]
+  os_version: 'N9k, N9k-F:9.2'
+  kind: boolean
+  get_value: '/^global suppress-arp$/'
+  set_value: '<state> global suppress-arp'
+  default_value: false
+
 host_reachability:
   get_value: '/^host-reachability protocol (\S+)/'
   set_value: '<state> host-reachability protocol <proto>'

data/lib/cisco_node_utils/cmd_ref/vxlan_vtep_vni.yaml

@@ -16,7 +16,7 @@ all_vnis:
   get_value: '/^member vni (\d+|\d+-\d+) ?(associate-vrf)?$/'
 
 ingress_replication:
-  _exclude: [N5k, N6k, N7k]
+  _exclude: [N3k-F, N5k, N6k, N7k, N9k-F]
   kind: string
   get_value: '/^ingress-replication protocol (\S+)$/'
   set_value: '<state> ingress-replication protocol <protocol>'
@@ -35,7 +35,7 @@ multisite_ingress_replication:
   default_value: false
 
 peer_list:
-  _exclude: [N5k, N6k, N7k]
+  _exclude: [N3k-F, N5k, N6k, N7k, N9k-F]
   multiple:
   get_context:
     - '/^interface <name>$/i'
@@ -55,6 +55,13 @@ suppress_arp:
   set_value: '<state> suppress-arp'
   default_value: false
 
+suppress_arp_disable:
+  _exclude: [N3k-F, N5k, N6k, N7k]
+  os_version: 'N9k, N9k-F:9.2'
+  get_value: '/^suppress-arp disable$/'
+  set_value: '<state> suppress-arp disable'
+  default_value: ~
+
 suppress_uuc:
   _exclude: [N3k-F, N9k-F, N9k]
   os_version: 'N7k:8.1.1'

data/lib/cisco_node_utils/command_reference.rb

@@ -437,8 +437,8 @@ module Cisco
       puts "DEBUG: #{text}" if @@debug
     end
 
-    KNOWN_PLATFORMS = %w(C3064 C3132 C3172 N35 N3k N3k-F N5k N6k N7k N9k N9k-F
-                         XRv9k)
+    KNOWN_PLATFORMS = %w(C3048 C3064 C3132 C3172 N35 N3k N3k-F N5k N6k N7k N9k
+                         N9k-F XRv9k)
 
     def self.platform_to_filter(platform)
       if KNOWN_PLATFORMS.include?(platform)

data/lib/cisco_node_utils/dhcp_relay_global.rb

@@ -172,7 +172,6 @@ module Cisco
 
     def ipv4_src_intf
       intf = config_get('dhcp_relay_global', 'ipv4_src_intf')
-      # Normalize by downcasing and removing white space
       intf = intf.downcase.delete(' ') if intf
       intf
     end
@@ -207,10 +206,7 @@ module Cisco
     def ipv4_sub_option_circuit_id_string
       str = config_get('dhcp_relay_global', 'ipv4_sub_option_circuit_id_string')
       # Normalize by removing white space and add quotes
-      if str
-        str.strip!
-        str = Utils.add_quotes(str)
-      end
+      str.strip! if str.kind_of?(String)
       str
     end
 

data/lib/cisco_node_utils/feature.rb

@@ -80,6 +80,27 @@ module Cisco
       config_get('feature', 'fabric')
     end
 
+    # ---------------------------
+    def self.fabricpath_enable
+      # install feature-set and enable it
+      return if fabricpath_enabled?
+      config_set('feature', 'fabricpath', state: 'install') unless
+        fabricpath_installed?
+      config_set('feature', 'fabricpath', state: '')
+    end
+
+    def self.fabricpath_enabled?
+      config_get('feature', 'fabricpath') =~ /^enabled/
+    end
+
+    def self.fabricpath_installed?
+      config_get('feature', 'fabricpath') !~ /^uninstalled/
+    end
+
+    def self.fabricpath_supported?
+      config_get('feature', 'fabricpath')
+    end
+
     #  ---------------------------
     def self.fabric_forwarding_enable
       return if fabric_forwarding_enabled?
@@ -183,7 +204,8 @@ module Cisco
     def self.nv_overlay_enable
       # Note: vdc platforms restrict this feature to F3 or newer linecards
       return if nv_overlay_enabled?
-      config_set('feature', 'nv_overlay', state: '')
+      result = config_set('feature', 'nv_overlay', state: '')
+      cli_error_check(result)
       sleep 1
     end
 
@@ -311,14 +333,18 @@ module Cisco
       # instead just displays a STDOUT error message; thus NXAPI does not detect
       # the failure and we must catch it by inspecting the "body" hash entry
       # returned by NXAPI. This cli behavior is unlikely to change soon.
+      patterns = [
+        'Hardware is not capable of supporting',
+        'is unsupported on this node',
+        'Feature NOT supported on this Platform',
+      ]
       fail result[2]['body'] if
         result[2].is_a?(Hash) &&
-        /Hardware is not capable of supporting/.match(result[2]['body'].to_s)
+        result[2]['body'].to_s[Regexp.union(patterns)]
 
       # Some test environments get result as a string instead of a hash
       fail result if
-        result.is_a?(String) &&
-        /Hardware is not capable of supporting/.match(result)
+        result.is_a?(String) && result[Regexp.union(patterns)]
     end
 
     # ---------------------------