Note

The documentation you're currently reading is for version 2.8.1. Click here to view documentation for the latest stable version.

Workflows

DC Fabric Automation Suite includes turnkey automations required to provision, validate and troubleshoot data center networks spanning Day-0 and Day-N activities. Designed to work with multiple data center architectures such as IP Fabric, IP Fabric with EVPN overlay, VCS Fabric as well as multiple device families such as VDX, SLX.

This is a reference documentation organized around key usecases as outlined below. These can be used as independent workflows, or tied together to form more complex workflows. They can be manually triggered, or they can be tied to sensors using rules.

All actions and workflows return a boolean True/False to indicate success or failure of the run. Some actions, workflows return additional variables which are documented in the corresponding section.

Manage Fabric Templates

As explained in section Setting UP IP Fabric, fabric template is used to provision an IP Fabric network. DC Fabric Suite includes a default fabric template which has a set of predefined parameters used to create the fabric, such as ASN range, IP address ranges, etc. However, if a different set of configuration parameters are needed, users can create a new IP Fabric template and define the values for the configuration parameters using the actions in this section. For documentation regarding the various fabric parameters, refer to IP Fabric parameters.

fabric_add

Description: Add a fabric to the inventory

Parameter Description
fabric

Name of the fabric to add

Type: string

fabric_delete

Description: Delete a fabric template from the inventory

Parameter Description
fabric

Name of the fabric to be deleted

Type: string

fabric_list

Description: Get the list of all the fabric templates in the inventory or the details for a specified fabric template

Parameter Description
fabric

Name of the fabric

Type: string

fabric_config_set

Description: Add or Update the specified fabric parameter from the fabric template in the inventory

Parameter Description
fabric

Name of the fabric

Type: string

key

Name of the fabric key to be added or updated

Choose from:

  • p2p_link_range
  • spine_asn_block
  • spine_peer_group
  • leaf_asn_block
  • leaf_peer_group
  • loopback_ip_range
  • loopback_port_number
  • evpn_enabled
  • vtep_loopback_port_number
  • anycast_mac
  • bfd_tx
  • bfd_rx
  • bfd_multiplier
  • bgp_multihop
  • max_paths
  • allowas_in
  • mtu
  • ip_mtu
  • vni_auto_map
  • enable_vf
  • control_VLAN
  • mct_link_ip_range
other_key

Other fabric keys to be added or updated, which are not available through key enum

Type: string

value

Value of the parameter to be added or updated

Type: string

fabric_config_delete

Description: Delete the specified parameter from the fabric template

Parameter Description
fabric

Name of the fabric template from which the key will be deleted

Type: string

key

Name of the parameter to be deleted

Type: string

Build IP Fabric Infrastructure

Actions in this section enable the user to register switches into the inventory as part of a pre-defined fabric and automatically configure all the switch interfaces, BGP peering and related settings as per the fabric template parameters. Please refer to the Setting UP IP Fabric section for additional details.

switch_add

Description: Register a switch in the inventory and assign to a fabric

Parameter Description
fabric

Name of the fabric

Type: string

host

Management IP address of the switch

Type: string

user

Login user name to connect to the switch

Type: string

passwd

Login password to connect to the device

Type: string

protocol

The protocol used for REST requests. This applies to REST platforms such as SLX and VDX.

Choose from:

  • http
  • https

Default: http

switch_delete

Description: Delete a switch in the inventory and remove from the fabric

Parameter Description
host

Management IP address of the switch

Type: string

clear_config

Clear switch configuration

Type: boolean

switch_list

Description: Show the details for all the switches that are part of a specified fabric or for a specified single switch

Parameter Description
fabric

Name of the fabric

Type: string

host

Management IP address of the switch

Type: string

switch_update

Description: Update the details of all the switches in the fabric or a specified single switch

Parameter Description
fabric

Name of the fabric

Type: string

host

Management IP address of the switch

Type: string

user

Login user name to connect to the device

Type: string

passwd

Login password to connect to the device

Type: string

state

Device Provisioning State. Its mainly needed to mark the state during workflow execution.

Choose from:

  • Provisioned
  • Failed
protocol

The protocol used for REST requests. This applies to REST platforms such as SLX and VDX.

Choose from:

  • http
  • https

Default: http

topology_generate

Description: Generate the topology of the fabric

Parameter Description
fabric

Name of the fabric

Type: string

Default: default

format

Choice of the topology file format to be generated

Choose from:

  • pdf
  • jpeg
  • png
  • svg

Default: pdf

render_dir

File path where the generated topology file to be placed

Type: string

Default: /tmp

configure_fabric_infra

Description: This configures IP fabric infrastructure.

Parameter Description
fabric

The name of the IP fabric template.

Type: string

Default: default

username

The login user name to connect to the device.

Type: string

password

The login password to connect to the device.

Type: string

batch_size

The number of switches to configure concurrently.

Type: integer

Default: 10

state

The filter to fetch all or just unprovisioned devices.

Choose from:

  • Unprovisioned
  • All

Default: Unprovisioned

Manage EVPN Tenants and Edge Ports

Once IP Fabric is provisioned, check out the Using IP Fabric documentation for Day-N service provisioning workflows. This section includes the actions and workflows to automate Day-N services such as provisioning of tenants, gateways and edge ports to enable the deployment of endpoints such as Servers, Firewalls and Load Balancers etc. on the fabric.

create_l2_tenant_evpn

Description: This will create EVPN VXLAN based L2 broadcast domain spanning multiple switches. or a vLAG pair

Parameter Description
mgmt_ip

The management IP address of the target device.

Type: string

username

The login user name to connect to the device.

Type: string

Default: admin

password

The login password to connect to the device.

Type: string

Default: password

vni

The VNI to be added for EVPN Instance (<NUMBER:1-16777215>) example 1,2,4-6. Valid only on VDX devices.

Type: string

vlan_id

A single or a range of VLAN IDs to be added under the EVPN instance, e.g. 10 or 10-15 or 10,12,13-15. Valid only on SLXOS devices.

Type: string

bridge_domain_id

A single or a range of BD IDs to be added under the EVPN instance, e.g. 10 or 10-15 or 10,12,13-15. Valid only on SLXOS devices.

Type: string

Details

The create_l2_tenant_evpn workflow provisions an L2 domain extension in the BGP EVPN based IP fabric, on the selected leaves or vLAG pairs.The workflow must be provided with the set of vLAG pairs or leaf switches between which the layer 2 extension is required.

Requirements

This workflow is designed for use in IP Fabric EVPN networks only.

Output

result
Boolean - True/False, to indicate success or failure of the action.

Error Messages

“Input is not a valid VNI value”
Returned if VNI value is < 1 or > 16777215
“EVPN instance not configured under rbridge-id”
Returned if EVPN instance is not already configured
“Invalid Input values for VNI <vni> add for evi <evi> under rbridge <rbridge-id>
Returned if input is invalid.
“VLAG PAIR must be <= 2 leaf nodes”
Returned if VLAG pair is more than two nodes

