cisco_node_utils 1.3.0 → 1.4.0

data/lib/cisco_node_utils/cmd_ref/snmp_server.yaml

@@ -1,23 +1,29 @@
 # snmp_server
 ---
-_exclude: [ios_xr]
 
 aaa_user_cache_timeout:
-  nexus:
-    kind: int
-    get_command: "show snmp internal globals"
-    get_value: '/AAA Cache Timeout :(\d+)/'
-    set_value: "%s snmp-server aaa-user cache-timeout %d"
-    default_value: 3600
+  _exclude: [ios_xr]
+  kind: int
+  get_command: "show snmp internal globals"
+  get_value: '/AAA Cache Timeout :(\d+)/'
+  set_value: "%s snmp-server aaa-user cache-timeout %d"
+  default_value: 3600
 
 contact:
-  get_data_format: nxapi_structured
-  get_command: "show snmp"
-  get_value: "sys_contact"
-  set_value: "%s snmp-server contact %s"
-  default_value: ""
+  nexus:
+    get_data_format: nxapi_structured
+    get_command: "show snmp"
+    get_value: "sys_contact"
+    set_value: "<state> snmp-server contact <contact>"
+    default_value: ""
+  ios_xr:
+    get_command: 'show running-config snmp'
+    get_value: '/^snmp-server contact (\S+)$/'
+    set_value: "<state> snmp-server contact <contact>"
+    default_value: ""
 
 global_enforce_priv:
+  _exclude: [ios_xr]
   kind: boolean
   get_command: "show run snmp all"
   get_value: '/^(?:no )?snmp-server globalEnforcePriv/'
@@ -25,28 +31,51 @@ global_enforce_priv:
   default_value: false
 
 location:
-  get_data_format: nxapi_structured
-  get_command: "show snmp"
-  get_value: "sys_location"
-  set_value: "%s snmp-server location %s"
-  default_value: ""
+  nexus:
+    get_data_format: nxapi_structured
+    get_command: "show snmp"
+    get_value: "sys_location"
+    set_value: "<state> snmp-server location <location>"
+    default_value: ""
+  ios_xr:
+    get_command: 'show running-config snmp'
+    get_value: '/^snmp-server location (\S+)$/'
+    set_value: "<state> snmp-server location <location>"
+    default_value: ""
 
 packet_size:
+  _exclude: [ios_xr]
   kind: int
   get_command: "show snmp internal globals"
   get_value: '/SNMP Max packet size :(\d+)/'
   set_value: "%s snmp-server packetsize %d"
-  default_value: 1500
+  N3k: &n3k_default_packet_size
+    # Prior to the 7.0(3)I4(1) release, the default packet size
+    # was incorrectly displayed as 0.  CSCuz14217 fixed this to
+    # corectly display 1500.
+    default_value: 1500
+  N9k: *n3k_default_packet_size
+  N5k: &n5k_default_packet_size
+    # N5|6|7k platforms still incorrectly display the packet
+    # size as 0. This value is therefore still used as the
+    # default. This yaml entry will be changed to match
+    # the n3|9k behavior when the issue is resolved.
+    default_value: 0
+  N6k: *n5k_default_packet_size
+  N7k: *n5k_default_packet_size
+  N8k: *n5k_default_packet_size
 
 protocol:
+  _exclude: [ios_xr]
   kind: boolean
   auto_default: false
-  get_command: "show running-config snmp all"
+  get_command: 'show running-config snmp all'
   get_value: '/^snmp.server protocol enable/'
   set_value: "%s snmp-server protocol enable"
   default_value: true
 
 tcp_session_auth:
+  _exclude: [ios_xr]
   kind: boolean
   auto_default: false
   get_command: "show running-config snmp all"

data/lib/cisco_node_utils/cmd_ref/tacacs_global.yaml

@@ -0,0 +1,30 @@
+# tacacs_global.yaml
+---
+encryption:
+  set_value: "<state> tacacs-server key <option> <key>"
+
+key:
+  get_value: '/^tacacs-server key (\d+)\s+(\S+)/'
+  default_value: ""
+  nexus:
+    get_command: "show run tacacs all"
+  ios_xr:
+    get_command: "show running-config tacacs-server"
+
+key_format:
+  get_value: '/^tacacs-server key (\d+)\s+(\S+)/'
+  default_value: 0
+  nexus:
+    get_command: "show run tacacs all"
+  ios_xr:
+    get_command: "show running-config tacacs-server"
+
+timeout:
+  kind: int
+  get_value: '/tacacs-server timeout\s+(\d+)/'
+  set_value: "<state> tacacs-server timeout <timeout>"
+  default_value: 5
+  nexus:
+    get_command: "show run tacacs all"
+  ios_xr:
+    get_command: "show running-config tacacs-server"

