f5networks.f5_modules.bigip_device_auth_radius module – Manages RADIUS auth configuration on a BIG-IP device
Note
This module is part of the f5networks.f5_modules collection (version 1.31.0).
You might already have this collection installed if you are using the ansible
package.
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 f5networks.f5_modules
.
To use it in a playbook, specify: f5networks.f5_modules.bigip_device_auth_radius
.
New in f5networks.f5_modules 1.3.0
Synopsis
Module creates a RADIUS configuration.
Parameters
Parameter |
Comments |
---|---|
Enables or disables validation of the accounting response vector. This option should be necessary only on older servers. Choices:
|
|
Specifies the system uses the Local authentication method if the remote authentication method is not available. Option only available on Choices:
|
|
A dict object containing connection details. |
|
Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. |
|
If You may omit this option by setting the environment variable Previously used variable Choices:
|
|
The password for the user account used to connect to the BIG-IP or the BIG-IQ. You may omit this option by setting the environment variable |
|
The BIG-IP host or the BIG-IQ host. You may omit this option by setting the environment variable |
|
The BIG-IP server port. You may omit this option by setting the environment variable Default: |
|
Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. |
|
Configures the transport connection to use when connecting to the remote device. Choices:
|
|
The username to connect to the BIG-IP or the BIG-IQ. This user must have administrative privileges on the device. You may omit this option by setting the environment variable |
|
If You may omit this option by setting the environment variable Choices:
|
|
Specifies the number of authentication retries the BIG-IP Local Traffic Management system allows before authentication fails. |
|
Specifies the names of RADIUS servers for use with RADIUS authentication profiles. |
|
Specifies the type of service requested from the RADIUS server. The default value is Choices:
|
|
When When Choices:
|
|
Specifies whether or not this auth source is put in use on the system. If If Choices:
|
Notes
Note
This module is based on the command line (TMSH) configuration capabilities of RADIUS authentication, not the GUI.
For more information on using Ansible to manage F5 Networks devices see https://www.ansible.com/integrations/networks/f5.
Requires BIG-IP software version >= 12.
The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the f5networks.f5_modules.bigip_config module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration.
Examples
- name: Create an RADIUS device configuration
bigip_device_auth_radius:
servers:
- "ansible_test1"
- "ansible_test2"
retries: 3
service_type: authenticate-only
accounting_bug: false
use_for_auth: true
fallback_to_local: true
state: present
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
- name: Update an RADIUS device configuration
bigip_device_auth_radius:
retries: 5
service_type: administrative
accounting_bug: true
state: present
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
- name: Delete RADIUS auth configuration
bigip_device_auth_radius:
state: absent
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Enables or disables validation of the accounting response vector. Returned: changed Sample: |
|
Number of authentication retries before authentication fails. Returned: changed Sample: |
|
The servers value of the resource. Returned: changed Sample: |
|
Type of service requested from the RADIUS server. Returned: changed Sample: |