cisco_node_utils 1.9.0 → 1.10.0

data/lib/cisco_node_utils/cmd_ref/banner.yaml

@@ -0,0 +1,7 @@
+# banner
+---
+motd:
+  default_value: "User Access Verification\n"
+  get_command: 'show banner motd'
+  get_value: '/^.*$/m'
+  set_value: '<state> banner motd <motd>'

data/lib/cisco_node_utils/cmd_ref/fabricpath.yaml

@@ -82,7 +82,7 @@ loadbalance_multicast_has_vlan:
   _exclude: [N5k, N6k]
   kind: boolean
   auto_default: false
-  get_command: "show fabricpath load-balance | begin Ftag"
+  get_command: "show fabricpath load-balance | begin ignore-case Ftag"
   get_value: '/^Use VLAN: TRUE/'
   default_value: true
 
@@ -93,7 +93,7 @@ loadbalance_multicast_reset:
 loadbalance_multicast_rotate:
   _exclude: [N5k, N6k]
   kind: int
-  get_command: "show fabricpath load-balance | begin Ftag"
+  get_command: "show fabricpath load-balance | begin ignore-case Ftag"
   get_value: '/^Rotate amount: (\d+)/'
   # default_value: n/a. The default rotate amount is randomized to avoid polarization.
 

data/lib/cisco_node_utils/cmd_ref/hostname.yaml

@@ -0,0 +1,8 @@
+# hostname
+---
+
+name:
+  get_command: "show running-config all | include 'hostname '"
+  get_value: '/^hostname (\S+)$/'
+  set_value: "<state> hostname <name>"
+  default_value: ""

data/lib/cisco_node_utils/cmd_ref/interface.yaml

@@ -127,7 +127,7 @@ hsrp_mac_refresh:
   kind: int
   get_value: '/^hsrp mac-refresh (\d+)$/'
   set_value: '<state> hsrp mac-refresh <timeout>'
-  default_value: false
+  default_value: ~
 
 hsrp_use_bia:
   _exclude: [ios_xr, N5k, N6k]
@@ -137,7 +137,7 @@ hsrp_use_bia:
   # optional match to get the whole config
   get_value: '/^hsrp use-bia(?:\s+\S+\s+\S+)?$/'
   set_value: '<state> hsrp use-bia<scope>'
-  default_value: false
+  default_value: ~
 
 hsrp_version:
   _exclude: [ios_xr, N5k, N6k]
@@ -211,7 +211,7 @@ ipv4_dhcp_relay_src_intf:
   _exclude: [ios_xr]
   get_value: '/^ip dhcp relay source-interface (.*)$/'
   set_value: "<state> ip dhcp relay source-interface <intf>"
-  default_value: false
+  default_value: ~
 
 ipv4_dhcp_relay_subnet_broadcast:
   _exclude: [ios_xr]
@@ -258,7 +258,7 @@ ipv4_proxy_arp:
 ipv4_redirects_loopback:
   kind: boolean
   nexus:
-    default_only: false
+    default_only: ~
   ios_xr:
     get_value: '/^((?:no )?ipv4 redirects)$/'
     set_value: "<state> ipv4 redirects"
@@ -304,7 +304,14 @@ ipv6_dhcp_relay_src_intf:
   _exclude: [ios_xr]
   get_value: '/^ipv6 dhcp relay source-interface (.*)$/'
   set_value: "<state> ipv6 dhcp relay source-interface <intf>"
-  default_value: false
+  default_value: ~
+
+ipv6_redirects:
+  _exclude: [ios_xr]
+  kind: boolean
+  get_value: '/^((?:no )?ipv6 redirects)$/'
+  set_value: "<state> ipv6 redirects"
+  default_value: true
 
 load_interval_counter_1_delay:
   _exclude: [ios_xr]
@@ -329,7 +336,7 @@ load_interval_counter_3_delay:
   kind: int
   get_value: '/^load-interval counter 3 (\d+)$/'
   set_value: "<state> load-interval counter 3 <delay>"