create_l3_tenant_evpn

Description: This create VRF, create L3VNI on VE interface and assign VRF forwarding, redistribute connected routes in the BGP VRF address families.

Parameter Description
mgmt_ip

The management IP address of the target device.

Type: string

username

The login user name to connect to the device.

Type: string

Default: admin

password

The login password to connect to the device.

Type: string

Default: password

vrf_name

The VRF name, 1-32 characters.

Type: string

l3vni

L3VNI for the VRF. VDX <1-8191> and SLX <1-4096>.

Type: integer

vlan_id

A single VLAN ID. VDX <1-8191> and SLXOS <1-4090>. If vlan_id is passed for VDX devices , vlan_id & l3vni args must of be same value. If vlan_id is not passed for VDX devices , l3vni will be assumed as vlan_id. This is mandatory args for SLXOS devices. In Bridge-domain context for SLXOS, use network_id.

Type: string

network_id

Bridge-domain ID. Valid only on SLXOS devices. Valid range is from 1 through 4096 on SLX-9140/SLX-9850/SLX-9540 and 1 through 3566 on SLX-9240.

Type: integer

route_distinguisher

The BGP router ID of the leafs, for example, 10.20.31.1, 10.20.31.2.

Type: array

route_target

The Route Target for the address family, for example, 101.

Type: integer

tenant_addressing_type

The Tenant IP addressing type.

Choose from:

  • ipv4
  • ipv6
  • both

Default: ipv4

maximum_paths

Forward packets over multiple paths.

Type: integer

Default: 8

Details

The Create_l3_tenant_evpn workflow provisions the BGP EVPN based IP fabric with an L3 tenant identified by a VRF. This workflow provisions the vlan, VRF for the Layer 3 tenant at the identified leaf switches or vLAG pairs, enables routing for the VRF across the IP fabric by enabling the VRF address family in BGP and creating L3VNI interface and also enables redistribution of connected routes in the VRF to BGP EVPN.

Requirements

This workflow is designed for operating in IP Fabric mode.

Output

result
Boolean - True/False, to indicate success or failure of the action.

Error Messages

“Not a valid VLAN”
Returned if VLAN provided are invalid, e.g. > 4094
“vlan 1 is default vlan”
Returned if VLAN provided is 1.
“Vlan cannot be created, as it is not a user/fcoe vlan”
Returned if VLAN provided is part of user/FCOE VLAN (4087/4096/1002).

add_multihomed_endpoint

Description: This workflow creates VLANs, port channel and configures port channel as a Trunk. In Bridge-domain context, workflow will create bridge-domains, logical interfaces and associate the logical interfaces to the bridge-domains. Configures VLAN/Bridge-domain to VNI mapping under the overlay gateway. The workflow also creates the MCT client and its interfaces. For service or transport VFs in a Virtual Fabrics context, workflow will create g-vlans and map c-tags under the switchport.

Parameter Description
mgmt_ip

The management IP address of the target device.

Type: string

username

The login user name to connect to the device.

Type: string

Default: admin

password

The login password to connect to the device.

Type: string

Default: password

intf_type

The interface type.

Choose from:

  • ethernet
  • tengigabitethernet
  • gigabitethernet
  • fortygigabitethernet
  • hundredgigabitethernet

Default: ethernet

ports

A single or a list of ports that are members of the port channel. Examples for VDX, SLX are 24/0/1, 24/0/2 or 1/13, 1/14.

Type: array

port_speed

The configurable port speed.

Choose from:

  • 1000
  • 10000
  • 25000
  • 40000
  • 100000

Default: 10000

intf_desc

The description for all the ports, space is not allowed, use ‘_’ instead.

Type: string

auto_pick_port_channel_id

If selected, workflow will pick the lowest available port channel on the switch.

Type: boolean

trunk_no_default_native

Configure the switchport mode as trunk-no-default-native.

Type: boolean

port_channel_id

The Portchannel interface number. VDX <1-6144>, SLX-9850 <1-512>, SLX-9540 <1-64>, SLX-9140/9240 <1-1024>, if auto pick option is selected, no need to specify port_channel_id.

Type: string

port_channel_desc

The port channel description without any space.

Type: string

mode

The port channel type.

Choose from:

  • standard
  • brocade

Default: standard

protocol

The port channel mode.

Choose from:

  • active
  • passive
  • modeon

Default: active

mtu

The L2 MTU size in bytes <Number:1522-9216>.

Type: integer

enabled

Select true to enable the port, false to disable the port.

Type: boolean

Default: True

auto_pick_network_id

In Bridge-domain context, if selected, workflow will pick the lowest available Single/Range of BRIDGE-DOMAIN IDs available on the switch, valid range is from 1 through 4096. For service or transport VFs in a Virtual Fabrics context, if selected, workflow will pick the lowest available Single/Range of VF IDs available on the switch, valid range is from 4096 through 8191. For Virtual Fabric/Bridge-Domain and ctag classification, use auto_pick_network_id or network_id.

Type: boolean

network_id

For SLXOS, single or range of Bridge Domain IDs, valid range is 1-4096. For VDX, when using Virtual Fabrics, single or range of VF IDs, valid range is 4096-8191. If auto_pick_network_id=True, network_id need not be specified.

Type: string

vlan_id

A single or range of VLANs to be configured on the interface. For 802.1Q VLANs ID must be below 4096. Valid for vlan_id only use cases. For Virtual Fabric/Bridge-Domain and ctag classification, use auto_pick_network_id or network_id.

Type: string

vlan_desc

The VLAN description, space is not allowed, use ‘_’ instead. Same VLAN description is configured on all the VLANs when the range is provided.

Type: string

c_tag

A single or range of VLAN IDs <NUMBER:1-4090>. Valid only if switchport_mode is trunk. This is mandatory parameter in Virtual Fabric/Bridge-Domain context. Not applicable, if vlan_type=untagged.

Type: string

auto_pick_lif_id

This auto generates physical/port-channel logical interfaces. Valid only on SLXOS devices.

Type: boolean

lif_id

A single or comma seperated list of logical interface IDs. Format for the logical interfaces is <physical/port-channel number>.<number>. This can be ignored, if auto_pick_lif_id=True and auto_pick_port_channel_id=True. Valid only on SLXOS devices.

Type: string

vlan_type

In bridge-domain context, the VLAN tag type to be configured under logical interfaces. If vlan_type is untagged, enable trunk_no_default_native parameter. Valid only on SLXOS devices.

Choose from:

  • untagged
  • tagged

Default: tagged

vni

Single or a range of VNI <NUMBER:1-16777215> mappings for VLANs or NETWORK IDs, for example 10 or 10-15 or 10,12,13-15. When using ranges, the number of values in a VLAN ID or c_tag range must correspond to the number of values in a VNI range.

Type: string