data/lib/cisco_node_utils/cmd_ref/tacacs_server.yaml

@@ -1,8 +1,8 @@
 # tacacs_server
 ---
-_exclude: [ios_xr]
 
 deadtime:
+  _exclude: [ios_xr]
   kind: int
   get_command: "show run tacacs all"
   get_value: '/^tacacs-server deadtime\s+(\d+)/'
@@ -10,6 +10,7 @@ deadtime:
   default_value: 0
 
 directed_request:
+  _exclude: [ios_xr]
   kind: boolean
   # oddly, directed request must be retrieved from aaa output
   get_command: "show running aaa all"
@@ -18,26 +19,34 @@ directed_request:
   default_value: false
 
 encryption:
-  set_value: "%s tacacs-server key %d %s"
+  set_value: "<state> tacacs-server key <option> <key>"
 
 encryption_password:
-  get_command: "show run tacacs all"
   get_value: '/^tacacs-server key (\d+)\s+(\S+)/'
   default_value: ""
+  nexus:
+    get_command: "show run tacacs all"
+  ios_xr:
+    get_command: "show running-config tacacs-server"
 
 encryption_type:
   auto_default: false
-  get_command: "show run tacacs all"
   get_value: '/^tacacs-server key (\d+)\s+(\S+)/'
   default_value: 0
+  nexus:
+    get_command: "show run tacacs all"
+  ios_xr:
+    get_command: "show running-config tacacs-server"
 
 feature:
+  _exclude: [ios_xr]
   kind: boolean
   get_command: "show run tacacs all"
   get_value: '/^feature tacacs/'
   set_value: "%s feature tacacs+"
 
 source_interface:
+  _exclude: [ios_xr]
   get_command: "show run tacacs all"
   get_value: '/(no)?\s*ip tacacs source-interface\s+(\S+)?/'
   set_value: "%s ip tacacs source-interface %s"
@@ -45,7 +54,10 @@ source_interface:
 
 timeout:
   kind: int
-  get_command: "show run tacacs all"
   get_value: '/tacacs-server timeout\s+(\d+)/'
-  set_value: "%s tacacs-server timeout %d"
+  set_value: "<state> tacacs-server timeout <timeout>"
   default_value: 5
+  nexus:
+    get_command: "show run tacacs all"
+  ios_xr:
+    get_command: "show running-config tacacs-server"

data/lib/cisco_node_utils/cmd_ref/vdc.yaml

@@ -16,6 +16,10 @@ all_vdcs:
   get_context: ~
   get_value: '/^vdc (\S+) id/'
 
+allocate_interface:
+  get_value: '/^allocate interface (.*)/'
+  default_value: ~
+
 allocate_interface_unallocated:
   kind: boolean
   set_value: 'allocate interface unallocated-interfaces'

data/lib/cisco_node_utils/cmd_ref/virtual_service.yaml

@@ -3,5 +3,6 @@
 services:
   _exclude: [ios_xr]
   multiple: true
+  get_data_format: nxapi_structured
   get_command: 'show virtual-service detail'
   get_context: ["TABLE_detail", "ROW_detail"]

data/lib/cisco_node_utils/cmd_ref/vlan.yaml

@@ -24,15 +24,28 @@ fabric_control:
   default_value: false
 
 mapped_vni:
-  N3k: &mapped_vni_n3k_n9k
-    kind: int
+  _exclude: [N7k]
+  N3k: &mapped_vni_n3_8_9k
     get_command: 'show running vlan'
-    get_context: ['/^vlan <vlan>$/']
-    get_value: '/^vn-segment (\d+)$/'
-    set_context: ['vlan <vlan>']
-    set_value:  '<state> vn-segment <vni> ; end'
-    default_value: ''
-  N9k: *mapped_vni_n3k_n9k
+  N8k: *mapped_vni_n3_8_9k
+  N9k: *mapped_vni_n3_8_9k
+  N5k: &mapped_vni_n5_6k
+    get_command: 'show running vlan 1-4094'
+  N6k: *mapped_vni_n5_6k
+  kind: int
+  get_context: ['/^vlan <vlan>$/']
+  get_value: '/^vn-segment (\d+)$/'
+  set_context: ['vlan <vlan>']
+  set_value:  '<state> vn-segment <vni> ; end'
+  default_value: ''
+
+mapped_vni_requires_nv_overlay:
+  kind: boolean
+  N5k: &requires_nv_overlay_true
+    default_only: true
+  N6k: *requires_nv_overlay_true
+  else:
+    default_only: false
 
 mode:
   _exclude: [N3k, N9k]
