cisco_node_utils_mgx 2.1.0.1

data/lib/cisco_node_utils/cmd_ref/bridge_domain.yaml

@@ -0,0 +1,49 @@
+# bridge_domain
+# bridge_domain feature is available only on n7k
+---
+_exclude: [N3k, N5k, N6k, N3k-F, N9k-F, N9k, ios_xr]
+
+_template:
+  get_command: "show running-config bridge-domain"
+  get_context: ~
+  set_context: ["(?)bridge-domain <bd>"]
+
+all_bds:
+  multiple: true
+  get_value: '/^bridge-domain (\S+)/'
+
+bd_name:
+  get_data_format: nxapi_structured
+  get_command: "show bridge-domain <bd>"
+  get_context: ["TABLE_bd", "ROW_bd"]
+  get_value: ["bd-name"]
+  set_value: "<state> name <name>"
+
+create:
+  set_value: "bridge-domain <bd>"
+
+destroy:
+  set_value: "no bridge-domain <bd>"
+
+# Configured fabric-control Bridge-Domain/VLAN    :  100
+fabric_control:
+  get_data_format: nxapi_structured
+  get_command: "show bridge-domain summary"
+  get_context: ~
+  get_value: ["fabric-control-bd"]
+  set_value: "<state> fabric-control"
+  default_value: false
+
+shutdown:
+  get_data_format: nxapi_structured
+  get_command: "show bridge-domain <bd>"
+  get_context: ["TABLE_bd", "ROW_bd"]
+  get_value: ["bd-admin-state"]
+  set_value: "<state> shutdown"
+  default_value: false
+
+system_bridge_domain:
+  get_value: '/^system bridge-domain (\S+)/'
+  set_context: ~
+  set_value: "system bridge-domain <oper> <bd>"
+  default_value: ""

data/lib/cisco_node_utils/cmd_ref/bridge_domain_vni.yaml

@@ -0,0 +1,33 @@
+# bridge_domain
+---
+_exclude: [N3k, N5k, N6k, N3k-F, N9k-F, N9k, ios_xr]
+
+create:
+  set_value: "bridge-domain <bd>"
+
+member_vni:
+  get_command: "show running-config bridge-domain | inc 'member vni'"
+  get_value: '/^  member vni (.*)/'
+  set_value: "bridge-domain <bd> ; <membstate> member vni <membvni>"
+  default_value: ''
+
+member_vni_bd:
+  get_command: "show running-config bridge-domain | inc 'member vni' prev 1"
+  get_value: '/^bridge-domain (.*)/'
+
+range_bds:
+  multiple: true
+  get_command: "show running-config bridge-domain | inc 'member vni' prev 1"
+  get_value: '/^bridge-domain (.*)/'
+
+system_bridge_domain:
+  get_command: "show running-config bridge-domain"
+  get_value: '/^system bridge-domain (\S+)/'
+  set_value: "system bridge-domain <oper> <bd>"
+  default_value: ""
+
+vni:
+  get_command: "show running-config bridge-domain"
+  get_value: '/^vni (\d+)/'
+  set_value: "<state> vni <vni>"
+  default_value: ''

data/lib/cisco_node_utils/cmd_ref/dhcp_relay_global.yaml

