31 lines
11 KiB
HTML
31 lines
11 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
|
|
<link href="../../../rdx/css/rdx.css" rel="stylesheet" type="text/css" />
|
|
<link href="../../../index.css" rel="stylesheet" type="text/css" />
|
|
<title>mpssession</title>
|
|
</head>
|
|
<body class="ns_body">
|
|
<p class="ns_wp_header">mpssession</p>
|
|
<P>Configuration for Client Session resource.</P>
|
|
<p class="heading">Read/write properties</p>
|
|
<p class="property_name">id<span class="property_type"><String></span></p><p class="property_description">Id is system generated key for all the client sessions.</p>
|
|
<p class="property_name">is_external_auth<span class="property_type"><Boolean></span></p><p class="property_description">Is session created by using external authentication.</p>
|
|
<p class="heading">Read only properties</p>
|
|
<p class="property_name">permission<span class="property_type"><String></span></p><p class="property_description">Permission to identify who created the session.</p>
|
|
<p class="property_name">last_activity_time<span class="property_type"><Integer></span></p><p class="property_description">Last Activity Time for this session.</p>
|
|
<p class="property_name">username<span class="property_type"><String></span></p><p class="property_description">User Name who initiated this session.</p>
|
|
<p class="property_name">ip_address<span class="property_type"><String></span></p><p class="property_description">IP Aaddress from where this session was initiated.</p>
|
|
<p class="property_name">client_type<span class="property_type"><String></span></p><p class="property_description">Client Type.</p>
|
|
<p class="property_name">expire_after<span class="property_type"><Integer></span></p><p class="property_description">Session will expire after these many seconds.</p>
|
|
<p class="property_name">login_time<span class="property_type"><Integer></span></p><p class="property_description">Session was initiated at this time.</p>
|
|
<p class="property_name">tenant_name<span class="property_type"><String></span></p><p class="property_description">Tenant Name.</p>
|
|
<p class="property_name">port<span class="property_type"><Integer></span></p><p class="property_description">Port from where this session was initiated.</p>
|
|
<p class="property_name">session_timeout<span class="property_type"><Integer></span></p><p class="property_description">Session Timeout set for this session.</p>
|
|
<p class="property_name">is_self<span class="property_type"><Boolean></span></p><p class="property_description">true, if this session is for current logged-in user.</p>
|
|
<p class="heading">Operations</p><p class="property_name">NOTE: In request payload, Mandatory parameters are marked red and bold.<br /><br />The following parameters can be used in the nitro request :</p>
|
|
<p class="property_name">onerror<span class=\"property_type\"> <String_value></span></p><p class="property_description"> Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.<br />Default value: EXIT<br />Possible values = EXIT, CONTINUE</p><a href="#get_all" class="operation">get (all)</a><a href="#get" class="operation">get</a><a href="#delete" class="operation">delete</a><p class="heading"><a name="get_all">get (all)</a></p><p class="key">URL:<span class="url_value">https://<MGMT-IP>/nitro/v2/config/mpssession</span></p><p class="key">Query-parameters:<span class="url_value"></span></p><p class="key"><b>filter</b></p><p class="key"><span class="value">https://<MGMT-IP>/nitro/v2/config/mpssession<b>?filter=property-name1:property-value1,property-name2:property-value2</b></span></p><p class="key"><span class="value">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.</span></p><p class="key"><b>pagesize=#no&pageno=#no</b></p><p class="key"><span class="value">https://<MGMT-IP>/nitro/v2/config/mpssession<b>?pagesize=#no&pageno=#no</b></span></p><p class="key"><span class="value">Use this query-parameter to get the mpssession resources in chunks.</span></p><p class="key"><b>count</b></p><p class="key"><span class="value">https://<MGMT-IP>/nitro/v2/config/mpssession<b>?count=yes</b></span></p><p class="key"><span class="value">Use this query-parameter to get the count of mpssession resources.</span></p><p class="key">HTTPS Method:<span class="value">GET</span></p><p class="key">Request Headers:</p><p class="key"><span class="value">Accept:<span class="value">application/json</span></span></p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value<String></span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value<String></span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value<String></span></span></p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": <String_value>, "mpssession":[{<br> "permission":<String_value></font>,<br> "last_activity_time":<Integer_value></font>,<br> "username":<String_value></font>,<br> "ip_address":<String_value></font>,<br> "id":<String_value></font>,<br> "client_type":<String_value></font>,<br> "expire_after":<Integer_value></font>,<br> "login_time":<Integer_value></font>,<br> "token":<String_value></font>,<br> "sessionid":<String_value></font>,<br> "is_external_auth":<Boolean_value></font>,<br> "tenant_name":<String_value></font>,<br> "port":<Integer_value></font>,<br> "session_timeout":<Integer_value></font>,<br> "session_creator":<String_value></font>,<br> "is_self":<Boolean_value></font>}]}</p><p class="heading"><a name="get">get</a></p><p class="key">URL:<span class="url_value">https://<MGMT-IP>/nitro/v2/config/mpssession/id_value<String></span></p><p class="key">HTTPS Method:<span class="value">GET</span></p><p class="key">Request Headers:</p><p class="key"><span class="value">Accept:<span class="value">application/json</span></span></p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value<String></span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value<String></span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value<String></span></span></p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": <String_value>, "mpssession":[{<br> "permission":<String_value></font>,<br> "last_activity_time":<Integer_value></font>,<br> "username":<String_value></font>,<br> "ip_address":<String_value></font>,<br> "id":<String_value></font>,<br> "client_type":<String_value></font>,<br> "expire_after":<Integer_value></font>,<br> "login_time":<Integer_value></font>,<br> "token":<String_value></font>,<br> "sessionid":<String_value></font>,<br> "is_external_auth":<Boolean_value></font>,<br> "tenant_name":<String_value></font>,<br> "port":<Integer_value></font>,<br> "session_timeout":<Integer_value></font>,<br> "session_creator":<String_value></font>,<br> "is_self":<Boolean_value></font>}]}</p><p class="heading"><a name="delete">delete</a></p><p class="key">URL:<span class="url_value">https://<MGMT-IP>/nitro/v2/config/mpssession/id_value<String></span></p><p class="key">HTTPS Method:<span class="value">DELETE</span></p><p class="key">Request Headers:</p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value<String></span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value<String></span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value<String></span></span></p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": <String_value> }</p>
|
|
</body>
|
|
</html>
|