cisco_node_utils_mgx 2.1.0.1

data/lib/cisco_node_utils/ip_multicast.rb

@@ -0,0 +1,90 @@
+# 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
+      result = config_get('ip_multicast', 'overlay_spt_only')
+      result.nil? ? false : result
+    end
+
+    def overlay_spt_only=(bool)
+      fail TypeError unless [true, false].include?(bool)
+      @set_args[:state] = bool ? '' : 'no'
+      config_set('ip_multicast', 'overlay_spt_only', @set_args)
+    end
+
+    def default_overlay_spt_only
+      val = config_get_default('ip_multicast', 'overlay_spt_only')
+      # The default value for this property is different for older
+      # Nexus software verions.
+      #
+      # Versions: 7.0(3)I7(1), 7.0(3)I7(2), 7.0(3)I7(3)
+      #   Default State: false
+      #
+      # Versions: 7.0(3)I7(4) and later
+      #   Default State: true
+      node.os_version[/7\.0\(3\)I7\([1-3]\)/] ? !val : val
+    end
+  end
+end

data/lib/cisco_node_utils/itd_device_group.rb

@@ -0,0 +1,228 @@
+# February 2016, Sai Chintalapudi
+#
+# Copyright (c) 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 itd_device_group
+  class ItdDeviceGroup < NodeUtil
+    attr_reader :name
+
+    def initialize(name, instantiate=true)
+      fail TypeError unless name.is_a?(String)
+      fail ArgumentError unless name.length > 0
+      @name = name
+
+      set_args_keys_default
+      create if instantiate
+    end
+
+    def self.itds
+      hash = {}
+      groups = config_get('itd_device_group',
+                          'all_itd_device_groups')
+      return hash if groups.nil?
+
+      groups.each do |id|
+        hash[id] = ItdDeviceGroup.new(id, false)
+      end
+      hash
+    end
+
+    ########################################################
+    #                      PROPERTIES                      #
+    ########################################################
+
+    def create
+      Feature.itd_enable
+      config_set('itd_device_group', 'create', name: @name)
+    end
+
+    def destroy
+      config_set('itd_device_group', 'destroy', name: @name)
+    end
+
+    # Helper method to delete @set_args hash keys
+    def set_args_keys_default
+      keys = { name: @name }
+      @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
+
+    # probe configuration is all done in a single line (like below)
+    # probe tcp port 32 frequency 10 timeout 5 retry-down-count 3 ...
+    # probe udp port 23 frequency 10 timeout 5 retry-down-count 3 ...
+    # probe icmp frequency 10 timeout 5 retry-down-count 3 retry-up-count 3
+    # probe dns host 8.8.8.8 frequency 10 timeout 5 retry-down-count 3 ...
+    # also the 'control enable' can be set if the type is tcp or udp only
+    # probe udp port 23 control enable frequency 10 timeout 5 ...
+    def probe_get
+      str = config_get('itd_device_group', 'probe', @get_args)
+      return nil if str.nil?
+      regexp = Regexp.new('(?<type>\S+)'\
+                 ' *(?<dns_host>host \S+)?'\
+                 ' *(?<port>port \d+)?'\
+                 ' *(?<control>control \S+)?'\
+                 ' *(?<frequency>frequency \d+)?'\
+                 ' *(?<timeout>timeout \d+)'\
+                 ' *(?<retry_down>retry-down-count \d+)'\
+                 ' *(?<retry_up>retry-up-count \d+)')
+      regexp.match(str)
+    end
+
+    def probe_control
+      val = Utils.extract_value(probe_get, 'control')
+      return default_probe_control if val.nil?
+      val == 'enable' ? true : default_probe_control
+    end
+
+    def probe_control=(control)
+      if control
+        @set_args[:control] = 'control enable'
+      else
+        @set_args[:control] = ''
+      end
+    end
+
+    def default_probe_control
+      config_get_default('itd_device_group', 'probe_control')
+    end
+
+    def probe_dns_host
+      Utils.extract_value(probe_get, 'dns_host', 'host')
+    end
+
+    def probe_dns_host=(dns_host)
+      @set_args[:dns_host] = Utils.attach_prefix(dns_host, :dns_host, 'host')
+    end
+
+    def probe_frequency
+      val = Utils.extract_value(probe_get, 'frequency')
+      return default_probe_frequency if val.nil?
+      val.to_i
+    end
+
+    def probe_frequency=(frequency)
+      @set_args[:frequency] = Utils.attach_prefix(frequency, :frequency)
+    end
+
+    def default_probe_frequency
+      config_get_default('itd_device_group', 'probe_frequency')
+    end
+
+    def probe_port
+      val = Utils.extract_value(probe_get, 'port')
+      val.to_i unless val.nil?
+    end
+
+    def probe_port=(port)
+      @set_args[:port] = Utils.attach_prefix(port, :port)
+    end
+
+    def probe_retry_down
+      val = Utils.extract_value(probe_get, 'retry_down', 'retry-down-count')
+      return default_probe_retry_down if val.nil?
+      val.to_i
+    end
+
+    def probe_retry_down=(rdc)
+      @set_args[:retry_down_count] = Utils.attach_prefix(rdc,
+                                                         :retry_down_count,
+                                                         'retry-down-count')
+    end
+
+    def default_probe_retry_down
+      config_get_default('itd_device_group', 'probe_retry_down')
+    end
+
+    def probe_retry_up
+      val = Utils.extract_value(probe_get, 'retry_up', 'retry-up-count')
+      return default_probe_retry_up if val.nil?
+      val.to_i
+    end
+
+    def probe_retry_up=(ruc)
+      @set_args[:retry_up_count] = Utils.attach_prefix(ruc,
+                                                       :retry_up_count,
+                                                       'retry-up-count')
+    end
+
+    def default_probe_retry_up
+      config_get_default('itd_device_group', 'probe_retry_up')
+    end
+
+    def probe_timeout
+      val = Utils.extract_value(probe_get, 'timeout')
+      return default_probe_timeout if val.nil?
+      val.to_i
+    end
+
+    def probe_timeout=(timeout)
+      @set_args[:timeout] = Utils.attach_prefix(timeout, :timeout)
+    end
+
+    def default_probe_timeout
+      config_get_default('itd_device_group', 'probe_timeout')
+    end
+
+    def probe_type
+      match = probe_get
+      return default_probe_type if match.nil?
+      match.names.include?('type') ? match[:type] : default_probe_type
+    end
+
+    def probe_type=(type)
+      @set_args[:type] = type
+    end
+
+    def default_probe_type
+      config_get_default('itd_device_group', 'probe_type')
+    end
+
+    def probe_set(attrs)
+      if attrs[:probe_type] == false
+        cmd = 'probe_type'
+        @set_args[:state] = 'no'
+      else
+        cmd = 'probe'
+        set_args_keys_default
+        set_args_keys(attrs)
+        [:probe_type,
+         :probe_dns_host,
+         :probe_port,
+         :probe_control,
+         :probe_frequency,
+         :probe_timeout,
+         :probe_retry_down,
+         :probe_retry_up,
+        ].each do |p|
+          attrs[p] = '' if attrs[p].nil?
+          send(p.to_s + '=', attrs[p])
+        end
+        # for boolean we need to do this
+        send('probe_control=', false) if attrs[:probe_control] == ''
+        @get_args = @set_args
+      end
+      config_set('itd_device_group', cmd, @set_args)
+      set_args_keys_default
+    end
+  end  # Class
+end    # Module

