Product Documentation

rewrite policylabel

Sep 12, 2016

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

add rewrite policylabel

Creates a user-defined rewrite policy label.

Synopsys

add rewrite policylabel <labelName> <transform> [-comment <string>]

Arguments

labelName

Name for the rewrite 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. Cannot be changed after the rewrite 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 rewrite policy label" or ?my rewrite policy label?).

transform

Types of transformations allowed by the policies bound to the label. For Rewrite, the following types are supported:

* http_req - HTTP requests

* http_res - HTTP responses

* othertcp_req - Non-HTTP TCP requests

* othertcp_res - Non-HTTP TCP responses

* url - URLs

* text - Text strings

* clientless_vpn_req - NetScaler clientless VPN requests

* clientless_vpn_res - NetScaler clientless VPN responses

* sipudp_req - SIP requests

* sipudp_res - SIP responses

* diameter_req - DIAMETER requests

* diameter_res - DIAMETER responses

* radius_req - RADIUS requests

* radius_res - RADIUS responses

* dns_req - DNS requests

* dns_res - DNS responses

Possible values: http_req, http_res, othertcp_req, othertcp_res, url, text, clientless_vpn_req, clientless_vpn_res, sipudp_req, sipudp_res, siptcp_req, siptcp_res, diameter_req, diameter_res, radius_req, radius_res, dns_req, dns_res

comment

Any comments to preserve information about this rewrite policy label.

Example

add rewrite policylabel trans_http_url http_req

rm rewrite policylabel

Removes the specified rewrite policy label.

Synopsys

rm rewrite policylabel <labelName>

Arguments

labelName

Name of the rewrite policy label to remove.

Example

rm rewrite policylabel trans_http_url

bind rewrite policylabel

Binds the specified rewrite policy to the specified policy label.

Synopsys

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

Arguments

labelName

* If labelType is policylabel, name of the policy label to invoke.

* If labelType is reqvserver or resvserver, name of the virtual server to which to forward the request or response.

policyName

Name of the rewrite 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 the label. Policies are evaluated in the order of their priorities, and the first policy that matches the request or response 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.

* 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

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

* resvserver - Forward the response to the specified response virtual server.

* policylabel - Invoke the specified policy label.

Possible values: reqvserver, resvserver, policylabel

Example

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

unbind rewrite policylabel

Unbinds the specified rewrite policy from the specified policy label. See the bind rewrite policylabel command for a description of the parameters.

Synopsys

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

Arguments

labelName

Name for the rewrite 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. Cannot be changed after the rewrite 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 rewrite policy label" or ?my rewrite policy label?).

policyName

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

priority

Priority of the NOPOLICY to be unbound.

Minimum value: 1

Maximum value: 2147483647

Example

unbind rewrite policylabel trans_http_url pol_1

show rewrite policylabel

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

Synopsys

show rewrite policylabel [<labelName>]

Arguments

labelName

Name of the rewrite policy label.

Outputs

stateflag

transform

Types of transformations allowed by the policies bound to the label. For Rewrite, the following types are supported:

* http_req - HTTP requests

* http_res - HTTP responses

* othertcp_req - Non-HTTP TCP requests

* othertcp_res - Non-HTTP TCP responses

* url - URLs

* text - Text strings

* clientless_vpn_req - NetScaler clientless VPN requests

* clientless_vpn_res - NetScaler clientless VPN responses

* sipudp_req - SIP requests

* sipudp_res - SIP responses

* diameter_req - DIAMETER requests

* diameter_res - DIAMETER responses

* radius_req - RADIUS requests

* radius_res - RADIUS responses

* dns_req - DNS requests

* dns_res - DNS responses

numpol

Number of polices bound to label.

hits

Number of times policy label was invoked.

policyName

Name of the rewrite 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

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

* resvserver - Forward the response to the specified response virtual server.

* policylabel - Invoke the specified policy label.

labelName

* If labelType is policylabel, name of the policy label to invoke.

* If labelType is reqvserver or resvserver, name of the virtual server to which to forward the request or response.

flowType

Flowtype of the bound rewrite policy.

description

Description of the policylabel

isDefault

A value of true is returned if it is a default rewritepolicylabel.

flags

comment

Any comments to preserve information about this rewrite policy label.

builtin

Flag to determine if rewrite policy label is built-in or not

devno

count

Example

 i) show rewrite policylabel trans_http_url  ii) show rewrite policylabel

stat rewrite policylabel

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

Synopsys

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

Arguments

labelName

Name of the rewrite 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 rewrite policylabel

Renames a rewrite policy label.

Synopsys

rename rewrite policylabel <labelName>@ <newName>@

Arguments

labelName

Current name of the policy label.

newName

New name for the rewrite 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 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?).

Example

rename rewrite policylabel oldname newname