f5networks.f5_modules.bigip_device_auth_radius_server – Manages the RADIUS server configuration of the device
f5networks.f5_modules.bigip_device_auth_radius_server – Manages the RADIUS server configuration of the device
Note
This plugin is part of the f5networks.f5_modules collection (version 1.7.1).
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_server
.
New in version 1.3.0: of f5networks.f5_modules
Synopsis
- Manages a device’s RADIUS server configuration.
- Used in tandem with the
bigip_device_auth_radius
module.
Parameters
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
description string |
The description of the RADIUS server. | ||
ip string |
The IP address of the server. This parameter is mandatory when creating a new resource. | ||
name string / required |
Specifies the name of the RADIUS server to manage. | ||
partition string |
Default: "Common" |
Device partition to manage resources on. | |
port integer |
The port of the server. Valid range of values is between | ||
provider dictionary added in 1.0.0 of f5networks.f5_modules |
A dict object containing connection details. | ||
auth_provider string |
Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. | ||
no_f5_teem boolean |
|
If You may omit this option by setting the environment variable | |
password string / required |
The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable
| ||
server string / required |
The BIG-IP host. You may omit this option by setting the environment variable | ||
server_port integer |
Default: 443 |
The BIG-IP server port. You may omit this option by setting the environment variable | |
timeout integer |
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. | ||
transport string |
|
Configures the transport connection to use when connecting to the remote device. | |
user string / required |
The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable | ||
validate_certs boolean |
|
If You may omit this option by setting the environment variable | |
secret string |
Specifies the secret used for accessing RADIUS server. This parameter is mandatory when creating a new resource. | ||
state string |
|
When When | |
timeout integer |
Specifies the timeout value in seconds. Valid range of values is between | ||
update_secret string |
|
|
Notes
Note
- 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 a RADIUS server configuration
bigip_device_auth_radius_server:
name: "ansible_test"
ip: "1.1.1.1"
port: 1812
secret: "secret"
timeout: 5
update_secret: on_create
state: present
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
- name: Update RADIUS server configuration
bigip_device_auth_radius_server:
name: "ansible_test"
ip: "10.10.10.1"
description: "this is a test"
port: 1813
timeout: 10
state: present
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
- name: Remove RADIUS server configuration
bigip_device_auth_radius_server:
name: "ansible_test"
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 | Returned | Description |
---|---|---|
description string |
changed |
User defined description of the RADIUS server.
Sample: this is my server |
ip string |
changed |
IP address of the RADIUS Server.
Sample: 1.1.1.1 |
port integer |
changed |
RADIUS service port.
Sample: 1812 |
timeout integer |
changed |
Timeout value.
Sample: 3 |
Authors
- Wojciech Wypior (@wojtek0806)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/f5networks/f5_modules/bigip_device_auth_radius_server_module.html