lbpersistentsessions¶

Configuration for persistence session resource.

Properties¶

(click to see Operations )

Name	Data Type	Permissions	Description
vserver	<String>	Read-write	The name of the virtual server.
nodeid	<Double>	Read-write	Unique number that identifies the cluster node. Minimum value = 0 Maximum value = 31
persistenceparameter	<String>	Read-write	The persistence parameter whose persistence sessions are to be flushed.
type	<Double>	Read-only	Type of Persistence.
typestring	<String>	Read-only	Type of Persistence as String.
srcip	<String>	Read-only	SOURCE IP.
srcipv6	<String>	Read-only	SOURCE IPv6 ADDRESS.
destip	<String>	Read-only	DESTINATION IP.
destipv6	<String>	Read-only	DESTINATION IPv6 ADDRESS.
flags	<Boolean>	Read-only	IPv6 FLAGS.
destport	<Integer>	Read-only	Destination port. Range 1 - 65535 * in CLI is represented as 65535 in NITRO API
vservername	<String>	Read-only	Virtual server name.
timeout	<Double>	Read-only	Persistent Session timeout.
referencecount	<Double>	Read-only	Reference Count.
persistenceparam	<String>	Read-only	Specific persistence information . Callid in case of SIP_CALLID persistence entry , RTSP session id in case of RTSP_SESSIONID persistence entry.
cnamepersparam	<String>	Read-only	The cname that is selected incase of gslb service.
__count	<Double>	Read-only	count parameter

Operations¶

(click to see Properties )

GET (ALL)
COUNT
CLEAR

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

clear¶

URL: http:// <netscaler-ip-address> /nitro/v1/config/lbpersistentsessions? action=clear

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"lbpersistentsessions":{
      "vserver":<String_value>,
      "persistenceparameter":<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

get (all)¶

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

Query-parameters:

args

http:// <netscaler-ip-address> /nitro/v1/config/lbpersistentsessions? args=vserver: <String_value> ,nodeid: <Double_value>

Use this query-parameter to get lbpersistentsessions resources based on additional properties.

attrs

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

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

view

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

Use this query-parameter to get the summary output of lbpersistentsessions resources configured on NetScaler.

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

pagination

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

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

Content-Type:application/json

Response Payload:

{ "lbpersistentsessions": [ {
vserver:<String_value>,nodeid:<Double_value>      "type":<Double_value>,
      "typestring":<String_value>,
      "srcip":<String_value>,
      "srcipv6":<String_value>,
      "destip":<String_value>,
      "destipv6":<String_value>,
      "flags":<Boolean_value>,
      "destport":<Integer_value>,
      "vservername":<String_value>,
      "timeout":<Double_value>,
      "referencecount":<Double_value>,
      "sipcallid":<String_value>,
      "persistenceparam":<String_value>,
      "cnamepersparam":<String_value>
}]}

count¶

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

Content-Type:application/json

Response Payload:

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