-  default_value: false
+  default_value: ~
 
 mtu_loopback:
   kind: boolean
@@ -377,6 +384,7 @@ purge_config:
   set_value:   "default interface <name>"
   get_command: "show running interface"
   get_value:   '/(.*)/'
+  default_value: ~
 
 pvlan_any:
   multiple:
@@ -462,13 +470,13 @@ stp_bpdufilter:
   kind: string
   get_value: '/^spanning-tree bpdufilter (.*)$/'
   set_value: "<state> spanning-tree bpdufilter <filter>"
-  default_value: false
+  default_value: ~
 
 stp_bpduguard:
   kind: string
   get_value: '/^spanning-tree bpduguard (.*)$/'
   set_value: "<state> spanning-tree bpduguard <guard>"
-  default_value: false
+  default_value: ~
 
 stp_cost:
   kind: string
@@ -480,7 +488,7 @@ stp_guard:
   kind: string
   get_value: '/^spanning-tree guard (.*)$/'
   set_value: "<state> spanning-tree guard <guard>"
-  default_value: false
+  default_value: ~
 
 stp_link_type:
   kind: string
@@ -517,7 +525,7 @@ stp_port_type:
   get_command: "show running interface"
   get_value: '/^spanning-tree port type (.*)$/'
   set_value: "<state> spanning-tree port type <type>"
-  default_value: false
+  default_value: ~
 
 stp_vlan_cost:
   multiple:
@@ -625,7 +633,7 @@ switchport_pvlan_trunk_allowed_vlan:
   multiple: true
   get_value: '/^switchport private-vlan trunk allowed vlan (?:add )?(\S+)$/'
   set_value: "switchport private-vlan trunk allowed vlan <range>"
-  default_value: 'none'
+  default_value: none
 
 switchport_pvlan_trunk_association:
   _exclude: [ios_xr, N3k, N3k-F, N9k-F]
@@ -728,7 +736,7 @@ vpc_id:
   kind: int
   get_value: '/^vpc (\d+)$/'
   set_value: '<state> vpc <id>'
-  default_value: false
+  default_value: ~
 
 vpc_peer_link:
   kind: boolean

data/lib/cisco_node_utils/cmd_ref/interface_hsrp_group.yaml

@@ -23,14 +23,14 @@ authentication_enc_type:
   default_value: '0'
 
 authentication_key_type:
-  default_value: 'key-chain'
+  default_value: ~
 
 authentication_string:
-  default_value: ''
+  default_value: ~
 
 authentication_timeout:
   kind: int
-  default_value: 0
+  default_value: ~
 
 group_name:
   get_value: '/^name (\S+)/'

data/lib/cisco_node_utils/cmd_ref/ip_multicast.yaml

@@ -7,12 +7,16 @@ _template:
 
 overlay_distributed_dr:
   context: ~
+  kind: boolean
   get_value: '^ip multicast overlay-distributed-dr$'
   set_value: "<state> ip multicast overlay-distributed-dr"
   default_value: false
 
 overlay_spt_only:
   context: ~
-  get_value: '^ip multicast overlay-spt-only$'
+  kind: boolean
+  auto_default: false
+  get_command: "show fabric multicast globals"
+  get_value: '^Overlay spt-only:\s+TRUE$'
   set_value: "<state> ip multicast overlay-spt-only"
-  default_value: false
+  default_value: true

data/lib/cisco_node_utils/cmd_ref/snmp_server.yaml

@@ -62,7 +62,10 @@ packet_size:
     # the n3|9k behavior when the issue is resolved.
     default_value: 0
   N6k: *n5k_default_packet_size
-  N7k: *n5k_default_packet_size
+  # On recent versions, packet size is fixed,
+  # so this change will take care of the fix but
+  # it could still fail in the older versions.
+  N7k: *n3k_default_packet_size
   # On recent versions, packet size is fixed,
   # so this change will take care of the fix but
   # it could still fail in the older versions.

