Product Documentation

tmtrafficaction

Sep 08, 2016

Configuration for TM traffic action resource.

Properties (click to see Operations)

Name Data Type Permissions Description
name
<String>
Read-write
Name for the traffic action. Must begin with an ASCII alphanumeric or underscore (_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at (@), equals (=), and hyphen (-) characters. Cannot be changed after a traffic 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').
Minimum length = 1
apptimeout
<Double>
Read-write
Time interval, in minutes, of user inactivity after which the connection is closed.
Minimum value = 1
Maximum value = 715827
sso
<String>
Read-write
Use single sign-on for the resource that the user is accessing now.
Possible values = ON, OFF
formssoaction
<String>
Read-write
Name of the configured form-based single sign-on profile.
persistentcookie
<String>
Read-write
Use persistent cookies for the traffic session. A persistent cookie remains on the user device and is sent with each HTTP request. The cookie becomes stale if the session ends.
Possible values = ON, OFF
initiatelogout
<String>
Read-write
Initiate logout for the traffic management (TM) session if the policy evaluates to true. The session is then terminated after two minutes.
Possible values = ON, OFF
kcdaccount
<String>
Read-write
Kerberos constrained delegation account name.
Default value: "None"
Minimum length = 1
Maximum length = 32
samlssoprofile
<String>
Read-write
Profile to be used for doing SAML SSO to remote relying party.
Minimum length = 1
forcedtimeout
<String>
Read-write
Setting to start, stop or reset TM session force timer.
Possible values = START, STOP, RESET
forcedtimeoutval
<Double>
Read-write
Time interval, in minutes, for which force timer should be set.
userexpression
<String>
Read-write
expression that will be evaluated to obtain username for SingleSignOn.
Maximum length = 256
passwdexpression
<String>
Read-write
expression that will be evaluated to obtain password for SingleSignOn.
Maximum length = 256
__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/tmtrafficaction

HTTP Method: POST

Request Headers:

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

Request Payload:

{"tmtrafficaction":{
      "name":<String_value>,
      "apptimeout":<Double_value>,
      "sso":<String_value>,
      "formssoaction":<String_value>,
      "persistentcookie":<String_value>,
      "initiatelogout":<String_value>,
      "kcdaccount":<String_value>,
      "samlssoprofile":<String_value>,
      "forcedtimeout":<String_value>,
      "forcedtimeoutval":<Double_value>,
      "userexpression":<String_value>,
      "passwdexpression":<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/tmtrafficaction/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/tmtrafficaction

HTTP Method: PUT

Request Headers:

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

Request Payload:

{"tmtrafficaction":{
      "name":<String_value>,
      "apptimeout":<Double_value>,
      "sso":<String_value>,
      "formssoaction":<String_value>,
      "persistentcookie":<String_value>,
      "initiatelogout":<String_value>,
      "kcdaccount":<String_value>,
      "samlssoprofile":<String_value>,
      "forcedtimeout":<String_value>,
      "forcedtimeoutval":<Double_value>,
      "userexpression":<String_value>,
      "passwdexpression":<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/tmtrafficaction?action=unset

HTTP Method: POST

Request Headers:

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

Request Payload:

{"tmtrafficaction":{
      "name":<String_value>,
      "persistentcookie":true,
      "kcdaccount":true,
      "forcedtimeout":true,
      "userexpression":true,
      "passwdexpression":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

get (all)

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

Query-parameters:

attrs

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

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

view

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

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

pagination

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

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

{ "tmtrafficaction": [ {
      "name":<String_value>,
      "apptimeout":<Double_value>,
      "sso":<String_value>,
      "formssoaction":<String_value>,
      "persistentcookie":<String_value>,
      "initiatelogout":<String_value>,
      "kcdaccount":<String_value>,
      "samlssoprofile":<String_value>,
      "forcedtimeout":<String_value>,
      "forcedtimeoutval":<Double_value>,
      "userexpression":<String_value>,
      "passwdexpression":<String_value>
}]}

get

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

Query-parameters:

attrs

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

{ "tmtrafficaction": [ {
      "name":<String_value>,
      "apptimeout":<Double_value>,
      "sso":<String_value>,
      "formssoaction":<String_value>,
      "persistentcookie":<String_value>,
      "initiatelogout":<String_value>,
      "kcdaccount":<String_value>,
      "samlssoprofile":<String_value>,
      "forcedtimeout":<String_value>,
      "forcedtimeoutval":<Double_value>,
      "userexpression":<String_value>,
      "passwdexpression":<String_value>
}]}

count

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

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