data/lib/cisco_node_utils/itd_device_group_node.rb

@@ -0,0 +1,144 @@
+# February 2016, Sai Chintalapudi
+#
+# Copyright (c) 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 'itd_device_group'
+
+module Cisco
+  # node_utils class for itd_device_group_node
+  class ItdDeviceGroupNode < ItdDeviceGroup
+    attr_reader :itd_device_group_name, :name, :node_type
+
+    def initialize(itd_dg_name, node_name, node_type, instantiate=true)
+      fail TypeError unless itd_dg_name.is_a?(String)
+      fail TypeError unless node_name.is_a?(String)
+      fail ArgumentError unless itd_dg_name.length > 0
+      fail ArgumentError unless node_name.length > 0
+
+      @itd_device_group_name = itd_dg_name
+      @itddg = ItdDeviceGroup.itds[itd_dg_name]
+      fail "itd device-group #{itd_dg_name} does not exist" if
+      @itddg.nil?
+      @name = node_name
+      @node_type = node_type
+
+      set_args_keys_default
+      create_node if instantiate
+    end
+
+    # itd_device_group_nodes have the name form as
+    # node ip 1.1.1.1
+    # node IPv6 2000::1
+    # and they depdend on the device_group
+    def self.itd_nodes(node_name=nil)
+      fail TypeError unless node_name.is_a?(String) || node_name.nil?
+      itd_nodes = {}
+      itd_list = ItdDeviceGroup.itds
+      return itd_nodes if itd_list.nil?
+      itd_list.keys.each do |name|
+        itd_nodes[name] = {}
+        match = config_get('itd_device_group',
+                           'all_itd_device_group_nodes', name: name)
+        next if match.nil?
+        match.each do |vars|
+          ntype = vars[0]
+          nname = vars[1].strip
+          next unless node_name.nil? || nname == node_name
+          itd_nodes[name][nname] =
+              ItdDeviceGroupNode.new(name, nname, ntype, false)
+        end
+      end
+      itd_nodes
+    end
+
+    ########################################################
+    #                      PROPERTIES                      #
+    ########################################################
+
+    def ==(other)
+      (itd_device_group_name == other.itd_device_group_name) &&
+        (name == other.name) && (node_type == other.node_type)
+    end
+
+    def create_node
+      config_set('itd_device_group', 'create_node',
+                 name: @itddg.name, ntype: @node_type, nname: @name)
+    end
+
+    def destroy
+      config_set('itd_device_group', 'destroy_node', name: @itddg.name,
+                ntype: @node_type, nname: @name)
+    end
+
+    # Helper method to delete @set_args hash keys
+    def set_args_keys_default
+      @set_args = { name: @itddg.name }
+      @set_args[:ntype] = @node_type
+      @set_args[:nname] = @name
+      @get_args = @set_args
+    end
+
+    def hot_standby
+      config_get('itd_device_group', 'hot_standby', @get_args)
+    end
+
+    # DO NOT call this directly
+    def lhot_standby=(state)
+      no_cmd = (state ? '' : 'no')
+      @set_args[:state] = no_cmd
+      config_set('itd_device_group', 'hot_standby', @set_args)
+      set_args_keys_default
+    end
+
+    def default_hot_standby
+      config_get_default('itd_device_group', 'hot_standby')
+    end
+
+    def weight
+      config_get('itd_device_group', 'weight', @get_args)
+    end
+
+    # DO NOT call this directly
+    def lweight=(val)
+      @set_args[:state] = val == default_weight ? 'no' : ''
+      @set_args[:weight] = val
+      config_set('itd_device_group', 'weight', @set_args)
+    end
+
+    # Call this for setting hot_standby and weight together because
+    # the CLI is pretty weird and it accepts these params in a very
+    # particular way and they cannot even be reset unless proper
+    # order is followed
+    def hs_weight(hs, wt)
+      if hs != hot_standby && hot_standby == default_hot_standby
+        self.lweight = wt unless weight == wt
+        self.lhot_standby = hs
+      elsif hs != hot_standby && hot_standby != default_hot_standby
+        self.lhot_standby = hs
+        self.lweight = wt unless weight == wt
+      elsif wt != weight && weight == default_weight
+        self.lweight = wt
+      elsif wt != weight && weight != default_weight
+        self.lweight = wt
+      end
+      set_args_keys_default
+    end
+
+    def default_weight
+      config_get_default('itd_device_group', 'weight')
+    end
+  end  # Class
+end    # Module