VXLAN EVPN Overlay Functions¶
emulation vxlan evpn overlay port config¶
Execute Tester Command ${rt_handle} command=test_control <additional key=value arguments>
- Purpose:
Spirent Extension (for Spirent HLTAPI only).
Configures VXLAN EVPN Overlay ports and interfaces
Synopsis:
Note: M indicates the argument is `Mandatory`.
emulation vxlan evpn overlay port config
port_handle= <port_handle>
mode= {create}
router_id= <a.b.c.d>
router_id_step= <a.b.c.d>
tunnel_ip_mode= {interface | route rid}
vtep_ip_addr= <a.b.c.d>
vtep_ip_addr_step= <a.b.c.d>
prefix_len= <0-32>
gw_ip_addr= <a.b.c.d>
gw_ip_addr_step= <a.b.c.d>
mac_addr= <aa:bb:cc:dd:ee:ff>
mac_addr_step= <aa:bb:cc:dd:ee:ff>
vlan_enable= {true | false}
vlan_id= <1-4095>
vlan_id_step= <1-4095>
vlan_count= <1-65535>
gw_ipv6_addr= <aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh>
gw_ipv6_addr_step= <aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh>
ipv6_prefix_len= <0-128>
vtep_ipv6_addr= <aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh>
vtep_ipv6_addr_step= <aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh>
vtep_ipv6_link_local_addr= <aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh>
vtep_ipv6_link_local_addr_step= <aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh>
ipv6_router_id= <aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh>
ipv6_router_id_step= <aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh>
Arguments:
port_handle
Specifies the port on which VXLAN Tunnel End Point (VTEP) and
Virtual Machine (VM) devices will be emulated. This argument is
`Mandatory`.
mode
Specifies the action to perform
Values::
create Configures VTEPs or VMs on the port specified by port_handle
Default: create
router_id
Specifies the router ID of the emulated device
Values: IPv4
Default: 10.1.1.1
router_id_step
Specifies the step value by which to create subsequent router IDs
Values: 32bit mask
Default: 0.0.0.1
tunnel_ip_mode
Specifies the source of the tunnel IP address
Values: interfaceip, routerid
Default: interfaceip
vtep_ip_addr
Specifies the IP address of the emulated VTEP device
Values: IPv4
Default: 192.168.100.2
vtep_ip_addr_step
Specifies the step value by which to generate subsequent IP
addresses for VTEPs
Values: 32bit mask
Default: 0.0.0.1
prefix_len
Specifies the prefix length on the provider subnet
Values: 0-32
Default: 24
gw_ip_addr
Specifies the IP address of the first gateway
Values: IPv4
Default: 192.168.100.1
gw_ip_addr_step
Specifies the step value by which to generate subsequent gateway
IP addresses
Values: 32bit mask
Default: 0.0.0.1
mac_addr
Specifies the first MAC address of the emulated device
Values: MAC
Default: 10:00:00:10:00:01
mac_addr_step
Specifies the step value by which to generate subsequent MAC addresses
Values: 48bit mask
Default: 00:00:00:00:00:01
vlan_enable
Enables or disables VLAN
Values: true (enable), false (disable)
Default: false
vlan_id
Specifies the ID for the first VLAN in a block
Dependency: vlan_enable true
Values: 1-4095
Default: 1
vlan_id_step
Specifies the step value by which to generate subsequent VLAN IDs
Values: 1-4095
Default: 1
vlan_count
Specifies the VLAN count
Values: 1-65535
Default: 1
gw_ipv6_addr
Specifies the VTEP Gateway IPv6 Address to be configured if VTEP
encap is IPv6
Values: IPv6
Default: 2000::1
gw_ipv6_addr_step
Specifies the VTEP Gateway IPv6 Address Step to be configured if
VTEP encap is IPv6
Values: 64bit mask
Default: 0::1
ipv6_prefix_len
Specifies the Prefix Length of IPv6 Prefixes to be configured if
VTEP encap is IPv6
Values: 0-128
Default: 64
vtep_ipv6_addr
Specifies the VTEP IPv6 Address to be configured if VTEP encap
is IPv6
Values: IPv6
Default: 2000::2
vtep_ipv6_addr_step
Specifies the VTEP IPv6 Address step to be configured if VTEP encap
is IPv6
Values: 64bit mask
Default: 0::1
vtep_ipv6_link_local_addr
Specifies the VTEP IPv6 Link Local Address to be configured if VTEP
encap is IPv6
Values: IPv6
Default: FE80::1
vtep_ipv6_link_local_addr_step
Specifies the VTEP IPv6 Link Local Address step to be configured
if VTEP encap is IPv6
Values: 64bit mask
Default: :::
ipv6_router_id
Specifies the VTEP Router ID IPv6 Address to be configured if
VTEP encap is IPv6
Values: IPv6
Default: 2001::1
ipv6_router_id_step
Specifies the VTEP Router ID IPv6 Address step to be configured
if VTEP encap is IPv6
Values: 64bit mask
Default: 0::1
- Return Values:
Depending on the specific language that HLTAPI uses, the function returns a keyed list/dictionary/hash (See Introduction for more information on return value formats) using the following keys (with corresponding data):
handle VXLAN EVPN Overlay port handle created by the function status Success (1) or failure (0) of the operation log An error message (if the operation failed)
- Description:
The
emulation vxlan evpn overlay port configfunction configures VXLAN EVPN Overlay ports and interfaces, mapping the operation of the VXLAN EVPN Overlay wizard on the Spirent TestCenter GUI.If the operation fails, Spirent HLTAPI returns an error message.
Examples:
The following example configures VXLAN EVPN Overlay ports and interfaces:
set VxPort1 [emulation vxlan evpn overlay port config mode= create port_handle= $port1 vlan_enable= true mac_addr_step= 00:00:00:00:00:02 mac_addr= AA:00:00:AA:00:04 vtep_ip_addr= 192.160.50.100 gw_ip_addr= 192.160.50.1 gw_ip_addr_step= 0.0.0.3 vlan_count= 4 prefix_len= 24 vlan_id_step= 5 vlan_id= 1000 router_id= 10.1.10.1 router_id_step= 0.0.1.0 tunnel_ip_mode= interfacip ]Sample Output:
{handle vxlanevpnoverlaygenvtepportparams1} {status 1}
emulation nonvxlan evpn overlay port config¶
Execute Tester Command ${rt_handle} command=test_control <additional key=value arguments>
- Purpose:
Spirent Extension (for Spirent HLTAPI only).
Configures nonVXLAN EVPN Overlay ports and interfaces
Synopsis:
Note: M indicates the argument is `Mandatory`.
emulation nonvxlan evpn overlay port config
port_handle= <port_handle>
mode= {create}
type= {L2_VNI | L3_VNI | L2_L3_VNI}
NonVXLAN= Port Configurations (Layer 2 VNI)
l2_gw_ip_addr= <a.b.c.d>
l2_gw_ip_addr_step= <a.b.c.d>
l2_gw_ip_addr_step_seg= <a.b.c.d>
l2_mac_addr= <aa:bb:cc:dd:ee:ff>
l2_mac_addr_step= <aa:bb:cc:dd:ee:ff>
l2_mac_addr_step_seg= <aa:bb:cc:dd:ee:ff>
l2_vlan_enable= {true | false}
l2_vlan_id= <1-4095>
l2_vlan_id_step= <1-4095>
l2_addr_mode= {mac | ipv4 | ipv6 | ipv4_ipv6}
l2_ip_addr= <a.b.c.d>
l2_ip_addr_step= <a.b.c.d>
l2_ip_prefix= <0-32>
l2_ip_addr_step_seg= <a.b.c.d>
l2_ipv6_addr= <aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh>
l2_ipv6_addr_step= <aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh>
l2_ipv6_prefix= <0-128>
l2_ipv6_addr_step_seg= <aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh>
l2_gw_ipv6_addr= <aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh>
l2_gw_ipv6_addr_step= <aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh>
l2_gw_ipv6_addr_step_seg= <aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh>
l2_host_per_seg= <1-65535>
l2_vni_in_mac= {true | false}
l2_vni_in_mac_len= {2_byte | 3_byte}
l2_mask_2bytes= <ENUM>
l2_mask_3bytes= <ENUM>
l2_attached_vtep_ipv4_addr= <a.b.c.d>
l2_attached_vtep_ipv6_addr= <aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh>
l2_enable_type5_prefix_match= {true | false}
l2_override_attached_vtep_ip= {true | false}
NonVXLAN= Port Configurations (Layer 3 VNI)
l3_gw_ip_addr= <a.b.c.d>
l3_gw_ip_addr_step= <a.b.c.d>
l3_gw_ip_addr_step_seg= <a.b.c.d>
l3_mac_addr= <aa:bb:cc:dd:ee:ff>
l3_mac_addr_step= <aa:bb:cc:dd:ee:ff>
l3_mac_addr_step_seg= <aa:bb:cc:dd:ee:ff>
l3_vlan_enable= {true | false}
l3_vlan_id= <1-4095>
l3_vlan_id_step= <1-4095>
l3_addr_mode= {ipv4 | ipv6 | ipv4_ipv6}
l3_ip_addr= <a.b.c.d>
l3_ip_addr_step= <a.b.c.d>
l3_ip_prefix= <0-32>
l3_ip_addr_step_seg= <a.b.c.d>
l3_ipv6_addr= <aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh>
l3_ipv6_addr_step= <aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh>
l3_ipv6_prefix= <0-128>
l3_ipv6_addr_step_seg= <aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh>
l3_gw_ipv6_addr= <aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh>
l3_gw_ipv6_addr_step= <aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh>
l3_gw_ipv6_addr_step_seg= <aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh>
l3_host_per_seg= <1-65535>
l3_l2_vni_in_mac= {true | false}
l3_l2_vni_in_mac_len= {2_byte | 3_byte}
l3_l2_mask_2bytes= <ENUM>
l3_l2_mask_3bytes= <ENUM>
l3_attached_vtep_ipv4_addr= <a.b.c.d>
l3_attached_vtep_ipv6_addr= <aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh>
l3_enable_type5_prefix_match= {true | false}
l3_override_attached_vtep_ip= {true | false}
Arguments:
port_handle
Specifies the port on which nonVXLAN hosts will be emulated.
This argument is `Mandatory`.
mode
Specifies the action to perform
Values::
create Creates hosts on the port specified by port_handle
Default: create
type
Specifies the VNI type of the nonVXLAN port
Values: L2_VNI, L3_VNI, L2_L3_VNI
Default: L2_VNI
NonVXLAN Port Configurations (Layer 2 VNI)
l2_gw_ip_addr
Specifies the IP address of the first Layer 2 gateway
Dependency: type L2_VNI/L2_L3_VNI
Default: 192.168.100.1
l2_gw_ip_addr_step
Specifies the step value by which to generate subsequent gateway
IP addresses
Dependency: type L2_VNI/L2_L3_VNI
Values: 32bit mask
Default: 0.0.0.1
l2_gw_ip_addr_step_seg
Specifies the step value by which to generate subsequent gateway
IP address across segment blocks
Values: 32bit mask
Default: 0.0.0.1
l2_mac_addr
Specifies the first MAC address of the emulated device
Values: MAC
Default: 10:00:00:10:00:01
l2_mac_addr_step
Specifies the step value by which to generate subsequent MAC addresses
Values: 48bit mask
Default: 00:00:00:00:00:01
l2_mac_addr_step_seg
Specifies the step value by which to generate subsequent MAC
addresses across segment blocks
Values: 48bit mask
Default: 00:00:00:00:01:00
l2_vlan_enable
Enables or disables VLANs
Values: true (enable), false (disable)
Default: false
l2_vlan_id
Specifies the first VLAN ID in the block
Dependency: l2_vlan_enable true
Values: 1-4095
Default: 1
l2_vlan_id_step
Specifies the step value by which to generate subsequent VLAN IDs
Values: 1-4095
Default: 1
l2_addr_mode
Specifies the address mode of the host
Values: mac, ipv4, ipv6, ipv4_ipv6
Default: ipv4
l2_ip_addr
Specifies the IP address of the emulated device
Values: IPv4
Default: 192.168.100.2
l2_ip_addr_step
Specifies the step value by which to generate subsequent IPv4
addresses
Values: 32bit mask
Default: 00.0.1
l2_ip_prefix
Specifies the prefix length of the IP address
Values: 0-32
Default: 24
l2_ip_addr_step_seg
Specifies the step value by which to generate subsequent IPv4
addresses across segment blocks
Values: 32bit mask
Default: 0.1.0.0
l2_ipv6_addr
Specifies the IPv6 address of the emulated device
Values: IPv6
Default: 5001::2
l2_ipv6_addr_step
Specifies the step value by which to generate subsequent IPv6
addresses
Values: 128bit mask
Default: 0::1
l2_ipv6_prefix
Specifies the prefix length for the IPv6 address
Values: 0-128
Default: 64
l2_ipv6_addr_step_seg
Specifies the step value by which to generate subsequent IPv6
addresses across segment blocks
Values: 128bit mask
Default: ::1:0
l2_gw_ipv6_addr
Specifies the IPv6 address of the first gateway
Values: IPv6
Default: 5001::1
l2_gw_ipv6_addr_step
Specifies the step value by which to generate subsequent gateway
IPv6 addresses
Values: 128bit mask
Default: 0::1
l2_gw_ipv6_addr_step_seg
Specifies the step value by which to generate subsequent gateway
IPv6 addresses across segment blocks
Values: 128bit mask
Default: ::1:0
l2_host_per_seg
Specifies the number of hosts to be created per segment block
Values: 1-65535
Default: 1
l2_vni_in_mac
Determines whether to include the Layer 2 VNI value in the host
MAC address of the nonVXLAN EVPN Overlay port
Dependency::
l2_split_seg (emulation_vxlan_evpn_overlay_wizard_config) true
Values: true, false
Default: false
l2_vni_in_mac_len
Specifies the length of the Layer 2 VNI to be included in the
host MAC address of the nonVXLAN EVPN Overlay port
Values: 2_byte, 3_byte
Default: 2_byte
l2_mask_2bytes
A 2byte mask to specify the position of the Layer 2 VNI
Dependency::
l2_split_seg (emulation_vxlan_evpn_overlay_wizard_config) true
l2_vni_in_mac_len 2_byte
Values::
MASK_FF_FF_00_00_00_00
MASK_00_FF_FF_00_00_00
MASK_00_00_FF_FF_00_00
MASK_00_00_00_FF_FF_00
MASK_00_00_00_00_FF_FF
Default: MASK_FF_FF_00_00_00_00
l2_mask_3bytes
A 3byte mask to specify the position of the Layer 2 VNI
Dependency::
l2_split_seg (emulation_vxlan_evpn_overlay_wizard_config) true
l2_vni_in_mac_len 3_byte
Values::
MASK_FF_FF_FF_00_00_00
MASK_00_FF_FF_FF_00_00
MASK_00_00_FF_FF_FF_00
MASK_00_00_00_FF_FF_FF
Default: MASK_FF_FF_FF_00_00_00
l2_attached_vtep_ipv4_addr
Specifies the attached VTEP IPv4 Address for host
Values: IPv4
Default: 192.85.100.1
l2_attached_vtep_ipv6_addr
Specifies the attached VTEP IPv6 Address for host
addresses
Values: IPv6
Default: 5001::1
l2_enable_type5_prefix_match
Enable to match Type-5 Prefix for the host
Values: true (enable), false (disable)
Default: false
l2_override_attached_vtep_ip
Enable to override attached VTEP IP for host
Values: true (enable), false (disable)
Default: false
NonVXLAN Port Configurations (Layer 3 VNI)
l3_gw_ip_addr
Specifies the IP address of the first Layer 3 gateway
Values: IPv4
Default: 192.168.100.1
l3_gw_ip_addr_step
Specifies the step value by which to generate subsequent gateway
IP addresses
Values: 32bit mask
Default: 0.0.0.1
l3_gw_ip_addr_step_seg
Specifies the step value by which to generate additional gateway
IP addresses across segment blocks
Values: 32bit mask
Default: 0.0.0.1
l3_mac_addr
Specifies the first MAC address of the emulated device
Values: MAC
Default: 10:00:00:10:00:01
l3_mac_addr_step
Specifies the step value by which to generate subsequent MAC
addresses
Values: 48bit mask
Default: 00:00:00:00:00:01
l3_mac_addr_step_seg
Specifies the step value by which to generate subsequent MAC
addresses across segment blocks
Values: 48bit mask
Default: 00:00:00:00:01:00
l3_vlan_enable
Enables or disables Layer 3 VLANs
Values: true (enable), false (disable).
Default: false
l3_vlan_id
Specifies the ID for the first VLAN in the block
Dependency: l3_vlan_enable true
Values: 1-4095
Default: 1
l3_vlan_id_step
Specifies the step value by which to generate subsequent VLAN IDs
Values: 1-4095
Default: 1
l3_addr_mode
Specifies the address mode for Layer 3 hosts
Values: ipv4, ipv6, ipv4_ipv6 (ipv4 and ipv6)
Default: ipv4
l3_ip_addr
Specifies the IP address of the emulated Layer 3 device
Values: IPv4
Default: 192.168.100.2
l3_ip_addr_step
Specifies the step value by which to generate subsequent IPv4
addresses
Values: 32bit mask
Default: 0.0.0.1
l3_ip_prefix
Specifies the prefix length for the IP address
Values: 0-32
Default: 24
l3_ip_addr_step_seg
Specifies the step value by which to generate subsequent IP
addresses across segment blocks
Values: 32bit mask
Default: 0.1.0.0
l3_ipv6_addr
Specifies the IPv6 address of the emulated Layer 3 device
Values: IPv6
Default: 5001::2
l3_ipv6_addr_step
Specifies the step value by which to generate subsequent IPv6 addresses
Values: 128bit mask
Default: 0::1
l3_ipv6_prefix
Specifies the prefix length for the IPv6 address
Values: 0-128
Default: 64
l3_ipv6_addr_step_seg
Specifies the step value by which to generate subsequent IPv6
addresses across segment blocks
Values: 128bit mask
Default: ::1:0
l3_gw_ipv6_addr
Specifies the IPv6 address of the first Layer 3 gateway
Values: IPv6
Default: 5001::1
l3_gw_ipv6_addr_step
Specifies the step value by which to generate subsequent gateway
IPv6 addresses
Values: 128bit mask
Default: 0::1
l3_gw_ipv6_addr_step_seg
Specifies the step value by which to generate subsequent IPv6
gateway addresses across segment blocks
Values: 128bit mask
Default: ::1:0
l3_host_per_seg
Specifies the number of hosts per segment
Values: 1-65535
Default: 1
l3_l2_vni_in_mac
Determines whether to include the Layer 2 VNI value in the host
MAC address of the L3 VNI NonVXLAN port
Dependency::
l2_split_seg (emulation_vxlan_evpn_overlay_wizard_config) true
Values: true, false
Default: false
l3_l2_vni_in_mac_len
Specifies the length of the Layer 2 VNI to be included in the host
MAC address of the Layer 3 VNI's NonVXLAN port
Dependency::
l2_split_seg (emulation_vxlan_evpn_overlay_wizard_config) true
Values: 2_byte, 3_byte
Default: 2_byte
l3_l2_mask_2bytes
A 2byte mask to specify the position of the Layer 3 VNI
Dependency::
l2_split_seg (emulation_vxlan_evpn_overlay_wizard_config) true
l3_l2_vni_in_mac_len 3_byte
Values::
MASK_FF_FF_00_00_00_00
MASK_00_FF_FF_00_00_00
MASK_00_00_FF_FF_00_00
MASK_00_00_00_FF_FF_00
MASK_00_00_00_00_FF_FF
Default: MASK_FF_FF_00_00_00_00
l3_l2_mask_3bytes
A 3byte mask to specify the position of the Layer 3 VNI
Dependency::
l2_split_seg (emulation_vxlan_evpn_overlay_wizard_config) true
l3_l2_vni_in_mac_len 3_byte
Values::
MASK_FF_FF_FF_00_00_00
MASK_00_FF_FF_FF_00_00
MASK_00_00_FF_FF_FF_00
MASK_00_00_00_FF_FF_FF
Default: MASK_FF_FF_FF_00_00_00
l3_attached_vtep_ipv4_addr
Specifies the attached VTEP IPv4 Address for host
Values: IPv4
Default: 192.85.100.1
l3_attached_vtep_ipv6_addr
Specifies the attached VTEP IPv6 Address for host
addresses
Values: IPv6
Default: 5001::1
l3_enable_type5_prefix_match
Enable to match Type-5 Prefix for the host
Values: true (enable), false (disable)
Default: false
l3_override_attached_vtep_ip
Enable to override attached VTEP IP for host
Values: true (enable), false (disable)
Default: false
- Return Values:
Depending on the specific language that HLTAPI uses, the function returns a keyed list/dictionary/hash (See Introduction for more information on return value formats) using the following keys (with corresponding data):
- handle
- All nonVXLAN EVPN Overlay port handles created by the function
- l2_handle
- Layer 2 VNI nonVXLAN port handle created by the function
- l3_handle
- Layer 3 VNI nonVXLAN EVPN Overlay port handle created by the function
- status
- Success (1) or failure (0) of the operation
- log
- An error message (if the operation failed)
- Description:
The
emulation nonvxlan evpn overlay port configfunction configures nonVXLAN EVPN Overlay ports and interfaces, mapping the operation of the VXLAN EVPN Overlay wizard on the Spirent TestCenter GUI.If the operation fails, Spirent HLTAPI returns an error message.
Examples:
The following example configures nonVXLAN= EVPN Overlay ports and interfaces:
set nonVxPort1 [emulation nonvxlan evpn overlay port config mode= create port_handle= $port4 type= L2_L3_VNI l2_gw_ip_addr= 172.0.0.1 l2_gw_ip_addr_step= 0.0.0.1 l2_gw_ip_addr_step= 0.0.1.0 l2_mac_addr= 0a:00:00:0a:00:01 l2_mac_addr_step= 00:00:00:00:00:02 l2_mac_addr_step_s= 00:00:00:00:02:01 l2_vlan_enable= true l2_vlan_id_step= 1 l2_vlan_id= 15 l2_addr_mode= ipv4_ipv6 l2_gw_ipv6_addr= 6000::1 l2_ip_addr= 172.0.0.8 l2_ip_addr_step= 0.0.2.0 l2_ip_addr_step_se= 0.0.3.0 l2_ip_prefix= 32 l2_host_per_seg= 1 l2_ipv6_addr= 6000::3 l2_ipv6_addr_step= 0::2 l2_ipv6_prefix= 128 l2_vni_in_mac= true l2_vni_in_mac_len= 3_byte l2_mask_2bytes= MASK_00_FF_FF_00_00_00 l2_mask_3bytes= MASK_00_00_00_FF_FF_FF l3_mac_addr_step= 0a:00:00:00:00:01 l3_mac_addr= 00:10:94:00:00:01 l3_mac_addr_step_s= 0a:00:00:00:10:00 l3_gw_ip_addr= 172.16.10.10 l3_gw_ip_addr_step= 0.0.0.2 l3_gw_ip_addr_step= 0.0.1.0 l3_addr_mode= ipv4_ipv6 l3_ip_prefix= 24 l3_vlan_enable= true l3_vlan_id_step= 1 l3_vlan_id= 25 l3_host_per_seg= 1 ]Sample Output:
{l2_handle vxlanevpnoverlaygenl2vnihostportparams1} {l3_handle vxlanevpnoverlaygenl3vnihostportparams1} {handle {vxlanevpnoverlaygenl2vnihostportparams1 vxlanevpnoverlaygenl3vnihostportparams1}} {status 1}
emulation vxlan evpn overlay wizard config¶
Execute Tester Command ${rt_handle} command=test_control <additional key=value arguments>
- Purpose:
Spirent Extension (for Spirent HLTAPI only).
Creates or deletes the VXLAN EVPN Overlay topology, mapping the operations of VXLAN EVPN Overlay wizard on the Spirent TestCenter GUI.
Synopsis:
Note: M indicates the argument is `Mandatory`.
emulation vxlan evpn overlay wizard config
handle= <vxlan_evpn_overlay_wizard_parameters_handle>
mode= {create | delete}
VTEP parameters
irb_enable= {true|false}
irb_mode= {symmetric}
igp_protocol= {bgp | ospf}
multi_homed_vtep= {true | false}
vteps_per_vlan= <1-65535>
route_reflector_enable= {true | false}
multi_homed_vtep_type= {within_port | across_vlan | across_port}
multi_homed_vteps_per_port= <1-65535>
spi_or_gw_count= <2-65535>
dut_per_spi_or_gw= <1-65535>
same_mac_ip_for_vtep= {true | false}
same_spi_gw_for_vtep= {true | false}
udp_src_port_auto_select= {true | false}
udp_src_port= <1-65535>
udp_src_port_step= <1-32767>
udp_checksum_enable= {true | false}
BGP underlay parameters
bgp_underlay_as_byte_mode= {2_byte | 4_byte}
bgp_underlay_as_num= <1-65535>
bgp_underlay_as_num_4_byte= <Number.Number>
bgp_underlay_as_num_4_byte_step= <Number.Number>
bgp_underlay_as_num_step= <1-65535>
bgp_underlay_bgp_mode= {ibgp | ebgp}
bgp_underlay_dut_as= <1-65535>
bgp_underlay_dut_as_4_byte= <Number.Number>
bgp_underlay_dut_as_4_byte_step= <Number.Number>
bgp_underlay_dut_as_step= <1-65535>
bgp_underlay_dut_ip_addr= <a.b.c.d>
bgp_underlay_dut_ip_addr_step= <a.b.c.d>
bgp_underlay_gateway_ip_addr= <a.b.c.d>
bgp_underlay_gateway_ip_addr_step= <a.b.c.d>
bgp_underlay_ip_addr= <a.b.c.d>
bgp_underlay_ip_addr_step= <a.b.c.d>
bgp_underlay_dut_ipv6_addr= <aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh>
bgp_underlay_dut_ipv6_addr_step= <aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh>
bgp_underlay_ipv6_addr= <aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh>
bgp_underlay_ipv6_addr_step= <aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh>
bgp_underlay_gateway_ipv6_addr= <aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh>
bgp_underlay_gateway_ipv6_addr_step= <aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh>
bgp_underlay_prefix_len= <0-32>
bgp_underlay_mac_addr= <MAC>
bgp_underlay_mac_addr_step= <MAC
bgp_underlay_ipv6_prefix_len= <0-128>
bgp_underlay_router_id= <a.b.c.d>
bgp_underlay_router_id_step= <a.b.c.d>
bgp_underlay_router_id_ipv6= <aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh>
bgp_underlay_router_id_ipv6_step= <aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh>
bgp_underlay_ipv6_link_local_addr= <aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh>
bgp_underlay_use_gateway_as_dut= {true | false}
bgp_underlay_vxlan_bgp_session_ip= {interface_ip | router_id}
OSPFv2 underlay parameters
ospfv2_underlay_area_id= <a.b.c.d>
ospfv2_underlay_router_priority= <0-255>
ospfv2_underlay_if_cost= <1-65535>
ospfv2_underlay_options= {tbit|ebit|mcbit|npbit|eabit|dcbit|obit|unused7}
ospfv2_underlay_network_type= {native|broadcast|p2p}
ospfv2_underlay_enable_graceful_restart= {true|false}
ospfv2_underlay_graceful_restart_type= {none|rfcstandard|llsignalling}
ospfv2_underlay_enable_bfd= {true|false}
ospfv2_underlay_sr_algorithm_tlv= <string>
ospfv2_underlay_tlv_sid_range= <integer>
ospfv2_underlay_tlv_sid_base= <integer>
ospfv2_underlay_if_sub_tlv_index= <integer>
ospfv2_underlay_if_sub_tlv_index_step= <integer>
ospfv2_underlay_authentication= {none|simple|md5}
ospfv2_underlay_md5_key_id= <integer>
ospfv2_underlay_password= <string>
Route Reflector parameters
rr_as_byte_mode= {2_byte | 4_byte}
rr_as_num= <1-65535>
rr_as_num_4_byte= <Number.Number>
rr_as_num_4_byte_step= <Number.Number>
rr_as_num_step= <1-65535>
rr_bgp_mode= {ibgp | ebgp}
rr_dut_as= <1-65535>
rr_dut_as_4_byte= <Number.Number>
rr_dut_as_4_byte_step= <Number.Number>
rr_dut_as_step= <1-65535>
rr_dut_ip_addr= <a.b.c.d>
rr_dut_ip_addr_step= <a.b.c.d>
rr_gateway_ip_addr= <a.b.c.d>
rr_gateway_ip_addr_step= <a.b.c.d>
rr_ip_addr= <a.b.c.d>
rr_ip_addr_step= <a.b.c.d>
rr_mac_addr= <MAC>
rr_mac_addr_step= <MAC>
rr_prefix_len= <0-32>
rr_route_ref_count_per_port= <NUMERIC>
rr_router_id= <a.b.c.d>
rr_router_id_step= <a.b.c.d>
rr_use_gateway_as_dut= {true | false}
rr_vtep_to_route_ref_map= {many_to_one | linear | round_robin}
rr_vxlan_bgp_session_ip= {interface_ip | router_id}
BGP parameters
bgp_mode= {ibgp | ebgp}
as_byte_mode= {as2byte | as4byte}
dut_as= <1-65535>
dut_as_step_device= <0-65535>
dut_as_step_port= <0-65535>
dut_as_4byte= <Number:Number>
dut_as_4byte_step_device= <string>
dut_as_4byte_step_port= <string>
as= <1-65535>
as_step_device= <0-65535>
as_step_port= <0-65535>
as_4byte= <Number:Number>
as_4byte_step_device= <string>
as_4byte_step_port= <string>
dut_ip_addr= <a.b.c.d>
dut_ip_addr_step= <a.b.c.d>
dut_ipv6_addr= <aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh>
dut_ipv6_addr_step= <aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh>
vtep_encap_type= {ipv4 | ipv6}
bgp_session_ip= {interfaceip | routerid}
use_gw_as_dut= {true | false}
EVPN Route parameters
evpn_ad_route= {true | false}
evpn_active_standby_mode= {all_active | single_active}
evpn_ad_route_evi= {true | false}
evpn_ad_route_esi= {true | false}
evpn_mac_ip_route= {true | false}
evpn_mac_ip_route_mac_and_ip= {true | false}
evpn_mac_ip_route_mac_only= {true | false}
evpn_inclusive_multicast_route= {true | false}
evpn_ether_seg_route= {true | false}
evpn_ip_prefix_route= {true | false}
evpn_ip_unicast_route= {true | false}
evpn_ether_seg_value_type= {type0 | type1 | type2 | type3 | type4 | type5}
evpn_ether_tag_id= <integer>
evpn_ether_seg_id= <X:X:X:X:X:X:X:X:X>
evpn_ether_seg_id_step= <X:X:X:X:X:X:X:X:X>
evpn_next_hop_config= {true | false}
evpn_next_hop_ip= <a.b.c.d>
evpn_next_hop_device_step= <a.b.c.d>
evpn_next_hop_port_step= <a.b.c.d>
evpn_evpn_router_mac_ext_community= {true | false}
evpn_enable_pack_routes= {true | false}
evpn_next_hop_ipv6= <aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh>
evpn_next_hop_device_ipv6_step= <aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh>
evpn_next_hop_ipv6_port_step= <aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh>
evpn_next_hop_ipv6_link_local= <aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh>
evpn_next_hop_device_ipv6_link_local_step= <aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh>
evpn_next_hop_ipv6_link_local_port_step= <aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh>
evpn_vxlan_ipv6_unicast_route= {true | false}
Segment information parameters
vrf_enable= {true | false}
vrf_id= <1-65535>
vrf_step= <1-65535>
vrf_rt= <ENUM>
l3_vni= <1-16777215>
l3_vni_step= <1-16777215>
l3_vni_per_vtep= <1-16777215>
l2_vni_per_l3_vni= <1-16777215>
l3_vni_per_block= <1-16777215>
l3_auto_vrf_rdrt= {true | false}
l3_vni_rt_enum= <ENUM>
l3_vni_rd_enum= <ENUM>
l3_vni_rt= <Number:Number>
l3_vni_rd= <Number:Number>
l3_vni_rd_offset= <0-65535>
l3_vni_rt_step= <Number:Number>
l3_vni_rd_step= <Number:Number>
l2_vni= <1-16777215>
l2_vni_step= <1-16777215>
l2_vni_per_vtep= <1-16777215>
l2_vni_per_block= <1-16777215>
l2_vni_block_step= <1-16777215>
l2_split_seg= {true | false}
l2_auto_vrf_rdrt= {true | false}
l2_vni_rt_enum= <ENUM>
l2_vni_rd_enum= <ENUM>
l2_vni_rt= <Number:Number>
l2_vni_rd= <Number:Number>
l2_vni_rd_offset= <0-65535>
l2_vni_rt_step= <Number:Number>
l2_vni_rd_step= <Number:Number>
same_vnis_across_ports= {true | false}
same_vnis_across_vteps= {true | false}
traffic_endpoint_mode= {L2_VNI | L3_VNI | L2_L3_VNI}
configure_l3_segments= {true | false}
ipv6_vxlan_l2_rd= {AS_L2_VNI | AS_L3_VNI | AS_VLAN}
ipv6_vxlan_l2_rt= {AS_L2_VNI | AS_L3_VNI | AS_VLAN}
ipv6_vxlan_l3_rd= {AS_L2_VNI | AS_L3_VNI | AS_VLAN}
ipv6_vxlan_l3_rt= {AS_L2_VNI | AS_L3_VNI | AS_VLAN}
ipv6_vxlan_vrf_rt= {AS_L2_VNI | AS_L3_VNI | AS_VLAN | VRF_ID_VRF_ID | CUSTOM}
same_l2_rd_rt_across_vteps= {true | false}
same_l2_vnis_across_ports= {true | false}
same_l2_vnis_across_vteps= {true | false}
same_l3_rd_rt_across_vteps= {true | false}
same_tenant_rt_across_vteps= {true | false}
tenant_vrf_rt_target= <Number:Number>
tenant_vrf_rt_target_step= <Number:Number>
L2 VNI VM device parameters
vm_l2_addr_mode= {mac | ipv4 | ipv6 | ipv4_ipv6}
vms_l2_per_seg= <1-10000>
vm_l2_vlan_enable= {true | false}
vm_l2_vlan_id= <1-4095>
vm_l2_vlan_id_step= <1-4095>
vm_l2_vni_in_mac= {true | false}
vm_l2_vni_in_mac_len= {2_byte | 3_byte}
vm_l2_mask_2bytes= <ENUM>
vm_l2_mask_3bytes= <ENUM>
vm_l2_mac_addr= <aa:bb:cc:dd:ee:ff>
vm_l2_mac_addr_step= <aa:bb:cc:dd:ee:ff>
vm_l2_mac_addr_step_seg= <aa:bb:cc:dd:ee:ff>
vm_l2_mac_addr_step_vtep= <aa:bb:cc:dd:ee:ff>
vm_l2_ip_addr= <a.b.c.d>
vm_l2_ip_addr_step= <a.b.c.d>
vm_l2_ip_addr_step_seg= <a.b.c.d>
vm_l2_ip_addr_step_port= <a.b.c.d>
vm_l2_ip_addr_step_vtep= <a.b.c.d>
vm_l2_gw_addr= <a.b.c.d>
vm_l2_gw_addr_step= <a.b.c.d>
vm_l2_gw_addr_step_seg= <a.b.c.d>
vm_l2_gw_addr_step_port= <a.b.c.d>
vm_l2_gw_addr_step_vtep= <a.b.c.d>
vm_l2_ip_prefix= <0-32>
vm_l2_ipv6_addr= <aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh>
vm_l2_ipv6_addr_step= <aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh>
vm_l2_ipv6_addr_step_seg= <aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh>
vm_l2_ipv6_addr_step_port= <aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh>
vm_l2_ipv6_addr_step_vtep= <aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh>
vm_l2_ipv6_gw_addr= <aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh>
vm_l2_ipv6_gw_addr_step= <aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh>
vm_l2_ipv6_gw_addr_step_seg= <aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh>
vm_l2_ipv6_gw_addr_step_port= <aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh>
vm_l2_ipv6_gw_addr_step_vtep= <aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh>
vm_l2_ipv6_prefix= <0-128>
L3 VNI VM device parameters
vm_l3_addr_mode= {ipv4 | ipv6 | ipv4_ipv6}
vms_l3_per_seg= <1-10000>
vm_l3_vlan_enable= {true | false}
vm_l3_vlan_id= <1-4095>
vm_l3_vlan_id_step= <1-4095>
vm_l3_l2_vni_in_mac= {true | false}
vm_l3_l2_vni_in_mac_len= {2_byte | 3_byte}
vm_l3_l2_mask_2bytes= <ENUM>
vm_l3_l2_mask_3bytes= <ENUM>
vm_l3_mac_addr= <aa:bb:cc:dd:ee:ff>
vm_l3_mac_addr_step= <aa:bb:cc:dd:ee:ff>
vm_l3_mac_addr_step_seg= <aa:bb:cc:dd:ee:ff>
vm_l3_mac_addr_step_vtep= <aa:bb:cc:dd:ee:ff>
vm_l3_ip_addr= <a.b.c.d>
vm_l3_ip_addr_step= <a.b.c.d>
vm_l3_ip_addr_step_seg= <a.b.c.d>
vm_l3_ip_addr_step_port= <a.b.c.d>
vm_l3_ip_addr_step_vtep= <a.b.c.d>
vm_l3_gw_addr= <a.b.c.d>
vm_l3_gw_addr_step= <a.b.c.d>
vm_l3_gw_addr_step_seg= <a.b.c.d>
vm_l3_gw_addr_step_port= <a.b.c.d>
vm_l3_gw_addr_step_vtep= <a.b.c.d>
vm_l3_ip_prefix= <0-32>
vm_l3_ipv6_addr= <aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh>
vm_l3_ipv6_addr_step= <aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh>
vm_l3_ipv6_addr_step_seg= <aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh>
vm_l3_ipv6_addr_step_port= <aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh>
vm_l3_ipv6_addr_step_vtep= <aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh>
vm_l3_ipv6_gw_addr= <aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh>
vm_l3_ipv6_gw_addr_step= <aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh>
vm_l3_ipv6_gw_addr_step_seg= <aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh>
vm_l3_ipv6_gw_addr_step_port= <aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh>
vm_l3_ipv6_gw_addr_step_vtep= <aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh>
vm_l3_ipv6_prefix= <0-128>
IP Prefix Route parameters
ippr_mode= {ipv4 | ipv6 | ipv4_ipv6}
ippr_vni_type= {L2_VNI | L3_VNI}
ippr_count_seg= <1-65535>
ippr_auto_vrf_rdrt= {true | false}
ippr_rt_enum= <ENUM>
ippr_rd_enum= <ENUM>
ippr_rt= <Number:Number>
ippr_rd= <Number:Number>
ippr_rd_offset= <0-65535>
ippr_rt_step= <Number:Number>
ippr_rd_step= <Number:Number>
ippr_prefix_length= <a.b.c.d>
ippr_prefix= <a.b.c.d>
ippr_prefix_step= <a.b.c.d>
ippr_prefix_step_seg= <a.b.c.d>
ippr_prefix_step_port= <a.b.c.d>
ippr_prefix_step_vtep= <a.b.c.d>
ippr_v6_prefix_length= <0-128>
ippr_v6_prefix= <aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh>
ippr_v6_prefix_step= <aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh>
ippr_v6_prefix_step_seg= <aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh>
ippr_v6_prefix_step_port= <aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh>
ippr_v6_prefix_step_vtep= <aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh>
ippr_advertise_gw_in_type2= {true | false}
ippr_gw_type= {VA | VTEP}
ippr_gw_mac_addr= <aa:bb:cc:dd:ee:ff>
ippr_gw_mac_addr_step= <aa:bb:cc:dd:ee:ff>
ippr_gw_mac_addr_step_seg= <aa:bb:cc:dd:ee:ff>
ippr_gw_mac_addr_step_port= <aa:bb:cc:dd:ee:ff>
ippr_gw_ip_addr= <a.b.c.d>
ippr_gw_ip_addr_step= <a.b.c.d>
ippr_gw_ip_addr_step_seg= <a.b.c.d>
ippr_gw_ip_addr_step_port= <a.b.c.d>
ippr_gw_ipv6_addr= <aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh>
ippr_gw_ipv6_addr_step= <aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh>
ippr_gw_ipv6_addr_step_seg= <aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh>
ippr_gw_ipv6_addr_step_port= <aaaa:bbbb:cccc:dddd:eeee:ffff:gggg:hhhh>
enable_type5_prefix_match= {true | false}
same_ipprefix_rdrt_accross_vteps= {true | false}
ippr_v6_vxlan_ip_prefix_rd= {AS_L2_VNI| AS_L3_VNI | AS_VLAN}
ippr_v6_vxlan_ip_prefix_rt= {AS_L2_VNI| AS_L3_VNI | AS_VLAN}
Traffic parameters
create_traffic= {true | false}
traffic_config= {auto | manual}
traffic_direction= {bidirectional | upstream | downstream}
east_ports= <port_handles>
west_ports= <port_handles>
end_point_mapping= {one_to_one | fully_mesh}
ip_encap= {true | false}
ipv6_encap= {true | false}
mac_encap= {true | false}
traffic_profile_l2= {true | false}
traffic_profile_l3= {true | false}
Arguments:
handle
The VXLAN EVPN Overlay wizard configuration handle returned by
this API. You must specify this argument for mode delete.
mode
Specifies the action to perform
Values::
create
Creates the VXLAN EVPN Overlay test topology
delete
Delete all handles created by this function. You must
use this before you recreate a VXLAN EVPN Overlay
wizard configuration
Default: create
VTEP parameters (multi_homed_vtep true)
irb_enable
Enables or disables integrated routing and bridging (IRB)
support for the EVPN Overlay emulation
Values: true (enable), false (disable)
Default: false
irb_mode
Specifies the IRB mode
Dependency: irb_enable true
Values:
symmetric
The ingress VTEP and the egress VTEP perform both Layer
2 bridging and Layer 3 routing lookup
Default: symmetric
igp_protocol
Specifies the IGP protocol.
Possible values are bgp and ospf.
multi_homed_vtep
Enables or disables multihomed VXLAN Tunnel End Point (VTEP)
Values: true (enable), false (disable)
Default: false
vteps_per_vlan
Specifies the number of VTEP devices per VLAN
Dependency: multi_homed_vtep false
Values: 1-65535
Default: 1
route_reflector_enable
Enables or disables route reflector
Values: true (enable), false (disable)
Default: false
multi_homed_vtep_type
Specifies the type of multihomed VTEPs
Dependency: multi_homed_vtep true
Values: within_port, across_vlan, across_port
Default: within_port
multi_homed_vteps_per_port
Specifies the number of multihomed VTEPs to create per port
Dependency: multi_homed_vtep true
Values: 1-65535
Default: 1
spi_or_gw_count
Specifies the number of emulated spines or gateways to create
Dependency: multi_homed_vtep true
Values: 2-65535
Default: 2
dut_per_spi_or_gw
Specifies the number of DUTs per spine or gateway
Dependency: multi_homed_vtep true
Values: 1-65535
Default: 1
same_mac_ip_for_vtep
Specifies whether to use the same MAC or IP address for
multihomed VTEP interfaces
Dependency: multi_homed_vtep true
Values: true, false
Default: false
same_spi_gw_for_vtep
Specifies whether to use the same spine or gateway interface for VTEPs
Dependency: multi_homed_vtep true
Values: true, false
Default: true
udp_src_port_auto_select
Determines whether to generate port numbers automatically
Values: true, false
Default: true
udp_src_port
Specifies the UDP source port of the first VTEP
Dependency: auto_select_udp_src_port false
Values: 1-65535
Default: 1025
udp_src_port_step
Specifies the step value by which to create UDP source
ports for subsequent VTEPs
Dependency: auto_select_udp_src_port false
Values: 1-32767
Default: 1
udp_checksum_enable
Enables or disables UDP checksum
Values: true (enable), false (disable)
Default: false
BGP underlay parameters
bgp_underlay_as_byte_mode
Specifies the BGP underlay AS byte mode to be configured.
Dependency: igp_protocol bgp
Values: 2_byte, 4_byte
Default: 2_byte
bgp_underlay_as_num
Specifies the BGP underlay AS number to be configured.
Dependency: igp_protocol bgp
Values: 1-65535
Default: 1
bgp_underlay_as_num_step
Specifies the BGP underlay AS number IP step to be
configured.
Dependency: igp_protocol bgp
Values: 1-65535
Default: 1
bgp_underlay_as_num_4_byte
Specifies the BGP underlay AS 4byte to be configured.
Dependency: igp_protocol bgp
Default: 1.1
bgp_underlay_as_num_4_byte_step
Specifies the BGP underlay AS 4byte step to be configured.
Dependency: igp_protocol bgp
Default: 0
bgp_underlay_bgp_mode
Specifies the BGP underlay BGP mode to be configured.
Dependency: igp_protocol bgp
Values: ibgp (internal BGP), ebgp (external BGP)
Default: ebgp
bgp_underlay_dut_as
Specifies the BGP underlay DUT AS to be configured.
Dependency: igp_protocol bgp
Values: 1-65535
Default: 1001
bgp_underlay_dut_as_step
Specifies the BGP underlay DUT AS step to be configured.
Dependency: igp_protocol bgp
Values: 1-65535
Default: 1
bgp_underlay_dut_as_4_byte
Specifies the BGP underlay DUT AS 4byte to be configured.
Dependency: igp_protocol bgp
Default: 1.1001
bgp_underlay_dut_as_4_byte_step
Specifies the BGP underlay DUT AS 4byte step to be configured.
Dependency: igp_protocol bgp
Default: 0
bgp_underlay_dut_ip_addr
Specifies the BGP underlay DUT IP address to be configured.
Dependency: igp_protocol bgp
Values: IPv4
Default: 10.0.0.1
bgp_underlay_dut_ip_addr_step
Specifies the BGP underlay DUT IP address step to be configured.
addresses
Dependency: igp_protocol bgp
Values: 32bit mask
Default: 0.0.0.1
bgp_underlay_gateway_ip_addr
Specifies the BGP underlay gateway IP to be configured.
Dependency: igp_protocol bgp
Values: IPv4
Default: 193.168.100.1
bgp_underlay_gateway_ip_addr_step
Specifies the BGP underlay gateway IP step to be configured.
Dependency: igp_protocol bgp
Values: 32bit mask
Default: 0.0.0.1
bgp_underlay_ip_addr
Specifies the BGP underlay interface IP address to be configured.
Dependency: igp_protocol bgp
Values: IPv4
Default: 193.168.100.2
bgp_underlay_ip_addr_step
Specifies the BGP underlay interface IP address step to
be configured.
Dependency: igp_protocol bgp
Values: 32bit mask
Default: 0.0.0.1
bgp_underlay_mac_addr
Specifies the BGP underlay MAC address to be configured.
Dependency: igp_protocol bgp
Values: MAC
Default: 00:10:00:10:00:01
bgp_underlay_mac_addr_step
Specifies the BGP underlay MAC address step to be configured.
Dependency: igp_protocol bgp
Values: MAC
Default: 00:00:00:00:00:01
bgp_underlay_prefix_len
Specifies the BGP underlay prefix to be configured.
Dependency: igp_protocol bgp
Values: 1-32
Default: 24
bgp_underlay_router_id
Specifies the BGP underlay router ID address to be
configured.
Dependency: igp_protocol bgp
Values: IPv4
Default: 10.10.1.1
bgp_underlay_router_id_step
Specifies the BGP underlay router ID address step
to be configured.
Dependency: igp_protocol bgp
Values: IPv4
Default: 0.0.0.1
bgp_underlay_dut_ipv6_addr
Specifies the BGP underlay DUT IPv6 address to be configured.
Dependency: igp_protocol bgp
Values: IPv6
Default: 2000::1
bgp_underlay_dut_ipv6_addr_step
Specifies the BGP underlay DUT IPv6 address step
to be configured.
Dependency: igp_protocol bgp
Values: IPv6
Default: 0::1
bgp_underlay_gateway_ipv6_addr
Specifies the BGP underlay gateway IPv6 address
to be configured.
Dependency: igp_protocol bgp
Values: IPv6
Default: 2000::1
bgp_underlay_gateway_ipv6_addr_step
Specifies the BGP underlay gateway IPv6 address
step to be configured.
Dependency: igp_protocol bgp
Values: IPv6
Default: 0::1
bgp_underlay_ipv6_addr
Specifies the BGP underlay IPv6 address to be configured.
Dependency: igp_protocol bgp
Values: IPv6
Default: 2000::2
bgp_underlay_ipv6_addr_step
Specifies the BGP underlay IPv6 address step to
be configured.
Dependency: igp_protocol bgp
Values: 32bit mask
Default: 0::1
bgp_underlay_ipv6_prefix_len
Specifies the prefix length of BGP underlay IPv6
prefixes to be configured.
Dependency: igp_protocol bgp
Values: 1-128
Default: 64
bgp_underlay_router_id_ipv6
Specifies the BGP underlay router ID IPv6 address
to be configured.
Dependency: igp_protocol bgp
Values: IPv6
Default: 2001::1
bgp_underlay_router_id_ipv6_step
Specifies the BGP underlay router ID IPv6 address
step to be configured.
Dependency: igp_protocol bgp
Values: IPv6
Default: 0::1
bgp_underlay_ipv6_link_local_addr
Specifies the BGP underlay IPv6 link local address to
be configured
Values: IPv6
Default: fe80::1
bgp_underlay_use_gateway_as_dut
Enable use gateway as DUT on BGP underlay.
Dependency: igp_protocol bgp
Values: true (use gateway as DUT), false
(do not use gateway as DUT)
Default: false
bgp_underlay_vxlan_bgp_session_ip
Specifies the BGP underlay session IP address mode to
be configured.
Dependency: igp_protocol bgp
Values: interface_ip, router_id
Default: interface_ip
OSPFv2 underlay parameters
ospfv2_underlay_area_id
Specifies the OSPF area to which the router belongs.
The default area ID is 0.0.0.0.
Dependency: igp_protocol ospf
ospfv2_underlay_router_priority
Specifies the priority for the emulated router.
Possible values are 0 to 255. The default is 0.
Dependency: igp_protocol ospf
ospfv2_underlay_if_cost
Specifies the interface cost.
Possible values are 1 to 65535. The default is 1.
Dependency: igp_protocol ospf
ospfv2_underlay_options
Specifies the options.
Dependency: igp_protocol ospf
Possible values are described below::
Value Description
TBIT T bit, TOS.
EBIT E bit, External Routing.
MCBIT MC bit, Multicast.
NPBIT N/P bit, NSSA.
EABIT EA bit, External Attribute.
DCBIT DC bit, Demand Circuit.
OBIT O bit, Opaque.
UNUSED unused.
The default is EBIT.
ospfv2_underlay_network_type
Indicates the type of network for the interface.
Dependency: igp_protocol ospf
Possible values are::
broadcast - Indicates that the network is a broadcast
network, as in an Ethernet connection.
ptop - Pointto-point (PTOP). A network formed by a
pointto-point link between two routers.
native - Specifies that the interface on OSPF session uses the
default adjacency implied by the port type. Use this setting
to override the physical link type to emulate a broadcast
adjacency over POS, or a pointto-point adjacency over
Ethernet.
The default value is native.
ospfv2_underlay_enable_graceful_restart
Specifies if OSPF graceful restart is enabled on the
simulated router. Possible values are 1 (enable graceful
restart) or 0 (disable graceful restart). The default is 0.
Dependency: igp_protocol ospf
ospfv2_underlay_graceful_restart_type
Specifies the graceful restart type. You must set
ospfv2_underlay_enable_graceful_restart to true and
igp_protocol ospf.
In OSPFv2, possible values are::
none No graceful restart
rfcstandard Follows RFC 3623
llsignalling LinkLayer Signaling
ospfv2_underlay_enable_bfd
Specifies to enable or disable Bidirectional Forwarding
Detection (BFD).
Dependency: igp_protocol ospf
Possible values are 1 (enable)
and 0 (disable). The default is 0.
ospfv2_underlay_sr_algorithm_tlv
Specifies SR algorithm TLV value.
Dependency: igp_protocol ospf
The default is 0.
ospfv2_underlay_tlv_sid_range
Specifies the size of the SID/Label range.
Dependency: igp_protocol ospf
Possible values range from 0 to 65535. The default value is 100.
ospfv2_underlay_tlv_sid_base
Specifies the starting value of the SID or label
for SID/Label Range TLV. The default is 100.
Dependency: igp_protocol ospf
ospfv2_underlay_if_sub_tlv_index
Specifies the prefix SID sub TLV index. The value must be an integer.
The default value is 0.
Dependency: igp_protocol ospf
ospfv2_underlay_if_sub_tlv_index_step
Specifies the prefix SID sub TLV index step. The value must be an integer.
The default value is 1.
Dependency: igp_protocol ospf
ospfv2_underlay_authentication
Specifies the authentication mode for an
interface.
Dependency: igp_protocol ospf
Possible values are::
none - No authentication
simple - Simple authentication uses a password (key) that is
configured on each router and is included in plain text
in each OSPF packet originated by that router
md5 - MD5 authentication is based on shared secret keys that
are configured in all routers in the area
The default value is none.
ospfv2_underlay_md5_key_id
Specifies the MD5 key ID to use for MD5
authentication mode. To use this argument, you must specify
ospfv2_underlay_authentication md5. Possible values range from 1
to 255. The default is 1.
Dependency: igp_protocol ospf
ospfv2_underlay_password
Assigns a password that is used by neighboring
OSPF routers on an area that is using OSPF's simple password
authentication. The default is "Spirent". To use this
argument, you must specify ospfv2_underlay_authentication simple.
Dependency: igp_protocol ospf
BGP Route Reflector parameters
rr_as_byte_mode
Specifies the AS byte mode
Dependency: route_reflector_enable true
Values: 2_byte, 4_byte
Default: 2_byte
rr_as_num
Specifies the autonomous system number
Dependency: route_reflector_enable true
Values: 1-65535
Default: 1
rr_as_num_step
Specifies the autonomous system number step
Dependency: route_reflector_enable true
Values: 1-65535
Default: 1
rr_as_num_4_byte
Specifies the 4byte autonomous system number
Dependency: route_reflector_enable true
Default: 1.1
rr_as_num_4_byte_step
Specifies the 4byte autonomous system number step
Dependency: route_reflector_enable true
Default: 0
rr_bgp_mode
Specifies the BGP mode
Dependency: route_reflector_enable true
Values: ibgp (internal BGP), ebgp (external BGP)
Default: ebgp
rr_dut_as
Specifies the autonomous system number for DUT
Dependency: route_reflector_enable true
Values: 1-65535
Default: 1001
rr_dut_as_step
Specifies the autonomous system number step for DUT
Dependency: route_reflector_enable true
Values: 1-65535
Default: 1
rr_dut_as_4_byte
Specifies the 4byte autonomous system number for DUT
Dependency: route_reflector_enable true
Default: 1.1001
rr_dut_as_4_byte_step
Specifies the 4byte autonomous system number step for DUT
Dependency: route_reflector_enable true
Default: 0
rr_dut_ip_addr
Specifies the IP address of the DUT
Dependency: route_reflector_enable true
Values: IPv4
Default: 10.0.0.1
rr_dut_ip_addr_step
Specifies the step value by which to create subsequent DUT IPv4
addresses
Dependency: route_reflector_enable true
Values: 32bit mask
Default: 0.0.0.1
rr_gateway_ip_addr
Specifies the gateway IP address
Dependency: route_reflector_enable true
Values: IPv4
Default: 193.168.100.1
rr_gateway_ip_addr_step
Specifies the gateway IP address step value
Dependency: route_reflector_enable true
Values: 32bit mask
Default: 0.0.0.1
rr_ip_addr
Specifies the IP address for BGP
Dependency: route_reflector_enable true
Values: IPv4
Default: 193.168.100.2
rr_ip_addr_step
Specifies the IP address step value for BGP
Dependency: route_reflector_enable true
Values: 32bit mask
Default: 0.0.0.1
rr_mac_addr
Specifies the MAC address
Dependency: route_reflector_enable true
Values: MAC
Default: 00:10:00:10:00:01
rr_mac_addr_step
Specifies the MAC address step value
Dependency: route_reflector_enable true
Values: MAC
Default: 00:00:00:00:00:01
rr_prefix_len
Specifies the prefix length
Dependency: route_reflector_enable true
Values: 1-32
Default: 24
rr_route_ref_count_per_port
Specifies the number of route reflectors per port
Dependency: route_reflector_enable true
Values: 1-100
Default: 1
rr_router_id
Specifies the router ID for BGP
Dependency: route_reflector_enable true
Values: IPv4
Default: 10.10.1.1
rr_router_id_step
Specifies the router ID step for BGP
Dependency: route_reflector_enable true
Values: IPv4
Default: 0.0.0.1
rr_use_gateway_as_dut
Specifies the prefix length
Dependency: route_reflector_enable true
Values: true (use gateway as DUT), false (do not use gateway as DUT)
Default: false
rr_vtep_to_route_ref_map
Specifies the mapping between VTEP to route reflector
Dependency: route_reflector_enable true
Values: many_to_one, round_robin, and linear
Default: many_to_one
rr_vxlan_bgp_session_ip
Specifies the element to use for the session IP address of BGP
Dependency: route_reflector_enable true
Values: interfaceip, routerid
Default: interfaceip
BGP Configurations
bgp_mode
Specifies the BGP mode
Values: ibgp (internal BGP), ebgp (external BGP)
Default: ebgp
as_byte_mode
Specifies the BGP AS byte mode
Values: as2byte, as4byte
Default: as2byte
dut_as
Specifies the DUT AS number
Values: 1-65535
Default: 1001
dut_as_step_device
Specifies the step value per device for the DUT AS number
Values: 0-65535
Default: 1
dut_as_step_port
Specifies the step value per port for the DUT AS number
Values: 0-65535
Default: 0
dut_as_4byte
Specifies the 4byte DUT AS number
Values: number:number, number.number
Default: 1.1001
dut_as_4byte_step_device
Specifies the step value per device for the 4byte DUT AS number
Values: 0-65535
Default: 0
dut_as_4byte_step_port
Specifies the step value per port for the 4byte DUT AS number
Values: 0-65535
Default: 0
as
Specifies the AS number
Dependency: bgp_mode ebgp
Values: 1-65535
Default: 1
as_step_device
Specifies the step value per device for the AS number
Dependency: bgp_mode ebgp
Values: 0-65535
Default: 1
as_step_port
Specifies the step value per device for the AS number
Dependency: bgp_mode ebgp
Values: 0-65535
Default: 0
as_4byte
Specifies the 4byte AS number
Dependency: bgp_mode ebgp
Values: number:number, number.number
Default: 1.1001
as_4byte_step_device
Specifies the step value per device by which to create subsequent
4byte AS numbers
Default: 0
as_4byte_step_port
Specifies the step value per port by which to create subsequent
4byte AS numbers
Default: 0
dut_ip_addr
Specifies the IP address of the DUT
Values: IPv4
Default: 10.0.0.1
dut_ip_addr_step
Specifies the step value by which to create subsequent DUT IPv4
addresses
Values: 32bit mask
Default: 0.0.0.1
dut_ipv6_addr
Specifies the DUT IPv6 address used by BGP
Values: IPv6
Default: 1001::2
dut_ipv6_addr_step
Specifies the DUT IPv6 address step used by BGP
addresses
Values: 128bit mask
Default: 0::1
bgp_session_ip
Specifies the element to use for the session IP address of BGP
Values: interfaceip, routerid
Default: interfaceip
use_gw_as_dut
Specifies whether to use the gateway IP address as the DUT IP address
Dependency: bgp_session_ip interfaceip
Values: true, false
Default: false
evpn_ad_route
Enables or disables type-1 EVPN AD routes
Values: true, false
Default: false
evpn_active_standby_mode
Specifies the Multihoming mode
Dependency: evpn_ad_route true
Values::
all_active All active Multihoming
single_active Single active Multihoming
Default: single_active
evpn_ad_route_evi
Enables or disables AD Routes (type-1) per EVI
Dependency: evpn_ad_route true
Values: true (enable), false (disable)
Default: false
evpn_ad_route_esi
Determines whether to add AD Routes (type-1) per ESI
Dependency: evpn_ad_route true
Values: true, false
Default: false
evpn_mac_ip_route
Enables or disables EVPN MAC/IP (type-2) routes
Values: true (enable), false (disable)
Default: true
evpn_mac_ip_route_mac_and_ip
Enables or disables advertising MAC and IP routes
Values: true (enable), false (disable)
Default: true
evpn_mac_ip_route_mac_only
Enables or disables advertising MAC Only routes
Values: true (enable), false (disable)
Default: false
evpn_inclusive_multicast_route
Enables or disables EVPN Inclusive Multicast routes
Values: true (enable), false (disable)
Default: false
evpn_ether_seg_route
Enables or disables EVPN Ethernet Segment routes
Values: true (enable), false (disable)
Default: false
evpn_ip_prefix_route
Enables or disables IP Prefix routes
Values: true (enable), false (disable)
Default: false
evpn_ip_unicast_route
Enables or disables IPv4 Unicast routes
Values: true (enable), false (disable)
Default: false
evpn_ether_seg_value_type
Specifies the Ethernet segment type of the route
Values::
type0 Operator
type1 IEEE 802.1AX, LACP
type2 Bridged LAN
type3 MAC Based
type4 Router ID
type5 Autonomous System
Default: type0
evpn_ether_tag_id
Specifies the Ethernet tag value to identify a broadcast domain
Values: 0-4294967295
Default: 0
evpn_ether_seg_id
Specifies the Ethernet Segment ID (ESI) for the EVPN route
Values: AS:Value (X:X:X:X:X:X:X:X:X)
Default: 00:00:00:00:00:00:00:00:00
evpn_ether_seg_id_step
Specifies the step value by which to create subsequent ESIs
Values: AS:Value (X:X:X:X:X:X:X:X:X)
Default: 00:00:00:00:00:00:00:00:00
evpn_next_hop_config
Enables or disables next hop configurations
Values: true (enable), false (disable)
Default: false
evpn_next_hop_ip
Specifies the next hop's IP address
Values: IPv4
Default: 192.168.100.2
evpn_next_hop_device_step
Specifies the step value per device by which to generate
subsequent next hop addresses
Values: 32bit mask
Default: 0.0.0.1
evpn_next_hop_port_step
Specifies the step value per port by which to generate subsequent
next hop addresses
Values: 32bit mask
Default: 0.0.0.1
evpn_evpn_router_mac_ext_community
Determines whether to advertise the Router's MAC extended
community attribute
Values: true, false
Default: false
evpn_enable_pack_routes
Enables or disables Pack routes
Values: true (enable), false (disable)
Default: false
evpn_next_hop_ipv6
Specifies the VTEP next hop IPv6 address to be configured if
VTEP encap is IPv6
Values: IPv6
Default: 2000::1
evpn_next_hop_device_ipv6_step
Specifies the VTEP next hop IPv6 address device step to be
configured if VTEP encap is IPv6
Values: IPv6
Default: 0::1
evpn_next_hop_ipv6_port_step
Specifies the VTEP next hop IPv6 address port step to be configured
if VTEP encap is IPv6
Values: IPv6
Default: 0::1
evpn_next_hop_ipv6_link_local
Specifies the VTEP next hop IPv6 link local address to be
configured if VTEP encap is IPv6
Values: IPv6
Default: FE80::1
evpn_next_hop_device_ipv6_link_local_step
Specifies the VTEP next hop IPv6 link local address device step
to be configured if VTEP encap is IPv6
Values: IPv6
Default: 0::1
evpn_next_hop_ipv6_link_local_port_step
Specifies the VTEP next hop IPv6 link local address port step to be
configured if VTEP encap is IPv6
Values: IPv6
Default: 0::1
evpn_vxlan_ipv6_unicast_route
Creates the IPv6 unicast route for the active BGP device.
Values: true, false
Default: false
Segment Information Parameters
vrf_enable
Enables or disables tenant Virtual Router and Forwarding (VRF)
configurations
Values: true (enable), false (disable)
Default: false
vrf_id
Specifies the first VRF ID
Dependency: vrf_enable true
Values: 1-65535
Default: 1
vrf_step
Specifies the step value by which to generate subsequent VRF IDs
Values: 1-65535
Default: 1
vrf_rt
Specifies the VRF route target
Dependency: vrf_enable true
Values::
AS_L2_VNI AS:L2_VNI
AS_L3_VNI AS:L3_VNI
AS_VLAN AS:VLAN
NEXTHOP_AS NEXTHOP:AS
NEXTHOP_L2_VNI NEXTHOP:L2_VNI
NEXTHOP_L3_VNI NEXTHOP:L3_VNI
NEXTHOP_VLAN NEXTHOP:VLAN
ROUTER_ID_AS ROUTER_ID:AS
ROUTER_ID_L2_VNI ROUTER_ID:L2_VNI
ROUTER_ID_L3_VNI ROUTER_ID:L3_VNI
ROUTER_ID_VLAN ROUTER_ID:VLAN
GATEWAY_IP_AS GATEWAY_IP:AS
GATEWAY_IP_L2_VNI GATEWAY_IP:L2_VNI
GATEWAY_IP_L3_VNI GATEWAY_IP:L3_VNI
GATEWAY_IP_VLAN GATEWAY_IP:VLAN
INTERFACE_IP_AS INTERFACE_IP:AS
INTERFACE_IP_L2_VNI INTERFACE_IP:L2_VNI
INTERFACE_IP_L3_VNI INTERFACE_IP:L3_VNI
INTERFACE_IP_VLAN INTERFACE_IP:VLAN
VRF_ID_VRF_ID VRF_ID:VRF_ID
Default: VRF_ID_VRF_ID
l3_vni
Specifies the initial Layer 3 VXLAN Network Identifier (VNI)
Values: 1-16777215
Default: 100
l3_vni_step
Specifies the step value by which to create subsequent Layer 3 VNIs
Values: 1-16777215
Default: 1
l3_vni_per_vtep
Specifies the number of Layer 3 VNIs for each VTEP
Values: 1-16777215
Default: 1
l2_vni_per_l3_vni
Specifies the number of Layer 2 VNIs for each Layer 3 VNI
Values: 1-16777215
Default: 1
l3_vni_per_block
Specifies the number of Layer 3 VNIs for each block
Values: 1-16777215
Default: 1
l3_auto_vrf_rdrt
Enables or disables the arguments used to identify route
distinguishers and route targets
Values: true (enable), false (disable)
Default: true
l3_vni_rt_enum
Specifies the pattern used to automatically identify route
targets for Layer 3 VNIs
Dependency: l3_auto_vrf_rdrt true
Values::
AS_L2_VNI AS:L2_VNI
AS_L3_VNI AS:L3_VNI
AS_VLAN AS:VLAN
NEXTHOP_AS NEXTHOP:AS
NEXTHOP_L2_VNI NEXTHOP:L2_VNI
NEXTHOP_L3_VNI NEXTHOP:L3_VNI
NEXTHOP_VLAN NEXTHOP:VLAN
ROUTER_ID_AS ROUTER_ID:AS
ROUTER_ID_L2_VNI ROUTER_ID:L2_VNI
ROUTER_ID_L3_VNI ROUTER_ID:L3_VNI
ROUTER_ID_VLAN ROUTER_ID:VLAN
GATEWAY_IP_AS GATEWAY_IP:AS
GATEWAY_IP_L2_VNI GATEWAY_IP:L2_VNI
GATEWAY_IP_L3_VNI GATEWAY_IP:L3_VNI
GATEWAY_IP_VLAN GATEWAY_IP:VLAN
INTERFACE_IP_AS INTERFACE_IP:AS
INTERFACE_IP_L2_VNI INTERFACE_IP:L2_VNI
INTERFACE_IP_L3_VNI INTERFACE_IP:L3_VNI
INTERFACE_IP_VLAN INTERFACE_IP:VLAN
Default: AS_L3_VNI
l3_vni_rd_enum
Specifies the pattern used to automatically identify route
distinguishers for Layer 3 VNIs
Dependency: l3_auto_vrf_rdrt true
Values::
AS_L2_VNI AS:L2_VNI
AS_L3_VNI AS:L3_VNI
AS_VLAN AS:VLAN
NEXTHOP_AS NEXTHOP:AS
NEXTHOP_L2_VNI NEXTHOP:L2_VNI
NEXTHOP_L3_VNI NEXTHOP:L3_VNI
NEXTHOP_VLAN NEXTHOP:VLAN
ROUTER_ID_AS ROUTER_ID:AS
ROUTER_ID_L2_VNI ROUTER_ID:L2_VNI
ROUTER_ID_L3_VNI ROUTER_ID:L3_VNI
ROUTER_ID_VLAN ROUTER_ID:VLAN
GATEWAY_IP_AS GATEWAY_IP:AS
GATEWAY_IP_L2_VNI GATEWAY_IP:L2_VNI
GATEWAY_IP_L3_VNI GATEWAY_IP:L3_VNI
GATEWAY_IP_VLAN GATEWAY_IP:VLAN
INTERFACE_IP_AS INTERFACE_IP:AS
INTERFACE_IP_L2_VNI INTERFACE_IP:L2_VNI
INTERFACE_IP_L3_VNI INTERFACE_IP:L3_VNI
INTERFACE_IP_VLAN INTERFACE_IP:VLAN
Default: AS_L3_VNI
l3_vni_rd_offset
Specifies the number of bytes in the packet that precedes the
route distinguisher of the Layer 3 VNI
Dependency: l3_auto_vrf_rdrt true
Values: 0-65535
Default: 0
l3_vni_rd
Specifies the first route distinguisher for the Layer 3 VNI
Dependency: l3_auto_vrf_rdrt false
Values: AS:Number, IPv4:Number
Default: 192.0.0.1:1
l3_vni_rt
Specifies the first route target for the Layer 3 VNI
Dependency: l3_auto_vrf_rdrt false
Values: AS:Number, IPv4:Number
Default: 100:1
l3_vni_rt_step
Specifies the step value by which to create subsequent route
targets for Layer 3 VNIs
Dependency: l3_auto_vrf_rdrt false
Values: AS:Number, IPv4:Number
Default: 0:1
l3_vni_rd_step
Specifies the step value by which to create subsequent route
distinguishers for Layer 3 VNIs
Dependency: l3_auto_vrf_rdrt false
Values: AS:Number, IPv4:Number
Default: 0:1
l2_vni
Specifies the first Layer 2 VNI
Values: 1-16777215
Default: 100
l2_vni_step
Specifies the step value by which to create subsequent Layer 2 VNIs
Values: 1-16777215
Default: 1
l2_split_seg
Determines whether to split segment configurations per Layer 2 VNI
Values: true, false
Default: false
l2_vni_per_vtep
Specifies the number of Layer 2 VNIs for each VTEP
Values: 1-16777215
Default: 1
l2_vni_per_l3_vni
Specifies the number of Layer 2 VNIs for each Layer 3 VNI
Values: 1-16777215
Default: 1
l2_vni_per_block
Specifies the number of Layer 2 VNIs for each block
Values: 1-16777215
Default: 1
l2_vni_block_step
Specifies the step value per block by which to create subsequent
Layer 2 VNIs
Values: 0-16777215
Default: 1
l2_auto_vrf_rdrt
Enables or disables the arguments used to automatically identify
route distinguishers and route targets for Layer 2 VRFs
Values: true (enable), false (disable)
Default: true
l2_vni_rt_enum
Specifies the pattern used to automatically identify route
targets for Layer 2 VNIs
Dependency: l2_auto_vrf_rdrt true
Values::
AS_L2_VNI AS:L2_VNI
AS_L3_VNI AS:L3_VNI
AS_VLAN AS:VLAN
NEXTHOP_AS NEXTHOP:AS
NEXTHOP_L2_VNI NEXTHOP:L2_VNI
NEXTHOP_L3_VNI NEXTHOP:L3_VNI
NEXTHOP_VLAN NEXTHOP:VLAN
ROUTER_ID_AS ROUTER_ID:AS
ROUTER_ID_L2_VNI ROUTER_ID:L2_VNI
ROUTER_ID_L3_VNI ROUTER_ID:L3_VNI
ROUTER_ID_VLAN ROUTER_ID:VLAN
GATEWAY_IP_AS GATEWAY_IP:AS
GATEWAY_IP_L2_VNI GATEWAY_IP:L2_VNI
GATEWAY_IP_L3_VNI GATEWAY_IP:L3_VNI
GATEWAY_IP_VLAN GATEWAY_IP:VLAN
INTERFACE_IP_AS INTERFACE_IP:AS
INTERFACE_IP_L2_VNI INTERFACE_IP:L2_VNI
INTERFACE_IP_L3_VNI INTERFACE_IP:L3_VNI
INTERFACE_IP_VLAN INTERFACE_IP:VLAN
Default: AS_L2_VNI
l2_vni_rt
Specifies the route target for the Layer 2 VNIs
Dependency: l2_auto_vrf_rdrt false
Values: AS:Number, IPv4:Number
Default: 100:1
l2_vni_rd_enum
Specifies the pattern used to automatically identify route
distinguishers for Layer 2 VNIs
Dependency: l2_auto_vrf_rdrt true
Values::
AS_L2_VNI AS:L2_VNI
AS_L3_VNI AS:L3_VNI
AS_VLAN AS:VLAN
NEXTHOP_AS NEXTHOP:AS
NEXTHOP_L2_VNI NEXTHOP:L2_VNI
NEXTHOP_L3_VNI NEXTHOP:L3_VNI
NEXTHOP_VLAN NEXTHOP:VLAN
ROUTER_ID_AS ROUTER_ID:AS
ROUTER_ID_L2_VNI ROUTER_ID:L2_VNI
ROUTER_ID_L3_VNI ROUTER_ID:L3_VNI
ROUTER_ID_VLAN ROUTER_ID:VLAN
GATEWAY_IP_AS GATEWAY_IP:AS
GATEWAY_IP_L2_VNI GATEWAY_IP:L2_VNI
GATEWAY_IP_L3_VNI GATEWAY_IP:L3_VNI
GATEWAY_IP_VLAN GATEWAY_IP:VLAN
INTERFACE_IP_AS INTERFACE_IP:AS
INTERFACE_IP_L2_VNI INTERFACE_IP:L2_VNI
INTERFACE_IP_L3_VNI INTERFACE_IP:L3_VNI
INTERFACE_IP_VLAN INTERFACE_IP:VLAN
Default: AS_L2_VNI
l2_vni_rd
Specifies the route distinguisher for the Layer 2 VNI
Dependency: l2_auto_vrf_rdrt false
Values: AS:Number, IPv4:Number
Default: 192.0.0.1:1
l2_vni_rd_offset
Specifies the number of bytes in the packet that precedes the
route distinguisher of the Layer 2 VNI
Dependency: l2_auto_vrf_rdrt true
Values: 0-65535
Default: 0
l2_vni_rt_step
Specifies the step value by which to create subsequent route
targets for Layer 2 VNIs
Dependency: l2_auto_vrf_rdrt false
Values: AS:Number, IPv4:Number
Default: 0:1
l2_vni_rd_step
Specifies the step value by which to create subsequent route
distinguishers for Layer 2 VNIs
Dependency: l2_auto_vrf_rdrt false
Values: AS:Number, IPv4:Number
Default: 0:1
same_vnis_across_ports
Determines whether to use the same VNI across ports
Values: true, false
Default: true
same_vnis_across_vteps
Determines whether to restart VNI numbering for each VTEP
Values: true, false
Default: true
traffic_endpoint_mode
Specifies the layer for the traffic endpoint
Values::
L2_VNI Layer 2 VNI. vm_l2_* arguments are available
L3_VNI Layer 3 VNI. vm_l3_* arguments are available
L2_L3_VNI Both Layer 2 VNI and Layer 3 VNI
Default: L2_VNI
L2 VNI VM Configurations (traffic_endpoint_mode L2_VNI/L2_L3_VNI)
configure_l3_segments
Specifies to configure L3 segments
Values: true, false
Default: true
ipv6_vxlan_l2_rd
Specifies the L2 RD value to be configured in Route when VXLAN is IPv6
Values::
AS_L2_VNI Populates the L2L3 RD/RT Value with combination
of AS Number and L2 VNI vlaue configured in wizard
AS_L3_VNI Populates the L2L3 RD/RT Value with combination of AS
Number and L3 VNI vlaue configured in wizard
AS_VLAN Populates the L2L3 RD/RT Value with combination of AS
Number and VLAN vlaue configured in wizard
Default: AS_L2_VNI
ipv6_vxlan_l2_rt
Specifies the L2 RT value to be configured in Route when VXLAN is IPv6
Values::
AS_L2_VNI Populates the L2L3 RD/RT Value with combination
of AS Number and L2 VNI vlaue configured in wizard
AS_L3_VNI Populates the L2L3 RD/RT Value with combination of AS
Number and L3 VNI vlaue configured in wizard
AS_VLAN Populates the L2L3 RD/RT Value with combination of AS
Number and VLAN vlaue configured in wizard
Default: AS_L2_VNI
ipv6_vxlan_l3_rd
Specifies the L3 RD value to be configured in Route when VXLAN is IPv6
Values::
AS_L2_VNI Populates the L2L3 RD/RT Value with combination
of AS Number and L2 VNI vlaue configured in wizard
AS_L3_VNI Populates the L2L3 RD/RT Value with combination of AS
Number and L3 VNI vlaue configured in wizard
AS_VLAN Populates the L2L3 RD/RT Value with combination of AS
Number and VLAN vlaue configured in wizard
Default: AS_L3_VNI
ipv6_vxlan_l3_rt
Specifies the L3 RT value to be configured in Route when VXLAN is IPv6
Values::
AS_L2_VNI Populates the L2L3 RD/RT Value with combination
of AS Number and L2 VNI vlaue configured in wizard
AS_L3_VNI Populates the L2L3 RD/RT Value with combination of AS
Number and L3 VNI vlaue configured in wizard
AS_VLAN Populates the L2L3 RD/RT Value with combination of AS
Number and VLAN vlaue configured in wizard
Default: AS_L3_VNI
ipv6_vxlan_vrf_rt
Specifies the VRF RT value to be configured in Route when VXLAN is IPv6
Values::
AS_L2_VNI Populates the L2L3 RD/RT Value with combination
of AS Number and L2 VNI vlaue configured in wizard
AS_L3_VNI Populates the L2L3 RD/RT Value with combination of AS
Number and L3 VNI vlaue configured in wizard
AS_VLAN Populates the L2L3 RD/RT Value with combination of AS
Number and VLAN vlaue configured in wizard
VRF_ID_VRF_ID Populates the VRF RT Value with combination of VRF ID
and VRF ID value configured in wizard
CUSTOM Populates the customized VRF RT Value from user
Default: VRF_ID_VRF_ID
same_l2_rd_rt_across_vteps
Determines whether to use same RD/RT across VTEPs
Values: true, false
Default: false
same_l2_vnis_across_ports
Determines whether to use same L2VNI across ports
Values: true, false
Default: true
same_l2_vnis_across_vteps
Determines whether to use same L2VNI across VTEPs
Values: true, false
Default: false
same_l3_rd_rt_across_vteps
Determines whether to use same RD/RT across VTEPs
Values: true, false
Default: false
same_tenant_rt_across_vteps
Determines whether to use same RT across VTEPs
Values: true, false
Default: false
tenant_vrf_rt_target
Specifies to configure Custom Tenant VRF Route Target
Values: Number:Number
Default: 100:1
tenant_vrf_rt_target_step
Specifies to configure Custom Tenant VRF Route Target Step
Values: Number:Number
Default: 0:1
vm_l2_addr_mode
Specifies the address mode of Layer 2 VNI/VM devices
Values: mac, ipv4, ipv6, ipv4_ipv6
Default: ipv4
vms_l2_per_seg
Specifies the number of Layer 2 VMs per segment
Values: 1-10000
Default: 1
vm_l2_vlan_enable
Enables or disables VLAN on Layer 2 VMs
Values: true (enable), false (disable)
Default: false
vm_l2_vlan_id
Specifies the first VLAN ID for Layer 2 VMs
Dependency: vm_l2_vlan_enable true
Values: 1-4095
Default: 1
vm_l2_vlan_id_step
Specifies the step value by which to create subsequent VLAN IDs
Values: 1-4095
Default: 1
vm_l2_vni_in_mac
Determines whether to include the Layer 2 VNI value in the MAC address
Dependency: l2_split_seg true
Values: true, false
Default: false
vm_l2_vni_in_mac_len
Specifies the length of the Layer 2 VNI to be used
Dependency: l2_split_seg true
Values: 2_byte, 3_byte
Default: 2_byte
vm_l2_mask_2bytes
Specifies the mask used to determine the position of the 2byte Layer 2 VNI
Dependency::
l2_split_seg true
vm_l2_vni_in_mac true
vm_l2_vni_in_mac_len 2_byte
Values::
MASK_FF_FF_00_00_00_00
MASK_00_FF_FF_00_00_00
MASK_00_00_FF_FF_00_00
MASK_00_00_00_FF_FF_00
MASK_00_00_00_00_FF_FF
Default: MASK_FF_FF_00_00_00_00
vm_l2_mask_3bytes
Specifies the mask to determine the position of the 3byte Layer 2 VNI
Dependency::
l2_split_seg true
vm_l2_vni_in_mac true
vm_l2_vni_in_mac_len 3_byte
Values::
MASK_FF_FF_FF_00_00_00
MASK_00_FF_FF_FF_00_00
MASK_00_00_FF_FF_FF_00
MASK_00_00_00_FF_FF_FF
Default: MASK_FF_FF_FF_00_00_00
vm_l2_mac_addr
Specifies the value of the first MAC address for Layer 2 VMs
Values: MAC
Default: 00:00:10:01:00:00
vm_l2_mac_addr_step
Specifies the step value by which to create subsequent MAC addresses
Values: 48bit mask
Default: 00:00:00:00:00:01
vm_l2_mac_addr_step_seg
Specifies the step value by which to create subsequent MAC
addresses across segment blocks
Values: 48bit mask
Default: 00:00:00:01:00:00
vm_l2_mac_addr_step_vtep
Specifies the step value by which to create subsequent MAC
addresses across VTEPs
Values: 48bit mask
Default: 00:00:00:00:00:00
vm_l2_ip_addr
Specifies the first IP address for Layer 2 VMs
Values: IPv4
Default: 100.0.0.2
vm_l2_ip_addr_step
Specifies the step value by which to create subsequent IPv4
addresses
Values: 32bit mask
Default: 0.0.0.1
vm_l2_ip_addr_step_seg
Specifies the step value by which to create subsequent IPv4
addresses across segments
Values: 32bit mask
Default: 0.0.1.0
vm_l2_ip_addr_step_port
Specifies the step value by which to create subsequent IP
addresses across ports
Values: 32bit mask
Default: 0.0.0.0
vm_l2_ip_addr_step_vtep
Specifies the step value by which to create subsequent IP
addresses across VTEPs
Values: 32bit mask
Default: 0.0.0.0
vm_l2_gw_addr
Specifies the first gateway IP address for Layer 2 VMs
Values: IPv4
Default: 100.0.0.2
vm_l2_gw_addr_step
Specifies the step value by which to create subsequent gateway
IP addresses
Values: 32bit mask
Default: 0.0.0.1
vm_l2_gw_addr_step_seg
Specifies the step value by which to create subsequent gateway
IP addresses across segments
Values: 32bit mask
Default: 0.0.1.0
vm_l2_gw_addr_step_port
Specifies the step value by which to create subsequent gateway
IP addresses across ports
Values: 32bit mask
Default: 0.0.0.0
vm_l2_gw_addr_step_vtep
Specifies the step value by which to create subsequent gateway
IP addresses across VTEPs
Values: 32bit mask
Default: 0.0.0.0
vm_l2_ip_prefix
Specifies the prefix length of the IP address
Values: 0-32
Default: 24
vm_l2_ipv6_addr
Specifies the first host IPv6 address for Layer 2 VMs
Values: IPv6
Default: 2001::2
vm_l2_ipv6_addr_step
Specifies the step value by which to create subsequent host IPv6
addresses
Values: 128bit mask
Default: ::1
vm_l2_ipv6_addr_step_seg
Specifies the step value by which to create subsequent IPv6
addresses across segments
Values: 128bit mask
Default: 0::1:0
vm_l2_ipv6_addr_step_port
Specifies the step value by which to create subsequent IPv6
addresses across ports
Values: 128bit mask
Default: ::
vm_l2_ipv6_addr_step_vtep
Specifies the step value by which to create subsequent IPv6
addresses across VTEPs
Values: 128bit mask
Default: ::
vm_l2_ipv6_gw_addr
Specifies the first gateway IPv6 address for Layer 2 VMs
Values: IPv6
Default: 2001::1
vm_l2_ipv6_gw_addr_step
Specifies the step value by which to create subsequent gateway
IPv6 addresses
Values: IPv6
Default: 0::1
vm_l2_ipv6_gw_addr_step_seg
Specifies the step value by which to create subsequent gateway
IPv6 addresses across segments
Values: IPv6
Default: 0::1:0
vm_l2_ipv6_gw_addr_step_port
Specifies the step value by which to create subsequent gateway
IPv6 addresses across ports
Values: IPv6
Default: ::
vm_l2_ipv6_gw_addr_step_vtep
Specifies the step value by which to create subsequent gateway
IPv6 addresses across VTEPs
Values: IPv6
Default: ::
vm_l2_ipv6_prefix
Specifies the length of the prefix portion of the IPv6 address
Values: 0-128
Default: 64
Layer 3 VNI VM Configurations (traffic_endpoint_mode L3_VNI/L2_L3_VNI)
vm_l3_addr_mode
Specifies the address mode for Layer 3 VMs
Values: ipv4, ipv6, ipv4_ipv6
Default: ipv4
vms_l3_per_seg
Specifies the number of Layer 3 VMs to be created per segment
Values: 1-10000
Default: 1
vm_l3_vlan_enable
Enables or disables VLAN for Layer 3 VMs
Values: true (enable), false (disable)
Default: false
vm_l3_vlan_id
Specifies the first VLAN ID for Layer 3 VMs
Dependency: vm_l3_vlan_enable true
Values: 1-4095
Default: 1
vm_l3_vlan_id_step
Specifies the step value by which to create subsequent VLAN IDs
Values: 1-4095
Default: 1
vm_l3_l2_vni_in_mac
Determines whether to include the Layer 2 VNI value in the MAC
address of the Layer 3 VM
Dependency: l2_split_seg true
Values: true, false
Default: false
vm_l3_l2_vni_in_mac_len
Specifies the length of the Layer 2 VNI to be used for the Layer 3 VM
Dependency: l2_split_seg true
Values: 2_byte, 3_byte
Default: 2_byte
vm_l3_l2_mask_2bytes
Specifies the 2byte mask where the Layer 2 VNI will be used for
the Layer 3 VM
Dependency::
l2_split_seg true
vm_l3_l2_vni_in_mac true
Values::
MASK_FF_FF_00_00_00_00
MASK_00_FF_FF_00_00_00
MASK_00_00_FF_FF_00_00
MASK_00_00_00_FF_FF_00
MASK_00_00_00_00_FF_FF
Default: MASK_FF_FF_00_00_00_00
vm_l3_l2_mask_3bytes
Specifies the 3byte mask where the Layer 2 VNI will be used for
the Layer 3 VM
Dependency::
l2_split_seg true
vm_l3_l2_vni_in_mac true
Values::
MASK_FF_FF_FF_00_00_00
MASK_00_FF_FF_FF_00_00
MASK_00_00_FF_FF_FF_00
MASK_00_00_00_FF_FF_FF
Default: MASK_FF_FF_FF_00_00_00
vm_l3_mac_addr
Specifies the value of the first MAC address for Layer 3 VMs
Values: MAC
Default: 00:00:20:01:00:00
vm_l3_mac_addr_step
Specifies the step value by which to create subsequent MAC addresses
Values: 48bit mask
Default: 00:00:00:00:00:01
vm_l3_mac_addr_step_seg
Specifies the step value by which to create subsequent MAC
addresses across segment blocks
Values: 48bit mask
Default: 00:00:00:01:00:00
vm_l3_mac_addr_step_vtep
Specifies the step value by which to create subsequent MAC
addresses across VTEPs
Values: 48bit mask
Default: 00:00:00:00:00:00
vm_l3_ip_addr
Specifies the first host IP address for Layer 3 VMs
Values: IPv4
Default: 200.0.0.2
vm_l3_ip_addr_step
Specifies the step value by which to create subsequent IP addresses
Values: 32bit mask
Default: 0.0.0.1
vm_l3_ip_addr_step_seg
Specifies the step value by which to create subsequent IP
addresses across segments
Values: 32bit mask
Default: 0.0.1.0
vm_l3_ip_addr_step_port
Specifies the step value by which to create subsequent IP
addresses across ports
Values: 32bit mask
Default: 0.0.0.0
vm_l3_ip_addr_step_vtep
Specifies the step value by which to create subsequent IP
addresses across VTEPs
Values: 32bit mask
Default: 0.0.0.0
vm_l3_gw_addr
Specifies the first gateway IP address for Layer 3 VMs
Values: IPv4
Default: 200.0.0.1
vm_l3_gw_addr_step
Specifies the step value by which to create subsequent gateway
IP addresses
Values: 32bit mask
Default: 0.0.0.1
vm_l3_gw_addr_step_seg
Specifies the step value by which to create subsequent gateway
IP addresses across segments
Values: 32bit mask
Default: 0.0.1.0
vm_l3_gw_addr_step_port
Specifies the step value by which to create subsequent gateway
IP addresses across ports
Values: 32bit mask
Default: 0.0.0.0
vm_l3_gw_addr_step_vtep
Specifies the step value by which to create subsequent gateway
IP addresses across VTEPs
Values: 32bit mask
Default: 0.0.0.0
vm_l3_ip_prefix
Length of the prefix portion of the IP address
Values: 0-32
Default: 24
vm_l3_ipv6_addr
Specifies the first host IPv6 address for Layer 3 VMs
Values: IPv6
Default: 4001::2
vm_l3_ipv6_addr_step
Specifies the step value by which to create subsequent host IPv6
addresses
Values: 128bit mask
Default: ::1
vm_l3_ipv6_addr_step_seg
Specifies the step value by which to create subsequent host IPv6
addresses across segments
Values: 128bit mask
Default: 0::1:0
vm_l3_ipv6_addr_step_port
Specifies the step value by which to create subsequent host IPv6
addresses across ports
Values: 128bit mask
Default: ::
vm_l3_ipv6_addr_step_vtep
Specifies the step value by which to create subsequent host IPv6
addresses across VTEPs
Values: 128bit mask
Default: ::
vm_l3_ipv6_gw_addr
Specifies the first gateway IPv6 address for Layer 3 VMs
Values: IPv6
Default: 4001::1
vm_l3_ipv6_gw_addr_step
Specifies the step value by which to create subsequent gateway
IPv6 addresses
Values: 128bit mask
Default: 0::1
vm_l3_ipv6_gw_addr_step_seg
Specifies the step value by which to create subsequent gateway IPv6
addresses across segments
Values: 128bit mask
Default: 0::1:0
vm_l3_ipv6_gw_addr_step_port
Specifies the step value by which to create subsequent gateway IPv6
addresses across ports
Values: 128bit mask
Default: :::
vm_l3_ipv6_gw_addr_step_vtep
Specifies the step value by which to create subsequent gateway IPv6
addresses across VTEPs
Values: 128bit mask
Default: :::
vm_l3_ipv6_prefix
Length of the prefix portion of the IPv6 address
Values: 0-128
Default: 64
IP Prefix Route Configurations (evpn_ip_prefix_route true)
ippr_mode
Specifies the configuration mode of the IP Prefix route
Values: ipv4, ipv6, ipv4_ipv6
Default: ipv4
ippr_vni_type
Specifies the type of VNI to configure for IP Prefix routes
Values: L2_VNI, L3_VNI
Default: L2_VNI
ippr_count_seg
Specifies the prefix count per segment
Values: 1-65535
Default: 1
ippr_auto_vrf_rdrt
Enables or disables the arguments used to automatically identify
route distinguishers and route targets for IP Prefix routes
Values: true (enable), false (disable)
Default: true
ippr_rt_enum
Specifies the pattern used to identify IP Prefix route targets automatically
Dependency: ippr_auto_vrf_rdrt true
Values::
AS_L2_VNI AS:L2_VNI
AS_L3_VNI AS:L3_VNI
AS_VLAN AS:VLAN
NEXTHOP_AS NEXTHOP:AS
NEXTHOP_L2_VNI NEXTHOP:L2_VNI
NEXTHOP_L3_VNI NEXTHOP:L3_VNI
NEXTHOP_VLAN NEXTHOP:VLAN
ROUTER_ID_AS ROUTER_ID:AS
ROUTER_ID_L2_VNI ROUTER_ID:L2_VNI
ROUTER_ID_L3_VNI ROUTER_ID:L3_VNI
ROUTER_ID_VLAN ROUTER_ID:VLAN
GATEWAY_IP_AS GATEWAY_IP:AS
GATEWAY_IP_L2_VNI GATEWAY_IP:L2_VNI
GATEWAY_IP_L3_VNI GATEWAY_IP:L3_VNI
GATEWAY_IP_VLAN GATEWAY_IP:VLAN
INTERFACE_IP_AS INTERFACE_IP:AS
INTERFACE_IP_L2_VNI INTERFACE_IP:L2_VNI
INTERFACE_IP_L3_VNI INTERFACE_IP:L3_VNI
INTERFACE_IP_VLAN INTERFACE_IP:VLAN
Default: AS_L2_VNI
ippr_rt
Specifies the IP Prefix route target manually
Dependency: ippr_auto_vrf_rdrt false
Values: AS:Number, IPv4:Number
Default: 100:1
ippr_rd_enum
Specifies the pattern used to identify IP Prefix route
distinguishers automatically
Dependency: ippr_auto_vrf_rdrt true
Values::
AS_L2_VNI AS:L2_VNI
AS_L3_VNI AS:L3_VNI
AS_VLAN AS:VLAN
NEXTHOP_AS NEXTHOP:AS
NEXTHOP_L2_VNI NEXTHOP:L2_VNI
NEXTHOP_L3_VNI NEXTHOP:L3_VNI
NEXTHOP_VLAN NEXTHOP:VLAN
ROUTER_ID_AS ROUTER_ID:AS
ROUTER_ID_L2_VNI ROUTER_ID:L2_VNI
ROUTER_ID_L3_VNI ROUTER_ID:L3_VNI
ROUTER_ID_VLAN ROUTER_ID:VLAN
GATEWAY_IP_AS GATEWAY_IP:AS
GATEWAY_IP_L2_VNI GATEWAY_IP:L2_VNI
GATEWAY_IP_L3_VNI GATEWAY_IP:L3_VNI
GATEWAY_IP_VLAN GATEWAY_IP:VLAN
INTERFACE_IP_AS INTERFACE_IP:AS
INTERFACE_IP_L2_VNI INTERFACE_IP:L2_VNI
INTERFACE_IP_L3_VNI INTERFACE_IP:L3_VNI
INTERFACE_IP_VLAN INTERFACE_IP:VLAN
ROUTER_ID_VRF_ID irb_modeROUTER_ID:VRF_ID
Default: AS_L2_VNI
ippr_rd
Specifies the IP Prefix route distinguisher manually
Dependency: ippr_auto_vrf_rdrt false
Values: AS:Number, IPv4:Number
Default: 192.0.0.1:1
ippr_rd_offset
Specifies the number of bytes in the packet that precedes the IP
Prefix route distinguisher
Dependency: ippr_auto_vrf_rdrt true
Values: 0-65535
Default: 0
ippr_rt_step
Specifies the step value by which to create subsequent IP Prefix
route targets
Dependency: ippr_auto_vrf_rdrt false
Values: AS:Number, IPv4:Number
Default: 0:1
ippr_rd_step
Specifies the step value by which to create subsequent IP Prefix
route distinguishers
Dependency: ippr_auto_vrf_rdrt false
Values: AS:Number, IPv4:Number
Default: 0:1
ippr_prefix_length
Specifies the IP prefix length for the IP prefix route
Values: 0-32
Default: 24
ippr_prefix
Specifies the first IP prefix for the IP Prefix route
Values: IPv4
Default: 100.1.1.0
ippr_prefix_step
Specifies the step value by which to create subsequent IP prefixes
Values: 32bit mask
Default: 0.0.1.0
ippr_prefix_step_seg
Specifies the step value by which to create subsequent IP
prefixes across segments
Values: 32bit mask
Default: 0.1.0.0
ippr_prefix_step_port
Specifies the step value by which to create subsequent IP
prefixes across ports
Values: 32bit mask
Default: 0.0.0.0
ippr_prefix_step_vtep
Specifies the step value by which to create subsequent IP
prefixes across VTEPs
Values: 32bit mask
Default: 0.0.0.0
ippr_v6_prefix_length
Specifies the IPv6 prefix length
Values: 0-128
Default: 64
ippr_v6_prefix
Specifies the first IPv6 prefix for the IP prefix route
Values: IPv6
Default: 6001:::
ippr_v6_prefix_step
Specifies the step value by which to create subsequent IPv6
prefixes
Values: 128bit mask
Default: 0:0:0:1::
ippr_v6_prefix_step_seg
Specifies the step value by which to create subsequent IPv6
prefixes across segments
Values: 128bit mask
Default: 0:0:1::
ippr_v6_prefix_step_port
Specifies the step value by which to create subsequent IPv6
prefixes across ports
Values: 128bit mask
Default: ::
ippr_v6_prefix_step_vtep
Specifies the step value by which to create subsequent IPv6
prefixes across VTEPs
Values: 128bit mask
Default: ::
ippr_advertise_gw_in_type2
Enables or disables advertising gateway in type-2 routes
Values: true (enable), false (disable)
Default: true
ippr_gw_type
Specifies the gateway type for the IP Prefix route
Default: VA (Virtual Appliance)
ippr_gw_mac_addr
Specifies the first gateway MAC address
Values: MAC
Default: 00:10:10:01:00:00
ippr_gw_mac_addr_step
Specifies the step value by which to create subsequent gateway
MAC addresses
Values: 48bit mask
Dependency: ippr_gw_type VA
Default: 00:00:00:00:00:01
ippr_gw_mac_addr_step_seg
Specifies the step value by which to create subsequent gateway
MAC addresses across segments
Values: 48bit mask
Dependency: ippr_gw_type VA
Default: 00:00:00:01:00:00
ippr_gw_mac_addr_step_port
Specifies the step value by which to create subsequent gateway
MAC addresses across ports
Values: 48bit mask
Dependency: ippr_gw_type VA
Default: 00:00:00:00:00:00
ippr_gw_ip_addr
Specifies the first gateway IP address for the IP Prefix route
Dependency: ippr_gw_type VA
Values: IPv4
Default: 2001.1.1
ippr_gw_ip_addr_step
Specifies the step value by which to create subsequent gateway IP
addresses
Dependency: ippr_gw_type VA
Values: 32bit mask
Default: 0.0.0.1
ippr_gw_ip_addr_step_seg
Specifies the step value by which to create subsequent gateway IP
addresses across segments
Values: 32bit mask
Dependency: ippr_gw_type VA
Default: 0.0.1.0
ippr_gw_ip_addr_step_port
Specifies the step value by which to create subsequent gateway IP
addresses across ports
Values: 32bit mask
Dependency: ippr_gw_type VA
Default: 0.0.0.0
ippr_gw_ipv6_addr
Specifies the first gateway IPv6 address for the IP Prefix route
Dependency: ippr_gw_type VA
Values: IPv6
Default: 6002::1
ippr_gw_ipv6_addr_step
Specifies the step value by which to create subsequent gateway
IPv6 addresses
Values: 128bit mask
Dependency: ippr_gw_type VA
Default: ::1
ippr_gw_ipv6_addr_step_seg
Specifies the step value by which to create subsequent gateway
IPv6 addresses across segments
Values: 128bit mask
Dependency: ippr_gw_type VA
Default: ::1:0
ippr_gw_ipv6_addr_step_port
Specifies the step value by which to create subsequent gateway
IPv6 addresses across ports
Values: 128bit mask
Dependency: ip_prefix_gw_type VA
Default: ::
enable_type5_prefix_match
Enables or disables the Prefix Match for IP Prefix route (Type-5)
Values: true (enable), false (disable)
Default: true
same_ipprefix_rdrt_accross_vteps
Specifies whether to use same RD/RT across VTEPs
Values: true (enable), false (disable)
Default: false
ippr_v6_vxlan_ip_prefix_rd
Specifies the IP Prefix RD value to be configured in Route when VXLAN is IPv6
Values::
AS_L2_VNI Populates the Prefix RD Value with combination
of AS Number and L2 VNI vlaue configured in wizard
AS_L3_VNI Populates the Prefix RD Value with combination of AS
Number and L3 VNI vlaue configured in wizard
AS_VLAN Populates the Prefix RD Value with combination of AS
Number and VLAN vlaue configured in wizard
Default: AS_L2_VNI
ippr_v6_vxlan_ip_prefix_rt
Specifies the IP Prefix RT value to be configured in Route when VXLAN is IPv6
Values::
AS_L2_VNI Populates the Prefix RT Value with combination
of AS Number and L2 VNI vlaue configured in wizard
AS_L3_VNI Populates the Prefix RT Value with combination of AS
Number and L3 VNI vlaue configured in wizard
AS_VLAN Populates the Prefix RT Value with combination of AS
Number and VLAN vlaue configured in wizard
Default: AS_L2_VNI
Traffic Configurations
create_traffic
Determines whether to create traffic
Values: true, false
Default: false
traffic_config
Specifies the traffic configuration mode
Values::
auto Create traffic automatically by the current function
manual Use traffic config to create traffic manually
Default: manual
traffic_direction
Specifies the traffic direction
Dependency: traffic_config automatic
Values: bidirectional, upstream (east to west), downstream (west to east)
Default: bidirectional
east_ports
Specifies a list of ports to be configured in the east side
Dependency: traffic_config automatic
west_ports
Specifies a list of ports to be configured in the west side
Dependency: traffic_config automatic
end_point_mapping
Specifies the endpoint mapping pattern for traffic streams
Dependency: traffic_config automatic
Values: one_to_one, fully_mesh
Default: fully_mesh
ip_encap
Specifies whether to create traffic with IPv4 encapsulation
Dependency: traffic_config automatic
Values: true, false
Default: false
ipv6_encap
Specifies whether to create traffic with IPv6 encapsulation
Dependency: traffic_config automatic
Values: true, false
Default: false
mac_encap
Specifies whether to create traffic with MAC encapsulation
Dependency: traffic_config automatic
Values: true, false
Default: false
traffic_profile_l2
Specifies the Layer 2 traffic profile
Dependency: traffic_config automatic -l2_split_seg true
Values: true, false
Default: true
traffic_profile_l3
Specifies the Layer 3 traffic profile
Dependency: traffic_config automatic -l2_split_seg true
Values: true, false
Default: false
- Return Values:
Depending on the specific language that HLTAPI uses, the function returns a keyed list/dictionary/hash (See Introduction for more information on return value formats) using the following keys (with corresponding data):
- handle
- The VXLAN EVPN Overlay wizard configuration handle
- vxlanseg_handle
- A list of VXLAN segment handles
- vtep_handle
- A list of handles, separated by port handles
- device_handle
- VTEP device handle
- bgp_handle
- BGP router configuration handle of this VTEP device
- bgpevpnippr_handle
- BGP EVPN IP Prefix router configuration handle of this VTEP device
- vm_handle
- A list of VM device handles under this VTEP device
- ip_prefix_handle
- IP Prefix route handle under this VTEP device
- host_handle
- A list of host handles
- streamblock_handle
- Streamblock handles returned when create_traffic is true and traffic_config is auto
- status
- Success (1) or failure (0) of the operation
- log
- An error message (if the operation failed)
- Description:
The
emulation vxlan evpn overlay wizard configfunction configures or deletes a VXLAN EVPN Overlay topology, mapping the operations of VXLAN EVPN Overlay wizard on the Spirent TestCenter GUI.Use the mode argument to specify the operation to perform. See the mode argument for a description of the actions.
Examples:
The following example configures a VXLAN EVPN Overlay topology:
set VxWizard [emulation vxlan evpn overlay wizard config mode= create multi_homed_vtep= true multi_homed_vtep_type= across_port udp_src_port_auto_select= true udp_src_port= 2069 udp_src_port_step= 1024 udp_checksum_enable= true vteps_per_vlan= 1 multi_homed_vteps_per_port= 6 spi_or_gw_count= 2 dut_per_spi_or_gw= 1 same_mac_ip_for_vtep= false same_spi_gw_for_vtep= false vrf_enable= false vrf_id= 111 vrf_step= 11 vrf_rt= NEXTHOP_AS vm_l2_vlan_enable= true vm_l2_ip_addr= 100.0.0.3 vm_l2_ip_addr_step= 0.0.0.1 vm_l2_ip_addr_step_seg= 0.0.0.3 vm_l2_ip_prefix= 32 vm_l2_ip_addr_step_port= 0.0.0.0 vm_l2_ip_addr_step_vtep= 0.0.0.0 vm_l2_vni_in_mac= true vm_l2_vni_in_mac_len= 2_byte vm_l2_mask_2bytes= MASK_00_00_00_00_FF_FF vm_l2_mask_3bytes= MASK_00_00_00_FF_FF_FF vm_l2_mac_addr= 0f:00:00:00:00:01 vm_l2_mac_addr_step= 00:00:00:00:01:00 bgp_mode= ebgp as_byte_mode= as4byte dut_as= 10 dut_as_step_device= 2 dut_as_step_port= 3 as_4byte= 2.1001 as_step_device= 1 as_step_port= 2 bgp_session_ip= interfaceip use_gw_as_dut= true evpn_ad_route= false evpn_ad_route_evi= true evpn_ad_route_esi= true evpn_active_standby_mode= all_active evpn_mac_ip_route= false evpn_mac_ip_route_mac_and_ip= false evpn_mac_ip_route_mac_only= true evpn_inclusive_multicast_route= true evpn_ether_seg_route= true evpn_ip_prefix_route= true evpn_ip_unicast_route= true evpn_ether_seg_value_type= type5 evpn_ether_tag_id= 2 evpn_ether_seg_id= 0a:00:00:00:00:00:0b:00:00 evpn_ether_seg_id_step= 00:00:00:00:00:00:00:00:0f evpn_next_hop_config= true evpn_next_hop_ip= 192.168.100.4 evpn_evpn_router_mac_ext_community= true evpn_enable_pack_routes= true ippr_mode= ipv6 ippr_prefix= 100.1.1.1 ippr_gw_type= VA ippr_rt_enum= GATEWAY_IP_L2_VNI ippr_rd_enum= ROUTER_ID_VRF_ID ippr_rd_offset= 1 ippr_gw_ipv6_addr_step_port= ::1:1 l3_auto_vrf_rdrt= true l3_vni_rt= 200:1 l3_vni_rd= 193.0.0.1:1 l3_vni_rd_enum= INTERFACE_IP_VLAN l3_vni_rt_enum= INTERFACE_IP_VLAN vm_l3_ip_addr= 110.0.0.3 vm_l3_gw_addr= 110.0.0.1 vm_l3_gw_addr_step_seg= 0.1.0.0 traffic_endpoint_mode= L2_L3_VNI create_traffic= true traffic_config= auto traffic_direction= upstream east_ports= $port1 west_ports= $port2 end_point_mapping= one_to_one mac_encap= true ]Sample Output:
{vxlanseg_handle vxlansegmentconfig1} {vtep_handle { {port1 {{1 {{device_handle emulateddevice1} {bgp_handle bgprouterconfig1} {bgpevpnmacadv_handle bgpevpnmacadvrouteconfig1} {bgpevpnippr_handle bgpevpnipprefixrouteconfig1} {vm_handle {emulateddevice7 emulateddevice13}} {ip_prefix_handle emulateddevice19}}} {2 {{device_handle emulateddevice2} {bgp_handle bgprouterconfig2} {bgpevpnmacadv_handle bgpevpnmacadvrouteconfig2} {bgpevpnippr_handle bgpevpnipprefixrouteconfig2} {vm_handle {emulateddevice8 emulateddevice14}} {ip_prefix_handle emulateddevice20}}} {3 {{device_handle emulateddevice3} {bgp_handle bgprouterconfig3} {bgpevpnmacadv_handle bgpevpnmacadvrouteconfig3} {bgpevpnippr_handle bgpevpnipprefixrouteconfig3} {vm_handle {emulateddevice9 emulateddevice15}} {ip_prefix_handle emulateddevice21}}} {4 {{device_handle emulateddevice4} {bgp_handle bgprouterconfig4} {bgpevpnmacadv_handle bgpevpnmacadvrouteconfig4} {bgpevpnippr_handle bgpevpnipprefixrouteconfig4} {vm_handle {emulateddevice10 emulateddevice16}} {ip_prefix_handle emulateddevice22}}} {5 {{device_handle emulateddevice5} {bgp_handle bgprouterconfig5} {bgpevpnmacadv_handle bgpevpnmacadvrouteconfig5} {bgpevpnippr_handle bgpevpnipprefixrouteconfig5} {vm_handle {emulateddevice11 emulateddevice17}} {ip_prefix_handle emulateddevice23}}} {6 {{device_handle emulateddevice6} {bgp_handle bgprouterconfig6} {bgpevpnmacadv_handle bgpevpnmacadvrouteconfig6} {bgpevpnippr_handle bgpevpnipprefixrouteconfig6} {vm_handle {emulateddevice12 emulateddevice18}} {ip_prefix_handle emulateddevice24}}}}} {port2 {{1 {{device_handle emulateddevice25} {bgp_handle bgprouterconfig7} {bgpevpnmacadv_handle bgpevpnmacadvrouteconfig7} {bgpevpnippr_handle bgpevpnipprefixrouteconfig7} {vm_handle {emulateddevice31 emulateddevice37}} {ip_prefix_handle emulateddevice43}}} {2 {{device_handle emulateddevice26} {bgp_handle bgprouterconfig8} {bgpevpnmacadv_handle bgpevpnmacadvrouteconfig8} {bgpevpnippr_handle bgpevpnipprefixrouteconfig8} {vm_handle {emulateddevice32 emulateddevice38}} {ip_prefix_handle emulateddevice44}}} {3 {{device_handle emulateddevice27} {bgp_handle bgprouterconfig9} {bgpevpnmacadv_handle bgpevpnmacadvrouteconfig9} {bgpevpnippr_handle bgpevpnipprefixrouteconfig9} {vm_handle {emulateddevice33 emulateddevice39}} {ip_prefix_handle emulateddevice45}}} {4 {{device_handle emulateddevice28} {bgp_handle bgprouterconfig10} {bgpevpnmacadv_handle bgpevpnmacadvrouteconfig10} {bgpevpnippr_handle bgpevpnipprefixrouteconfig10} {vm_handle {emulateddevice34 emulateddevice40}} {ip_prefix_handle emulateddevice46}}} {5 {{device_handle emulateddevice29} {bgp_handle bgprouterconfig11} {bgpevpnmacadv_handle bgpevpnmacadvrouteconfig11} {bgpevpnippr_handle bgpevpnipprefixrouteconfig11} {vm_handle {emulateddevice35 emulateddevice41}} {ip_prefix_handle emulateddevice47}}} {6 {{device_handle emulateddevice30} {bgp_handle bgprouterconfig12} {bgpevpnmacadv_handle bgpevpnmacadvrouteconfig12} {bgpevpnippr_handle bgpevpnipprefixrouteconfig12} {vm_handle {emulateddevice36 emulateddevice42}} {ip_prefix_handle emulateddevice48}}}}}}} {vm_handle {emulateddevice7 emulateddevice8 emulateddevice9 emulateddevice10 emulateddevice11 emulateddevice12 emulateddevice13 emulateddevice14 emulateddevice15 emulateddevice16 emulateddevice17 emulateddevice18 emulateddevice31 emulateddevice32 emulateddevice33 emulateddevice34 emulateddevice35 emulateddevice36 emulateddevice37 emulateddevice38 emulateddevice39 emulateddevice40 emulateddevice41 emulateddevice42}} {host_handle {emulateddevice49 emulateddevice50 emulateddevice51}} {ip_prefix_handle {emulateddevice19 emulateddevice20 emulateddevice21 emulateddevice22 emulateddevice23 emulateddevice24 emulateddevice43 emulateddevice44 emulateddevice45 emulateddevice46 emulateddevice47 emulateddevice48}} {streamblock_handle {streamblock1 streamblock2 streamblock3 streamblock4 streamblock5 streamblock6 streamblock7 streamblock8 streamblock9 streamblock10 streamblock11 streamblock12}} {handle vxlanevpnoverlayconfiggenparams1} {status 1}The following example configures a VXLAN EVPN Overlay topology with route reflector enabled:
set VxPort1 [emulation vxlan evpn overlay port config mode= create port_handle= $port1 gw_ip_addr= 192.168.100.1 gw_ip_addr_step= 0.0.0.1 vtep_ip_addr_step= 0.0.0.1 vlan_enable= true vlan_id= 1 vlan_count= 1 vtep_ip_addr= 192.168.100.2 vlan_id_step= 1 tunnel_ip_mode= routerid] set VxWizard [emulation vxlan evpn overlay wizard config mode= create vteps_per_vlan= 1 route_reflector_enable= true rr_as_byte_mode= 2_byte rr_as_num= 1 rr_as_num_4_byte= 1:1 rr_as_num_4_byte_step= 0:0 rr_as_num_step= 1 rr_bgp_mode= ibgp rr_dut_as= 1 rr_dut_as_4_byte= 1.1001 rr_dut_as_4_byte_step= 1.0 rr_dut_as_step= 1 rr_dut_ip_addr= 10.0.0.1 rr_dut_ip_addr_step= 0.0.0.1 rr_gateway_ip_addr= 193.168.100.1 rr_gateway_ip_addr_step= 0.0.0.1 rr_ip_addr= 193.168.100.2 rr_ip_addr_step= 0.0.0.1 rr_mac_addr= 00:10:00:10:00:01 rr_mac_addr_step= 00:00:00:00:00:01 rr_prefix_len= 24 rr_route_ref_count_per_port= 1 rr_router_id= 10.1.1.10 rr_router_id_step= 0.0.0.0 rr_use_gateway_as_dut= true rr_vtep_to_route_ref_map= many_to_one rr_vxlan_bgp_session_ip= interface_ip bgp_session_ip= interfaceip use_gw_as_dut= true as_byte_mode= as2byte as= 1 as_step_device= 1 as_step_port= 0 bgp_mode= ebgp evpn_mac_ip_route= true evpn_mac_ip_route_mac_and_ip= true evpn_mac_ip_route_mac_only= true evpn_ether_seg_id= 00:00:00:00:00:00:00:00:00 evpn_ether_seg_id_step= 00:00:00:00:00:00:00:00:00 evpn_ether_seg_value_type= type2 evpn_ether_tag_id= 0 configure_l3_segments= true l3_vni= 200 l3_vni_step= 1 l3_vni_per_vtep= 1 l3_vni_per_block= 1 l3_auto_vrf_rdrt= true l2_vni= 100 l2_vni_step= 1 l2_vni_per_vtep= 1 l2_vni_per_block= 1 l2_vni_block_step= 1 l2_vni_per_l3_vni= 1 l2_split_seg= true l2_auto_vrf_rdrt= false l2_vni_rt= 100:1 l2_vni_rd= 192.0.0.1:1 l2_vni_rt_step= 0:1 l2_vni_rd_step= 0:1 tenant_vrf_rt_target= 100:1 tenant_vrf_rt_target_step= 0:1 traffic_endpoint_mode= L2_VNI vm_l2_vlan_enable= true vm_l2_ip_addr= 100.0.0.2 vm_l2_ip_addr_step_seg= 0.0.1.0 vm_l2_ip_prefix= 24 vm_l2_ip_addr_step_port= 0.0.0.0 vm_l2_ip_addr_step_vtep= 0.0.0.0 vm_l2_ip_addr_step= 0.0.0.1 vm_l2_vni_in_mac= true vm_l2_vni_in_mac_len= 2_byte vm_l2_mask_2bytes= MASK_FF_FF_00_00_00_00 vm_l2_mask_3bytes= MASK_FF_FF_FF_00_00_00 vm_l2_mac_addr= 00:00:10:01:00:00 vm_l2_mac_addr_step= 00:00:00:00:00:01 vm_l2_mac_addr_step_seg= 00:00:00:01:00:00 vm_l2_mac_addr_step_vtep= 00:00:00:00:00:00 vm_l2_vlan_id= 1 vm_l2_vlan_id_step= 1 vms_l2_per_seg= 1 vm_l2_gw_addr= 100.0.0.1 vm_l2_gw_addr_step= 0.0.0.1 vm_l2_gw_addr_step_seg= 0.0.1.0 vm_l2_gw_addr_step_port= 0.0.0.0 vm_l2_gw_addr_step_vtep= 0.0.0.0 vm_l2_ipv6_gw_addr= 2001::1 vm_l2_ipv6_gw_addr_step= 0::1 vm_l2_ipv6_gw_addr_step_seg= 0::1:0 vm_l2_ipv6_gw_addr_step_port= 0::0 vm_l2_ipv6_gw_addr_step_vtep= 0::0 vm_l2_ipv6_addr= 2001::2 vm_l2_ipv6_addr_step_port= 0::0 vm_l2_ipv6_addr_step= ::1 vm_l2_ipv6_addr_step_seg= 0::1:0 vm_l2_ipv6_addr_step_vtep= 0::0 vm_l2_ipv6_prefix= 128 vm_l2_addr_mode= ipv4]Sample Output:
{vtep_handle emulateddevice1} {vm_handle emulateddevice2} {bgp_rr_handle emulateddevice3} {bgp_evpn_route_handles {bgpevpnmacadvrouteconfig1 bgpevpnmacadvrouteconfig2}} {handle vxlanevpnoverlayconfiggenparams1} {status 1}The following example configures a VXLAN EVPN Overlay topology with BGP underlay configuration:
set VxWizard [emulation vxlan evpn overlay wizard config mode= create igp_protocol= bgp bgp_underlay_as_byte_mode= 4_byte bgp_underlay_as_num= 5 bgp_underlay_as_num_4_byte= 2:2 bgp_underlay_as_num_4_byte_step= 1:1 bgp_underlay_as_num_step= 5 bgp_underlay_bgp_mode= ibgp bgp_underlay_dut_as= 20 bgp_underlay_dut_as_4_byte= 1.1111 bgp_underlay_dut_as_4_byte_step= 1.1 bgp_underlay_dut_as_step= 10 bgp_underlay_dut_ip_addr= 10.1.1.40 bgp_underlay_dut_ip_addr_step= 0.0.0.5 bgp_underlay_gateway_ip_addr= 10.1.1.60 bgp_underlay_gateway_ip_addr_step= 0.0.0.4 bgp_underlay_ip_addr= 10.1.1.20 bgp_underlay_ip_addr_step= 0.0.0.3 bgp_underlay_mac_addr= 00:10:00:10:00:01 bgp_underlay_mac_addr_step= 00:00:00:00:00:01 bgp_underlay_prefix_len= 24 bgp_underlay_router_id= 10.1.1.10 bgp_underlay_router_id_step= 0.0.0.2 bgp_underlay_use_gateway_as_dut= true bgp_underlay_vxlan_bgp_session_ip= interface_ip evpn_ad_route= true evpn_ad_route_esi= false evpn_ad_route_evi= false evpn_ether_seg_route= false evpn_inclusive_multicast_route= false evpn_ip_prefix_route= false evpn_ip_unicast_route= false evpn_mac_ip_route= true evpn_mac_ip_route_mac_and_ip= true evpn_mac_ip_route_mac_only= false evpn_next_hop_config= false evpn_next_hop_ip= 192.168.100.2 evpn_next_hop_device_step= 0.0.0.1 evpn_next_hop_port_step= 0.0.0.1Sample Output:
{segment_handle vxlansegmentconfig1} {vtep_handle {{port1 {{1 {{device_handle emulateddevice1} {bgp_handle bgprouterconfig1} {bgpevpnmacadv_handle bgpevpnmacadvrouteconfig1} {vm_handle emulateddevice2}}}}}}} {vm_handle emulateddevice2} {bgp_underlay_handle emulateddevice3} {bgp_underlay_evpn_route_handles bgpipv4routeconfig1} {handle vxlanevpnoverlayconfiggenparams1} {status 1}The following example configures a VXLAN EVPN Overlay topology with OSPF underlay configuration:
set VxWizard [emulation vxlan evpn overlay wizard config mode= create igp_protocol= ospf ospfv2_underlay_area_id= 0.0.0.1 ospfv2_underlay_router_priority= 1 ospfv2_underlay_if_cost= 1 ospfv2_underlay_options= ebit ospfv2_underlay_network_type= p2p ospfv2_underlay_enable_graceful_restart= true ospfv2_underlay_graceful_restart_type= none ospfv2_underlay_enable_bfd= true ospfv2_underlay_sr_algorithm_tlv= 1 ospfv2_underlay_tlv_sid_range= 1 ospfv2_underlay_tlv_sid_base= 1 ospfv2_underlay_if_sub_tlv_index= 1 ospfv2_underlay_if_sub_tlv_index_step= 1Sample Output:
{segment_handle vxlansegmentconfig1} {vtep_handle {{port1 {{1 {{device_handle emulateddevice1} {bgp_handle bgprouterconfig1} {ospfv2_handle ospfv2routerconfig1} {bgpevpnmacadv_handle bgpevpnmacadvrouteconfig1} {ospfv2_lsa_handle {ospfv2simplifiedsrlsa1 routerlsa1}} {vm_handle emulateddevice2}}}}}}} {vm_handle emulateddevice2} {handle vxlanevpnoverlayconfiggenparams1} {status 1}The following example deletes the created VXLAN EVPN Overlay topology:
set VxDel [emulation vxlan evpn overlay wizard config mode= delete handle= $VxWizard ]
emulation vxlan evpn overlay control¶
Execute Tester Command ${rt_handle} command=test_control <additional key=value arguments>
- Purpose:
Spirent Extension (for Spirent HLTAPI only).
Starts or stops the created VTEP devices
Synopsis:
Note: M indicates the argument is `Mandatory`.
emulation vxlan evpn overlay control
action= {start | stop} M
port_handle= <port_handle>
handle= <device handle>
Arguments:
action
Specifies the action to perform. This argument is `Mandatory`.
Values::
start Starts the VTEP device
stop Stops the VTEP device
port_handle
Specifies the port on which the action will be performed. You
must specify either port_handle or -handle, but not both.
handle
Specifies the VTEP device handles on which to perform the action.
You must specify either port_handle or -handle, but not both.
- Return Values:
Depending on the specific language that HLTAPI uses, the function returns a keyed list/dictionary/hash (See Introduction for more information on return value formats) using the following keys (with corresponding data):
- status
- Success (1) or failure (0) of the operation
- log
- Error message if command returns {status 0}
- Description:
- The
emulation vxlan evpn overlay controlfunction controls the configured VTEP devices.
Examples:
To start the specified VTEP device:
set status [::emulation vxlan evpn overlay control port_handle= "$port1 $port2" action= start]
emulation vxlan evpn overlay stats¶
Execute Tester Command ${rt_handle} command=test_control <additional key=value arguments>
- Purpose:
Spirent Extension (for Spirent HLTAPI only).
Retrieves statistics for the VTEP devices configured on the specified test port
Synopsis:
Note: M indicates the argument is `Mandatory`.
emulation vxlan evpn overlay stats
port_handle= <port_handle>
handle= <device handle>
Arguments:
port_handle
Specifies the port handles from which to retrieve the statistics.
You must specify either port_handle or handle, but not both.
handle
Specifies the VXLAN device handles from which to retrieve the
statistics. You must specify either port_handle or handle, but
not both.
- Return Values:
Depending on the specific language that HLTAPI uses, the function returns a keyed list/dictionary/hash (See Introduction for more information on return value formats) using the following keys (with corresponding data):
- status
- Success (1) or failure (0) of the operation
- log
- Error message if command returns {status 0}
- state
The state of the VTEP device.
STOPPED Stopped and left multicasts groups
STARTED Joined multicast groups (if necessary) and sent out ARPs
- learned_binding_count
- Number of binding VM devices learned
- load_profile_run_state
- State of the load profile
- resolved_vm_macs_count
- Number of resolved VM MAC addresses
- unresolved_vm_macs_count
- Number of unresolved VM MAC addresses
- Description:
- The
emulation vxlan evpn overlay statsfunction retrieves statistics for all emulated VTEP devices configured on a specified port, or statistics for a specified VTEP device. - Examples:
To get statistics from VTEP devices under the specified ports:
set results [emulation vxlan evpn overlay stats port_handle= "$port1 $port2" ]
Sample Output:
{emulateddevice1 {{unresolved_vm_macs_count 0} {load_profile_run_state false} {resolved_vm_macs_count 1} {learned_binding_count 1} {state STARTED}}} {emulateddevice3 {{unresolved_vm_macs_count 0} {load_profile_run_state false} {resolved_vm_macs_count 1} {learned_binding_count 1} {state STARTED}}} {status 1}
To get the statistics from the specified VTEP device:
set results [emulation vxlan evpn overlay stats handle= $vtep1 ]
Sample Output:
{emulateddevice1 {{unresolved_vm_macs_count 0} {load_profile_run_state false} {resolved_vm_macs_count 1} {learned_binding_count 1} {state STARTED}}} {status 1}