cisco_node_utils 1.2.0 → 1.3.0

data/lib/cisco_node_utils/cmd_ref/encapsulation.yaml

@@ -0,0 +1,25 @@
+# encapsulation_profile_vni
+# encapsulation_profile_vni feature is available only on n7k
+---
+_exclude: [N3k, N5k, N6k, N8k, N9k, ios_xr]
+
+all_encaps:
+  multiple: true
+  get_command: "show running-config vni"
+  get_value: '/^encapsulation profile vni (\S+)/'
+
+create:
+  set_value: "encapsulation profile vni <profile>"
+
+destroy:
+  set_value: "no encapsulation profile vni <profile>"
+
+# Eg:
+# encapsulation profile vni my_vni_profile
+#   [no] dot1q 100-200, 300 vni 5000-5100, 5300
+dot1q_map:
+  get_command: "show encapsulation profile"
+  get_value: '/^.* vni <profile>\s+dot1q ([\d\s,-]+) vni ([\d\s,-]+)$/'
+  set_context: ['encapsulation profile vni <profile>']
+  set_value: '<state> dot1q <vlans> vni <vnis>'
+  default_value: []

data/lib/cisco_node_utils/cmd_ref/evpn_vni.yaml

@@ -1,42 +1,48 @@
 # evpn_vni.yaml
 ---
+_exclude: [ios_xr]
+
 _template:
-  config_get: "show running bgp all"
-  config_get_token: '/^evpn$/'
-  config_get_token_append: 
+  get_command: "show running bgp all"
+  get_context:
+    - '/^evpn$/'
     - '/^vni <vni> l2$/'
-  config_set: 'evpn'
-  config_set_append: 
+  set_context:
+    - 'evpn'
     - "vni <vni> l2"
 
 evpn:
-  config_get_token: "/^evpn$/"
-  config_set: "<state> evpn"
+  get_context: ~
+  get_value: "/^evpn$/"
+  set_context: ~
+  set_value: "<state> evpn"
 
 route_distinguisher:
-  config_get_token_append: '/^rd (\S+)$/'
-  config_set_append: "<state> rd <rd>"
+  get_value: '/^rd (\S+)$/'
+  set_value: "<state> rd <rd>"
   default_value: ""
 
 route_target_both:
-  config_get_token_append: '/^route-target both (\S+)$/'
-  config_set_append: "<state> route-target both <community>"
+  get_value: '/^route-target both (\S+)$/'
+  set_value: "<state> route-target both <community>"
   multiple: true
   default_value: []
 
 route_target_export:
-  config_get_token_append: '/^route-target export (\S+)$/'
-  config_set_append: "<state> route-target export <community>"
+  get_value: '/^route-target export (\S+)$/'
+  set_value: "<state> route-target export <community>"
   multiple: true
   default_value: []
 
 route_target_import:
-  config_get_token_append: '/^route-target import (\S+)$/'
-  config_set_append: "<state> route-target import <community>"
+  get_value: '/^route-target import (\S+)$/'
+  set_value: "<state> route-target import <community>"
   multiple: true
   default_value: []
 
 vni:
   multiple: true
-  config_get_token_append: '/^vni\s+(\S+)\s+l2$/'
-  config_set: ["evpn", "<state> vni <vni> l2", "end"]
+  get_context: ['/^evpn$/']
+  get_value: '/^vni\s+(\S+)\s+l2$/'
+  set_context: ['evpn']
+  set_value: "<state> vni <vni> l2"

data/lib/cisco_node_utils/cmd_ref/fabricpath.yaml

@@ -1,172 +1,183 @@
 # fabricpath
 ---
-# Fabricpath feature is not available on N3K and N9K
-_exclude: [/N3/, /N9K/]
+_exclude: [N3k, N8k, N9k, ios_xr]
 
 aggregate_multicast_routes:
-  _exclude: [/N5K/, /N6K/]
+  _exclude: [N5k, N6k]
   kind: boolean
-  config_get: "show run fabricpath all"
-  config_get_token: '/^fabricpath multicast aggregate\-routes\s*$/'
-  config_set: "<state> fabricpath multicast aggregate-routes"
+  get_command: "show run fabricpath all"
+  get_value: '/^fabricpath multicast aggregate\-routes\s*$/'
+  set_value: "<state> fabricpath multicast aggregate-routes"
   default_value: false
