Note

The documentation you're currently reading is for version 2.3.0. 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 parameter to be added or updated

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

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

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: Configure IP fabric infrastructure

Parameter Description
fabric

Name of the IP fabric template

Type: string

Default: default

username

Login user name to connect to the device

Type: string

password

Login password to connect to the device

Type: string

batch_size

Number of switches to configure concurrently

Type: integer

Default: 10

state

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: Create EVPN VXLAN based L2 broadcast domain spanning multiple switches or a vLAG pair

Parameter Description
mgmt_ip

Management IP address of the target device

Type: string

username

Login user name to connect to the device

Type: string

Default: admin

password

Login password to connect to the device

Type: string

Default: password

vni

VNI to be added for EVPN Instance (<NUMBER:1-16777215>) example 1,2,4-6

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: Create VRF, create L3VNI on VE interface and assign VRF forwarding, redistribute connected routes in the BGP VRF address families.

Parameter Description
mgmt_ip

Management IP address of the target device

Type: string

username

Login user name to connect to the device

Type: string

Default: admin

password

Login password to connect to the device

Type: string

Default: password

vrf_name

VRF name, 1-32 characters

Type: string

l3vni

L3VNI for the VRF <1-8191>

Type: integer

route_distinguisher

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

Type: array

rt

RT for the address family, for example, 101

Type: integer

tenant_addressing_type

Tenant IP addressing type

Choose from:

  • ipv4
  • ipv6
  • both
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: Create VLAN, port channel and configure port channel as Access or Trunk, validate port channel state.

Parameter Description
mgmt_ip

Management IP address of the target device

Type: string

username

Login user name to connect to the device

Type: string

Default: admin

password

Login password to connect to the device

Type: string

Default: password

vlan_id

Single or range of VLANs

Type: string

vlan_desc

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

Type: string

intf_type

Interface type

Choose from:

  • ethernet
  • tengigabitethernet
  • gigabitethernet
  • fortygigabitethernet
  • hundredgigabitethernet

Default: tengigabitethernet

ports

Single or 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

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

port_channel_id

Portchannel interface number <NUMBER:1-6144>

Type: string

port_channel_desc

Port channel description without any space.

Type: string

mode

Port channel type

Choose from:

  • standard
  • brocade

Default: standard

protocol

Port channel mode

Choose from:

  • active
  • passive
  • modeon

Default: active

mtu

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

add_multihomed_endpoint_and_gw_evpn

Description: Add an endpoint (Server, FW, LB, VM) to an existing L3 tenant in an EVPN IP fabric and also configures IP Anycast Gateway.

Parameter Description
mgmt_ip

Management IP address of the target device

Type: string

username

Login user name to connect to the device

Type: string

Default: admin

password

Login password to connect to the device

Type: string

Default: password

intf_type

Interface type

Choose from:

  • gigabitethernet
  • tengigabitethernet
  • fortygigabitethernet
  • hundredgigabitethernet
  • port_channel

Default: tengigabitethernet

intf_name

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

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

Type: string

enabled

Select 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

Portchannel interface number <NUMBER:1-6144>, if auto pick option is selected and switchport_mode is access no need to specify the VLAN ID.

Type: string

port_channel_desc

Port channel description without any space

Type: string

mode

Port channel type.

Choose from:

  • standard
  • brocade

Default: standard

protocol

port channel mode

Choose from:

  • active
  • passive
  • modeon

Default: active

switchport_mode

Switch port mode

Choose from:

  • access
  • trunk

Default: access

vlan_id

Single VLAN ID

Type: string

vlan_desc

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

Type: string

vrf_name

VRF name

Type: string

anycast_address

IPv4 or IPv6 address with subnet/prefix length.

Type: string

arp_aging_type

Aging type

Choose from:

  • arp_aging
  • nd_cache_expiry

Default: arp_aging

arp_aging_timeout

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

Type: integer

Default: 4

nd_cache_expire_time

Cache expiry timeout in seconds <30-14400>.

Type: integer

Default: 270

mtu

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

Type: integer

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: Traces the data path through the IP Fabric network and checks the integrity of the route-programming on the devices along the data path. 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 not reaching the destination.

Parameter Description
host

Management IP address of the target device

Type: string

username

username to ssh into host

Type: string

Default: admin

password

password for login into switch

Type: string

Default: password

fabric

Fabric name

Type: string

mac_da

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

Type: string

mac_sa

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

Type: string

dip

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

Type: string

sip

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

Type: string

vlan

VLAN ID

Type: string

interface

Ingress interface name in slot/port

Type: string

verbose

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: Construct the IP Fabric topology using the inventory

Parameter Description
fabric

Name of the IP fabric

Type: string

Default: default

state

Filter 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

Brocade 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 Brocade VCS Fabric for various deployment models.

add_multihomed_endpoint

Description: Create VLAN, port channel and configure port channel as Access or Trunk, validate port channel state.

Parameter Description
mgmt_ip

