cisco_node_utils 1.3.0 → 1.4.0

data/lib/cisco_node_utils/snmpserver.rb

@@ -39,9 +39,9 @@ module Cisco
     def location=(location)
       fail TypeError unless location.is_a?(String)
       if location.empty?
-        config_set('snmp_server', 'location', 'no', '')
+        config_set('snmp_server', 'location', state: 'no', location: '')
       else
-        config_set('snmp_server', 'location', '', location)
+        config_set('snmp_server', 'location', state: '', location: location)
       end
     end
 
@@ -57,9 +57,9 @@ module Cisco
     def contact=(contact)
       fail TypeError unless contact.is_a?(String)
       if contact.empty?
-        config_set('snmp_server', 'contact', 'no', '')
+        config_set('snmp_server', 'contact', state: 'no', contact: '')
       else
-        config_set('snmp_server', 'contact', '', contact)
+        config_set('snmp_server', 'contact', state: '', contact: contact)
       end
     end
 

data/lib/cisco_node_utils/tacacs_global.rb

@@ -0,0 +1,102 @@
+# Tacacs Global provider class
+
+# TP HONEY et al., June 2014-2016
+
+# 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'
+
+# Tacacs Global configuration management
+module Cisco
+  TACACS_GLOVAL_ENC_NONE = 0
+  TACACS_GLOBAL_ENC_CISCO_TYPE_7 = 7
+  TACACS_GLOBAL_ENC_UNKNOWN = 8
+
+  # TacacsGlobal - node utility class for
+  class TacacsGlobal < NodeUtil
+    attr_reader :name
+
+    def initialize(name)
+      fail TypeError unless name.is_a?(String)
+      fail ArgumentError,
+           "This provider only accepts an id of 'default'" \
+           unless name.eql?('default')
+      Feature.tacacs_enable unless Feature.tacacs_enabled?
+      @name = name
+    end
+
+    def self.tacacs_global
+      hash = {}
+      hash['default'] = TacacsGlobal.new('default')
+      hash
+    end
+
+    def ==(other)
+      name == other.name
+    end
+
+    def timeout
+      config_get('tacacs_global', 'timeout')
+    end
+
+    def default_timeout
+      config_get_default('tacacs_global', 'timeout')
+    end
+
+    def timeout=(val)
+      unless val.nil?
+        fail ArgumentError, 'timeout must be an Integer' \
+          unless val.is_a?(Integer)
+      end
+
+      if val.nil?
+        config_set('tacacs_global',
+                   'timeout',
+                   state:   'no',
+                   timeout: timeout)
+      else
+        config_set('tacacs_global',
+                   'timeout',
+                   state:   '',
+                   timeout: val)
+      end
+    end
+
+    def key_format
+      match = config_get('tacacs_global', 'key_format')
+      match.nil? ? TACACS_GLOBAL_ENC_UNKNOWN : match[0].to_i
+    end
+
+    def key
+      match = config_get('tacacs_global', 'key')
+      match.empty? ? TacacsGlobal.default_key : match[1]
+    end
+
+    # Get default encryption password
+    def self.default_key
+      config_get_default('tacacs_global', 'key')
+    end
+
+    def encryption_key_set(key_format, key)
+      if key_format == TACACS_GLOBAL_ENC_UNKNOWN
+        config_set('tacacs_server', 'encryption', state: 'no',
+                    option: key_format, key: key)
+      else
+        config_set('tacacs_server', 'encryption', state: '', option: key_format,
+                    key: key)
+      end
+    end
+  end # class
+end # module

data/lib/cisco_node_utils/tacacs_server.rb

@@ -39,12 +39,12 @@ module Cisco
 
     # Enable tacacs_server feature
     def enable
-      config_set('tacacs_server', 'feature', '')
+      config_set('tacacs_server', 'feature', '') unless platform == :ios_xr
     end
 
     # Disable tacacs_server feature
     def destroy
-      config_set('tacacs_server', 'feature', 'no')
+      config_set('tacacs_server', 'feature', 'no') unless platform == :ios_xr
     end
 
     # --------------------