-  
+
 allocate_delay:
   kind: int
-  config_get: "show run fabricpath all"
-  config_get_token: '/^fabricpath timers allocate\-delay (\d+)/'
-  config_set: "<state> fabricpath timers allocate-delay <delay>"
+  get_command: "show run fabricpath all"
+  get_value: '/^fabricpath timers allocate\-delay (\d+)/'
+  set_value: "<state> fabricpath timers allocate-delay <delay>"
   default_value: 10
 
-auto_switch_id: 
+auto_switch_id:
   kind: int
-  config_get: "show fabricpath switch-id"
-  config_get_token: '/^\*\s+(\d+).*No\s*$/'
+  get_command: "show fabricpath switch-id"
+  get_value: '/^\*\s+(\d+).*No\s*$/'
 
 feature:
-  config_get: "show feature-set"
-  config_get_token: '/^fabricpath[\s]+[\d]+[\s]+(\S+)/'
-  config_set: "<state> feature-set fabricpath"
+  get_command: "show feature-set"
+  get_value: '/^fabricpath[\s]+[\d]+[\s]+(\S+)/'
+  set_value: "<state> feature-set fabricpath"
   default_value: disabled
 
 feature_install:
-  config_set: "<state> install feature-set fabricpath"
+  set_value: "<state> install feature-set fabricpath"
 
 graceful_merge:
   auto_default: false
-  kind: boolean
-  config_get: "show run fabricpath all"
-  config_get_token: '/^fabricpath graceful\-merge disable\s*$/'
-  config_set: "<state> fabricpath graceful-merge disable"
-  default_value: true
+  get_command: "show run fabricpath all"
+  get_value: '/^fabricpath graceful-merge disable\s*$/'
+  set_value: "<state> fabricpath graceful-merge disable"
+  default_value: enable
 
 linkup_delay:
   kind: int
-  config_get: "show run fabricpath all"
-  config_get_token: '/^fabricpath timers linkup-delay (\d+)\s*$/'
-  config_set: "<state> fabricpath timers linkup-delay <delay>"
+  get_command: "show run fabricpath all"
+  get_value: '/^fabricpath timers linkup\-delay (\d+)\s*$/'
+  set_value: "<state> fabricpath timers linkup-delay <delay>"
   default_value: 10
 
 linkup_delay_always:
-  _exclude: [/N5K/, /N6K/]
+  _exclude: [N5k, N6k]
   kind: boolean
-  config_get: "show run fabricpath all"
-  config_get_token: '/^fabricpath timers linkup-delay always\s*$/'
-  config_set: "<state> fabricpath timers linkup-delay always"
+  get_command: "show run fabricpath all"
+  get_value: '/^fabricpath timers linkup\-delay always\s*$/'
+  set_value: "<state> fabricpath timers linkup-delay always"
   default_value: false
-  
+
 linkup_delay_enable:
-  _exclude: [/N5K/, /N6K/]
+  _exclude: [N5k, N6k]
   auto_default: false
   kind: boolean
-  config_get: "show run fabricpath all"
-  config_get_token: '/^fabricpath linkup-delay\s*$/'
-  config_set: "<state> fabricpath linkup-delay"
+  get_command: "show run fabricpath all"
+  get_value: '/^fabricpath linkup\-delay\s*$/'
+  set_value: "<state> fabricpath linkup-delay"
   default_value: true
-  
+
 loadbalance_algorithm:
   kind: string
-  config_get: "show run fabricpath all"
-  config_get_token: '/^fabricpath load-balance (\S+)\s*$/'
-  config_set: "<state> fabricpath load-balance <algo>"
-  /N5K/:
+  get_command: "show run fabricpath all"
+  get_value: '/^fabricpath load\-balance (\S+)\s*$/'
+  set_value: "<state> fabricpath load-balance <algo>"
+  N5k: &loadbal_alg_src_dst
     default_value: "source-destination"
+  N6k: *loadbal_alg_src_dst
   else:
     default_value: "symmetric"
 
+loadbalance_algorithm_symmetric_support:
+  _exclude: [N5k, N6k]
+  kind: boolean
+  default_only: true
+
 loadbalance_multicast_has_vlan:
