cisco_node_utils 1.2.0 → 1.3.0

data/lib/cisco_node_utils/cmd_ref/interface_channel_group.yaml

@@ -1,28 +1,38 @@
 # interface_channel_group
 ---
 _template:
-  config_get: "show running interface all"
-  config_get_token: '/^interface <name>$/i'
-  config_set: 'interface <name>'
+  context: ['interface <name>']
+  ios_xr:
+    get_command: "show running interface"
+  nexus:
+    get_command: "show running interface all"
 
 all_interfaces:
   multiple:
-  config_get_token: '/^interface (Ethernet.*)/i'
+  get_context: ~
+  get_value: '/^interface (Ethernet.*)/i'
 
 channel_group:
   kind: int
-  config_get_token_append: '/^channel-group (\d+)$/'
-  config_set_append: '<state> channel-group <group> <force>'
   default_value: false
+  nexus:
+    get_value: '/^channel-group (\d+)$/'
+    set_value: '<state> channel-group <group> <force>'
+  ios_xr:
+    get_value: '/^bundle id (\d+).*$/'
+    set_value: '<state> bundle id <group>'
 
 description:
   kind: string
-  config_get_token_append: '/^description (.*)/'
-  config_set_append: '<state> description <desc>'
+  get_value: '/^description (.*)/'
+  set_value: '<state> description <desc>'
   default_value: ''
 
 shutdown:
   kind: boolean
-  config_get_token_append: '/^(?:no )?shutdown$/'
-  config_set_append: '<state> shutdown'
-  default_value: true
+  get_value: '/^(?:no )?shutdown$/'
+  set_value: '<state> shutdown'
+  nexus:
+    default_value: true
+  ios_xr:
+    default_value: false

data/lib/cisco_node_utils/cmd_ref/interface_ospf.yaml

@@ -1,61 +1,61 @@
 # interface_ospf
 ---
+_exclude: [ios_xr]
+
 _template:
-  config_get: 'show running interface all'
-  config_get_token: ['/^interface %s$/i']
-  config_set: ["interface %s"]
+  get_command: 'show running interface all'
+  context: ["interface %s"]
 
 area:
-  config_get_token_append: ['/^\s*ip router ospf (\S+) area (\S+)/']
-  config_set_append: ["%s ip router ospf %s area %s"]
+  get_value: '/^\s*ip router ospf (\S+) area (\S+)/'
+  set_value: "%s ip router ospf %s area %s"
 
 cost:
   kind: int
-  config_get_token_append: ['/^\s*ip ospf cost (\d+)/']
-  config_set_append: ["%s ip ospf cost %s"]
+  get_value: '/^\s*ip ospf cost (\d+)/'
+  set_value: "%s ip ospf cost %s"
   default_value: 0
 
 dead_interval:
   kind: int
-  config_get_token_append: ['/^\s*ip ospf dead-interval (\d+)/']
-  config_set_append: ["%s ip ospf dead-interval %s"]
+  get_value: '/^\s*ip ospf dead-interval (\d+)/'
+  set_value: "%s ip ospf dead-interval %s"
   default_value: 40
-  test_config_result: [262141]
 
 hello_interval:
   kind: int
-  config_get_token_append: ['/^\s*ip ospf hello-interval (\d+)/']
-  config_set_append: ["%s ip ospf hello-interval %s"]
+  get_value: '/^\s*ip ospf hello-interval (\d+)/'
+  set_value: "%s ip ospf hello-interval %s"
   default_value: 10
 
 message_digest:
   kind: boolean
-  config_get_token_append: ['/^\s*ip ospf authentication message-digest/']
-  config_set_append: ["%s ip ospf authentication message-digest"]
+  get_value: '/^\s*ip ospf authentication message-digest/'
+  set_value: "%s ip ospf authentication message-digest"
   default_value: false
 
 message_digest_alg_type:
-  config_get_token_append: ['/^\s*ip ospf message-digest-key \d+ (\S+)/']
+  get_value: '/^\s*ip ospf message-digest-key \d+ (\S+)/'
   default_value: 'md5'
 
 message_digest_enc_type:
-  config_get_token_append: ['/^\s*ip ospf message-digest-key \d+ \S+ (\d+)/']
+  get_value: '/^\s*ip ospf message-digest-key \d+ \S+ (\d+)/'
   default_value: '0'
 
 message_digest_key_id:
   kind: int
-  config_get_token_append: ['/^\s*ip ospf message-digest-key (\d+)/']
+  get_value: '/^\s*ip ospf message-digest-key (\d+)/'
   default_value: 0
 
 message_digest_key_set:
-  config_set_append: ["%s ip ospf message-digest-key %s %s %s %s"]
+  set_value: "%s ip ospf message-digest-key %s %s %s %s"
 
 message_digest_password:
   default_value: ~
