cisco_node_utils 1.1.0 → 1.2.0

data/lib/cisco_node_utils/cmd_ref/radius_global.yaml

@@ -0,0 +1,25 @@
+# radius_global.yaml
+---
+key:
+  config_get: "show running-config radius all"
+  config_get_token: '/^radius-server key \d+\s+(\S+)/'
+  config_set: '<state> radius-server key <key>'
+
+key_format:
+  kind: int
+  config_get: "show running-config radius all"
+  config_get_token: '/^radius-server key (\d).*/'
+
+retransmit:
+  kind: int
+  config_get: "show running-config radius all"
+  config_get_token: '/^radius-server retransmit (\d+).*/'
+  config_set: '<state> radius-server retransmit <count>'
+  default_value: 1
+
+timeout:
+  kind: int
+  config_get: "show running-config radius all"
+  config_get_token: '/^radius-server timeout (\d+).*/'
+  config_set: '<state> radius-server timeout <timeout>'
+  default_value: 5

data/lib/cisco_node_utils/cmd_ref/radius_server.yaml

@@ -0,0 +1,64 @@
+# radius_server.yaml
+---
+accounting:
+  auto_default: false
+  kind: boolean
+  config_get: "show running-config radius"
+  config_get_token: '/^radius-server host %s.* (accounting) .*$/'
+  config_set: '<state> radius-server host <ip> accounting'
+  default_value: true
+
+acct-port:
+  kind: int
+  config_get: "show running-config radius all"
+  config_get_token: '/^radius-server host %s.* acct-port (\d+).*$/'
+  config_set: '<state> radius-server host <ip> acct-port <port>'
+  default_value: 1813
+
+auth-port:
+  kind: int
+  config_get: "show running-config radius all"
+  config_get_token: '/^radius-server host %s.* auth-port (\d+).*$/'
+  config_set: '<state> radius-server host <ip> auth-port <port>'
+  default_value: 1812
+
+authentication:
+  auto_default: false
+  kind: boolean
+  config_get: "show running-config radius"
+  config_get_token: '/^radius-server host %s.* (authentication) .*$/'
+  config_set: '<state> radius-server host <ip> authentication'
+  default_value: true
+
+hosts:
+  multiple: true
+  config_get: "show running-config radius"
+  config_get_token: '/^radius-server host (\S+).*/'
+  config_set: '<state> radius-server host <ip>'
+  default_value: ''
+
+key:
+  config_get: "show running-config radius all"
+  config_get_token: '/^radius-server host %s.* key \d+\s+(\S+)/'
+  config_set: '<state> radius-server host <ip> key <key>'
+  default_value: ~
+
+key_format:
+  kind: int
+  config_get: "show running-config radius all"
+  config_get_token: '/^radius-server host %s.* key (\d).*$/'
+  default_value: ~
+
+retransmit:
+  kind: int
+  config_get: "show running-config radius all"
+  config_get_token: '/^radius-server host %s.* retransmit (\d+).*$/'
+  config_set: '<state> radius-server host <ip> retransmit <count>'
+  default_value: ~
+
+timeout:
+  kind: int
+  config_get: "show running-config radius all"
+  config_get_token: '/^radius-server host %s.* timeout (\d+).*$/'
+  config_set: '<state> radius-server host <ip> timeout <timeout>'
+  default_value: ~

data/lib/cisco_node_utils/cmd_ref/radius_server_group.yaml

@@ -0,0 +1,14 @@
+# radius_server_group
+---
+_template:
+  multiple: true
+  default_value: []
+  config_get: "show running-config radius all"
+
+group:
+  config_get_token: '/^aaa group server radius (\S+)/'
+  config_set: '<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>']

data/lib/cisco_node_utils/cmd_ref/show_system.yaml

@@ -0,0 +1,5 @@
+# show_system
+---
+uptime:
+  config_get: 'show system uptime'
+  config_get_token: '/.*System uptime:\s+(\d+) days, (\d+) hours, (\d+) minutes, (\d+) seconds/'

