cisco_node_utils 1.2.0 → 1.3.0

data/lib/cisco_node_utils/cmd_ref/radius_server_group.yaml

@@ -3,12 +3,17 @@
 _template:
   multiple: true
   default_value: []
-  config_get: "show running-config radius all"
+  nexus:
+    get_command: "show running-config radius all"
+  ios_xr:
+    get_command: "show running-config aaa"
 
 group:
-  config_get_token: '/^aaa group server radius (\S+)/'
-  config_set: '<state> aaa group server radius <name>'
+  get_value: '/^aaa group server radius (\S+)/'
+  set_value: '<state> aaa group server radius <name>'
 
 servers:
-  config_get_token: ['/^aaa group server radius %s $/i', '/server (\S+)/']
-  config_set: ['aaa group server radius <group>', '<state> server <ip>']
+  get_context: ['/^aaa group server radius %s/i']
+  get_value: '/server (\S+)/'
+  set_context: ['aaa group server radius <group>']
+  set_value: '<state> server <ip>'

data/lib/cisco_node_utils/cmd_ref/show_system.yaml

@@ -1,5 +1,9 @@
 # show_system
 ---
 uptime:
-  config_get: 'show system uptime'
-  config_get_token: '/.*System uptime:\s+(\d+) days, (\d+) hours, (\d+) minutes, (\d+) seconds/'
+  # TODO: redundant with show_version, uptime?
+  nexus:
+    get_command: 'show system uptime'
+  ios_xr:
+    get_command: 'show version'
+  get_value: '/.*System uptime.*(?:(\d+) days, )?(?:(\d+) hours, )?(?:(\d+) minutes, )?(?:(\d+) seconds)?/'

data/lib/cisco_node_utils/cmd_ref/show_version.yaml

@@ -1,72 +1,76 @@
 # show_version
 ---
 _template:
-  config_get: 'sh version'
-  cli_nexus:
-    test_config_get: "sh version | no-more"
+  get_command: 'sh version'
+  nexus:
+    data_format: nxapi_structured
+  ios_xr:
+    data_format: cli
 
 board:
-  config_get_token: 'proc_board_id'
+  nexus:
+    get_value: 'proc_board_id'
 
 boot_image:
-  config_get_token: "kick_file_name"
-  test_config_get_regex: '/.*NXOS image file is: (.*)$.*/'
+  _exclude: [ios_xr]
+  nexus:
+    get_value: "kick_file_name"
 
 cpu:
-  config_get_token: 'cpu_name'
+  nexus:
+    get_value: 'cpu_name'
 
 description:
-  config_get_token: "chassis_id"
-  cli_nexus:
-    /N7/:
-      test_config_get_regex: '/.*Hardware\n  cisco (\w+ \w+ \(\w+ \w+\) \w+).*/'
-    else:
-      # Hardware
-      #   cisco Nexus9000 C9396PX Chassis
-      #
-      # Other variants for the line of interest:
-      #   cisco Nexus9000 C9504 (4 Slot) Chassis ("Supervisor Module")
-      #                                          ^-module_id-ignore!-^
-      #   cisco Nexus3000 C3132Q Chassis
-      #   cisco N3K-C3048TP-1GE
-      test_config_get_regex: '/Hardware\n  cisco (([^(\n]+|\(\d+ Slot\))+\w+)/'
+  nexus:
+    get_value: "chassis_id"
+  ios_xr:
+    get_command: 'show inventory | inc "Rack 0"'
+    get_value: '/DESCR: "(.*)"/'
 
 full:
-  config_get: "sh version"
+  get_command: "sh version"
 
 header:
-  config_get_token: "header_str"
+  nexus:
+    get_value: "header_str"
+  ios_xr:
+    get_value: '/Cisco.*Software/'
 
 host_name:
-  cli_nexus:
-    config_get_token: "host_name"
+  nexus:
+    get_value: "host_name"
+  ios_xr:
+    # not displayed in 'show version' on IOS XR
+    get_command: "show running | i hostname"
+    get_value: '/^hostname (.*)$/'
+    default_value: 'ios'
 
 last_reset_reason:
-  config_get_token: "rr_reason"
-  test_config_get_regex: '/.*\nLast reset.*\n\n?  Reason: (.*)\n/'
+  _exclude: [ios_xr]
+  get_value: "rr_reason"
 
 last_reset_time:
+  _exclude: [N3k, ios_xr]
   kind: string
   default_value: ''
