Product Documentation

csaction

Sep 05, 2016

Configuration for Content Switching action resource.

Properties (click to see Operations)

Name Data Type Permissions Description
name
<String>
Read-write
Name for the content switching action. 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. Can be changed after the content switching action is created.
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 action? or ?my action?).
targetlbvserver
<String>
Read-write
Name of the load balancing virtual server to which the content is switched.
targetvserver
<String>
Read-write
Name of the VPN virtual server to which the content is switched.
targetvserverexpr
<String>
Read-write
Information about this content switching action.
comment
<String>
Read-write
Comments associated with this cs action.
newname
<String>
Read-write
New name for the content switching action. 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.
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 name or my name).
Minimum length = 1
hits
<Double>
Read-only
The number of times the action has been taken.
referencecount
<Double>
Read-only
The number of references to the action.
undefhits
<Double>
Read-only
The number of times the action resulted in UNDEF.
builtin
<String[]>
Read-only
.
Possible values = MODIFIABLE, DELETABLE, IMMUTABLE, PARTITION_ALL
__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>.

add

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

HTTP Method: POST

Request Headers:

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

Request Payload:

{"csaction":{
      "name":<String_value>,
      "targetlbvserver":<String_value>,
      "targetvserver":<String_value>,
      "targetvserverexpr":<String_value>,
      "comment":<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/csaction/name_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/csaction

HTTP Method: PUT

Request Headers:

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

Request Payload:

{"csaction":{
      "name":<String_value>,
      "targetlbvserver":<String_value>,
      "targetvserver":<String_value>,
      "targetvserverexpr":<String_value>,
      "comment":<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/csaction?action=unset

HTTP Method: POST

Request Headers:

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

Request Payload:

{"csaction":{
      "name":<String_value>,
      "comment":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/csaction?action=rename

HTTP Method: POST

Request Headers:

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

Request Payload:

{"csaction":{
      "name":<String_value>,
      "newname":<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

get (all)

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

Query-parameters:

attrs

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

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

view

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

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

pagination

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

Use this query-parameter to get the csaction 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:

{ "csaction": [ {
      "name":<String_value>,
      "targetlbvserver":<String_value>,
      "targetvserver":<String_value>,
      "targetvserverexpr":<String_value>,
      "hits":<Double_value>,
      "referencecount":<Double_value>,
      "undefhits":<Double_value>,
      "builtin":<String[]_value>,
      "comment":<String_value>
}]}

get

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

Query-parameters:

attrs

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

{ "csaction": [ {
      "name":<String_value>,
      "targetlbvserver":<String_value>,
      "targetvserver":<String_value>,
      "targetvserverexpr":<String_value>,
      "hits":<Double_value>,
      "referencecount":<Double_value>,
      "undefhits":<Double_value>,
      "builtin":<String[]_value>,
      "comment":<String_value>
}]}

count

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

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