Developer Documentation
ADC NITRO APIs
Current Release 13.1 13

subscriberparam

August 17, 2023
Contributed by: 
C

Configuration for Subscriber Params resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
keytype Read-write Type of subscriber key type IP or IPANDVLAN. IPANDVLAN option can be used only when the interfaceType is set to gxOnly.

Changing the lookup method should result to the subscriber session database being flushed.



Default value: IP

Possible values = IP, IPANDVLAN
interfacetype Read-write Subscriber Interface refers to Citrix ADC interaction with control plane protocols, RADIUS and GX.

Types of subscriber interface: NONE, RadiusOnly, RadiusAndGx, GxOnly.

NONE: Only static subscribers can be configured.

RadiusOnly: GX interface is absent. Subscriber information is obtained through RADIUS Accounting messages.

RadiusAndGx: Subscriber ID obtained through RADIUS Accounting is used to query PCRF. Subscriber information is obtained from both RADIUS and PCRF.

GxOnly: RADIUS interface is absent. Subscriber information is queried using Subscriber IP or IP+VLAN.



Default value: None

Possible values = None, RadiusOnly, RadiusAndGx, GxOnly
idlettl Read-write q!Idle Timeout, in seconds, after which Citrix ADC will take an idleAction on a subscriber session (refer to ‘idleAction’ arguement in ‘set subscriber param’ for more details on idleAction). Any data-plane or control plane activity updates the idleTimeout on subscriber session. idleAction could be to ‘just delete the session’ or ‘delete and CCR-T’ (if PCRF is configured) or ‘do not delete but send a CCR-U’.

Zero value disables the idle timeout. !.

Default value: 0

Minimum value = 0

Maximum value = 172800
idleaction Read-write q!Once idleTTL exprires on a subscriber session, Citrix ADC will take an idle action on that session. idleAction could be chosen from one of these ==>

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. !.

Default value: ccrTerminate

Possible values = ccrTerminate, delete, ccrUpdate
ipv6prefixlookuplist <Double[]> Read-write The ipv6PrefixLookupList should consist of all the ipv6 prefix lengths assigned to the UE’s’.

Minimum value = 1

Maximum value = 128
builtin <String[]> Read-only .

Possible values = MODIFIABLE, DELETABLE, IMMUTABLE, PARTITION_ALL
feature Read-only The feature to be checked while applying this config.

Operations

(click to see Properties )

  • UPDATE
  • UNSET
  • GET (ALL)

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

update

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

HTTP Method: PUT

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload: 


{"subscriberparam":{
      "keytype":<String_value>,
      "interfacetype":<String_value>,
      "idlettl":<Double_value>,
      "idleaction":<String_value>,
      "ipv6prefixlookuplist":<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

unset

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

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload: 


{"subscriberparam":{
      "keytype":true,
      "interfacetype":true,
      "idlettl":true,
      "idleaction":true
}}

<!--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/subscriberparam

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: 


{ "subscriberparam": [ {
      "keytype":<String_value>,
      "interfacetype":<String_value>,
      "idlettl":<Double_value>,
      "idleaction":<String_value>,
      "ipv6prefixlookuplist":<Double[]_value>,
      "builtin":<String[]_value>,
      "feature":<String_value>
}]}

<!--NeedCopy-->
subscriberparam
August 17, 2023
Contributed by: 
C
August 17, 2023
Contributed by: 
C

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.