ADC NITRO APIs

subscribersessions

August 17, 2023

Contributed by:

Configuration for subscriber sesions resource.

Properties

(click to see Operations )

Name	Data Type	Permissions	Description
ip		Read-write	Subscriber IP Address. Default value: 0
vlan		Read-write	The vlan number on which the subscriber is located. Default value: 0 Minimum value = 0 Maximum value = 4096
nodeid		Read-write	Unique number that identifies the cluster node. Minimum value = 0 Maximum value = 31
subscriptionidtype		Read-only	Subscription-Id type. Possible values = E164, IMSI, SIP_URI, NAI, PRIVATE
subscriptionidvalue		Read-only	Subscription-Id value.
subscriberrules	<String[]>	Read-only	Rules stored in this session for this subscriber. When PCRF sends Charging-Rule-Name or Charging-Rule-Base-Name AVP for a subscriber, Citrix ADC stores these AVPs in the subscriber session. These Rules can be retreived using ‘Subscriber.Rule_Active()' expression. For static subscriber profiles, these rules are configured using '-subscriberRules '.
flags		Read-only	Subscriber Session flags.
ttl		Read-only	Subscriber Session revalidation Timeout remaining. This TTL gets refreshed when a radius or CCA or RAR message is received for this subscriber session. Citrix ADC will send a CCR-U after revalidation timer expires. If subscriber sessions is a negative session, then Citrix ADC will send a CCR-I after TTL expires. Negative Sessions are sessions which have not been resolved by PCRF and instead of polling PCRF continously, Citrix ADC has installed a negative session. If default subscriber is configued, then Negative Sessions inherits default subscriber profile. .
idlettl		Read-only	Subscriber Session Activity Timeout remaining. Citrix ADC will take an idleAction after ttl expires. idleaction could be –> 1. ccrTerminate: (default) send CCR-T to inform PCRF about session termination and delete the session. 2. delete: Just delete the subscriber session without informing PCRF. 3. ccrUpdate: Do not delete the session and instead send a CCR-U to PCRF requesting for an updated session. But if this is a negative session and idleaction is ccrUpdate then Citrix ADC won’t take any action. Also on negative sessions ccrTerminate translates to delete.
avpdisplaybuffer		Read-only	Subscriber Attributes Display.
servicepath		Read-only	Name of the servicepath to be taken for this subscriber.
__count		Read-only	count parameter

Operations

(click to see Properties )

CLEAR
GET (ALL)
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

clear

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

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"subscribersessions":{
      "ip":<String_value>,
      "vlan":<Double_value>
}}

<!--NeedCopy-->

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/subscribersessions

Query-parameters:

args

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

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

attrs

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

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

view

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

Use this query-parameter to get the summary output of subscribersessions 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/subscribersessions? pagesize=#no;pageno=#no

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

{ "subscribersessions": [ {
ip:<String_value>,vlan:<Double_value>,nodeid:<Double_value>      "subscriptionidtype":<String_value>,
      "subscriptionidvalue":<String_value>,
      "subscriberrules":<String[]_value>,
      "flags":<Double_value>,
      "ttl":<Double_value>,
      "idlettl":<Double_value>,
      "avpdisplaybuffer":<String_value>,
      "servicepath":<String_value>
}]}

<!--NeedCopy-->

count

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

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

<!--NeedCopy-->

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

subscribersessions

August 17, 2023

Contributed by:

August 17, 2023

Contributed by:

subscribersessions

Properties

Operations

clear

get (all)

count

In this article