Skip to content

mpssession

Configuration for Client Session resource.

(click to see Operations)

Properties

(click to see Operations)

NameData TypePermissionsDescription
tenant_name<String>Read-writeTenant Name.
permission<String>Read-writePermission to identify who created the session.
is_external_auth<Boolean>Read-writeIs session created by using external authentication.
id<String>Read-writeId is system generated key for all the client sessions.
expire_after<Integer>Read-onlySession will expire after these many seconds.
login_time<Integer>Read-onlySession was initiated at this time.
session_timeout<Integer>Read-onlySession Timeout set for this session.
port<Integer>Read-onlyPort from where this session was initiated.
username<String>Read-onlyUser Name who initiated this session.
client_type<String>Read-onlyClient Type.
last_activity_time<Integer>Read-onlyLast Activity Time for this session.
ip_address<String>Read-onlyIP Aaddress from where this session was initiated.
is_self<Boolean>Read-onlytrue, if this session is for current logged-in user.

Operations

(click to see Properties)

GET (ALL)| GET| DELETE

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>.

get (all)

URL: https://<MGMT-IP>/nitro/v1/config/mpssession

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "mpssession":[{
"tenant_name":<String_value>,
"expire_after":<Integer_value>,
"login_time":<Integer_value>,
"permission":<String_value>,
"session_timeout":<Integer_value>,
"port":<Integer_value>,
"username":<String_value>,
"client_type":<String_value>,
"last_activity_time":<Integer_value>,
"session_creator":<String_value>,
"is_external_auth":<Boolean_value>,
"id":<String_value>,
"ip_address":<String_value>,
"token":<String_value>,
"sessionid":<String_value>,
"is_self":<Boolean_value>}]}

get

URL: https://<MGMT-IP>/nitro/v1/config/mpssession/id_value<String>

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "mpssession":[{
"tenant_name":<String_value>,
"expire_after":<Integer_value>,
"login_time":<Integer_value>,
"permission":<String_value>,
"session_timeout":<Integer_value>,
"port":<Integer_value>,
"username":<String_value>,
"client_type":<String_value>,
"last_activity_time":<Integer_value>,
"session_creator":<String_value>,
"is_external_auth":<Boolean_value>,
"id":<String_value>,
"ip_address":<String_value>,
"token":<String_value>,
"sessionid":<String_value>,
"is_self":<Boolean_value>}]}

delete

URL: https://<MGMT-IP>/nitro/v1/config/mpssession/id_value<String>

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value> }