Skip to content

lb-policylabel

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

add| unbind| rm| bind| show| stat| rename|

add lb policylabel

Creates a user-defined LB policy label, to which you can bind policies. A policy label is a tool for evaluating a set of policies in a specified order.

Synopsis

add lb policylabel [-policylabeltype ] [-comment ]

Arguments

labelName Name for the LB policy label. 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 policy label" or 'my lb policy label').

policylabeltype Protocols supported by the policylabel. Available Types are : * HTTP - HTTP requests. * DNS - DNS request. * OTHERTCP - OTHERTCP request. * SIP_UDP - SIP_UDP request. * SIP_TCP - SIP_TCP request. * MYSQL - MYSQL request. * MSSQL - MSSQL request. * ORACLE - ORACLE request. * NAT - NAT request. * DIAMETER - DIAMETER request. * RADIUS - RADIUS request. * MQTT - MQTT request. * QUIC_BRIDGE - QUIC_BRIDGE request. * HTTP_QUIC - HTTP_QUIC request.

Possible values: HTTP, OTHERTCP, SIP_UDP, SIP_TCP, MYSQL, MSSQL, ORACLE, NAT, DIAMETER, RADIUS, DNS, MQTT, QUIC_BRIDGE, HTTP_QUIC Default value: HTTP

comment Any comments to preserve information about this LB policy label.

Example

add lb policylabel lblabel1

unbind lb policylabel

Unbinds the specified LB policy from the specified policy label.

Synopsis

unbind lb policylabel -policyName

Arguments

labelName Name for the LB policy label. 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 policy label" or 'my lb policy label').

policyName The name of the policy to be unbound.

Example

unbind lb policylabel lblabel1 lbpol1

rm lb policylabel

Removes the specified LB policy label.

Synopsis

rm lb policylabel

Arguments

labelName Name for the LB policy label. 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 policy label" or 'my lb policy label').

Example

rm lb policylabel lblabel1

bind lb policylabel

Binds the specified LB policy to the specified LB policylabel.

Synopsis

bind lb policylabel -policyName -priority [-gotoPriorityExpression ] [-invoke ( ) ]

Arguments

labelName Name for the LB policy label. 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 policy label" or 'my lb policy label').

policyName Name of the policy to bind to the LB policylabel.

priority Positive integer specifying the priority of the policy. A lower number specifies a higher priority. Must be unique within the label. Policies are evaluated in the order of their priority numbers, and the first policy that matches the request is applied. Minimum value: 1 Maximum value: 2147483647

gotoPriorityExpression Expression or other value specifying the next policy to evaluate if the current policy evaluates to TRUE. Specify one of the following values: * NEXT - Evaluate the policy with the next higher priority number. * END - End policy evaluation. * USE_INVOCATION_RESULT - Applicable if this policy invokes another policy label. If the final goto in the invoked policy label has a value of END, the evaluation stops. If the final goto is anything other than END, the current policy label performs a NEXT. * An expression that evaluates to a number. If you specify an expression, the number to which it evaluates determines the next policy to evaluate, as follows: * If the expression evaluates to a higher numbered priority, the policy with that priority is evaluated next. * If the expression evaluates to the priority of the current policy, the policy with the next higher numbered priority is evaluated next. * If the expression evaluates to a number that is larger than the largest numbered priority, policy evaluation ends.

An UNDEF event is triggered if: * The expression is invalid. * The expression evaluates to a priority number that is smaller than the current policys priority number. * The expression evaluates to a priority number that is between the current policy's priority number (say, 30) and the highest priority number (say, 100), but does not match any configured priority number (for example, the expression evaluates to the number 85). This example assumes that the priority number increments by 10 for every successive policy, and therefore a priority number of 85 does not exist in the policy label.

invoke If the current policy evaluates to TRUE, terminate evaluation of policies bound to the current policy label and evaluate the specified policy label.

labelType Type of policy label to invoke. Available settings function as follows: * vserver - Invokes the unnamed policy label associated with the specified virtual server. * policylabel - Invoke a user-defined policy label.

Possible values: reqvserver, policylabel

labelName * If labelType is policylabel, name of the policy label to invoke. * If labelType is reqvserver, name of the virtual server.

Example

bind lb policylabel lblabel1 lbpol1 10

show lb policylabel

Displays the current settings for the specified LB policylabel. If no policy label is specified, displays a list of all the LB policy labels currently configured on the Citrix ADC, with abbreviated settings.

Synopsis

show lb policylabel []

Arguments

labelName Name for the LB policy label. 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 policy label" or 'my lb policy label').

Output

policylabeltype Protocols supported by the policylabel. Available Types are : * HTTP - HTTP requests. * DNS - DNS request. * OTHERTCP - OTHERTCP request. * SIP_UDP - SIP_UDP request. * SIP_TCP - SIP_TCP request. * MYSQL - MYSQL request. * MSSQL - MSSQL request. * ORACLE - ORACLE request. * NAT - NAT request. * DIAMETER - DIAMETER request. * RADIUS - RADIUS request. * MQTT - MQTT request. * QUIC_BRIDGE - QUIC_BRIDGE request. * HTTP_QUIC - HTTP_QUIC request.

stateflag numpol number of polices bound to label.

hits Number of times policy label was invoked.

policyName Name of the LB policy.

priority Specifies the priority of the policy.

flags comment Any comments to preserve information about this LB policy label.

gotoPriorityExpression Expression specifying the priority of the next policy which will get evaluated if the current policy rule evaluates to TRUE.

invoke If the current policy evaluates to TRUE, terminate evaluation of policies bound to the current policy label and evaluate the specified policy label.

labelType Type of policy label to invoke. Available settings function as follows: * vserver - Invokes the unnamed policy label associated with the specified virtual server. * policylabel - Invoke a user-defined policy label.

labelName * If labelType is policylabel, name of the policy label to invoke. * If labelType is reqvserver, name of the virtual server.

devno count

Example

show lb policylabel lblabel1

stat lb policylabel

Displays statistics for the specified LB policy label. If no policy label name is provided, displays abbreviated statistics for all the LB policy labels currently configured on the Citrix ADC.

Synopsis

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

Arguments

labelName Name of the LB policy label.

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

Policy Label Hits (Hits) Number of times policy label was invoked.

rename lb policylabel

Renames the specified LB policy label.

Synopsis

rename lb policylabel @ @

Arguments

labelName Current name of the LB policy label.

newName New name for the LB policy label. 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.

Example

rename lb policylabel oldname newname

Was this article helpful?