Home > Configuration > Subscriber

Use this method to creates a static subscriber profile for mobile subscribers. When traffic passes through Citrix ADC, Citrix ADC can identify the subscribers for this traffic and Subscriber based policy expressions could be configured to enable subscriber aware traffic processing.

Use this method to deletes a subscriber session. Without any arguement it clears the subscriber session database.

Use this method to get the Gx interface parameters configured on the Citrix ADC.

Use this method to get global subscriber params.

Use this method to get method of a static subscriber

Use this method to get the RADIUS interface parameters configured on the Citrix ADC.

Use this method to get method of a subscriber session

Use this method to deletes a static subscriber

Use this method to set q!Healthcheck request timeout, in seconds, after which the Citrix ADC considers that no CCA packet received to the initiated CCR. After this time Citrix ADC should send again CCR to PCRF server. !

Use this method to set q!Set this setting to yes if Citrix ADC should send DWR packets to PCRF server. When the session is idle, healthcheck timer expires and DWR packets are initiated in order to check that PCRF server is active. By default set to No. !

Use this method to set q!Healthcheck timeout, in seconds, after which the DWR will be sent in order to ensure the state of the PCRF server. Any CCR, CCA, RAR or RRA message resets the timer. !

Use this method to set set this setting to yes if Citrix ADC needs to Hold pakcets till subscriber session is fetched from PCRF. Else set to NO. By default set to yes. If this setting is set to NO, then till Citrix ADC fetches subscriber from PCRF, default subscriber profile will be applied to this subscriber if configured. If default subscriber profile is also not configured an undef would be raised to expressions which use Subscriber attributes.

Use this method to set q!Idle Time, in seconds, after which the Gx CCR-U request will be sent after any PCRF activity on a session. Any RAR or CCA message resets the timer.
Zero value disables the idle timeout. !
NOTE: This attribute is deprecated.

Use this method to set q!Negative TTL, in seconds, after which the Gx CCR-I request will be resent for sessions that have not been resolved by PCRF due to server being down or no response or failed response. Instead of polling the PCRF server constantly, negative-TTL makes Citrix ADC stick to un-resolved session. Meanwhile Citrix ADC installs a negative session to avoid going to PCRF.
For Negative Sessions, Netcaler inherits the attributes from default subscriber profile if default subscriber is configured. A default subscriber could be configured as 'add subscriber profile *'. Or these attributes can be inherited from Radius as well if Radius is configued.
Zero value disables the Negative Sessions. And Citrix ADC does not install Negative sessions even if subscriber session could not be fetched. !

Use this method to set set this to YES if Citrix ADC should create negative session for Result-Code DIAMETER_LIMITED_SUCCESS (2002) received in CCA-I. If set to NO, regular session is created.

Use this method to set pCRF realm is of type DiameterIdentity and contains the realm of PCRF to which the message is to be routed. This is the realm used in Destination-Realm AVP by Citrix ADC Gx client (as a Diameter node).

Use this method to set set this setting to YES if needed to purge Subscriber Database in case of Gx failure. By default set to NO.

Use this method to set if the request does not complete within requestTimeout time, the request is retransmitted for requestRetryAttempts time.

Use this method to set q!Time, in seconds, within which the Gx CCR request must complete. If the request does not complete within this time, the request is retransmitted for requestRetryAttempts time. If still reuqest is not complete then default subscriber profile will be applied to this subscriber if configured. If default subscriber profile is also not configured an undef would be raised to expressions which use Subscriber attributes.
Zero disables the timeout. !

Use this method to set q!Revalidation Timeout, in seconds, after which the Gx CCR-U request will be sent after any PCRF activity on a session. Any RAR or CCA message resets the timer.
Zero value disables the idle timeout. !

Use this method to set name of DIAMETER/SSL_DIAMETER service corresponding to PCRF to which the Gx connection is established. The service type of the service must be DIAMETER/SSL_DIAMETER. Mutually exclusive with vserver parameter. Therefore, you cannot set both Service and the Virtual Server in the Gx Interface.

Use this method to set The AVP code in which PCRF sends service path applicable for subscriber.

Use this method to set The vendorid of the AVP in which PCRF sends service path for subscriber.

Use this method to set name of the load balancing, or content switching vserver to which the Gx connections are established. The service type of the virtual server must be DIAMETER/SSL_DIAMETER. Mutually exclusive with the service parameter. Therefore, you cannot set both service and the Virtual Server in the Gx Interface.

Use this method to set 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. !

Use this method to set 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. !

Use this method to set 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.

Use this method to set The ipv6PrefixLookupList should consist of all the ipv6 prefix lengths assigned to the UE's'

Use this method to set 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.

Use this method to set Name of the servicepath to be taken for this subscriber.

Use this method to set rules configured for this subscriber. This is similar to rules received from PCRF for dynamic subscriber sessions.

Use this method to set subscription-Id type

Use this method to set name of RADIUS LISTENING service that will process RADIUS accounting requests.

Use this method to set treat radius interim message as start radius messages.

Remove subscriber gxInterface cerrequesttimeout setting.

Remove subscriber gxInterface healthcheck setting.

Remove subscriber gxInterface healthcheckttl setting.

Remove subscriber gxInterface holdonsubscriberabsence setting.

Remove subscriber gxInterface idlettl setting.

Remove subscriber gxInterface negativettl setting.

Remove subscriber gxInterface negativettllimitedsuccess setting.

Remove subscriber gxInterface purgesdbongxfailure setting.

Remove subscriber gxInterface requestretryattempts setting.

Remove subscriber gxInterface requesttimeout setting.

Remove subscriber gxInterface revalidationtimeout setting.

Remove subscriber gxInterface service setting.

Remove subscriber gxInterface servicepathavp setting.

Remove subscriber gxInterface servicepathvendorid setting.

Remove subscriber gxInterface vserver setting.

Remove subscriber param idleaction setting.

Remove subscriber param idlettl setting.

Remove subscriber param interfacetype setting.

Remove subscriber param keytype setting.

Remove subscriber profile servicepath setting.

Remove subscriber radiusInterface radiusinterimasstart setting.