-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
subscribersessions
-
-
-
-
-
-
This content has been machine translated dynamically.
Dieser Inhalt ist eine maschinelle Übersetzung, die dynamisch erstellt wurde. (Haftungsausschluss)
Cet article a été traduit automatiquement de manière dynamique. (Clause de non responsabilité)
Este artículo lo ha traducido una máquina de forma dinámica. (Aviso legal)
此内容已经过机器动态翻译。 放弃
このコンテンツは動的に機械翻訳されています。免責事項
이 콘텐츠는 동적으로 기계 번역되었습니다. 책임 부인
Este texto foi traduzido automaticamente. (Aviso legal)
Questo contenuto è stato tradotto dinamicamente con traduzione automatica.(Esclusione di responsabilità))
This article has been machine translated.
Dieser Artikel wurde maschinell übersetzt. (Haftungsausschluss)
Ce article a été traduit automatiquement. (Clause de non responsabilité)
Este artículo ha sido traducido automáticamente. (Aviso legal)
この記事は機械翻訳されています.免責事項
이 기사는 기계 번역되었습니다.책임 부인
Este artigo foi traduzido automaticamente.(Aviso legal)
这篇文章已经过机器翻译.放弃
Questo articolo è stato tradotto automaticamente.(Esclusione di responsabilità))
Translation failed!
subscribersessions
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(
|
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 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>
}}
<!--NeedCopy-->
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>
}]}
<!--NeedCopy-->
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"} ] }
<!--NeedCopy-->
Share
Share
In this article
This Preview product documentation is Citrix Confidential.
You agree to hold this documentation confidential pursuant to the terms of your Citrix Beta/Tech Preview Agreement.
The development, release and timing of any features or functionality described in the Preview documentation remains at our sole discretion and are subject to change without notice or consultation.
The documentation is for informational purposes only and is not a commitment, promise or legal obligation to deliver any material, code or functionality and should not be relied upon in making Citrix product purchase decisions.
If you do not agree, select I DO NOT AGREE to exit.