-  config_get_token_append: ['/^\s*ip ospf message-digest-key \d+ \S+ \d+ (\S+)/']
+  get_value: '/^\s*ip ospf message-digest-key \d+ \S+ \d+ (\S+)/'
 
 passive_interface:
   kind: boolean
-  config_get_token_append: ['/^\s*ip ospf passive-interface/']
-  config_set_append: ["%s ip ospf passive-interface"]
+  get_value: '/^\s*ip ospf passive-interface/'
+  set_value: "%s ip ospf passive-interface"
   default_value: false

data/lib/cisco_node_utils/cmd_ref/interface_portchannel.yaml

@@ -1,54 +1,63 @@
 # interface_portchannel
 ---
+_exclude: [ios_xr]
+
 _template:
-  config_set: ["interface %s"]
-  config_get_token: '/^interface %s$/i'
-  config_get: "show running interface all"
+  get_command: "show running interface all"
+  get_context: ['/^interface %s$/i']
+  set_context: ["interface %s"]
 
 create:
-  config_set: "interface %s"
+  set_context: ~
+  set_value: "interface %s"
 
 destroy:
-  config_set: "no interface %s"
+  set_context: ~
+  set_value: "no interface %s"
 
 lacp_graceful_convergence:
   kind: boolean
   auto_default: false
-  config_get_token_append: ['/^lacp graceful.convergence$/']
-  config_set_append: ["%s lacp graceful-convergence"]
+  get_value: '/^lacp graceful.convergence$/'
+  set_value: "%s lacp graceful-convergence"
   default_value: true
 
 lacp_max_bundle:
   kind: int
-  config_get_token_append: ['/^lacp max.bundle (\d+)$/']
-  config_set_append: ["lacp max-bundle %s"]
-  /N(3|9)/:
+  get_value: '/^lacp max.bundle (\d+)$/'
+  set_value: "lacp max-bundle %s"
+  N3k: &lacp_max_bundle_32
     default_value: 32
-  else:
+  N5k: &lacp_max_bundle_16
     default_value: 16
+  N6k: *lacp_max_bundle_16
+  N7k: *lacp_max_bundle_16
+  N8k: *lacp_max_bundle_32
+  N9k: *lacp_max_bundle_32
 
 lacp_min_links:
   kind: int
-  config_get_token_append: ['/^lacp min.links (\d+)$/']
-  config_set_append: ["lacp min-links %s"]
+  get_value: '/^lacp min.links (\d+)$/'
+  set_value: "lacp min-links %s"
   default_value: 1
 
 lacp_suspend_individual:
   kind: boolean
   auto_default: false
-  config_get_token_append: ['/^lacp suspend.individual$/']
-  config_set_append: ["%s lacp suspend-individual"]
+  get_value: '/^lacp suspend.individual$/'
+  set_value: "%s lacp suspend-individual"
   default_value: true
 
 port_hash_distribution:
-  _exclude: [/N6/, /N5/]
-  config_get_token_append: ['/^port-channel port hash.distribution (.*)$/']
-  config_set: ["terminal dont-ask", "interface %s", "%s port-channel port hash-distribution %s", "end"]
+  _exclude: [N6k, N5k]
+  set_context:  ['terminal dont-ask', "interface %s"]
+  get_value: '/^port-channel port hash.distribution (.*)$/'
+  set_value: "%s port-channel port hash-distribution %s"
   default_value: false
 
 port_load_defer:
-  _exclude: [/N6/, /N5/]
+  _exclude: [N6k, N5k]
   kind: boolean
-  config_get_token_append: ['/^port-channel port load.defer$/']
-  config_set_append: ["%s port-channel port load-defer"]
+  get_value: '/^port-channel port load.defer$/'
+  set_value: "%s port-channel port load-defer"
   default_value: false

data/lib/cisco_node_utils/cmd_ref/interface_service_vni.yaml

@@ -1,32 +1,37 @@
 # interface_service_vni
 ---
+_exclude: [N3k, N5k, N6k, N8k, N9k, ios_xr]
+
 _template:
-  _exclude: [/N(3|5|6|9)/]
-  config_get: 'show running interface all'
-  config_get_token: '/^interface <name>$/i'
-  config_get_token_append:
+  get_command: 'show running interface all'
+  get_context:
+    - '/^interface <name>$/i'
     - '/^service instance <sid> vni$/'
-  config_set: 'interface <name>'
-  config_set_append:
+  set_context:
+    - 'interface <name>'
     - 'service instance <sid> vni'
 
 all_service_vni_ids:
   multiple:
-  config_get_token_append: '/^service instance (\d+) vni/'
+  get_context:
+    - '/^interface <name>$/i'
+  get_value: '/^service instance (\d+) vni/'
 
 create_destroy:
-  config_set: ['interface <name>', '<state> service instance <sid> vni']
+  set_context:
+    - 'interface <name>'
+  set_value: '<state> service instance <sid> vni'
 
 encapsulation_profile_vni:
-  config_get_token_append: '/encapsulation profile (\S+)  default/'
-  config_set_append: '<state> encapsulation profile <profile> default'
+  get_value: '/encapsulation profile (\S+)  default/'
+  set_value: '<state> encapsulation profile <profile> default'
   default_value: ''
 
 shutdown:
-  /N7/:
+  N7k:
     kind: boolean
-    config_get_token_append: '/^(?:no )?shutdown$/'
-    config_set_append: "<state> shutdown"
+    get_value: '/^(?:no )?shutdown$/'
+    set_value: "<state> shutdown"
     default_value: true
   else:
     default_value: false

data/lib/cisco_node_utils/cmd_ref/inventory.yaml

@@ -1,45 +1,40 @@
 # inventory
 ---
 _template:
-  cli_nexus:
-    config_get: 'show inventory'
-    test_config_get: 'show inventory | no-more'
+  get_command: 'show inventory'
+  ios_xr:
+    data_format: cli
+  nexus:
+    data_format: nxapi_structured
 
 all:
   multiple: true
-  cli_nexus:
-    config_get_token: ["TABLE_inv", "ROW_inv"]
+  nexus:
+    get_context: ["TABLE_inv", "ROW_inv"]
 
 chassis:
-  cli_nexus:
-    config_get_token: ["TABLE_inv", "ROW_inv", {'name': '"Chassis"'}]
-
-inventory:
-  # TODO: clean this up
-  /N7/:
-    test_config_get_regex: [
-    '/.*\nNAME: "(.+)",\s+DESCR: "(.+)"\s+\nPID: (\S+)\s+,\s+VID: (.+) ,\s+SN: (.+)\s+\n/',
-    '/.*NAME: "(.+)",\s+DESCR: "(.+)"\s+PID: (\S+)\s+,\s+VID: (.+) ,\s+SN: (.+)\s+\n/'
-    ]
-  /N9K/:
-    test_config_get_regex: [
-    '/.*\nNAME: "(.+)",\s+DESCR: "(.+)"\s+\nPID: (\S+)\s+,\s+VID: (.+) ,\s+SN: (.+)\s+\n/',
-    '/.*NAME: "(.+)",\s+DESCR: "(.+)"\s+PID: (\S+)\s+,\s+VID: (.+) ,\s+SN: (.+)\s+\n/'
-    ]
-  else:
-    test_config_get_regex: [
-    '/.*\nNAME: "(.+)",\s+DESCR: "(.+)"\nPID: (\S+)\s+, VID: (.+) , SN: (.+)\n/',
-    '/.*\nNAME: "(.+)",\s+DESCR: "(.+)"\nPID: (\S+)\s+, VID: (.+) , SN: (.+)\n/'
-    ]
+  nexus:
+    # Get all the inventory and we'll filter it down to the chassis
+    multiple: true
+    get_context: ["TABLE_inv", "ROW_inv"]
 
 productid:
-  cli_nexus:
-    config_get_token: ["TABLE_inv", "ROW_inv", 0, "productid"]
+  ios_xr:
+    get_value: '/"Rack 0".*\n.*PID: ([^ ,]+)/'
+  nexus:
+    get_context: ["TABLE_inv", "ROW_inv", '0']
+    get_value: "productid"
 
 serialnum:
-  cli_nexus:
-    config_get_token: ["TABLE_inv", "ROW_inv", 0, "serialnum"]
+  ios_xr:
+    get_value: '/"Rack 0".*\n.*SN: ([^ ,]+)/'
+  nexus:
+    get_context: ["TABLE_inv", "ROW_inv", '0']
+    get_value: "serialnum"
 
 versionid:
-  cli_nexus:
-    config_get_token: ["TABLE_inv", "ROW_inv", 0, "vendorid"]
+  ios_xr:
+    get_value: '/"Rack 0".*\n.*VID: ([^ ,]+)/'
+  nexus:
+    get_context: ["TABLE_inv", "ROW_inv", '0']
+    get_value: "vendorid"

data/lib/cisco_node_utils/cmd_ref/itd_device_group.yaml

