netscaler.adc.subscriberparam module – Configuration for Subscriber Params resource.

Note

This module is part of the netscaler.adc collection (version 2.6.0).

It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install netscaler.adc.

To use it in a playbook, specify: netscaler.adc.subscriberparam.

New in netscaler.adc 2.0.0

Synopsis

  • Configuration for Subscriber Params resource.

Parameters

Parameter

Comments

api_path

string

Base NITRO API path.

Define only in case of an ADM service proxy call

Default: "nitro/v1/config"

idleaction

any

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

Choices:

  • "ccrTerminate"

  • "delete"

  • "ccrUpdate"

idlettl

any

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

interfacetype

any

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.

Choices:

  • "None"

  • "RadiusOnly"

  • "RadiusAndGx"

  • "GxOnly"

ipv6prefixlookuplist

list / elements=integer

The ipv6PrefixLookupList should consist of all the ipv6 prefix lengths assigned to the UE’s’

keytype

any

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.

Choices:

  • "IP"

  • "IPANDVLAN"

managed_netscaler_instance_id

string

added in netscaler.adc 2.6.0

The ID of the managed NetScaler instance to which NetScaler Console

has to configure as a proxy server.

Define only in case of an ADM service proxy call

managed_netscaler_instance_ip

string

added in netscaler.adc 2.6.0

The IP of the managed NetScaler instance to which NetScaler Console

has to configure as a proxy server.

Define only in case of an ADM service proxy call

managed_netscaler_instance_name

string

added in netscaler.adc 2.6.0

The name of the managed NetScaler instance to which NetScaler Console

has to configure as a proxy server.

Define only in case of an ADM service proxy call

managed_netscaler_instance_password

string

added in netscaler.adc 2.6.0

The password of the managed NetScaler instance.

Define only in case of an ADM service proxy call

In Settings > Administration > System Configurations > Basic Settings,

if you select Prompt Credentials for Instance Login,

ensure to configure username and password of a managed instance.

managed_netscaler_instance_username

string

added in netscaler.adc 2.6.0

The username of the managed NetScaler instance.

Define only in case of an ADM service proxy call

In Settings > Administration > System Configurations > Basic Settings,

if you select Prompt Credentials for Instance Login,

ensure to configure username and password of a managed instance.

netscaler_console_as_proxy_server

boolean

added in netscaler.adc 2.6.0

The IP address of the NetScaler ADC appliance acting as a proxy server.

Define only in case of an ADM service proxy call

Choices:

  • false ← (default)

  • true

nitro_auth_token

string

The authentication token provided by a login operation.

nitro_pass

string

The password with which to authenticate to the NetScaler ADC node.

nitro_protocol

string

Which protocol to use when accessing the nitro API objects.

Choices:

  • "http"

  • "https" ← (default)

nitro_user

string

The username with which to authenticate to the NetScaler ADC node.

nsip

string / required

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.

save_config

boolean

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

Choices:

  • false ← (default)

  • true

state

string

The state of the resource being configured by the module on the NetScaler ADC node.

When present, the resource will be added/updated configured according to the module’s parameters.

When unset, the resource will be unset on the NetScaler ADC node.

Choices:

  • "present" ← (default)

  • "unset"

validate_certs

boolean

If false, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.

Choices:

  • false

  • true ← (default)

Notes

Note

Examples

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

changed

boolean

Indicates if any change is made by the module

Returned: always

Sample: true

diff

dictionary

Dictionary of before and after changes

Returned: always

Sample: {"after": {"key2": "pqr"}, "before": {"key1": "xyz"}, "prepared": "changes done"}

diff_list

list / elements=string

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"]

failed

boolean

Indicates if the module failed or not

Returned: always

Sample: false

loglines

list / elements=string

list of logged messages by the module

Returned: always

Sample: ["message 1", "message 2"]

Authors

  • Sumanth Lingappa (@sumanth-lingappa)