cisco_node_utils 1.9.0 → 1.10.0

data/lib/cisco_node_utils/interface_DEPRECATED.rb

@@ -65,6 +65,7 @@ module Cisco
     end
 
     def switchport_mode_private_vlan_host
+      return nil if switchport_mode == :disabled
       mode = config_get('DEPRECATED',
                         'switchport_mode_private_vlan_host',
                         name: @name)
@@ -299,6 +300,7 @@ module Cisco
     end
 
     def switchport_mode_private_vlan_trunk_promiscuous
+      return nil if switchport_mode == :disabled
       config_get('DEPRECATED',
                  'switchport_mode_private_vlan_trunk_promiscuous',
                  name: @name)
@@ -331,6 +333,7 @@ module Cisco
     end
 
     def switchport_mode_private_vlan_trunk_secondary
+      return nil if switchport_mode == :disabled
       config_get('DEPRECATED',
                  'switchport_mode_private_vlan_trunk_secondary',
                  name: @name)
@@ -361,6 +364,7 @@ module Cisco
     end
 
     def switchport_private_vlan_trunk_allowed_vlan
+      return nil if switchport_mode == :disabled
       result = config_get('DEPRECATED',
                           'switchport_private_vlan_trunk_allowed_vlan',
                           name: @name)
@@ -400,6 +404,7 @@ module Cisco
     end
 
     def switchport_private_vlan_trunk_native_vlan
+      return nil if switchport_mode == :disabled
       config_get('DEPRECATED',
                  'switchport_private_vlan_trunk_native_vlan',
                  name: @name)

data/lib/cisco_node_utils/interface_hsrp_group.rb

@@ -1,7 +1,7 @@
 #
 # October 2016, Sai Chintalapudi
 #
-# Copyright (c) 2016 Cisco and/or its affiliates.
+# 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.
@@ -96,6 +96,12 @@ module Cisco
     # authentication md5 key-string ABCXYZ timeout 22
     # authentication md5 key-string 7 12345678901234567890 timeout 22
     # authentication md5 key-string 7 123456789 compatibility timeout 22
+    # if passwd
+    #   req auth_enc_type
+    # if encrypted
+    #   req authentication_key_type, authentication_enc_type
+    #   if key-string
+    #     optional compat and timeout
     def authentication
       hash = {}
       hash[:auth_type] = default_authentication_auth_type
@@ -203,8 +209,13 @@ module Cisco
     end
 
     def authentication_timeout=(val)
-      @set_args[:tval] = val
-      @set_args[:timeout] = 'timeout'
+      if val.nil?
+        @set_args[:tval] = ''
+        @set_args[:timeout] = ''
+      else
+        @set_args[:tval] = val
+        @set_args[:timeout] = 'timeout'
+      end
     end
 
     def default_authentication_timeout
@@ -227,14 +238,14 @@ module Cisco
        :authentication_compatibility,
        :authentication_timeout,
       ].each do |p|
-        send(p.to_s + '=', attrs[p]) unless attrs[p].nil?
+        send(p.to_s + '=', attrs[p])
       end
-      return if @set_args[:passwd] == default_authentication_string
+      return if @set_args[:passwd].nil? || @set_args[:passwd].empty?
       @set_args[:state] = ''
       if @set_args[:authtype] == 'text'
         @set_args[:keytype] = @set_args[:enctype] = ''
         @set_args[:compatible] = @set_args[:timeout] = @set_args[:tval] = ''
-      elsif @set_args[:keytype] == default_authentication_key_type
+      elsif @set_args[:keytype] == 'key-chain'
         @set_args[:enctype] = @set_args[:compatible] = ''
         @set_args[:timeout] = @set_args[:tval] = ''
       end

data/lib/cisco_node_utils/ip_multicast.rb

@@ -64,23 +64,27 @@ module Cisco
     end
 
     def overlay_spt_only
