cisco_node_utils_mgx 2.1.0.1

data/lib/cisco_node_utils/cmd_ref/show_system.yaml

@@ -0,0 +1,9 @@
+# show_system
+---
+uptime:
+  # 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

@@ -0,0 +1,84 @@
+# show_version
+---
+_template:
+  N5k: &template5k
+    get_command: 'sh version'
+  N6k: *template5k
+  N3k: &template3k
+    get_command: 'sh hardware'
+  N7k: *template3k
+  N9k: *template3k
+  N3k-F: *template3k
+  N9k-F: *template3k
+  nexus:
+    data_format: nxapi_structured
+  ios_xr:
+    data_format: cli
+
+board:
+  nexus:
+    get_value: 'proc_board_id'
+
+boot_image:
+  _exclude: [ios_xr]
+  get_value: "kick_file_name"
+
+cpu:
+  nexus:
+    get_value: 'cpu_name'
+
+description:
+  nexus:
+    get_value: "chassis_id"
+  ios_xr:
+    get_command: 'show inventory | inc "Rack 0"'
+    get_value: '/DESCR: "(.*)"/'
+
+full:
+  get_command: "sh version"
+
+header:
+  nexus:
+    get_value: "header_str"
+  ios_xr:
+    get_value: '/Cisco.*Software/'
+
+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:
+  _exclude: [ios_xr]
+  get_value: "rr_reason"
+
+last_reset_time:
+  _exclude: [N3k, ios_xr]
+  kind: string
+  default_value: ''
+  get_value: "rr_ctime"
+
+system_image:
+  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_command: 'sh install active'
+    get_value: '/^\s*(\S*)\s*version.*\[Boot image\]$/'
+
+uptime:
+  get_command: 'sh system uptime'
+  get_data_format: cli
+  get_value: '/Kernel uptime:\s+(.*)/'
+
+version:
+  nexus:
+    get_value: "kickstart_ver_str"
+  ios_xr:
+    get_value: '/IOS XR.*Version (.*)$/'

data/lib/cisco_node_utils/cmd_ref/snmp_community.yaml

@@ -0,0 +1,81 @@
+# snmp_community
+---
+
+_template:
+  N3k: &template_structured
+    get_data_format: nxapi_structured
+    get_command: "show snmp community"
+    get_context: ["TABLE_snmp_community", "ROW_snmp_community"]
+  N9k: *template_structured
+  N9k-F: *template_structured
+  N3k-F: *template_structured
+
+acl:
+  N3k: &acl_structured_get
+    kind: string
+    get_value: ["community_name <name>", "aclfilter", '/^(?:ACL mapped:\s+)?(\S+)/']
+    set_value: "<state> snmp-server community <name> use-acl <acl>"
+  N9k: *acl_structured_get
+  N9k-F: *acl_structured_get
+  N3k-F: *acl_structured_get
+  ios_xr:
+    get_command: "show running snmp"
+    get_value: '/^snmp-server community <name> IPv4 (.*)$/'
+    set_value: "<state> snmp-server community <name> <acl>"
+  N5k: &acl_cli_get
+    get_command: "show running snmp all"
+    get_value: '/^snmp-server community <name> use-acl (.*)$/'
+    set_value: "<state> snmp-server community <name> use-acl <acl>"
+  N6k: *acl_cli_get
+  N7k: *acl_cli_get
+  default_value: ""
+
+all_communities:
+  multiple: true
+  N3k: &all_structured
+    get_value: 'community_name'
+  N9k: *all_structured
+  N9k-F: *all_structured
+  N3k-F: *all_structured
+  N5k: &all_cli
+    get_command: "show running snmp all"
+    get_value: '/^snmp-server community (\S+) /'
+  N6k: *all_cli
+  N7k: *all_cli
+  ios_xr:
+    get_command: "show running-config snmp"
+    get_value: '/^snmp-server community (\S+)/'
+
+community:
+  nexus:
+    set_value: "<state> snmp-server community <name> group <group>"
+  ios_xr:
+    get_command: "show running-config snmp"
+    get_value: '/^snmp-server community (%s) .*$/'
+    set_value: "<state> snmp-server community <name>"
+
+group:
+  N3k: &group_structured_get
+    kind: string
+    get_value: ["community_name <name>", "grouporaccess", '/^(?:Community groupname:\s+)?(\S+)/']
+  N9k: *group_structured_get
+  N9k-F: *group_structured_get
+  N3k-F: *group_structured_get
+  ios_xr: &group_cli_based_get
+    kind: string
+    get_command: "show running snmp all"
+    get_value: '/^snmp-server community <name> group (.*)$/'
+  N5k: *group_cli_based_get
+  N6k: *group_cli_based_get
+  N7k: *group_cli_based_get
+  set_value: "snmp-server community <name> group <group>"
+  default_value: "network-operator"
+
+group_community_mapping:
+    get_command: "show running snmp"
+    get_value: '/^snmp-server community-map <name> target-list (.*)$/'
+    set_value: "snmp-server community-map <name> target-list <group>"
+
+group_simple:
+    get_command: "show running snmp"
+    set_value: "snmp-server group <group> v3 noauth"

