cisco_node_utils 1.6.0 → 1.7.0

data/lib/cisco_node_utils/itd_device_group.rb

@@ -67,30 +67,6 @@ module Cisco
       @set_args = @get_args.merge!(hash) unless hash.empty?
     end
 
-    # extract value of property from probe
-    def extract_value(prop, prefix=nil)
-      prefix = prop if prefix.nil?
-      probe_match = probe_get
-
-      # matching probe not found
-      return nil if probe_match.nil? # no matching probe found
-
-      # property not defined for matching probe
-      return nil unless probe_match.names.include?(prop)
-
-      # extract and return value that follows prefix + <space>
-      regexp = Regexp.new("#{Regexp.escape(prefix)} (?<extracted>.*)")
-      value_match = regexp.match(probe_match[prop])
-      return nil if value_match.nil?
-      value_match[:extracted]
-    end
-
-    # prepend property name prefix/keyword to value
-    def attach_prefix(val, prop, prefix=nil)
-      prefix = prop.to_s if prefix.nil?
-      @set_args[prop] = val.to_s.empty? ? val : "#{prefix} #{val}"
-    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 ...
@@ -113,7 +89,7 @@ module Cisco
     end
 
     def probe_control
-      val = extract_value('control')
+      val = Utils.extract_value(probe_get, 'control')
       return default_probe_control if val.nil?
       val == 'enable' ? true : default_probe_control
     end
@@ -131,21 +107,21 @@ module Cisco
     end
 
     def probe_dns_host
-      extract_value('dns_host', 'host')
+      Utils.extract_value(probe_get, 'dns_host', 'host')
     end
 
     def probe_dns_host=(dns_host)
-      attach_prefix(dns_host, :dns_host, 'host')
+      @set_args[:dns_host] = Utils.attach_prefix(dns_host, :dns_host, 'host')
     end
 
     def probe_frequency
-      val = extract_value('frequency')
+      val = Utils.extract_value(probe_get, 'frequency')
       return default_probe_frequency if val.nil?
       val.to_i
     end
 
     def probe_frequency=(frequency)
-      attach_prefix(frequency, :frequency)
+      @set_args[:frequency] = Utils.attach_prefix(frequency, :frequency)
     end
 
     def default_probe_frequency
@@ -153,22 +129,24 @@ module Cisco
     end
 
     def probe_port
-      val = extract_value('port')
+      val = Utils.extract_value(probe_get, 'port')
       val.to_i unless val.nil?
     end
 
     def probe_port=(port)
-      attach_prefix(port, :port)
+      @set_args[:port] = Utils.attach_prefix(port, :port)
     end
 
     def probe_retry_down
-      val = extract_value('retry_down', 'retry-down-count')
+      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)
-      attach_prefix(rdc, :retry_down_count, 'retry-down-count')
+      @set_args[:retry_down_count] = Utils.attach_prefix(rdc,
+                                                         :retry_down_count,
+                                                         'retry-down-count')
     end
 
     def default_probe_retry_down
@@ -176,13 +154,15 @@ module Cisco
     end
 
     def probe_retry_up
-      val = extract_value('retry_up', 'retry-up-count')
+      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)
-      attach_prefix(ruc, :retry_up_count, 'retry-up-count')
+      @set_args[:retry_up_count] = Utils.attach_prefix(ruc,
+                                                       :retry_up_count,
+                                                       'retry-up-count')
     end
 
     def default_probe_retry_up
@@ -190,13 +170,13 @@ module Cisco
     end
 
     def probe_timeout
-      val = extract_value('timeout')
+      val = Utils.extract_value(probe_get, 'timeout')
       return default_probe_timeout if val.nil?
       val.to_i
     end
 
     def probe_timeout=(timeout)
-      attach_prefix(timeout, :timeout)
+      @set_args[:timeout] = Utils.attach_prefix(timeout, :timeout)
     end
 
     def default_probe_timeout

data/lib/cisco_node_utils/itd_service.rb

@@ -80,30 +80,6 @@ module Cisco
       @set_args = @get_args.merge!(hash) unless hash.empty?
     end
 
-    # extract value of property from load-balance
-    def extract_value(prop, prefix=nil)
-      prefix = prop if prefix.nil?
-      lb_match = lb_get
-
-      # matching lb not found
-      return nil if lb_match.nil? # no matching lb found
-
-      # property not defined for matching lb
-      return nil unless lb_match.names.include?(prop)
-
-      # extract and return value that follows prefix + <space>
-      regexp = Regexp.new("#{Regexp.escape(prefix)} (?<extracted>.*)")
-      value_match = regexp.match(lb_match[prop])
-      return nil if value_match.nil?
-      value_match[:extracted]
-    end
-
-    # prepend property name prefix/keyword to value
-    def attach_prefix(val, prop, prefix=nil)
-      prefix = prop.to_s if prefix.nil?
-      @set_args[prop] = val.to_s.empty? ? val : "#{prefix} #{val}"
-    end
-
     def access_list
       config_get('itd_service', 'access_list', @get_args)
     end
@@ -270,13 +246,13 @@ module Cisco
     end
 
     def load_bal_buckets
