Product Documentation

craction

Sep 05, 2016

Configuration for cache redirection action resource.

Properties (click to see Operations)

Name Data Type Permissions Description
name
<String>
Read-write
Name of the action for which to display detailed information.
Minimum length = 1
crtype
<String>
Read-only
Type to decide where to redirect the requests if the cache redirection policy is hit.
The valid options are as follows:
*CACHE - Directs all the requests to the cache if cache redirection policy is hit.
*ORIGIN - Directs all requests to the origin server if the cache redirection policy is hit.
Possible values = origin, cache
builtin
<String[]>
Read-only
Flag to determine whether CRACTION is default or not.
Possible values = MODIFIABLE, DELETABLE, IMMUTABLE, PARTITION_ALL
isdefault
<Boolean>
Read-only
A value of true is returned if it is a default cr action.
hits
<Double>
Read-only
The number of times the action has been taken.
referencecount
<String>
Read-only
The number of references to the action.
undefhits
<Double>
Read-only
The number of times the action resulted in UNDEF.
comment
<String>
Read-only
Comment. Any type of information about this responder action.
__count
<Double>
Read-only
count parameter

Operations (click to see Properties)

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>

메모

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

get (all)

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

Query-parameters:

attrs

http://<netscaler-ip-address>/nitro/v1/config/craction?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/craction?filter=property-name1:property-val1,property-name2:property-val2

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

view

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

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

pagination

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

Use this query-parameter to get the craction 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 error

Response Headers:

Content-Type:application/json

Response Payload:

{ "craction": [ {
      "name":<String_value>,
      "crtype":<String_value>,
      "builtin":<String[]_value>,
      "isdefault":<Boolean_value>,
      "hits":<Double_value>,
      "referencecount":<String_value>,
      "undefhits":<Double_value>,
      "comment":<String_value>
}]}

get

URL: http://<netscaler-ip-address>/nitro/v1/config/craction/name_value<String>

Query-parameters:

attrs

http://<netscaler-ip-address>/nitro/v1/config/craction/name_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/craction/name_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 error

Response Headers:

Content-Type:application/json

Response Payload:

{ "craction": [ {
      "name":<String_value>,
      "crtype":<String_value>,
      "builtin":<String[]_value>,
      "isdefault":<Boolean_value>,
      "hits":<Double_value>,
      "referencecount":<String_value>,
      "undefhits":<Double_value>,
      "comment":<String_value>
}]}

count

URL: http://<netscaler-ip-address>/nitro/v1/config/craction?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 error

Response Headers:

Content-Type:application/json

Response Payload:

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