@@ -51,7 +64,7 @@ name:
   set_context: ["vlan %d"]
   set_value: "%s name %s ; end"
 
-private_vlan_association:
+pvlan_association:
   _exclude: [N8k]
   multiple: true
   get_command: "show vlan private-vlan"
@@ -60,7 +73,7 @@ private_vlan_association:
   set_value: "<state> private-vlan association <vlans> ; end"
   default_value: []
 
-private_vlan_type:
+pvlan_type:
   _exclude: [N8k]
   kind: string
   get_command: 'show vlan private-vlan type'

data/lib/cisco_node_utils/cmd_ref/vxlan_vtep.yaml

@@ -50,11 +50,17 @@ source_intf:
   default_value: ''
 
 source_intf_hold_down_time:
-  _exclude: [N5k, N6k, N7k, N8k]
+  _exclude: [N5k, N6k, N7k]
   kind: int
   get_value: '/^source-interface hold-down-time (\d+)$/'
   set_value: '<state> source-interface hold-down-time <time>'
-  default_value: ''
+  # This property is dependent on 'source-intf' and will not nvgen unless that
+  # command is also present. In I4 and older images the default_value was ''
+  # because the command did not nvgen with 'sh run int nve1 all'; in I4+ images
+  # this was changed and now the command appears (with 'show run all') with
+  # a value of 180. This is the correct behavior but it means that I4 and older
+  # images may experience an idempotence problem.
+  default_value: 180
 
 vni:
   set_value: '<state> member vni <vni> <assoc_vrf>'

data/lib/cisco_node_utils/cmd_ref/yang.yaml

@@ -0,0 +1,7 @@
+# yang
+#
+---
+_exclude: [nexus]
+support:
+  get_value: ''
+

data/lib/cisco_node_utils/cmd_ref/yum.yaml

@@ -2,6 +2,9 @@
 ---
 _exclude: [ios_xr]
 
+deactivate:
+  set_value: "install deactivate %s"
+
 install:
   set_value: "install add %s %s activate"
 
@@ -11,5 +14,11 @@ query:
   # pass in the pkg name, retrieve version
   get_value: '/^%s\S*\s+(\S+)\s+(?:installed|@\S+)/'
 
+query_all:
+  multiple: true
+  get_command: "show install packages"
+  get_value: '/^(\S+)\s+(\S+)\s+(\S+)$/'
+  default_value: []
+
 remove:
-  set_value: "install deactivate %s"
+  set_value: "install remove %s forced"

data/lib/cisco_node_utils/constants.rb

@@ -28,6 +28,13 @@ module Cisco
     :cli,
     # Structured data format specific to NX-API
     :nxapi_structured,
-    # TODO: :yang,
+    # YANG JSON
+    :yang_json,
+  ]
+
+  YANG_SET_MODE = [
+    :merge_config,
+    :replace_config,
+    :delete_config,
   ]
 end

data/lib/cisco_node_utils/dhcp_relay_global.rb