mct_client_name

Cluster Client name for Node Specific configuration, both mct_client_name and mct_client_id are required for MCT client creation. Valid on SLXOS devices.

Type: string

mct_client_id

The ID for the Cluster Client. Valid IDs are 1 - 512. Both mct_client_name and mct_client_id are required for MCT client creation. Valid on SLXOS devices.

Type: integer

display_show_results

This enable or disable execution of show commands on the device to display the output.

Type: boolean

add_multihomed_endpoint_and_gw_evpn

Description: This workflow adds an endpoint (Server, FW, LB, VM) to an existing L3 tenant in an EVPN IP fabric and also configures IPV4/IPV6 Anycast Gateway. This workflow creates VLAN, VE and configures port channel. In Bridge-domain context, workflow will create bridge-domains, logical interfaces and associate the logical interfaces to the bridge-domains. Configures VLAN/Bridge-domain to VNI mapping under the overlay gateway. The workflow also creates the mct client and its interfaces. For service or transport VFs in a Virtual Fabrics context, workflow will create g-vlans and map c-tags under the switchport.

Parameter Description
mgmt_ip

The management IP address of the target device.

Type: string

username

The login user name to connect to the device.

Type: string

Default: admin

password

The login password to connect to the device.

Type: string

Default: password

intf_type

The interface type.

Choose from:

  • ethernet
  • gigabitethernet
  • tengigabitethernet
  • fortygigabitethernet
  • hundredgigabitethernet
  • port_channel

Default: ethernet

port_speed

The configurable port speed. Valid if switchport is trunk or trunk_no_default_active.

Choose from:

  • 1000
  • 10000
  • 25000
  • 40000
  • 100000

Default: 10000

intf_name

The list of ports that are members of the port channel. Examples for VDX, SLX are 24/0/1, 24/0/2 or 1/13, 1/14.

Type: array

intf_desc

The description for all the ports, space is not allowed, use ‘_’ instead.

Type: string

enabled

This selects true to enable the port, false to disable the port.

Type: boolean

Default: True

auto_pick_port_channel_id

If selected, workflow will pick the lowest available port channel. on the switch.

Type: boolean

port_channel_id

The Portchannel interface number. VDX <1-6144>, SLX-9850 <1-512>, SLX-9540 <1-64>, SLX-9140/9240 <1-1024>, if auto pick option is selected, no need to specify port_channel_id.

Type: string

port_channel_desc

The port channel description without any space.

Type: string

mode

The port channel type.

Choose from:

  • standard
  • brocade

Default: standard

protocol

The port channel mode

Choose from:

  • active
  • passive
  • modeon

Default: active

switchport_mode

The switch port mode

Choose from:

  • access
  • trunk
  • trunk_no_default_native

Default: access

auto_pick_network_id

In Bridge-domain context, if selected, workflow will pick the lowest available Single/Range of BRIDGE-DOMAIN IDs available on the switch, valid range is from 1 through 4096. For service or transport VFs in a Virtual Fabrics context, if selected, workflow will pick the lowest available Single/Range of VF IDs available on the switch, valid range is from 4096 through 8191. For Virtual Fabric/Bridge-Domain and ctag classification, use auto_pick_network_id or network_id.

Type: boolean

network_id

For SLXOS, single or range of Bridge Domain IDs, valid range is 1-4096. For VDX, when using Virtual Fabrics, single or range of VF IDs, valid range is 4096-8191. If auto_pick_network_id=True, network_id need not be specified.

Type: string

vlan_id

Single or a range of VLANs to be configured on the interface. For 802.1Q VLANs ID must be below 4096. Valid for vlan_id only use cases. For Virtual Fabric/Bridge-Domain and ctag classification, use auto_pick_network_id or network_id.

Type: string

ve_id

Single or a range of VE IDs. Valid range for SLXOS is 1-4096 and for VDX is 1-8191. Required for SLXOS devices. For VDX, vlan_id/network_id is auto assigned as ve_id.

Type: string

vlan_desc

The VLAN description, space is not allowed, use ‘_’ instead.

Type: string

vlan_type

In bridge-domain context, the VLAN tag type to be configured under logical interfaces. If vlan_type is untagged, enable trunk_no_default_native parameter. Valid only on SLXOS devices.

Choose from:

  • untagged
  • tagged

Default: tagged

c_tag

A single or a range of VLAN IDs <NUMBER:1-4090>. Valid only if switchport_mode is trunk. This is mandatory parameter in Virtual Fabric/Bridge-Domain context. Not applicable, if vlan_type=untagged.

Type: string

auto_pick_lif_id

This auto generates physical port lifs or port channel lifs. Valid only on SLXOS devices.

Type: boolean

lif_id

A single or comma seperated list of logical interface ids. Format for the logical interfaces is <physical/port-channel number>.<number>. This can be ignored, if auto_pick_lif_id=True and auto_pick_port_channel_id=True. Valid only on SLXOS devices.

Type: string

vni

Single or a range of VNI <NUMBER:1-16777215> mappings for VLANs or NETWORK IDs, for example 10 or 10-15 or 10,12,13-15. When using ranges, the number of values in a VLAN ID or c_tag range must correspond to the number of values in a VNI range.

Type: string

mac_group_id

The MAC group ID <NUMBER:1,500>. Only applicable if switchport_mode is access and on VDX platforms.

Type: array

vrf_name

VRF name

Type: string

ipv4_anycast_address

Single or list of IPv4 with subnet/prefix length separated by comma. e.g. 10.10.9.10/22 or 10.10.9.10/22,11.11.10.9/22.

Type: string

ipv6_anycast_address

Single or list of IPv6 with subnet/prefix length separated by comma. e.g. fdf8:10:0:65::254/96 or fdf8:10:0:65::254/96,fde8:10:0:65::251/96 Valid only on SLX9140.

Type: string

arp_aging_type

The aging type.

Choose from:

  • arp_aging
  • nd_cache_expiry

Default: arp_aging

arp_aging_timeout

The ARP aging timeout in minutes, valid range is 0-240.

Type: integer

Default: 4

nd_cache_expire_time

Cache expiry timeout in seconds, valid range is 30-14400.

Type: integer

Default: 270

mtu

L2 MTU size in bytes, valid range is 1522-9216.

Type: integer

mct_client_name

Cluster Client name for Node Specific configuration, both mct_client_name and mct_client_id are required for MCT client creation. Valid on SLXOS devices.

Type: string

mct_client_id

The ID for the Cluster Client. Valid IDs are 1 - 512. Both mct_client_name and mct_client_id are required for MCT client creation. Valid on SLXOS devices.

Type: integer

display_show_results

This enable or disable execution of show commands on the device to display the output.

Type: boolean

suppression_type

The suppression type.

Choose from:

  • ARP
  • ND
  • Both

Default: ARP

Details

