cisco_node_utils 1.7.0 → 1.8.0

data/lib/cisco_node_utils/interface_ospf.rb

@@ -1,6 +1,6 @@
 # March 2015, Alex Hunsberger
 #
-# Copyright (c) 2015-2016 Cisco and/or its affiliates.
+# Copyright (c) 2015-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.
@@ -53,7 +53,7 @@ module Cisco
       fail TypeError unless ospf_name.is_a?(String) || ospf_name.nil?
       ints = {}
 
-      intf_list = config_get('interface', 'all_interfaces')
+      intf_list = config_get('interface_ospf', 'all_interfaces')
       return ints if intf_list.nil?
       intf_list.each do |name|
         match = config_get('interface_ospf', 'area', name)

data/lib/cisco_node_utils/interface_portchannel.rb

@@ -1,6 +1,6 @@
 # December 2015, Sai Chintalapudi
 #
-# Copyright (c) 2015-2016 Cisco and/or its affiliates.
+# Copyright (c) 2015-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.
@@ -38,7 +38,7 @@ module Cisco
 
     def self.interfaces
       hash = {}
-      intf_list = config_get('interface', 'all_interfaces')
+      intf_list = config_get('interface_portchannel', 'all_interfaces')
       return hash if intf_list.nil?
 
       intf_list.each do |id|

data/lib/cisco_node_utils/node.rb

@@ -372,6 +372,15 @@ module Cisco
             return prod.concat('-F') unless prod[/-F/]
           end
         end
+      when /N3K/
+        if @cmd_ref
+          ver = os_version
+        else
+          ver = get(command:     'show version',
+                    data_format: :nxapi_structured)['kickstart_ver_str']
+        end
+        # Append -F for fretta platform.
+        return prod.concat('-F') if ver[/7.0\(3\)F/] && !prod[/-F/]
       end
       prod
     end

data/lib/cisco_node_utils/ntp_auth_key.rb

@@ -16,7 +16,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require_relative 'node'
+require_relative 'node_util'
 
 module Cisco
   # NtpAuthKey - node utility class for NTP authentication-key management

data/lib/cisco_node_utils/object_group.rb

@@ -0,0 +1,75 @@
+#
+# May 2017, Sai Chintalapudi
+#
+# 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 'node_util'
+require_relative 'acl'
+
+module Cisco
+  # node_utils class for object_group
+  class ObjectGroup < NodeUtil
+    attr_reader :afi, :type, :grp_name
+
+    def initialize(afi, type, name, instantiate=true)
+      fail TypeError unless name.is_a?(String)
+      fail ArgumentError unless type[/address|port/]
+      @afi = Acl.afi_cli(afi)
+      @type = type
+      @grp_name = name
+
+      set_args_keys_default
+      create if instantiate
+    end
+
+    # Helper method to delete @set_args hash keys
+    def set_args_keys_default
+      @set_args = { afi: @afi, type: @type, grp_name: @grp_name }
+      @get_args = @set_args
+    end
+
+    # rubocop:disable Style/AccessorMethodName
+    def set_args_keys(hash={})
+      set_args_keys_default
+      @set_args = @get_args.merge!(hash) unless hash.empty?
+    end
+
+    def create
+      config_set('object_group', 'create', @set_args)
+    end
+
+    def destroy
+      config_set('object_group', 'destroy', @set_args)
+    end
+
+    def ==(other)
+      grp_name == other.grp_name && afi == other.afi && type == other.type
+    end
+
+    def self.object_groups
+      hash = {}
+      grps = config_get('object_group', 'all_object_groups')
+      return hash if grps.nil?
+      grps.each do |afi, type, name|
+        lafi = afi
+        lafi = 'ipv4' if afi == 'ip'
+        hash[lafi] ||= {}
+        hash[lafi][type] ||= {}
+        hash[lafi][type][name] = ObjectGroup.new(lafi, type, name, false)
+      end
+      hash
+    end
+  end # class
+end # module

data/lib/cisco_node_utils/object_group_entry.rb