-  config_get_token: "rr_ctime"
-  test_config_get_regex: '/.*\nLast reset at \d+ usecs after  (.*)\n/'
+  get_value: "rr_ctime"
 
 system_image:
-  cli_nexus:
-    /N7/:
-      config_get_token: "isan_file_name"
-      test_config_get_regex: '/.*system image file is:    (.*)$.*/'
-    else:
-      config_get_token: "kick_file_name"
-      test_config_get_regex: '/.*NXOS image file is: (.*)$.*/'
+  get_value: "kick_file_name"
+  N5k: &sys_img_isan
+    get_value: "isan_file_name"
+  N6k: *sys_img_isan
+  N7k: *sys_img_isan
+  ios_xr:
+    get_value: '/IOS XR.*Version (.*)$/'
 
 uptime:
-  config_get_token: '/uptime is (.*)/'
+  # TODO: redundant with show_system, uptime?
+  get_data_format: cli
+  get_value: '/uptime is (.*)/'
 
 version:
-  cli_nexus:
-    config_get_token: "kickstart_ver_str"
-    test_config_get_regex: [
-    /\nkickstart_ver_str\s+(.+)\n/,
-    '/.*NXOS:\s+version (.*)\n/'
-    ]
+  nexus:
+    get_value: "kickstart_ver_str"
+  ios_xr:
+    get_value: '/IOS XR.*Version (.*)$/'

data/lib/cisco_node_utils/cmd_ref/snmp_community.yaml

@@ -1,23 +1,25 @@
 # snmp_community
 ---
+_exclude: [ios_xr]
+
 acl:
-  config_get: "show running snmp all"
-  config_get_token: '/^snmp-server community %s use-acl (.*)$/'
-  config_set: "%s snmp-server community %s use-acl %s"
+  get_command: "show running snmp all"
+  get_value: '/^snmp-server community %s use-acl (.*)$/'
+  set_value: "%s snmp-server community %s use-acl %s"
   default_value: ""
 
 all_communities:
   multiple: true
-  config_get: "show running snmp all"
-  config_get_token: '/^snmp-server community (\S+) /'
+  get_command: "show running snmp all"
+  get_value: '/^snmp-server community (\S+) /'
 
 community:
-  config_get: "show running snmp all"
-  config_get_token: '/^snmp-server community (%s) group .*$/'
-  config_set: "%s snmp-server community %s group %s"
+  get_command: "show running snmp all"
+  get_value: '/^snmp-server community (%s) group .*$/'
+  set_value: "%s snmp-server community %s group %s"
 
 group:
-  config_get: "show running snmp all"
-  config_get_token: '/^snmp-server community %s group (.*)$/'
-  config_set: "snmp-server community %s group %s"
+  get_command: "show running snmp all"
+  get_value: '/^snmp-server community %s group (.*)$/'
+  set_value: "snmp-server community %s group %s"
   default_value: "network-operator"

data/lib/cisco_node_utils/cmd_ref/snmp_group.yaml

@@ -1,7 +1,9 @@
 # snmp_group
 ---
+_exclude: [ios_xr]
+
 group:
   multiple: true
-  config_get: "show snmp group"
-  config_get_token: "/^Role: (.*)$/"
+  get_command: "show snmp group"
+  get_value: "/^Role: (.*)$/"
   default_value: ""

data/lib/cisco_node_utils/cmd_ref/snmp_notification_receiver.yaml

@@ -1,50 +1,52 @@
 # snmp_notification_receiver
 ---
+_exclude: [ios_xr]
+
 port:
-  config_get: "show running-config snmp all"
-  config_get_token: '/^snmp-server host %s.*version.* udp-port (\d+).*$/'
+  get_command: "show running-config snmp all"
+  get_value: '/^snmp-server host %s.*version.* udp-port (\d+).*$/'
   default_value: null
 
 receivers:
-  config_get: "show running snmp all"
-  config_get_token: '/^snmp-server host (\S+) (traps|informs)/'
-  config_set: "<state> snmp-server host <ip> <type> version <version> <security> <username> <udp_port>"
+  get_command: "show running snmp all"
+  get_value: '/^snmp-server host (\S+) (traps|informs)/'
+  set_value: "<state> snmp-server host <ip> <type> version <version> <security> <username> <udp_port>"
   multiple:
 
 security:
-  config_get: "show running-config snmp all"
-  config_get_token: '/^snmp-server host %s.* version 3 (auth|noauth|priv).*$/'
+  get_command: "show running-config snmp all"
+  get_value: '/^snmp-server host %s.* version 3 (auth|noauth|priv).*$/'
   default_value: null
 
 source_interface:
