appflow policy¶
The following operations can be performed on "appflow policy":
add | rm | set | unset | rename | show
add appflow policy¶
Adds an Appflow policy. The policy specifies the rule based on which the traffic is evaluated, and the action to be taken if the rule returns "TRUE".
Synopsys¶
add appflow policy <name> <rule> <action> [-comment <string>]
Arguments¶
name
Name for the policy. 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 NetScaler CLI:
If the name includes one or more spaces, enclose the name in double or single quotation marks (for example, "my appflow policy" or 'my appflow policy').
rule
Expression or other value against which the traffic is evaluated. Must be a Boolean, default syntax expression. Note:
Maximum length of a string literal in the expression is 255 characters. A longer string can be split into smaller strings of up to 255 characters each, and the smaller strings concatenated with the + operator. For example, you can create a 500-character string as follows: '"<string of 255 characters>" + "<string of 245 characters>"'
The following requirements apply only to the NetScaler 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.
action
Name of the action to be associated with this policy.
comment
Any comments about this policy.
Example¶
add appflow policy appflow_pol "HTTP.REQ.HEADER(\\"header\\").CONTAINS(\\"qh3\\")" appflow_act
rm appflow policy¶
Removes an AppFlow policy. (Cannot remove a policy that is bound to a policy label.)
Synopsys¶
rm appflow policy <name>
Arguments¶
name
Name of the policy to be removed.
Example¶
rm appflow policy appflow_policy_1
set appflow policy¶
Modifies the rule and/or action for an existing AppFlow policy. The rule for flow type can be changed only if the associated action is of NEUTRAL flow type.
Synopsys¶
set appflow policy <name> [-rule <expression>] [-action <string>] [-comment <string>]
Arguments¶
name
Name of the policy to modify.
rule
Expression or other value against which the traffic is evaluated. Must be a Boolean, default syntax expression. Note:
Maximum length of a string literal in the expression is 255 characters. A longer string can be split into smaller strings of up to 255 characters each, and the smaller strings concatenated with the + operator. For example, you can create a 500-character string as follows: '"<string of 255 characters>" + "<string of 245 characters>"'
The following requirements apply only to the NetScaler 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.
action
Name of the action to be associated with this policy.
comment
Any comments about this policy.
Example¶
set appflow policy appflow_policy -rule "HTTP.REQ.HEADER(\\"header\\").CONTAINS(\\"qh2\\")"
unset appflow policy¶
Use this command to remove appflow policy settings.Refer to the set appflow policy command for meanings of the arguments.
Synopsys¶
unset appflow policy <name> -comment
rename appflow policy¶
Renames an AppFlow policy.
Synopsys¶
rename appflow policy <name>@ <newName>@
Arguments¶
name
Existing name of the policy.
newName
New name for the policy. 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 NetScaler CLI:
If the name includes one or more spaces, enclose the name in double or single quotation marks (for example, "my appflow policy" or 'my appflow policy').
Example¶
rename appflow policy old_name new_name
show appflow policy¶
Displays information about all configured AppFlow policies, or detailed information about the specified policy.
Synopsys¶
show appflow policy [<name>]
Arguments¶
name
Name of the policy about which to display detailed information.
Outputs¶
stateflag
rule
Expression to be used by AppFlow policy.
action
AppFlow action associated with the policy.
hits
Number of hits.
undefHits
Number of policy UNDEF hits.
activePolicy
Indicates whether policy is bound or not.
boundTo
Location where policy is bound.
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.
labelType
Type of policy label invocation.
labelName
Name of the label to invoke if the current policy rule evaluates to TRUE.
description
Description of the policy
comment
Any comments about this policy.
bindPolicyType
vserverType
devno
count
Example¶
show appflow policy