cisco_node_utils 1.2.0 → 1.3.0

data/lib/cisco_node_utils/vpc.rb

@@ -1,4 +1,7 @@
-# David Chuck, November 2015
+#
+# NXAPI implementation of vpc domain class
+#
+# November 2015, Deepak Cherian
 #
 # Copyright (c) 2014-2016 Cisco and/or its affiliates.
 #
@@ -16,6 +19,7 @@
 
 require_relative 'node_util'
 require_relative 'interface'
+require_relative 'fabricpath_global'
 
 # Add vpc-specific constants to Cisco namespace
 module Cisco
@@ -25,7 +29,6 @@ module Cisco
     # Constructor for Vpc
     def initialize(domain_id, instantiate=true)
       @domain = domain_id
-      @set_params = {}
 
       create if instantiate
     end
@@ -146,6 +149,38 @@ module Cisco
                          'dual_active_exclude_interface_vlan_bridge_domain')
     end
 
+    def fabricpath_emulated_switch_id
+      config_get('vpc', 'fabricpath_emulated_switch_id')
+    end
+
+    def fabricpath_emulated_switch_id=(switch_id)
+      FabricpathGlobal.fabricpath_enable
+      set_args_keys(state: switch_id ? '' : 'no',
+                    swid:  switch_id ? switch_id : '')
+      config_set('vpc', 'fabricpath_emulated_switch_id', @set_args)
+    end
+
+    def default_fabricpath_emulated_switch_id
+      config_get_default('vpc', 'fabricpath_emulated_switch_id')
+    end
+
+    # Note: fabricpath_multicast_load_balance also requires
+    # fabricpath_emulated_switch_id before it will be functional but it
+    # will config & nvgen independently.
+    def fabricpath_multicast_load_balance
+      config_get('vpc', 'fabricpath_multicast_load_balance')
+    end
+
+    def fabricpath_multicast_load_balance=(state)
+      FabricpathGlobal.fabricpath_enable
+      set_args_keys(state: state ? '' : 'no')
+      config_set('vpc', 'fabricpath_multicast_load_balance', @set_args)
+    end
+
+    def default_fabricpath_multicast_load_balance
+      config_get_default('vpc', 'fabricpath_multicast_load_balance')
+    end
+
     def graceful_consistency_check
       val = config_get('vpc', 'graceful_consistency_check')
       val.nil? ? false : val
@@ -290,6 +325,23 @@ module Cisco
       config_get_default('vpc', 'peer_gateway_exclude_vlan')
     end
 
+    def port_channel_limit
+      val = config_get('vpc', 'port_channel_limit')
+      val.nil? ? false : val
+    end
+
+    def port_channel_limit=(val)
+      set_args_keys(state: val ? '' : 'no')
+      # This requires fabricpath_emulated_switch_id to be set first
+      fail 'fabricpath_switch_id configuration is required in the vPC domain' if
+        !fabricpath_emulated_switch_id && !val
+      config_set('vpc', 'port_channel_limit', @set_args)
+    end
+
+    def default_port_channel_limit
+      config_get_default('vpc', 'port_channel_limit')
+    end
+
     def role_priority
       config_get('vpc', 'role_priority')
     end
@@ -362,7 +414,7 @@ module Cisco
 
     def track=(val)
       unless val.nil?
-        fail ArgumentError, 'retransmit_count must be an Integer' unless
+        fail ArgumentError, 'track must be an Integer' unless
           val.is_a?(Integer)
       end
 

data/lib/cisco_node_utils/vrf.rb

@@ -30,6 +30,10 @@ module Cisco
       create if instantiate
     end
 
+    def to_s
+      "VRF #{@name}"
+    end
+
     def self.vrfs
       hash = {}
       vrf_list = config_get('vrf', 'all_vrfs')
@@ -63,14 +67,57 @@ module Cisco
       desc.strip!
       no_cmd = desc.empty? ? 'no' : ''
       config_set('vrf', 'description', vrf: @name, state: no_cmd, desc: desc)
-    rescue Cisco::CliError => e
-      raise "[#{@name}] '#{e.command}' : #{e.clierror}"
     end
 
     def default_description
       config_get_default('vrf', 'description')
     end
 
