Skip to content

subscriber gxInterface

The following operations can be performed on "subscriber gxInterface":

set| unset| show

set subscriber gxInterface

Set the Gx Interface configuration on NS.

Synopsys

set subscriber gxInterface [-vServer <string>] [-service <string>] [-pcrfRealm <string>] [-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

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.

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.

Possible values: YES, NO

Default value: YES

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

Default value: 10

Minimum value: 0

Maximum value: 86400

requestRetryAttempts

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

Default value: 3

Minimum value: 0

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

Default value: 0

Maximum value: 86400

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

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

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

Default value: 0

Minimum value: 0

Maximum value: 86400

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

Default value: 600

Minimum value: 0

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

unset subscriber gxInterface

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

Synopsys

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.

Synopsys

show subscriber gxInterface

Outputs

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.