-  _exclude: [/N5K/, /N6K/]
+  _exclude: [N5k, N6k]
   kind: boolean
   auto_default: false
-  config_get: "show fabricpath load-balance | begin Ftag"
-  config_get_token: '/^Use VLAN: TRUE\s*$/'
+  get_command: 'show run fabricpath all'
+  get_value: '/^fabricpath load-balance multicast .*include-vlan/'
   default_value: true
 
 loadbalance_multicast_reset:
-  _exclude: [/N5K/, /N6K/]
-  config_set: "no fabricpath load-balance multicast"
+  _exclude: [N5k, N6k]
+  set_value: "no fabricpath load-balance multicast"
 
 loadbalance_multicast_rotate:
-  _exclude: [/N5K/, /N6K/]
+  _exclude: [N5k, N6k]
   kind: int
-  config_get: "show fabricpath load-balance | begin Ftag"
-  config_get_token: '/^Rotate amount: (\d+)/'
-  default_value: 1
- 
+  get_command: "show fabricpath load-balance | begin Ftag"
+  get_value: '/^Rotate amount: (\d+)/'
+  # default_value: n/a. The default rotate amount is randomized to avoid polarization.
+
 loadbalance_multicast_set:
-  _exclude: [/N5K/, /N6K/]
-  config_set: 'fabricpath load-balance multicast <rotate_amt> <inc_vlan>'
+  _exclude: [N5k, N6k]
+  set_value: 'fabricpath load-balance multicast <rotate> <has_vlan>'
 
 loadbalance_unicast_has_vlan:
   kind: boolean
   auto_default: false
-  config_get: "show fabricpath load-balance | begin ECMP next 4"
-  config_get_token: '/^Use VLAN: TRUE\s*$/'
-  config_set: "<state> fabricpath load-balance unicast include-vlan"
+  get_command: 'show run fabricpath all'
+  get_value: '/^fabricpath load-balance unicast .*include-vlan/'
+  set_value: "<state> fabricpath load-balance unicast include-vlan"
   default_value: true
 
 loadbalance_unicast_layer:
   kind: string
-  config_get: "show fabricpath load-balance | begin ECMP next 4"
-  config_get_token: '/^L3\/L4 Preference: (\S+)/'
-  config_set: "<state> fabricpath load-balance unicast <pref>"
+  get_command: "show fabricpath load-balance | begin ECMP next 4"
+  get_value: '/^L3\/L4 Preference: (\S+)/'
+  set_value: "<state> fabricpath load-balance unicast <layer>"
   default_value: "mixed"
 
 loadbalance_unicast_reset:
-  config_set: "no fabricpath load-balance unicast"
+  set_value: "no fabricpath load-balance unicast"
 
 loadbalance_unicast_rotate:
-  _exclude: [/N5K/, /N6K/]
+  _exclude: [N5k, N6k]
   kind: int
-  config_get: "show fabricpath load-balance | begin ECMP next 4"
-  config_get_token: '/^Rotate amount: (\d+)/'
-  default_value: 1
+  get_command: "show fabricpath load-balance | begin ECMP next 4"
+  get_value: '/^Rotate amount: (\d+)/'
+  # default_value: n/a. The default rotate amount is randomized to avoid polarization.
 
 loadbalance_unicast_set:
-  config_set: 'fabricpath load-balance unicast <pref> <rotate_amt> <inc_vlan>'
+  set_value: 'fabricpath load-balance unicast <layer> <rotate> <has_vlan>'
 
 loadbalance_unicast_support:
   kind: string
-  /N5K/:
-    default_only: "split"
-  /N6K/:
+  N5k: &loadbal_uni_split
     default_only: "split"
+  N6k: *loadbal_uni_split
   else:
     default_only: "combined"
 
 mode:
   kind: string
-  config_get: "show run fabricpath all"
-  config_get_token: '/^fabricpath mode (\S+)/'
-  config_set: "<state> fabricpath mode transit"
+  get_command: "show run fabricpath all"
+  get_value: '/^fabricpath mode (\S+)/'
+  set_value: "<state> fabricpath mode transit"
   default_value: "normal"
 
