cisco_node_utils 1.2.0 → 1.3.0

data/lib/cisco_node_utils/cmd_ref/vrf.yaml

@@ -1,88 +1,84 @@
 # vrf.yaml
 ---
 _template:
-  config_get: "show running all | section '^vrf context'"
-  config_get_token: '/^vrf context <vrf>$/'
-  config_get_token_append:
-    - '/^address-family <afi> <safi>$/'
-  config_set: 'vrf context <vrf>'
-  config_set_append:
-    - 'address-family <afi> <safi>'
+  nexus:
+    get_command: "show running all | section '^vrf context'"
+    context:
+      - 'vrf context <vrf>'
+  ios_xr:
+    get_command: "show run vrf"
+    context:
+      - 'vrf <vrf>'
 
 address_family:
-  config_set: ['vrf context <vrf>', '<state> address-family <afi> <safi>']
-
-all_vrf_afs:
-  multiple: true
-  config_get_token_append: '/^address-family (\S+) (\S+)$/'
+  set_value: '<state> address-family <afi> <safi>'
 
 all_vrfs:
   multiple: true
-  config_get_token: '/^vrf context (.*)/'
+  context: ~
+  nexus:
+    get_value: '/^vrf context (.*)/'
+  ios_xr:
+    get_value: '/^vrf (.*)/'
 
 create:
-  config_set:  'vrf context <vrf>'
+  context: ~
+  nexus:
+    set_value:  'vrf context <vrf>'
+  ios_xr:
+    set_value:  'vrf <vrf>'
 
 description:
-  config_get_token_append: '/^description (.*)/'
-  config_set_append: '<state> description <desc>'
+  get_value: '/^description (.*)/'
+  set_value: '<state> description <desc>'
   kind: string
   default_value: ''
 
 destroy:
-  config_set: 'no vrf context <vrf>'
+  context: ~
+  nexus:
+    set_value: 'no vrf context <vrf>'
+  ios_xr:
+    set_value: 'no vrf <vrf>'
 
-route_distinguisher:
-  config_get_token_append: '/^rd (\S+)$/'
-  config_set_append: '<state> rd <rd>'
+mhost_default_interface:
+  _exclude: [nexus]
+  get_value: '/^mhost <afi> default-interface (\S+)$/'
+  set_value: '<state> mhost <afi> default-interface <intf>'
   default_value: ''
 
-route_target_both_auto:
-  kind: boolean
-  config_get_token_append: '/^route-target both auto$/'
-  config_set_append: '<state> route-target both auto'
-  default_value: false
-
-route_target_both_auto_evpn:
+remote_route_filtering:
+  _exclude: [nexus]
   kind: boolean
-  config_get_token_append: '/^route-target both auto evpn$/'
-  config_set_append: '<state> route-target both auto evpn'
-  default_value: false
+  get_value: '/^remote-route-filtering disable$/'
+  set_value: '<state> remote-route-filtering disable'
+  default_value: true
 
-route_target_export:
-  multiple: true
-  config_get_token_append: '/^route-target export (\S+)$/'
-  config_set_append: '<state> route-target export <community>'
-  default_value: []
-
-route_target_export_evpn:
-  multiple: true
-  config_get_token_append: '/^route-target export (\S+) evpn$/'
-  config_set_append: '<state> route-target export <community> evpn'
-  default_value: []
-
-route_target_import:
-  multiple: true
-  config_get_token_append: '/^route-target import (\S+)$/'
-  config_set_append: '<state> route-target import <community>'
-  default_value: []
-
-route_target_import_evpn:
-  multiple: true
-  config_get_token_append: '/^route-target import (\S+) evpn$/'
-  config_set_append: '<state> route-target import <community> evpn'
-  default_value: []
+route_distinguisher:
+  # Only configurable under BGP in IOS XR, not under VRF context
+  _exclude: [ios_xr]
+  get_value: '/^rd (\S+)$/'
+  set_value: '<state> rd <rd>'
+  default_value: ''
 
 shutdown:
+  _exclude: [ios_xr]
   kind: boolean
-  config_get_token_append: '/^shutdown$/'
-  config_set_append: '<state> shutdown'
+  get_value: '/^shutdown$/'
+  set_value: '<state> shutdown'
   default_value: false
 
 vni: # TBD Should this move to the vni provider as vrf_vni?
   # MT-lite only
