ADC CLI Commands

subscriber-gxInterface

May 28, 2024

Contributed by:

The following operations can be performed on “subscriber-gxInterface”:

unset subscriber gxInterface

Use this command to remove subscriber gxInterface settings.Refer to the set subscriber gxInterface command for meanings of the arguments.

Synopsis

unset subscriber gxInterface [-vServer] [-service] [-holdOnSubscriberAbsence] [-requestTimeout] [-requestRetryAttempts] [-revalidationTimeout] [-healthCheck] [-healthCheckTTL] [-cerRequestTimeout] [-negativeTTL] [-negativeTTLLimitedSuccess] [-purgeSDBonGxFailure] [-servicePathAVP] [-servicePathVendorid]

show subscriber gxInterface

Displays the Gx interface parameters configured on the Citrix ADC.

Synopsis

show subscriber gxInterface

Arguments

Output

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

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

svrState The state of the gx service.

pcrfRealm 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).

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

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

requestRetryAttempts If the request does not complete within requestTimeout time, the request is retransmitted for requestRetryAttempts time.

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

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

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

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

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

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

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

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

identity DiameterIdentity to be used by NS. DiameterIdentity is used to identify a Diameter node uniquely. Before setting up diameter configuration, Citrix ADC (as a Diameter node) MUST be assigned a unique DiameterIdentity. example => set ns diameter -identity Citrix ADC.com Now whenever Citrix ADC system needs to use identity in diameter messages. It will use ‘netscaler.com’ as Origin-Host AVP as defined in RFC3588

realm Diameter Realm to be used by NS. example => set ns diameter -realm com Now whenever Citrix ADC system needs to use realm in diameter messages. It will use ‘com’ as Origin-Realm AVP as defined in RFC3588

status Citrix ADC PCRF connection Status. (Gx Protocol State)

servicePathAVP The AVP code in which PCRF sends service path applicable for subscriber.

servicePathVendorid The vendorid of the AVP in which PCRF sends service path for subscriber.

servicePathInfomode The type of info in which service path is passed from PCRF, SERVICE_FUNCTION: Denotes the service chain is passed as servicefunction names in-order in AVPS with code servicepathAVP SERVICE_PATH: Denotes the service path name is passed in AVPS with code servicepathAVP.q

gxReportingAvp1 The AVP code to report as 1st custom AVP.

gxReportingAvp1VendorId The vendorid of the AVP which will be reported as 1st custom AVP.

gxReportingAvp1Type The type of the AVP which will be reported as 1st custom AVP.

gxReportingAvp2 The AVP code to report as 2nd custom AVP.

gxReportingAvp2VendorId The vendorid of the AVP which will be reported as 2nd custom AVP.

gxReportingAvp2Type The type of the AVP which will be reported as 2nd custom AVP.

gxReportingAvp3 The AVP code to report as 3rd custom AVP.

gxReportingAvp3VendorId The vendorid of the AVP which will be reported as 3rd custom AVP.

gxReportingAvp3Type The type of the AVP which will be reported as 3rd custom AVP.

gxReportingAvp4 The AVP code to report as 4th custom AVP.

gxReportingAvp4VendorId The vendorid of the AVP which will be reported as 4th custom AVP.

gxReportingAvp4Type The type of the AVP which will be reported as 4th custom AVP.

gxReportingAvp5 The AVP code to report as 5th custom AVP.

gxReportingAvp5VendorId The vendorid of the AVP which will be reported as 5th custom AVP.

gxReportingAvp5Type The type of the AVP which will be reported as 5th custom AVP.

set subscriber gxInterface

Set the Gx Interface configuration on NS.

Synopsis

set subscriber gxInterface [-vServer ] \[-service ] \[-pcrfRealm ] \[-holdOnSubscriberAbsence \( YES | NO )] \[-requestTimeout <positive\_integer>] \[-requestRetryAttempts <positive\_integer>] \[-revalidationTimeout <positive\_integer>] \[-healthCheck \( YES | NO )] \[-healthCheckTTL <positive\_integer>] \[-cerRequestTimeout <positive\_integer>] \[-negativeTTL <positive\_integer>] \[-negativeTTLLimitedSuccess \( YES | NO )] \[-purgeSDBonGxFailure \( YES | NO )] \[-servicePathAVP <positive\_integer> ...] \[-servicePathVendorid <positive\_integer>]

Arguments

Possible values: YES, NO Default value: YES

requestRetryAttempts If the request does not complete within requestTimeout time, the request is retransmitted for requestRetryAttempts time. Default value: 3 Minimum value: 0

Possible values: YES, NO Default value: NO

healthCheckTTL 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. ! Default value: 30 Minimum value: 6 Maximum value: 86400

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

Possible values: YES, NO Default value: NO

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

Possible values: YES, NO Default value: NO

servicePathAVP The AVP code in which PCRF sends service path applicable for subscriber. Minimum value: 1

servicePathVendorid The vendorid of the AVP in which PCRF sends service path for subscriber. Minimum value: 0

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

subscriber-gxInterface

May 28, 2024

Contributed by:

May 28, 2024

Contributed by:

subscriber-gxInterface

unset subscriber gxInterface

Synopsis

show subscriber gxInterface

Synopsis

Arguments

Output

set subscriber gxInterface

Synopsis

Arguments

In this article