+supported_module_pids:
+  _exclude: [N5k, N6k]
+  default_only: 'N7[K7]-(?:F2.*2.E|F3|F4|M3)'
+
+supported_modules:
+  _exclude: [N5k, N6k]
+  default_only: "f2e f3"
+
 switch_id:
   kind: int
-  config_get: "show run fabricpath all"
-  config_get_token: '/^fabricpath switch-id (\d+)\s*$/'
-  config_set: "fabricpath switch-id <swid>"
+  get_command: "show run fabricpath all"
+  get_value: '/^fabricpath switch\-id (\d+)\s*$/'
+  set_value: "fabricpath switch-id <swid>"
 
 transition_delay:
   kind: int
-  config_get: "show run fabricpath all"
-  config_get_token: '/^fabricpath timers transition\-delay (\d+)\s*$/'
-  config_set: "<state> fabricpath timers transition-delay <delay>"
+  get_command: "show run fabricpath all"
+  get_value: '/^fabricpath timers transition\-delay (\d+)\s*$/'
+  set_value: "<state> fabricpath timers transition-delay <delay>"
   default_value: 10
 
 ttl_multicast:
-  _exclude: [/N5K/, /N6K/]
+  _exclude: [N5k, N6k]
   kind: int
-  config_get: "show run fabricpath all"
-  config_get_token: '/^fabricpath ttl multicast (\d+)\s*$/'
-  config_set: "<state> fabricpath ttl multicast <ttl>"
+  get_command: "show run fabricpath all"
+  get_value: '/^fabricpath ttl multicast (\d+)\s*$/'
+  set_value: "<state> fabricpath ttl multicast <ttl>"
   default_value: 32
 
 ttl_unicast:
-  _exclude: [/N5K/, /N6K/]
+  _exclude: [N5k, N6k]
   kind: int
-  config_get: "show run fabricpath all"
-  config_get_token: '/^fabricpath ttl unicast (\d+)\s*$/'
-  config_set: "<state> fabricpath ttl unicast <ttl>"
+  get_command: "show run fabricpath all"
+  get_value: '/^fabricpath ttl unicast (\d+)\s*$/'
+  set_value: "<state> fabricpath ttl unicast <ttl>"
   default_value: 32
 

data/lib/cisco_node_utils/cmd_ref/fabricpath_topology.yaml

@@ -1,35 +1,40 @@
 # fabricpath_topology
 ---
 # Fabricpath feature is not available on N3K and N9K
-_exclude: [/N3/, /N9K/]
+_exclude: [N3k, N8k, N9k, ios_xr]
+
+_template:
+  get_command: 'show running-config fabricpath all'
+  get_context: ['/^fabricpath topology %d$/']
+  set_context: ['fabricpath topology <topo_id>']
 
 all_topos:
   multiple:
-  config_get: "show fabricpath topology"
-  config_get_token: '/^\S+[\s]+(\d+)[\s]+/'
+  get_context: ~
+  get_value: '/^fabricpath topology (\d+)/'
+  default_value: []
 
 create:
-  config_set: ["fabricpath topology <topo>" , "end"]
+  set_value: "fabricpath topology <topo_id>"
 
 description:
   kind: string
-  config_get: "show fabricpath topology"
-  config_get_token: '/^(\S+)[\s]+%d+[\s]+\S+/'
-  config_set: ["fabricpath topology <topo>" , "<state> description <name>", "end"]
-  default_value: ""
+  get_value: '/^description (\S+)$/'
+  set_value: '<state> description <name>'
+  default_value: ''
 
 destroy:
-  config_set: "no fabricpath topology <topo>"
+  set_value: "no fabricpath topology <topo_id>"
 
 member_vlans:
   kind: string
-  config_get: "show fabricpath topology vlan"
-  config_get_token: '/^\S+[\s]+%d+[\s]+(\S+)/'
-  config_set: ["fabricpath topology <topo>" , "<state> member vlan <vlan_range>", "end"]
-  default_value: "--"
+  get_value: '/^member vlan (.+)/'
+  set_value: '<state> member vlan <vlan_range>'
+  default_value: ''
 
-state:
+member_vnis:
+  _exclude: [N5k, N6k]
   kind: string
