Skip to content

lb-action

The following operations can be performed on "lb-action":

show| rm| unset| rename| add| set|

show lb action

Displays the current settings for the specified LB action. If no action name is provided, displays a list of all LB actions currently configured on the Citrix ADC, with abbreviated settings.

Synopsis

show lb action []

Arguments

name Name for the LB action. Must begin with a letter, number, or the underscore character (_), and must contain only letters, numbers, and the hyphen (-), period (.) hash (#), space ( ), at (@), equals (=), colon (:), and underscore characters.

The following requirement applies only to the Citrix ADC CLI: If the name includes one or more spaces, enclose the name in double or single quotation marks (for example, "my lb action" or 'my lb action').

Output

stateflag type Type of an LB action. Available settings function as follows: * NOLBACTION - Does not consider LB action in making LB decision. * SELECTIONORDER - services bound to vserver with order specified in value parameter is considerd for lb/gslb decision.

value The selection order list used during lb/gslb decision. Preference of services during lb/gslb decision is as follows - services corresponding to first order specified in the sequence is considered first, services corresponding to second order specified in the sequence is considered next and so on. For example, if -value 2 1 3 is specified here and service-1 bound to a vserver with order 1, service-2 bound to a vserver with order 2 and service-3 bound to a vserver with order 3. Then preference of selecting services in LB decision is as follows: service-2, service-1, service-3.

hits The number of times the action has been taken.

referenceCount The number of references to the action.

undefHits The number of times the action resulted in UNDEF.

comment Comment. Any type of information about this LB action.

feature The feature to be checked while applying this config

builtin Flag to determine whether LB action is built-in or not

gslbBindings Number of times action is used in a policy bound to a gslb vserver

devno count

Example

show lb action lbact1

rm lb action

Removes the specified LB action.

Synopsis

rm lb action

Arguments

name Name for the LB action. Must begin with a letter, number, or the underscore character (_), and must contain only letters, numbers, and the hyphen (-), period (.) hash (#), space ( ), at (@), equals (=), colon (:), and underscore characters.

The following requirement applies only to the Citrix ADC CLI: If the name includes one or more spaces, enclose the name in double or single quotation marks (for example, "my lb action" or 'my lb action').

Example

rm lb action lbact1

unset lb action

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

Synopsis

unset lb action -comment

rename lb action

Renames an LB action.

Synopsis

rename lb action @ @

Arguments

name Existing name of the LB action

newName New name for the LB action. Must begin with a letter, number, or the underscore character (_), and must contain only letters, numbers, and the hyphen (-), period (.) hash (#), space ( ), at (@), equals (=), colon (:), and underscore characters.

The following requirement applies only to the Citrix ADC CLI: If the name includes one or more spaces, enclose the name in double or single quotation marks (for example, "my lb action" or my lb action').

Example

rename lb action lbact1 lbact2

add lb action

Creates an LB action which specifies a selection order for the given client request.

Synopsis

add lb action -type ( NOLBACTION | SELECTIONORDER ) [-value ...] [-comment ]

Arguments

name Name for the LB action. Must begin with a letter, number, or the underscore character (_), and must contain only letters, numbers, and the hyphen (-), period (.) hash (#), space ( ), at (@), equals (=), colon (:), and underscore characters.

The following requirement applies only to the Citrix ADC CLI: If the name includes one or more spaces, enclose the name in double or single quotation marks (for example, "my lb action" or 'my lb action').

type Type of an LB action. Available settings function as follows: * NOLBACTION - Does not consider LB action in making LB decision. * SELECTIONORDER - services bound to vserver with order specified in value parameter is considerd for lb/gslb decision.

Possible values: NOLBACTION, SELECTIONORDER

value The selection order list used during lb/gslb decision. Preference of services during lb/gslb decision is as follows - services corresponding to first order specified in the sequence is considered first, services corresponding to second order specified in the sequence is considered next and so on. For example, if -value 2 1 3 is specified here and service-1 bound to a vserver with order 1, service-2 bound to a vserver with order 2 and service-3 bound to a vserver with order 3. Then preference of selecting services in LB decision is as follows: service-2, service-1, service-3. Minimum value: 1

comment Comment. Any type of information about this LB action.

Example

add lb action lbact1 -type SELECTIONORDER -value 2 1 3

set lb action

Modifies the specified parameters of an LB action.

Synopsis

set lb action [-value ...] [-comment ]

Arguments

name Name for the LB action. Must begin with a letter, number, or the underscore character (_), and must contain only letters, numbers, and the hyphen (-), period (.) hash (#), space ( ), at (@), equals (=), colon (:), and underscore characters.

The following requirement applies only to the Citrix ADC CLI: If the name includes one or more spaces, enclose the name in double or single quotation marks (for example, "my lb action" or 'my lb action').

value The selection order list used during lb/gslb decision. Preference of services during lb/gslb decision is as follows - services corresponding to first order specified in the sequence is considered first, services corresponding to second order specified in the sequence is considered next and so on. For example, if -value 2 1 3 is specified here and service-1 bound to a vserver with order 1, service-2 bound to a vserver with order 2 and service-3 bound to a vserver with order 3. Then preference of selecting services in LB decision is as follows: service-2, service-1, service-3. Minimum value: 1

comment Comment. Any type of information about this LB action.

Example

set lb action lbact1 -value 3 2 1

Was this article helpful?