netscaler / netscaler.adc / 2.5.1 / module / authenticationradiusaction Configuration for RADIUS action resource. | "added in version" 2.0.0 of netscaler.adc" Authors: Sumanth Lingappa (@sumanth-lingappa) preview | supported by communitynetscaler.adc.authenticationradiusaction (2.5.1) — module
Install with ansible-galaxy collection install netscaler.adc:==2.5.1
collections: - name: netscaler.adc version: 2.5.1
Configuration for RADIUS action resource.
name: description: - Name for the RADIUS action. - Must begin with a letter, number, or the underscore character (_), and must contain only letters, numbers, and the hyphen (-), period (.) pound (#), space ( ), at (@), equals (=), colon (:), and underscore characters. Cannot be changed after the RADIUS action is added. type: str 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 - absent - 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(absent), the resource will be deleted from the NetScaler ADC node. - When C(unset), the resource will be unset on the NetScaler ADC node. type: str radkey: description: - Key shared between the RADIUS server and the Citrix ADC. - Required to allow 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: - If configured, this string is sent to the RADIUS server as the Network Access Server ID (NASID). type: str radnasip: choices: - ENABLED - DISABLED description: - If enabled, the Citrix ADC IP address (NSIP) is sent to the RADIUS server as the Network Access Server IP (NASIP) address. - The RADIUS protocol defines the meaning and use of the NASIP address. type: str serverip: description: - IP address assigned to the RADIUS server. type: str transport: choices: - UDP - TCP - TLS description: - Transport mode to RADIUS server. type: str accounting: choices: - 'ON' - 'OFF' description: - Whether the RADIUS server is currently accepting accounting messages. type: str ipvendorid: description: - Vendor ID of the intranet IP attribute in the RADIUS response. - 'NOTE: A value of 0 indicates that the attribute is not vendor encoded.' 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 servername: description: - RADIUS server name as a FQDN. Mutually exclusive with RADIUS IP address. type: str serverport: description: - Port number on which the RADIUS server listens for connections. type: int authtimeout: description: - Number of seconds the Citrix ADC waits for a response from the RADIUS server. type: float pwdvendorid: description: - Vendor ID of the attribute, in the RADIUS response, used to extract the user password. type: float radvendorid: description: - RADIUS vendor ID attribute, used 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: - Encoding type for passwords 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: - Remote IP address attribute type in a RADIUS response. type: float radgroupsprefix: description: - RADIUS groups prefix string. - This groups prefix precedes the group names within a RADIUS attribute for RADIUS group extraction. type: str targetlbvserver: description: - If transport mode is TLS, specify the name of LB vserver to associate. The LB vserver needs to be of type TCP and service associated needs to be SSL_TCP 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: - Vendor-specific password attribute type in a RADIUS response. type: float radattributetype: description: - RADIUS attribute type, used for RADIUS group extraction. type: float radgroupseparator: description: - RADIUS group separator string - The group separator 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
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