+    def mhost_ipv4_default_interface
+      config_get('vrf', 'mhost_default_interface', vrf: @name, afi: 'ipv4')
+    end
+
+    def mhost_ipv4_default_interface=(val)
+      mhost_default_interface_setter_helper('ipv4', val)
+    end
+
+    def default_mhost_ipv4_default_interface
+      config_get_default('vrf', 'mhost_default_interface')
+    end
+
+    def mhost_ipv6_default_interface
+      config_get('vrf', 'mhost_default_interface', vrf: @name, afi: 'ipv6')
+    end
+
+    def mhost_ipv6_default_interface=(val)
+      mhost_default_interface_setter_helper('ipv6', val)
+    end
+
+    def default_mhost_ipv6_default_interface
+      config_get_default('vrf', 'mhost_default_interface')
+    end
+
+    def mhost_default_interface_setter_helper(afi, val)
+      val.strip!
+      no_cmd = val.empty? ? 'no' : ''
+      config_set('vrf', 'mhost_default_interface', vrf: @name,
+                 state: no_cmd, afi: afi, intf: val)
+    end
+
+    def remote_route_filtering
+      config_get('vrf', 'remote_route_filtering', vrf: @name)
+    end
+
+    def remote_route_filtering=(val)
+      no_cmd = val ? 'no' : ''
+      config_set('vrf', 'remote_route_filtering', vrf: @name,
+                 state: no_cmd, remote_route_filtering: val)
+    end
+
+    def default_remote_route_filtering
+      config_get_default('vrf', 'remote_route_filtering')
+    end
+
     def shutdown
       config_get('vrf', 'shutdown', vrf: @name)
     end
@@ -78,8 +125,6 @@ module Cisco
     def shutdown=(val)
       no_cmd = (val) ? '' : 'no'
       config_set('vrf', 'shutdown', vrf: @name, state: no_cmd)
-    rescue Cisco::CliError => e
-      raise "[vrf #{@name}] '#{e.command}' : #{e.clierror}"
     end
 
     def default_shutdown
@@ -94,12 +139,16 @@ module Cisco
 
     def route_distinguisher=(rd)
       # feature bgp and nv overlay required for rd cli in NXOS
-      Feature.bgp_enable
-      Feature.nv_overlay_enable
-      Feature.nv_overlay_evpn_enable
+      if platform == :nexus
+        Feature.bgp_enable
+        Feature.nv_overlay_enable if Feature.nv_overlay_supported?
+        Feature.nv_overlay_evpn_enable if Feature.nv_overlay_evpn_supported?
+      end
       if rd == default_route_distinguisher
         state = 'no'
-        rd = ''
+        # I2 images require an rd for removal
+        rd = route_distinguisher
+        return if rd.to_s.empty?
       else
         state = ''
       end
@@ -116,16 +165,28 @@ module Cisco
     end
 
     def vni=(id)
-      Feature.vn_segment_vlan_based_enable
+      Feature.vn_segment_vlan_based_enable if platform == :nexus
       no_cmd = (id) ? '' : 'no'
       id = (id) ? id : vni
       config_set('vrf', 'vni', vrf: @name, state: no_cmd, id: id)
-    rescue Cisco::CliError => e
-      raise "[vrf #{@name}] '#{e.command}' : #{e.clierror}"
     end
 
     def default_vni
       config_get_default('vrf', 'vni')
     end
+
+    def vpn_id
+      config_get('vrf', 'vpn_id', vrf: @name)
+    end
+
+    def vpn_id=(val)
+      val.strip!
+      no_cmd = val.empty? ? 'no' : ''
+      config_set('vrf', 'vpn_id', vrf: @name, state: no_cmd, vpnid: val)
+    end
+
+    def default_vpn_id
+      config_get_default('vrf', 'vpn_id')
+    end
   end # class
 end # module

data/lib/cisco_node_utils/vrf_af.rb

@@ -23,19 +23,21 @@ require_relative 'feature'
 module Cisco
   # VrfAF - node utility class for VRF Address-Family configuration
   class VrfAF < NodeUtil
-    attr_reader :name
-
     def initialize(vrf, af, instantiate=true)
       validate_args(vrf, af)
       create if instantiate
     end
 
