Skip to content

vrID

The following operations can be performed on "vrID":

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

add vrID

Adds a VMAC address to the Citrix ADC. A Virtual MAC address (VMAC) is a floating entity, shared by the nodes in an high availability, or active-active, or cluster setup

Synopsis

add vrID [-priority ] [-preemption ( ENABLED | DISABLED )] [-sharing ( ENABLED | DISABLED )] [-tracking ] [-ownerNode ] [-trackifNumPriority ] [-preemptiondelaytimer ]

Arguments

id Integer that uniquely identifies the VMAC address. The generic VMAC address is in the form of 00:00:5e:00:01:. For example, if you add a VRID with a value of 60 and bind it to an interface, the resulting VMAC address is 00:00:5e:00:01:3c, where 3c is the hexadecimal representation of 60. Minimum value: 1 Maximum value: 255

priority Base priority (BP), in an active-active mode configuration, which ordinarily determines the master VIP address. Default value: 255 Minimum value: 0 Maximum value: 255

preemption In an active-active mode configuration, make a backup VIP address the master if its priority becomes higher than that of a master VIP address bound to this VMAC address. If you disable pre-emption while a backup VIP address is the master, the backup VIP address remains master until the original master VIP's priority becomes higher than that of the current master.

Possible values: ENABLED, DISABLED Default value: ENABLED

sharing In an active-active mode configuration, enable the backup VIP address to process any traffic instead of dropping it.

Possible values: ENABLED, DISABLED Default value: DISABLED

tracking The effective priority (EP) value, relative to the base priority (BP) value in an active-active mode configuration. When EP is set to a value other than None, it is EP, not BP, which determines the master VIP address. Available settings function as follows: * NONE - No tracking. EP = BP * ALL - If the status of all virtual servers is UP, EP = BP. Otherwise, EP = 0. * ONE - If the status of at least one virtual server is UP, EP = BP. Otherwise, EP = 0. * PROGRESSIVE - If the status of all virtual servers is UP, EP = BP. If the status of all virtual servers is DOWN, EP = 0. Otherwise EP = BP (1 - K/N), where N is the total number of virtual servers associated with the VIP address and K is the number of virtual servers for which the status is DOWN. Default: NONE.

Possible values: NONE, ONE, ALL, PROGRESSIVE Default value: NONE

ownerNode In a cluster setup, assign a cluster node as the owner of this VMAC address for IP based VRRP configuration. If no owner is configured, owner node is displayed as ALL and one node is dynamically elected as the owner. Default value: -1 Minimum value: 0 Maximum value: 31

trackifNumPriority Priority by which the Effective priority will be reduced if any of the tracked interfaces goes down in an active-active configuration. Default value: 0 Minimum value: 1 Maximum value: 255

preemptiondelaytimer Preemption delay time, in seconds, in an active-active configuration. If any high priority node will come in network, it will wait for these many seconds before becoming master. Default value: 0 Minimum value: 1 Maximum value: 36000

Example

add vrID 1

rm vrID

Removes a specified VMAC entry or all VMAC entries from the Citrix ADC.

Synopsis

rm vrID ( | -all)

Arguments

id Integer value that uniquely identifies the VMAC address. Minimum value: 1 Maximum value: 255

all Remove all the configured VMAC addresses from the Citrix ADC.

unset vrID

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

Synopsis

unset vrID [-priority] [-preemption] [-sharing] [-tracking] [-ownerNode] [-trackifNumPriority] [-preemptiondelaytimer]

show vrID

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

Synopsis

show vrID []

Arguments

id Integer value that uniquely identifies the VMAC address. Minimum value: 1 Maximum value: 255

Output

ifaces Interfaces bound to this VRID.

ifnum Interfaces to bind to the VMAC, specified in (slot/port) notation (for example, 1/2).Use spaces to separate multiple entries.

type Indicates whether this VRID entry was added manually or dynamically. When you manually add a VRID entry, the value for this parameter is STATIC. Otherwise, it is DYNAMIC.

vlan The VLAN in which this VRID resides.

priority Base priority (BP), in an active-active mode configuration, which ordinarily determines the master VIP address.

effectivePriority The effective priority of this VRID.

preemption In an active-active mode configuration, make a backup VIP address the master if its priority becomes higher than that of a master VIP address bound to this VMAC address. If you disable pre-emption while a backup VIP address is the master, the backup VIP address remains master until the original master VIP's priority becomes higher than that of the current master.

sharing In an active-active mode configuration, enable the backup VIP address to process any traffic instead of dropping it.

tracking The effective priority (EP) value, relative to the base priority (BP) value in an active-active mode configuration. When EP is set to a value other than None, it is EP, not BP, which determines the master VIP address. Available settings function as follows: * NONE - No tracking. EP = BP * ALL - If the status of all virtual servers is UP, EP = BP. Otherwise, EP = 0. * ONE - If the status of at least one virtual server is UP, EP = BP. Otherwise, EP = 0. * PROGRESSIVE - If the status of all virtual servers is UP, EP = BP. If the status of all virtual servers is DOWN, EP = 0. Otherwise EP = BP (1 - K/N), where N is the total number of virtual servers associated with the VIP address and K is the number of virtual servers for which the status is DOWN. Default: NONE.

flags Flags.

IPAddress The IP address bound to the VRID.

state State of this VRID.