-  config_get: "show running-config snmp all"
-  config_get_token: '/^snmp-server host %s.* source-interface (\S+).*$/'
-  config_set: "snmp-server host <ip> source-interface <source_interface> <port>"
+  get_command: "show running-config snmp all"
+  get_value: '/^snmp-server host %s.* source-interface (\S+).*$/'
+  set_value: "snmp-server host <ip> source-interface <source_interface> <port>"
   default_value: null
 
 type:
-  config_get: "show running-config snmp all"
-  config_get_token: '/^snmp-server host %s (traps|informs).*$/'
+  get_command: "show running-config snmp all"
+  get_value: '/^snmp-server host %s (traps|informs).*$/'
   default_value: null
 
 username:
-  config_get: "show running-config snmp all"
-  config_get_token: '/^snmp-server host %s.*version.* (\S+)$/'
+  get_command: "show running-config snmp all"
+  get_value: '/^snmp-server host %s.*version.* (\S+)$/'
   default_value: null
 
 username_with_port:
-  config_get: "show running-config snmp all"
-  config_get_token: '/^snmp-server host %s.*version.* (\S+) udp-port/'
+  get_command: "show running-config snmp all"
+  get_value: '/^snmp-server host %s.*version.* (\S+) udp-port/'
   default_value: null
 
 version:
-  config_get: "show running-config snmp all"
-  config_get_token: '/^snmp-server host %s.* version (\S+).*$/'
+  get_command: "show running-config snmp all"
+  get_value: '/^snmp-server host %s.* version (\S+).*$/'
   default_value: null
 
 vrf:
-  config_get: "show running-config snmp all"
-  config_get_token: '/^snmp-server host %s.* use-vrf (\S+).*$/'
-  config_set: "snmp-server host <ip> use-vrf <vrf> <port>"
+  get_command: "show running-config snmp all"
+  get_value: '/^snmp-server host %s.* use-vrf (\S+).*$/'
+  set_value: "snmp-server host <ip> use-vrf <vrf> <port>"
   default_value: null
 

data/lib/cisco_node_utils/cmd_ref/snmp_server.yaml

@@ -1,51 +1,55 @@
 # snmp_server
 ---
+_exclude: [ios_xr]
+
 aaa_user_cache_timeout:
-  cli_nexus:
+  nexus:
     kind: int
-    config_get: "show snmp internal globals"
-    config_get_token: '/AAA Cache Timeout :(\d+)/'
-    config_set: "%s snmp-server aaa-user cache-timeout %d"
+    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:
-  config_get: "show snmp"
-  config_get_token: "sys_contact"
-  config_set: "%s snmp-server contact %s"
+  get_data_format: nxapi_structured
+  get_command: "show snmp"
+  get_value: "sys_contact"
+  set_value: "%s snmp-server contact %s"
   default_value: ""
 
 global_enforce_priv:
   kind: boolean
-  config_get: "show run snmp all"
-  config_get_token: '/^(?:no )?snmp-server globalEnforcePriv/'
-  config_set: "%s snmp-server globalEnforcePriv"
+  get_command: "show run snmp all"
+  get_value: '/^(?:no )?snmp-server globalEnforcePriv/'
+  set_value: "%s snmp-server globalEnforcePriv"
   default_value: false
 
 location:
-  config_get: "show snmp"
-  config_get_token: "sys_location"
-  config_set: "%s snmp-server location %s"
+  get_data_format: nxapi_structured
+  get_command: "show snmp"
+  get_value: "sys_location"
+  set_value: "%s snmp-server location %s"
   default_value: ""
 
 packet_size:
   kind: int
-  config_get: "show snmp internal globals"
-  config_get_token: '/SNMP Max packet size :(\d+)/'
-  config_set: "%s snmp-server packetsize %d"
+  get_command: "show snmp internal globals"
+  get_value: '/SNMP Max packet size :(\d+)/'
+  set_value: "%s snmp-server packetsize %d"
   default_value: 1500
 
 protocol:
   kind: boolean
   auto_default: false
-  config_get: "show running-config snmp all"
-  config_get_token: ['/^snmp.server protocol enable/']
-  config_set: "%s snmp-server protocol enable"
+  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:
   kind: boolean
   auto_default: false