@@ -0,0 +1,302 @@
+# September 2016, Sai Chintalapudi
+#
+# Copyright (c) 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 dhcp_relay_global
+  class DhcpRelayGlobal < NodeUtil
+    attr_reader :name
+
+    def initialize(instantiate=true)
+      Feature.dhcp_enable if instantiate
+      set_args_keys_default
+    end
+
+    def self.globals
+      hash = {}
+      hash['default'] = DhcpRelayGlobal.new(false) if Feature.dhcp_enabled?
+      hash
+    end
+
+    # Helper method to delete @set_args hash keys
+    def set_args_keys_default
+      @set_args = {}
+      @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
+      return unless Feature.dhcp_enabled?
+      [:ipv4_information_option,
+       :ipv4_information_option_trust,
+       :ipv4_information_option_vpn,
+       :ipv4_information_trust_all,
+       :ipv4_relay,
+       :ipv4_smart_relay,
+       :ipv4_src_addr_hsrp,
+       :ipv4_src_intf,
+       :ipv4_sub_option_circuit_id_custom,
+       :ipv4_sub_option_circuit_id_string,
+       :ipv4_sub_option_cisco,
+       :ipv6_option_cisco,
+       :ipv6_option_vpn,
+       :ipv6_relay,
+       :ipv6_src_intf,
+      ].each do |prop|
+        send("#{prop}=", send("default_#{prop}")) if send prop
+      end
+      set_args_keys_default
+    end
+
+    ########################################################
+    #                      PROPERTIES                      #
+    ########################################################
+
+    def ipv4_information_option
+      config_get('dhcp_relay_global', 'ipv4_information_option')
+    end
+
+    def ipv4_information_option=(val)
+      state = val ? '' : 'no'
+      set_args_keys(state: state)
+      config_set('dhcp_relay_global', 'ipv4_information_option', @set_args)
+    end
+
+    def default_ipv4_information_option
+      config_get_default('dhcp_relay_global', 'ipv4_information_option')
+    end
+
+    def ipv4_information_option_trust
+      config_get('dhcp_relay_global', 'ipv4_information_option_trust')
+    end
+
+    def ipv4_information_option_trust=(val)
+      state = val ? '' : 'no'
+      set_args_keys(state: state)
+      config_set('dhcp_relay_global', 'ipv4_information_option_trust',
+                 @set_args)
+    end
+
+    def default_ipv4_information_option_trust
+      config_get_default('dhcp_relay_global', 'ipv4_information_option_trust')
+    end
+
+    def ipv4_information_option_vpn
+      config_get('dhcp_relay_global', 'ipv4_information_option_vpn')
+    end
+
+    def ipv4_information_option_vpn=(val)
+      state = val ? '' : 'no'
+      set_args_keys(state: state)
+      config_set('dhcp_relay_global', 'ipv4_information_option_vpn', @set_args)
+    end
+
+    def default_ipv4_information_option_vpn
+      config_get_default('dhcp_relay_global', 'ipv4_information_option_vpn')
+    end
+
+    def ipv4_information_trust_all
+      config_get('dhcp_relay_global', 'ipv4_information_trust_all')
+    end
+
+    def ipv4_information_trust_all=(val)
+      state = val ? '' : 'no'
+      set_args_keys(state: state)
+      config_set('dhcp_relay_global', 'ipv4_information_trust_all', @set_args)
+    end
+
+    def default_ipv4_information_trust_all
+      config_get_default('dhcp_relay_global', 'ipv4_information_trust_all')
+    end
+
+    def ipv4_relay
+      config_get('dhcp_relay_global', 'ipv4_relay')
+    end
+
+    def ipv4_relay=(val)
+      state = val ? '' : 'no'
+      set_args_keys(state: state)
+      config_set('dhcp_relay_global', 'ipv4_relay', @set_args)
+    end
+
+    def default_ipv4_relay
+      config_get_default('dhcp_relay_global', 'ipv4_relay')
+    end
+
+    def ipv4_smart_relay
+      config_get('dhcp_relay_global', 'ipv4_smart_relay')
+    end
+
+    def ipv4_smart_relay=(val)
+      state = val ? '' : 'no'
+      set_args_keys(state: state)
+      config_set('dhcp_relay_global', 'ipv4_smart_relay', @set_args)
+    end
+
+    def default_ipv4_smart_relay
+      config_get_default('dhcp_relay_global', 'ipv4_smart_relay')
+    end
+
+    def ipv4_src_addr_hsrp
+      config_get('dhcp_relay_global', 'ipv4_src_addr_hsrp')
+    end
+
+    def ipv4_src_addr_hsrp=(val)
+      state = val ? '' : 'no'
+      set_args_keys(state: state)
+      config_set('dhcp_relay_global', 'ipv4_src_addr_hsrp', @set_args)
+    end
+
+    def default_ipv4_src_addr_hsrp
+      config_get_default('dhcp_relay_global', 'ipv4_src_addr_hsrp')
+    end
+
+    def ipv4_src_intf
+      intf = config_get('dhcp_relay_global', 'ipv4_src_intf')
+      # Normalize by downcasing and removing white space
+      intf = intf.downcase.delete(' ') if intf
+      intf
+    end
+
+    def ipv4_src_intf=(val)
+      state = val == default_ipv4_src_intf ? 'no' : ''
+      intf = val == default_ipv4_src_intf ? '' : val
+      set_args_keys(state: state, intf: intf)
+      config_set('dhcp_relay_global', 'ipv4_src_intf', @set_args)
+    end
+
+    def default_ipv4_src_intf
+      config_get_default('dhcp_relay_global', 'ipv4_src_intf')
+    end
+
+    def ipv4_sub_option_circuit_id_custom
+      config_get('dhcp_relay_global', 'ipv4_sub_option_circuit_id_custom')
+    end
+
+    def ipv4_sub_option_circuit_id_custom=(val)
+      state = val ? '' : 'no'
+      set_args_keys(state: state)
+      config_set('dhcp_relay_global', 'ipv4_sub_option_circuit_id_custom',
+                 @set_args)
+    end
+
+    def default_ipv4_sub_option_circuit_id_custom
+      config_get_default('dhcp_relay_global',
+                         'ipv4_sub_option_circuit_id_custom')
+    end
+
+    def ipv4_sub_option_circuit_id_string
+      str = config_get('dhcp_relay_global', 'ipv4_sub_option_circuit_id_string')
+      # Normalize by removing white space
+      str.strip! if str
+      str
+    end
+
+    def ipv4_sub_option_circuit_id_string=(val)
+      state = val == default_ipv4_sub_option_circuit_id_string ? 'no' : ''
+      format = val == default_ipv4_sub_option_circuit_id_string ? '' : 'format'
+      word = val == default_ipv4_sub_option_circuit_id_string ? '' : val
+      set_args_keys(state: state, format: format, word: word)
+      config_set('dhcp_relay_global', 'ipv4_sub_option_circuit_id_string',
+                 @set_args)
+    end
+
+    def default_ipv4_sub_option_circuit_id_string
+      config_get_default('dhcp_relay_global',
+                         'ipv4_sub_option_circuit_id_string')
+    end
+
+    def ipv4_sub_option_cisco
+      config_get('dhcp_relay_global', 'ipv4_sub_option_cisco')
+    end
+
+    def ipv4_sub_option_cisco=(val)
+      state = val ? '' : 'no'
+      set_args_keys(state: state)
+      config_set('dhcp_relay_global', 'ipv4_sub_option_cisco', @set_args)
+    end
+
+    def default_ipv4_sub_option_cisco
+      config_get_default('dhcp_relay_global', 'ipv4_sub_option_cisco')
+    end
+
+    def ipv6_option_cisco
+      config_get('dhcp_relay_global', 'ipv6_option_cisco')
+    end
+
+    def ipv6_option_cisco=(val)
+      state = val ? '' : 'no'
+      set_args_keys(state: state)
+      config_set('dhcp_relay_global', 'ipv6_option_cisco', @set_args)
+    end
+
+    def default_ipv6_option_cisco
+      config_get_default('dhcp_relay_global', 'ipv6_option_cisco')
+    end
+
+    def ipv6_option_vpn
+      config_get('dhcp_relay_global', 'ipv6_option_vpn')
+    end
+
+    def ipv6_option_vpn=(val)
+      state = val ? '' : 'no'
+      set_args_keys(state: state)
+      config_set('dhcp_relay_global', 'ipv6_option_vpn', @set_args)
+    end
+
+    def default_ipv6_option_vpn
+      config_get_default('dhcp_relay_global', 'ipv6_option_vpn')
+    end
+
+    def ipv6_relay
+      config_get('dhcp_relay_global', 'ipv6_relay')
+    end
+
+    def ipv6_relay=(val)
+      state = val ? '' : 'no'
+      set_args_keys(state: state)
+      config_set('dhcp_relay_global', 'ipv6_relay', @set_args)
+    end
+
+    def default_ipv6_relay
+      config_get_default('dhcp_relay_global', 'ipv6_relay')
+    end
+
+    def ipv6_src_intf
+      intf = config_get('dhcp_relay_global', 'ipv6_src_intf')
+      # Normalize by downcasing and removing white space
+      intf = intf.downcase.delete(' ') if intf
+      intf
+    end
+
+    def ipv6_src_intf=(val)
+      state = val == default_ipv6_src_intf ? 'no' : ''
+      intf = val == default_ipv6_src_intf ? '' : val
+      set_args_keys(state: state, intf: intf)
+      config_set('dhcp_relay_global', 'ipv6_src_intf', @set_args)
+    end
+
+    def default_ipv6_src_intf
+      config_get_default('dhcp_relay_global', 'ipv6_src_intf')
+    end
+  end # class
+end # module