data/lib/cisco_node_utils/cmd_ref/show_version.yaml

@@ -0,0 +1,72 @@
+# show_version
+---
+_template:
+  config_get: 'sh version'
+  cli_nexus:
+    test_config_get: "sh version | no-more"
+
+board:
+  config_get_token: 'proc_board_id'
+
+boot_image:
+  config_get_token: "kick_file_name"
+  test_config_get_regex: '/.*NXOS image file is: (.*)$.*/'
+
+cpu:
+  config_get_token: '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+)/'
+
+full:
+  config_get: "sh version"
+
+header:
+  config_get_token: "header_str"
+
+host_name:
+  cli_nexus:
+    config_get_token: "host_name"
+
+last_reset_reason:
+  config_get_token: "rr_reason"
+  test_config_get_regex: '/.*\nLast reset.*\n\n?  Reason: (.*)\n/'
+
+last_reset_time:
+  kind: string
+  default_value: ''
+  config_get_token: "rr_ctime"
+  test_config_get_regex: '/.*\nLast reset at \d+ usecs after  (.*)\n/'
+
+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: (.*)$.*/'
+
+uptime:
+  config_get_token: '/uptime is (.*)/'
+
+version:
+  cli_nexus:
+    config_get_token: "kickstart_ver_str"
+    test_config_get_regex: [
+    /\nkickstart_ver_str\s+(.+)\n/,
+    '/.*NXOS:\s+version (.*)\n/'
+    ]

data/lib/cisco_node_utils/cmd_ref/snmp_community.yaml

@@ -0,0 +1,23 @@
+# snmp_community
+---
+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"
+  default_value: ""
+
+all_communities:
+  multiple: true
+  config_get: "show running snmp all"
+  config_get_token: '/^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"
+
+group:
+  config_get: "show running snmp all"
+  config_get_token: '/^snmp-server community %s group (.*)$/'
+  config_set: "snmp-server community %s group %s"
+  default_value: "network-operator"

data/lib/cisco_node_utils/cmd_ref/snmp_group.yaml

@@ -0,0 +1,7 @@
+# snmp_group
+---
+group:
+  multiple: true
+  config_get: "show snmp group"
+  config_get_token: "/^Role: (.*)$/"
+  default_value: ""

data/lib/cisco_node_utils/cmd_ref/snmp_notification_receiver.yaml

@@ -0,0 +1,50 @@
+# snmp_notification_receiver
+---
+port:
+  config_get: "show running-config snmp all"
+  config_get_token: '/^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>"
+  multiple:
+
+security:
+  config_get: "show running-config snmp all"
+  config_get_token: '/^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>"
+  default_value: null
+
+type:
+  config_get: "show running-config snmp all"
+  config_get_token: '/^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+)$/'
+  default_value: null
+
+username_with_port:
+  config_get: "show running-config snmp all"
+  config_get_token: '/^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+).*$/'
+  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>"
+  default_value: null
+

data/lib/cisco_node_utils/cmd_ref/snmp_server.yaml

@@ -0,0 +1,51 @@
+# snmp_server
+---
+aaa_user_cache_timeout:
+  cli_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"
+    default_value: 3600
+
+contact:
+  config_get: "show snmp"
+  config_get_token: "sys_contact"
+  config_set: "%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"
+  default_value: false
+
+location:
+  config_get: "show snmp"
+  config_get_token: "sys_location"
+  config_set: "%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"
+  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"
+  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"
+  default_value: true

data/lib/cisco_node_utils/cmd_ref/snmp_user.yaml

@@ -0,0 +1,55 @@
+# snmp_user
+---
+_template:
+  multiple: true
+
+auth_password:
+  config_get: "show run snmp all"
+  config_get_token: '/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+)/'
+  default_value: ""
+
+auth_protocol:
+  default_value: "md5"
+  /N9K/:
+    # TODO: is this really N9K-specific?
+    config_get_token: "auth"
+
+engine_id:
+  default_value: ""
+
+group:
+  default_value: "network-operator"
+  /N9K/:
+    # TODO: is this really N9K-specific?
+    config_get_token: "group"
+
+priv_password:
+  config_get: "show run snmp all"
+  config_get_token: '/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+)/'
+  default_value: ""
+
+priv_protocol:
+  default_value: "des"
+  /N9K/:
+    # TODO: is this really N9K-specific?
+    config_get_token: "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"