The add_multihomed_endpoint_and_gw_evpn workflow automates the configuration of the edge ports of the BGP EVPN based IP fabric. The workflow automates creation of port-channel interfaces (LAGs and vLAGs), configuration of the port-channel interface as access or trunk, creation and association of VLANs with the port-channel interfaces, validation of the port channel state as well as creation of layer 3 gateway using Anycast Gateway protocol and modify ARP ND ageing on the vLAG pair or leaf switch and association of the layer 3 gateways with a VRF.

Requirements

This workflow is designed for use in IP Fabric with EVPN networks.

Output

Result
Boolean - True/False, to indicate success or failure of the action.

Error Messages

“Not a valid VLAN”
Returned if VLAN provided are invalid, e.g. > 4094
“vlan 1 is default vlan”
Returned if VLAN provided is 1.
“Vlan cannot be created, as it is not a user/fcoe vlan”
Returned if VLAN provided is part of user/fcoe vlan (4087/4096/1002).

Invalid IP “anycast_address”

Note

To re-run this workflow, autopick_port_channel_id flag must be unset and port-channel ID must be specified.

IP Fabric Validation and Troubleshooting

get-flow-trace-ip-fabric

Description: This traces the data path through the IP Fabric network and checks the integrity of the route-programming on the devices along the data path. This can be used to trace the path of the packet flow in IP fabric topology as well as in identifying the point of failure when a flow is dropped and is not reaching the destination.

Parameter Description
host

The management IP address of the target device.

Type: string

username

The username to SSH into the host.

Type: string

Default: admin

password

The password for login into switch.

Type: string

Default: password

fabric

The Fabric name.

Type: string

mac_da

The destination MAC address of the flow (myDA in l3fwd) in xxxx.xxxx.xxxx format.

Type: string

mac_sa

The source MAC address of the flow in xxxx.xxxx.xxxx (0010.9400.0008) format.

Type: string

dip

The destination IP of the flow in A.B.C.D/E format.

Type: string

sip

The source IP of the flow in A.B.C.D/E format.

Type: string

vlan

The VLAN ID.

Type: string

interface

The ingress interface name in slot/port.

Type: string

verbose

This enables the verbose mode for the script to log more details.

Type: boolean

Details

Based on source and destination information provided by the user, this workflow determines the path of the packet flow in the IP Fabric topology and connects and runs diagnostic scripts on ingress leaf, spine and egress leaf. Diagnostic actions on each node are intended for use by this workflow and not to be directly run by the end user.

Output

Result
Boolean - True/False, to indicate success or failure of the action.

Error Messages

“The host ip address 10.18.245.150 is not the fabric host list”
Returned if the input switch IP address is not part of fabric topology
“the connection parameters are incorrect”
Returned if any of the connection parameters (Username, Password or Host IP) is incorrect.
“username for %s not found.”
Returned if authentication fails
“password for %s not found.”
Returned if authentication fails
“Unsupported version running on the switch”
Returned if the switch software version is < 7.0.1a
“Length of the description is more than the allowed size”
Returned if interface description length is more than 63.
“The mgmt_ip could not find for loopback_ip”
Loopback IP address provided in the debug cannot be found from topology
“Not able to open the file located at /tmp/debug_ingress”
Returned if the debug file cannot be opened
“Failed to run on switch 10.18.245.166 due to exception”
Returned if the command is not be able to run on the switch because of some exceptions.

query_topology

Description: This will construct the IP Fabric topology using the inventory.

Parameter Description
fabric

The name of the IP fabric.

Type: string

Default: default

state

The ilter to fetch all or just unprovisioned devices.

Choose from:

  • All
  • Unprovisioned

Default: All

show_config_bgp

Description: Show the BGP configuration details from the inventory for the specified fabric or the device IP

Parameter Description
fabric

Name of the fabric

Type: string

host

IP of the device

Type: string

Manage VCS Fabric Tenants and Edge Ports

VCS fabric automatically forms with minimal Day-0 configurations. This section includes the actions and workflows to automate Day-N services such as provisioning of tenants, gateways and edge ports to enable the deployment of endpoints such as Servers, Firewalls and Load Balancers etc. on a VCS fabric. Refer to VCS Fabric for various deployment models.

add_multihomed_endpoint

Description: This workflow creates VLANs, port channel and configures port channel as a Trunk. In Bridge-domain context, workflow will create bridge-domains, logical interfaces and associate the logical interfaces to the bridge-domains. Configures VLAN/Bridge-domain to VNI mapping under the overlay gateway. The workflow also creates the MCT client and its interfaces. For service or transport VFs in a Virtual Fabrics context, workflow will create g-vlans and map c-tags under the switchport.

Parameter Description
mgmt_ip

The management IP address of the target device.

Type: string

username

The login user name to connect to the device.

Type: string

Default: admin

password

The login password to connect to the device.

Type: string

Default: password

intf_type

The interface type.

Choose from:

  • ethernet
  • tengigabitethernet
  • gigabitethernet
  • fortygigabitethernet
  • hundredgigabitethernet

Default: ethernet

ports

A single or a list of ports that are members of the port channel. Examples for VDX, SLX are 24/0/1, 24/0/2 or 1/13, 1/14.

Type: array

port_speed

The configurable port speed.

Choose from:

  • 1000
  • 10000
  • 25000
  • 40000
  • 100000

Default: 10000

intf_desc

The description for all the ports, space is not allowed, use ‘_’ instead.

Type: string

auto_pick_port_channel_id

If selected, workflow will pick the lowest available port channel on the switch.

Type: boolean

trunk_no_default_native

Configure the switchport mode as trunk-no-default-native.

Type: boolean

port_channel_id

The Portchannel interface number. VDX <1-6144>, SLX-9850 <1-512>, SLX-9540 <1-64>, SLX-9140/9240 <1-1024>, if auto pick option is selected, no need to specify port_channel_id.

Type: string

port_channel_desc

The port channel description without any space.

Type: string

mode

The port channel type.

Choose from:

  • standard
  • brocade

Default: standard

protocol

The port channel mode.

Choose from:

  • active
  • passive
  • modeon

Default: active

mtu

The L2 MTU size in bytes <Number:1522-9216>.

Type: integer

enabled

Select true to enable the port, false to disable the port.

Type: boolean

Default: True

auto_pick_network_id

In Bridge-domain context, if selected, workflow will pick the lowest available Single/Range of BRIDGE-DOMAIN IDs available on the switch, valid range is from 1 through 4096. For service or transport VFs in a Virtual Fabrics context, if selected, workflow will pick the lowest available Single/Range of VF IDs available on the switch, valid range is from 4096 through 8191. For Virtual Fabric/Bridge-Domain and ctag classification, use auto_pick_network_id or network_id.

Type: boolean

network_id

For SLXOS, single or range of Bridge Domain IDs, valid range is 1-4096. For VDX, when using Virtual Fabrics, single or range of VF IDs, valid range is 4096-8191. If auto_pick_network_id=True, network_id need not be specified.