+    def to_s
+      "VRF #{@vrf} afi #{@afi} safi #{@safi}"
+    end
+
     def self.afs
       hash = {}
       vrfs = config_get('vrf', 'all_vrfs')
       vrfs.each do |vrf|
         hash[vrf] = {}
-        afs = config_get('vrf', 'all_vrf_afs', vrf: vrf)
+        afs = config_get('vrf_af', 'all_afs', vrf: vrf)
 
         next if afs.nil?
         afs.each do |af|
@@ -73,92 +75,160 @@ module Cisco
       @set_args = @get_args.merge!(hash) unless hash.empty?
     end
 
-    def route_target_feature_enable
+    def route_target_feature_enable(require_nv_overlay=nil)
+      return unless platform == :nexus
+
+      # All NX route-target properties require feature bgp
       Feature.bgp_enable
-      Feature.nv_overlay_enable
-      Feature.nv_overlay_evpn_enable
+
+      # Some platforms/versions also require nv overlay for some properties
+      return unless require_nv_overlay
+      Feature.nv_overlay_enable if Feature.nv_overlay_supported?
+      Feature.nv_overlay_evpn_enable if Feature.nv_overlay_evpn_supported?
     end
 
     ########################################################
     #                      PROPERTIES                      #
     ########################################################
 
+    def route_policy_export
+      config_get('vrf_af', 'route_policy_export', @get_args)
+    end
+
+    def route_policy_export=(name)
+      Feature.bgp_enable if platform == :nexus
+      # Nexus requires passing in <policy_name> in "no export map" command.
+      if name
+        set_args_keys(state: '', policy_name: name)
+      else
+        remove_name = config_get('vrf_af', 'route_policy_export', @get_args)
+        return nil if remove_name.nil?
+        set_args_keys(state: 'no', policy_name: remove_name)
+      end
+      config_set('vrf_af', 'route_policy_export', @set_args)
+    end
+
+    def default_route_policy_export
+      config_get_default('vrf_af', 'route_policy_export')
+    end
+
+    def route_policy_import
+      config_get('vrf_af', 'route_policy_import', @get_args)
+    end
+
+    def route_policy_import=(name)
+      Feature.bgp_enable if platform == :nexus
+      # Nexus requires passing in <policy_name> in "no import map" command.
+      if name
+        set_args_keys(state: '', policy_name: name)
+      else
+        remove_name = config_get('vrf_af', 'route_policy_import', @get_args)
+        return nil if remove_name.nil?
+        set_args_keys(state: 'no', policy_name: remove_name)
+      end
+      config_set('vrf_af', 'route_policy_import', @set_args)
+    end
+
+    def default_route_policy_import
+      config_get_default('vrf_af', 'route_policy_import')
+    end
+
+    # --------------------------
     def route_target_both_auto
-      config_get('vrf', 'route_target_both_auto', @get_args)
+      config_get('vrf_af', 'route_target_both_auto', @get_args)
     end
 
     def route_target_both_auto=(state)
-      route_target_feature_enable
+      route_target_feature_enable(:require_nv_overlay)
       set_args_keys(state: (state ? '' : 'no'))
-      config_set('vrf', 'route_target_both_auto', @set_args)
+      config_set('vrf_af', 'route_target_both_auto', @set_args)
     end
 
     def default_route_target_both_auto
-      config_get_default('vrf', 'route_target_both_auto')
+      config_get_default('vrf_af', 'route_target_both_auto')
     end
 
     # --------------------------
     def route_target_both_auto_evpn
-      config_get('vrf', 'route_target_both_auto_evpn', @get_args)
+      config_get('vrf_af', 'route_target_both_auto_evpn', @get_args)
     end
 
     def route_target_both_auto_evpn=(state)
-      route_target_feature_enable
+      route_target_feature_enable(:require_nv_overlay)
       set_args_keys(state: (state ? '' : 'no'))
-      config_set('vrf', 'route_target_both_auto_evpn', @set_args)
+      config_set('vrf_af', 'route_target_both_auto_evpn', @set_args)
     end
 
     def default_route_target_both_auto_evpn
-      config_get_default('vrf', 'route_target_both_auto_evpn')
+      config_get_default('vrf_af', 'route_target_both_auto_evpn')
     end
 
     # --------------------------
     def route_target_export
