cisco_node_utils 1.1.0 → 1.2.0

data/lib/cisco_node_utils/vrf_af.rb

@@ -0,0 +1,191 @@
+# VRF_AF provider class
+#
+# January 2016, Chris Van Heuveln
+#
+# 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 'cisco_cmn_utils'
+require_relative 'node_util'
+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 self.afs
+      hash = {}
+      vrfs = config_get('vrf', 'all_vrfs')
+      vrfs.each do |vrf|
+        hash[vrf] = {}
+        afs = config_get('vrf', 'all_vrf_afs', vrf: vrf)
+
+        next if afs.nil?
+        afs.each do |af|
+          hash[vrf][af] = VrfAF.new(vrf, af, false)
+        end
+      end
+      hash
+    end
+
+    def create
+      config_set('vrf', 'address_family', set_args_keys(state: ''))
+    end
+
+    def destroy
+      config_set('vrf', 'address_family', set_args_keys(state: 'no'))
+    end
+
+    def validate_args(vrf, af)
+      fail ArgumentError unless vrf.is_a?(String) && (vrf.length > 0)
+      fail ArgumentError, "'af' must be an array specifying afi and safi" unless
+        af.is_a?(Array) || af.length == 2
+      @vrf = vrf.downcase
+      @afi, @safi = af
+      set_args_keys_default
+    end
+
+    def set_args_keys_default
+      keys = { afi: @afi, safi: @safi }
+      keys[:vrf] = @vrf unless @vrf == 'default'
+      @get_args = @set_args = keys
+    end
+
+    def set_args_keys(hash={}) # rubocop:disable Style/AccessorMethodName
+      set_args_keys_default
+      @set_args = @get_args.merge!(hash) unless hash.empty?
+    end
+
+    def route_target_feature_enable
+      Feature.bgp_enable
+      Feature.nv_overlay_enable
+      Feature.nv_overlay_evpn_enable
+    end
+
+    ########################################################
+    #                      PROPERTIES                      #
+    ########################################################
+
+    def route_target_both_auto
+      config_get('vrf', 'route_target_both_auto', @get_args)
+    end
+
+    def route_target_both_auto=(state)
+      route_target_feature_enable
+      set_args_keys(state: (state ? '' : 'no'))
+      config_set('vrf', 'route_target_both_auto', @set_args)
+    end
+
+    def default_route_target_both_auto
+      config_get_default('vrf', 'route_target_both_auto')
+    end
+
+    # --------------------------
+    def route_target_both_auto_evpn
+      config_get('vrf', 'route_target_both_auto_evpn', @get_args)
+    end
+
+    def route_target_both_auto_evpn=(state)
+      route_target_feature_enable
+      set_args_keys(state: (state ? '' : 'no'))
+      config_set('vrf', 'route_target_both_auto_evpn', @set_args)
+    end
+
+    def default_route_target_both_auto_evpn
+      config_get_default('vrf', 'route_target_both_auto_evpn')
+    end
+
+    # --------------------------
+    def route_target_export
+      cmds = config_get('vrf', 'route_target_export', @get_args)
+      cmds.sort
+    end
+
+    def route_target_export=(should)
+      route_target_delta(should, route_target_export, 'route_target_export')
+    end
+
+    def default_route_target_export
+      config_get_default('vrf', 'route_target_export')
+    end
+
+    # --------------------------
+    def route_target_export_evpn
+      cmds = config_get('vrf', 'route_target_export_evpn', @get_args)
+      cmds.sort
+    end
+
+    def route_target_export_evpn=(should)
+      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')
+    end
+
+    # --------------------------
+    def route_target_import
+      cmds = config_get('vrf', 'route_target_import', @get_args)
+      cmds.sort
+    end
+
+    def route_target_import=(should)
+      route_target_delta(should, route_target_import, 'route_target_import')
+    end
+
+    def default_route_target_import
+      config_get_default('vrf', 'route_target_import')
+    end
+
+    # --------------------------
+    def route_target_import_evpn
+      cmds = config_get('vrf', 'route_target_import_evpn', @get_args)
+      cmds.sort
+    end
+
+    def route_target_import_evpn=(should)
+      route_target_delta(should, route_target_import_evpn,
+                         'route_target_import_evpn')
+    end
+
+    def default_route_target_import_evpn
+      config_get_default('vrf', 'route_target_import_evpn')
+    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
+      delta_hash = Utils.delta_add_remove(should, is)
+      return if delta_hash.values.flatten.empty?
+      [:add, :remove].each do |action|
+        CiscoLogger.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)
+        end
+      end
+    end
+  end # class
+end # module