Type: string

vlan_id

A single or range of VLANs to be configured on the interface. For 802.1Q VLANs ID must be below 4096. Valid for vlan_id only use cases. For Virtual Fabric/Bridge-Domain and ctag classification, use auto_pick_network_id or network_id.

Type: string

vlan_desc

The VLAN description, space is not allowed, use ‘_’ instead. Same VLAN description is configured on all the VLANs when the range is provided.

Type: string

c_tag

A single or range of VLAN IDs <NUMBER:1-4090>. Valid only if switchport_mode is trunk. This is mandatory parameter in Virtual Fabric/Bridge-Domain context. Not applicable, if vlan_type=untagged.

Type: string

auto_pick_lif_id

This auto generates physical/port-channel logical interfaces. Valid only on SLXOS devices.

Type: boolean

lif_id

A single or comma seperated list of logical interface IDs. Format for the logical interfaces is <physical/port-channel number>.<number>. This can be ignored, if auto_pick_lif_id=True and auto_pick_port_channel_id=True. Valid only on SLXOS devices.

Type: string

vlan_type

In bridge-domain context, the VLAN tag type to be configured under logical interfaces. If vlan_type is untagged, enable trunk_no_default_native parameter. Valid only on SLXOS devices.

Choose from:

  • untagged
  • tagged

Default: tagged

vni

Single or a range of VNI <NUMBER:1-16777215> mappings for VLANs or NETWORK IDs, for example 10 or 10-15 or 10,12,13-15. When using ranges, the number of values in a VLAN ID or c_tag range must correspond to the number of values in a VNI range.

Type: string

mct_client_name

Cluster Client name for Node Specific configuration, both mct_client_name and mct_client_id are required for MCT client creation. Valid on SLXOS devices.

Type: string

mct_client_id

The ID for the Cluster Client. Valid IDs are 1 - 512. Both mct_client_name and mct_client_id are required for MCT client creation. Valid on SLXOS devices.

Type: integer

display_show_results

This enable or disable execution of show commands on the device to display the output.

Type: boolean

Details

The add_multihomed_endpoint workflow automates the configuration of the edge ports. The workflow automates creation of port-channel interfaces (LAGs and vLAGs), configuration of the port-channel interface as access or trunk, creation and association of VLANs with the port-channel interfaces as well as validation of the port channel state.

Requirements

This workflow is designed for operating on edge devices of IP Fabric, EVPN or VCS networks.

Output

Result
Boolean - True/False, to indicate success or failure of the action.

Error Messages

“Not a valid VLAN”
Returned if the VLAN provided is invalid, e.g. > 4094
“vlan 1 is default vlan”
Returned if VLAN provided is 1.
“Vlan cannot be created, as it is not a user/fcoe vlan”
Returned if VLAN provided is part of user/FCOE VLAN (4087/4096/1002).
“Input is not a valid Interface”
Returned if interface name is not a valid port number.
“SWITCHING_NOT_ENABLED | %Error: Interface not configured for switching”
Returned if given interfaces are already part of a port-channel

add_multihomed_endpoint_and_gw

Description: This adds an endpoint (VM, server, LB, FW) to a VCS or an IP fabric (non EVPN) for an existing tenant. Create interface/port-channel configurations based on the user input on devices. Enable VRRPE configurations.

Parameter Description
mgmt_ip

The management IP address of the target device.

Type: string

username

The login user name to connect to the device.

Type: string

Default: admin

password

The login password to connect to the device.

Type: string

Default: password

rbridge_id

A single or comma separated RBridge ID(s) to create VE, VRRPe. Applicable only for VDX switches.

Type: array

intf_type

The interface type.

Choose from:

  • ethernet
  • gigabitethernet
  • tengigabitethernet
  • fortygigabitethernet
  • hundredgigabitethernet
  • port_channel
  • VE
  • loopback

Default: ethernet

intf_name

Single or a list of ports that are members of the port channel. Examples for VDX, SLX are 24/0/1, 24/0/2 or 24/1, 24/2.

Type: array

intf_desc

The description for all the ports, space is not allowed, use ‘_’ instead.

Type: string

enabled

This enable or disable admin setting on the interface.

Type: boolean

Default: True

switchport_mode

The switch port mode.

Choose from:

  • access
  • trunk
  • trunk_no_default_native

Default: access

auto_pick_port_channel_id

If selected, workflow will pick the lowest available port channel. on the switch.

Type: boolean

port_channel_id

The Portchannel interface number. VDX <1-6144>, SLX-9850 <1-512>, SLX-9540 <1-64>, SLX-9140/9240 <1-1024>, if auto pick option is selected, no need to specify the port_channel_id.

Type: string

port_channel_desc

The port channel description without any space.

Type: string

mode

The Portchannel type.

Choose from:

  • standard
  • brocade

Default: standard

protocol

The Portchannel mode type.

Choose from:

  • active
  • passive
  • modeon

Default: active

auto_pick_network_id

For service or transport of VFs in a Virtual Fabrics context, if selected, workflow will pick the lowest available VF ID available on the switch, valid range is from 4096 through 8191. For Virtual Fabric and ctag classification , use auto_pick_network_id or network_id. Valid only on VDX platform.

Type: boolean

network_id

For VDX, when using Virtual Fabrics, single VF ID, valid range is 4096-8191. If auto_pick_network_id=True, network_id need not be specified. Valid on VDX platform.

Type: string

vlan_id

Single VLAN ID . For 802.1Q VLANs ID must be below 4096. Valid for vlan_id only use cases. For Virtual Fabric and ctag classification , use auto_pick_network_id or network_id.

Type: string

vlan_desc

The VLAN description, space is not allowed, use ‘_’ instead.

Type: string

c_tag

The single VLAN ID <NUMBER:1-4090>. Valid only on NOS devices & if switchport_mode is trunk.

Type: string

mac_group_id

The MAC group ID <NUMBER:1,500>. Only applicable if switchport_mode is access.

Type: array

ve_id

VE ID. Valid range for SLXOS is 1-4096 and for VDX is 1-8191. Required for SLXOS devices. For VDX, vlan_id/network_id is auto assigned as ve_id.

Type: string

ve_ip

Single or list of IPv4/IPv6 addresses to be configured on the VE. IPv4/subnet-length or IPv6/prefix-length, for example 10.0.0.10/22, 30.0.0.10/22.

Type: array

vrid

The virtual group ID. Range for VDX & SLX is from 1 through 255.

Type: string

virtual_ip

The VRRPe virtual IP address without the netmask.

Type: string

vrf_name

The VRF name. For example vrf32 or 32.

Type: string

afi

The IP address type.

Choose from:

  • ipv4
  • ipv6

Default: ipv4

mtu

The L2 MTU size in bytes <Number:1522-9216>.

Type: integer

display_show_results

This enable or disable execution of show commands on the device to display the output.

Type: boolean

Details