@@ -0,0 +1,128 @@
+# dhcp_relay_global
+---
+_exclude: [ios_xr]
+
+_template:
+  get_command: "show running-config dhcp | no-more"
+
+ipv4_information_option:
+  kind: boolean
+  get_value: '/^ip dhcp relay information option$/'
+  set_value: "<state> ip dhcp relay information option"
+  default_value: false
+
+ipv4_information_option_trust:
+  _exclude: [N5k, N6k]
+  kind: boolean
+  get_value: '/^ip dhcp relay information option trust$/'
+  set_value: "<state> ip dhcp relay information option trust"
+  default_value: false
+
+ipv4_information_option_vpn:
+  kind: boolean
+  get_value: '/^ip dhcp relay information option vpn$/'
+  set_value: "<state> ip dhcp relay information option vpn"
+  default_value: false
+
+ipv4_information_trust_all:
+  _exclude: [N5k, N6k]
+  kind: boolean
+  get_value: '/^ip dhcp relay information trust-all$/'
+  set_value: "<state> ip dhcp relay information trust-all"
+  default_value: false
+
+ipv4_relay:
+  kind: boolean
+  get_value: '/^ip dhcp relay$/'
+  set_value: "<state> ip dhcp relay"
+  N3k: &relay_default_true
+    # auto_default is set to false because when
+    # this property is set to false, we do not
+    # find the regex pattern and since the default_value
+    # is true, it should not return true as its real
+    # value is false.
+    auto_default: false
+    default_value: true
+  N5k: &relay_default_false
+    default_value: false
+  N6k: *relay_default_false
+  N7k: *relay_default_true
+  N3k-F: *relay_default_true
+  N9k-F: *relay_default_true
+  N9k: *relay_default_true
+
+ipv4_smart_relay:
+  kind: boolean
+  get_value: '/^ip dhcp smart-relay global$/'
+  set_value: "<state> ip dhcp smart-relay global"
+  default_value: false
+
+ipv4_src_addr_hsrp:
+  _exclude: [N3k, N3k-F, N9k-F, N9k]
+  kind: boolean
+  get_value: '/^ip dhcp relay source-address hsrp$/'
+  set_value: "<state> ip dhcp relay source-address hsrp"
+  default_value: false
+
+ipv4_src_intf:
+  get_value: '/^ip dhcp relay source-interface (.*)$/'
+  set_value: "<state> ip dhcp relay source-interface <intf>"
+  default_value: false
+
+ipv4_sub_option_circuit_id_custom:
+  _exclude: [N7k, N3k-F, N9k-F]
+  kind: boolean
+  get_value: '/^ip dhcp relay sub-option circuit-id customized$/'
+  set_value: "<state> ip dhcp relay sub-option circuit-id customized"
+  default_value: false
+
+ipv4_sub_option_circuit_id_string:
+  _exclude: [N5k, N6k, N7k, N3k-F, N9k-F]
+  os_version: 'N9k:7.0.3.I6.1'
+  get_value: '/^ip dhcp relay sub-option circuit-id format-type string format (.*)$/'
+  set_value: "<state> ip dhcp relay sub-option circuit-id format-type string <format> <word>"
+  default_value: false
+
+ipv4_sub_option_cisco:
+  kind: boolean
+  get_value: '/^ip dhcp relay sub-option type cisco$/'
+  set_value: "<state> ip dhcp relay sub-option type cisco"
+  default_value: false
+
+ipv6_option_cisco:
+  _exclude: [N5k, N6k]
+  kind: boolean
+  get_value: '/^ipv6 dhcp relay option type cisco$/'
+  set_value: "<state> ipv6 dhcp relay option type cisco"
+  default_value: false
+
+ipv6_option_vpn:
+  kind: boolean
+  get_value: '/^ipv6 dhcp relay option vpn$/'
+  set_value: "<state> ipv6 dhcp relay option vpn"
+  default_value: false
+
+ipv6_relay:
+  kind: boolean
+  get_value: '/^ipv6 dhcp relay$/'
+  set_value: "<state> ipv6 dhcp relay"
+  N3k: &v6_relay_default_true
+    # auto_default is set to false because when
+    # this property is set to false, we do not
+    # find the regex pattern and since the default_value
+    # is true, it should not return true as its real
+    # value is false.
+    auto_default: false
+    default_value: true
+  N5k: &v6_relay_default_false
+    default_value: false
+  N6k: *v6_relay_default_false
+  N7k: *v6_relay_default_true
+  N3k-F: *v6_relay_default_true
+  N9k-F: *v6_relay_default_true
+  N9k: *v6_relay_default_true
+
+ipv6_src_intf:
+  get_value: '/^ipv6 dhcp relay source-interface (.*)$/'
+  set_value: "<state> ipv6 dhcp relay source-interface <intf>"
+  default_value: false

data/lib/cisco_node_utils/cmd_ref/dnsclient.yaml

