tmsessionaction
Configuration for TM session action resource.
Properties
(click to see Operations)
| Name | Data Type | Permissions | Description |
|---|---|---|---|
| name | <String> | Read-write | Name for the session 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 session 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).<br>Minimum length = 1 |
| sesstimeout | <Double> | Read-write | Session timeout, in minutes. If there is no traffic during the timeout period, the user is disconnected and must reauthenticate to access intranet resources.<br>Minimum value = 1 |
| defaultauthorizationaction | <String> | Read-write | Allow or deny access to content for which there is no specific authorization policy.<br>Possible values = ALLOW, DENY |
| sso | <String> | Read-write | Use single sign-on (SSO) to log users on to all web applications automatically after they authenticate, or pass users to the web application logon page to authenticate to each application individually.<br>Default value: OFF<br>Possible values = ON, OFF |
| ssocredential | <String> | Read-write | Use the primary or secondary authentication credentials for single sign-on (SSO).<br>Possible values = PRIMARY, SECONDARY |
| ssodomain | <String> | Read-write | Domain to use for single sign-on (SSO).<br>Minimum length = 1<br>Maximum length = 32 |
| httponlycookie | <String> | Read-write | Allow only an HTTP session cookie, in which case the cookie cannot be accessed by scripts.<br>Possible values = YES, NO |
| kcdaccount | <String> | Read-write | Kerberos constrained delegation account name.<br>Minimum length = 1<br>Maximum length = 32 |
| persistentcookie | <String> | Read-write | Enable or disable persistent SSO cookies for the traffic management (TM) session. A persistent cookie remains on the user device and is sent with each HTTP request. The cookie becomes stale if the session ends. This setting is overwritten if a traffic action sets persistent cookie to OFF. Note: If persistent cookie is enabled, make sure you set the persistent cookie validity.<br>Possible values = ON, OFF |
| persistentcookievalidity | <Double> | Read-write | Integer specifying the number of minutes for which the persistent cookie remains valid. Can be set only if the persistent cookie setting is enabled.<br>Minimum value = 1 |
| homepage | <String> | Read-write | Web address of the home page that a user is displayed when authentication vserver is bookmarked and used to login. |
| builtin | <String[]> | Read-only | Indicates that a variable is a built-in (SYSTEM INTERNAL) type.<br>Possible values = MODIFIABLE, DELETABLE, IMMUTABLE, PARTITION_ALL |
| __count | <Double> | Read-only | count parameter |
Operations
(click to see Properties)
ADD | DELETE | UPDATE | UNSET | 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 red and placeholder content is marked in <green>.
add
URL: http://<NSIP>/nitro/v1/config/
HTTP Method: POST
Request Payload:
object={
"params":{
"warning":<String_value>,
"onerror":<String_value>
},
"sessionid":"##sessionid",
"tmsessionaction":{
"name":<String_value>,
"sesstimeout":<Double_value>,
"defaultauthorizationaction":<String_value>,
"sso":<String_value>,
"ssocredential":<String_value>,
"ssodomain":<String_value>,
"httponlycookie":<String_value>,
"kcdaccount":<String_value>,
"persistentcookie":<String_value>,
"persistentcookievalidity":<Double_value>,
"homepage":<String_value>,
}}
Response Payload:
{ "errorcode": 0, "message": "Done", "severity":
delete
URL: http://<NSIP>/nitro/v1/config/tmsessionaction/name_value<String>
Query-parameters:
warning
http://<NS_IP>/nitro/v1/config/tmsessionaction/name_value<String>?warning=yes
Use this query parameter to get warnings in nitro response. If this field is set to YES, warning message will be sent in 'message' field and 'WARNING' value is set in severity field of the response in case there is a
HTTP Method: DELETE
Response Payload:
{ "errorcode": 0, "message": "Done", "severity":
update
URL: http://<NSIP>/nitro/v1/config/
HTTP Method: PUT
Request Payload:
{
"params": {
"warning":<String_value>,
"onerror":<String_value>"
},
sessionid":"##sessionid",
"tmsessionaction":{
"name":<String_value>,
"sesstimeout":<Double_value>,
"defaultauthorizationaction":<String_value>,
"sso":<String_value>,
"ssocredential":<String_value>,
"ssodomain":<String_value>,
"kcdaccount":<String_value>,
"httponlycookie":<String_value>,
"persistentcookie":<String_value>,
"persistentcookievalidity":<Double_value>,
"homepage":<String_value>,
}}
Response Payload:
{ "errorcode": 0, "message": "Done", "severity":
unset
URL: http://<NSIP>/nitro/v1/config/
HTTP Method: POST
Request Payload:
object={
"params":{
"warning":<String_value>,
"onerror":<String_value>,
"action":"unset"
},
"sessionid":"##sessionid",
"tmsessionaction":{
"name":<String_value>,
"sesstimeout":true,
"defaultauthorizationaction":true,
"sso":true,
"ssocredential":true,
"ssodomain":true,
"kcdaccount":true,
"httponlycookie":true,
"persistentcookie":true,
"persistentcookievalidity":true,
"homepage":true,
}}
Response Payload:
{ "errorcode": 0, "message": "Done", "severity":
get (all)
URL: http://<NSIP>/nitro/v1/config/tmsessionaction
Query-parameters:
filter
http://<NSIP>/nitro/v1/config/tmsessionaction?filter=property-name1:property-val1,property-name2:property-val2
Use this query-parameter to get the filtered set of tmsessionaction resources configured on NetScaler.Filtering can be done on any of the properties of the resource.
view
http://<NS_IP>/nitro/v1/config/tmsessionaction?view=summary
Use this query-parameter to get the summary output of tmsessionaction resources configured on NetScaler.
pagesize=#no;pageno=#no
http://<NS_IP>/nitro/v1/config/tmsessionaction?pagesize=#no;pageno=#no
Use this query-parameter to get the tmsessionaction resources in chunks.
warning
http://<NS_IP>/nitro/v1/config/tmsessionaction?warning=yes
Use this query parameter to get warnings in nitro response. If this field is set to YES, warning message will be sent in 'message' field and 'WARNING' value is set in severity field of the response in case there is a
HTTP Method: GET
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": <String_value>, "tmsessionaction": [ {
"name":<String_value>,
"sesstimeout":<Double_value>,
"defaultauthorizationaction":<String_value>,
"sso":<String_value>,
"ssocredential":<String_value>,
"ssodomain":<String_value>,
"kcdaccount":<String_value>,
"httponlycookie":<String_value>,
"persistentcookie":<String_value>,
"persistentcookievalidity":<Double_value>,
"homepage":<String_value>,
"builtin":<String[]_value>
}]}
get
URL: http://<NS_IP>/nitro/v1/config/tmsessionaction/name_value<String>
HTTP Method: GET
Response Payload:
{ "errorcode": 0, "message": "Done", "tmsessionaction": [ {
"name":<String_value>,
"sesstimeout":<Double_value>,
"defaultauthorizationaction":<String_value>,
"sso":<String_value>,
"ssocredential":<String_value>,
"ssodomain":<String_value>,
"kcdaccount":<String_value>,
"httponlycookie":<String_value>,
"persistentcookie":<String_value>,
"persistentcookievalidity":<Double_value>,
"homepage":<String_value>,
"builtin":<String[]_value>
}]}
count
URL: http://<NS_IP>/nitro/v1/config/tmsessionaction?count=yes
HTTP Method: GET
Response Payload:
{ "errorcode": 0, "message": "Done",tmsessionaction: [ { "__count": "#no"} ] }