-  /N9/:
+  N9k:
     kind: int
-    config_get_token_append: '/^vni (\d+)$/'
-    config_set_append: '<state> vni <id>'
+    get_value: '/^vni (\d+)$/'
+    set_value: '<state> vni <id>'
     default_value: false
+
+vpn_id:
+  _exclude: [nexus]
+  get_value: '/^vpn id (\S+)$/'
+  set_value: '<state> vpn id <vpnid>'
+  default_value: ''
+

data/lib/cisco_node_utils/cmd_ref/vrf_af.yaml

@@ -0,0 +1,118 @@
+# vrf_af.yaml
+---
+_template:
+  nexus:
+    get_command: "show running all | section '^vrf context'"
+    context:
+      - 'vrf context <vrf>'
+      - 'address-family <afi> <safi>'
+  ios_xr:
+    get_command: "show run vrf"
+    context:
+      - 'vrf <vrf>'
+      - 'address-family <afi> <safi>'
+
+all_afs:
+  multiple: true
+  get_value: '/^address-family (\S+) (\S+)$/'
+  nexus:
+    context: ['vrf context <vrf>']
+  ios_xr:
+    context: ['vrf <vrf>']
+
+route_policy_export:
+  default_value: ~
+  nexus:
+    get_value: '/^export map (\S+)$/'
+    set_value: '<state> export map <policy_name>'
+  ios_xr:
+    get_value: '/^export route-policy (\S+)$/'
+    set_value: '<state> export route-policy <policy_name>'
+
+route_policy_import:
+  default_value: ~
+  nexus:
+    get_value: '/^import map (\S+)$/'
+    set_value: '<state> import map <policy_name>'
+  ios_xr:
+    get_value: '/^import route-policy (\S+)$/'
+    set_value: '<state> import route-policy <policy_name>'
+
+route_target_both_auto:
+  _exclude: [N3k, ios_xr]
+  kind: boolean
+  get_value: '/^route-target both auto$/'
+  set_value: '<state> route-target both auto'
+  default_value: false
+
+route_target_both_auto_evpn:
+  _exclude: [N3k, ios_xr]
+  kind: boolean
+  get_value: '/^route-target both auto evpn$/'
+  set_value: '<state> route-target both auto evpn'
+  default_value: false
+
+route_target_export:
+  multiple: true
+  default_value: []
+  nexus:
+    get_value: '/^route-target export (\S+)$/'
+    set_value: '<state> route-target export <community>'
+  ios_xr:
+    get_context:
+      - '/^vrf <vrf>$/i'
+      - '/^address-family <afi> <safi>$/'
+      - '/^export route-target$/'
+    get_value: '/^(\S+)$/'
+    set_value: '<state> export route-target <community>'
+
+route_target_export_evpn:
+  _exclude: [N3k, ios_xr]
+  multiple: true
+  get_value: '/^route-target export (\S+) evpn$/'
+  set_value: '<state> route-target export <community> evpn'
+  default_value: []
+
+route_target_export_stitching:
+  _exclude: [nexus]
+  multiple: true
+  get_context:
+    - '/^vrf <vrf>$/i'
+    - '/^address-family <afi> <safi>$/'
+    - '/^export route-target$/'
+  get_value: '/^(\S+) stitching$/'
+  set_value: '<state> export route-target <community> stitching'
+  default_value: []
+
+route_target_import:
+  multiple: true
+  default_value: []
+  nexus:
+    get_value: '/^route-target import (\S+)$/'
+    set_value: '<state> route-target import <community>'
+  ios_xr:
+    get_context:
+      - '/^vrf <vrf>$/i'
+      - '/^address-family <afi> <safi>$/'
+      - '/^import route-target$/'
+    get_value: '/^(\S+)$/'
+    set_value: '<state> import route-target <community>'
+
+route_target_import_evpn:
+  _exclude: [N3k, ios_xr]
+  multiple: true
+  get_value: '/^route-target import (\S+) evpn$/'
+  set_value: '<state> route-target import <community> evpn'
+  default_value: []
+
+route_target_import_stitching:
+  _exclude: [nexus]
+  multiple: true
+  get_context:
+    - '/^vrf <vrf>$/i'
+    - '/^address-family <afi> <safi>$/'
+    - '/^import route-target$/'
+  get_value: '/^(\S+) stitching$/'
+  set_value: '<state> import route-target <community> stitching'
+  default_value: []
+