data/lib/cisco_node_utils/vtp.rb

@@ -1,6 +1,6 @@
 # Mike Wiebe, November 2014
 #
-# Copyright (c) 2014-2015 Cisco and/or its affiliates.
+# 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.
@@ -30,7 +30,11 @@ module Cisco
     end
 
     def self.enabled
-      !config_get('vtp', 'feature').nil?
+      config_get('vtp', 'feature')
+    rescue Cisco::CliError => e
+      # cmd will syntax reject when feature is not enabled
+      raise unless e.clierror =~ /Syntax error/
+      return false
     end
 
     def enable
@@ -99,8 +103,7 @@ module Cisco
 
     # Get vtp filename
     def filename
-      match = config_get('vtp', 'filename')
-      match.nil? ? default_filename : match.first
+      config_get('vtp', 'filename')
     end
 
     # Set vtp filename
@@ -121,8 +124,7 @@ module Cisco
 
     # Get vtp version
     def version
-      match = config_get('vtp', 'version') if Vtp.enabled
-      match.nil? ? default_version : match.first.to_i
+      Vtp.enabled ? config_get('vtp', 'version') : default_version
     end
 
     # Set vtp version

data/lib/cisco_node_utils/vxlan_vtep.rb

@@ -0,0 +1,151 @@
+#
+# NXAPI implementation of VXLAN_VTEP class
+#
+# November 2015, Deepak Cherian
+#
+# 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 'vrf'
+
+module Cisco
+  # node_utils class for vxlan_vtep
+  class VxlanVtep < NodeUtil
+    attr_reader :name
+
+    def initialize(name, instantiate=true)
+      fail TypeError unless name.is_a?(String)
+      fail ArgumentError unless name.length > 0
+      @name = name.downcase
+
+      create if instantiate
+    end
+
+    def self.vteps
+      hash = {}
+      return hash unless Feature.nv_overlay_enabled?
+      vtep_list = config_get('vxlan_vtep', 'all_interfaces')
+      return hash if vtep_list.nil?
+
+      vtep_list.each do |id|
+        id = id.downcase
+        hash[id] = VxlanVtep.new(id, false)
+      end
+      hash
+    end
+
+    def self.mt_full_support
+      config_get('vxlan_vtep', 'mt_full_support')
+    end
+
+    def self.mt_lite_support
+      config_get('vxlan_vtep', 'mt_lite_support')
+    end
+
+    def create
+      Feature.nv_overlay_enable
+      Feature.vn_segment_vlan_based_enable if VxlanVtep.mt_lite_support
+      # re-use the "interface command ref hooks"
+      config_set('interface', 'create', @name)
+    end
+
+    def destroy
+      # re-use the "interface command ref hooks"
+      config_set('interface', 'destroy', @name)
+    end
+
+    def ==(other)
+      name == other.name
+    end
+
+    ########################################################
+    #                      PROPERTIES                      #
+    ########################################################
+
+    def description
+      config_get('interface', 'description', @name)
+    end
+
+    def description=(desc)
+      fail TypeError unless desc.is_a?(String)
+      if desc.empty?
+        config_set('interface', 'description', @name, 'no', '')
+      else
+        config_set('interface', 'description', @name, '', desc)
+      end
+    end
+
+    def default_description
+      config_get_default('interface', 'description')
+    end
+
+    def host_reachability
+      hr = config_get('vxlan_vtep', 'host_reachability', name: @name)
+      hr == 'bgp' ? 'evpn' : hr
+    end
+
+    def host_reachability=(val)
+      set_args = { name: @name, proto: 'bgp' }
+      if val.to_s == 'flood' && host_reachability == 'evpn'
+        set_args[:state] = 'no'
+      elsif val.to_s == 'evpn'
+        set_args[:state] = ''
+      else
+        return
+      end
+      config_set('vxlan_vtep', 'host_reachability', set_args)
+    end
+
+    def default_host_reachability
+      config_get_default('vxlan_vtep', 'host_reachability')
+    end
+
+    def source_interface
+      config_get('vxlan_vtep', 'source_intf', name: @name)
+    end
+
+    def source_interface_set(val)
+      set_args = { name: @name, lpbk_intf: val }
+      set_args[:state] = val.empty? ? 'no' : ''
+      config_set('vxlan_vtep', 'source_intf', set_args)
+    end
+
+    def source_interface=(val)
+      # The source interface can only be changed if the nve
+      # interface is in a shutdown state.
+      current_state = shutdown
+      self.shutdown = true unless shutdown
+      source_interface_set(val)
+      self.shutdown = current_state
+    end
+
+    def default_source_interface
+      config_get_default('vxlan_vtep', 'source_intf')
+    end
+
+    def shutdown
+      config_get('vxlan_vtep', 'shutdown', name: @name)
+    end
+
+    def shutdown=(bool)
+      state = (bool ? '' : 'no')
+      config_set('vxlan_vtep', 'shutdown', name: @name, state: state)
+    end
+
+    def default_shutdown
+      config_get_default('vxlan_vtep', 'shutdown')
+    end
+  end  # Class
+end    # Module

