Product Documentation

appfw policylabel

Sep 12, 2016

The following operations can be performed on "appfw policylabel":

add appfw policylabel

Creates a user-defined application firewall policy label.

Synopsys

add appfw policylabel <labelName> <policylabeltype>

Arguments

labelName

Name for the policy label. Must begin with a letter, number, or the underscore character (_), and must contain only letters, numbers, and the hyphen (-), period (.) pound (#), space ( ), at (@), equals (=), colon (:), and underscore characters. Can be changed after the policy label is created.

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 policy label" or 'my policy label').

policylabeltype

Type of transformations allowed by the policies bound to the label. Always http_req for application firewall policy labels.

Possible values: http_req

Example

add appfw policylabel appfw_label http_req

rm appfw policylabel

Removes the specified application firewall policy label.

Synopsys

rm appfw policylabel <labelName>

Arguments

labelName

Name of the application firewall policy label to remove.

Example

rm appfw policylabel appfw_label

bind appfw policylabel

Binds the specified application firewall policy to the specified policy label.

Synopsys

bind appfw policylabel <labelName> <policyName> <priority> [<gotoPriorityExpression>] [-invoke (<labelType> <labelName>) ]

Arguments

labelName

Name of the policy label to invoke if the current policy evaluates to TRUE, the invoke parameter is set, and Label Type is set to Policy Label.

policyName

Name of the application firewall policy to bind to the policy label.

priority

Priority with which the policy is to be bound.

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.

* A default syntax or classic 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 policy's 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 then forward the request to the specified virtual server or evaluate the specified policy label.

labelType

Type of policy label to invoke if the current policy evaluates to TRUE and the invoke parameter is set. Available settings function as follows:

* reqvserver. Invoke the unnamed policy label associated with the specified request virtual server.

* policylabel. Invoke the specified user-defined policy label.

Possible values: reqvserver, policylabel

Example

 i) bind appfw policylabel trans_http_url pol_1 1 2 -invoke reqvserver CURRENT  ii) bind appfw policylabel trans_http_url pol_2 2

unbind appfw policylabel

Unbinds the specified application firewall policy from the specified policy label. See the bind appfw policylabel command for descriptions of the parameters.

Synopsys

unbind appfw policylabel <labelName> <policyName> [-priority <positive_integer>]

Arguments

labelName

Name for the policy label. Must begin with a letter, number, or the underscore character (_), and must contain only letters, numbers, and the hyphen (-), period (.) pound (#), space ( ), at (@), equals (=), colon (:), and underscore characters. Can be changed after the policy label is created.

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 policy label" or 'my policy label').

policyName

Name of the application firewall policy to bind to the policy label.

priority

Priority of the NOPOLICY to be unbound.

Minimum value: 1

Maximum value: 2147483647

Example

unbind appfw policylabel appfw_label

show appfw policylabel

Displays the current settings for the specified application firewall policy label. If no policy label is specified, displays a list of all application firewall policy labels currently configured on the NetScaler appliance.

Synopsys

show appfw policylabel [<labelName>]

Arguments

labelName

Name of the application firewall policy label.

Outputs

stateflag

policylabeltype

Type of transformations allowed by the policies bound to the label. Always http_req for application firewall policy labels.

numpol

Number of polices bound to label.

hits

Number of times policy label was invoked.

policyName

Name of the application firewall policy to bind to the policy label.

priority

Positive integer specifying the priority of the policy. A lower number specifies a higher priority. Must be unique within a group of policies that are bound to the same bind point or label. Policies are evaluated in the order of their priority numbers.

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 then forward the request to the specified virtual server or evaluate the specified policy label.

labelType

Type of policy label to invoke if the current policy evaluates to TRUE and the invoke parameter is set. Available settings function as follows:

* reqvserver. Invoke the unnamed policy label associated with the specified request virtual server.

* policylabel. Invoke the specified user-defined policy label.

labelName

Name of the policy label to invoke if the current policy evaluates to TRUE, the invoke parameter is set, and Label Type is set to Policy Label.

description

Description of the policylabel

flags

policyType

devno

count

Example

 i) show appfw policylabel appfw_label  ii) show appfw policylabel

stat appfw policylabel

Displays statistics for the specified application firewall policy label. If no application firewall policy label is specified, displays abbreviated statistics for all application firewall policy labels.

Synopsys

stat appfw policylabel [<labelName>] [-detail] [-fullValues] [-ntimes <positive_integer>] [-logFile <input_filename>] [-clearstats ( basic | full )]

Arguments

labelName

Name of the application firewall 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

Outputs

count

devno

stateflag

Outputs

Policy Label Hits (Hits)

Number of times policy label was invoked.

rename appfw policylabel

Renames an application firewall policy label.

Synopsys

rename appfw policylabel <labelName>@ <newName>@

Arguments

labelName

Existing name of the application firewall policy label.

newName

The new name of the application firewall policylabel.

Example

rename appfw policylabel oldname newname