cisco_node_utils 1.1.0 → 1.2.0

data/lib/cisco_node_utils/tacacs_server_host.rb

@@ -1,6 +1,6 @@
 # Alex Hunsberger, March 2015
 #
-# Copyright (c) 2015 Cisco and/or its affiliates.
+# 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.
@@ -53,9 +53,7 @@ module Cisco
     end
 
     def port
-      p = config_get('tacacs_server_host', 'port', @name)
-      fail "unable to retrieve port information for #{@name}" if p.nil?
-      p.first.to_i
+      config_get('tacacs_server_host', 'port', @name)
     end
 
     def port=(n)
@@ -68,7 +66,7 @@ module Cisco
 
     def encryption_type
       type = config_get('tacacs_server_host', 'encryption_type', @name)
-      type.nil? ? TACACS_SERVER_ENC_UNKNOWN : type.first.to_i
+      type.nil? ? TACACS_SERVER_ENC_UNKNOWN : type.to_i
     end
 
     def self.default_encryption_type
@@ -76,8 +74,7 @@ module Cisco
     end
 
     def encryption_password
-      pass = config_get('tacacs_server_host', 'encryption_password', @name)
-      pass.nil? ? TacacsServerHost.default_encryption_password : pass.first
+      config_get('tacacs_server_host', 'encryption_password', @name)
     end
 
     def self.default_encryption_password
@@ -107,8 +104,7 @@ module Cisco
     end
 
     def timeout
-      t = config_get('tacacs_server_host', 'timeout', @name)
-      t.nil? ? TacacsServerHost.default_timeout : t.first.to_i
+      config_get('tacacs_server_host', 'timeout', @name)
     end
 
     def timeout=(t)

data/lib/cisco_node_utils/vdc.rb

@@ -0,0 +1,88 @@
+#
+# NXAPI implementation of VDC class
+#
+# December 2015, Chris Van Heuveln
+#
+# 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 vdc
+  class Vdc < NodeUtil
+    attr_reader :name
+
+    def initialize(name, instantiate=true)
+      @vdc = (name == 'default') ? Vdc.default_vdc_name : name
+      create if instantiate
+    end
+
+    def self.vdcs
+      hash = {}
+      vdc_list = config_get('vdc', 'all_vdcs')
+      return hash if vdc_list.nil?
+
+      vdc_list.each do |vdc_name|
+        hash[vdc_name] = Vdc.new(vdc_name, false)
+      end
+      hash
+    end
+
+    def self.vdc_support
+      config_get('vdc', 'vdc_support')
+    end
+
+    def self.default_vdc_name
+      vdc = config_get('vdc', 'default_vdc_name')
+      fail RuntimeError if vdc.nil?
+      vdc
+    end
+
+    def create
+      fail ArgumentError,
+           'There is currently no support for non-default VDCs' unless
+        @vdc == Vdc.default_vdc_name
+      # noop for 'default' vdc
+    end
+
+    def ==(other)
+      name == other.name
+    end
+
+    ########################################################
+    #                      PROPERTIES                      #
+    ########################################################
+
+    def limit_resource_module_type
+      str = config_get('vdc', 'limit_resource_module_type', vdc: @vdc)
+      str.strip! unless str.nil?
+    end
+
+    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)
+    end
+
+    def default_limit_resource_module_type
+      config_get_default('vdc', 'limit_resource_module_type')
+    end
+  end  # Class
+end    # Module

data/lib/cisco_node_utils/version.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2015 Cisco and/or its affiliates.
+# 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.
@@ -14,5 +14,8 @@
 
 # Container module for version number only.
 module CiscoNodeUtils
-  VERSION = '1.1.0'
+  VERSION = '1.2.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
 end

data/lib/cisco_node_utils/vlan.rb

@@ -1,6 +1,6 @@
 # Jie Yang, November 2014
 #
-# Copyright (c) 2014-2015 Cisco and/or its affiliates.
+# 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.
@@ -16,6 +16,7 @@
 
 require_relative 'node_util'
 require_relative 'interface'
+require_relative 'fabricpath_global'
 
 # Add some Vlan-specific constants to the Cisco namespace
 module Cisco
@@ -57,13 +58,58 @@ module Cisco
       # instead just displays a STDOUT error message; thus NXAPI does not detect
       # the failure and we must catch it by inspecting the "body" hash entry
       # returned by NXAPI. This vlan cli behavior is unlikely to change.
-      fail result[2]['body'] unless result[2]['body'].empty?
+      fail result[2]['body'] if
+        result[2].is_a?(Hash) &&
+        /(ERROR:|Warning:)/.match(result[2]['body'].to_s)
+
+      # Some test environments get result[2] as a string instead of a hash
+      fail result[2] if
+        result[2].is_a?(String) &&
+        /(ERROR:|Warning:)/.match(result[2])
+    end
+
+    def fabricpath_feature
+      FabricpathGlobal.fabricpath_feature
+    end
+
+    def fabricpath_feature_set(fabricpath_set)
+      FabricpathGlobal.fabricpath_feature_set(fabricpath_set)
+    end
+
+    def mode
+      result = config_get('vlan', 'mode', @vlan_id)
+      return default_mode if result.nil?
+      case result
+      when /fabricpath/i
+        return 'fabricpath'
+      when /ce/i
+        return 'ce'
+      end
+    end
+
+    def mode=(str)
+      str = str.to_s
+      if str.empty?
+        result = config_set('vlan', 'mode', @vlan_id, 'no', '')
+      else
+        if 'fabricpath' == str
+          fabricpath_feature_set(:enabled) unless
+            :enabled == fabricpath_feature
+        end
+        result = config_set('vlan', 'mode', @vlan_id, '', str)
+      end
+      cli_error_check(result)
+    rescue CliError => e
+      raise "[vlan #{@vlan_id}] '#{e.command}' : #{e.clierror}"
+    end
+
+    def default_mode
+      config_get_default('vlan', 'mode')
     end
 
     def vlan_name
       result = config_get('vlan', 'name', @vlan_id)
-      return default_vlan_name if result.nil?
-      result.shift
+      result.nil? ? default_vlan_name : result
     end
 
     def vlan_name=(str)
@@ -84,8 +130,7 @@ module Cisco
 
     def state
       result = config_get('vlan', 'state', @vlan_id)
-      return default_state if result.nil?
-      case result.first
+      case result
       when /act/
         return 'active'
       when /sus/
@@ -111,9 +156,8 @@ module Cisco
 
     def shutdown
       result = config_get('vlan', 'shutdown', @vlan_id)
-      return default_shutdown if result.nil?
       # Valid result is either: "active"(aka no shutdown) or "shutdown"
-      result.first[/shut/] ? true : false
+      result[/shut/] ? true : false
     end
 
     def shutdown=(val)
@@ -146,5 +190,24 @@ module Cisco
       end
       interfaces
     end
+
+    def mapped_vni
+      config_get('vlan', 'mapped_vni', vlan: @vlan_id)
+    end
+
+    def mapped_vni=(vni)
+      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,
+                         state: 'no', vni: vni)
+      # Configure the new mapping
+      state = vni == default_mapped_vni ? 'no' : ''
+      config_set('vlan', 'mapped_vni', vlan: @vlan_id,
+                          state: state, vni: vni)
+    end
+
+    def default_mapped_vni
+      config_get_default('vlan', 'mapped_vni')
+    end
   end # class
 end # module

data/lib/cisco_node_utils/vni.rb

