Skip to content

subscribersessions

Configuration for subscriber sesions resource.

Properties

(click to see Operations)

NameData TypePermissionsDescription
ip<String>Read-writeSubscriber IP Address.
Default value: 0
vlan<Double>Read-writeThe vlan number on which the subscriber is located.
Default value: 0
Minimum value = 0
Maximum value = 4096
nodeid<Double>Read-writeUnique number that identifies the cluster node.
Minimum value = 0
Maximum value = 31
subscriptionidtype<String>Read-onlySubscription-Id type.
Possible values = E164, IMSI, SIP_URI, NAI, PRIVATE
subscriptionidvalue<String>Read-onlySubscription-Id value.
subscriberrules<String[]>Read-onlyRules 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(<rule name>)' expression. For static subscriber profiles, these rules are configured using '-subscriberRules <list of rules>'.
flags<Double>Read-onlySubscriber Session flags.
ttl<Double>Read-onlySubscriber 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<Double>Read-onlySubscriber 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<String>Read-onlySubscriber Attributes Display.
servicepath<String>Read-onlyName of the servicepath to be taken for this subscriber.
__count<Double>Read-onlycount 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 Citrix ADC appliance, the URL is as follows:

    http://<Citrix-ADC-IP-address(NSIP)>/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 Citrix ADC 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 redand placeholder content is marked in <green>.

clear

URL:http://<Citrix-ADC-IP-address(NSIP)>/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>
}}

Response:

HTTP Status Code on Success: 200 OK HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for Citrix ADC specific errors). The response payload provides details of the error

get (all)

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/subscribersessions

Query-parameters:

args

http://<Citrix-ADC-IP-address(NSIP)>/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://<Citrix-ADC-IP-address(NSIP)>/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://<Citrix-ADC-IP-address(NSIP)>/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 Citrix ADC. Filtering can be done on any of the properties of the resource.

view

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/subscribersessions?view=summary

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

pagination

http://<Citrix-ADC-IP-address(NSIP)>/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 Citrix ADC specific errors). The response payload provides details of the errorResponse Headers:

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>
}]}

count

URL:http://<Citrix-ADC-IP-address(NSIP)>/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 Citrix ADC specific errors). The response payload provides details of the errorResponse Headers:

Content-Type:application/json

Response Payload:

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