Skip to content

lb group

The following operations can be performed on "lb group":

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

add lb group

p{white-space: pre-wrap;}

Adds lb group entity

Synopsys

add lb group <name>@ [-persistenceType <persistenceType>] [-persistenceBackup ( SOURCEIP | NONE )] [-backupPersistenceTimeout <mins>] [-persistMask <netmask>] [-cookieName <string>] [-v6persistmasklen <positive_integer>] [-cookieDomain <string>] [-timeout <mins>] [-rule <expression>] [-useVserverPersistency ( ENABLED | DISABLED )]

Arguments

name

Name of the load balancing virtual server group.

persistenceType

Type of persistence for the group. Available settings function as follows:

  • SOURCEIP - Create persistence sessions based on the client IP.

  • COOKIEINSERT - Create persistence sessions based on a cookie in client requests. The cookie is inserted by a Set-Cookie directive from the server, in its first response to a client.

  • RULE - Create persistence sessions based on a user defined rule.

  • NONE - Disable persistence for the group.

Possible values: SOURCEIP, COOKIEINSERT, RULE, NONE

persistenceBackup

Type of backup persistence for the group.

Possible values: SOURCEIP, NONE

backupPersistenceTimeout

Time period, in minutes, for which backup persistence is in effect.

Default value: 2

Minimum value: 2

Maximum value: 1440

persistMask

Persistence mask to apply to source IPv4 addresses when creating source IP based persistence sessions.

Default value: 0xFFFFFFFF

cookieName

Use this parameter to specify the cookie name for COOKIE peristence type. It specifies the name of cookie with a maximum of 32 characters. If not specified, cookie name is internally generated.

v6persistmasklen

Persistence mask to apply to source IPv6 addresses when creating source IP based persistence sessions.

Default value: 128

Minimum value: 1

Maximum value: 128

cookieDomain

Domain attribute for the HTTP cookie.

timeout

Time period for which a persistence session is in effect.

Default value: 2

Maximum value: 1440

rule

Expression, or name of a named expression, against which traffic is evaluated.

The following requirements apply only to the Citrix ADC CLI:

  • If the expression includes one or more spaces, enclose the entire expression in double quotation marks.

  • If the expression itself includes double quotation marks, escape the quotations by using the \ character.

  • Alternatively, you can use single quotation marks to enclose the rule, in which case you do not have to escape the double quotation marks.

Default value: "None"

useVserverPersistency

Use this parameter to enable vserver level persistence on group members. This allows member vservers to have their own persistence, but need to be compatible with other members persistence rules. When this setting is enabled persistence sessions created by any of the members can be shared by other member vservers.

Possible values: ENABLED, DISABLED

Default value: DISABLED

set lb group

p{white-space: pre-wrap;}

Configures persistence for the specified load balancing group. The persistence settings are applied to all the members of the group.

Synopsys

set lb group <name>@ [-persistenceType <persistenceType>] [-persistenceBackup ( SOURCEIP | NONE )] [-backupPersistenceTimeout <mins>] [-persistMask <netmask>] [-cookieName <string>] [-v6persistmasklen <positive_integer>] [-cookieDomain <string>] [-timeout <mins>] [-rule <expression>] [-useVserverPersistency ( ENABLED | DISABLED )] [-masterVserver <string>]

Arguments

name

Name of the load balancing virtual server group.

persistenceType

Type of persistence for the group. Available settings function as follows:

  • SOURCEIP - Create persistence sessions based on the client IP.

  • COOKIEINSERT - Create persistence sessions based on a cookie in client requests. The cookie is inserted by a Set-Cookie directive from the server, in its first response to a client.

  • RULE - Create persistence sessions based on a user defined rule.

  • NONE - Disable persistence for the group.

Possible values: SOURCEIP, COOKIEINSERT, RULE, NONE

persistenceBackup

Type of backup persistence for the group.

Possible values: SOURCEIP, NONE

backupPersistenceTimeout

Time period, in minutes, for which backup persistence is in effect.

Default value: 2

Minimum value: 2

Maximum value: 1440

persistMask

Persistence mask to apply to source IPv4 addresses when creating source IP based persistence sessions.

Default value: 0xFFFFFFFF

cookieName

Use this parameter to specify the cookie name for COOKIE peristence type. It specifies the name of cookie with a maximum of 32 characters. If not specified, cookie name is internally generated.

v6persistmasklen

Persistence mask to apply to source IPv6 addresses when creating source IP based persistence sessions.

Default value: 128

Minimum value: 1

Maximum value: 128

cookieDomain

Domain attribute for the HTTP cookie.

timeout

Time period for which a persistence session is in effect.

Default value: 2

Maximum value: 1440

rule

Expression, or name of a named expression, against which traffic is evaluated.