data/lib/cisco_node_utils/cmd_ref/snmp_group.yaml

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

data/lib/cisco_node_utils/cmd_ref/snmp_notification_receiver.yaml

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

data/lib/cisco_node_utils/cmd_ref/snmp_server.yaml

@@ -0,0 +1,91 @@
+# snmp_server
+---
+
+aaa_user_cache_timeout:
+  _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:
+  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/'
+  set_value: "%s snmp-server globalEnforcePriv"
+  default_value: false
+
+location:
+  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"
+  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
+  # 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.
+  N9k-F: *n3k_default_packet_size
+  N3k-F: *n3k_default_packet_size
+
+protocol:
+  _exclude: [ios_xr]
+  kind: boolean
+  auto_default: false
+  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"
+  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

@@ -0,0 +1,57 @@
+# snmp_user
+---
+_exclude: [ios_xr]
+
+_template:
+  multiple: true
+
+auth_password:
+  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:
+  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:
+    # TODO: is this really N9K-specific?
+    get_value: "auth"
+
+engine_id:
+  default_value: ""
+
+group:
+  default_value: "network-operator"
+  N9k:
+    # TODO: is this really N9K-specific?
+    get_value: "group"
+
+priv_password:
+  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:
+  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:
+    # TODO: is this really N9K-specific?
+    get_value: "priv"
+
+# Config string syntax:
+# [no] snmp-server user <user> [group] [auth {md5|sha} <passwd1> \
+#       [priv [aes-128] <passwd2>] [localizedkey] [engineID <id>]]
+user:
+  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

@@ -0,0 +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:
+  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:
+  nexus:
+    get_value: '/.*snmp-server enable traps (.*)?$/'
+    multiple:
+  ios_xr:
+    get_value: '/.*snmp-server traps (.*)?$/'
+    multiple:

data/lib/cisco_node_utils/cmd_ref/span_session.yaml

@@ -0,0 +1,65 @@
+# SPAN session
+---
+_exclude: [N5k, N6k, N7k]
+
+_template:
+  get_command: "show running monitor all"
+  get_context: ["monitor session <id>(?: .*)?"]
+  set_context: ["monitor session <id>"]
+
+all_sessions:
+  multiple:
+  get_context: ~
+  get_value: '/^monitor session (\d+)/'
+
+create:
+  set_context: ~
+  set_value: 'monitor session <id>'
+
+description:
+  kind: string
+  get_value: '/^description (.*)/'
+  set_value: '<state> description <description>'
+  default_value: ''
+
+destination:
+  kind: string
+  get_value: '/^destination interface (\S+)$/'
+  set_value: '<state> destination interface <intf_name>'
+
+destroy:
+  set_context: ~
+  set_value: 'no monitor session <id>'
+
+session_id:
+  kind: int
+  default_value: false
+  get_context: ~
+  get_value: '/^monitor session (\d+)/'
+  set_context: ~
+  set_value: '<state> monitor session <id> <type> <val>'
+
+shutdown:
+  kind: boolean
+  default_value: true
+  get_value: '/^no shut$/'
+  set_value: '<state> shut'
+
+source_interfaces:
+  multiple:
+  get_value: '/^source interface (\S+) (\w+)$/'
+  set_value: '<state> source interface <int_name> <direction>'
+  default_value: []
+
+source_vlans:
+  get_value: '/^source vlan (\S+) (\w+)$/'
+  set_value: '<state> source vlan <vlans> <direction>'
+  default_value: []
+
+type:
+  kind: string
+  default_value: 'local'
+  get_context: ~
+  get_value: '/^monitor session \d+ type (\S+)$/'
+  set_context: ~
+  set_value: 'monitor session <id> type <type>'