cisco_node_utils 1.1.0 → 1.2.0

data/lib/cisco_node_utils/overlay_global.rb

@@ -0,0 +1,153 @@
+# VXLAN global provider class
+# Provides configuration of anycast gateways and duplicate host IP and
+# mac detection
+#
+# Alok Aggarwal, October 2015
+#
+# 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 'cisco_cmn_utils'
+require_relative 'feature'
+require_relative 'node_util'
+
+module Cisco
+  # node_utils class for overlay_global
+  class OverlayGlobal < NodeUtil
+    # ----------
+    # PROPERTIES
+    # ----------
+
+    # dup-host-ip-addr-detection
+    def dup_host_ip_addr_detection
+      return nil unless Feature.nv_overlay_evpn_enabled?
+      match = config_get('overlay_global', 'dup_host_ip_addr_detection')
+      if match.nil?
+        default_dup_host_ip_addr_detection
+      else
+        match.collect(&:to_i)
+      end
+    end
+
+    def dup_host_ip_addr_detection_host_moves
+      host_moves, _timeout = dup_host_ip_addr_detection
+      host_moves
+    end
+
+    def dup_host_ip_addr_detection_timeout
+      _host_moves, timeout = dup_host_ip_addr_detection
+      timeout
+    end
+
+    def dup_host_ip_addr_detection_set(host_moves, timeout)
+      Feature.nv_overlay_evpn_enable
+      if host_moves == default_dup_host_ip_addr_detection_host_moves &&
+         timeout == default_dup_host_ip_addr_detection_timeout
+        state = 'no'
+      else
+        state = ''
+      end
+      set_args = { state: state, host_moves: host_moves, timeout: timeout }
+      config_set('overlay_global', 'dup_host_ip_addr_detection', set_args)
+    end
+
+    def default_dup_host_ip_addr_detection
+      [default_dup_host_ip_addr_detection_host_moves,
+       default_dup_host_ip_addr_detection_timeout]
+    end
+
+    def default_dup_host_ip_addr_detection_host_moves
+      config_get_default('overlay_global',
+                         'dup_host_ip_addr_detection_host_moves')
+    end
+
+    def default_dup_host_ip_addr_detection_timeout
+      config_get_default('overlay_global', 'dup_host_ip_addr_detection_timeout')
+    end
+
+    # dup-host-mac-detection
+    def dup_host_mac_detection
+      match = config_get('overlay_global', 'dup_host_mac_detection')
+      if match.nil?
+        default_dup_host_mac_detection
+      else
+        match.collect(&:to_i)
+      end
+    end
+
+    def dup_host_mac_detection_host_moves
+      host_moves, _timeout = dup_host_mac_detection
+      host_moves
+    end
+
+    def dup_host_mac_detection_timeout
+      _host_moves, timeout = dup_host_mac_detection
+      timeout
+    end
+
+    def dup_host_mac_detection_set(host_moves, timeout)
+      set_args = { host_moves: host_moves, timeout: timeout }
+      if host_moves == default_dup_host_mac_detection_host_moves &&
+         timeout == default_dup_host_mac_detection_timeout
+        dup_host_mac_detection_default
+      else
+        config_set('overlay_global', 'dup_host_mac_detection', set_args)
+      end
+    end
+
+    def dup_host_mac_detection_default
+      config_set('overlay_global', 'dup_host_mac_detection_default')
+    end
+
+    def default_dup_host_mac_detection
+      [default_dup_host_mac_detection_host_moves,
+       default_dup_host_mac_detection_timeout]
+    end
+
+    def default_dup_host_mac_detection_host_moves
+      config_get_default('overlay_global', 'dup_host_mac_detection_host_moves')
+    end
+
+    def default_dup_host_mac_detection_timeout
+      config_get_default('overlay_global', 'dup_host_mac_detection_timeout')
+    end
+
+    # anycast-gateway-mac
+    def anycast_gateway_mac
+      return nil unless Feature.nv_overlay_evpn_enabled?
+      mac = config_get('overlay_global', 'anycast_gateway_mac')
+      # This value gets 0-padded when nvgened, so we need to convert it.
+      Utils.zero_pad_macaddr(mac).nil? ? default_anycast_gateway_mac : mac
+    end
+
+    def anycast_gateway_mac=(mac_addr)
+      fail TypeError unless mac_addr.is_a?(String)
+
+      Feature.nv_overlay_evpn_enable
+      Feature.fabric_forwarding_enable
+      if mac_addr == default_anycast_gateway_mac
+        state = 'no'
+        mac_addr = ''
+      else
+        state = ''
+      end
+      config_set('overlay_global', 'anycast_gateway_mac',
+                 state: state, mac_addr: mac_addr)
+    end
+
+    def default_anycast_gateway_mac
+      config_get_default('overlay_global', 'anycast_gateway_mac')
+    end
+  end # class
+end # module