The following requirements apply only to the Citrix ADC CLI:

  • If the expression includes one or more spaces, enclose the entire expression in double quotation marks.

  • If the expression itself includes double quotation marks, escape the quotations by using the \ character.

  • Alternatively, you can use single quotation marks to enclose the rule, in which case you do not have to escape the double quotation marks.

Default value: "None"

useVserverPersistency

Use this parameter to enable vserver level persistence on group members. This allows member vservers to have their own persistence, but need to be compatible with other members persistence rules. When this setting is enabled persistence sessions created by any of the members can be shared by other member vservers.

Possible values: ENABLED, DISABLED

Default value: DISABLED

masterVserver

When USE_VSERVER_PERSISTENCE is enabled, one can use this setting to designate a member vserver as master which is responsible to create the persistence sessions

Example

set lb group webgrp -persistenceType COOKIEINSERT To set the persistence type for multiple groups use the following command: set lb group webgrp[1-3] -persistenceType COOKIEINSERT

unset lb group

p{white-space: pre-wrap;}

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

Synopsys

unset lb group <name>@ [-persistenceType] [-persistenceBackup] [-backupPersistenceTimeout] [-persistMask] [-cookieName] [-v6persistmasklen] [-cookieDomain] [-timeout] [-rule] [-useVserverPersistency] [-masterVserver]

bind lb group

p{white-space: pre-wrap;}

Binds one or more virtual servers to a load balancing virtual server group. If the specified group does not exist, the Citrix ADC first creates the group, and then binds the virtual servers to it. A virtual server group enables you to specify common persistence settings for all of its members through a single set lb group command. Only address-based virtual servers can be added to a group. Content-based virtual servers (content switching and cache redirection virtual servers) cannot be added. A virtual server can be assigned to only one group at any given time. To move a virtual server from one group to another, the virtual server must first be unbound from the group to which it belongs.

Synopsys

bind lb group <name>@ <vServerName>@ ...

Arguments

name

Name for the load balancing virtual server group. Must begin with an ASCII alphanumeric or underscore (_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at (@), equals (=), and hyphen (-) characters. Can be changed after the virtual server is created.

CLI Users: If the name includes one or more spaces, enclose the name in double or single quotation marks (for example, "my lbgroup" or 'my lbgroup').

vServerName

Name of the virtual server to bind to the group. Multiple names can be specified.

Example

bind lb group webgrp http_vip To bind multiple vservers to a group use the following command: bind lb group webgrp v[1-4] To bind vserver v1 to group webgrp1, v2 to webgrp2 and v3 to webgrp3, use the following command: bind lb group webgrp[1-3] v[1-3]

unbind lb group

p{white-space: pre-wrap;}

Unbinds one or more virtual servers from a group.

Synopsys

unbind lb group <name> <vServerName>@ ...

Arguments

name

Name of the load balancing virtual server group.

vServerName

Name of the virtual server to unbind. Multiple names can be specified.

Example

unbind lb group webgroup http_vip To unbind multiple vservers use the following command: unbind lb group webgroup v[1-3]

rm lb group

p{white-space: pre-wrap;}

Removes the lb group

Synopsys

rm lb group <name>@ ...

Arguments

name

Name of the lb group to delete.

Example

rm lb group lb_grp1

show lb group

p{white-space: pre-wrap;}

Displays the virtual servers bound to the specified group.

Synopsys

show lb group [<name>]

Arguments

name

Name of the load balancing virtual server group.

Outputs

vServerName

Virtual server name.

persistenceType

The type of the persistence set for the group.

persistenceBackup

The type of the backup persistence set for the group.

backupPersistenceTimeout

Time period, in minutes, for which backup persistence is in effect.

persistMask

The netmask applied for ipv4 traffic when the persistency type is SOURCEIP.

v6persistmasklen

The netmask applied for ipv6 traffic when the persistency type is SOURCEIP.

cookieName

Use this parameter to specify the cookie name for COOKIE peristence type. It specifies the name of cookie with a maximum of 32 characters. If not specified, cookie name is internally generated.

cookieDomain

Domain attribute for the HTTP cookie.

timeout

Time period for which a persistence session is in effect.

rule

Rule type.

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.

stateflag

useVserverPersistency

Use this parameter to enable vserver level persistence on group members. This allows member vservers to have their own persistence, but need to be compatible with other members persistence rules. When this setting is enabled persistence sessions created by any of the members can be shared by other member vservers.

masterVserver

When USE_VSERVER_PERSISTENCE is enabled, one can use this setting to designate a member vserver as master which is responsible to create the persistence sessions

devno

count

Example

show lb group webgrp

rename lb group

p{white-space: pre-wrap;}

Renames a load balancing virtual server group.

Synopsys

rename lb group <name>@ <newName>@

Arguments

name

Existing name of the load balancing virtual server group.

newName

New name for the load balancing virtual server group.

Example

rename lb group gv1 gv-new1