Management IP address of the target device

Type: string

username

Login user name to connect to the device

Type: string

Default: admin

password

Login password to connect to the device

Type: string

Default: password

vlan_id

Single or range of VLANs

Type: string

vlan_desc

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

Type: string

intf_type

Interface type

Choose from:

  • ethernet
  • tengigabitethernet
  • gigabitethernet
  • fortygigabitethernet
  • hundredgigabitethernet

Default: tengigabitethernet

ports

Single or 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

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

port_channel_id

Portchannel interface number <NUMBER:1-6144>

Type: string

port_channel_desc

Port channel description without any space.

Type: string

mode

Port channel type

Choose from:

  • standard
  • brocade

Default: standard

protocol

Port channel mode

Choose from:

  • active
  • passive
  • modeon

Default: active

mtu

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

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: Add 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

Management IP address of the target device

Type: string

username

Login user name to connect to the device

Type: string

Default: admin

password

Login password to connect to the device

Type: string

Default: password

rbridge_id

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

Type: array

intf_type

Interface type

Choose from:

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

Default: tengigabitethernet

intf_name

Single or 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

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

Type: string

enabled

Enable or disable admin setting on the interface

Type: boolean

Default: True

vlan_id

Single or range of VLAN(s)

Type: string

vlan_desc

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

Type: string

switchport_mode

Switch port mode

Choose from:

  • access
  • trunk

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

Port channel interface number.<NUMBER:1-6144>

Type: string

port_channel_desc

Port channel description without any space

Type: string

mode

Portchannel type

Choose from:

  • standard
  • brocade

Default: standard

protocol

Portchannel mode type

Choose from:

  • active
  • passive
  • modeon

Default: active

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

Virtual group ID

Type: string

virtual_ip

VRRPe virtual IP address without the netmask

Type: string

vrf_name

VRF name. For example vrf32 or 32.

Type: string

afi

IP address type

Choose from:

  • ipv4
  • ipv6

Default: ipv4

mtu

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

Type: integer

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: Create VLAN, configure interface as Access or Trunk, and validate interface state.

Parameter Description
mgmt_ip

Management IP address of the target device

Type: string

username

Login user name to connect to the device

Type: string

Default: admin

password

Login password to connect to the device

Type: string

Default: password

vlan_id

Single or range of VLANs

Type: string

vlan_desc

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

Type: string

intf_type

Interface type

Choose from:

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

Default: tengigabitethernet

intf_name

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

Type: string

intf_desc

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

Type: string

enabled

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

Type: boolean

Default: True

switchport_mode

Switch port mode

Choose from:

  • access
  • trunk

Default: access

configure_vrrpe_gw

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

Parameter Description
mgmt_ip

Management IP address of the target device

Type: string

username

Login user name to connect to the device

Type: string

Default: admin

password

Login password to connect to the device

Type: string

Default: password

rbridge_id

Single Rbridge or list of Rbridge’s separated by comma that needs ve/vrrpe creation

Type: array

vlan_id

VLAN ID

Type: string

vlan_desc

Vlan description without any space

Type: string

ve_ip

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

vrid

Virtual group ID

Type: string

virtual_ip

VRRPe virtual IP address without the netmask

Type: string

vrf_name

VRF name, for example vrf32 or 32

Type: string

afi

IP address type

Choose from:

  • ipv4
  • ipv6

Default: ipv4

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.

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: Configure anycast gateway address

Parameter Description
mgmt_ip

Management IP of the Device

Type: string

username

Login user name to connect to the device

Type: string

Default: admin

password

Login password to connect to the device

Type: string

Default: password

vlan_id

VLAN ID

Type: string

anycast_address

IPv4 or IPv6 address with subnet/prefix length.

Type: string

configure_anycast_gw_mac_evpn

Description: Configure anycast gateway address

Parameter Description
mgmt_ip

Management IP of the Device

Type: string

username

Login user name to connect to the device

Type: string

Default: admin

password

Login password to connect to the device

Type: string

Default: password

rbridge_id

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

Type: string

mac

Anycast gateway MAC

Type: string

configure_conversational_arp_evpn

Description: Configure conversational ARP, ND learning

Parameter Description
mgmt_ip

Management IP address of the target device

Type: string

username

Login user name to connect to the device

Type: string

Default: admin

password

Login password to connect to the device

Type: string

Default: password

configure_conversational_mac_evpn

Description: Configure conversational MAC learning

Parameter Description
mgmt_ip

Management IP address of the target device

Type: string

username

Login user name to connect to the device

Type: string

Default: admin

password

Login password to connect to the device

Type: string

Default: password

create_vrf_evpn

Description: Create VRF for L3 tenants.Assign l3vni,route_distinguisher and ipv4/ipv6 route target.

Parameter Description
mgmt_ip

Management IP address of the target device

Type: string

username

Login user name to connect to the device

Type: string

Default: admin

password

Login password to connect to the device

