Product Documentation

vxlan

Sep 12, 2016

The following operations can be performed on "vxlan":

add | rm | set | unset | bind | unbind | show | stat

add vxlan

Adds a VXLAN to the NetScaler appliance.

Synopsys

add vxlan <id> [-vlan <positive_integer>] [-port <port>] [-dynamicRouting ( ENABLED | DISABLED )] [-ipv6DynamicRouting ( ENABLED | DISABLED )] [-type ( VXLAN | VXLANGPE ) [-protocol <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 NetScaler allows traffic of all VLANs that are not part of any other VXLANs.

Minimum value: 1

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 NS 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 NetScaler appliance

Synopsys

rm vxlan <id>

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

Synopsys

set vxlan <id> [-vlan <positive_integer>] [-port <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

vlan

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

Minimum value: 1

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

innerVlanTagging

Specifies whether NS 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.

Synopsys

unset vxlan <id> [-vlan] [-port] [-dynamicRouting] [-ipv6DynamicRouting] [-innerVlanTagging]

bind vxlan

Binds tunnels or IP addresses to the VXLAN

Synopsys

bind vxlan <id> (-tunnel <string> | (-IPAddress <ip_addr|ipv6_addr|*> [<netmask>]))

Arguments

id

A positive integer, which is also called VXLAN Network Identifier (VNI), that uniquely identifies a VXLAN.

Minimum value: 1

Maximum value: 16777215

tunnel

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

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

Synopsys

unbind vxlan <id> (-tunnel <string> | (-IPAddress <ip_addr|ipv6_addr|*> [<netmask>]))

Arguments

id

A positive integer, which is also called VXLAN Network Identifier (VNI), that uniquely identifies a VXLAN.

Minimum value: 1

Maximum value: 16777215

tunnel

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

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 Netscaler appliance

Synopsys

show vxlan [<id>]

Arguments

id

A positive integer, which is also called VXLAN Network Identifier (VNI), that uniquely identifies a VXLAN.

Minimum value: 1

Maximum value: 16777215

Outputs

vlan

ID of VLANs whose traffic is allowed over this VXLAN. If you do not specify any VLAN IDs, the NetScaler 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 NS 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

devno

count

stat vxlan

Display statistics for VXLAN(s).

Synopsys

stat vxlan [<id>] [-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

Outputs

count

devno

stateflag

Outputs

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