@@ -0,0 +1,55 @@
+# dnsclient
+---
+_template:
+  get_command: "show running-config all"
+
+domain_list:
+  multiple: true
+  nexus:
+    get_value: '/^ip domain-list (\S+)$/'
+    set_value: '<state> ip domain-list <name>'
+  ios_xr:
+    get_value: '/^domain list (\S+)$/'
+    set_value: '<state> domain list <name>'
+  default_value: []
+
+domain_list_vrf:
+  multiple: true
+  nexus:
+    context: ['vrf context <vrf>']
+    get_value: '/ip domain-list (\S+)/'
+    set_value: '<state> ip domain-list <name>'
+  ios_xr:
+    get_value: '/^domain vrf <vrf> list (\S+)/'
+    set_value: '<state> domain vrf <vrf> list <name>'
+  default_value: []
+
+domain_name:
+  default_value: ''
+  nexus:
+    set_value: '<state> ip domain-name <name>'
+    get_value: '/^ip domain-name (\S+)$/'
+  ios_xr:
+    set_value: '<state> domain name <name>'
+    get_value: '/^domain name (\S+)$/'
+
+domain_name_vrf:
+  nexus:
+    context: ['vrf context <vrf>']
+    get_value: '/ip domain-name (\S+)/'
+    set_value: '<state> ip domain-name <name>'
+  ios_xr:
+    get_value: '/^domain vrf <vrf> name (\S+)$/'
+    set_value: '<state> domain vrf <vrf> name <name>'
+  default_value: ''
+
+name_server:
+  multiple: true
+  default_value: []
+  nexus:
+    get_command: "show running-config all | include 'ip name-server' | exclude 'use-vrf'"
+    get_value: '/^ip name-server ([\s\d\.:]+)$/'
+    set_value: '<state> ip name-server <ip>'
+  ios_xr:
+    get_value: '/^domain name-server (\S+)$/'
+    set_value: '<state> domain name-server <ip>'

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, N3k-F, N9k-F, 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_multicast.yaml

@@ -0,0 +1,12 @@
+# evpn_multicast.yaml
+---
+_exclude: [ios_xr, N3k, N3k-F, N5k, N6k, N7k, N9k-F]
+
+_template:
+  get_command: "show running-config | section advertise"
+
+multicast:
+  context: ~
+  get_value: '^advertise evpn multicast$'
+  set_value: "<state> advertise evpn multicast"
+  default_value: ''

data/lib/cisco_node_utils/cmd_ref/evpn_multisite.yaml

@@ -0,0 +1,18 @@
+# evpn_multisite.yaml
+---
+_exclude: [ios_xr, N3k, N3k-F, N5k, N6k, N7k, N9k-F]
+
+_template:
+  get_command: "show running-config | section multisite"
+
+delay_restore:
+  default_value: ""
+  get_context: ['/^evpn multisite border-gateway <multisiteid>$/']
+  get_value: '/^delay-restore\s+time\s+(\d+)$/'
+  set_context: ['evpn multisite border-gateway <multisiteid>']
+  set_value: "<state> delay-restore time <time>"
+
+multisite:
+  context: ~
+  get_value: 'evpn multisite border-gateway ([\d.]+)'
+  set_value: "<state> evpn multisite border-gateway <multisiteid>"

data/lib/cisco_node_utils/cmd_ref/evpn_stormcontrol.yaml

@@ -0,0 +1,18 @@
+# evpn_stormcontrol.yaml
+---
+_exclude: [ios_xr, N3k, N3k-F, N5k, N6k, N7k, N9k-F]
+
+_template:
+  get_command: "show running-config | section storm-control"
+
+broadcast:
+  get_value: 'evpn storm-control broadcast level ([\d.]+)'
+  set_value: "<state> evpn storm-control broadcast level <level>"
+
+multicast:
+  get_value: 'evpn storm-control multicast level ([\d.]+)'
+  set_value: "<state> evpn storm-control multicast level <level>"
+
+unicast:
+  get_value: 'evpn storm-control unicast level ([\d.]+)'
+  set_value: "<state> evpn storm-control unicast level <level>"

data/lib/cisco_node_utils/cmd_ref/evpn_vni.yaml

