cisco_node_utils 1.3.0 → 1.4.0

data/cisco_node_utils.gemspec

@@ -14,7 +14,7 @@ Gem::Specification.new do |spec|
   spec.description   = <<-EOF
 Utilities for management of Cisco network nodes.
 Designed to work with Puppet and Chef.
-Currently supports NX-OS and IOS XR nodes.
+Currently supports NX-OS nodes.
   EOF
   spec.license       = 'Apache-2.0'
   spec.homepage      = 'https://github.com/cisco/cisco-network-node-utils'

data/docs/README-maintainers.md

@@ -48,6 +48,7 @@ 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/docs/README-utilities.md

@@ -0,0 +1,14 @@
+# Executable utilities included in this gem
+
+## check_metric_limits.rb
+
+This is a helper script for developers. If you're doing refactoring work to
+reduce the code complexity metrics, you can run this script to report the
+worst offenders for each metric and whether you've managed to improve any
+metrics compared to the baseline.  Run this script from the base
+cisco-network-node-utils directory to report metrics of code in the
+./lib and ./tests directories.
+
+```bash
+[cisco-network-node-utils]$ ruby bin/check_metric_limits.rb
+```

data/lib/.rubocop.yml

@@ -12,7 +12,7 @@ Metrics/MethodLength:
   Max: 50
 
 Metrics/ParameterLists:
-  Max: 9
+  Max: 10
 
 Metrics/PerceivedComplexity:
   Max: 24

data/lib/cisco_node_utils/aaa_authentication_login_service.rb

@@ -57,9 +57,14 @@ module Cisco
 
       if g_str.empty?
         # cannot remove default local, so do nothing in this case
-        unless m == :local && @name == 'default'
-          config_set('aaa_auth_login_service', 'method',
-                     'no', @name, m_str)
+        unless m == :local
+          unless node.product_id[/N8/]
+            # TBD: These 'no' commands currently error on N8k
+            #   no aaa authentication login console local
+            #   no aaa authentication login console none
+            config_set('aaa_auth_login_service', 'method',
+                       'no', @name, m_str)
+          end
         end
       else
         config_set('aaa_auth_login_service', 'groups',

data/lib/cisco_node_utils/aaa_authorization_service.rb

@@ -39,6 +39,10 @@ module Cisco
       config_set('aaa_authorization_service', 'method', '', type_str, name)
     end
 
+    def self.remove_local_auth
+      config_get('aaa_authorization_service', 'remove_local_auth')
+    end
+
     def self.services
       servs = {}
       servs_arr = config_get('aaa_authorization_service', 'services')
@@ -66,6 +70,8 @@ module Cisco
                      'no', t_str, @name)
         end
       else
+        # Removal of auth method local is not supported on all platforms.
+        m_str = AaaAuthorizationService.remove_local_auth ? m_str : ''
         config_set('aaa_authorization_service', 'groups',
                    'no', t_str, @name, g_str, m_str)
       end

data/lib/cisco_node_utils/bfd_global.rb

@@ -0,0 +1,300 @@
+#
+# NXAPI implementation of BFD Global class
+#
+# May 2016, Sai Chintalapudi
+#
+# Copyright (c) 2016 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.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require_relative 'node_util'
+
+module Cisco
+  # node_utils class for bfd_global
+  class BfdGlobal < NodeUtil
+    attr_reader :name
+
+    def initialize(instantiate=true)
+      set_args_keys_default
+
+      Feature.bfd_enable if instantiate
+    end
+
+    # Reset everything back to default
+    def destroy
+      return unless Feature.bfd_enabled?
+      [:interval,
+       :ipv4_interval,
+       :ipv6_interval,
+       :fabricpath_interval,
+       :echo_interface,
+       :echo_rx_interval,
+       :ipv4_echo_rx_interval,
+       :ipv6_echo_rx_interval,
+       :fabricpath_vlan,
+       :slow_timer,
+       :ipv4_slow_timer,
+       :ipv6_slow_timer,
+       :fabricpath_slow_timer,
+       :startup_timer,
+      ].each do |prop|
+        send("#{prop}=", send("default_#{prop}")) if
+          send prop
+      end
+      set_args_keys_default
+    end
+
+    # Helper method to delete @set_args hash keys
+    def set_args_keys_default
+      keys = { state: '' }
+      @get_args = @set_args = keys
+    end
+
+    # rubocop:disable Style/AccessorMethodName
+    def set_args_keys(hash={})
+      set_args_keys_default
+      @set_args = @get_args.merge!(hash) unless hash.empty?
+    end
+
+    ########################################################
+    #                      PROPERTIES                      #
+    ########################################################
+
+    def echo_interface
+      config_get('bfd_global', 'echo_interface', @get_args)
+    end
+
+    def echo_interface=(val)
+      set_args_keys(intf:  val ? val : echo_interface,
+                    state: val ? '' : 'no')
+      config_set('bfd_global', 'echo_interface', @set_args) if
+        @set_args[:intf]
+    end
+
+    def default_echo_interface
+      config_get_default('bfd_global', 'echo_interface')
+    end
+
+    def echo_rx_interval
+      config_get('bfd_global', 'echo_rx_interval', @get_args)
+    end
+
+    def echo_rx_interval=(val)
+      set_args_keys(rxi:   val,
+                    state: val == default_echo_rx_interval ? 'no' : '')
+      config_set('bfd_global', 'echo_rx_interval', @set_args)
+    end
+
+    def default_echo_rx_interval
+      config_get_default('bfd_global', 'echo_rx_interval')
+    end
+
+    def ipv4_echo_rx_interval
+      config_get('bfd_global', 'ipv4_echo_rx_interval', @get_args)
+    end
+
+    def ipv4_echo_rx_interval=(val)
+      set_args_keys(rxi:   val,
+                    state: val == default_ipv4_echo_rx_interval ? 'no' : '')
+      config_set('bfd_global', 'ipv4_echo_rx_interval', @set_args)
+    end
+
+    def default_ipv4_echo_rx_interval
+      config_get_default('bfd_global', 'ipv4_echo_rx_interval')
+    end
+
+    def ipv6_echo_rx_interval
+      config_get('bfd_global', 'ipv6_echo_rx_interval', @get_args)
+    end
+
+    def ipv6_echo_rx_interval=(val)
+      set_args_keys(rxi:   val,
+                    state: val == default_ipv6_echo_rx_interval ? 'no' : '')
+      config_set('bfd_global', 'ipv6_echo_rx_interval', @set_args)
+    end
+
+    def default_ipv6_echo_rx_interval
+      config_get_default('bfd_global', 'ipv6_echo_rx_interval')
+    end
+
+    def slow_timer
+      config_get('bfd_global', 'slow_timer', @get_args)
+    end
+
+    def slow_timer=(val)
+      set_args_keys(timer: val,
+                    state: val == default_slow_timer ? 'no' : '')
+      config_set('bfd_global', 'slow_timer', @set_args)
+    end
+
+    def default_slow_timer
+      config_get_default('bfd_global', 'slow_timer')
+    end
+
+    def ipv4_slow_timer
+      config_get('bfd_global', 'ipv4_slow_timer', @get_args)
+    end
+
+    def ipv4_slow_timer=(val)
+      set_args_keys(timer: val,
+                    state: val == default_ipv4_slow_timer ? 'no' : '')
+      config_set('bfd_global', 'ipv4_slow_timer', @set_args)
+    end
+
+    def default_ipv4_slow_timer
+      config_get_default('bfd_global', 'ipv4_slow_timer')
+    end
+
+    def ipv6_slow_timer
+      config_get('bfd_global', 'ipv6_slow_timer', @get_args)
+    end
+
+    def ipv6_slow_timer=(val)
+      set_args_keys(timer: val,
+                    state: val == default_ipv6_slow_timer ? 'no' : '')
+      config_set('bfd_global', 'ipv6_slow_timer', @set_args)
+    end
+
+    def default_ipv6_slow_timer
+      config_get_default('bfd_global', 'ipv6_slow_timer')
+    end
+
+    def fabricpath_slow_timer
+      config_get('bfd_global', 'fabricpath_slow_timer', @get_args)
+    end
+
+    def fabricpath_slow_timer=(val)
+      set_args_keys(timer: val,
+                    state: val == default_fabricpath_slow_timer ? 'no' : '')
+      config_set('bfd_global', 'fabricpath_slow_timer', @set_args)
+    end
+
+    def default_fabricpath_slow_timer
+      config_get_default('bfd_global', 'fabricpath_slow_timer')
+    end
+
+    def startup_timer
+      config_get('bfd_global', 'startup_timer', @get_args)
+    end
+
+    def startup_timer=(val)
+      set_args_keys(timer: val,
+                    state: val == default_startup_timer ? 'no' : '')
+      config_set('bfd_global', 'startup_timer', @set_args)
+    end
+
+    def default_startup_timer
+      config_get_default('bfd_global', 'startup_timer')
+    end
+
+    def fabricpath_vlan
+      config_get('bfd_global', 'fabricpath_vlan', @get_args)
+    end
+
+    def fabricpath_vlan=(val)
+      set_args_keys(vlan:  val,
+                    state: val == default_fabricpath_vlan ? 'no' : '')
+      config_set('bfd_global', 'fabricpath_vlan', @set_args)
+    end
+
+    def default_fabricpath_vlan
+      config_get_default('bfd_global', 'fabricpath_vlan')
+    end
+
+    def default_interval
+      config_get_default('bfd_global', 'interval')
+    end
+
+    def default_ipv4_interval
+      config_get_default('bfd_global', 'ipv4_interval')
+    end
+
+    def default_ipv6_interval
+      config_get_default('bfd_global', 'ipv6_interval')
+    end
+
+    def default_fabricpath_interval
+      config_get_default('bfd_global', 'fabricpath_interval')
+    end
+
+    # interval is an array of interval, min_rx and multiplier
+    # CLI: bfd interval 100 min_rx 100 multiplier 25
+    def interval
+      config_get('bfd_global', 'interval', @get_args)
+    end
+
+    # ipv4_interval is an array of ipv4_interval, ipv4_min_rx and
+    # ipv4_multiplier
+    # CLI: bfd ipv4 interval 100 min_rx 100 multiplier 25
+    def ipv4_interval
+      config_get('bfd_global', 'ipv4_interval', @get_args)
+    end
+
+    # ipv6_interval is an array of ipv6_interval, ipv6_min_rx and
+    # ipv6_multiplier
+    # CLI: bfd ipv6 interval 100 min_rx 100 multiplier 25
+    def ipv6_interval
+      config_get('bfd_global', 'ipv6_interval', @get_args)
+    end
+
+    # fabricpath_interval is an array of fabricpath_interval,
+    # fabricpath_min_rx and fabricpath_multiplier
+    # CLI: bfd fabricpath interval 100 min_rx 100 multiplier 25
+    def fabricpath_interval
+      config_get('bfd_global', 'fabricpath_interval', @get_args)
+    end
+
+    # interval is an array of interval, min_rx and multiplier
+    # ex: ['100', '100', '25']
+    # CLI: bfd interval 100 min_rx 100 multiplier 25
+    def interval=(arr)
+      interval, min_rx, multiplier = arr
+      set_args_keys(interval: interval, min_rx: min_rx, multiplier: multiplier,
+                    state: arr == default_interval ? 'no' : '')
+      config_set('bfd_global', 'interval', @set_args)
+    end
+
+    # ipv4_interval is an array of ipv4_interval, ipv4_min_rx and
+    # ipv4_multiplier
+    # ex: ['100', '100', '25']
+    # CLI: bfd ipv4 interval 100 min_rx 100 multiplier 25
+    def ipv4_interval=(arr)
+      interval, min_rx, multiplier = arr
+      set_args_keys(interval: interval, min_rx: min_rx, multiplier: multiplier,
+                    state: arr == default_ipv4_interval ? 'no' : '')
+      config_set('bfd_global', 'ipv4_interval', @set_args)
+    end
+
+    # ipv6_interval is an array of ipv6_interval, ipv6_min_rx and
+    # ipv6_multiplier
+    # ex: ['100', '100', '25']
+    # CLI: bfd ipv6 interval 100 min_rx 100 multiplier 25
+    def ipv6_interval=(arr)
+      interval, min_rx, multiplier = arr
+      set_args_keys(interval: interval, min_rx: min_rx, multiplier: multiplier,
+                    state: arr == default_ipv6_interval ? 'no' : '')
+      config_set('bfd_global', 'ipv6_interval', @set_args)
+    end
+
+    # fabricpath_interval is an array of fabricpath_interval,
+    # fabricpath_min_rx and fabricpath_multiplier
+    # ex: ['100', '100', '25']
+    # CLI: bfd fabricpath interval 100 min_rx 100 multiplier 25
+    def fabricpath_interval=(arr)
+      interval, min_rx, multiplier = arr
+      set_args_keys(interval: interval, min_rx: min_rx, multiplier: multiplier,
+                    state: arr == default_fabricpath_interval ? 'no' : '')
+      config_set('bfd_global', 'fabricpath_interval', @set_args)
+    end
+  end # class
+end # module

data/lib/cisco_node_utils/bgp.rb

@@ -100,7 +100,7 @@ module Cisco
     end
 
     def wait_for_process_initialized
-      return unless node.product_id[/N(5|6)/]
+      return unless node.product_id[/N(5|6|8)/]
 
       # Hack for slow-start platforms which will have setter failures if the
       # bgp instance is still initializing. To see this problem in a sandbox
@@ -462,7 +462,7 @@ module Cisco
     def event_history_events
       match = config_get('bgp', 'event_history_events', @get_args)
       if match.is_a?(Array)
-        return 'false' if match[0] == 'no '
+        return 'size_disable' if match[0] == 'no '
         return 'size_' + match[1] if match[1]
       end
       default_event_history_events
@@ -805,7 +805,8 @@ module Cisco
       # N3k I2 images require 'nv overlay evpn' for rd and also require
       # 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
+      Feature.nv_overlay_evpn_enable if
+        Utils.nexus_i2_image || node.product_id[/N7/]
 
       if rd == default_route_distinguisher
         return if route_distinguisher.empty?
@@ -867,7 +868,8 @@ module Cisco
 
     # Supress Fib Pending (Getter/Setter/Default)
     def suppress_fib_pending
-      config_get('bgp', 'suppress_fib_pending', @get_args)
+      val = config_get('bgp', 'suppress_fib_pending', @get_args)
+      val.nil? ? false : val
     end
 
     def suppress_fib_pending=(enable)

data/lib/cisco_node_utils/bgp_af.rb

@@ -29,6 +29,8 @@ module Cisco
       err_msg = '"af" argument must be an array of two string values ' \
         'containing an afi + safi tuple'
       fail ArgumentError, err_msg unless af.is_a?(Array) || af.length == 2
+      err_msg = '"vrf" argument must be "default" for l2vpn address-family'
+      fail ArgumentError, err_msg if vrf != 'default' && af[1][/evpn/]
       @asn = RouterBgp.validate_asnum(asn)
       @vrf = vrf
       @afi, @safi = af

data/lib/cisco_node_utils/bgp_neighbor.rb

@@ -88,6 +88,20 @@ module Cisco
       @set_args = @set_args.merge!(hash) unless hash.empty?
     end
 
+    def bfd=(val)
+      set_args_keys(state: (val) ? '' : 'no')
+      Feature.bfd_enable
+      config_set('bgp_neighbor', 'bfd', @set_args)
+    end
+
+    def bfd
+      config_get('bgp_neighbor', 'bfd', @get_args)
+    end
+
+    def default_bfd
+      config_get_default('bgp_neighbor', 'bfd')
+    end
+
     def description=(desc)
       fail TypeError unless desc.is_a?(String)
       desc.strip!