cisco_node_utils_mgx 2.1.0.1

data/lib/cisco_node_utils/domain_name.rb

@@ -0,0 +1,82 @@
+# Domain Name provider class
+#
+# October 2015, Bryan Jen
+#
+# 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'
+
+module Cisco
+  # DomainName- node utility class for domain name configuration
+  class DomainName < NodeUtil
+    attr_reader :name, :vrf
+
+    def initialize(name, vrf=nil, instantiate=true)
+      @name = name
+      @vrf = vrf
+      create if instantiate
+    end
+
+    def self.domainnames(vrf=nil)
+      hash = {}
+      if vrf.nil?
+        domain = config_get('dnsclient', 'domain_name')
+      else
+        domain = config_get('dnsclient', 'domain_name_vrf', vrf: vrf)
+      end
+      hash[domain] = DomainName.new(domain, vrf, false) unless domain.empty?
+      hash
+    end
+
+    def ==(other)
+      (name == other.name) && (vrf == other.vrf)
+    end
+
+    def create
+      if @vrf.nil?
+        config_set('dnsclient', 'domain_name',
+                   state: '', name: @name)
+      else
+        # On some platforms attempts to create a new domain results
+        # in the error. 'ERROR: Deletion of VRF test in progresswait
+        # for it to complete'.  We handle this by trying up to 10 times
+        # with a 1 second delay between attempts before giving up.
+        tries = 10
+        begin
+          config_set('dnsclient', 'domain_name_vrf',
+                     state: '', name: @name, vrf: @vrf)
+        rescue Cisco::CliError => e
+          if /ERROR: Deletion of VRF .* in progress/.match(e.to_s)
+            sleep 1
+            tries -= 1
+            # rubocop:disable Metrics/BlockNesting
+            retry if tries > 0
+            # rubocop:enable Metrics/BlockNesting
+          end
+        end
+      end
+    end
+
+    def destroy
+      if @vrf.nil?
+        config_set('dnsclient', 'domain_name',
+                   state: 'no', name: @name)
+      else
+        config_set('dnsclient', 'domain_name_vrf',
+                   state: 'no', name: @name, vrf: @vrf)
+      end
+    end
+  end
+end

data/lib/cisco_node_utils/encapsulation.rb

@@ -0,0 +1,112 @@
+# NXAPI implementation of encapsulation profile class
+#
+# March 2016, Rohan Gandhi Korlepara
+#
+# 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 'feature'
+
+module Cisco
+  # Encapsulation - node utility class for Encapsulation config mgmt.
+  class Encapsulation < NodeUtil
+    attr_reader :encap_name
+
+    # name: name of the encap instance
+    # instantiate: true = create encap instance
+    def initialize(name, instantiate=true)
+      fail ArgumentError unless name.length > 0
+      @encap_name = name
+      create if instantiate
+    end
+
+    def to_s
+      "Encapsulation #{encap_name}"
+    end
+
+    # Create a hash of all current encap instances.
+    def self.encaps
+      return {} unless Feature.vni_enabled?
+      instances = config_get('encapsulation', 'all_encaps')
+      return {} if instances.nil?
+      hash = {}
+      instances.each do |name|
+        hash[name] = Encapsulation.new(name, false)
+      end
+      hash
+    end
+
+    # This will expand the string to a list of bds as integers
+    def self.string_to_array(string)
+      list = []
+      narray = string.split(',')
+      narray.each do |elem|
+        if elem.include?('-')
+          es = elem.gsub('-', '..')
+          ea = es.split('..').map { |d| Integer(d) }
+          er = ea[0]..ea[1]
+          list << er.to_a
+        else
+          list << elem.to_i
+        end
+      end
+      list.flatten
+    end
+
+    # Enable feature and create encap instance
+    def create
+      Feature.vni_enable
+      config_set('encapsulation', 'create', profile: @encap_name)
+    end
+
+    # Destroy an encap instance
+    def destroy
+      config_set('encapsulation', 'destroy', profile: @encap_name)
+    end
+
+    # ----------
+    # PROPERTIES
+    # ----------
+
+    def range_summarize(string)
+      Utils.array_to_str(Encapsulation.string_to_array(string.to_s), false)
+    end
+
+    def dot1q_map
+      result = config_get('encapsulation', 'dot1q_map', profile: @encap_name)
+      return default_dot1q_map if result.empty?
+
+      result[0] = range_summarize(result[0])
+      result[1] = range_summarize(result[1])
+      result
+    end
+
+    def dot1q_map=(map)
+      state = ''
+      if map.empty?
+        state = 'no'
+        map = dot1q_map
+        return if map.empty?
+      end
+      vlans, vnis = map
+      config_set('encapsulation', 'dot1q_map', profile: @encap_name,
+                 state: state, vlans: vlans, vnis: vnis)
+    end
+
+    def default_dot1q_map
+      config_get_default('encapsulation', 'dot1q_map')
+    end
+  end
+end

