ADC CLI Commands

vxlan

May 28, 2024

Contributed by:

The following operations can be performed on “vxlan”:

add vxlan

Adds a VXLAN to the Citrix ADC.

Synopsis

add vxlan \[-vlan <positive\_integer>] \[-port ] \[-dynamicRouting \( ENABLED | DISABLED )] \[-ipv6DynamicRouting \( ENABLED | DISABLED )] \[-type \( VXLAN | VXLANGPE ) \[-protocol ]] \[-innerVlanTagging \( ENABLED | DISABLED )]

Arguments

id A positive integer, which is also called VXLAN Network Identifier (VNI), that uniquely identifies a VXLAN. Minimum value: 1 Maximum value: 16777215

vlan ID of VLANs whose traffic is allowed over this VXLAN. If you do not specify any VLAN IDs, the Citrix ADC allows traffic of all VLANs that are not part of any other VXLANs. Minimum value: 2 Maximum value: 4094

port Specifies UDP destination port for VXLAN packets. Default value: 4789 Minimum value: 1 Maximum value: 65534

dynamicRouting Enable dynamic routing on this VXLAN.

Possible values: ENABLED, DISABLED Default value: DISABLED

ipv6DynamicRouting Enable all IPv6 dynamic routing protocols on this VXLAN. Note: For the ENABLED setting to work, you must configure IPv6 dynamic routing protocols from the VTYSH command line.

Possible values: ENABLED, DISABLED Default value: DISABLED

type VXLAN encapsulation type. VXLAN, VXLANGPE

Possible values: VXLAN, VXLANGPE Default value: VXLAN

protocol VXLAN-GPE next protocol. RESERVED, IPv4, IPv6, ETHERNET, NSH

Possible values: IPv4, IPv6, ETHERNET, NSH Default value: ETHERNET

innerVlanTagging Specifies whether Citrix ADC should generate VXLAN packets with inner VLAN tag.

Possible values: ENABLED, DISABLED Default value: DISABLED

Example

add vxlan 20000 -vlan 4

rm vxlan

Removes a VXLAN from the Citrix ADC

Synopsis

rm vxlan

Arguments

id A positive integer, which is also called VXLAN Network Identifier (VNI), that uniquely identifies a VXLAN. Minimum value: 1 Maximum value: 16777215

Example

rm vxlan 20000

set vxlan

Modify VXLAN parameters

Synopsis

set vxlan \[-vlan <positive\_integer>] \[-port ] \[-dynamicRouting \( ENABLED | DISABLED )] \[-ipv6DynamicRouting \( ENABLED | DISABLED )] \[-innerVlanTagging \( ENABLED | DISABLED )]

Arguments

id A positive integer, which is also called VXLAN Network Identifier (VNI), that uniquely identifies a VXLAN. Minimum value: 1 Maximum value: 16777215

port Specifies UDP destination port for VXLAN packets. Default value: 4789 Minimum value: 1 Maximum value: 65534

dynamicRouting Enable dynamic routing on this VXLAN.

Possible values: ENABLED, DISABLED Default value: DISABLED

ipv6DynamicRouting Enable all IPv6 dynamic routing protocols on this VXLAN. Note: For the ENABLED setting to work, you must configure IPv6 dynamic routing protocols from the VTYSH command line.

Possible values: ENABLED, DISABLED Default value: DISABLED

innerVlanTagging Specifies whether Citrix ADC should generate VXLAN packets with inner VLAN tag.

Possible values: ENABLED, DISABLED Default value: DISABLED

Example

set vxlan 20000 -vlan 4

unset vxlan

Use this command to remove vxlan settings.Refer to the set vxlan command for meanings of the arguments.

Synopsis

unset vxlan [-vlan] [-port] [-dynamicRouting] [-ipv6DynamicRouting] [-innerVlanTagging]

stat vxlan

Display statistics for VXLAN(s).

Synopsis

stat vxlan [] \[-detail] \[-fullValues] \[-ntimes <positive\_integer>] \[-logFile <input\_filename>] \[-clearstats \( basic | full )]

Arguments

id An integer specifying the VXLAN identification number (VNID). Minimum value: 1 Maximum value: 16777215