-  config_get: "show fabricpath topology"
-  config_get_token: '/^\S+[\s]+%d+[\s]+(\S+)/'
-  default_value: "up"
+  get_value: '/^member vni (\S+)/'
+  set_value: '<state> member vni <vni_range>'
+  default_value: ''

data/lib/cisco_node_utils/cmd_ref/feature.yaml

@@ -1,42 +1,92 @@
 # feature
 ---
+_exclude: [ios_xr]
+
+_template:
+  get_command: "show running | i ^feature"
+
 bgp:
   kind: boolean
-  config_get: "show running | i feature"
-  config_get_token: '/^feature bgp$/'
-  config_set: "feature bgp"
+  get_value: '/^feature bgp$/'
+  set_value: "feature bgp"
 
 fabric:
-  _exclude: [/N(3|9)/]
-  config_get: "show feature-set"
-  config_get_token: '/^fabric[\s\d]+(\w+)/'
-  config_set: "<state> feature-set fabric"
+  _exclude: [N3k, N8k, N9k]
+  get_command: "show feature-set"
+  get_value: '/^fabric[\s\d]+(\w+)/'
+  set_value: "<state> feature-set fabric"
 
 fabric_forwarding:
-  _exclude: [/N3/]
-  config_get: "show running | i ^feature"
-  config_get_token: '/^feature fabric forwarding$/'
-  config_set: "feature fabric forwarding"
+  _exclude: [N3k]
+  get_value: '/^feature fabric forwarding$/'
+  set_value: "feature fabric forwarding"
+
+fex:
+  _exclude: [C3064, C3132, N5k, N6k, N8k]
+  get_command: "show feature-set"
+  get_value: '/^fex[\s\d]+(\w+)/'
+  set_value: "<state> feature-set fex"
+
+itd:
+  _exclude: [N3k, N5k, N6k]
+  get_value: '/^feature itd$/'
+  set_value: "feature itd"
 
 nv_overlay:
-  _exclude: [/N(3|5|6)/]
+  # N3k - native vxlan support in a future release
+  _exclude: [N3k]
   kind: boolean
-  config_get: 'show running nv overlay'
-  config_get_token: '/^feature nv overlay$/'
-  config_set: "feature nv overlay"
+  get_value: '/^feature nv overlay$/'
+  set_value: "<state> feature nv overlay"
 
 nv_overlay_evpn:
-  _exclude: [/N3/]
+  # N3k - native vxlan support in a future release
+  _exclude: [N3k]
   kind: boolean
-  config_get: "show running | section nv"
-  config_get_token: '/^nv overlay evpn$/'
-  config_set: "nv overlay evpn"
+  get_command: "show running | section nv"
+  get_value: '/^nv overlay evpn$/'
+  set_value: "nv overlay evpn"
+
+ospf:
+  kind: boolean
+  get_value: '/^feature ospf$/'
+  set_value: "feature ospf"
+
+pim:
+  kind: boolean
+  get_value: '/^feature pim$/' # TBD pim6
+  set_value: 'feature pim'
+
+private_vlan:
+  _exclude: [N8k]
+  kind: boolean
+  get_value: '/^feature private-vlan$/'
+  set_value: "feature private-vlan"
+
+tacacs:
+  kind: boolean
+  get_value: '/^feature tacacs\+$/'
+  set_value: "feature tacacs"
 
 vn_segment_vlan_based:
-  # MT-lite only
-  /N(3|9)/:
-    kind: boolean
-    config_get: 'show running section feature'
-    config_get_token: '/^feature vn-segment-vlan-based$/'
-    config_set: 'feature vn-segment-vlan-based'
-    default_value: false
+  _exclude: [N7k]
+  kind: boolean
+  get_value: '/^feature vn-segment-vlan-based$/'
+  set_value: 'feature vn-segment-vlan-based'
+  default_value: false
+
+vni:
+  kind: boolean
+  N7k:
+    # MT-Full only
+    get_value: '/^feature vni$/'
+    set_value: 'feature vni'
+  else:
+    get_value: '/^feature vn-segment-vlan-based$/'
+    set_value: 'feature vn-segment-vlan-based'
+
+vtp:
+  kind: boolean
+  get_value: '/^feature vtp$/'
+  set_value: "<state> feature vtp"
+  default_value: false