The add_multihomed_endpoint_and_gw workflow automates the addition of an endpoint which needs Layer 3 termination within the fabric. It automates the provisioning of both the edge ports as well as the VRRP-E based redundant gateway.

Requirements

This workflow is designed for use in IP Fabric (no EVPN) and VCS Fabric networks.

Output

result
Boolean - True/False, to indicate success or failure of the action.

ve_ip: IP address assigned to the VE interface

vrid: VRRPe router ID assigned to the VE interface

add_singlehomed_endpoint

Description: This workflow creates VLAN, configures interface as Access or Trunk, and validates the interface state.In Bridge-domain context, workflow will create bridge-domains, logical interfaces and associate the logical interfaces to the bridge-domains. Configures VLAN/Bridge-domain to VNI mapping under the overlay gateway.

Parameter Description
mgmt_ip

The management IP address of the target device.

Type: string

username

The login user name to connect to the device.

Type: string

Default: admin

password

The login password to connect to the device.

Type: string

Default: password

intf_type

The interface type.

Choose from:

  • ethernet
  • gigabitethernet
  • tengigabitethernet
  • fortygigabitethernet
  • hundredgigabitethernet
  • port_channel
  • ve
  • loopback

Default: ethernet

intf_name

A single port. Examples for VDX, SLX are 24/0/1 or 1/13.

Type: string

intf_desc

The port description, where space is not allowed, use ‘_’ instead.

Type: string

enabled

This selects true to enable the port, false to disable the port.

Type: boolean

Default: True

switchport_mode

The switch port mode.

Choose from:

  • access
  • trunk
  • trunk_no_default_native

Default: access

auto_pick_network_id

In Bridge-domain context, if selected, workflow will pick the lowest available Single/Range of BRIDGE-DOMAIN IDs available on the switch, valid range is from 1 through 4096. For service or transport VFs in a Virtual Fabrics context, if selected, workflow will pick the lowest available Single/Range of VF IDs available on the switch, valid range is from 4096 through 8191. For Virtual Fabric/Bridge-Domain and ctag classification, use auto_pick_network_id or network_id.

Type: boolean

network_id

For SLXOS, single or range of Bridge Domain IDs, valid range is 1-4096. For VDX, when using Virtual Fabrics, single or range of VF IDs, valid range is 4096-8191. If auto_pick_network_id=True, network_id need not be specified.

Type: string

vlan_id

A single or range of VLANs to be configured on the interface. For 802.1Q VLANs ID must be below 4096. Valid for vlan_id only use cases. For Virtual Fabric/Bridge-Domain and ctag classification, use auto_pick_network_id or network_id.

Type: string

vlan_desc

The VLAN description, where space is not allowed, use ‘_’ instead. Same VLAN description is configured on all the VLANs when the range is provided.

Type: string

c_tag

A single or range of VLAN IDs <NUMBER:1-4090>. Valid only if switchport_mode is trunk. This is mandatory parameter in Virtual Fabric/Bridge-Domain context. Not applicable, if vlan_type=untagged.

Type: string

mac_group_id

The MAC group ID <NUMBER:1,500>. Only applicable if switchport_mode is access and on VDX platforms.

Type: array

auto_pick_lif_id

The auto generates physical port lifs or port channel lifs. Valid only on SLXOS devices.

Type: boolean

lif_id

A single or comma seperated list of logical interface IDs. Format for the logical interfaces is <physical/port-channel number>.<number>. This can be ignored, if auto_pick_lif_id=True and auto_pick_port_channel_id=True. Valid only on SLXOS devices.

Type: string

vlan_type

In bridge-domain context, the VLAN tag type to be configured under logical interfaces. If vlan_type is untagged, enable trunk_no_default_native parameter. Valid on SLXOS devices.

Choose from:

  • untagged
  • tagged

Default: tagged

vni

Single or range of VNI <NUMBER:1-16777215> mappings for VLANs or NETWORK IDs, for example 10 or 10-15 or 10,12,13-15. When using ranges, the number of values in a VLAN ID or c_tag range must correspond to the number of values in a VNI range.

Type: string

configure_vrrpe_gw

Description: This create VLAN, VE interface on specified GWs and configure VRRPe on VE interfaces.

Parameter Description
mgmt_ip

The management IP address of the target device.

Type: string

username

The login user name to connect to the device.

Type: string

Default: admin

password

The login password to connect to the device.

Type: string

Default: password

rbridge_id

This is a single Rbridge or a list of Rbridges separated by comma that needs VE/VRRPe creation.

Type: array

vlan_id

A single VLAN ID. VDX range is from 1 through 8191 and 1 through 4090 for SLX.

Type: string

vlan_desc

The VLAN description without any space.

Type: string

ve_ip

A single or a list of IPv4/IPv6 addresses to be configured on the VE. IPv4/subnet-length or IPv6/prefix-length, for example 10.0.0.10/22, 30.0.0.10/22.

Type: array

vrid

The virtual group ID. Range for VDX & SLX is from 1 through 255.

Type: string

virtual_ip

The VRRPe virtual IP address without the netmask.

Type: string

vrf_name

The VRF name, for example vrf32 or 32.

Type: string

afi

The IP address type.

Choose from:

  • ipv4
  • ipv6

Default: ipv4

intf_type

The interface type, VDX & SLX supports only ve.

Choose from:

  • ve

Default: ve

intf_name

The VE ID. This is mandatory args for SLX. VE range for SLX is from 1 through 4096 and 1 through 8191 for VDX. intf_name will be infered as vlan_id if not passed.

Type: string

display_show_results

This enable/disable output display of show commands executed on the devices.

Type: boolean

Requirements

This workflow is designed for use in IP Fabric, EVPN and VCS networks.

Output

result
Boolean - True/False, to indicate success or failure of the action.

ve_ip: IP address assigned to the VE interface

vrid: VRRPe router ID assigned to the VE interface

virtual_ip: VRRPe virtual IP assigned to the VE interface

virtual-mac: VRRPe virtual MAC assigned to the VE interface

Error Messages

“Not a valid VLAN”
Returned if VLAN provided is invalid, e.g. > 4094
“vlan 1 is default vlan”
Returned if VLAN provided is 1.
“Vlan cannot be created, as it is not a user/fcoe vlan”
Returned if VLAN provided is part of user/FCOE VLAN (4087/4096/1002).
“Pls specify a valid description”
Returned if interface description length is less than 1.
“Length of the description is more than the allowed size”
Returned if interface description length is more than 63.
“rbridge_id and ip_address lists are not matching”
Returned if given rbridge_id and ip_address lists are not matching
“Invalid IP address <ip-address>”
Returned if ip address format is wrong e.g. 10.0.0.10.1
“Pass IP address along with netmask.(ip-address/netmask)”
Returned if IP address input is without netwmask e.g. 10.0.0.1.
“Invalid Input values while creating to Ve”
Returned if any one of the input is invalid.
“Invalid Input values while assigning IP address to Ve”
Returned if any one of the input is invalid.
“Invalid Input values while configuring IPV6 link local”
Returned if input is invalid.