@@ -0,0 +1,227 @@
+# VNI provider class
+#
+# Deepak Cherian, September 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.
+#
+# ----
+# This provider supports both MT-full (N7K) and MT-lite (N3K/N9K),
+# each of which have their own feature requirements and clis.
+#
+# MT-full cli:                      MT-lite cli:
+#   feature nv overlay              feature nv overlay
+#   feature nvi                     feature vn-segment-vlan-based
+#   system bridge-domain 100-113
+#   bridge-domain 100
+#     member vni 100
+#   vni 10001                       vlan 100
+#     shutdown                        vn-segment 10001
+#
+require_relative 'node_util'
+require_relative 'feature'
+
+module Cisco
+  # node_utils class for Vni
+  class Vni < NodeUtil
+    attr_reader :name, :vni_id
+
+    def initialize(vni_id, instantiate=true)
+      @vni_id = vni_id.to_s
+      fail ArgumentError,
+           'Invalid value(non-numeric VNI id)' unless @vni_id[/^\d+$/]
+      create if instantiate
+    end
+
+    def self.vnis
+      hash = {}
+      vni_list = config_get('vni', 'all_vnis')
+      return hash if vni_list.nil?
+
+      vni_list.each do |id|
+        hash[id] = Vni.new(id, false)
+      end
+      hash
+    end
+
+    # feature vni
+    def self.feature_vni_enabled
+      config_get('vni', '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_vni_enable # TBD: move this to feature.rb
+      Feature.nv_overlay_enable
+      config_set('vni', 'feature')
+    end
+
+    def self.mt_full_support
+      config_get('vni', 'mt_full_support')
+    end
+
+    def self.mt_lite_support
+      config_get('vni', 'mt_lite_support')
+    end
+
+    def create
+      Vni.feature_vni_enable unless Vni.feature_vni_enabled
+      config_set('vni', 'create', vni: @vni_id) if Vni.mt_full_support
+    end
+
+    def destroy
+      config_set('vni', 'destroy', vni: @vni_id)
+    end
+
+    def cli_error_check(result)
+      # The NXOS vni cli does not raise an exception in some conditions and
+      # instead just displays a STDOUT error message; thus NXAPI does not detect
+      # the failure and we must catch it by inspecting the "body" hash entry
+      # returned by NXAPI. This cli behavior is unlikely to change.
+      fail result[2]['body'] if /ERROR:/.match(result[2]['body'].to_s)
+    end
+
+    # TODO: This method will be refactored as part of US52662
+    # def encap_dot1q
+    #  final_hash = {}
+    #  show = show("sh encapsulation profile | inc 'vni [0-9,]*' p 1")
+    #  debug("show class is #{show.class} and show op is #{show}")
+    #  return final_hash if show == {}
+    #  match_pat = /vni (\S+).*dot1q\s+([ 0-9,\-]+)vni ([ 0-9,\-]+)/m
+    #  split_pat = /encapsulation profile /
+    #  pair_arr = show.split(split_pat)
+    #  pair_arr.each do |pair|
+    #    match_arr = match_pat.match(pair)
+    #    next if match_arr.nil?
+    #    debug "match arr 1 : #{match_arr[1]} 2: #{match_arr[2]} " \
+    #          "3: #{match_arr[3]}"
+    #    key_arr = (match_arr[3].split(/,/)).map do |x|
+    #      x.strip!
+    #      if /-/.match(x)
+    #        x.gsub!('-', '..')
+    #      else
+    #        x
+    #      end
+    #    end
+    #    val_arr = (match_arr[2].split(/,/)).map do |x|
+    #      x.strip!
+    #      if /-/.match(x)
+    #        x.gsub!('-', '..')
+    #      else
+    #        x
+    #      end
+    #    end
+    #
+    #    debug "key_arr = #{key_arr} val_arr = #{val_arr}"
+    #
+    #    index = 0
+    #    value = nil
+    #    key_arr.each do |key|
+    #      # puts "checking |#{key}| against |#{@vni_id}|"
+    #      # puts "checking #{key.class} against #{my_vni.class}"
+    #      if /\.\./.match(key)
+    #        range = eval(key) ###################### *MUSTFIX* REMOVE eval
+    #        if range.include?(@vni_id.to_i)
+    #          val_range = eval(val_arr[index]) ##### *MUSTFIX* REMOVE eval
+    #          position = @vni_id.to_i - range.begin
+    #          value = val_range.begin + position
+    #          value = value.to_s
+    #          debug "matched #{@vni_id} value is #{value}"
+    #          break
+    #        end
+    #      elsif key == @vni_id
+    #        value = val_arr[index]
+    #        debug "matched #{key} value is #{value}"
+    #      end
+    #      index += 1
+    #    end
+    #    unless value.nil?
+    #      # final_hash[match_arr[1]] = value.to_i
+    #      final_hash[match_arr[1]] = value
+    #    end
+    #  end # pair.each
+    #  final_hash
+    # end # end of encap_dot1q
+
+    def encap_dot1q=(val, prev_val=nil) # TBD REFACTOR
+      debug "val is of class #{val.class} and is #{val} prev is #{prev_val}"
+      # When prev_val is nil, HashDiff doesn't do a `+' on each element, so this
+      if prev_val.nil?
+        val.each do |fresh_profile, fresh_dot1q|
+          config_set('vni', 'encap_dot1q', fresh_profile, '',
+                     fresh_dot1q, @vni_id)
+        end
+        return
+      end
+      require 'hashdiff'
+      hash_diff = HashDiff.diff(prev_val, val)
+      debug "hsh diff ; #{hash_diff}"
+      return if hash_diff == []
+      hash_diff.each do |diff|
+        result =
+          case diff[0]
+          when /\+/
+            config_set('vni', 'encap_dot1q', diff[1], '', diff[2], @vni_id)
+          when /\-/
+            config_set('vni', 'encap_dot1q', diff[1], 'no', diff[2], @vni_id)
+          when /~/
+            config_set('vni', 'encap_dot1q', diff[1], 'no', diff[2], @vni_id)
+            config_set('vni', 'encap_dot1q', diff[1], '', diff[3], @vni_id)
+          end
+        cli_error_check(result)
+      end
+    rescue CliError => e
+      raise "[vni #{@vni_id}] '#{e.command}' : #{e.clierror}"
+    end
+
+    def default_encap_dot1q
+      config_get_default('vni', 'encap_dot1q')
+    end
+
+    def bridge_domain
+      bd_arr = config_get('vni', 'bridge_domain', vni: @vni_id)
+      bd_arr.first.to_i
+    end
+
+    def bridge_domain=(domain)
+      # TBD: ACTIVATE SHOULD BE SEPARATE SETTER AND POSSIBLY RENAMED
+      state = (domain) ? '' : 'no'
+      config_set('vni', 'bridge_domain_activate', state: state, domain: domain)
+      config_set('vni', 'bridge_domain', state: state, domain: domain,
+                 vni: @vni_id)
+    end
+
+    def default_bridge_domain
+      config_get_default('vni', 'bridge_domain')
+    end
+
+    def shutdown
+      config_get('vni', 'shutdown', vni: @vni_id)
+    end
+
+    def shutdown=(state)
+      state = (state) ? '' : 'no'
+      result = config_set('vni', 'shutdown', state: state, vni: @vni_id)
+      cli_error_check(result)
+    rescue CliError => e
+      raise "[vni #{@vni_id}] '#{e.command}' : #{e.clierror}"
+    end
+
+    def default_shutdown
+      config_get_default('vni', 'shutdown')
+    end
+  end # class
+end # module