data/lib/cisco_node_utils/cmd_ref/syslog_facility.yaml

@@ -0,0 +1,10 @@
+# syslog_facility
+---
+_exclude: [ios_xr]
+
+facility:
+  multiple: true
+  get_command: "show running-config | include '^logging level'"
+  # Returns <facility>, <level>
+  get_value: '/^(?:logging level)\s+(.*)\s+([0-7])/'
+  set_value: '<state> logging level <facility> <level>'

data/lib/cisco_node_utils/cmd_ref/syslog_server.yaml

@@ -15,9 +15,9 @@ server:
   multiple: true
   nexus:
     get_command: "show running-config all | include '^logging server'"
-    # Returns <ip>, <level>, <port>, <vrf>
-    get_value: '/^(?:logging server )([^\s]+)(?: (\d+))?(?: port (\d+))?(?: use-vrf (\S+))?/'
-    set_value: '<state> logging server <ip> <level> <port> <vrf>'
+    # Returns <ip>, <level>, <port>, <vrf>, <facility>
+    get_value: '/^(?:logging server )([^\s]+)(?: (\d+))?(?: port (\d+))?(?: use-vrf (\S+))?(?: facility (\S+))?/'
+    set_value: '<state> logging server <ip> <level> <port> <vrf> <facility>'
   ios_xr:
     get_command: "show running-config logging"
     get_value: '/^logging (\S+).*/'

data/lib/cisco_node_utils/cmd_ref/syslog_settings.yaml

@@ -9,6 +9,22 @@ console:
   get_value: '/^(no)?\s*logging console\s*(\d)?/'
   set_value: '<state> logging console <severity>'
 
+logfile_name:
+  get_command: "show running-config all | include 'logging'"
+  # Returns <state> and <name>
+  get_value: '/^(no)?\s*logging logfile\s(\S*)\s*?/'
+  set_value: '<state> logging logfile <logname> <severity> <size>'
+
+logfile_severity_level:
+  get_command: "show running-config all | include 'logging'"
+  # Returns <state> and <severity>
+  get_value: '/^(no)?\s*logging logfile\s\S*\s*(\d)?/'
+
+logfile_size:
+  get_command: "show running-config all | include 'logging'"
+  # Returns <state> and <size>
+  get_value: '/^(no)?\s*logging logfile.*size\s(\d*)/'
+
 monitor:
   default_value: 5
   get_command: "show running-config all | include 'logging'"

data/lib/cisco_node_utils/cmd_ref/tacacs_server_host.yaml

@@ -48,7 +48,7 @@ hosts:
 port:
   default_value: 49
   kind: int
-  get_value: '/^tacacs-server host <ip>.* port (\d+).*$/'
+  get_value: '/^tacacs-server host <ip>\s.*port (\d+).*$/'
   nexus:
     set_value: "tacacs-server host <ip> port <port>"
 
@@ -56,7 +56,7 @@ timeout:
   default_value: 0
   kind: int
   nexus:
-    get_value: '/^tacacs-server host <ip> .*timeout (\d+)/'
+    get_value: '/^tacacs-server host <ip>\s.*timeout (\d+)/'
     set_value: "<state> tacacs-server host <ip> timeout <timeout>"
   ios_xr:
     context: ["tacacs-server host <ip> port <port>"]

data/lib/cisco_node_utils/environment.rb

@@ -1,6 +1,7 @@
+# August 2018
 # March 2016, Glenn F. Matthews
 #
-# 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.
@@ -90,6 +91,12 @@ module Cisco
       {}
     end
 
+    def self.add_env(env_name, env_hash)
+      fail ArgumentError, 'empty environment name' if env_name.empty?
+      fail TypeError, 'invalid environment hash' unless env_hash.is_a?(Hash)
+      @environments[env_name] = env_hash
+    end
+
     def self.strings_to_symbols(hash)
       Hash[hash.map { |k, v| [k.to_sym, v] }]
     end