data/lib/cisco_node_utils/vxlan_vtep_vni.rb

@@ -0,0 +1,234 @@
+#
+# NXAPI implementation of VxlanVtepVni class
+#
+# November 2015 Michael G Wiebe
+#
+# 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 'cisco_cmn_utils'
+require_relative 'node_util'
+require_relative 'vxlan_vtep'
+
+module Cisco
+  # VxlanVtepVni - node utility for vxlan vtep vni members.
+  class VxlanVtepVni < NodeUtil
+    attr_reader :name, :vni, :assoc_vrf
+
+    def initialize(name, vni, assoc_vrf=false, instantiate=true)
+      @name = name
+      @vni = vni
+      @assoc_vrf = assoc_vrf
+
+      set_args_keys_default
+      create if instantiate
+    end
+
+    def self.vnis
+      hash = {}
+      VxlanVtep.vteps.each do |name, _obj|
+        hash[name] = {}
+        get_args = { name: name }
+        vni_list = config_get('vxlan_vtep_vni', 'all_vnis', get_args)
+        next if vni_list.nil?
+        vni_list.each do |vni, assoc_vrf|
+          assoc_vrf = assoc_vrf.nil? ? false : true
+          hash[name][vni] = VxlanVtepVni.new(name, vni, assoc_vrf, false)
+        end
+      end
+      hash
+    end
+
+    def ==(other)
+      (name == other.name) && (vni == other.vni) &&
+        (assoc_vrf == other.assoc_vrf)
+    end
+
+    def set_args_keys_default
+      keys = { name: @name, vni: @vni }
+      keys[:assoc_vrf] = @assoc_vrf ? 'associate-vrf' : ''
+      @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
+
+    def create_with_associate_vrf?
+      !@set_args[:assoc_vrf].eql?('')
+    end
+
+    def destroy_existing(key)
+      getargs = { name: @name, vni: @vni, state: '' }
+      return unless config_get('vxlan_vtep', key, getargs)
+      getargs[:assoc_vrf] = key.eql?('vni_with_vrf') ? 'associate-vrf' : ''
+      getargs[:state] = 'no'
+      config_set('vxlan_vtep', 'vni', getargs)
+    end
+
+    def create
+      # The configuration for this resource can be either of the following:
+      # - member nve 5000
+      # - member nve 5000 associate-vrf
+      # They are mutually exclusive and one must be removed before the other
+      # can be configured.
+      set_args_keys(state: '')
+      if create_with_associate_vrf?
+        destroy_existing('vni_without_vrf')
+      else
+        destroy_existing('vni_with_vrf')
+      end
+      config_set('vxlan_vtep', 'vni', @set_args)
+    end
+
+    def destroy
+      set_args_keys(state: 'no')
+      config_set('vxlan_vtep', 'vni', @set_args)
+    end
+
+    ########################################################
+    #                      PROPERTIES                      #
+    ########################################################
+
+    def ingress_replication
+      config_get('vxlan_vtep_vni', 'ingress_replication', @get_args)
+    end
+
+    def remove_add_ingress_replication(protocol)
+      if ingress_replication.empty?
+        set_args_keys(state: '', protocol: protocol)
+        config_set('vxlan_vtep_vni', 'ingress_replication', @set_args)
+      else
+        # Sadly, the only way to change between protocols is to
+        # first remove the existing protocol.
+        set_args_keys(state: 'no', protocol: ingress_replication)
+        config_set('vxlan_vtep_vni', 'ingress_replication', @set_args)
+        set_args_keys(state: '', protocol: protocol)
+        config_set('vxlan_vtep_vni', 'ingress_replication', @set_args)
+      end
+    end
+
+    def ingress_replication=(protocol)
+      return if protocol.to_s == ingress_replication
+      # Only set ingress_replicatin to the default value if it's not already.
+      if protocol.to_s == default_ingress_replication &&
+         (ingress_replication != default_ingress_replication)
+        set_args_keys(state: 'no', protocol: ingress_replication)
+        config_set('vxlan_vtep_vni', 'ingress_replication', @set_args)
+      else
+        # Multicast group and ingress replication are mutually exclusive
+        # properties, so remove multicast_group first
+        unless multicast_group.empty?
+          set_args_keys(state: 'no', ip_start: '', ip_end: '')
+          config_set('vxlan_vtep_vni', 'multicast_group', @set_args)
+        end
+        remove_add_ingress_replication(protocol.to_s)
+      end
+    end
+
+    def default_ingress_replication
+      config_get_default('vxlan_vtep_vni', 'ingress_replication')
+    end
+
+    def multicast_group
+      g1, g2 = config_get('vxlan_vtep_vni', 'multicast_group', @get_args)
+      g2.nil? ? g1 : g1 + ' ' + g2
+    end
+
+    def remove_add_multicast_group(ip_start, ip_end)
+      set_args_keys(state: 'no', ip_start: '', ip_end: '')
+      config_set('vxlan_vtep_vni', 'multicast_group', @set_args)
+      set_args_keys(state: '', ip_start: ip_start, ip_end: ip_end)
+      config_set('vxlan_vtep_vni', 'multicast_group', @set_args)
+    end
+
+    def multicast_group=(range)
+      if range == default_multicast_group
+        # Due to CSCux78514, trying to remove multicast-group in CLI
+        # when ingress replication is configured results in removing
+        # ingress replication from nvgen. So be careful and negate
+        # Multicast-group only is it is configured.
+        unless multicast_group.empty?
+          set_args_keys(state: 'no', ip_start: '', ip_end: '')
+          config_set('vxlan_vtep_vni', 'multicast_group', @set_args)
+        end
+      else
+        ip_start, ip_end = range.split(' ')
+        ip_end = '' if ip_end.nil?
+        # Since multicast group and ingress replication are exclusive
+        # properties, remove ingress replication first
+        unless ingress_replication.empty?
+          set_args_keys(state: 'no', protocol: ingress_replication)
+          config_set('vxlan_vtep_vni', 'ingress_replication', @set_args)
+        end
+        remove_add_multicast_group(ip_start, ip_end)
+      end
+    end
+
+    def default_multicast_group
+      config_get_default('vxlan_vtep_vni', 'multicast_group')
+    end
+
+    def peer_list
+      config_get('vxlan_vtep_vni', 'peer_list', @get_args)
+    end
+
+    def peer_list=(should_list)
+      delta_hash = Utils.delta_add_remove(should_list, peer_list)
+      return if delta_hash.values.flatten.empty?
+      [:add, :remove].each do |action|
+        CiscoLogger.debug('peer_list' \
+          "#{@get_args}\n #{action}: #{delta_hash[action]}")
+        delta_hash[action].each do |peer|
+          state = (action == :add) ? '' : 'no'
+          @set_args[:state] = state
+          @set_args[:peer] = peer
+          config_set('vxlan_vtep_vni', 'peer_list', @set_args)
+        end
+      end
+    end
+
+    def default_peer_list
+      config_get_default('vxlan_vtep_vni', 'peer_list')
+    end
+
+    def suppress_arp
+      config_get('vxlan_vtep_vni', 'suppress_arp', @get_args)
+    end
+
+    def suppress_arp=(state)
+      if state
+        set_args_keys(state: '')
+        # Host reachability must be enabled for this property
+        VxlanVtep.new(@name).host_reachability = 'evpn'
+        config_set('vxlan_vtep_vni', 'suppress_arp', @set_args)
+      else
+        set_args_keys(state: 'no')
+        # Remove suppress-arp only if it is configured. Suppress-arp needs
+        # free TCAM region for arp-ether ACL. Customers who don't need
+        # suppress-arp, needn't see cli failures warning about TCAM regions
+        # issued due to 'no suppress-arp'. Note that for suppress-arp, default
+        # is 'false' which is no suppress-arp
+        config_set('vxlan_vtep_vni', 'suppress_arp', @set_args) if suppress_arp
+      end
+    end
+
+    def default_suppress_arp
+      config_get_default('vxlan_vtep_vni', 'suppress_arp')
+    end
+  end
+end