@@ -55,7 +55,7 @@ module Cisco
     def timeout=(timeout)
       # 'no tacacs timeout' will fail.
       # Just set it to the requested timeout value.
-      config_set('tacacs_server', 'timeout', '', timeout)
+      config_set('tacacs_server', 'timeout', state: '', timeout: timeout)
     end
 
     # Get timeout
@@ -162,12 +162,13 @@ module Cisco
         # need to unset it. Otherwise the box is not configured with key, we
         # don't need to do anything
         if encryption_type != TACACS_SERVER_ENC_UNKNOWN
-          config_set('tacacs_server', 'encryption', 'no',
-                     encryption_type,
-                     encryption_password)
+          config_set('tacacs_server', 'encryption', state:  'no',
+                                                    option: encryption_type,
+                                                    key:    encryption_password)
         end
       else
-        config_set('tacacs_server', 'encryption', '', enctype, password)
+        config_set('tacacs_server', 'encryption', state: '', option: enctype,
+                    key: password)
       end
     end
   end

data/lib/cisco_node_utils/vdc.rb

@@ -65,6 +65,12 @@ module Cisco
     #                      PROPERTIES                      #
     ########################################################
 
+    def allocate_interface
+      # TBD: This property is only partially implemented because it is currently
+      # only used for minitest & beaker.
+      config_get('vdc', 'allocate_interface', vdc: @vdc)
+    end
+
     def limit_resource_module_type
       str = config_get('vdc', 'limit_resource_module_type', vdc: @vdc)
       str.strip! unless str.nil?
@@ -72,13 +78,25 @@ module Cisco
 
     def limit_resource_module_type=(mods)
       state = mods.empty? ? 'no' : ''
-      config_set('vdc', 'limit_resource_module_type',
-                 state: state, vdc: @vdc, mods: mods)
-
-      # TBD: No interfaces are allocated after changing the module-type
-      # so 'allocate' is needed to make this useful. Consider moving
-      # this into it's own property.
-      config_set('vdc', 'allocate_interface_unallocated', vdc: @vdc)
+      begin
+        # limit-resource commands are time-consuming and process in the
+        # background. Back-to-back LR commands may fail if processed too
+        # quickly.
+        config_set('vdc', 'limit_resource_module_type',
+                   state: state, vdc: @vdc, mods: mods)
+
+        # TBD: No interfaces are allocated after changing the module-type
+        # so 'allocate' is needed to make this useful. Consider moving
+        # this into it's own property.
+        config_set('vdc', 'allocate_interface_unallocated', vdc: @vdc)
+
+      rescue CliError => e
+        count ||= 1
+        if e.message[/VDC is not in active state/] && (count += 1) < 10
+          retry
+        end
+        raise
+      end
     end
 
     def default_limit_resource_module_type

data/lib/cisco_node_utils/version.rb

@@ -14,7 +14,7 @@
 
 # Container module for version number only.
 module CiscoNodeUtils
-  VERSION = '1.3.0'
+  VERSION = '1.4.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/vlan.rb

@@ -19,13 +19,14 @@ require_relative 'node_util'
 require_relative 'interface'
 require_relative 'fabricpath_global'
 require_relative 'feature'
+require_relative 'vlan_DEPRECATED'
 
 # Add some Vlan-specific constants to the Cisco namespace
 module Cisco
   VLAN_NAME_SIZE = 33
 
   # Vlan - node utility class for VLAN configuration management
-  class Vlan < NodeUtil
+  class Vlan < Cisco::VlanDeprecated
     attr_reader :vlan_id
 
     def initialize(vlan_id, instantiate=true)
@@ -221,7 +222,13 @@ module Cisco
       config_get('vlan', 'mapped_vni', vlan: @vlan_id)
     end
 
+    def requires_nv_overlay?
+      config_get('vlan', 'mapped_vni_requires_nv_overlay')
+    end
+
     def mapped_vni=(vni)
