Download full document:

cspolicy

Configuration for content-switching policy resource.

Properties

(click to see Operations)

NameData TypePermissionsDescription
policyname<String>Read-writeName for the content switching policy. Must begin with an ASCII alphanumeric or underscore (_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at sign (@), equal sign (=), and hyphen (-) characters. Cannot be changed after a policy is created.
The following requirement applies only to the Citrix ADC CLI:
If the name includes one or more spaces, enclose the name in double or single quotation marks (for example, "my policy" or 'my policy').
Minimum length = 1
url<String>Read-writeURL string that is matched with the URL of a request. Can contain a wildcard character. Specify the string value in the following format: [[prefix] [*]] [.suffix].
Minimum length = 1
Maximum length = 208
rule<String>Read-writeExpression, or name of a named expression, against which traffic is evaluated. Written in the classic or default syntax.
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 Citrix ADC 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.
domain<String>Read-writeThe domain name. The string value can range to 63 characters.
Minimum length = 1
action<String>Read-writeContent switching action that names the target load balancing virtual server to which the traffic is switched.
logaction<String>Read-writeThe log action associated with the content switching policy.
newname<String>Read-writeThe new name of the content switching policy.
Minimum length = 1
vstype<Double>Read-onlyVirtual server type.
hits<Double>Read-onlyTotal number of hits.
bindhits<Double>Read-onlyTotal number of hits.
labelname<String>Read-onlyName of the label invoked.
labeltype<String>Read-onlyThe invocation type.
Possible values = reqvserver, resvserver, policylabel
priority<Double>Read-onlypriority of bound policy.
activepolicy<Boolean>Read-onlyIndicates whether policy is bound or not.
cspolicytype<String>Read-onlyIndicates whether policy is PI or not.(used only during display).
Possible values = Classic Policy, Advanced Policy
__count<Double>Read-onlycount parameter

Operations

(click to see Properties)

ADD| DELETE| UPDATE| UNSET| RENAME| GET (ALL)| GET| COUNT

Some options that you can use for each operations:

  • Getting warnings in response:NITRO allows you to get warnings in an operation by specifying the "warning" query parameter as "yes". For example, to get warnings while connecting to the NetScaler appliance, the URL is as follows:

    http://<netscaler-ip-address>/nitro/v1/config/login?warning=yes

    If any, the warnings are displayed in the response payload with the HTTP code "209 X-NITRO-WARNING".

  • Authenticated access for individual NITRO operations:NITRO allows you to logon to the NetScaler appliance to perform individual operations. You can use this option instead of creating a NITRO session (using the login object) and then using that session to perform all operations,

    To do this, you must specify the username and password in the request header of the NITRO request as follows:

    X-NITRO-USER:<username>

    X-NITRO-PASS:<password>

    Note:In such cases, make sure that the request header DOES not include the following:

    Cookie:NITRO_AUTH_TOKEN=<tokenvalue>

Note:

Mandatory parameters are marked in redand placeholder content is marked in <green>.

add

URL:http://<netscaler-ip-address>/nitro/v1/config/cspolicy

HTTP Method:POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Content-Type:application/json

Request Payload:

{"cspolicy":{
<b>"policyname":<String_value>,
</b>"url":<String_value>,
"rule":<String_value>,
"domain":<String_value>,
"action":<String_value>,
"logaction":<String_value>
}}

Response:

HTTP Status Code on Success: 201 Created HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

delete

URL:http://<netscaler-ip-address>/nitro/v1/config/cspolicy/policyname_value<String>

HTTP Method:DELETE

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue>

Response:

HTTP Status Code on Success: 200 OK HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

update

URL:http://<netscaler-ip-address>/nitro/v1/config/cspolicy

HTTP Method:PUT

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Content-Type:application/json

Request Payload:

{"cspolicy":{
<b>"policyname":<String_value>,
</b>"url":<String_value>,
"rule":<String_value>,
"domain":<String_value>,
"action":<String_value>,
"logaction":<String_value>
}}

Response:

HTTP Status Code on Success: 200 OK HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

unset

URL:http://<netscaler-ip-address>/nitro/v1/config/cspolicy?action=unset

HTTP Method:POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Content-Type:application/json

Request Payload:

{"cspolicy":{
<b>"policyname":<String_value>,
</b>"logaction":true,
"url":true,
"rule":true,
"domain":true,
"action":true
}}

Response:

HTTP Status Code on Success: 200 OK HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

rename

URL:http://<netscaler-ip-address>/nitro/v1/config/cspolicy?action=rename

HTTP Method:POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Content-Type:application/json

Request Payload:

{"cspolicy":{
<b>"policyname":<String_value>,
</b><b>"newname":<String_value>
</b>}}

Response:

HTTP Status Code on Success: 200 OK HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

get (all)

URL:http://<netscaler-ip-address>/nitro/v1/config/cspolicy

Query-parameters:

attrs

http://<netscaler-ip-address>/nitro/v1/config/cspolicy?attrs=property-name1,property-name2

Use this query parameter to specify the resource details that you want to retrieve.

filter

http://<netscaler-ip-address>/nitro/v1/config/cspolicy?filter=property-name1:property-val1,property-name2:property-val2

Use this query-parameter to get the filtered set of cspolicy resources configured on NetScaler.Filtering can be done on any of the properties of the resource.

view

http://<netscaler-ip-address>/nitro/v1/config/cspolicy?view=summary

Note:By default, the retrieved results are displayed in detail view (?view=detail).

pagination

http://<netscaler-ip-address>/nitro/v1/config/cspolicy?pagesize=#no;pageno=#no

Use this query-parameter to get the cspolicy resources in chunks.

HTTP Method:GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Accept:application/json

Response:

HTTP Status Code on Success: 200 OK HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the errorResponse Headers:

Content-Type:application/json

Response Payload:

{ "cspolicy": [ {
"policyname":<String_value>,
"url":<String_value>,
"rule":<String_value>,
"domain":<String_value>,
"action":<String_value>,
"vstype":<Double_value>,
"hits":<Double_value>,
"bindhits":<Double_value>,
"labelname":<String_value>,
"labeltype":<String_value>,
"target":<String_value>,
"priority":<Double_value>,
"activepolicy":<Boolean_value>,
"cspolicytype":<String_value>,
"logaction":<String_value>
}]}

get

URL:http://<netscaler-ip-address>/nitro/v1/config/cspolicy/policyname_value<String>

Query-parameters:

attrs

http://<netscaler-ip-address>/nitro/v1/config/cspolicy/policyname_value<String>?attrs=property-name1,property-name2

Use this query parameter to specify the resource details that you want to retrieve.

view

http://<netscaler-ip-address>/nitro/v1/config/cspolicy/policyname_value<String>?view=summary

Note:By default, the retrieved results are displayed in detail view (?view=detail).

HTTP Method:GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Accept:application/json

Response:

HTTP Status Code on Success: 200 OK HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the errorResponse Headers:

Content-Type:application/json

Response Payload:

{ "cspolicy": [ {
"policyname":<String_value>,
"url":<String_value>,
"rule":<String_value>,
"domain":<String_value>,
"action":<String_value>,
"vstype":<Double_value>,
"hits":<Double_value>,
"bindhits":<Double_value>,
"labelname":<String_value>,
"labeltype":<String_value>,
"target":<String_value>,
"priority":<Double_value>,
"activepolicy":<Boolean_value>,
"cspolicytype":<String_value>,
"logaction":<String_value>
}]}

count

URL:http://<netscaler-ip-address>/nitro/v1/config/cspolicy?count=yes

HTTP Method:GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Accept:application/json

Response:

HTTP Status Code on Success: 200 OK HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the errorResponse Headers:

Content-Type:application/json

Response Payload:

{ "cspolicy": [ { "__count": "#no"} ] }