@@ -0,0 +1,143 @@
+#
+# May 2017, Sai Chintalapudi
+#
+# 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 'node_util'
+require_relative 'acl'
+require_relative 'object_group'
+
+module Cisco
+  # node_utils class for object_group_entry
+  class ObjectGroupEntry < NodeUtil
+    attr_reader :afi, :type, :grp_name
+
+    def initialize(afi, type, name, seqno)
+      fail TypeError unless name.is_a?(String)
+      fail ArgumentError unless type[/address|port/]
+      @afi = Acl.afi_cli(afi)
+      @type = type
+      @grp_name = name
+      @seqno = seqno
+      og = ObjectGroup.object_groups[afi.to_s][type.to_s][name.to_s]
+      fail "ObjectGroup #{afi} #{type} #{name} does not exist" if
+        og.nil?
+      set_args_keys_default
+    end
+
+    # Helper method to delete @set_args hash keys
+    def set_args_keys_default
+      @set_args = { afi: @afi, type: @type, grp_name: @grp_name, seqno: @seqno }
+      @get_args = @set_args
+    end
+
+    # rubocop:disable Style/AccessorMethodName
+    def set_args_keys(hash={})
+      set_args_keys_default
+      @set_args = @get_args.merge!(hash) unless hash.empty?
+    end
+
+    def destroy
+      config_set('object_group', 'entry_destroy', @set_args)
+    end
+
+    def self.object_group_entries
+      hash = {}
+      grps = config_get('object_group', 'all_object_groups')
+      return hash if grps.nil?
+      grps.each do |afi, type, name|
+        lafi = afi
+        lafi = 'ipv4' if afi == 'ip'
+        hash[lafi] ||= {}
+        hash[lafi][type] ||= {}
+        hash[lafi][type][name] ||= {}
+        entries = config_get('object_group', 'all_entries',
+                             afi:      Acl.afi_cli(lafi),
+                             type:     type,
+                             grp_name: name)
+        next if entries.nil?
+        entries.each do |seqno|
+          hash[lafi][type][name][seqno] =
+            ObjectGroupEntry.new(lafi, type, name, seqno)
+        end
+      end
+      hash
+    end
+
+    def entry_get
+      str = config_get('object_group', 'entry', @get_args)
+      return nil if str.nil?
+      str = str.strip
+
+      # rubocop:disable Metrics/LineLength
+      regexp = Regexp.new('(?<seqno>\d+)'\
+                          ' *(?<address>host \S+|[:\.0-9a-fA-F]+ [:\.0-9a-fA-F]+|[:\.0-9a-fA-F]+\/\d+)?'\
+                          ' *(?<port>range \S+ \S+|(lt|eq|gt|neq) \S+)?')
+      # rubocop:enable Metrics/LineLength
+      regexp.match(str)
+    end
+
+    def entry_set(attrs)
+      if attrs.empty?
+        attrs[:state] = 'no'
+      else
+        destroy if seqno
+        attrs[:state] = ''
+      end
+      set_args_keys_default
+      set_args_keys(attrs)
+      [:address,
+       :port,
+      ].each do |p|
+        attrs[p] = '' if attrs[p].nil?
+        send(p.to_s + '=', attrs[p])
+      end
+      @get_args = @set_args
+      config_set('object_group', 'entry', @set_args)
+    end
+
+    # PROPERTIES
+    # ----------
+    def seqno
+      match = entry_get
+      return nil if match.nil?
+      match.names.include?('seqno') ? match[:seqno] : nil
+    end
+
+    def address
+      match = entry_get
+      return nil if match.nil?
+      addr = match[:address]
+      return nil if addr.nil?
+      # Normalize addr. Some platforms zero_pad ipv6 addrs.
+      addr.gsub!(/^0*/, '').gsub!(/:0*/, ':')
+      addr
+    end
+
+    def address=(address)
+      @set_args[:address] = address
+    end
+
+    def port
+      match = entry_get
+      return nil if match.nil?
+      match.names.include?('port') ? match[:port] : nil
+    end
+
+    def port=(port)
+      @set_args[:port] = port
+    end
+  end # class
+end # module

data/lib/cisco_node_utils/portchannel_global.rb

@@ -113,7 +113,7 @@ module Cisco
           _parse_ethernet_params(hash, params)
         when :asymmetric # n7k
           _parse_asymmetric_params(hash, params, line)
-        when :no_hash # n9k-f
+        when :no_hash # n9k-f or n3k-f
           _parse_no_hash_params(hash, params)
         when :symmetry # n9k
           _parse_symmetry_params(hash, params, line)
@@ -213,7 +213,7 @@ module Cisco
         # port-channel load-balance dst ip-l4port rotate 4 asymmetric
         config_set('portchannel_global', 'port_channel_load_balance',
                    bselect, bhash, 'rotate', rot.to_s, asym, '')
-      when :no_hash # n9k-f
+      when :no_hash # n9k-f or n3k-f
         # port-channel load-balance dst ip-l4port rotate 4
         rot_str = rot.zero? ? '' : 'rotate'
         rot_val = rot.zero? ? '' : rot.to_s

data/lib/cisco_node_utils/radius_global.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.
@@ -137,5 +137,29 @@ module Cisco
                    key:   "#{value}")
       end
     end
+
+    # Get default source interface
+    def default_source_interface
+      config_get_default('radius_global', 'source_interface')
+    end
+
+    # Set source interface
+    def source_interface=(name)
+      if name
+        config_set(
+          'radius_global', 'source_interface',
+          state: '', source_interface: name)
+      else
+        config_set(
+          'radius_global', 'source_interface',
+          state: 'no', source_interface: '')
+      end
+    end
+
+    # Get source interface
+    def source_interface
+      i = config_get('radius_global', 'source_interface')
+      i.nil? ? default_source_interface : i.downcase
+    end
   end # class
 end # module

data/lib/cisco_node_utils/router_ospf.rb

@@ -38,9 +38,9 @@ module Cisco
         hash[name] = RouterOspf.new(name, false)
       end
       return hash