+      # Some platforms require feature nv_overlay to be enabled first.
+      Feature.nv_overlay_enable if requires_nv_overlay?
       Feature.vn_segment_vlan_based_enable
       # Remove the existing mapping first as cli doesn't support overwriting.
       config_set('vlan', 'mapped_vni', vlan: @vlan_id,
@@ -236,93 +243,60 @@ module Cisco
       config_get_default('vlan', 'mapped_vni')
     end
 
-    def private_vlan_type
+    def pvlan_type
       return nil unless Feature.private_vlan_enabled?
-      config_get('vlan', 'private_vlan_type', id: @vlan_id)
+      config_get('vlan', 'pvlan_type', id: @vlan_id)
     end
 
-    def private_vlan_type=(type)
+    def pvlan_type=(type)
       Feature.private_vlan_enable
       fail TypeError unless type && type.is_a?(String)
 
-      if type == default_private_vlan_type
-        return if private_vlan_type.empty?
-        set_args_keys(state: 'no', type: private_vlan_type)
+      if type == default_pvlan_type
+        return if pvlan_type.empty?
+        set_args_keys(state: 'no', type: pvlan_type)
         ignore_msg = 'Warning: Private-VLAN CLI removed'
       else
         set_args_keys(state: '', type: type)
         ignore_msg = 'Warning: Private-VLAN CLI entered'
       end
-      result = config_set('vlan', 'private_vlan_type', @set_args)
+      result = config_set('vlan', 'pvlan_type', @set_args)
       cli_error_check(result, ignore_msg)
     end
 
-    def default_private_vlan_type
-      config_get_default('vlan', 'private_vlan_type')
+    def default_pvlan_type
+      config_get_default('vlan', 'pvlan_type')
     end
 
-    def private_vlan_association
+    def pvlan_association
       return nil unless Feature.private_vlan_enabled?
-      config_get('vlan', 'private_vlan_association', id: @vlan_id)
+      range = config_get('vlan', 'pvlan_association', id: @vlan_id)
+      Utils.normalize_range_array(range)
     end
 
-    def private_vlan_association=(vlan_list)
+    def pvlan_association=(range)
       Feature.private_vlan_enable
-      vlan_list_delta(private_vlan_association, vlan_list)
+      is = Utils.dash_range_to_elements(pvlan_association)
+      should = Utils.dash_range_to_elements(range)
+      association_delta(is, should)
     end
 
     def default_private_vlan_association
-      config_get_default('vlan', 'private_vlan_association')
+      config_get_default('vlan', 'pvlan_association')
     end
 
     # --------------------------
-    # vlan_list_delta is a helper function for the private_vlan_association
+    # association_delta is a helper function for the pvlan_association
     # property. It walks the delta hash and adds/removes each target private
     # vlan.
-    # This api is used by private vlan to prepare the input to the setter
-    # method. The input can be in the following formats for vlans:
-    # 10-12,14. Prepare_array api is transforming this input into a flat array.
-    # In the example above the returned array will be 10, 11, 12, 14. Prepare
-    # array is first splitting the input on ',' and the than expanding the vlan
-    # range element like 10-12 into a flat array. The final result will
-    # be a  flat array.
-    # This way we can later used the lib utility to check the delta from
-    # the input vlan value and the vlan configured to apply the right config.
-
-    def vlan_list_delta(is_list, should_list)
-      new_list = []
-      should_list.each do |item|
-        if item.include?(',')
-          new_list.push(item.split(','))
-        else
-          new_list.push(item)
-        end
-      end
-      new_list.flatten!
-      new_list.sort!
-
-      new_list.each { |item| item.gsub!('-', '..') }
-
-      should_list_new = []
-      new_list.each do |elem|
-        if elem.include?('..')
-          elema = elem.split('..').map { |d| Integer(d) }
-          elema.sort!
-          tr = elema[0]..elema[1]
-          tr.to_a.each do |item|
-            should_list_new.push(item.to_s)
-          end
-        else
-          should_list_new.push(elem)
-        end
-      end
-
-      delta_hash = Utils.delta_add_remove(should_list_new, is_list)
+    def association_delta(is, should)
+      delta_hash = Utils.delta_add_remove(should, is)
+      Cisco::Logger.debug("association_delta: #{@vlan_id}: #{delta_hash}")
       [:add, :remove].each do |action|
         delta_hash[action].each do |vlans|
           state = (action == :add) ? '' : 'no'
           set_args_keys(state: state, vlans: vlans)
-          result = config_set('vlan', 'private_vlan_association', @set_args)
+          result = config_set('vlan', 'pvlan_association', @set_args)
           cli_error_check(result)
         end
       end

data/lib/cisco_node_utils/vlan_DEPRECATED.rb

@@ -0,0 +1,108 @@
+# rubocop: disable Style/FileName
+#
+# 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.
+###############################################################################
+#
+#                        WARNING! WARNING! WARNING!
+#
+# This file contains deprecated methods that will be removed with version 2.0.0
+#
+###############################################################################
+
+require_relative 'node_util'
+require 'logger'
+
+module Cisco
+  # Vlan - node utility class for VLAN configuration management
+  class VlanDeprecated < NodeUtil
+    def deprecation_warning(method, new_prop=nil)
+      if new_prop.nil?
+        new_prop = ''
+      else
+        new_prop = "The new property name is '#{new_prop}'"
+      end
+
+      warn "
+      #########################################################################
+       WARNING: Method '#{method.to_s.delete('=')}'
+       is deprecated and should not be used.
+       #{new_prop}
+      #########################################################################
+      "
+    end
+
+    def private_vlan_type
+      return nil unless Feature.private_vlan_enabled?
+      config_get('DEPRECATED', 'private_vlan_type', id: @vlan_id)
+    end
+
+    def private_vlan_type=(type)
+      deprecation_warning(__method__, 'pvlan_type')
+      Feature.private_vlan_enable
+      fail TypeError unless type && type.is_a?(String)
+
+      if type == default_private_vlan_type
+        return if private_vlan_type.empty?
+        set_args_keys(state: 'no', type: private_vlan_type)
+        ignore_msg = 'Warning: Private-VLAN CLI removed'
+      else
+        set_args_keys(state: '', type: type)
+        ignore_msg = 'Warning: Private-VLAN CLI entered'
+      end
+      result = config_set('DEPRECATED', 'private_vlan_type', @set_args)
+      cli_error_check(result, ignore_msg)
+    end
+
+    def default_private_vlan_type
+      config_get_default('DEPRECATED', 'private_vlan_type')
+    end
+
+    def private_vlan_association
+      return nil unless Feature.private_vlan_enabled?
+      range = config_get('DEPRECATED', 'private_vlan_association', id: @vlan_id)
+      Utils.normalize_range_array(range)
+    end
+
+    def private_vlan_association=(range)
+      deprecation_warning(__method__, 'pvlan_association')
+      Feature.private_vlan_enable
+      is = Utils.dash_range_to_elements(private_vlan_association)
+      should = Utils.dash_range_to_elements(range)
+      association_delta(is, should)
+    end
+
+    def default_private_vlan_association
+      config_get_default('DEPRECATED', 'private_vlan_association')
+    end
+
+    # --------------------------
+    # association_delta is a helper function for the private_vlan_association
+    # property. It walks the delta hash and adds/removes each target private
+    # vlan.
+    def association_delta(is, should)
+      delta_hash = Utils.delta_add_remove(should, is)
+      Cisco::Logger.debug("association_delta: #{@vlan_id}: #{delta_hash}")
+      [:add, :remove].each do |action|
+        delta_hash[action].each do |vlans|
+          state = (action == :add) ? '' : 'no'
+          set_args_keys(state: state, vlans: vlans)
+          result = config_set('DEPRECATED',
+                              'private_vlan_association', @set_args)
+          cli_error_check(result)
+        end
+      end
+    end
+  end # Class
+end # Module