@@ -0,0 +1,83 @@
+# itd_device_group
+---
+_exclude: [N3k, N5k, N6k, N8k, ios_xr]
+
+_template:
+  get_command: "show running-config all | section itd"
+  get_context:
+      - '/^itd device-group <name>/'
+      - '(?)/^node <ntype> <nname>/'
+  set_context: ["itd device-group <name>", "(?)node <ntype> <nname>"]
+
+all_itd_device_group_nodes:
+  multiple:
+  get_context: ['/^itd device-group <name>/']
+  get_value: '/^node (\S+) (\S+)/'
+
+all_itd_device_groups:
+  multiple:
+  get_context: ~
+  get_value: '/^itd device-group (\S+)/'
+
+create:
+  set_context: ~
+  set_value: "itd device-group <name>"
+
+create_node:
+  set_context: ["itd device-group <name>"]
+  set_value: "node <ntype> <nname>"
+
+destroy:
+  set_context: ~
+  set_value: "no itd device-group <name>"
+
+destroy_node:
+  set_context: ["itd device-group <name>"]
+  set_value: "no node <ntype> <nname>"
+
+hot_standby:
+  kind: boolean
+  get_value: '/^mode hot-standby/'
+  set_value: "<state> mode hot-standby"
+  default_value: false
+
+probe:
+  get_value: '/^probe .+$/'
+  set_value: "probe <type> <dns_host> <port> <control> <frequency> <timeout> <retry_down_count> <retry_up_count>"
+
+probe_control:
+  kind: boolean
+  default_value: false
+
+probe_dns_host:
+  kind: string
+
+probe_frequency:
+  kind: int
+  default_value: 10
+
+probe_port:
+  kind: int
+
+probe_retry_down:
+  kind: int
+  default_value: 3
+
+probe_retry_up:
+  kind: int
+  default_value: 3
+
+probe_timeout:
+  kind: int
+  default_value: 5
+
+probe_type:
+  kind: string
+  set_value: "<state> probe icmp"
+  default_value: false
+
+weight:
+  kind: int
+  get_value: '/^weight (\d+)/'
+  set_value: "<state> weight <weight>"
+  default_value: 1

data/lib/cisco_node_utils/cmd_ref/itd_service.yaml

@@ -0,0 +1,119 @@
+# itd_service
+---
+_exclude: [N3k, N5k, N6k, N8k, ios_xr]
+
+_template:
+  get_command: "show running-config all | section itd"
+  get_context: ['/^itd <name>/']
+  set_context: ["itd <name>"]
+
+access_list:
+  kind: string
+  get_value: '/^access-list (\S+)$/'
+  set_value: "<state> access-list <al>"
+  default_value: ''
+
+all_itds:
+  multiple:
+  get_context: ~
+  get_value: '/^itd (\S+)/'
+
+create:
+  set_context: ~
+  set_value: "itd <name>"
+
+destroy:
+  set_context: ~
+  set_value: "no itd <name>"
+
+device_group:
+  kind: string
+  get_value: '/^device-group (\S+)$/'
+  set_value: "<state> device-group <dg>"
+  default_value: ''
+
+exclude_access_list:
+  kind: string
+  get_value: '/^exclude access-list (\S+)$/'
+  set_value: "<state> exclude access-list <al>"
+  default_value: ''
+
+fail_action:
+  kind: boolean
+  get_value: '/^failaction node reassign/'
+  set_value: "<state> failaction node reassign"
+  default_value: false
+
+ingress_interface:
+  multiple:
+  get_value: '/^ingress interface (\S+)(?: next-hop (\S+))*/'
+  set_value: "<state> ingress interface <interface> <next> <nhop>"
+  default_value: []
+
+load_bal_buckets:
+  kind: int
+  default_value: false
+
+load_bal_enable:
+  kind: boolean
+  default_value: false
+
+load_bal_mask_pos:
+  kind: int
+  default_value: false
+
+load_bal_method_bundle_hash:
+  kind: string
+  default_value: ''
+
+load_bal_method_bundle_select:
+  kind: string
+  default_value: ''
+
+load_bal_method_end_port:
+  kind: int
+  default_value: false
+
+load_bal_method_proto:
+  kind: string
+  default_value: ''
+
+load_bal_method_start_port:
+  kind: int
+  default_value: false
+
+load_balance:
+  get_value: '/^load-balance .+$/'
+  set_value: "<state> load-balance <bundle_select> <bundle_hash> <proto> <start_port> <endPort> <buckets> <mask>"
+
+nat_destination:
+  _exclude: [N9k]
+  kind: boolean
+  get_value: '/^nat destination$/'
+  set_value: "<state> nat destination"
+  default_value: false
+
+peer_local:
+  _exclude: [N7k]
+  get_value: '/^peer local service (\S+)$/'
+  set_value: "<state> peer local service <service>"
+  default_value: ''
+
+peer_vdc:
+  _exclude: [N9k]
+  get_value: '/^peer vdc (\S+) service (\S+)$/'
+  set_value: "<state> peer vdc <vdc> service <service>"
+  default_value: []
+
+shutdown:
+  kind: boolean
+  auto_default: true
+  get_value: '/^no shut$/'
+  set_value: "<state> shutdown"
+  default_value: true
+
+virtual_ip:
+  multiple:
+  get_value: '/^virtual (.*)/'
+  set_value : "<state> virtual <string>"
+  default_value: []