Product Documentation

sc policy

Sep 12, 2016

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

add | rm | set | unset | show | stat

add sc policy

Creates a new SureConnect policy.

Synopsys

add sc policy <name> [-url <URL> | -rule <expression>] [-delay <usecs>] [-maxConn <positive_integer>] [-action <action> (<altContentSvcName> <altContentPath>)]

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.

url

URL against which to match incoming client request.

rule

Expression against which the traffic is evaluated.

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.

delay

Delay threshold, in microseconds, for requests that match the policy's URL or rule. If the delay statistics gathered for the matching request exceed the specified delay, SureConnect is triggered for that request.

Minimum value: 1

Maximum value: 599999999

maxConn

Maximum number of concurrent connections that can be open for requests that match the policy's URL or rule.

Minimum value: 1

Maximum value: 4294967294

action

Action to be taken when the delay or maximum-connections threshold is reached. Available settings function as follows:

ACS - Serve content from an alternative content service.

NS - Serve alternative content from the NetScaler appliance.

NO ACTION - Serve no alternative content. However, delay statistics are still collected for the configured URLs, and, if the Maximum Client Connections parameter is set, the number of connections is limited to the value specified by that parameter. (However, alternative content is not served even if the maxConn threshold is met).

Possible values: ACS, NS, NOACTION

altContentSvcName

Name of the alternative content service to be used in the ACS action.

altContentPath

Path to the alternative content service to be used in the ACS action.

Example

add sc policy scpol_ns -delay 1000000 -url /delay.asp -action NS  add policy expression exp_acs "url == /mc_acs.asp" add service svc_acs 10.110.100.253 http 80 add scpolicy scpol_acs -maxconn 10 -rule exp_acs -action ACS svc_acs /altcont.htm

rm sc policy

Removes the specified SureConnect policy.

Synopsys

rm sc policy <name>

Arguments

name

Name of the policy to be removed.

Example

rm sc policy scpol_ns rm sc policy scpol_acs

set sc policy

Modifies the specified settings of a SureConnect policy.

Synopsys

set sc policy <name> [-url <URL> | -rule <expression>] [-delay <usecs>] [-maxConn <positive_integer>] [-action <action> (<altContentSvcName> <altContentPath>)]

Arguments

name

Name of the policy to be modified.

url

URL against which to match requests. URLs take precedence over rules in SureConnect policies.

rule

Expression against which the traffic is evaluated.

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.

delay

Delay threshold, in microseconds, for requests that match the policy's URL or rule. If the delay statistics gathered for the matching request exceed the specified delay, SureConnect is triggered for that request.

Minimum value: 1

Maximum value: 599999999

maxConn

Maximum number of concurrent connections that can be open for the configured URL or rule.

Minimum value: 1

Maximum value: 4294967294

action

Action to be taken when the delay or maximum-connections threshold is reached. Available settings function as follows:

ACS - Serve content from an alternative content service.

NS - Serve alternative content from the NetScaler appliance.

NO ACTION - Serve no alternative content. However, delay statistics are still collected for the configured URLs, and, if the Maximum Client Connections parameter is set, the number of connections is limited to the value specified by that parameter. (However, alternative content is not served even if the maxConn threshold is met).

Possible values: ACS, NS, NOACTION

altContentSvcName

Name of the alternative content service to be used in the ACS action.

altContentPath

Path to the alternative content service to be used in the ACS action.

Example

set sc policy scpol_ns -delay 2000000 set sc policy scpol_acs -maxconn 100

unset sc policy

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

Synopsys

unset sc policy <name> [-delay] [-maxConn]

show sc policy

Displays information about the SureConnect policies.

Synopsys

show sc policy [<name>]

Arguments

name

Name of a policy about which to display detailed information. To display information about all the SureConnect policies, do not set this parameter.

Outputs

url

The URL name. The system matches the incoming client request against the URL you enter here.

rule

The rule that the system matches with the incoming request.

The system matches the incoming request against the rules you enter here. Before matching against the configured rules, the NetScaler 9000 system matches the requests with any of the configured URLs. Thus, URLs have a higher precedence over rules. If the incoming request does not match any of the configured URLs or the rules that have been configured, then SureConnect does not trigger.

Expression logic is expression names, separated by the logical operators || and && , and possibly grouped using parenthesis. If the expression contains blanks (for example, between an expression name and a logical operator), then the entire argument must be enclosed in double quotes.The following are valid expression logic:

ns_ext_cgi||ns_ext_asp

ns_non_get && (ns_header_cookie||ns_header_pragma)

delay

Delay threshold, in microseconds, for requests that match the policy's URL or rule. If the delay statistics gathered for the matching request exceed the specified delay, SureConnect is triggered for that request.

maxConn

Maximum number of concurrent connections that can be open for requests that match the policy's URL or rule.

action

The action to be taken when the thresholds are met. The valid options are ACS , NS and NOACTION .

ACS - Specifies that alternate content is to be served from altContSvcName with the path altContPath .

NS - Specifies that alternate content is to be served from the NetScaler 9000 system. See the set sc parameter command to customize the response served from the system.

NOACTION - Specifies that no alternate content is to be served. However, delay statistics are still collected for the configured URLs. If the - maxconn argument is specified, the number of connections is limited to that specified value for that configured URL or rule (alternate content will not served even if the - maxconn threshold is met).

altContentSvcName

Name of the alternative content service to be used in the ACS action.

altContentPath

Path to the alternative content service to be used in the ACS action.

devno

count

stateflag

Example

> show sc policy         2 monitored Sure Connect Policies: 1)      Name: scpol_ns         RULE: exp1         Delay: 1000000 microsecs         Alternate Content from NS 2)      Name: scpol_acs         RULE: exp_acs         Max Conn: 10         Alternate Content from ACS, svc_acs        /delay/alcont.htm  Done 

stat sc policy

Displays statistics about SureConnect policies.

Synopsys

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

Arguments

name

Name of the policy about which to display statistics. To display statistics about all SureConnect policies, do not set this parameter.

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

Server TTLB (SvrTTLB)

Server Time-To-Last-Byte in seconds calculated for this SureConnect policy.

Average server TTLB

Average server transaction time in seconds for this SureConnect Policy.

Average client TTLB (AvClTTLB)

Average value of the client Time-To-Last-Byte in seconds for this SureConnect policy.

Physical service IP (SvcIP)

IP address of the service in dotted notation for which these statistics are maintained.

Physical service port (SvcPort)

Port of the service for which these statistics are maintained.

Current client connections (CurClts)

Number of clients currently allowed a server connection by this SureConnect policy.

Current SC queue length (WaitClts)

Current number of SureConnect priority clients that are waiting for a server connection.

Current server connections (CurSvrs)

Current number of open connections to the servers matching this policy.

Estimated waiting time (Sec) (WaitTime)

Value of the currently estimated waiting time in seconds for the configured URL.

Client TCP connections (TotClt)

Total number of clients that were allowed a server connection by this SureConnect policy.

Server TCP connections (TotSvr)

Total number of server connections that were established through this SureConnect policy.

Client HTTP transactions

Total number of client transactions processed by this SureConnect policy.

Server HTTP transactions (SrvTrans)

Number of 200 OK responses received from the web server by this SureConnect policy.

Requests received (TotReq)

Total number of requests received by this SureConnect policy.

Request bytes received (ReqBytes)

Total number of request bytes received by this SureConnect policy.

Server responses received (TotResp)

Total number of server responses received by this SureConnect policy.

Response bytes received (RspBytes)

Total number of response bytes received by this SureConnect policy.

Related Commands