@@ -0,0 +1,48 @@
+# evpn_vni.yaml
+---
+_exclude: [ios_xr]
+
+_template:
+  get_command: "show running bgp all"
+  get_context:
+    - '/^evpn$/'
+    - '/^vni <vni> l2$/'
+  set_context:
+    - 'evpn'
+    - "vni <vni> l2"
+
+evpn:
+  get_context: ~
+  get_value: "/^evpn$/"
+  set_context: ~
+  set_value: "<state> evpn"
+
+route_distinguisher:
+  get_value: '/^rd (\S+)$/'
+  set_value: "<state> rd <rd>"
+  default_value: ""
+
+route_target_both:
+  get_value: '/^route-target both (\S+)$/'
+  set_value: "<state> route-target both <community>"
+  multiple: true
+  default_value: []
+
+route_target_export:
+  get_value: '/^route-target export (\S+)$/'
+  set_value: "<state> route-target export <community>"
+  multiple: true
+  default_value: []
+
+route_target_import:
+  get_value: '/^route-target import (\S+)$/'
+  set_value: "<state> route-target import <community>"
+  multiple: true
+  default_value: []
+
+vni:
+  multiple: true
+  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

@@ -0,0 +1,183 @@
+# fabricpath
+---
+_exclude: [N3k, N3k-F, N9k-F, N9k, ios_xr]
+
+aggregate_multicast_routes:
+  _exclude: [N5k, N6k]
+  kind: boolean
+  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
+  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:
+  kind: int
+  get_command: "show fabricpath switch-id"
+  get_value: '/^\*\s+(\d+).*No\s*$/'
+
+feature:
+  get_command: "show feature-set"
+  get_value: '/^fabricpath[\s]+[\d]+[\s]+(\S+)/'
+  set_value: "<state> feature-set fabricpath"
+  default_value: disabled
+
+feature_install:
+  set_value: "<state> install feature-set fabricpath"
+
+graceful_merge:
+  auto_default: false
+  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
+  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]
+  kind: boolean
+  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]
+  auto_default: false
+  kind: boolean
+  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
+  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]
+  kind: boolean
+  auto_default: false
+  get_command: "show fabricpath load-balance | begin ignore-case Ftag"
+  get_value: '/^Use VLAN: TRUE/'
+  default_value: true
+
+loadbalance_multicast_reset:
+  _exclude: [N5k, N6k]
+  set_value: "no fabricpath load-balance multicast"
+
+loadbalance_multicast_rotate:
+  _exclude: [N5k, N6k]
+  kind: int
+  get_command: "show fabricpath load-balance | begin ignore-case 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]
+  set_value: 'fabricpath load-balance multicast <rotate> <has_vlan>'
+
+loadbalance_unicast_has_vlan:
+  kind: boolean
+  auto_default: false
+  get_command: "show fabricpath load-balance | begin ECMP next 4"
+  get_value: '/^Use VLAN: TRUE/'
+  set_value: "<state> fabricpath load-balance unicast include-vlan"
+  default_value: true
+
+loadbalance_unicast_layer:
+  kind: string
+  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:
+  set_value: "no fabricpath load-balance unicast"
+
+loadbalance_unicast_rotate:
+  _exclude: [N5k, N6k]
+  kind: int
+  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:
+  set_value: 'fabricpath load-balance unicast <layer> <rotate> <has_vlan>'
+
+loadbalance_unicast_support:
+  kind: string
+  N5k: &loadbal_uni_split
+    default_only: "split"
+  N6k: *loadbal_uni_split
+  else:
+    default_only: "combined"
+
+mode:
+  kind: string
+  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
+  get_command: "show run fabricpath all"
+  get_value: '/^fabricpath switch\-id (\d+)\s*$/'
+  set_value: "fabricpath switch-id <swid>"
+
+transition_delay:
+  kind: int
+  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]
+  kind: int
+  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]
+  kind: int
+  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

@@ -0,0 +1,40 @@
+# fabricpath_topology
+---
+# Fabricpath feature is not available on N3K and N9K
+_exclude: [N3k, N3k-F, N9k-F, 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:
+  get_context: ~
+  get_value: '/^fabricpath topology (\d+)/'
+  default_value: []
+
+create:
+  set_value: "fabricpath topology <topo_id>"
+
+description:
+  kind: string
+  get_value: '/^description (\S+)$/'
+  set_value: '<state> description <name>'
+  default_value: ''
+
+destroy:
+  set_value: "no fabricpath topology <topo_id>"
+
+member_vlans:
+  kind: string
+  get_value: '/^member vlan (.+)/'
+  set_value: '<state> member vlan <vlan_range>'
+  default_value: ''
+
+member_vnis:
+  _exclude: [N5k, N6k]
+  kind: string
+  get_value: '/^member vni (\S+)/'
+  set_value: '<state> member vni <vni_range>'
+  default_value: ''