data/lib/cisco_node_utils/environment.rb

@@ -0,0 +1,110 @@
+# August 2018
+# March 2016, Glenn F. Matthews
+#
+# Copyright (c) 2016-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 'yaml'
+require_relative 'logger'
+
+module Cisco
+  # Class representing the configuration environment
+  class Environment
+    @environments = {}
+    @default_environment_name = 'default'
+
+    # Autogenerate Cisco::Environment.default_environment_name and
+    # Cisco::Environment.default_environment_name= class methods.
+    class << self
+      attr_accessor :default_environment_name
+    end
+
+    # We have three tiers of configuration:
+    # 1) default (defined in this file)
+    # 2) System-wide gem configuration in /etc/cisco_node_utils.yaml
+    # 3) User configuration in ~/cisco_node_utils.yaml
+
+    DEFAULT_ENVIRONMENT = {
+      host:     nil, # localhost by default
+      port:     nil, # only applicable to gRPC
+      username: nil,
+      password: nil,
+      cookie:   nil, # only applicable to nxapi
+    }
+
+    def self.environments
+      if @environments.empty?
+        @environments = merge_config('/etc/cisco_node_utils.yaml',
+                                     @environments)
+        @environments = merge_config('~/cisco_node_utils.yaml',
+                                     @environments)
+        @environments.each do |name, config|
+          Cisco::Logger.debug("Environment '#{name}': #{config}")
+        end
+      end
+      @environments
+    end
+
+    def self.merge_config(path, current_config)
+      data = data_from_file(path)
+      data.each do |name, config|
+        # in case config is nil:
+        config ||= {}
+        # in case current_config has no entry for this name:
+        current_config[name] ||= DEFAULT_ENVIRONMENT.clone
+        # merge it on in!
+        current_config[name].merge!(strings_to_symbols(config))
+      end
+      current_config
+    end
+
+    def self.data_from_file(path)
+      begin
+        path = File.expand_path(path)
+      rescue ArgumentError => e
+        # Can happen if path includes '~' but $HOME is not defined
+        Cisco::Logger.debug "Failed to load #{path}: #{e}"
+        return {}
+      end
+      unless File.file?(path)
+        Cisco::Logger.debug "No file found at #{path}"
+        return {}
+      end
+      unless File.readable?(path)
+        Cisco::Logger.debug "No permissions to read #{path}"
+        return {}
+      end
+      YAML.load_file(path)
+    rescue Psych::SyntaxError => e
+      Cisco::Logger.error("Error loading #{path}: #{e}")
+      {}
+    end
+
+    def self.add_env(env_name, env_hash)
+      fail ArgumentError, 'empty environment name' if env_name.empty?
+      fail TypeError, 'invalid environment hash' unless env_hash.is_a?(Hash)
+      @environments[env_name] = env_hash
+    end
+
+    def self.strings_to_symbols(hash)
+      Hash[hash.map { |k, v| [k.to_sym, v] }]
+    end
+
+    def self.environment(name=nil)
+      name ||= @default_environment_name
+      Cisco::Logger.debug("Getting environment '#{name}'")
+      environments.fetch(name, DEFAULT_ENVIRONMENT)
+    end
+  end
+end