data/lib/cisco_node_utils/cmd_ref/snmpnotification.yaml

@@ -0,0 +1,11 @@
+# snmpnotification
+---
+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>"
+
+notifications:
+  config_get: "sh run snmp all | include 'snmp-server enable traps'"
+  config_get_token: '/.*snmp-server enable traps (.*)?$/'
+  multiple:

data/lib/cisco_node_utils/cmd_ref/syslog_server.yaml

@@ -0,0 +1,18 @@
+# syslog_server
+---
+level:
+  kind: int
+  config_get: "show running-config all | include '^logging server'"
+  config_get_token: '/^logging server %s (\d).*/'
+  default_value: ~
+
+server:
+  multiple: true
+  config_get: "show running-config all | include '^logging server'"
+  config_get_token: '/^logging server (\S+).*/'
+  config_set: '<state> logging server <ip> <level> <vrf>'
+
+vrf:
+  config_get: "show running-config all | include '^logging server(.*)(use-vrf)'"
+  config_get_token: '/^logging server %s.* use-vrf (.*)$/'
+  default_value: default

data/lib/cisco_node_utils/cmd_ref/syslog_settings.yaml

@@ -0,0 +1,7 @@
+# syslog_settings
+---
+timestamp:
+  config_get: "show running-config all | include '^logging timestamp'"
+  config_get_token: '/^logging timestamp (.*)$/'
+  config_set: '<state> logging timestamp <units>'
+  default_value: 'seconds'

data/lib/cisco_node_utils/cmd_ref/system.yaml

@@ -0,0 +1,6 @@
+# system
+---
+resources:
+  config_get: "show system resources"
+  test_config_get: "show system resources | no-more"
+  test_config_get_regex: '/.*CPU states  :   (\d+\.\d+)% user,   (\d+\.\d+)% kernel/'

data/lib/cisco_node_utils/cmd_ref/tacacs_server.yaml

@@ -0,0 +1,49 @@
+# tacacs_server
+---
+deadtime:
+  kind: int
+  config_get: "show run tacacs all"
+  config_get_token: '/^tacacs-server deadtime\s+(\d+)/'
+  config_set: "%s tacacs-server deadtime %d"
+  default_value: 0
+
+directed_request:
+  kind: boolean
+  # oddly, directed request must be retrieved from aaa output
+  config_get: "show running aaa all"
+  config_get_token: '/(?:no)?\s*tacacs-server directed-request/'
+  config_set: "%s tacacs-server directed-request"
+  default_value: false
+
+encryption:
+  config_set: "%s tacacs-server key %d %s"
+
+encryption_password:
+  config_get: "show run tacacs all"
+  config_get_token: '/^tacacs-server key (\d+)\s+(\S+)/'
+  default_value: ""
+
+encryption_type:
+  auto_default: false
+  config_get: "show run tacacs all"
+  config_get_token: '/^tacacs-server key (\d+)\s+(\S+)/'
+  default_value: 0
+
+feature:
+  kind: boolean
+  config_get: "show run tacacs all"
+  config_get_token: '/^feature tacacs/'
+  config_set: "%s feature tacacs+"
+
+source_interface:
+  config_get: "show run tacacs all"
+  config_get_token: '/(no)?\s*ip tacacs source-interface\s+(\S+)?/'
+  config_set: "%s ip tacacs source-interface %s"
+  default_value: ""
+
+timeout:
+  kind: int
+  config_get: "show run tacacs all"
+  config_get_token: '/tacacs-server timeout\s+(\d+)/'
+  config_set: "%s tacacs-server timeout %d"
+  default_value: 5