-      val = extract_value('buckets')
+      val = Utils.extract_value(lb_get, 'buckets')
       return default_load_bal_buckets if val.nil?
       val.to_i
     end
 
     def load_bal_buckets=(buckets)
-      attach_prefix(buckets, :buckets)
+      @set_args[:buckets] = Utils.attach_prefix(buckets, :buckets)
     end
 
     def default_load_bal_buckets
@@ -284,13 +260,13 @@ module Cisco
     end
 
     def load_bal_mask_pos
-      val = extract_value('mask', 'mask-position')
+      val = Utils.extract_value(lb_get, 'mask', 'mask-position')
       return default_load_bal_mask_pos if val.nil?
       val.to_i
     end
 
     def load_bal_mask_pos=(mask)
-      attach_prefix(mask, :mask, 'mask-position')
+      @set_args[:mask] = Utils.attach_prefix(mask, :mask, 'mask-position')
     end
 
     def default_load_bal_mask_pos
@@ -313,13 +289,14 @@ module Cisco
     end
 
     def load_bal_method_bundle_select
-      val = extract_value('bundle_select', 'method')
+      val = Utils.extract_value(lb_get, 'bundle_select', 'method')
       return default_load_bal_method_bundle_select if val.nil?
       val
     end
 
     def load_bal_method_bundle_select=(bs)
-      attach_prefix(bs, :bundle_select, 'method')
+      @set_args[:bundle_select] =
+          Utils.attach_prefix(bs, :bundle_select, 'method')
     end
 
     def default_load_bal_method_bundle_select
@@ -342,13 +319,13 @@ module Cisco
     end
 
     def load_bal_method_start_port
-      val = extract_value('start_port', 'range')
+      val = Utils.extract_value(lb_get, 'start_port', 'range')
       return default_load_bal_method_start_port if val.nil?
       val.to_i
     end
 
     def load_bal_method_start_port=(start)
-      attach_prefix(start, :start_port, 'range')
+      @set_args[:start_port] = Utils.attach_prefix(start, :start_port, 'range')
     end
 
     def default_load_bal_method_start_port

data/lib/cisco_node_utils/node.rb

@@ -4,7 +4,7 @@
 #
 # December 2014, Glenn F. Matthews
 #
-# Copyright (c) 2014-2016 Cisco and/or its affiliates.
+# Copyright (c) 2014-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.
@@ -107,18 +107,22 @@ module Cisco
       return value unless ref.hash['drill_down']
 
       row_key = ref.hash['get_value'][0][/^\S+/]
-      row_index = ref.hash['get_value'][0][/\S+$/]
+
+      # Escape special characters if any in row_index and add
+      # anchors for exact match.
+      row_index = Regexp.escape(ref.hash['get_value'][0][/\S+$/])
+      row_index = "^#{row_index}$"
+
       data_key = ref.hash['get_value'][1]
       regexp_filter = nil
       if ref.hash['get_value'][2]
         regexp_filter = Regexp.new ref.hash['get_value'][2][1..-2]
       end
-
       # Get the value using the row_key, row_index and data_key
       value = value.is_a?(Hash) ? [value] : value
       data = nil
       value.each do |row|
