Skip to content

vlan

The following operations can be performed on "vlan":

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

show vlan

Displays the settings of all VLANs configured on the Citrix ADC, or of the specified VLAN. To display the settings of all the VLANs, run the command without any parameters. To display the settings of a particular VLAN, specify the ID of the VLAN.

Synopsis

show vlan [] show vlan stats - alias for 'stat vlan'

Arguments

id Integer that uniquely identifies the VLAN for which the details are to be displayed. Minimum value: 1 Maximum value: 4094

Output

aliasName A name for the VLAN. Must begin with a letter, a number, or the underscore symbol, and can consist of from 1 to 31 letters, numbers, and the hyphen (-), period (.) pound (#), space ( ), at sign (@), equals (=), colon (:), and underscore (_) characters. You should choose a name that helps identify the VLAN. However, you cannot perform any VLAN operation by specifying this name instead of the VLAN ID.

IPAddress The IP address assigned to the VLAN.

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

linklocalIPv6Addr The link-local IP address assigned to the VLAN.

rnat Temporary flag used for internal purpose.

stateflag state flag

portbitmap Member interfaces of this vlan.

lsbitmap Member linksets of this vlan.

tagbitmap Tagged members of this vlan.

lstagbitmap Tagged linksets of this vlan.

ifaces Names of all member interfaces of this vlan.

tagIfaces Names of all tagged member interfaces of this vlan.

dynamicRouting Whether dynamic routing is enabled or disabled.

ipv6DynamicRouting Whether ipv6 dynamic routing is enabled or disabled.

flag ifnum The interface to be bound to the VLAN, specified in slot/port notation (for example, 1/3).

tagged Make the interface an 802.1q tagged interface. Packets sent on this interface on this VLAN have an additional 4-byte 802.1q tag, which identifies the VLAN. To use 802.1q tagging, you must also configure the switch connected to the appliance's interfaces.

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.

vlantd Traffic domain associated with vlan.

sdxVlan SDX vlan.

mtu Specifies the maximum transmission unit (MTU), in bytes. The MTU is the largest packet size, excluding 14 bytes of ethernet header and 4 bytes of crc, that can be transmitted and received over this VLAN.

sharing If sharing is enabled, then this vlan can be shared across multiple partitions by binding it to all those partitions. If sharing is disabled, then this vlan can be bound to only one of the partitions.

partitionName Name of the Partition to which this vlan bound to.

vxlan The VXLAN that extends this vlan.

ownerGroup The owner node group in a Cluster for this vlan.

devno count

Example

An example of the output of the show vlan command is as follows:

1) VLAN ID: 5 VLAN Alias Name: Interfaces : 1/7 IPs : 10.102.169.36 Mask: 255.255.255.0

2) VLAN ID: 3 VLAN Alias Name: Interfaces : 1/5(T) Channels : LA/2 LR/1 Done

*(T) - Tagged

unset vlan

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

Synopsis

unset vlan [-aliasName] [-dynamicRouting] [-ipv6DynamicRouting] [-mtu] [-sharing]

add vlan

Adds a VLAN to the Citrix ADC.The newVLAN is not active unless interfaces are bound to it.

Synopsis

add vlan [-aliasName ] [-dynamicRouting ( ENABLED | DISABLED )] [-ipv6DynamicRouting ( ENABLED | DISABLED )] [-mtu ] [-sharing ( ENABLED | DISABLED )]

Arguments

id A positive integer that uniquely identifies a VLAN. Minimum value: 1 Maximum value: 4094