VLAN to VNI Mapping

Prior releases of DC Fabric Automation Suite (version < 1.2) only supported auto-mapping of VLAN to VNI, i.e., configure_fabric_infra workflow configures VLAN to VNI mapping as auto under overlay gateway on all the leaf switches in the fabric. When auto-mapping is enabled, overlay gateway associates the VLANs the VNIs with the same ID. Auto-mapping is convenient in some deployments, however, in deployments where VLAN scaling and overlapping is required, users need to use manual mapping. This release provides user configurable option in fabric template so that users can choose auto or manual VLAN to VNI mapping during the fabric deployment.

A new fabric configuration parameter vni_auto_map has been introduced as part of fabric template, which can be set as ‘Yes/No’ while configuring the fabric settings. By default auto-mapping is enabled, however, users can create a fabric and set the value to No for manual mapping option.

NOTE: If a switch has been deployed using DC Fabric Automation Suite (version < v1.2), switch will contain VLAN to VNI mapping as auto under the overlay gateway configuration. To change from auto to manual mapping, auto mapping configured previously needs to be disabled on the switch using delete_vni_mapping action.

configure_vni_mapping

Description: This configure overlay gateway type and VLAN or Bridge-Domain to VNI mapping

Parameter Description
mgmt_ip

The management IP address of the target device.

Type: string

username

The login user name to connect to the device.

Type: string

Default: admin

password

The login password to connect to the device.

Type: string

Default: password

vlan_id

A single or a range of VLAN IDs, e.g. 10 or 10-15 or 10,12,13-15. For 802.1Q VLANs ID must be below 4096, for service or transport VFs in a Virtual Fabrics context, valid range is from 4096 through 8191.

Type: string

vlan_vni

A single or a range of VNI <NUMBER:1-16777215> mappings for VLANs, for example 10 or 10-15 or 10,12,13-15. When using ranges, the number of values in a VLAN ID range must correspond to the number of values in a VNI range.

Type: string

bridge_domain_id

A single or range of Bridge-Domain IDs, e.g. 10 or 10-15 or 10,12,13-15. Valid values are from 1 through 4096 on SLX9140,SLX9850,SLX9540 and from 1 through 3566 on SLX9240 .Supported only on SLXOS platforms.

Type: string

bridge_domain_vni

A single or range of VNI <NUMBER:1-16777215> mappings for BDs, for example 10 or 10-15 or 10,12,13-15. When using ranges, the number of values in a Bridge-Domain ID range must correspond to the number of values in a VNI range.

Type: string

delete_vni_mapping

Description: This action will delete the VLAN/Bridge-Domain to VNI and auto mapping under an overlay gateway.

Parameter Description
mgmt_ip

The management IP address of the target device.

Type: string

username

The login user name to connect to the device.

Type: string

Default: admin

password

The login password to connect to the device.

Type: string

Default: password

auto

If set to True, this will delete VLAN to VNI auto mapping under the overlay gateway.

Type: boolean

vlan_id

A single or a range of VLAN IDs, e.g. 10 or 10-15 or 10,12,13-15. For 802.1Q VLANs ID must be below 4096, for service or transport VFs in a Virtual Fabrics context, and valid range is from 4096 through 8191.

Type: string

bridge_domain_id

A single or range of Bridge-Domain IDs, e.g. 10 or 10-15 or 10,12,13-15. Valid values are from 1 through 4096 on SLX9140,SLX9850,SLX9540 and from 1 through 3566 on SLX9240.

Type: string

Actions

This section includes various building block actions that are used by the workflows above. These are provided as a reference, can be used to build workflows for any custom scenarios.

configure_anycast_gateway_evpn

Description: This configures anycast gateway address.

Parameter Description
mgmt_ip

The management IP address of the device.

Type: string

username

The login user name to connect to the device.

Type: string

Default: admin

password

The login password to connect to the device.

Type: string

Default: password

vlan_id

This is a single or a range of VLAN IDs, e.g. 10 or 10-15 or 10,12,13-15.

Type: string

anycast_address

This is a single or list of IPv4 or IPv6 address with subnet/prefix length separated by comma. e.g. 10.10.9.10/22 or 10.10.9.10/22,11.11.10.9/22.

Type: string

configure_anycast_gw_mac_evpn

Description: This configures anycast gateway address.

Parameter Description
mgmt_ip

The management IP of the Device.

Type: string

username

The login user name to connect to the device.

Type: string

Default: admin

password

The login password to connect to the device.

Type: string

Default: password

rbridge_id

The RBridge ID of the VDX switch. This parameter is only applicable for VDX switches.

Type: string

mac

The Anycast gateway MAC in XXXX.YYYY.ZZZZ format.

Type: string

type

The Anycast MAC configurarion for IPv4 and IPv6.

Choose from:

  • ipv4
  • ipv6

Default: ipv4

configure_conversational_arp_evpn

Description: This configure conversational ARP, ND learning.

Parameter Description
mgmt_ip

The management IP address of the target device.

Type: string

username

The login user name to connect to the device.

Type: string

Default: admin

password

The login password to connect to the device.

Type: string

Default: password

conversational_timeout

The aging conversational timeout value.

Type: integer

Default: 300

configure_conversational_mac_evpn

Description: This configure conversational MAC learning.

Parameter Description
mgmt_ip

The management IP address of the target device.

Type: string

username

The login user name to connect to the device.

Type: string

Default: admin

password

The login password to connect to the device.

Type: string

Default: password

aging_time

The aging-time for MAC address.

Type: integer

Default: 300

legacy_aging_time

The legacy-aging-time for MAC address.

Type: integer

Default: 1800

create_vrf_evpn

Description: This will create VRF for L3 tenants. It will assign l3vni, route_distinguisher and IPv4/IPv6 route target.

Parameter Description
mgmt_ip

The management IP address of the target device.

Type: string

username

The login user name to connect to the device.

Type: string

Default: admin

password

The login password to connect to the device.

Type: string

Default: password

vrf_name

The VRF name. For example vrf32 or 32.

Type: string

l3vni

THe VNI for the VRF. Valid Values for VDX. ‘<NUMBER:1-16777215>’, Valid Values for SLX. ‘<NUMBER:1-4096>’.

Type: integer

route_distinguisher

The VPN route Distinguisher. ‘<ASN:nn or IP-address:nn>’.

Type: array

ipv4_route_target_import_evpn

The IPv4 import target VPN community. ‘ASN:nn’.

Type: string

ipv4_route_target_export_evpn

The IPv4 export target VPN community. ‘ASN:nn’.

Type: string

ipv6_route_target_import_evpn

The IPv6 import target VPN community. ‘ASN:nn’.

Type: string

ipv6_route_target_export_evpn

The IPv6 import target VPN community. ‘ASN:nn’.