data/lib/cisco_node_utils/evpn_multicast.rb

@@ -0,0 +1,66 @@
+# 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 EvpnMulticast < NodeUtil
+    def initialize
+      @get_args = @set_args = {}
+      create
+    end
+
+    def create
+      return unless multicast == default_multicast
+      Feature.ngmvpn_enable
+      config_set('feature', 'nv_overlay', state: '')
+      @set_args[:state] = ''
+      config_set('evpn_multicast', 'multicast', @set_args)
+    end
+
+    def destroy
+      @set_args[:state] = 'no'
+      config_set('evpn_multicast', 'multicast', @set_args)
+    end
+
+    def self.multicast
+      config_get('evpn_multicast', 'multicast')
+    end
+
+    def multicast
+      config_get('evpn_multicast', 'multicast')
+    end
+
+    def multicast=(bool)
+      fail TypeError unless [true, false].include?(bool)
+      @set_args[:state] = bool ? '' : 'no'
+      if @set_args[:state] == 'no'
+        unless multicast == default_multicast
+          config_set('evpn_multicast', 'multicast', @set_args)
+        end
+      else
+        config_set('evpn_multicast', 'multicast', @set_args)
+      end
+    end
+
+    def default_multicast
+      config_get_default('evpn_multicast', 'multicast')
+    end
+  end
+end

data/lib/cisco_node_utils/evpn_multisite.rb

@@ -0,0 +1,96 @@
+# 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_multisite
+  class EvpnMultisite < NodeUtil
+    attr_reader :multisiteid, :time
+
+    def initialize(multisiteid, instantiate=true)
+      err_msg = "multisiteid must be either a 'String' or an" \
+                " 'Integer' object"
+      fail ArgumentError, err_msg unless multisiteid.is_a?(Integer) ||
+                                         multisiteid.is_a?(String)
+      @multisiteid = multisiteid.to_i
+      @get_args = @set_args = { multisiteid: @multisiteid }
+      create if instantiate
+    end
+
+    def create
+      # There is an issue with EX platform using
+      # Feature.nv_overlay_enable generating error code '400'
+      # Using config_set for enabling nv overlay
+      config_set('feature', 'nv_overlay', state: '')
+      sleep 1
+      @set_args[:state] = ''
+      config_set('evpn_multisite', 'multisite', @set_args)
+    end
+
+    def destroy
+      @set_args[:state] = 'no'
+      # HACK: set time to a dummy value
+      @set_args[:time] = 30
+      config_set('evpn_multisite', 'delay_restore', @set_args)
+      config_set('evpn_multisite', 'multisite', @set_args)
+    end
+
+    def self.multisite
+      nu_obj = nil
+      ms_id = config_get('evpn_multisite', 'multisite')
+      nu_obj = EvpnMultisite.new(ms_id, false) if ms_id
+      nu_obj
+    end
+
+    def multisite
+      config_get('evpn_multisite', 'multisite')
+    end
+
+    def multisite=(multisiteid)
+      err_msg = "multisiteid must be either a 'String' or an" \
+                " 'Integer' object"
+      fail ArgumentError, err_msg unless multisiteid.is_a?(Integer) ||
+                                         multisiteid.is_a?(String)
+      @multisiteid = multisiteid.to_i
+      @set_args[:multisiteid] = @multisiteid
+      config_set('evpn_multisite', 'multisite', @set_args)
+    end
+
+    def delay_restore
+      config_get('evpn_multisite', 'delay_restore', @get_args)
+    end
+
+    def delay_restore=(time)
+      # HACK: set a dummy time value when removing the property
+      dummy_time = 30
+      if time == default_delay_restore
+        @set_args[:state] = 'no'
+        @set_args[:time] = dummy_time
+      else
+        @set_args[:time] = time
+        @set_args[:state] = '' unless @set_args[:state]
+      end
+      config_set('evpn_multisite', 'delay_restore', @set_args)
+    end
+
+    def default_delay_restore
+      config_get_default('evpn_multisite', 'delay_restore')
+    end
+  end
+end

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