data/lib/cisco_node_utils/cmd_ref/vtp.yaml

@@ -1,38 +1,32 @@
 # vtp
 ---
-domain:
-  config_get: "show vtp status"
-  config_get_token: "domain_name"
-  config_set: "vtp domain %s"
+_exclude: [ios_xr]
 
-feature:
-  kind: boolean
-  config_get: "show running vtp"
-  config_get_token: '/^feature vtp$/'
-  config_set: "%s feature vtp"
-  default_value: false
+# VTP behaves differently across the various Nexus platforms and as a
+# result it's not currently possible to use a single 'show running'
+# command to query the device state.
+domain:
+  get_command: "show vtp status"
+  get_value: '/^VTP\s+Domain\s+Name\s+:\s+(\S+)$/'
+  set_value: "vtp domain <domain>"
+  default_value: ""
 
 filename:
-  config_get: "show running vtp"
-  config_get_token: '/vtp file (\S+)/'
-  config_set: "%s vtp file %s"
+  get_command: "show running-config vtp all"
+  get_value: '/vtp\s+file\s+(\S+)/'
+  set_value: "<state> vtp file <uri>"
   default_value: "bootflash:/vlan.dat"
 
 password:
-  config_get: "show vtp password"
-  config_get_token: "passwd"
-  config_set: "%s vtp password %s"
+  get_data_format: nxapi_structured
+  get_command: "show vtp password"
+  get_value: "passwd"
+  set_value: "<state> vtp password <password>"
   default_value: ""
 
 version:
   kind: int
-  config_get: "show vtp status"
-  config_get_token: '/VTP\s+version\s+running\s+:\s+(\d+)/'
-  config_set: "vtp version %s"
+  get_command: "show vtp status"
+  get_value: '/^VTP\s+version\s+running\s+:\s+(\d+)$/'
+  set_value: "vtp version <version>"
   default_value: 1
-  /N7/:
-    test_config_result:
-      3: 3
-  else:
-    test_config_result:
-      3: "Cisco::CliError"

data/lib/cisco_node_utils/cmd_ref/vxlan_vtep.yaml

@@ -1,26 +1,26 @@
 # vxlan_vtep
 ---
-_exclude: [/N(3|5|6)/]
+_exclude: [N3k, ios_xr]
 
 _template:
-  config_get: "show running-config interface all | section 'interface nve'"
-  config_get_token: '/^interface <name>$/i'
-  config_set: 'interface <name>'
+  get_command: "show running-config interface all | section 'interface nve'"
+  context:
+    - 'interface <name>'
 
 all_interfaces:
   multiple:
-  config_get_token: '/^interface (.*)$/'
+  get_context: ~
+  get_value: '/^interface (.*)$/'
 
 host_reachability:
-  /N(7|9)/:
-    config_get_token_append: '/^host-reachability protocol (\S+)/'
-    config_set_append: '<state> host-reachability protocol <proto>'
-    default_value: 'flood'
+  get_value: '/^host-reachability protocol (\S+)/'
+  set_value: '<state> host-reachability protocol <proto>'
+  default_value: 'flood'
 
 mt_full_support:
   # This is only used for determining support for Multi-Tenancy Full
   kind: boolean
-  /N(7)/:
+  N7k:
     default_only: true
   else:
     # this feature is always off on these platforms and cannot be changed
@@ -29,32 +29,42 @@ mt_full_support:
 mt_lite_support:
   # This is only used for determining support for Multi-Tenancy Lite
   kind: boolean
-  /N9/:
+  N9k: &mt_lite_default
     default_only: true
+  N8k: *mt_lite_default
+  N6k: *mt_lite_default
+  N5k: *mt_lite_default
   else:
     # this feature is always off on these platforms and cannot be changed
     default_only: false
 
 shutdown:
   kind: boolean
-  config_get_token_append: '/^no shutdown$/'
-  config_set_append: '<state> shutdown'
+  get_value: '/^no shutdown$/'
+  set_value: '<state> shutdown'
   default_value: true
 
 source_intf:
