| getsubscriberparamResult Structure Definition |
The getsubscriberparamResult structure defines the return type for getsubscriberparam API. |
Syntax |
Members |
rc |
If the method succeeds, rc is 0 else rc > 0. Values above 0x8000 indicate Warnings. |
message |
If the method succeeds, message is NULL else message contains Error/Warning message. |
subscriberparamList |
List of subscriberparams |
| subscriberparam Structure Definition |
The subscriberparam structure defines the actual return type values for getsubscriberparam API. |
Syntax |
Members |
keytype |
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.
|
interfacetype |
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.
|
idlettl |
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. ! |
idleaction |
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. ! |
ipv6prefixlookuplist |
The ipv6PrefixLookupList should consist of all the ipv6 prefix lengths assigned to the UE's' |
builtin |
_nextgenapiresource |
See Also |