aliasName A name for the VLAN. Must begin with a letter, a number, or the underscore symbol, and can consist of from 1 to 31 letters, numbers, and the hyphen (-), period (.) pound (#), space ( ), at sign (@), equals (=), colon (:), and underscore (_) characters. You should choose a name that helps identify the VLAN. However, you cannot perform any VLAN operation by specifying this name instead of the VLAN ID.

dynamicRouting Enable dynamic routing on this VLAN.

Possible values: ENABLED, DISABLED Default value: DISABLED

ipv6DynamicRouting Enable all IPv6 dynamic routing protocols on this VLAN. 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

mtu Specifies the maximum transmission unit (MTU), in bytes. The MTU is the largest packet size, excluding 14 bytes of ethernet header and 4 bytes of crc, that can be transmitted and received over this VLAN. Default value: 0 Minimum value: 500 Maximum value: 9216

sharing If sharing is enabled, then this vlan can be shared across multiple partitions by binding it to all those partitions. If sharing is disabled, then this vlan can be bound to only one of the partitions.

Possible values: ENABLED, DISABLED Default value: DISABLED

set vlan

Modifies parameters of a VLAN on the Citrix ADC.

Synopsis

set vlan [-aliasName ] [-dynamicRouting ( ENABLED | DISABLED )] [-ipv6DynamicRouting ( ENABLED | DISABLED )] [-mtu ] [-sharing ( ENABLED | DISABLED )]

Arguments

id A positive integer that uniquely identifies a VLAN. Minimum value: 1 Maximum value: 4094

aliasName A name for the VLAN. Must begin with a letter, a number, or the underscore symbol, and can consist of from 1 to 31 letters, numbers, and the hyphen (-), period (.) pound (#), space ( ), at sign (@), equals (=), colon (:), and underscore (_) characters. You should choose a name that helps identify the VLAN. However, you cannot perform any VLAN operation by specifying this name instead of the VLAN ID.

dynamicRouting Enable dynamic routing on this VLAN.

Possible values: ENABLED, DISABLED Default value: DISABLED

ipv6DynamicRouting Enable IPv6 dynamic routing on this vlan. 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

mtu Specifies the maximum transmission unit (MTU), in bytes. The MTU is the largest packet size, excluding 14 bytes of ethernet header and 4 bytes of crc, that can be transmitted and received over this VLAN. Default value: 0 Minimum value: 500 Maximum value: 9216

sharing If sharing is enabled, then this vlan can be shared across multiple partitions by binding it to all those partitions. If sharing is disabled, then this vlan can be bound to only one of the partitions.

Possible values: ENABLED, DISABLED Default value: DISABLED

Example

set vlan 2 -dynamicRouting ENABLED

unbind vlan

Unbinds the specified interfaces or IP addresses from a VLAN. If any of the interfaces are untagged members of the VLAN, they are automatically bound to VLAN 1.

Synopsis

unbind vlan [-ifnum ... [-tagged]] [-IPAddress [] [-td ] [-ownerGroup ]]

Arguments

id The virtual LAN (VLAN) id. Minimum value: 1 Maximum value: 4094

ifnum Interface to unbind from the VLAN, specified in slot/port notation (for example, 1/3). Minimum value: 1

tagged The 802.1q tagged interface.

IPAddress The IP Address associated with the VLAN configuration.

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

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. Minimum value: 0 Maximum value: 4094

ownerGroup The owner node group in a Cluster for this vlan. Default value: DEFAULT_NG

stat vlan

Display statistics for VLAN(s).

Synopsis

stat vlan [] [-detail] [-fullValues] [-ntimes ] [-logFile ] [-clearstats ( basic | full )]

Arguments

id An integer specifying the VLAN identification number (VID). Possible values: 1 through 4094. Minimum value: 1 Maximum value: 4094

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 VLAN.

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

Packets sent (TxPkts) Packets transmitted on the VLAN.

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

Packets dropped (DropPkts) Inbound packets dropped by the VLAN upon reception.

Broadcast pkts sent & received (BcastPkt) Broadcast packets sent and received on the VLAN.

Example

stat vlan 1

bind vlan

Binds the specified interfaces or IP addresses to a VLAN. An interface can be bound to a VLAN as a tagged or an untagged member. Adding an interface as an untagged member removes it from its current native VLAN and adds it to the new VLAN. If an interface is added as a tagged member to a VLAN, it still remains a member of its native VLAN.

Synopsis

bind vlan [-ifnum ... [-tagged]] [-IPAddress [] [-td ] [-ownerGroup ]]

Arguments

id Specifies the virtual LAN ID. Minimum value: 1 Maximum value: 4094

ifnum Interface to be bound to the VLAN, specified in slot/port notation (for example, 1/3). Minimum value: 1

tagged Make the interface an 802.1q tagged interface. Packets leaving this interface have an additional 4-byte 802.1q tag, which identifies the VLAN. To use 802.1q tagging, you must also configure the switch connected to the interfaces on the appliance.

IPAddress Network address to be associated with the VLAN. Should exist on the appliance before you associate it with the VLAN. To enable IP forwarding among VLANs, the specified address can be used as the default gateway by the hosts in the network.

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

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. Minimum value: 0 Maximum value: 4094

ownerGroup The owner node group in a Cluster for this vlan. Default value: DEFAULT_NG

rm vlan

Removes a VLAN from the Citrix ADC. When the VLAN is removed, its interfaces are bound to VLAN 1. Note: VLAN 1 cannot be removed by any command.

Synopsis

rm vlan

Arguments

id Integer that uniquely identifies the VLAN to be removed from the Citrix ADC. When the VLAN is removed, its interfaces become members of VLAN 1. Minimum value: 2 Maximum value: 4094

Was this article helpful?