Type: string

Default: password

vrf_name

VRF name. For example vrf32 or 32

Type: string

l3vni

VNI for the VRF. ‘<NUMBER:1-16777215>’. Supported only for VDX

Type: integer

route_distinguisher

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

Type: array

ipv4_route_target_import_evpn

IPv4 import target VPN community. ‘ASN:nn’. Supported only for VDX

Type: string

ipv4_route_target_export_evpn

IPv4 export target VPN community. ‘ASN:nn’. Supported only for VDX

Type: string

ipv6_route_target_import_evpn

IPv6 import target VPN community. ‘ASN:nn’. Supported only for VDX

Type: string

ipv6_route_target_export_evpn

IPv6 import target VPN community. ‘ASN:nn’. Supported only for VDX

Type: string

rbridge_id

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

configure_arp_nd_suppression

Description: Configure ARP, ND suppression

Parameter Description
mgmt_ip

Management IP address of the target device

Type: string

user

Login user name to connect to the device

Type: string

Default: admin

passwd

Login password to connect to the device

Type: string

Default: password

vlan_id

VLAN ID

Type: string

suppression_type

Suppression type

Choose from:

  • ARP
  • ND
  • Both

configure_bgp_redistribute_connected

Description: Configure BGP route redistribution

Parameter Description
host

Management IP address of the target device

Type: string

user

Login user name to connect to the device

Type: string

passwd

Login password to connect to the device

Type: string

rbridge_id

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

Type: string

vrf

VRF name <1-32> characters.

Type: string

Default: default

source

Source type

Choose from:

  • connected

Default: connected

afi

IP address type

Choose from:

  • ipv4
  • ipv6

Default: ipv4

configure_evpn_instance

Description: Configure EVPN instance on a switch or a vLAG pair

Parameter Description
mgmt_ip

Management IP address of the target device

Type: string

username

Login user name to connect to the device

Type: string

Default: admin

password

Login password to connect to the device

Type: string

Default: password

rbridge_id

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

Type: array

evi_name

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

Type: string

duplicate_mac_timer

Duplicate MAC timer, in integer

Type: integer

Default: 10

max_count

Max count, value in integer

Type: integer

Default: 10

configure_evpn_vtep

Description: Configure EVPN VTEP on a leaf or vLAG pair

Parameter Description
mgmt_ip

Management IP address of the target device

Type: string

username

Login user name to connect to the device

Type: string

Default: admin

password

Login password to connect to the device

Type: string

Default: password

loopback_id

Loopback ID, <NUMBER:1-255>

Type: integer

rbridge_id

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

name

Overlay gateway name

Type: string

modify_arp_nd_aging_ve

Description: Modify ARP and ND aging timers on VE interface

Parameter Description
mgmt_ip

Management IP address of the target device

Type: string

username

Login user name to connect to the device

Type: string

Default: admin

password

Login password to connect to the device

Type: string

Default: password

rbridge_id

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

Type: array

vlan_id

VLAN ID

Type: string

arp_aging_type

Aging type

Choose from:

  • arp_aging
  • nd_cache_expiry
arp_aging_timeout

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

Type: integer

Default: 4

nd_cache_expire_time

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

Type: integer

Default: 270

provision_evpn_instance

Description: 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

Management IP address of the target device

Type: string

username

Login user name to connect to the device

Type: string

Default: admin

password

Login password to connect to the device

Type: string

Default: password

rbridge_id

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

Type: string

evi_name

EVI instance name

Type: string

vtep_name

Overlay gateway name

Type: string

vtep_loopback_id

VTEP loopback ID (<NUMBER:1-255>)

Type: integer

mac_move_threshold

MAC move threshold <NUMBER:5-500>

Type: integer

Default: 5

redistribute_connected_bgp_vrf

Description: Redistribute BGP connected routes under VRF address-family

Parameter Description
mgmt_ip

Management IP address of the target device

Type: string

username

Login user name to connect to the device

Type: string

Default: admin

password

Login password to connect to the device

Type: string

Default: password

rbridge_id

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

Configure IPv4 unicast address family

Type: boolean

ipv6_unicast

Configure IPv6 unicast address family

Type: boolean

ipv4_vrf_name

IPv4 VRF name

Type: string

ipv6_vrf_name

IPv6 VRF name

Type: string

set_max_path_bgp

Description: Configure maximum paths for BGP under VRF address-family

Parameter Description
mgmt_ip

Management IP address of the target device

Type: string

username

Login user name to connect to the device

Type: string

Default: admin

password

Login password to connect to the device

Type: string

Default: password

rbridge_id

Single or 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

Enable IPv4 unicast address family

Type: boolean

ipv6_unicast

Enable IPv6 unicast address family

Type: boolean

ipv4_vrf_name

IPv4 VRF name

Type: string

ipv6_vrf_name

IPv6 VRF name

Type: string

maximum_paths

Forward packets over multiple paths

Type: integer

Default: 8