-    rescue Cisco::CliError => e
-      # cmd will syntax reject when feature is not enabled
-      raise unless e.clierror =~ /Syntax error/
+    rescue Cisco::CliError
+      # cmd will error when feature 'ospf' is not enabled
+      raise if Feature.ospf_enabled?
       return {}
     end
 

data/lib/cisco_node_utils/syslog_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.
@@ -17,11 +17,12 @@
 # limitations under the License.
 
 require_relative 'node_util'
+require 'resolv'
 
 module Cisco
-  # NtpServer - node utility class for NTP Server configuration management
+  # SyslogServer - node utility class for syslog server configuration management
   class SyslogServer < NodeUtil
-    attr_reader :name, :level, :vrf
+    attr_reader :name, :level, :port, :vrf, :severity_level
 
     LEVEL_TO_NUM = { 'emergencies'   => 0,
                      'alerts'        => 1,
@@ -33,45 +34,38 @@ module Cisco
                      'debugging'     => 7 }.freeze
     NUM_TO_LEVEL = LEVEL_TO_NUM.invert.freeze
 
-    def initialize(name,
-                   level=nil,
-                   vrf=nil,
-                   instantiate=true)
-      fail TypeError unless name.is_a?(String)
-      fail TypeError unless name.length > 0
-      @name = name
-
-      fail TypeError unless level.is_a?(Integer) || level.nil?
-      @level = level
-
-      fail TypeError unless vrf.is_a?(String) || vrf.nil?
-      @vrf = vrf
+    def initialize(opts, instantiate=true)
+      @name = opts['name']
+      @level = opts['level'] || opts['severity_level']
+      @port = opts['port']
+      @vrf = opts['vrf']
+      @severity_level = opts['severity_level'] || opts['level']
+
+      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 @name =~ Resolv::AddressRegex ||
+             @name =~ hostname_regex
+        fail ArgumentError,
+             "Invalid value '#{@name}' \
+        (Must be valid IPv4/IPv6 address or hostname)"
+      end
 
       create if instantiate
     end
 
     def self.syslogservers
+      keys = %w(name level port vrf severity_level)
       hash = {}
       syslogservers_list = config_get('syslog_server', 'server')
       return hash if syslogservers_list.nil?
 
       syslogservers_list.each do |id|
-        # The YAML regex isn't specific enough for some platforms,
-        # so we have to do further checking.
-        begin
-          IPAddr.new(id)
-        rescue
-          next
-        end
-
-        level = config_get('syslog_server', 'level', id)
-        level = level[0] if level.is_a?(Array)
-        level = LEVEL_TO_NUM[level] if platform == :ios_xr
-
-        vrf = config_get('syslog_server', 'vrf', id)
-        vrf = vrf[0] if vrf.is_a?(Array)
-
-        hash[id] = SyslogServer.new(id, level, vrf, false)
+        value_hash = Hash[keys.zip(id)]
+        value_hash['severity_level'] = value_hash['level']
+        value_hash['vrf'] = 'default' if value_hash['vrf'].nil?
+        hash[id[0]] = SyslogServer.new(value_hash, false)
       end
 
       hash
@@ -92,17 +86,18 @@ module Cisco
         config_set('syslog_server',
                    'server',
                    state: '',
-                   ip:    "#{name}",
-                   level: level.nil? ? '' : "severity #{NUM_TO_LEVEL[level]}",
-                   vrf:   vrf.nil? ? '' : "vrf #{vrf}",
+                   ip:    @name,
+                   level: @level ? "severity #{NUM_TO_LEVEL[@level]}" : '',
+                   vrf:   @vrf ? "vrf #{@vrf}" : '',
                   )
       else
         config_set('syslog_server',
                    'server',
                    state: '',
-                   ip:    "#{name}",
-                   level: level.nil? ? '' : "#{level}",
-                   vrf:   vrf.nil? ? '' : "use-vrf #{vrf}",
+                   ip:    @name,
+                   level: @level ? "#{@level}" : '',
+                   port:  @port ? "port #{@port}" : '',
+                   vrf:   @vrf ? "use-vrf #{@vrf}" : '',
                   )
       end
     end
@@ -113,9 +108,9 @@ module Cisco
           config_set('syslog_server',
                      'server',
                      state: 'no',
-                     ip:    "#{name}",
+                     ip:    @name,
                      level: '',
-                     vrf:   vrf.nil? ? '' : "vrf #{vrf}",
+                     vrf:   @vrf ? "vrf #{@vrf}" : '',
                     )
         else
           warn("#{name} is configured multiple times on the device" \
@@ -125,7 +120,7 @@ module Cisco
             config_set('syslog_server',
                        'server',
                        state: 'no',
-                       ip:    "#{name}",
+                       ip:    @name,
                        level: '',
                        vrf:   "vrf #{dup}",
                       )
@@ -135,8 +130,9 @@ module Cisco
         config_set('syslog_server',
                    'server',
                    state: 'no',
-                   ip:    "#{name}",
+                   ip:    @name,
                    level: '',
+                   port:  '',
                    vrf:   '',
                   )
       end