bigip_device_auth_radius_server – Manages the RADIUS server configuration of the device

New in version 1.3.0.

Synopsis

  • Manages a device’s RADIUS server configuration.
  • Used in tandem with the bigip_device_auth_radius module.

Parameters

Parameter Choices/Defaults Configuration 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 0 and 65535 inclusive.
provider
dictionary
added in 1.0.0
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
    Choices:
  • no
  • yes
If yes, TEEM telemetry data is not sent to F5.
You may omit this option by setting the environment variable F5_TEEM.
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 F5_PASSWORD.

aliases: pass, pwd
server
string / required
The BIG-IP host.
You may omit this option by setting the environment variable F5_SERVER.
server_port
integer
Default:
443
The BIG-IP server port.
You may omit this option by setting the environment variable F5_SERVER_PORT.
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
    Choices:
  • rest ←
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 F5_USER.
validate_certs
boolean
    Choices:
  • no
  • yes ←
If no, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates.
You may omit this option by setting the environment variable F5_VALIDATE_CERTS.
secret
string
Specifies the secret used for accessing RADIUS server.
This parameter is mandatory when creating a new resource.
state
string
    Choices:
  • present ←
  • absent
When state is present, ensures the RADIUS server exists.
When state is absent, ensures the RADIUS server is removed.
timeout
integer
Specifies the timeout value in seconds.
Valid range of values is between 1 and 60 inclusive.
update_secret
string
    Choices:
  • always ←
  • on_create
always will update passwords if the secret is specified.
on_create will only set the password for newly created servers.

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

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


Status

Authors

  • Wojciech Wypior (@wojtek0806)