Product Documentation

ica policy

Sep 12, 2016

The following operations can be performed on "ica policy":

add | rm | set | unset | stat | rename | show

add ica policy

This command adds an ICA policy. The policy specifies the rule, on which the traffic is evaluated, and the action to be taken if the rule returns "TRUE".

Synopsys

add ica policy <name> -rule <expression> -action <string> [-comment <string>] [-logAction <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 ica policy" or 'my ica 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 ica action to be associated with this policy.

comment

Any type of information about this ICA policy.

logAction

Name of the messagelog action to use for requests that match this policy.

Example

add ica policy <name> -rule <expression> -action <string> [-comment <string>] [-logAction <string>] , where the action is the ica action name

rm ica policy

This command removes an ICA policy

Synopsys

rm ica policy <name>

Arguments

name

Name of the policy to be removed.

Example

rm ica policy ica_policy_1

set ica policy

This command modifies the parameters like rule, action , comment etc for an existing ICA policy.

Synopsys

set ica policy <name> [-rule <expression>] [-action <string>] [-comment <string>] [-logAction <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 ica action to be associated with this policy.

comment

Any type of information about this ICA policy.

logAction

Name of the messagelog action to use for requests that match this policy.

Example

set ica policy ica_policy -rule <rule>

unset ica policy

Use this command to remove ica policy settings.Refer to the set ica policy command for meanings of the arguments.

Synopsys

unset ica policy <name> [-comment] [-logAction]

stat ica policy

Displays statistics for the specified ICA policy. If no policy name is specified, displays abbreviated statistics for all ICA policies currently configured on the NetScaler appliance.

Synopsys

stat ica policy [<name>] [-detail] [-fullValues] [-ntimes <positive_integer>] [-logFile <input_filename>] [-clearstats ( basic | full )]

Arguments

name

Name of the ica policy.

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 hits (Hits)

Number of hits on the policy

Policy undef hits (Undefhits)

Number of undef hits on the policy

Example

stat ica policy

rename ica policy

This command renames an ICA policy.

Synopsys

rename ica 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 (.), s

pace, 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 ica policy" or 'my ica policy').

Example

rename ica policy old_name new_name

show ica policy

This command displays information about all configured ICA policies, or detailed information about the specified policy.

Synopsys

show ica policy [<name>] show ica policy stats - alias for 'stat ica policy'

Arguments

name

Name of the policy about which to display detailed information.

Outputs

stateflag

rule

Expression to be used by ICA policy.

action

ICA profile (action) associated with the policy.

hits

Number of hits.

undefHits

Number of policy UNDEF hits.

activePolicy

Indicates whether policy is bound or not.

comment

Any type of information about this ICA policy.

logAction

Name of the messagelog action to use for requests that match this policy.

gotoPriorityExpression

Expression specifying the priority of the next policy which will get evaluated if the current policy rule evaluates to TRUE.

boundTo

Location where policy is bound.

priority

Specifies the priority of the policy.

bindPolicyType

vserverType

builtin

Indicates that the ICA policy is a built-in (SYSTEM INTERNAL) type.

devno

count

Example

show ica policy