netscaler.adc.aaaradiusparams (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 RADIUS parameter 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

radkey:
    description:
    - The key shared between the RADIUS server and clients.
    - Required for allowing the Citrix ADC to communicate with the RADIUS server.
    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

radnasid:
    description:
    - Send the Network Access Server ID (NASID) for your Citrix ADC to the RADIUS server
      as the nasid part of the Radius protocol.
    type: str

radnasip:
    choices:
    - ENABLED
    - DISABLED
    description:
    - Send the Citrix ADC IP (NSIP) address to the RADIUS server as the Network Access
      Server IP (NASIP) part of the Radius protocol.
    type: str

serverip:
    description:
    - IP address of your RADIUS server.
    type: str

accounting:
    choices:
    - 'ON'
    - 'OFF'
    description:
    - Configure the RADIUS server state to accept or refuse accounting messages.
    type: str

ipvendorid:
    description:
    - Vendor ID attribute in the RADIUS response.
    - If the attribute is not vendor-encoded, it is set to 0.
    type: float

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

serverport:
    description:
    - Port number on which the RADIUS server listens for connections.
    type: int

authtimeout:
    description:
    - Maximum number of seconds that the Citrix ADC waits for a response from the RADIUS
      server.
    type: float

pwdvendorid:
    description:
    - Vendor ID of the password in the RADIUS response. Used to extract the user password.
    type: float

radvendorid:
    description:
    - Vendor ID for RADIUS group extraction.
    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

passencoding:
    choices:
    - pap
    - chap
    - mschapv1
    - mschapv2
    description:
    - Enable password encoding in RADIUS packets that the Citrix ADC sends to the RADIUS
      server.
    type: str

authservretry:
    description:
    - Number of retry by the Citrix ADC before getting response from the RADIUS server.
    type: float

authentication:
    choices:
    - 'ON'
    - 'OFF'
    description:
    - Configure the RADIUS server state to accept or refuse authentication messages.
    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

ipattributetype:
    description:
    - IP attribute type in the RADIUS response.
    type: float

radgroupsprefix:
    description:
    - Prefix string that precedes group names within a RADIUS attribute for RADIUS group
      extraction.
    type: str

callingstationid:
    choices:
    - ENABLED
    - DISABLED
    description:
    - Send Calling-Station-ID of the client to the RADIUS server. IP Address of the client
      is sent as its Calling-Station-ID.
    type: str

nitro_auth_token:
    description:
    - The authentication token provided by a login operation.
    type: str
    version_added: 2.6.0
    version_added_collection: netscaler.adc

pwdattributetype:
    description:
    - Attribute type of the Vendor ID in the RADIUS response.
    type: float

radattributetype:
    description:
    - Attribute type for RADIUS group extraction.
    type: float

radgroupseparator:
    description:
    - Group separator string that delimits group names within a RADIUS attribute for RADIUS
      group extraction.
    type: str

tunnelendpointclientip:
    choices:
    - ENABLED
    - DISABLED
    description:
    - Send Tunnel Endpoint Client IP address to the RADIUS server.
    type: str

defaultauthenticationgroup:
    description:
    - This is the default group that is chosen when the authentication succeeds in addition
      to extracted groups.
    type: str

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