cisco_node_utils 1.8.0 → 1.9.0

data/lib/cisco_node_utils/evpn_stormcontrol.rb

@@ -0,0 +1,84 @@
+# October 2017, Rahul Shenoy
+#
+# Copyright (c) 2017 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
+  # node_utils class for evpn_stormcontrol
+  class EvpnStormcontrol < NodeUtil
+    attr_reader :stormcontrol_type, :level
+
+    def initialize(stormcontrol_type, level, instantiate=true)
+      err_msg = 'storm control type must be one of the following:' \
+                ' broadcast, multicast or unicast'
+      type_list = %w(broadcast multicast unicast)
+      fail ArgumentError, err_msg unless type_list.include?(stormcontrol_type)
+      @stormcontrol_type = stormcontrol_type
+
+      err_msg = "level must be either a 'String' or an" \
+                " 'Integer' object"
+      fail ArgumentError, err_msg unless level.is_a?(Integer) ||
+                                         level.is_a?(String)
+      @level = level.to_i
+      @get_args = @set_args = { stormcontrol_type: @stormcontrol_type,
+                                level:             @level }
+      create if instantiate
+    end
+
+    def config_stormcontrol
+      stormcontrol_type = @set_args[:stormcontrol_type]
+      config_set('evpn_stormcontrol', stormcontrol_type, @set_args)
+    end
+
+    def create
+      @set_args[:state] = ''
+      config_stormcontrol
+    end
+
+    def destroy
+      @set_args[:state] = 'no'
+      config_stormcontrol
+    end
+
+    # Create a hash of all stormcontrol instances
+    def self.stormcontrol
+      hash = {}
+      type_list = %w(broadcast multicast unicast)
+      type_list.each do |type|
+        level = config_get('evpn_stormcontrol', type)
+        hash[type] = EvpnStormcontrol.new(type, level, false) if level
+      end
+      hash
+    end
+
+    def level
+      config_get('evpn_stormcontrol', @get_args[:stormcontrol_type])
+    end
+
+    def level=(level)
+      err_msg = "level must be either a 'String' or an" \
+                " 'Integer' object"
+      fail ArgumentError, err_msg unless level.is_a?(Integer) ||
+                                         level.is_a?(String)
+      @level = level.to_i
+      @set_args[:level] = @level
+      @set_args[:state] = ''
+      config_stormcontrol
+    end
+  end
+end

data/lib/cisco_node_utils/feature.rb

@@ -160,6 +160,25 @@ module Cisco
       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

data/lib/cisco_node_utils/interface.rb

@@ -1227,8 +1227,9 @@ module Cisco
       if val
         state = ''
       else
+        return unless stp_port_type
         state = 'no'
-        val = ''
+        val = stp_port_type
       end
       config_set('interface', 'stp_port_type', name: @name,
                  state: state, type: val)

data/lib/cisco_node_utils/interface_evpn_multisite.rb

@@ -0,0 +1,63 @@
+# October 2017, Rahul Shenoy
+#
+# Copyright (c) 2017 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 interface_evpn_multisite
+  class InterfaceEvpnMultisite < NodeUtil
+    attr_reader :interface, :tracking
+
+    def initialize(interface)
+      fail TypeError unless interface.is_a?(String)
+      @interface = interface.downcase
+      @get_args = @set_args = { interface: @interface }
+    end
+
+    def self.interfaces
+      hash = {}
+      intf_list = config_get('interface_evpn_multisite', 'all_interfaces')
+      return hash if intf_list.nil?
+
+      intf_list.each do |id|
+        id = id.downcase
+        intf = InterfaceEvpnMultisite.new(id)
+        hash[id] = intf if intf.tracking
+      end
+      hash
+    end
+
+    def enable(tracking)
+      @set_args[:tracking] = tracking
+      @set_args[:state] = ''
+      config_set('interface_evpn_multisite', 'evpn_multisite', @set_args)
+    end
+
+    def disable(tracking='dci-tracking')
+      @set_args[:tracking] = tracking
+      @set_args[:state] = 'no'
+      config_set('interface_evpn_multisite', 'evpn_multisite', @set_args)
+    end
+
+    def tracking
+      config_get('interface_evpn_multisite', 'evpn_multisite', @get_args)
+    end
+
+    def tracking=(tracking)
+      enable(tracking)
+    end
+  end # class
+end # module

data/lib/cisco_node_utils/ip_multicast.rb