-      config_get('ip_multicast', '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'
-      if @set_args[:state] == 'no'
-        unless overlay_spt_only == default_overlay_spt_only
-          config_set('ip_multicast', 'overlay_spt_only', @set_args)
-        end
-      else
-        config_set('ip_multicast', 'overlay_spt_only', @set_args)
-      end
+      config_set('ip_multicast', 'overlay_spt_only', @set_args)
     end
 
     def default_overlay_spt_only
-      config_get_default('ip_multicast', '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/node.rb

@@ -122,7 +122,10 @@ module Cisco
       value = value.is_a?(Hash) ? [value] : value
       data = nil
       value.each do |row|
-        data = row[data_key] if row[row_key].to_s[/#{row_index}/]
+        if row[row_key].to_s[/#{row_index}/]
+          data = row[data_key]
+          data = data.nil? ? '' : data
+        end
       end
       return value if data.nil?
       if regexp_filter

data/lib/cisco_node_utils/syslog_facility.rb

@@ -0,0 +1,64 @@
+# Syslog facility provider class
+#
+# Rick Sherman et al., August 2018
+#
+# Copyright (c) 2014-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 'node_util'
+
+module Cisco
+  # SyslogFacility - node utility class for Syslog facility severity management
+  class SyslogFacility < NodeUtil
+    attr_reader :facility, :level
+
+    def initialize(opts, instantiate=true)
+      @facility = opts['facility']
+      @level = opts['level']
+
+      create if instantiate
+    end
+
+    def self.facilities
+      keys = %w(facility level)
+      hash = {}
+      facility_key_list = config_get('syslog_facility', 'facility')
+      return hash if facility_key_list.nil?
+
+      facility_key_list.each do |id|
+        hash[id[0]] = SyslogFacility.new(Hash[keys.zip(id)], false)
+      end
+
+      hash
+    end
+
+    def ==(other)
+      facility == other.facility && level == other.level
+    end
+
+    def create
+      config_set('syslog_facility', 'facility', state: '', facility: @facility,
+                  level: @level)
+    end
+
+    def destroy
+      config_set('syslog_facility', 'facility', state: 'no',
+                  facility: @facility, level: @level)
+    end
+
+    def level
+      @level.to_i
+    end
+  end # class
+end # module

data/lib/cisco_node_utils/syslog_server.rb

@@ -1,8 +1,9 @@
 # Syslog Server provider class
 #
+# June 2018
 # Jonathan Tripathy et al., September 2015
 #
-# Copyright (c) 2014-2017 Cisco and/or its affiliates.
+# Copyright (c) 2014-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.
@@ -22,7 +23,7 @@ require 'resolv'
 module Cisco
   # SyslogServer - node utility class for syslog server configuration management
   class SyslogServer < NodeUtil
-    attr_reader :name, :level, :port, :vrf, :severity_level
+    attr_reader :name, :level, :port, :vrf, :severity_level, :facility
 
     LEVEL_TO_NUM = { 'emergencies'   => 0,
                      'alerts'        => 1,
@@ -40,6 +41,7 @@ module Cisco
       @port = opts['port']
       @vrf = opts['vrf']
       @severity_level = opts['severity_level'] || opts['level']
+      @facility = opts['facility']
 
       hostname_regex = /^(?=.{1,255}$)[0-9A-Za-z]
       (?:(?:[0-9A-Za-z]|-){0,61}[0-9A-Za-z])?
@@ -56,7 +58,7 @@ module Cisco
     end
 
     def self.syslogservers
-      keys = %w(name level port vrf severity_level)
+      keys = %w(name level port vrf facility severity_level)
       hash = {}
       syslogservers_list = config_get('syslog_server', 'server')
       return hash if syslogservers_list.nil?
@@ -65,6 +67,7 @@ module Cisco
         value_hash = Hash[keys.zip(id)]
         value_hash['severity_level'] = value_hash['level']
         value_hash['vrf'] = 'default' if value_hash['vrf'].nil?
+        value_hash['facility'] = 'local7' if value_hash['facility'].nil?
         hash[id[0]] = SyslogServer.new(value_hash, false)
       end
 
@@ -93,11 +96,12 @@ module Cisco
       else
         config_set('syslog_server',
                    'server',
-                   state: '',
-                   ip:    @name,
-                   level: @level ? "#{@level}" : '',
-                   port:  @port ? "port #{@port}" : '',
-                   vrf:   @vrf ? "use-vrf #{@vrf}" : '',
+                   state:    '',
+                   ip:       @name,
+                   level:    @level ? "#{@level}" : '',
+                   port:     @port ? "port #{@port}" : '',
+                   vrf:      @vrf ? "use-vrf #{@vrf}" : '',
+                   facility: @facility ? "facility #{@facility}" : '',
                   )
       end
     end
@@ -129,11 +133,12 @@ module Cisco
       else
         config_set('syslog_server',
                    'server',
-                   state: 'no',
-                   ip:    @name,
-                   level: '',
-                   port:  '',
-                   vrf:   '',
+                   state:    'no',
+                   ip:       @name,
+                   level:    '',
+                   port:     '',
+                   vrf:      '',
+                   facility: '',
                   )
       end
     end

data/lib/cisco_node_utils/syslog_settings.rb

@@ -1,8 +1,9 @@
 # Syslog Settings provider class
 #
+# August 2018
 # Jonathan Tripathy et al., September 2015
 #
-# Copyright (c) 2014-2017 Cisco and/or its affiliates.
+# Copyright (c) 2014-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.
@@ -126,6 +127,47 @@ module Cisco
                  units: val)
     end
 
+    def logfile_severity_level
+      logfile_severity_level =
+          config_get('syslog_settings', 'logfile_severity_level')
+      if logfile_severity_level.is_a?(Array)
+        if logfile_severity_level[0] == 'no'
+          logfile_severity_level = nil
+        else
+          logfile_severity_level = logfile_severity_level[1]
+        end
+      end
+      logfile_severity_level
+    end
+
+    def logfile_name=(logname, severity, size)
+      if logname
+        config_set(
+          'syslog_settings', 'logfile_name',
+          state: '', logname: logname, severity: severity, size: size)
+      else
+        config_set(
+          'syslog_settings', 'logfile_name',
+          state: 'no', logname: logname, severity: severity, size: size)
+      end
+    end
+
+    def logfile_name
+      logfile_name = config_get('syslog_settings', 'logfile_name')
+      if logfile_name.is_a?(Array)
+        logfile_name = (logfile_name[0] == 'no') ? 'unset' : logfile_name[1]
+      end
+      logfile_name
+    end
+
+    def logfile_size
+      logfile_size = config_get('syslog_settings', 'logfile_size')
+      if logfile_size.is_a?(Array)
+        logfile_size = (logfile_size[0] == 'no') ? nil : logfile_size[1]
+      end
+      logfile_size
+    end
+
     alias_method :time_stamp_units, :timestamp
     alias_method :time_stamp_units=, :timestamp=
   end # class

data/lib/cisco_node_utils/version.rb

@@ -14,7 +14,7 @@
 
 # Container module for version number only.
 module CiscoNodeUtils
-  VERSION = '1.9.0'
+  VERSION = '1.10.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

@@ -47,7 +47,7 @@ module Cisco
       return hash if vlan_list.nil?
 
       vlan_list.each do |id|
-        hash[id] = Vlan.new(id, false)
+        hash[id.to_s] = Vlan.new(id, false)
       end
       hash
     end

data/lib/cisco_node_utils/vxlan_vtep_vni.rb

@@ -112,20 +112,33 @@ module Cisco
       config_get('vxlan_vtep_vni', 'ingress_replication', @get_args)
     end
 
+    def set_host_reachability(vtep_name, protocol)
+      # This is a helper method for the ingress_replication setter.
+      # In later versions of Nexus, a check was added to make sure
+      # the host_reachability setting is correct for the desired
+      # ingress_replication setting.
+      #
+      case protocol
+      when 'bgp'
+        host_reachability = 'evpn'
+      when 'static'
+        host_reachability = 'flood'
+      else
+        fail "Protocol #{protocol} currently not supported"
+      end
+      VxlanVtep.new(vtep_name).host_reachability = host_reachability
+    end
+
     def remove_add_ingress_replication(protocol)
       # Note: ingress-replication is not supported on all platforms.
       # Use to_s.empty check to also handle nil check.
-      if ingress_replication.to_s.empty?
-        set_args_keys(state: '', protocol: protocol)
-        config_set('vxlan_vtep_vni', 'ingress_replication', @set_args)
-      else
-        # Sadly, the only way to change between protocols is to
-        # first remove the existing protocol.
+      unless ingress_replication.to_s.empty?
         set_args_keys(state: 'no', protocol: ingress_replication)
         config_set('vxlan_vtep_vni', 'ingress_replication', @set_args)
-        set_args_keys(state: '', protocol: protocol)
-        config_set('vxlan_vtep_vni', 'ingress_replication', @set_args)
       end
+      set_host_reachability(@set_args[:name], protocol)
+      set_args_keys(state: '', protocol: protocol)
+      config_set('vxlan_vtep_vni', 'ingress_replication', @set_args)
     end
 
     def ingress_replication=(protocol)

data/spec/environment_spec.rb

@@ -70,6 +70,37 @@ describe Cisco::Environment do
     end
   end
 
+  describe '.add_env' do
+    it 'rejects empty environment name' do
+      expect { described_class.add_env('', {}) }.to \
+        raise_error(ArgumentError, 'empty environment name')
+    end
+
+    it 'rejects incorrectly typed environment hash' do
+      expect { described_class.add_env('default', 'hash') }.to \
+        raise_error(TypeError, 'invalid environment hash')
+    end
+
+    context 'environment can be loaded by funcion' do
+      expected = {
+        host:     '192.168.1.1',
+        port:     nil,
+        username: 'admin',
+        password: 'admin',
+        cookie:   nil,
+      }
+      it 'can be loaded explicitly by name' do
+        described_class.add_env('test', expected)
+        expect(Cisco::Environment.environment('test')).to eq(expected)
+      end
+
+      it 'can be default' do
+        described_class.add_env('default', expected)
+        expect(Cisco::Environment.environment).to eq(expected)
+      end
+    end
+  end
+
   describe '.environments' do
     before(:each) do
       allow(Cisco::Environment).to receive(:data_from_file).and_return({})
@@ -162,6 +193,82 @@ describe Cisco::Environment do
         },
       )
     end
+
+    it 'loaded file can be overridden by add_env' do
+      expect(Cisco::Environment).to receive(:data_from_file).with(
+        '/etc/cisco_node_utils.yaml').and_return(global_config)
+      expect(Cisco::Environment).to receive(:data_from_file).with(
+        '~/cisco_node_utils.yaml').and_return(user_config)
+      expect(Cisco::Environment.environments).to eq(
+        'default' => {
+          host:     '127.0.0.1', # global config
+          port:     57_799, # user overrides global
+          username: 'user', # user config
+          password: nil, # auto-populated with nil
+          cookie:   nil,
+        },
+        'global'  => { # global config
+          host:     nil,
+          port:     nil,
+          username: 'global',
+          password: 'global',
+          cookie:   nil,
+        },
+        'user'    => { # user config
+          host:     nil,
+          port:     nil,
+          username: 'user',
+          password: 'user',
+          cookie:   nil,
+        },
+      )
+      added_env = {
+        host:     '192.168.1.1',
+        port:     nil,
+        username: 'admin',
+        password: 'admin',
+        cookie:   nil,
+      }
+      overide_defult = {
+        host:     '192.168.2.2',
+        port:     nil,
+        username: 'overridden',
+        password: 'overridden',
+        cookie:   nil,
+      }
+      described_class.add_env('added', added_env)
+      described_class.add_env('default', overide_defult)
+      expect(Cisco::Environment.environments).to eq(
+        'added'   => { # added by method
+          host:     '192.168.1.1',
+          port:     nil,
+          username: 'admin',
+          password: 'admin',
+          cookie:   nil,
+        },
+        'default' => {
+          host:     '192.168.2.2', # method overrides files
+          port:     nil, # method overrides files
+          username: 'overridden', # method overrides files
+          password: 'overridden', # method overrides files
+          cookie:   nil, # auto-popuplated with nil
+        },
+        'global'  => { # global config
+          host:     nil,
+          port:     nil,
+          username: 'global',
+          password: 'global',
+          cookie:   nil,
+        },
+        'user'    => { # user config
+          host:     nil,
+          port:     nil,
+          username: 'user',
+          password: 'user',
+          cookie:   nil,
+        },
+      )
+    end
   end
 
   context '.environment' do