Developer Documentation
ADC CLI Commands
Current Release 13.1 13.0 12.1

appflow-policylabel

May 28, 2024
Contributed by: 
C

The following operations can be performed on “appflow-policylabel”:

rm add unbind show rename bind

rm appflow policylabel

Removes an AppFlow policy label.

Synopsis

rm appflow policylabel

Arguments

labelName Name of the policy label to be removed.

Example

rm appflow policylabel appflow_pol_label

add appflow policylabel

Creates a user-defined AppFlow policy label. You can bind AppFlow policies to the AppFlow policy label.

Synopsis

add appflow policylabel [-policylabeltype ]

Arguments

labelName Name of the AppFlow policy label. Must begin with an ASCII alphabetic or underscore (_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at (@), equals (=), and hyphen (-) 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 appflow policylabel” or ‘my appflow policylabel’).

policylabeltype Type of traffic evaluated by the policies bound to the policy label.

Possible values: HTTP, OTHERTCP, HTTP_QUIC Default value: HTTP

Example

add appflow policylabel appflow_pol_label

unbind appflow policylabel

Unbinds an AppFlow policy from an AppFlow policy label.

Synopsis

unbind appflow policylabel [-priority ]

Arguments

labelName Name of the policy label from which to unbind a policy.

policyName Name of the policy to unbind.

priority Priority of the NOPOLICY to be unbound. Applicable only if a NOPOLICY has been bound to the policy label. Minimum value: 1 Maximum value: 2147483647

Example

unbind appflow policylabel appflow_pol_label appflow_pol

show appflow policylabel

Displays information about all AppFlow policy labels, or detailed information about the specified policy label.

Synopsis

show appflow policylabel []

Arguments

labelName Name of the policy label about which to display detailed information.

Output

stateflag policylabeltype Type of traffic evaluated by the policies bound to the policy label.

numpol Number of polices bound to the policy label.

hits Number of times the policy label was invoked.

policyName Name of the AppFlow policy.

priority Specifies the priority of the policy.

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

invoke Invoke policies bound to a virtual server or a user-defined policy label. After the invoked policies are evaluated, the flow returns to the policy with the next priority.

labelType Type of policy label to be invoked.

labelName Name of the label to invoke if the current policy evaluates to TRUE.

flowType Flowtype of the bound AppFlow policy.

description Description of the policylabel

flags devno count

Example

i)show appflow policylabel appflow_pol_label ii)show appflow policylabel

rename appflow policylabel

Renames an AppFlow policy label.

Synopsis

rename appflow policylabel @ @

Arguments

labelName Existing name of the policylabel.

newName New name for the policy label. Must begin with an ASCII alphabetic or underscore (_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at (@), equals (=), and hyphen (-) 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 appflow policylabel" or 'my appflow policylabel')

Example

rename appflow policylabel old_name new_name

bind appflow policylabel

Binds an AppFlow policy to an AppFlow policy label.

Synopsis

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

Arguments

labelName Name of the policy label to which to bind the policy.

policyName Name of the policy to bind to the policy label.

priority Priority assigned to the policy. The lower the number, the higher the priority. Minimum value: 1 Maximum value: 2147483647

gotoPriorityExpression Expression or other value specifying the priority of the next policy, within the policy label, to evaluate if the current policy evaluates to TRUE. Specify one of the following values:

  • NEXT - Evaluate the policy with the next higher numbered priority.
  • END - Stop 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, it’s evaluation result determines the next policy to evaluate, as follows:
  • If the expression evaluates to a higher numbered priority, that policy is evaluated next.
  • If the expression evaluates to the priority of the current policy, the policy with the next higher priority number is evaluated next.
  • If the expression evaluates to a priority number that is numerically higher than the highest priority number, policy evaluation ends. An UNDEF event is triggered if:
  • The expression is invalid.
  • The expression evaluates to a priority number that is numerically lower than the current policy’s priority.
  • 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 Invoke policies bound to a virtual server or a user-defined policy label. After the invoked policies are evaluated, the flow returns to the policy with the next priority.

labelType Type of policy label to be invoked.

Possible values: vserver, policylabel

labelName Name of the label to invoke if the current policy evaluates to TRUE.

Example

bind appflow policylabel appflow_pol_label -policyName appflow_pol -priority 1

appflow-policylabel
May 28, 2024
Contributed by: 
C
May 28, 2024
Contributed by: 
C

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.