@@ -0,0 +1,86 @@
+# January 2018, Rahul Shenoy
+#
+# Copyright (c) 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 'cisco_cmn_utils'
+require_relative 'node_util'
+require_relative 'feature'
+
+module Cisco
+  # node_utils class for evpn_multisite
+  class IpMulticast < NodeUtil
+    def initialize(instantiate=true)
+      @get_args = @set_args = {}
+      enable_features if instantiate
+    end
+
+    def destroy
+      @set_args[:state] = 'no'
+      config_set('ip_multicast', 'overlay_distributed_dr', @set_args)
+      config_set('ip_multicast', 'overlay_spt_only', @set_args)
+      Feature.ngmvpn_disable
+    end
+
+    def enable_features
+      Feature.nv_overlay_enable
+      Feature.nv_overlay_evpn_enable
+      Feature.ngmvpn_enable
+    end
+
+    def ip_multicast
+      Feature.ngmvpn_enabled?
+    end
+
+    def overlay_distributed_dr
+      config_get('ip_multicast', 'overlay_distributed_dr')
+    end
+
+    def overlay_distributed_dr=(bool)
+      fail TypeError unless [true, false].include?(bool)
+      @set_args[:state] = bool ? '' : 'no'
+      if @set_args[:state] == 'no'
+        unless overlay_distributed_dr == default_overlay_distributed_dr
+          config_set('ip_multicast', 'overlay_distributed_dr', @set_args)
+        end
+      else
+        config_set('ip_multicast', 'overlay_distributed_dr', @set_args)
+      end
+    end
+
+    def default_overlay_distributed_dr
+      config_get_default('ip_multicast', 'overlay_distributed_dr')
+    end
+
+    def overlay_spt_only
+      config_get('ip_multicast', 'overlay_spt_only')
+    end
+
+    def overlay_spt_only=(bool)
+      fail TypeError unless [true, false].include?(bool)
+      @set_args[:state] = bool ? '' : 'no'
+      if @set_args[:state] == 'no'
+        unless overlay_spt_only == default_overlay_spt_only
+          config_set('ip_multicast', 'overlay_spt_only', @set_args)
+        end
+      else
+        config_set('ip_multicast', 'overlay_spt_only', @set_args)
+      end
+    end
+
+    def default_overlay_spt_only
+      config_get_default('ip_multicast', 'overlay_spt_only')
+    end
+  end
+end

data/lib/cisco_node_utils/version.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2015-2017 Cisco and/or its affiliates.
+# Copyright (c) 2015-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.
@@ -14,7 +14,7 @@
 
 # Container module for version number only.
 module CiscoNodeUtils
-  VERSION = '1.8.0'
+  VERSION = '1.9.0'
   gem_version = Gem::Version.new(Gem::VERSION)
   min_gem_version = Gem::Version.new('2.1.0')
   fail 'Required rubygems version >= 2.1.0' if gem_version < min_gem_version

data/lib/cisco_node_utils/vrf_af.rb

@@ -75,16 +75,20 @@ module Cisco
       @set_args = @get_args.merge!(hash) unless hash.empty?
     end
 
-    def route_target_feature_enable(require_nv_overlay=nil)
+    def route_target_feature_enable(require_nv_overlay=nil, require_ngmvpn=nil)
       return unless platform == :nexus
 
       # All NX route-target properties require feature bgp
       Feature.bgp_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?
+      if require_nv_overlay
+        Feature.nv_overlay_enable if Feature.nv_overlay_supported?
+        Feature.nv_overlay_evpn_enable if Feature.nv_overlay_evpn_supported?
+      end
+
+      # ngmvpn feature is required for 'mvpn' enablement
+      Feature.ngmvpn_enable if require_ngmvpn
     end
 
     ########################################################
@@ -163,6 +167,21 @@ module Cisco
       config_get_default('vrf_af', 'route_target_both_auto_evpn')
     end
 
+    # --------------------------
+    def route_target_both_auto_mvpn
+      config_get('vrf_af', 'route_target_both_auto_mvpn', @get_args)
+    end
+
+    def route_target_both_auto_mvpn=(state)
+      route_target_feature_enable(nil, :require_ngmvpn)
+      set_args_keys(state: (state ? '' : 'no'))
+      config_set('vrf_af', 'route_target_both_auto_mvpn', @set_args)
+    end
+
+    def default_route_target_both_auto_mvpn
+      config_get_default('vrf_af', 'route_target_both_auto_mvpn')
+    end
+
     # --------------------------
     def route_target_export
       cmds = config_get('vrf_af', 'route_target_export', @get_args)