-        data = row[data_key] if row[row_key].to_s.include? row_index.to_s
+        data = row[data_key] if row[row_key].to_s[/#{row_index}/]
       end
       return value if data.nil?
       if regexp_filter
@@ -431,5 +435,9 @@ module Cisco
     def system
       config_get('show_version', 'system_image')
     end
+
+    def os_version_get(feature, property)
+      @cmd_ref.lookup(feature, property).os_version
+    end
   end
 end

data/lib/cisco_node_utils/ntp_auth_key.rb

@@ -0,0 +1,67 @@
+# NTP Authentication key provider class
+#
+# Rick Sherman et al., April 2017
+#
+# Copyright (c) 2014-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 'node'
+
+module Cisco
+  # NtpAuthKey - node utility class for NTP authentication-key management
+  class NtpAuthKey < NodeUtil
+    attr_reader :algorithm, :mode, :password
+
+    def initialize(opts, instantiate=true)
+      @algorithm = opts['algorithm'].nil? ? 'md5' : opts['algorithm']
+      @key = opts['name']
+      @mode = opts['mode'].nil? ? '7' : opts['mode']
+      @password = opts['password']
+
+      create if instantiate
+    end
+
+    def self.ntpkeys
+      keys = %w(name algorithm password mode)
+      hash = {}
+      ntp_auth_key_list = config_get('ntp_auth_key', 'key')
+      return hash if ntp_auth_key_list.empty?
+
+      ntp_auth_key_list.each do |id|
+        hash[id[0]] = NtpAuthKey.new(Hash[keys.zip(id)], false)
+      end
+
+      hash
+    end
+
+    def ==(other)
+      name == other.name
+    end
+
+    def create
+      config_set('ntp_auth_key', 'key', state: '', key: @key,
+                  algorithm: @algorithm, password: @password, mode: @mode)
+    end
+
+    def destroy
+      # There appears to be a bug in NXOS that requires the password be passed
+      config_set('ntp_auth_key', 'key', state: 'no', key: @key,
+                  algorithm: @algorithm, password: @password, mode: @mode)
+    end
+
+    def name
+      @key
+    end
+  end # class
+end # module

data/lib/cisco_node_utils/ntp_config.rb

@@ -2,7 +2,7 @@
 #
 # Jonathan Tripathy et al., September 2015
 #
-# Copyright (c) 2014-2016 Cisco and/or its affiliates.
+# Copyright (c) 2014-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.
@@ -41,6 +41,24 @@ module Cisco
       name == other.name
     end
 
+    def authenticate
+      config_get('ntp_config', 'authenticate')
+    end
+
+    def authenticate=(enable)
+      state = (enable ? '' : 'no')
+      config_set('ntp_config', 'authenticate', state: state)
+    end
+
+    def trusted_key
+      config_get('ntp_config', 'trusted_key')
+    end
+
+    def trusted_key_set(state, key)
+      state = (state ? '' : 'no')
+      config_set('ntp_config', 'trusted_key', state: state, key: key)
+    end
+
     def source_interface
       source_interface = config_get('ntp_config', 'source_interface')
       source_interface = source_interface.downcase \

data/lib/cisco_node_utils/ntp_server.rb

@@ -2,7 +2,7 @@
 #
 # Jonathan Tripathy et al., September 2015
 #
-# Copyright (c) 2014-2016 Cisco and/or its affiliates.
+# Copyright (c) 2014-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.
@@ -18,43 +18,43 @@
 
 require_relative 'node'
 require_relative 'interface'
+require 'resolv'
 
 module Cisco
   # NtpServer - node utility class for NTP Server configuration management
   class NtpServer < NodeUtil
-    def initialize(ntpserver_id, prefer, instantiate=true)
-      @ntpserver_id = ntpserver_id.to_s
-      @ntpserver_prefer = prefer
+    attr_reader :key, :maxpoll, :minpoll, :prefer, :vrf
 
-      unless @ntpserver_id =~ /^[a-zA-Z0-9\.\:]*$/
-        fail ArgumentError,
-             'Invalid value (IPv4/IPv6 address contains invalid characters)'
-      end
+    def initialize(opts, instantiate=true)
+      @ntpserver_id = opts['name']
+      @key = opts['key']
+      @minpoll = opts['minpoll']
+      @maxpoll = opts['maxpoll']
+      @prefer = opts['prefer'].nil? ? false : true
+      @vrf = opts['vrf'].nil? ? 'default' : opts['vrf']
 
-      begin
-        IPAddr.new(@ntpserver_id)
-      rescue
-        raise ArgumentError,
-              'Invalid value (Name is not a valid single IPv4/IPv6 address)'
-      end
+      hostname_regex = /^(?=.{1,255}$)[0-9A-Za-z]
+      (?:(?:[0-9A-Za-z]|-){0,61}[0-9A-Za-z])?
+      (?:\.[0-9A-Za-z](?:(?:[0-9A-Za-z]|-){0,61}[0-9A-Za-z])?)*\.?$/x
 
-      unless @ntpserver_prefer == true ||
-             @ntpserver_prefer == false ||
-             @ntpserver_prefer.nil?
-        fail ArgumentError, 'Invalid value(prefer must be true or false)'
+      unless @ntpserver_id =~ Resolv::AddressRegex ||
+             @ntpserver_id =~ hostname_regex
+        fail ArgumentError,
+             "Invalid value '#{@ntpserver_id}' \
+        (Must be valid IPv4/IPv6 address or hostname)"
       end
+
       create if instantiate
     end
 
     def self.ntpservers
+      keys = %w(name prefer vrf key minpoll maxpoll)
       hash = {}
       ntpservers_list = config_get('ntp_server', 'server')
       return hash if ntpservers_list.empty?
 
-      preferred_servers = config_get('ntp_server', 'prefer')
-
       ntpservers_list.each do |id|
-        hash[id] = NtpServer.new(id, preferred_servers.include?(id), false)
+        hash[id[0]] = NtpServer.new(Hash[keys.zip(id)], false)
       end
 
       hash
@@ -66,20 +66,21 @@ module Cisco
 
     def create
       config_set('ntp_server', 'server', state: '', ip: @ntpserver_id,
-                  prefer: @ntpserver_prefer ? 'prefer' : '')
+                  prefer: (['true', true].include? @prefer) ? 'prefer' : '',
+                  vrf: @vrf ? "use-vrf #{@vrf}" : '',
+                  key: @key ? "key #{@key}" : '',
+                  minpoll: @minpoll ? "minpoll #{@minpoll}" : '',
+                  maxpoll: @maxpoll ? "maxpoll #{@maxpoll}" : '')
     end
 
     def destroy
       config_set('ntp_server', 'server',
-                 state: 'no', ip: @ntpserver_id, prefer: '')
+                 state: 'no', ip: @ntpserver_id, prefer: '', vrf: '',
+                 key: '', minpoll: '', maxpoll: '')
     end
 
     def name
       @ntpserver_id
     end
-
-    def prefer
-      @ntpserver_prefer
-    end
   end # class
 end # module