-  config_get: "show running-config snmp all"
-  config_get_token: ['/^snmp.server tcp.session auth$/']
-  config_set: "%s snmp-server tcp-session %s"
+  get_command: "show running-config snmp all"
+  get_value: '/^snmp.server tcp.session auth$/'
+  set_value: "%s snmp-server tcp-session %s"
   default_value: true

data/lib/cisco_node_utils/cmd_ref/snmp_user.yaml

@@ -1,55 +1,57 @@
 # snmp_user
 ---
+_exclude: [ios_xr]
+
 _template:
   multiple: true
 
 auth_password:
-  config_get: "show run snmp all"
-  config_get_token: '/snmp-server user (\S+) \S+ auth \S+ (\S+)/'
+  get_command: "show run snmp all"
+  get_value: '/snmp-server user (\S+) \S+ auth \S+ (\S+)/'
   default_value: ""
 
 # The getter format will not have group info if engine id is configured.
 auth_password_with_engine_id:
-  config_get: "show run snmp all"
-  config_get_token: '/snmp-server user (\S+) auth \S+ (\S+) .*engineID (\S+)/'
+  get_command: "show run snmp all"
+  get_value: '/snmp-server user (\S+) auth \S+ (\S+) .*engineID (\S+)/'
   default_value: ""
 
 auth_protocol:
   default_value: "md5"
-  /N9K/:
+  N9k:
     # TODO: is this really N9K-specific?
-    config_get_token: "auth"
+    get_value: "auth"
 
 engine_id:
   default_value: ""
 
 group:
   default_value: "network-operator"
-  /N9K/:
+  N9k:
     # TODO: is this really N9K-specific?
-    config_get_token: "group"
+    get_value: "group"
 
 priv_password:
-  config_get: "show run snmp all"
-  config_get_token: '/snmp-server user (\S+) \S+ auth \S+ \S+ priv.*(0x\S+)/'
+  get_command: "show run snmp all"
+  get_value: '/snmp-server user (\S+) \S+ auth \S+ \S+ priv.*(0x\S+)/'
   default_value: ""
 
 # The getter format will not have group info if engine id is configured.
 priv_password_with_engine_id:
-  config_get: "show run snmp all"
-  config_get_token: '/snmp-server user (\S+) auth \S+ \S+ priv .*(0x\S+) .*engineID (\S+)/'
+  get_command: "show run snmp all"
+  get_value: '/snmp-server user (\S+) auth \S+ \S+ priv .*(0x\S+) .*engineID (\S+)/'
   default_value: ""
 
 priv_protocol:
   default_value: "des"
-  /N9K/:
+  N9k:
     # TODO: is this really N9K-specific?
-    config_get_token: "priv"
+    get_value: "priv"
 
 # Config string syntax:
 # [no] snmp-server user <user> [group] [auth {md5|sha} <passwd1> \
 #       [priv [aes-128] <passwd2>] [localizedkey] [engineID <id>]]
 user:
-  config_get: "show run snmp all | i 'snmp-server user'"
-  config_get_token: '/^snmp.server user (.*)$/'
-  config_set: "%s snmp-server user %s %s %s %s %s %s"
+  get_command: "show run snmp all | i 'snmp-server user'"
+  get_value: '/^snmp.server user (.*)$/'
+  set_value: "%s snmp-server user %s %s %s %s %s %s"

data/lib/cisco_node_utils/cmd_ref/snmpnotification.yaml

@@ -1,11 +1,23 @@
 # snmpnotification
 ---
+_template:
+  nexus:
+    get_command: "sh run snmp all | include 'snmp-server enable traps'"
+  ios_xr:
+    get_command: "show running-config snmp"
+
 enable:
-  config_get: "sh run snmp all | include 'snmp-server enable traps'"
-  config_get_token: '/^snmp-server enable traps <trap_name> ?$/'
-  config_set: "<state> snmp-server enable traps <trap_name>"
+  nexus:
+    get_value: '/^snmp-server enable traps <trap_name> ?$/'
+    set_value: "<state> snmp-server enable traps <trap_name>"
+  ios_xr:
+    get_value: '/^snmp-server traps <trap_name> ?$/'
+    set_value: "<state> snmp-server traps <trap_name>"
 
 notifications:
-  config_get: "sh run snmp all | include 'snmp-server enable traps'"
-  config_get_token: '/.*snmp-server enable traps (.*)?$/'
-  multiple:
+  nexus:
+    get_value: '/.*snmp-server enable traps (.*)?$/'
+    multiple:
+  ios_xr:
+    get_value: '/.*snmp-server traps (.*)?$/'
+    multiple: