cisco_node_utils_mgx 2.1.0.1

data/lib/cisco_node_utils/fabricpath_topology.rb

@@ -0,0 +1,137 @@
+# Fabricpath Topology provider class
+#
+# Deepak Cherian, November 2015
+#
+# Copyright (c) 2015-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'
+require_relative 'fabricpath_global'
+
+module Cisco
+  # node_utils class for fabricpath_topology
+  class FabricpathTopo < NodeUtil
+    attr_reader :topo_id
+
+    def initialize(topo_id, instantiate=true)
+      @topo_id = topo_id.to_s
+      fail ArgumentError, "Invalid value(non-numeric
+                          Topo id #{@topo_id})" unless @topo_id[/^\d+$/]
+
+      create if instantiate
+    end
+
+    def self.topos
+      hash = {}
+      feature = config_get('fabricpath', 'feature')
+      return hash if feature.nil? || feature.to_sym != :enabled
+      topo_list = config_get('fabricpath_topology', 'all_topos')
+      return hash if topo_list.nil?
+
+      topo_list.each do |id|
+        hash[id] = FabricpathTopo.new(id, false)
+      end
+      hash
+    rescue Cisco::CliError => e
+      # cmd will syntax reject when feature is not enabled
+      raise unless e.clierror =~ /Syntax error/
+      return {}
+    end
+
+    def create
+      fabricpath_feature_set(:enabled) unless :enabled == fabricpath_feature
+      config_set('fabricpath_topology', 'create',
+                 topo_id: @topo_id) unless @topo_id == '0'
+    end
+
+    def destroy
+      config_set('fabricpath_topology', 'destroy', topo_id: @topo_id)
+    end
+
+    def fabricpath_feature
+      FabricpathGlobal.fabricpath_feature
+    end
+
+    def fabricpath_feature_set(fabricpath_set)
+      FabricpathGlobal.fabricpath_feature_set(fabricpath_set)
+    end
+
+    def member_vlans
+      config_get('fabricpath_topology', 'member_vlans',
+                 @topo_id).gsub(/\s+/, '')
+    end
+
+    def member_vlans=(str)
+      if str.empty?
+        state = 'no'
+        range = ''
+      else
+        state = ''
+        range = str
+        # reset existing range since we don't want incremental sets
+        config_set('fabricpath_topology', 'member_vlans', topo_id: @topo_id,
+                   state: 'no', vlan_range: '') if member_vlans != ''
+      end
+      config_set('fabricpath_topology', 'member_vlans', topo_id: @topo_id,
+                 state: state, vlan_range: range)
+    end
+
+    def default_member_vlans
+      config_get_default('fabricpath_topology', 'member_vlans')
+    end
+
+    def member_vnis
+      config_get('fabricpath_topology', 'member_vnis', @topo_id).gsub(/\s+/, '')
+    end
+
+    def member_vnis=(str)
+      debug "str is #{str} whose class is #{str.class}"
+      str = str.join(',') unless str.empty?
+      if str.empty?
+        state = 'no'
+        range = ''
+      else
+        state = ''
+        range = str
+      end
+      config_set('fabricpath_topology', 'member_vnis', topo_id: @topo_id,
+                 state: state, vni_range: range)
+    end
+
+    def default_member_vnis
+      config_get_default('fabricpath_topology', 'member_vlans')
+    end
+
+    def topo_name
+      config_get('fabricpath_topology', 'description', @topo_id)
+    end
+
+    def topo_name=(desc)
+      fail TypeError unless desc.is_a?(String)
+      if desc.empty?
+        state = 'no'
+        name = ''
+      else
+        state = ''
+        name = desc
+      end
+      config_set('fabricpath_topology', 'description', topo_id: @topo_id,
+                 state: state, name: name)
+    end
+
+    def default_topo_name
+      config_get_default('fabricpath_topology', 'description')
+    end
+  end # class
+end # module

data/lib/cisco_node_utils/feature.rb

@@ -0,0 +1,377 @@
+# January 2016, Robert W Gries
+#
+# Copyright (c) 2015-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.
+# 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
+  # Feature - node util class for managing common features
+  class Feature < NodeUtil
+    # Note that in most cases the enable methods should only enable;
+    # however, for test purposes it is sometimes convenient to support
+    # feature disablement for cleanup purposes.
+    # ---------------------------
+    def self.bfd_enable
+      return if bfd_enabled?
+      config_set('feature', 'bfd')
+    end
+
+    def self.bfd_enabled?
+      config_get('feature', 'bfd')
+    rescue Cisco::CliError => e
+      # cmd will syntax reject when feature is not enabled.
+      raise unless e.clierror =~ /Syntax error/
+      return false
+    end
+
+    # ---------------------------
+    def self.bgp_enable
+      return if bgp_enabled?
+      config_set('feature', 'bgp')
+    end
+
+    def self.bgp_enabled?
+      config_get('feature', 'bgp')
+    end
+
+    # ---------------------------
+    def self.dhcp_enable
+      return if dhcp_enabled?
+      config_set('feature', 'dhcp')
+    end
+
+    def self.dhcp_enabled?
+      config_get('feature', 'dhcp')
+    rescue Cisco::CliError => e
+      # cmd will syntax reject when feature is not enabled.
+      raise unless e.clierror =~ /Syntax error/
+      return false
+    end
+
+    # ---------------------------
+    def self.fabric_enable
+      # install feature-set and enable it
+      return if fabric_enabled?
+      config_set('feature', 'fabric', state: 'install') unless fabric_installed?
+      config_set('feature', 'fabric', state: '')
+    end
+
+    def self.fabric_enabled?
+      config_get('feature', 'fabric') =~ /^enabled/
+    end
+
+    def self.fabric_installed?
+      config_get('feature', 'fabric') !~ /^uninstalled/
+    end
+
+    def self.fabric_supported?
+      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?
+      Feature.fabric_enable if Feature.fabric_supported?
+      # The feature fabric-forwarding cli is required in some older nxos images
+      # but is not present in newer images because nv_overlay_evpn handles
+      # both features; therefore feature fabric-forwarding is best-effort
+      # and ignored on cli failure.
+      begin
+        config_set('feature', 'fabric_forwarding')
+      rescue Cisco::CliError
+        Cisco::Logger.debug '"feature fabric forwarding" CLI was rejected'
+      end
+    end
+
+    def self.fabric_forwarding_enabled?
+      config_get('feature', 'fabric_forwarding')
+    end
+
+    # ---------------------------
+    def self.fex_enable
+      # install feature-set and enable it
+      return if fex_enabled?
+      config_set('feature', 'fex', state: 'install') unless fex_installed?
+      config_set('feature', 'fex', state: '')
+    end
+
+    def self.fex_enabled?
+      config_get('feature', 'fex') =~ /^enabled/
+    end
+
+    def self.fex_installed?
+      config_get('feature', 'fex') !~ /^uninstalled/
+    end
+
+    def self.fex_supported?
+      config_get('feature', 'fex')
+    end
+
+    # ---------------------------
+    def self.hsrp_enable
+      return if hsrp_enabled?
+      config_set('feature', 'hsrp')
+    end
+
+    def self.hsrp_enabled?
+      config_get('feature', 'hsrp')
+    rescue Cisco::CliError => e
+      # cmd will syntax reject when feature is not enabled.
+      raise unless e.clierror =~ /Syntax error/
+      return false
+    end
+
+    # ---------------------------
+    def self.itd_enable
+      return if itd_enabled?
+      config_set('feature', 'itd')
+    end
+
+    def self.itd_enabled?
+      config_get('feature', 'itd')
+    rescue Cisco::CliError => e
+      # cmd will syntax reject when feature is not enabled.
+      raise unless e.clierror =~ /Syntax error/
+      return false
+    end
+
+    def self.lacp_enable
+      return if lacp_enabled?
+      config_set('feature', 'lacp')
+    end
+
+    def self.lacp_enabled?
+      config_get('feature', 'lacp')
+    rescue Cisco::CliError => e
+      # cmd will syntax reject when feature is not enabled.
+      raise unless e.clierror =~ /Syntax error/
+      return false
+    end
+
+    # ---------------------------
+    def self.ngmvpn_enable
+      return if ngmvpn_enabled?
+      config_set('feature', 'ngmvpn', state: '')
+    end
+
+    def self.ngmvpn_enabled?
+      config_get('feature', 'ngmvpn')
+    rescue Cisco::CliError => e
+      # cmd will syntax reject when feature is not enabled.
+      raise unless e.clierror =~ /Syntax error/
+      return false
+    end
+
+    def self.ngmvpn_disable
+      return unless ngmvpn_enabled?
+      config_set('feature', 'ngmvpn', state: 'no')
+    end
+
+    # ---------------------------
+    def self.nv_overlay_enable
+      # Note: vdc platforms restrict this feature to F3 or newer linecards
+      return if nv_overlay_enabled?
+      result = config_set('feature', 'nv_overlay', state: '')
+      cli_error_check(result)
+      sleep 1
+    end
+
+    def self.nv_overlay_disable
+      # Note: vdc platforms restrict this feature to F3 or newer linecards
+      # Note: this is for test purposes only
+      return unless nv_overlay_enabled?
+      config_set('feature', 'nv_overlay', state: 'no')
+      sleep 1
+    end
+
+    def self.nv_overlay_enabled?
+      config_get('feature', 'nv_overlay')
+    rescue Cisco::CliError => e
+      # cmd will syntax reject when feature is not enabled.
+      raise unless e.clierror =~ /Syntax error/
+      return false
+    end
+
+    def self.nv_overlay_supported?
+      node.cmd_ref.supports?('feature', 'nv_overlay')
+    end
+
+    # ---------------------------
+    def self.nv_overlay_evpn_enable
+      return if nv_overlay_evpn_enabled?
+      config_set('feature', 'nv_overlay_evpn')
+    end
+
+    def self.nv_overlay_evpn_enabled?
+      config_get('feature', 'nv_overlay_evpn')
+    end
+
+    def self.nv_overlay_evpn_supported?
+      node.cmd_ref.supports?('feature', 'nv_overlay_evpn')
+    end
+
+    # ---------------------------
+    def self.ospf_enable
+      return if ospf_enabled?
+      config_set('feature', 'ospf')
+    end
+
+    def self.ospf_enabled?
+      config_get('feature', 'ospf')
+    end
+
+    # ---------------------------
+    def self.pim_enable
+      return if pim_enabled?
+      config_set('feature', 'pim')
+    end
+
+    def self.pim_enabled?
+      config_get('feature', 'pim')
+    end
+
+    # ---------------------------
+    def self.private_vlan_enable
+      return if private_vlan_enabled?
+      config_set('feature', 'private_vlan')
+    end
+
+    def self.private_vlan_enabled?
+      config_get('feature', 'private_vlan')
+    end
+
+    # ---------------------------
+    def self.tacacs_enable
+      return if tacacs_enabled? || platform == :ios_xr
+      config_set('feature', 'tacacs')
+    end
+
+    def self.tacacs_enabled?
+      config_get('feature', 'tacacs')
+    end
+
+    # ---------------------------
+    def self.vn_segment_vlan_based_enable
+      return if vn_segment_vlan_based_enabled?
+      result = config_set('feature', 'vn_segment_vlan_based')
+      cli_error_check(result)
+    end
+
+    def self.vn_segment_vlan_based_enabled?
+      config_get('feature', 'vn_segment_vlan_based')
+    end
+
+    # ---------------------------
+    def self.vni_enable
+      return if vni_enabled?
+      result = config_set('feature', 'vni')
+      cli_error_check(result)
+    end
+
+    def self.vni_enabled?
+      config_get('feature', 'vni')
+    end
+
+    # ---------------------------
+    def self.vtp_enable
+      return if vtp_enabled?
+      result = config_set('feature', 'vtp', state: '')
+      cli_error_check(result)
+    end
+
+    # Special Case: The only way to remove a vtp instance
+    # is by disabling the feature.
+    def self.vtp_disable
+      return unless vtp_enabled?
+      config_set('feature', 'vtp', state: 'no')
+    end
+
+    def self.vtp_enabled?
+      config_get('feature', 'vtp')
+    rescue Cisco::CliError => e
+      # cmd will syntax reject when feature is not enabled.
+      raise unless e.clierror =~ /Syntax error/
+      return false
+    end
+
+    # ---------------------------
+    def self.cli_error_check(result)
+      # The NXOS feature cli may not raise an exception in some conditions and
+      # 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) &&
+        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) && result[Regexp.union(patterns)]
+    end
+
+    # ---------------------------
+    def self.compatible_interfaces(feature, property='supported_module_pids')
+      # Figure out the interfaces in a modular switch that are
+      # compatible with the given feature (or property within a feature)
+      # and return an array of such interfaces
+      module_pids = config_get(feature, property)
+      return [] if module_pids.nil?
+      module_regex = Regexp.new module_pids
+      # first get the compatible modules present in the switch
+      slots = Platform.slots.select do |_slot, filt_mod|
+        filt_mod['pid'] =~ module_regex
+      end
+      return [] if slots.empty?
+      # get the slot numbers only into filtered slots array
+      filt_slots = slots.keys.map { |key| key[/\d+/] }
+      # now filter interfaces in the vdc based on compatible slots
+      begin
+        vdc = Vdc.new(Vdc.default_vdc_name)
+        filt_intfs = vdc.interface_membership.select do |intf|
+          filt_slots.include? intf[/\d+/]
+        end
+      rescue CliError
+        filt_intfs = []
+      end
+      filt_intfs
+    end
+  end
+end