-  config_get_token_append: '/^source\-interface (\S+)$/'
-  config_set_append: '<state> source-interface <lpbk_intf>'
+  get_value: '/^source\-interface (\S+)$/'
+  set_value: '<state> source-interface <lpbk_intf>'
+  default_value: ''
+
+source_intf_hold_down_time:
+  _exclude: [N5k, N6k, N7k, N8k]
+  kind: int
+  get_value: '/^source-interface hold-down-time (\d+)$/'
+  set_value: '<state> source-interface hold-down-time <time>'
   default_value: ''
 
 vni:
-  config_set_append: '<state> member vni <vni> <assoc_vrf>'
+  set_value: '<state> member vni <vni> <assoc_vrf>'
 
 vni_with_vrf:
   kind: boolean
-  config_get_token_append: '/^member vni <vni> associate-vrf$/'
+  get_value: '/^member vni <vni> associate-vrf$/'
   default_value: false
 
 vni_without_vrf:
   kind: boolean
-  config_get_token_append: '/^member vni <vni>$/'
+  get_value: '/^member vni <vni>$/'
   default_value: false

data/lib/cisco_node_utils/cmd_ref/vxlan_vtep_vni.yaml

@@ -1,39 +1,56 @@
 # vxlan_vtep_vni
 ---
-_exclude: [/N(3|5|6)/]
+_exclude: [N3k, ios_xr]
 
 _template:
-  config_get: "show running-config interface all | section 'interface nve'"
-  config_get_token: '/^interface <name>$/i'
-  config_get_token_append:
-    - '/^member vni <vni> ?(associate-vrf)?$/'
-  config_set: 'interface <name>'
-  config_set_append:
-    - 'member vni <vni> <assoc_vrf>'
+  get_command: "show running-config interface all | section 'interface nve'"
+  get_context:
+    - '/^interface <name>$/i'
+    - '(?)/^member vni <vni> ?(associate-vrf)?$/'
+  set_context:
+    - 'interface <name>'
+    - '(?)member vni <vni> <assoc_vrf>'
 
 all_vnis:
   multiple:
-  config_get_token_append: '/^member vni (\d+|\d+-\d+) ?(associate-vrf)?$/'
+  get_value: '/^member vni (\d+|\d+-\d+) ?(associate-vrf)?$/'
 
 ingress_replication:
+  _exclude: [N5k, N6k, N7k]
   kind: string
-  config_get_token_append: '/^ingress-replication protocol (\S+)$/'
-  config_set_append: '<state> ingress-replication protocol <protocol>'
+  get_value: '/^ingress-replication protocol (\S+)$/'
+  set_value: '<state> ingress-replication protocol <protocol>'
   default_value: ''
 
 multicast_group:
-  config_get_token_append: '/^mcast-group (\S+)\s?(\S+)?$/'
-  config_set_append: '<state> mcast-group <ip_start> <ip_end>'
+  get_value: '/^mcast-group (\S+)\s?(\S+)?$/'
+  set_value: '<state> mcast-group <ip_start> <ip_end>'
   default_value: ''
 
 peer_list:
+  _exclude: [N5k, N6k, N7k]
   multiple:
-  config_get_token_append: ['/^ingress-replication protocol static$/', '/^peer-ip (\S+)$/']
-  config_set_append: ['ingress-replication protocol static', '<state> peer-ip <peer>']
+  get_context:
+    - '/^interface <name>$/i'
+    - '/^member vni <vni>?$/'
+    - '/^ingress-replication protocol static$/'
+  set_context:
+    - 'interface <name>'
+    - 'member vni <vni>'
+    - 'ingress-replication protocol static'
+  get_value: '/^peer-ip (\S+)$/'
+  set_value: '<state> peer-ip <peer>'
   default_value: []
 
 suppress_arp:
   kind: boolean
-  config_get_token_append: '/^suppress-arp$/'
-  config_set_append: '<state> suppress-arp'
+  get_value: '/^suppress-arp$/'
+  set_value: '<state> suppress-arp'
+  default_value: false
+
+suppress_uuc:
+  _exclude: [N7k, N8k, N9k]
+  kind: boolean
+  get_value: '/^suppress-unknown-unicast$/'
+  set_value: '<state> suppress-unknown-unicast'
   default_value: false