netscaler.adc.subscriberparam (2.5.1) — module

Install collection

Install with ansible-galaxy collection install netscaler.adc:==2.5.1

Add to requirements.yml

  collections:
    - name: netscaler.adc
      version: 2.5.1

Description

Configuration for Subscriber Params resource.

Inputs

    
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

idlettl:
    description:
    - '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. !
    type: float

keytype:
    choices:
    - IP
    - IPANDVLAN
    description:
    - Type of subscriber key type C(IP) or C(IPANDVLAN). C(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.
    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

idleaction:
    choices:
    - ccrTerminate
    - delete
    - ccrUpdate
    description:
    - 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. C(ccrTerminate): (default) send CCR-T to inform PCRF about session termination
      and C(delete) the session.  '
    - '2. C(delete): Just C(delete) the subscriber session without informing PCRF.'
    - '3. C(ccrUpdate): Do not C(delete) the session and instead send a CCR-U to PCRF
      requesting for an updated session. !'
    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

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

interfacetype:
    choices:
    - None
    - RadiusOnly
    - RadiusAndGx
    - GxOnly
    description:
    - Subscriber Interface refers to Citrix ADC interaction with control plane protocols,
      RADIUS and GX.
    - 'Types of subscriber interface: NONE, C(RadiusOnly), C(RadiusAndGx), C(GxOnly).'
    - 'NONE: Only static subscribers can be configured.'
    - 'C(RadiusOnly): GX interface is absent. Subscriber information is obtained through
      RADIUS Accounting messages.'
    - 'C(RadiusAndGx): Subscriber ID obtained through RADIUS Accounting is used to query
      PCRF. Subscriber information is obtained from both RADIUS and PCRF.'
    - 'C(GxOnly): RADIUS interface is absent. Subscriber information is queried using
      Subscriber IP or IP+VLAN.'
    type: str

nitro_protocol:
    choices:
    - http
    - https
    default: https
    description:
    - Which protocol to use when accessing the nitro API objects.
    type: str

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

ipv6prefixlookuplist:
    description:
    - The ipv6PrefixLookupList should consist of all the ipv6 prefix lengths assigned
      to the UE's'
    elements: int
    type: list

Outputs

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