@@ -194,6 +213,22 @@ module Cisco
       config_get_default('vrf_af', 'route_target_export_evpn')
     end
 
+    # --------------------------
+    def route_target_export_mvpn
+      cmds = config_get('vrf_af', 'route_target_export_mvpn', @get_args)
+      cmds.nil? ? nil : cmds.sort
+    end
+
+    def route_target_export_mvpn=(should)
+      route_target_feature_enable(nil, :require_ngmvpn)
+      route_target_delta(should, route_target_export_mvpn,
+                         'route_target_export_mvpn')
+    end
+
+    def default_route_target_export_mvpn
+      config_get_default('vrf_af', 'route_target_export_mvpn')
+    end
+
     # --------------------------
     def route_target_export_stitching
       cmds = config_get('vrf_af', 'route_target_export_stitching', @get_args)
@@ -226,12 +261,12 @@ module Cisco
 
     # --------------------------
     def route_target_import_evpn
-      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)
+      route_target_feature_enable(:require_nv_overlay)
       route_target_delta(should, route_target_import_evpn,
                          'route_target_import_evpn')
     end
@@ -240,6 +275,22 @@ module Cisco
       config_get_default('vrf_af', 'route_target_import_evpn')
     end
 
+    # --------------------------
+    def route_target_import_mvpn
+      cmds = config_get('vrf_af', 'route_target_import_mvpn', @get_args)
+      cmds.nil? ? nil : cmds.sort
+    end
+
+    def route_target_import_mvpn=(should)
+      route_target_feature_enable(nil, :require_ngmvpn)
+      route_target_delta(should, route_target_import_mvpn,
+                         'route_target_import_mvpn')
+    end
+
+    def default_route_target_import_mvpn
+      config_get_default('vrf_af', 'route_target_import_mvpn')
+    end
+
     # --------------------------
     def route_target_import_stitching
       cmds = config_get('vrf_af', 'route_target_import_stitching', @get_args)

data/lib/cisco_node_utils/vxlan_vtep.rb

@@ -173,5 +173,29 @@ module Cisco
     def default_shutdown
       config_get_default('vxlan_vtep', 'shutdown')
     end
+
+    def multisite_border_gateway_interface
+      config_get('vxlan_vtep', 'multisite_bg_intf', name: @name)
+    end
+
+    def multisite_border_gateway_interface=(val)
+      set_args = { name: @name }
+      set_args[:state] = val.empty? ? 'no' : ''
+      set_args[:lpbk_intf] = val.empty? ? 'loopback0' : val
+      if set_args[:state] == 'no'
+        # 'no multisite border-gateway' doesn't work without interface
+        # defaulting to 'loopback0' still clears any configuration
+        intf = multisite_border_gateway_interface
+        unless intf == default_multisite_border_gateway_interface
+          config_set('vxlan_vtep', 'multisite_bg_intf', set_args)
+        end
+      else
+        config_set('vxlan_vtep', 'multisite_bg_intf', set_args)
+      end
+    end
+
+    def default_multisite_border_gateway_interface
+      config_get_default('vxlan_vtep', 'multisite_bg_intf')
+    end
   end  # Class
 end    # Module

data/lib/cisco_node_utils/vxlan_vtep_vni.rb

@@ -262,5 +262,26 @@ module Cisco
     def default_suppress_uuc
       config_get_default('vxlan_vtep_vni', 'suppress_uuc')
     end
+
+    def multisite_ingress_replication
+      config_get('vxlan_vtep_vni', 'multisite_ingress_replication', @get_args)
+    end
+
+    def multisite_ingress_replication=(state)
+      @set_args[:state] = state ? '' : 'no'
+      if @set_args[:state] == 'no'
+        unless multisite_ingress_replication ==
+               default_multisite_ingress_replication
+          config_set('vxlan_vtep_vni', 'multisite_ingress_replication',
+                     @set_args)
+        end
+      else
+        config_set('vxlan_vtep_vni', 'multisite_ingress_replication', @set_args)
+      end
+    end
+
+    def default_multisite_ingress_replication
+      config_get_default('vxlan_vtep_vni', 'multisite_ingress_replication')
+    end
   end
 end