Try SpotterConfiguration for Gx interface Parameters resource.
| "added in version" 2.0.0 of netscaler.adc"
Authors: Sumanth Lingappa (@sumanth-lingappa)
preview | supported by community
Install with ansible-galaxy collection install netscaler.adc:==2.5.1
collections:
- name: netscaler.adc
version: 2.5.1Configuration for Gx interface Parameters resource.
---
- name: Sample Playbook
hosts: localhost
gather_facts: false
tasks:
- name: Sample Task | subscribergxInterface
delegate_to: localhost
netscaler.adc.subscribergxinterface:
state: present
pcrfrealm: pcrf.com
servicepathavp:
- 262099
servicepathvendorid: 3845
nsip:
description:
- The ip address of the NetScaler ADC appliance where the nitro API calls will be
made.
- The port can be specified with the colon (:). E.g. 192.168.1.1:555.
required: true
type: str
state:
choices:
- present
- unset
default: present
description:
- The state of the resource being configured by the module on the NetScaler ADC node.
- When C(present), the resource will be added/updated configured according to the
module's parameters.
- When C(unset), the resource will be unset on the NetScaler ADC node.
type: str
nodeid:
description:
- Unique number that identifies the cluster node.
type: float
idlettl:
description:
- 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. !
type: float
service:
description:
- 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.
type: str
vserver:
description:
- 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.
type: str
api_path:
default: nitro/v1/config
description:
- Base NITRO API path.
- Define only in case of an ADM service proxy call
type: str
pcrfrealm:
description:
- 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).
type: str
nitro_pass:
description:
- The password with which to authenticate to the NetScaler ADC node.
required: false
type: str
nitro_user:
description:
- The username with which to authenticate to the NetScaler ADC node.
required: false
type: str
healthcheck:
choices:
- 'YES'
- 'NO'
description:
- 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. !
type: str
negativettl:
description:
- 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. !
type: float
save_config:
default: false
description:
- If C(true) the module will save the configuration on the NetScaler ADC node if it
makes any changes.
- The module will not save the configuration on the NetScaler ADC node if it made
no changes.
type: bool
healthcheckttl:
description:
- 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. !
type: float
nitro_protocol:
choices:
- http
- https
default: https
description:
- Which protocol to use when accessing the nitro API objects.
type: str
requesttimeout:
description:
- 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. !
type: float
servicepathavp:
description:
- The AVP code in which PCRF sends service path applicable for subscriber.
elements: int
type: list
validate_certs:
default: true
description:
- If C(false), SSL certificates will not be validated. This should only be used on
personally controlled sites using self-signed certificates.
required: false
type: bool
nitro_auth_token:
description:
- The authentication token provided by a login operation.
type: str
version_added: 2.6.0
version_added_collection: netscaler.adc
cerrequesttimeout:
description:
- 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. !
type: float
purgesdbongxfailure:
choices:
- 'YES'
- 'NO'
description:
- Set this setting to C(YES) if needed to purge Subscriber Database in case of Gx
failure. By default set to C(NO).
type: str
revalidationtimeout:
description:
- 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. !
type: float
servicepathvendorid:
description:
- The vendorid of the AVP in which PCRF sends service path for subscriber.
type: float
requestretryattempts:
description:
- If the request does not complete within requestTimeout time, the request is retransmitted
for requestRetryAttempts time.
type: float
holdonsubscriberabsence:
choices:
- 'YES'
- 'NO'
description:
- Set this setting to yes if Citrix ADC needs to Hold pakcets till subscriber session
is fetched from PCRF. Else set to C(NO). By default set to yes. If this setting
is set to C(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.
type: str
negativettllimitedsuccess:
choices:
- 'YES'
- 'NO'
description:
- Set this to C(YES) if Citrix ADC should create negative session for Result-Code
DIAMETER_LIMITED_SUCCESS (2002) received in CCA-I. If set to C(NO), regular session
is created.
type: str
changed:
description: Indicates if any change is made by the module
returned: always
sample: true
type: bool
diff:
description: Dictionary of before and after changes
returned: always
sample:
after:
key2: pqr
before:
key1: xyz
prepared: changes done
type: dict
diff_list:
description: List of differences between the actual configured object and the configuration
specified in the module
returned: when changed
sample:
- 'Attribute `key1` differs. Desired: (<class ''str''>) XYZ. Existing: (<class ''str''>)
PQR'
type: list
failed:
description: Indicates if the module failed or not
returned: always
sample: false
type: bool
loglines:
description: list of logged messages by the module
returned: always
sample:
- message 1
- message 2
type: list