stateflag operationalOwnerNode Run time owner node of the vrid.

ownerNode In a cluster setup, assign a cluster node as the owner of this VMAC address for IP based VRRP configuration. If no owner is configured, owner node is displayed as ALL and one node is dynamically elected as the owner.

trackifNum Interfaces which need to be tracked for this vrID.

trackifNumPriority Priority by which the Effective priority will be reduced if any of the tracked interfaces goes down in an active-active configuration.

preemptiondelaytimer Preemption delay time, in seconds, in an active-active configuration. If any high priority node will come in network, it will wait for these many seconds before becoming master.

devno count

Example

show vrid

unbind vrID

Unbinds specified interfaces from a VMAC configuration.

Synopsis

unbind vrID (-ifnum ... | -trackifNum ...)

Arguments

id Integer value that uniquely identifies the VMAC address. The generic VMAC address is in the form of 00:00:5e:00:01:. For example, if you add a VRID with a value of 60 and bind it to an interface, the resulting VMAC address is 00:00:5e:00:01:3c, where 3c is the hexadecimal representation of 60. Minimum value: 1 Maximum value: 255

ifnum Interfaces to unbind from the VMAC, specified in (slot/port) notation (for example, 1/2). Use spaces to separate multiple entries.

trackifNum Interfaces which need to be tracked for this vrID.

bind vrID

Binds the specified interfaces to a VMAC configuration.

Synopsis

bind vrID (-ifnum ... | -trackifNum ...)

Arguments

id Integer that uniquely identifies the VMAC address. The generic VMAC address is in the form of 00:00:5e:00:01:. For example, if you add a VRID with a value of 60 and bind it to an interface, the resulting VMAC address is 00:00:5e:00:01:3c, where 3c is the hexadecimal representation of 60. Minimum value: 1 Maximum value: 255

ifnum Interfaces to bind to the VMAC. Use spaces to separate multiple entries. For a Citrix ADC, specify the interface in C/U notation (for example, 1/3).For a cluster setup for configuring interface based VRRP, specify the interface in N/C/U notation (for example, 2/1/3) . where C can take one of the following values: * 0 - Indicates a mgmt port. * 1 - Indicates a 1 Gbps port. * 10 - Indicates a 10 Gbps port. Note: Interface based VRRP is only applicable to a two-node cluster where one of node is in active state and the other in Spare. You must associate the VRID to the interfaces of both the nodes of the active-spare cluster setup. This is because unlike in a high availability setup, interface ID differs in a cluster setup

trackifNum Interfaces which need to be tracked for this vrID.

Example

add vrID 1

set vrID

Modifies parameters related to a VMAC address on the Citrix ADC.

Synopsis

set vrID [-priority ] [-preemption ( ENABLED | DISABLED )] [-sharing ( ENABLED | DISABLED )] [-tracking ] [-ownerNode ] [-trackifNumPriority ] [-preemptiondelaytimer ]

Arguments

id Integer value that uniquely identifies the VMAC address. The generic VMACaddressis in the form of 00:00:5e:00:01:. For example, if you add a VRID with a value of 60 and bind it to an interface, the resulting VMAC address is 00:00:5e:00:01:3c, where 3c is the hexadecimal representation of 60. Minimum value: 1 Maximum value: 255

priority Base priority (BP), in an active-active mode configuration, which ordinarily determines the master VIP address. Default value: 255 Minimum value: 0 Maximum value: 255

preemption In an active-active mode configuration, make a backup VIP address the master if its priority becomes higher than that of a master VIP address bound to this VMAC address. If you disable pre-emption while a backup VIP address is the master, the backup VIP address remains master until the original master VIP's priority becomes higher than that of the current master.

Possible values: ENABLED, DISABLED Default value: ENABLED

sharing In an active-active mode configuration, enable the backup VIP address to process any traffic instead of dropping it.

Possible values: ENABLED, DISABLED Default value: DISABLED

tracking The effective priority (EP) value, relative to the base priority (BP) value in an active-active mode configuration. When EP is set to a value other than None, it is EP, not BP, which determines the master VIP address. Available settings function as follows: * NONE - No tracking. EP = BP * ALL - If the status of all virtual servers is UP, EP = BP. Otherwise, EP = 0. * ONE - If the status of at least one virtual server is UP, EP = BP. Otherwise, EP = 0. * PROGRESSIVE - If the status of all virtual servers is UP, EP = BP. If the status of all virtual servers is DOWN, EP = 0. Otherwise EP = BP (1 - K/N), where N is the total number of virtual servers associated with the VIP address and K is the number of virtual servers for which the status is DOWN. Default: NONE.

Possible values: NONE, ONE, ALL, PROGRESSIVE Default value: NONE

ownerNode In a cluster setup, assign a cluster node as the owner of this VMAC address for IP based VRRP configuration. If no owner is configured, owner node is displayed as ALL and one node is dynamically elected as the owner. Default value: -1 Minimum value: 0 Maximum value: 31

trackifNumPriority Priority by which the Effective priority will be reduced if any of the tracked interfaces goes down. Default value: 0 Minimum value: 1 Maximum value: 255

preemptiondelaytimer Preemption delay time, in seconds, in an active-active configuration. If any high priority node will come in network, it will wait for these many seconds before becoming master. Default value: 0 Minimum value: 1 Maximum value: 36000

Example

set vrID 1 -priority 100

Was this article helpful?