data/lib/cisco_node_utils/pim.rb

@@ -0,0 +1,124 @@
+#
+# NXAPI implementation of PIM class
+#
+# Smitha Gopalan, 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'
+
+module Cisco
+  # node_utils class for Pim
+  class Pim < NodeUtil
+    attr_reader :vrf, :afi
+
+    # Constructor with vrf
+    # ---------------------
+    def initialize(afi, vrf, instantiate=true)
+      fail ArgumentError unless vrf.is_a?(String) || vrf.length > 0
+      @vrf = vrf
+      @afi = Pim.afi_cli(afi)
+      set_args_keys_default
+
+      Pim.feature_enable if instantiate
+    end
+
+    def self.feature_enabled
+      config_get('pim', 'feature')
+    rescue Cisco::CliError => e
+      # cmd will syntax reject when feature is not enabled
+      raise unless e.clierror =~ /Syntax error/
+      return false
+    end
+
+    def self.feature_enable
+      config_set('pim', 'feature')
+    end
+
+    # self.pims returns a hash of all current pim objects.
+    # There will be one object for each vrf. This method has slightly different
+    # behavior than most of the other "get all objects" methods because the
+    # pim properties are standalone and do not reside in a "pim" container;
+    # therefore, this method simply returns a pim object for each vrf
+    # regardless of whether there are any specific pim properties currently
+    # defined for the context.
+    def self.pims
+      afis = %w(ipv4) # TBD: No support for ipv6 at this time
+      hash_final = {}
+      afis.each do |afi|
+        hash_final[afi] = {}
+        default_vrf = 'default'
+        hash_final[afi][default_vrf] = Pim.new(afi, default_vrf, false)
+
+        # Now the vrf's
+        vrf_ids = config_get('vrf', 'all_vrfs')
+        vrf_ids.delete_if { |vrf_id| vrf_id == 'management' }
+        vrf_ids.each do |vrf|
+          hash_final[afi][vrf] = Pim.new(afi, vrf, false)
+        end
+      end
+      hash_final
+    rescue Cisco::CliError => e
+      # cmd will syntax reject when feature is not enabled
+      raise unless e.clierror =~ /Syntax error/
+      return {}
+    end
+
+    def self.afi_cli(afi)
+      # Add ipv6 support later
+      fail ArgumentError, "Argument afi must be 'ipv4'" unless
+        afi[/(ipv4)/]
+      afi[/ipv4/] ? 'ip' : afi
+    end
+
+    def set_args_keys_default
+      keys = { afi: @afi }
+      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
+
+    # This destroy method is different than most because pim does not have a
+    # "container" for properties, they simply exist in a given vrf context.
+    # For that reason destroy needs to explicitly set each property
+    # to its default state.
+    def destroy
+      self.ssm_range = ''
+    end
+
+    #-----------
+    # Properties
+    #-----------
+    def ssm_range
+      config_get('pim', 'ssm_range', @get_args)
+    end
+
+    def ssm_range=(range)
+      if range.empty?
+        state = 'no'
+        range = ssm_range
+        return if range.nil?
+      else
+        state = ''
+      end
+      set_args_keys(state: state, ssm_range: range)
+      config_set('pim', 'ssm_range', @set_args)
+    end
+  end  # Class
+end    # Module

data/lib/cisco_node_utils/pim_group_list.rb

