Product Documentation

responder policylabel

Sep 12, 2016

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

add responder policylabel

Creates a user-defined responder policy label, to which you can bind policies. 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 responder 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 responder policylabel <labelName> [-policylabeltype <policylabeltype>] [-comment <string>]

Arguments

labelName

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

policylabeltype

Type of responses sent by the policies bound to this policy label. Types are:

* HTTP - HTTP responses.

* OTHERTCP - NON-HTTP TCP responses.

* SIP_UDP - SIP responses.

* RADIUS - RADIUS responses.

* MYSQL - SQL responses in MySQL format.

* MSSQL - SQL responses in Microsoft SQL format.

* NAT - NAT response.

Possible values: HTTP, OTHERTCP, SIP_UDP, SIP_TCP, MYSQL, MSSQL, NAT, DIAMETER, RADIUS, DNS

Default value: HTTP

comment

Any comments to preserve information about this responder policy label.

Example

add responder policylabel resp_lab

rm responder policylabel

Removes a responder policy label.

Synopsys

rm responder policylabel <labelName>

Arguments

labelName

Name of the responder policy label to remove.

Example

rm responder policylabel resp_lab

bind responder policylabel

Binds the specified responder policy to the specified policy label.

Synopsys

bind responder 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.

policyName

Name of the policy to bind to the responder 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 priority numbers, and the first policy that matches the request 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 policys 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 evaluate the specified policy label.

labelType

Type of policy label to invoke. Available settings function as follows:

* vserver - Invoke an unnamed policy label associated with a virtual server.

* policylabel - Invoke a user-defined policy label.

Possible values: vserver, policylabel

Example

 i) bind responder policylabel resp_lab pol_resp 1 2  ii) bind responder policylabel resp_lab pol_resp 1 2 -invoke vserver CURRENT

unbind responder policylabel

Unbinds the specified responder policy from the specified policy label.

Synopsys

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

Arguments

labelName

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

policyName

The name of the policy to be unbound.

priority

Priority of the NOPOLICY to be unbound.

Minimum value: 1

Maximum value: 2147483647

Example

unbind responder policylabel resp_lab pol_resp

show responder policylabel

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

Synopsys

show responder policylabel [<labelName>]

Arguments

labelName

Name of the responder policy label.

Outputs

policylabeltype

The type of the policy label.

stateflag

numpol

number of polices bound to label.

hits

Number of times policy label was invoked.

policyName

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

If the current policy evaluates to TRUE, terminate evaluation of policies bound to the current policy label and evaluate the specified policy label.

labelType

Type of policy label to invoke. Available settings function as follows:

* vserver - Invoke an unnamed policy label associated with a virtual server.

* policylabel - Invoke a user-defined 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.

flags

comment

Any comments to preserve information about this responder policy label.

devno

count

Example

 i) show responder policylabel resp_lab  ii) show responder policylabel

stat responder policylabel

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

Synopsys

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

Arguments

labelName

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

Renames the specified responder policy label.

Synopsys

rename responder policylabel <labelName>@ <newName>@

Arguments

labelName

Current name of the responder policy label.

newName

New name for the responder 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.

Example

rename responder policylabel oldname newname