data/lib/cisco_node_utils/hostname.rb

@@ -0,0 +1,62 @@
+# Hostname provider class
+#
+# September 2018
+#
+# Copyright (c) 2014-2018 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
+  # Hostname- node utility class for hostname configuration
+  class HostName < NodeUtil
+    attr_reader :name
+
+    def initialize(name, instantiate=true)
+      @name = name
+      create if instantiate
+    end
+
+    def self.hostname
+      hash = {}
+      hostname = config_get('hostname', 'name')
+      hash[hostname] = HostName.new(hostname, false)
+      hash
+    end
+
+    def hostname=(host)
+      if host
+        config_set(
+          'hostname', 'name',
+          state: '', name: host)
+      else
+        config_set(
+          'hostname', 'name',
+          state: 'no', name: '')
+      end
+    end
+
+    def ==(other)
+      name == other.name
+    end
+
+    def create
+      config_set('hostname', 'name', state: '', name: @name)
+    end
+
+    def destroy
+      config_set('hostname', 'name', state: 'no', name: @name)
+    end
+  end # class
+end # module

data/lib/cisco_node_utils/hsrp_global.rb

@@ -0,0 +1,97 @@
+# October 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 hsrp_global
+  class HsrpGlobal < NodeUtil
+    def initialize(instantiate=true)
+      Feature.hsrp_enable if instantiate
+      set_args_keys_default
+    end
+
+    def self.globals
+      hash = {}
+      hash['default'] = HsrpGlobal.new(false) if Feature.hsrp_enabled?
+      hash
+    end
+
+    # Helper method to delete @set_args hash keys
+    def set_args_keys_default
+      @set_args = {}
+      @get_args = @set_args
+    end
+
+    # rubocop:disable Style/AccessorMethodName
+    def set_args_keys(hash={})
+      set_args_keys_default
+      @set_args = @get_args.merge!(hash) unless hash.empty?
+    end
+
+    def destroy
+      return unless Feature.hsrp_enabled?
+      [:bfd_all_intf,
+       :extended_hold,
+      ].each do |prop|
+        send("#{prop}=", send("default_#{prop}")) if send prop
+      end
+      set_args_keys_default
+    end
+
+    ########################################################
+    #                      PROPERTIES                      #
+    ########################################################
+
+    def bfd_all_intf
+      config_get('hsrp_global', 'bfd_all_intf')
+    end
+
+    def bfd_all_intf=(val)
+      state = val ? '' : 'no'
+      set_args_keys(state: state)
+      Feature.bfd_enable if val
+      config_set('hsrp_global', 'bfd_all_intf', @set_args)
+    end
+
+    def default_bfd_all_intf
+      config_get_default('hsrp_global', 'bfd_all_intf')
+    end
+
+    # CLI can be either of the following or none
+    # hsrp timers extended-hold (in this case, the time is 10)
+    # hsrp timers extended-hold <time>
+    def extended_hold
+      hold = config_get('hsrp_global', 'extended_hold', @get_args)
+      return default_extended_hold unless hold
+      arr = hold.split('hsrp timers extended-hold')
+      return config_get('hsrp_global', 'extended_hold_enable', @get_args) if
+        arr.empty?
+      arr[1].strip
+    end
+
+    def extended_hold=(val)
+      state = val ? '' : 'no'
+      time = val ? val : ''
+      set_args_keys(state: state, time: time)
+      config_set('hsrp_global', 'extended_hold', @set_args)
+    end
+
+    def default_extended_hold
+      config_get_default('hsrp_global', 'extended_hold')
+    end
+  end # class
+end # module