data/lib/cisco_node_utils/hostname.rb

@@ -0,0 +1,62 @@
+# Hostname provider class
+#
+# September 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
+  # Hostname- node utility class for hostname configuration
+  class HostName < NodeUtil
+    attr_reader :name
+
+    def initialize(name, instantiate=true)
+      @name = name
+      create if instantiate
+    end
+
+    def self.hostname
+      hash = {}
+      hostname = config_get('hostname', 'name')
+      hash[hostname] = HostName.new(hostname, false)
+      hash
+    end
+
+    def hostname=(host)
+      if host
+        config_set(
+          'hostname', 'name',
+          state: '', name: host)
+      else
+        config_set(
+          'hostname', 'name',
+          state: 'no', name: '')
+      end
+    end
+
+    def ==(other)
+      name == other.name
+    end
+
+    def create
+      config_set('hostname', 'name', state: '', name: @name)
+    end
+
+    def destroy
+      config_set('hostname', 'name', state: 'no', name: @name)
+    end
+  end # class
+end # module

data/lib/cisco_node_utils/interface.rb

@@ -1,6 +1,6 @@
 # November 2015, Chris Van Heuveln
 #
-# Copyright (c) 2015-2017 Cisco and/or its affiliates.
+# Copyright (c) 2015-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.
@@ -192,6 +192,7 @@ module Cisco
     # are left untouched.
 
     def access_vlan
+      return nil if switchport_mode == :disabled
       config_get('interface', 'access_vlan', name: @name)
     end
 
@@ -275,6 +276,7 @@ module Cisco
     end
 
     def fabric_forwarding_anycast_gateway=(state)