@@ -0,0 +1,108 @@
+# NXAPI implementation of the PimGroupList class
+#
+# Smitha Gopalan, November 2015
+#
+# 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 'pim'
+
+module Cisco
+  # node_utils class for pim grouplist
+  class PimGroupList < NodeUtil
+    attr_reader :afi, :rp_addr, :group, :vrf
+
+    # Constructor with grouplist and vrf
+    # ----------------------------------
+    def initialize(afi, vrf, rp_addr, group, instantiate=true)
+      fail ArgumentError unless vrf.is_a?(String) || vrf.length > 0
+      @afi = Pim.afi_cli(afi)
+      @rp_addr = rp_addr
+      @group = group
+      @vrf = vrf
+      set_args_keys_default
+
+      create if instantiate
+    end
+
+    # Create a hash of [afi][vrf][rp-addr,grouplist]
+    # --------------------------------------------------
+    def self.group_lists
+      afis = %w(ipv4) # TBD ipv6
+      hash = {}
+      afis.each do |afi|
+        hash[afi] = {}
+        default_vrf = 'default'
+        get_args = { afi: Pim.afi_cli(afi) }
+        rp_addrs = config_get('pim', 'all_group_lists', get_args)
+        unless rp_addrs.nil?
+          rp_addrs.each do |addr_and_group|
+            addr, group = addr_and_group
+            hash[afi][default_vrf] ||= {}
+            hash[afi][default_vrf][addr_and_group] =
+              PimGroupList.new(afi, default_vrf, addr, group, false)
+          end
+        end
+        vrf_ids = config_get('vrf', 'all_vrfs')
+        vrf_ids.each do |vrf|
+          get_args = { vrf: vrf, afi: Pim.afi_cli(afi) }
+          rp_addrs = config_get('pim', 'all_group_lists', get_args)
+          next if rp_addrs.nil?
+          rp_addrs.each do |addr_and_group|
+            hash[afi][vrf] ||= {}
+            addr, group = addr_and_group
+            hash[afi][vrf][addr_and_group] =
+              PimGroupList.new(afi, vrf, addr, group, false)
+          end
+        end
+      end
+      hash
+    rescue Cisco::CliError => e
+      # cmd will syntax reject when feature is not enabled
+      raise unless e.clierror =~ /Syntax error/
+      return {}
+    end
+
+    # set_args_keys_default
+    # ---------------------
+    def set_args_keys_default
+      keys = { afi: @afi, addr: @rp_addr, group: @group }
+      keys[:vrf] = @vrf unless @vrf == 'default'
+      @get_args = @set_args = keys
+    end
+
+    # set_args_key
+    # -------------
+    def set_args_keys(hash={}) # rubocop:disable Style/AccessorMethodName
+      set_args_keys_default
+      @set_args = @get_args.merge!(hash) unless hash.empty?
+    end
+
+    # Create pim grouplist instance
+    # ---------------------------------
+    def create
+      Pim.feature_enable unless Pim.feature_enabled
+      set_args_keys(state: '')
+      config_set('pim', 'group_list', @set_args)
+    end
+
+    # Destroy pim grouplist instance
+    # ----------------------------------
+    def destroy
+      set_args_keys(state: 'no')
+      config_set('pim', 'group_list', @set_args)
+    end
+  end
+end

data/lib/cisco_node_utils/pim_rp_address.rb

@@ -0,0 +1,102 @@
+# NXAPI implementation of the PimRpAddress class
+#
+# Smitha Gopalan, 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 'pim'
+
+module Cisco
+  # node_utils class for pim_rp_address
+  class PimRpAddress < NodeUtil
+    attr_reader :afi, :rp_addr, :vrf
+
+    # Constructor with afi, rp_address and vrf
+    # -----------------------------------------
+    def initialize(afi, vrf, rp_addr, instantiate=true)
+      fail ArgumentError unless vrf.is_a?(String) || vrf.length > 0
+      @afi = Pim.afi_cli(afi)
+      @rp_addr = rp_addr
+      @vrf = vrf
+      create if instantiate
+    end
+
+    # Create a hash of [afi][vrf][rp_address]
+    # ------------------------------------------------
+    def self.rp_addresses
+      afis = %w(ipv4) # TBD ipv6
+      hash = {}
+      afis.each do |afi|
+        hash[afi] = {}
+        default_vrf = 'default'
+        get_args = { afi: Pim.afi_cli(afi) }
+        rp_addrs = config_get('pim', 'all_rp_addresses', get_args)
+        unless rp_addrs.nil?
+          rp_addrs.each do |addr|
+            hash[afi][default_vrf] ||= {}
+            hash[afi][default_vrf][addr] =
+              PimRpAddress.new(afi, default_vrf, addr, false)
+          end
+        end
+        vrf_ids = config_get('vrf', 'all_vrfs')
+        vrf_ids.each do |vrf|
+          get_args = { afi: Pim.afi_cli(afi), vrf: vrf }
+          rp_addrs = config_get('pim', 'all_rp_addresses', get_args)
+          next if rp_addrs.nil?
+          rp_addrs.each do |addr|
+            hash[afi][vrf] ||= {}
+            hash[afi][vrf][addr] = PimRpAddress.new(afi, vrf, addr, false)
+          end
+        end
+      end
+      hash
+    rescue Cisco::CliError => e
+      # cmd will syntax reject when feature is not enabled
+      raise unless e.clierror =~ /Syntax error/
+      return {}
+    end
+
+    # set_args_keys_default
+    # ----------------------
+    def set_args_keys_default
+      keys = { afi: @afi, addr: @rp_addr }
+      keys[:vrf] = @vrf unless @vrf == 'default'
+      @get_args = @set_args = keys
+    end
+
+    # set_args_key
+    # -------------
+    def set_args_keys(hash={}) # rubocop:disable Style/AccessorMethodName
+      set_args_keys_default
+      @set_args = @get_args.merge!(hash) unless hash.empty?
+    end
+
+    # Create pim rp_addr instance
+    # ------------------------------
+    def create
+      Pim.feature_enable unless Pim.feature_enabled
+      set_args_keys(state: '')
+      config_set('pim', 'rp_address', @set_args)
+    end
+
+    # Destroy pim rp_addr instance
+    # ------------------------------
+    def destroy
+      set_args_keys(state: 'no')
+      config_set('pim', 'rp_address', @set_args)
+    end
+  end
+end