Product Documentation

transform policylabel

Sep 12, 2016

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

add transform policylabel

Creates a URL Transformation policy label. A policy label is a tool for evaluating a set of policies in a specified order. By using a policy label, you can configure the URL Transformation feature to choose the next policy, invoke a different policy label, or terminate policy evaluation completely by looking at whether the previous policy evaluated to TRUE or FALSE.

Synopsys

add transform 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 URL Transformation policy label is added.

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 transform policylabel? or ?my transform policylabel).

policylabeltype

Types of transformations allowed by the policies bound to the label. For URL transformation, always http_req (HTTP Request).

Possible values: http_req

Example

add transform policylabel trans_policylabel http_req

rm transform policylabel

Removes a URL Transformation policy label.

Synopsys

rm transform policylabel <labelName>

Arguments

labelName

Name of the policy label to remove.

Example

rm transform policylabel trans_policylabel

bind transform policylabel

Binds the specified URL Transformation policy to the specified policy label.

Synopsys

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

Arguments

labelName

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

policyName

Name of the URL Transformation policy to bind to the policy label.

priority

Positive integer specifying the priority of the policy within the policy label. A lower number specifies a higher priority. Must be unique within the list of policies bound to the label. Policies are evaluated in the order of their priority numbers, and the first policy that matches is applied.

Minimum value: 1

Maximum value: 2147483647

gotoPriorityExpression

Optional 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 PCRE-compatible regular 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 priority number is evaluated next.

* If the expression evaluates to a number that is larger than the largest priority number, 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 invocation. Available settings function as follows:

* reqvserver - Forward the request to the specified request virtual server.

* policylabel - Invoke the specified policy label.

Possible values: reqvserver, policylabel

Example

 i) bind transform policylabel trans_policylabel pol_1 1 2 -invoke reqvserver CURRENT  ii) bind transform policylabel trans_policylabel pol_2 2

unbind transform policylabel

Unbinds the specified URL Transformation policy from the specified policy label.

Synopsys

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

Arguments

labelName

Name of the label from which to unbind the policy.

policyName

Name of the label to which to bind the policy.

priority

Priority of the NOPOLICY to be unbound.

Minimum value: 1

Maximum value: 2147483647

Example

unbind transform policylabel trans_policylabel pol_1

show transform policylabel

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

Synopsys

show transform policylabel [<labelName>]

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 URL Transformation policy label is added.

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 transform policylabel? or ?my transform policylabel).

Outputs

stateflag

policylabeltype

Types of transformations allowed by the policies bound to the label. For URL transformation, always http_req (HTTP Request).

numpol

Number of polices bound to label.

hits

Number of times policy label was invoked.

policyName

Name of the URL Transformation policy to bind to the policy label.

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

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 invocation. Available settings function as follows:

* reqvserver - Forward the request to the specified request virtual server.

* policylabel - Invoke the specified policy label.

labelName

Name of the policy label.

description

Description of the policylabel

flags

devno

count

Example

 i) show transform policylabel trans_policylabel  ii) show transform policylabel

stat transform policylabel

Displays statistics for the specified URL Transformation policy label. If no policy label name is provided, displays abbreviated statistics for all URL Transformation policy labels currently configured on the NetScaler appliance.

Synopsys

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

Arguments

labelName

The name of the URL Transformation 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.

Related Commands

rename transform policylabel

Renames a URL Transformation policy label.

Synopsys

rename transform policylabel <labelName>@ <newName>@

Arguments

labelName

Current name of the policy label.

newName

New 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.

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 transform policylabel? or ?my transform policylabel).

Example

rename transform policylabel oldname newname