+      return if fabric_forwarding_anycast_gateway == state
       no_cmd = (state ? '' : 'no')
       config_set('interface',
                  'fabric_forwarding_anycast_gateway',
@@ -325,6 +327,7 @@ module Cisco
     end
 
     def hsrp_delay_minimum
+      return nil if switchport_mode != :disabled || @name[/loop/i]
       minimum, _reload = hsrp_delay
       minimum.nil? ? default_hsrp_delay_minimum : minimum
     end
@@ -342,6 +345,7 @@ module Cisco
     end
 
     def hsrp_delay_reload
+      return nil if switchport_mode != :disabled || @name[/loop/i]
       _minimum, reload = hsrp_delay
       reload.nil? ? default_hsrp_delay_reload : reload
     end
@@ -413,6 +417,7 @@ module Cisco
     end
 
     def hsrp_version
+      return nil if switchport_mode != :disabled || @name[/loop/i]
       config_get('interface', 'hsrp_version', name: @name)
     end
 
@@ -604,6 +609,7 @@ module Cisco
     end
 
     def ipv4_dhcp_relay_info_trust
+      return nil if @name[/loop/i] || switchport_mode != :disabled
       config_get('interface', 'ipv4_dhcp_relay_info_trust', name: @name)
     end
 
@@ -654,6 +660,7 @@ module Cisco
     end
 
     def ipv4_dhcp_relay_subnet_broadcast
+      return nil if @name[/loop/i] || switchport_mode != :disabled
       config_get('interface', 'ipv4_dhcp_relay_subnet_broadcast', name: @name)
     end
 
@@ -669,6 +676,7 @@ module Cisco
     end
 
     def ipv4_dhcp_smart_relay
+      return nil if @name[/loop/i] || switchport_mode != :disabled
       config_get('interface', 'ipv4_dhcp_smart_relay', name: @name)
     end
 
@@ -698,6 +706,7 @@ module Cisco
     end
 
     def ipv4_pim_sparse_mode
+      return nil unless switchport_mode == :disabled
       config_get('interface', 'ipv4_pim_sparse_mode', name: @name)
     end
 
@@ -713,6 +722,7 @@ module Cisco
     end
 
     def ipv4_proxy_arp
+      return nil if @name[/loop/i] || switchport_mode != :disabled
       config_get('interface', 'ipv4_proxy_arp', name: @name)
     end
 
@@ -736,6 +746,7 @@ module Cisco
     end
 
     def ipv4_redirects
+      return nil unless switchport_mode == :disabled
       config_get('interface', ipv4_redirects_lookup_string, name: @name)
     end
 
@@ -834,6 +845,22 @@ module Cisco
       config_get_default('interface', 'ipv6_dhcp_relay_src_intf')
     end
 
+    def ipv6_redirects
+      return nil if @name[/loop/i] || switchport_mode != :disabled
+      config_get('interface', 'ipv6_redirects', name: @name)
+    end
+
+    def ipv6_redirects=(redirects)
+      check_switchport(:disabled)
+      no_cmd = (redirects ? '' : 'no')
+      config_set('interface', 'ipv6_redirects',
+                 name: @name, state: no_cmd)
+    end
+
+    def default_ipv6_redirects
+      config_get_default('interface', 'ipv6_redirects')
+    end
+
     def feature_lacp?
       config_get('interface', 'feature_lacp')
     end
@@ -913,6 +940,7 @@ module Cisco
     end
 
     def mtu=(val)
+      return if mtu == val
       check_switchport(:disabled)
       config_set('interface', mtu_lookup_string,
                  name: @name, state: '', mtu: val)
@@ -923,6 +951,7 @@ module Cisco
     end
 
     def speed
+      return nil if @name[/loop|vlan/i]
       config_get('interface', 'speed', name: @name)
     end
 
@@ -935,6 +964,7 @@ module Cisco
     end
 
     def duplex
+      return nil if @name[/loop|vlan/i]
       config_get('interface', 'duplex', name: @name)
     end
 
@@ -958,6 +988,7 @@ module Cisco
     end
 
     def negotiate_auto
+      return nil if @name[/loop|vlan/]
       config_get('interface', negotiate_auto_lookup_string, name: @name)
     end
 
@@ -1032,10 +1063,12 @@ module Cisco
     end
 
     def storm_control_broadcast
+      return nil if @name[/loop|vlan/i]
       config_get('interface', 'storm_control_broadcast', name: @name)
     end
 
     def storm_control_broadcast=(val)
+      return if val == storm_control_broadcast
       state = val == default_storm_control_broadcast ? 'no' : ''
       level = val == default_storm_control_broadcast ? '' : val
       config_set('interface', 'storm_control_broadcast',
@@ -1047,10 +1080,12 @@ module Cisco
     end
 
     def storm_control_multicast
+      return nil if @name[/loop|vlan/i]
       config_get('interface', 'storm_control_multicast', name: @name)
     end
 
     def storm_control_multicast=(val)
+      return if val == storm_control_broadcast
       state = val == default_storm_control_multicast ? 'no' : ''
       level = val == default_storm_control_multicast ? '' : val
       config_set('interface', 'storm_control_multicast',
@@ -1062,10 +1097,12 @@ module Cisco
     end
 
     def storm_control_unicast
+      return nil if @name[/loop|vlan/i]
       config_get('interface', 'storm_control_unicast', name: @name)
     end
 
     def storm_control_unicast=(val)
+      return if val == storm_control_broadcast
       state = val == default_storm_control_unicast ? 'no' : ''
       level = val == default_storm_control_unicast ? '' : val
       config_set('interface', 'storm_control_unicast',
@@ -1116,6 +1153,7 @@ module Cisco
     end
 
     def stp_cost
+      return nil if switchport_mode == :disabled
       cost = config_get('interface', 'stp_cost', name: @name)
       cost == 'auto' ? cost : cost.to_i
     end
@@ -1150,6 +1188,7 @@ module Cisco
     end
 
     def stp_link_type
+      return nil if switchport_mode == :disabled
       config_get('interface', 'stp_link_type', name: @name)
     end
 
@@ -1163,6 +1202,7 @@ module Cisco
     end
 
     def stp_port_priority
+      return nil if switchport_mode == :disabled
       config_get('interface', 'stp_port_priority', name: @name)
     end
 
@@ -1294,6 +1334,7 @@ module Cisco
 
     # switchport_autostate_exclude is exclusive to switchport interfaces
     def switchport_autostate_exclude
+      return nil if switchport_mode == :disabled
       config_get('interface',
                  'switchport_autostate_exclude', name: @name)
     end
@@ -1384,6 +1425,7 @@ module Cisco
     end
 
     def switchport_trunk_allowed_vlan
+      return nil if switchport_mode == :disabled
       vlans = config_get('interface', 'switchport_trunk_allowed_vlan',
                          name: @name)
       vlans = vlans.join(',') if vlans.is_a?(Array)
@@ -1406,6 +1448,7 @@ module Cisco
     end
 
     def switchport_trunk_native_vlan
+      return nil if switchport_mode == :disabled
       config_get('interface', 'switchport_trunk_native_vlan', name: @name)
     end
 
@@ -1442,6 +1485,7 @@ module Cisco
     # --------------------------
     # <state> switchport mode private-vlan host
     def switchport_pvlan_host
+      return nil if switchport_mode == :disabled
       config_get('interface', 'switchport_pvlan_host', name: @name)
     end
 
@@ -1458,6 +1502,7 @@ module Cisco
     # --------------------------
     # <state> switchport mode private-vlan promiscuous
     def switchport_pvlan_promiscuous
+      return nil if switchport_mode == :disabled
       config_get('interface', 'switchport_pvlan_promiscuous', name: @name)
     end
 
@@ -1650,6 +1695,7 @@ module Cisco
     # --------------------------
     # <state> switchport mode private-vlan trunk promiscuous
     def switchport_pvlan_trunk_promiscuous
+      return nil if switchport_mode == :disabled
       config_get('interface', 'switchport_pvlan_trunk_promiscuous', name: @name)
     end
 
@@ -1666,6 +1712,7 @@ module Cisco
     # --------------------------
     # <state> switchport mode private-vlan trunk secondary
     def switchport_pvlan_trunk_secondary
+      return nil if switchport_mode == :disabled
       config_get('interface', 'switchport_pvlan_trunk_secondary', name: @name)
     end
 
@@ -1684,6 +1731,7 @@ module Cisco
     # Note that range is handled as a string because the entire range is
     # replaced instead of individually adding or removing vlans from the range.
     def switchport_pvlan_trunk_allowed_vlan
+      return nil if switchport_mode == :disabled
       vlans = config_get('interface', 'switchport_pvlan_trunk_allowed_vlan',
                          name: @name)
       vlans = vlans.join(',') if vlans.is_a?(Array)
@@ -1708,6 +1756,7 @@ module Cisco
     # --------------------------
     # <state> switchport trunk native vlan <vlan>
     def switchport_pvlan_trunk_native_vlan
+      return nil if switchport_mode == :disabled
       config_get('interface', 'switchport_pvlan_trunk_native_vlan', name: @name)
     end
 
@@ -1971,10 +2020,12 @@ module Cisco
     end
 
     def vpc_peer_link
+      return nil unless @name[/port-channel/i] && switchport_mode != :disabled
       config_get('interface', 'vpc_peer_link', name: @name)
     end
 
     def vpc_peer_link=(state)
+      return if vpc_peerlink == state
       no_cmd = (state ? '' : 'no')
       config_set('interface', 'vpc_peer_link', name: @name, state: no_cmd)
     end
@@ -2037,8 +2088,14 @@ module Cisco
     end
 
     def purge_config
+      # This getter is only supported on ethernet interfaces
+      return nil unless @name[/ethernet/]
       state = config_get('interface', 'purge_config', name: @name)
-      state.nil? ? true : false
+      state.nil? ? true : default_purge_config
+    end
+
+    def default_purge_config
+      config_get_default('interface', 'purge_config')
     end
   end  # Class
 end    # Module