mpssession

Configuration for Client Session resource.

Read/write properties

id<String>

Id is system generated key for all the client sessions.

is_external_auth<Boolean>

Is session created by using external authentication.

Read only properties

permission<String>

Permission to identify who created the session.

last_activity_time<Integer>

Last Activity Time for this session.

username<String>

User Name who initiated this session.

ip_address<String>

IP Aaddress from where this session was initiated.

client_type<String>

Client Type.

expire_after<Integer>

Session will expire after these many seconds.

login_time<Integer>

Session was initiated at this time.

tenant_name<String>

Tenant Name.

port<Integer>

Port from where this session was initiated.

session_timeout<Integer>

Session Timeout set for this session.

is_self<Boolean>

true, if this session is for current logged-in user.

Operations

NOTE: In request payload, Mandatory parameters are marked red and bold.

The following parameters can be used in the nitro request :

onerror   <String_value>

Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.
Default value: EXIT
Possible values = EXIT, CONTINUE

get (all)

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

Query-parameters:

filter

https://<MGMT-IP>/nitro/v2/config/mpssession?filter=property-name1:property-value1,property-name2:property-value2

Use this query-parameter to get the filtered set of mpssession resources configured on the system. You can set a filter on any property of the resource.

pagesize=#no&pageno=#no

https://<MGMT-IP>/nitro/v2/config/mpssession?pagesize=#no&pageno=#no

Use this query-parameter to get the mpssession resources in chunks.

count

https://<MGMT-IP>/nitro/v2/config/mpssession?count=yes

Use this query-parameter to get the count of mpssession resources.

HTTPS Method:GET

Request Headers:

Accept:application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Response:

HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Headers:

Content-Type:application/json

Response Payload:JSON

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

get

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

HTTPS Method:GET

Request Headers:

Accept:application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Response:

HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Headers:

Content-Type:application/json

Response Payload:JSON

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

delete

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

HTTPS Method:DELETE

Request Headers:

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Response:

HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Payload:JSON

{ "errorcode": 0, "message": "Done", "severity": <String_value> }