cisco_node_utils_mgx 2.1.0.1

data/lib/cisco_node_utils/vpc.rb

@@ -0,0 +1,466 @@
+#
+# NXAPI implementation of vpc domain class
+#
+# November 2015, Deepak Cherian
+#
+# Copyright (c) 2014-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 'interface'
+require_relative 'fabricpath_global'
+
+# Add vpc-specific constants to Cisco namespace
+module Cisco
+  # Vpc - node utility class for VTP configuration management
+  class Vpc < NodeUtil
+    attr_reader :domain
+    # Constructor for Vpc
+    def initialize(domain_id, instantiate=true)
+      @domain = domain_id
+
+      create if instantiate
+    end
+
+    def self.domains
+      hash = {}
+      return hash unless Vpc.enabled
+      my_domain = config_get('vpc', 'domain')
+      hash[my_domain] = Vpc.new(my_domain, false) unless my_domain.nil?
+      hash
+    end
+
+    def self.enabled
+      config_get('vpc', 'feature')
+    rescue Cisco::CliError => e
+      # cmd will syntax reject when feature is not enabled
+      raise unless e.clierror =~ /Syntax error/
+      return false
+    end
+
+    def create
+      enable unless Vpc.enabled
+      config_set('vpc', 'domain', state: '', domain: @domain)
+    end
+
+    def destroy
+      config_set('vpc', 'feature', state: 'no')
+    end
+
+    def enable
+      config_set('vpc', 'feature', state: '')
+    end
+
+    def set_args_keys_default
+      keys = { domain: @domain }
+      @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
+    # rubocop:enable Style/AccessorMethodNamefor
+
+    ########################################################
+    #                      PROPERTIES                      #
+    ########################################################
+
+    def auto_recovery
+      val = config_get('vpc', 'auto_recovery')
+      val.nil? ? false : val
+    end
+
+    def auto_recovery=(val)
+      set_args_keys(state: val ? '' : 'no')
+      config_set('vpc', 'auto_recovery', @set_args)
+    end
+
+    def default_auto_recovery
+      config_get_default('vpc', 'auto_recovery')
+    end
+
+    def auto_recovery_reload_delay
+      config_get('vpc', 'auto_recovery_reload_delay')
+    end
+
+    def auto_recovery_reload_delay=(val)
+      set_args_keys(delay: val)
+      config_set('vpc', 'auto_recovery_reload_delay', @set_args)
+    end
+
+    def default_auto_recovery_reload_delay
+      config_get_default('vpc', 'auto_recovery_reload_delay')
+    end
+
+    def delay_restore
+      config_get('vpc', 'delay_restore')
+    end
+
+    def delay_restore=(delay)
+      set_args_keys(delay: delay)
+      config_set('vpc', 'delay_restore', @set_args)
+    end
+
+    def default_delay_restore
+      config_get_default('vpc', 'delay_restore')
+    end
+
+    def delay_restore_interface_vlan
+      config_get('vpc', 'delay_restore_interface_vlan')
+    end
+
+    def delay_restore_interface_vlan=(delay)
+      set_args_keys(delay: delay)
+      config_set('vpc', 'delay_restore_interface_vlan', @set_args)
+    end
+
+    def default_delay_restore_interface_vlan
+      config_get_default('vpc', 'delay_restore_interface_vlan')
+    end
+
+    def dual_active_exclude_interface_vlan_bridge_domain
+      config_get('vpc', 'dual_active_exclude_interface_vlan_bridge_domain')
+    end
+
+    def dual_active_exclude_interface_vlan_bridge_domain=(val)
+      set_args_keys(state: val ? '' : 'no', range: val)
+      config_set('vpc', 'dual_active_exclude_interface_vlan_bridge_domain',
+                 @set_args)
+    end
+
+    def default_dual_active_exclude_interface_vlan_bridge_domain
+      config_get_default('vpc',
+                         '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
+    end
+
+    def graceful_consistency_check=(val)
+      set_args_keys(state: val ? '' : 'no')
+      config_set('vpc', 'graceful_consistency_check', @set_args)
+    end
+
+    def default_graceful_consistency_check
+      config_get_default('vpc', 'graceful_consistency_check')
+    end
+
+    def layer3_peer_routing
+      config_get('vpc', 'layer3_peer_routing')
+    end
+
+    def layer3_peer_routing=(val)
+      return if val == layer3_peer_routing
+      set_args_keys(state: val ? '' : 'no')
+      # This requires peer_gateway to be set first
+      self.peer_gateway = true if !peer_gateway && val
+      config_set('vpc', 'layer3_peer_routing', @set_args)
+    end
+
+    def default_layer3_peer_routing
+      config_get_default('vpc', 'layer3_peer_routing')
+    end
+
+    # peer keepalive
+    def peer_keepalive_dest
+      config_get('vpc', 'peer_keepalive_dest')
+    end
+
+    def default_peer_keepalive_dest
+      config_get_default('vpc', 'peer_keepalive_dest')
+    end
+
+    def peer_keepalive_hold_timeout
+      config_get('vpc', 'peer_keepalive_hold_timeout')
+    end
+
+    def default_peer_keepalive_hold_timeout
+      config_get_default('vpc', 'peer_keepalive_hold_timeout')
+    end
+
+    def peer_keepalive_interval
+      config_get('vpc', 'peer_keepalive_interval')
+    end
+
+    def default_peer_keepalive_interval
+      config_get_default('vpc', 'peer_keepalive_interval')
+    end
+
+    def peer_keepalive_interval_timeout
+      config_get('vpc', 'peer_keepalive_timeout')
+    end
+
+    def default_peer_keepalive_interval_timeout
+      config_get_default('vpc', 'peer_keepalive_timeout')
+    end
+
+    def peer_keepalive_precedence
+      config_get('vpc', 'peer_keepalive_precedence')
+    end
+
+    def default_peer_keepalive_precedence
+      config_get_default('vpc', 'peer_keepalive_precedence')
+    end
+
+    def peer_keepalive_src
+      config_get('vpc', 'peer_keepalive_src')
+    end
+
+    def default_peer_keepalive_src
+      config_get_default('vpc', 'peer_keepalive_src')
+    end
+
+    def peer_keepalive_udp_port
+      config_get('vpc', 'peer_keepalive_udp_port')
+    end
+
+    def default_peer_keepalive_udp_port
+      config_get_default('vpc', 'peer_keepalive_udp_port')
+    end
+
+    def peer_keepalive_vrf
+      config_get('vpc', 'peer_keepalive_vrf')
+    end
+
+    def default_peer_keepalive_vrf
+      config_get_default('vpc', 'peer_keepalive_vrf')
+    end
+
+    # common setter
+    def peer_keepalive_set(dest, src, udp_port, vrf, interval, timeout,
+                           prec, hold_timeout)
+      set_args_keys(dest: dest, src: src, port_num: udp_port, vrf: vrf,
+                    interval: interval, timeout: timeout,
+                    precedence: prec, hold_timeout: hold_timeout)
+      config_set('vpc', 'peer_keepalive_set', @set_args)
+    end
+
+    def peer_gateway
+      config_get('vpc', 'peer_gateway')
+    end
+
+    def peer_gateway=(val)
+      set_args_keys(state: val ? '' : 'no')
+      # disable layer3 routing first
+      self.layer3_peer_routing = false if !val && layer3_peer_routing
+      config_set('vpc', 'peer_gateway', @set_args)
+    end
+
+    def peer_switch
+      config_get('vpc', 'peer_switch')
+    end
+
+    def peer_switch=(val)
+      set_args_keys(state: val ? '' : 'no')
+      config_set('vpc', 'peer_switch', @set_args)
+    end
+
+    def arp_synchronize
+      config_get('vpc', 'arp_synchronize')
+    end
+
+    def arp_synchronize=(val)
+      set_args_keys(state: val ? '' : 'no')
+      config_set('vpc', 'arp_synchronize', @set_args)
+    end
+
+    def nd_synchronize
+      config_get('vpc', 'nd_synchronize')
+    end
+
+    def nd_synchronize=(val)
+      set_args_keys(state: val ? '' : 'no')
+      config_set('vpc', 'nd_synchronize', @set_args)
+    end
+
+    def default_peer_gateway
+      config_get_default('vpc', 'peer_gateway')
+    end
+
+    def default_peer_switch
+      config_get_default('vpc', 'peer_switch')
+    end
+
+    def default_arp_synchronize
+      config_get_default('vpc', 'arp_synchronize')
+    end
+
+    def default_nd_synchronize
+      config_get_default('vpc', 'nd_synchronize')
+    end
+
+    def peer_gateway_exclude_bridge_domain
+      config_get('vpc', 'peer_gateway_exclude_bridge_domain')
+    end
+
+    def peer_gateway_exclude_bridge_domain=(val)
+      set_args_keys(state: val ? '' : 'no', range: val)
+      config_set('vpc', 'peer_gateway_exclude_bridge_domain', @set_args)
+    end
+
+    def default_peer_gateway_exclude_bridge_domain
+      config_get_default('vpc', 'peer_gateway_exclude_bridge_domain')
+    end
+
+    def peer_gateway_exclude_vlan
+      config_get('vpc', 'peer_gateway_exclude_vlan')
+    end
+
+    def peer_gateway_exclude_vlan=(val)
+      set_args_keys(state: val ? '' : 'no', range: val)
+      config_set('vpc', 'peer_gateway_exclude_vlan', @set_args)
+    end
+
+    def default_peer_gateway_exclude_vlan
+      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
+
+    def role_priority=(priority)
+      set_args_keys(priority: priority)
+      config_set('vpc', 'role_priority', @set_args)
+    end
+
+    def default_role_priority
+      config_get_default('vpc', 'role_priority')
+    end
+
+    def self_isolation
+      val = config_get('vpc', 'self_isolation')
+      val.nil? ? false : val
+    end
+
+    def self_isolation=(val)
+      set_args_keys(state: val ? '' : 'no')
+      config_set('vpc', 'self_isolation', @set_args)
+    end
+
+    def default_self_isolation
+      config_get_default('vpc', 'self_isolation')
+    end
+
+    def shutdown
+      config_get('vpc', 'shutdown')
+    end
+
+    def shutdown=(val)
+      set_args_keys(state: val ? '' : 'no')
+      config_set('vpc', 'shutdown', @set_args)
+    end
+
+    def default_shutdown
+      config_get_default('vpc', 'shutdown')
+    end
+
+    def system_mac
+      config_get('vpc', 'system_mac')
+    end
+
+    def system_mac=(mac_addr)
+      set_args_keys(state: mac_addr.empty? ? 'no' : '', mac_addr: mac_addr)
+      config_set('vpc', 'system_mac', @set_args)
+    end
+
+    def default_system_mac
+      config_get_default('vpc', 'system_mac')
+    end
+
+    def system_priority
+      config_get('vpc', 'system_priority')
+    end
+
+    def system_priority=(priority)
+      set_args_keys(priority: priority)
+      config_set('vpc', 'system_priority', @set_args)
+    end
+
+    def default_system_priority
+      config_get_default('vpc', 'system_priority')
+    end
+
+    def track
+      config_get('vpc', 'track')
+    end
+
+    def track=(val)
+      unless val.nil?
+        fail ArgumentError, 'track must be an Integer' unless
+          val.is_a?(Integer)
+      end
+
+      set_args_keys(state: (val == track) ? 'no' : '', val: val)
+      config_set('vpc', 'track', @set_args)
+    end
+
+    def default_track
+      config_get_default('vpc', 'track')
+    end
+  end # class Vpc
+end # module Cisco

data/lib/cisco_node_utils/vrf.rb

@@ -0,0 +1,192 @@
+# VRF provider class
+#
+# Jie Yang, July 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 'feature'
+
+module Cisco
+  # Vrf - node utility class for VRF configuration management
+  class Vrf < NodeUtil
+    attr_reader :name
+
+    def initialize(name, instantiate=true)
+      fail TypeError unless name.is_a?(String)
+      @name = name.downcase.strip
+      create if instantiate
+    end
+
+    def to_s
+      "VRF #{@name}"
+    end
+
+    def self.vrfs
+      hash = {}
+      vrf_list = config_get('vrf', 'all_vrfs')
+      return hash if vrf_list.nil?
+
+      vrf_list.each do |id|
+        id = id.downcase.strip
+        hash[id] = Vrf.new(id, false)
+      end
+      hash
+    end
+
+    def create
+      config_set('vrf', 'create', vrf: @name)
+    end
+
+    def destroy
+      config_set('vrf', 'destroy', vrf: @name)
+    end
+
+    ########################################################
+    #                      PROPERTIES                      #
+    ########################################################
+
+    def description
+      config_get('vrf', 'description', vrf: @name)
+    end
+
+    def description=(desc)
+      fail TypeError unless desc.is_a?(String)
+      desc.strip!
+      no_cmd = desc.empty? ? 'no' : ''
+      config_set('vrf', 'description', vrf: @name, state: no_cmd, desc: desc)
+    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
+
+    def shutdown=(val)
+      no_cmd = (val) ? '' : 'no'
+      config_set('vrf', 'shutdown', vrf: @name, state: no_cmd)
+    end
+
+    def default_shutdown
+      config_get_default('vrf', 'shutdown')
+    end
+
+    # route_distinguisher
+    # Note that this property is supported by both bgp and vrf providers.
+    def route_distinguisher
+      config_get('vrf', 'route_distinguisher', vrf: @name)
+    end
+
+    def route_distinguisher=(rd)
+      # feature bgp and nv overlay required for rd cli in NXOS
+      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'
+        # I2 images require an rd for removal
+        rd = route_distinguisher
+        return if rd.to_s.empty?
+      else
+        state = ''
+      end
+      config_set('vrf', 'route_distinguisher', state: state, vrf: @name, rd: rd)
+    end
+
+    def default_route_distinguisher
+      config_get_default('vrf', 'route_distinguisher')
+    end
+
+    # Vni (Getter/Setter/Default)
+    def vni
+      config_get('vrf', 'vni', vrf: @name)
+    end
+
+    def vni=(id)
+      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)
+    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