-      cmds = config_get('vrf', 'route_target_export', @get_args)
-      cmds.sort
+      cmds = config_get('vrf_af', 'route_target_export', @get_args)
+      cmds.nil? ? nil : cmds.sort
     end
 
     def route_target_export=(should)
+      route_target_feature_enable
       route_target_delta(should, route_target_export, 'route_target_export')
     end
 
     def default_route_target_export
-      config_get_default('vrf', 'route_target_export')
+      config_get_default('vrf_af', 'route_target_export')
     end
 
     # --------------------------
     def route_target_export_evpn
-      cmds = config_get('vrf', 'route_target_export_evpn', @get_args)
-      cmds.sort
+      cmds = config_get('vrf_af', 'route_target_export_evpn', @get_args)
+      cmds.nil? ? nil : cmds.sort
     end
 
     def route_target_export_evpn=(should)
+      route_target_feature_enable(:require_nv_overlay)
       route_target_delta(should, route_target_export_evpn,
                          'route_target_export_evpn')
     end
 
     def default_route_target_export_evpn
-      config_get_default('vrf', 'route_target_export_evpn')
+      config_get_default('vrf_af', 'route_target_export_evpn')
+    end
+
+    # --------------------------
+    def route_target_export_stitching
+      cmds = config_get('vrf_af', 'route_target_export_stitching', @get_args)
+      cmds.nil? ? nil : cmds.sort
+    end
+
+    def route_target_export_stitching=(should)
+      route_target_delta(should, route_target_export_stitching,
+                         'route_target_export_stitching')
+    end
+
+    def default_route_target_export_stitching
+      config_get_default('vrf_af', 'route_target_export_stitching')
     end
 
     # --------------------------
     def route_target_import
-      cmds = config_get('vrf', 'route_target_import', @get_args)
-      cmds.sort
+      cmds = config_get('vrf_af', 'route_target_import', @get_args)
+      cmds.nil? ? nil : cmds.sort
     end
 
     def route_target_import=(should)
+      route_target_feature_enable
       route_target_delta(should, route_target_import, 'route_target_import')
     end
 
     def default_route_target_import
-      config_get_default('vrf', 'route_target_import')
+      config_get_default('vrf_af', 'route_target_import')
     end
 
     # --------------------------
     def route_target_import_evpn
-      cmds = config_get('vrf', 'route_target_import_evpn', @get_args)
-      cmds.sort
+      route_target_feature_enable(:require_nv_overlay)
+      cmds = config_get('vrf_af', 'route_target_import_evpn', @get_args)
+      cmds.nil? ? nil : cmds.sort
     end
 
     def route_target_import_evpn=(should)
@@ -167,23 +237,38 @@ module Cisco
     end
 
     def default_route_target_import_evpn
-      config_get_default('vrf', 'route_target_import_evpn')
+      config_get_default('vrf_af', 'route_target_import_evpn')
+    end
+
+    # --------------------------
+    def route_target_import_stitching
+      cmds = config_get('vrf_af', 'route_target_import_stitching', @get_args)
+      cmds.nil? ? nil : cmds.sort
+    end
+
+    def route_target_import_stitching=(should)
+      route_target_delta(should, route_target_import_stitching,
+                         'route_target_import_stitching')
+    end
+
+    def default_route_target_import_stitching
+      config_get_default('vrf_af', 'route_target_import_stitching')
     end
 
     # --------------------------
     # route_target_delta is a common helper function for the route_target
     # properties. It walks the delta hash and adds/removes each target cli.
     def route_target_delta(should, is, prop)
-      route_target_feature_enable
+      fail Cisco::UnsupportedError.new('vrf_af', prop) if is.nil?
       delta_hash = Utils.delta_add_remove(should, is)
       return if delta_hash.values.flatten.empty?
       [:add, :remove].each do |action|
-        CiscoLogger.debug("#{prop}" \
+        Cisco::Logger.debug("#{prop}" \
           "#{@get_args}\n #{action}: #{delta_hash[action]}")
         delta_hash[action].each do |community|
           state = (action == :add) ? '' : 'no'
           set_args_keys(state: state, community: community)
-          config_set('vrf', prop, @set_args)
+          config_set('vrf_af', prop, @set_args)
         end
       end
     end