detail Specifies detailed output (including more statistics). The output can be quite voluminous. Without this argument, the output will show only a summary.

fullValues Specifies that numbers and strings should be displayed in their full form. Without this option, long strings are shortened and large numbers are abbreviated

ntimes The number of times, in intervals of seven seconds, the statistics should be displayed. Default value: 1 Minimum value: 0

logFile The name of the log file to be used as input.

clearstats Clear the statsistics / counters

Possible values: basic, full

Output

count devno stateflag

Counters

Packets received (RxPkts) Packets received on the VXLAN.

Bytes received (RxBytes) Bytes of data received on the VXLAN.

Packets sent (TxPkts) Packets transmitted on the VXLAN.

Bytes sent (TxBytes) Bytes of data transmitted on the VXLAN.

Example

stat vxlan 10000

stat MapDomain

bind vxlan

Binds tunnels or IP addresses to the VXLAN

Synopsis

bind vxlan \[-srcIP <ip\_addr>] \[-IPAddress <ip\_addr|ipv6\_addr|\*> \[]]

Arguments

id A positive integer, which is also called VXLAN Network Identifier (VNI), that uniquely identifies a VXLAN. Minimum value: 1 Maximum value: 16777215

srcIP The source IP address to use in outgoing vxlan packets.

IPAddress Network address to be associated with the VXLAN. Should exist on the appliance before you associate it with the VXLAN.

netmask Subnet mask for the network address defined for this VXLAN.

Example

bind vxlan 20000 -tunnel t1

unbind vxlan

Unbinds tunnels and IP addresses from the VXLAN

Synopsis

unbind vxlan \[-srcIP <ip\_addr>] \[-IPAddress <ip\_addr|ipv6\_addr|\*> \[]]

Arguments

id A positive integer, which is also called VXLAN Network Identifier (VNI), that uniquely identifies a VXLAN. Minimum value: 1 Maximum value: 16777215

srcIP The source IP address to use in outgoing vxlan packets.

IPAddress The IP Address associated with the VXLAN configuration.

netmask Subnet mask for the network address defined for this VXLAN.

Example

unbind vxlan 20000 -tunnel t1

show vxlan

Display all the VXLANs on the Citrix ADC

Synopsis

show vxlan []

Arguments

id A positive integer, which is also called VXLAN Network Identifier (VNI), that uniquely identifies a VXLAN. Minimum value: 1 Maximum value: 16777215

Output

vlan ID of VLANs whose traffic is allowed over this VXLAN. If you do not specify any VLAN IDs, the Citrix ADC allows traffic of all VLANs that are not part of any other VXLANs.

port Specifies UDP destination port for VXLAN packets.

dynamicRouting Enable dynamic routing on this VXLAN.

ipv6DynamicRouting Enable all IPv6 dynamic routing protocols on this VXLAN. Note: For the ENABLED setting to work, you must configure IPv6 dynamic routing protocols from the VTYSH command line.

innerVlanTagging Specifies whether Citrix ADC should generate VXLAN packets with inner VLAN tag.

tunnel Specifies the name of the configured tunnel to be associated with this VXLAN.

IPAddress The IP address assigned to the VXLAN.

netmask Subnet mask for the network address defined for this VXLAN.

td Integer value that uniquely identifies the traffic domain in which you want to configure the entity. If you do not specify an ID, the entity becomes part of the default traffic domain, which has an ID of 0.

type VXLAN encapsulation type. VXLAN, VXLANGPE

protocol VXLAN-GPE next protocol. RESERVED, IPv4, IPv6, ETHERNET, NSH

stateflag Internal flag for display

partitionName The Partition to which this vxlan is bound

srcIP The source IP address to use in outgoing vxlan packets.

devno count

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

vxlan

May 28, 2024

Contributed by:

May 28, 2024

Contributed by:

vxlan

add vxlan

Synopsis

Arguments

Example

rm vxlan

Synopsis

Arguments

Example

set vxlan

Synopsis

Arguments

Example

unset vxlan

Synopsis

stat vxlan

Synopsis

Arguments

Output

Counters

Example

Related Commands

bind vxlan

Synopsis

Arguments

Example

unbind vxlan

Synopsis

Arguments

Example

show vxlan

Synopsis

Arguments

Output

In this article