Type: string

rbridge_id

A single or a list of RBridge IDs separated by comma, for example, 1 or 1,2, 4. This parameter is only applicable for VDX switches.

Type: array

configure_arp_nd_suppression

Description: This configure ARP, ND suppression on a vlan or bridge domain.

Parameter Description
mgmt_ip

THe management IP address of the target device.

Type: string

user

The login user name to connect to the device.

Type: string

Default: admin

passwd

The login password to connect to the device.

Type: string

Default: password

vlan_id

The VLAN ID.

Type: string

bridge_domain_id

The Bridge-domain ID. Valid values are <1-4096> on SLX9140,SLX9850,SLX9540 and <1-3566> on SLX9240. Valid only on SLXOS devices.

Type: string

suppression_type

The suppression type

Choose from:

  • ARP
  • ND
  • Both

Default: ARP

configure_bgp_redistribute_connected

Description: This configure BGP route redistribution.

Parameter Description
host

The management IP address of the target device.

Type: string

user

The login user name to connect to the device.

Type: string

passwd

The login password to connect to the device.

Type: string

rbridge_id

The RBridge ID of the VDX switch. This parameter is only applicable. for VDX switches.

Type: string

vrf

The VRF name <1-32> characters.

Type: string

Default: default

source

The source type.

Choose from:

  • connected

Default: connected

afi

The IP address type.

Choose from:

  • ipv4
  • ipv6

Default: ipv4

configure_evpn_instance

Description: This configure EVPN instance on a switch or a vLAG pair.

Parameter Description
mgmt_ip

The management IP address of the target device.

Type: string

username

The login user name to connect to the device.

Type: string

Default: admin

password

The login password to connect to the device.

Type: string

Default: password

rbridge_id

The RBridge ID of the VDX switch. This parameter is only applicable for VDX switches.

Type: array

evi_name

The EVPN instance name., for example ‘evpn1 or 32’.

Type: string

duplicate_mac_timer

The duplicate MAC timer, in integer.

Type: integer

Default: 10

max_count

The max count, value in integer.

Type: integer

Default: 10

configure_evpn_vtep

Description: This configure EVPN VTEP on a leaf or vLAG pair.

Parameter Description
mgmt_ip

The management IP address of the target device

Type: string

username

The login user name to connect to the device.

Type: string

Default: admin

password

The login password to connect to the device.

Type: string

Default: password

loopback_id

The loopback ID, <NUMBER:1-255>.

Type: integer

rbridge_id

A single or a list of RBridge IDs separated by comma, for example, 1 or 1,2, 4. This parameter is only applicable for VDX switches.

Type: array

name

The overlay gateway name.

Type: string

vni_auto_map

This configure VLAN/bridge-domain to vni auto mapping under overlay gateway.

Type: boolean

Default: True

modify_arp_nd_aging_ve

Description: This will modify ARP and ND aging timers on the VE interface.

Parameter Description
mgmt_ip

The management IP address of the target device.

Type: string

username

The login user name to connect to the device.

Type: string

Default: admin

password

The login password to connect to the device.

Type: string

Default: password

rbridge_id

The RBridge ID of the VDX switch. This parameter is only applicable for VDX switches.

Type: array

vlan_id

This is a single or a range of VLAN IDs, e.g. 10 or 10-15 or 10,12,13-15.

Type: string

arp_aging_type

The ARP aging type

Choose from:

  • arp_aging
  • nd_cache_expiry

Default: arp_aging

arp_aging_timeout

The ARP aging timeout in minutes <0..240>.

Type: integer

Default: 4

nd_cache_expire_time

The ND cache expiration timeout in seconds <30-14400>.

Type: integer

Default: 270

provision_evpn_instance

Description: This will provision overlay EVPN Instance on a switch or a vLAG pair, also configure overlay gateway and advertise the overlay gateway through BGP.

Parameter Description
mgmt_ip

The management IP address of the target device.

Type: string

username

The login user name to connect to the device.

Type: string

Default: admin

password

The login password to connect to the device.

Type: string

Default: password

rbridge_id

The RBridge ID of the VDX switch. This parameter is only applicable for VDX switches.

Type: string

evi_name

The EVI instance name.

Type: string

vtep_name

The Overlay gateway name.

Type: string

vtep_loopback_id

The VTEP loopback ID <NUMBER:1-255>.

Type: integer

mac_move_threshold

The MAC move threshold <NUMBER:5-500>.

Type: integer

Default: 5

vni_auto_map

This will enable or disable auto-mapping of VLANs/Bridge-Domains to VNIs.

Type: boolean

Default: True

principal_ip

The principal IP address of the target device.

Type: string

mct_interfaces

The list of ports that are members of the port channel, 1/13, 1/14.

Type: array

node_id

The ID of the node values <1-128>.

Type: integer

Default: 1

evpn

The EVPN enabled fabric.

Type: boolean

Default: True

is_principal

The Principal Node of Cluster.

Type: boolean

redistribute_connected_bgp_vrf

Description: This will redistribute BGP connected routes under VRF address-family.

Parameter Description
mgmt_ip

The management IP address of the target device.

Type: string

username

The login user name to connect to the device.

Type: string

Default: admin

password

The login password to connect to the device.

Type: string

Default: password

rbridge_id

A single or list of RBridge IDs separated by comma, for example, 1 or 1,2, 4. This parameter is only applicable for VDX switches.

Type: array

ipv4_unicast

This will configure IPv4 unicast address family.

Type: boolean

ipv6_unicast

This will configure IPv6 unicast address family.

Type: boolean

ipv4_vrf_name

The IPv4 VRF name.

Type: string

ipv6_vrf_name

The IPv6 VRF name.

Type: string

set_max_path_bgp

Description: This configures maximum paths for BGP under VRF address-family.

Parameter Description
mgmt_ip

The management IP address of the target device.

Type: string

username

The login user name to connect to the device.

Type: string

Default: admin

password

The login password to connect to the device.

Type: string

Default: password

rbridge_id

A single or a list of ports that are members of the port channel. Examples for VDX, SLX are 24/0/1, 24/0/2 or 1/13, 1/14.

Type: array

ipv4_unicast

This enables IPv4 unicast address family.

Type: boolean

ipv6_unicast

This enables IPv6 unicast address family.

Type: boolean

ipv4_vrf_name

The IPv4 VRF name.

Type: string

ipv6_vrf_name

The IPv6 VRF name.

Type: string

maximum_paths

This forwards packets over multiple paths.

Type: integer

Default: 8

clear_bgp_evpn_neighbor

Description: This clears BGP EVPN neighbor session.

Parameter Description
mgmt_ip

The management IP address of the target device.

Type: string

username

The login user name to connect to the device.

Type: string

Default: admin

password

The login password to connect to the device.

Type: string

Default: password

neighbor_address

The neighbor IP address in format.

Type: array

role

The role of the Node.

Type: string

Default: Leaf