f5networks.f5_modules.bigip_device_auth_radius – Manages RADIUS auth configuration on a BIG-IP 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.

New in version 1.3.0: of f5networks.f5_modules

Synopsis
Parameters
Notes
Examples
Return Values

Synopsis

Module creates a RADIUS configuration.

Parameters

Parameter		Choices/Defaults	Comments
accounting_bug boolean		no yes	Enables or disables validation of the accounting response vector. This option should be necessary only on older servers.
fallback_to_local boolean		no yes	Specifies the system uses the Local authentication method if the remote authentication method is not available. Option only available on `TMOS 13.0.0` and above.
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	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	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	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`.
retries integer			Specifies the number of authentication retries the BIG-IP Local Traffic Management system allows before authentication fails.
servers list / elements=string			Specifies the names of RADIUS servers for use with RADIUS authentication profiles.
service_type string		authenticate-only login default framed callback-login callback-framed outbound administrative nas-prompt callback-nas-prompt call-check callback-administrative	Specifies the type of service requested from the RADIUS server. The default value is `authenticate-only`.
state string		present ← absent	When `state` is `present`, ensures the RADIUS server exists. When `state` is `absent`, ensures the RADIUS server is removed.
use_for_auth boolean		no yes	Specifies whether or not this auth source is put in use on the system. If `yes`, the module sets the current system auth type to the value of `radius`. If `no`, the module sets the authentication type to `local`, similar behavior to when `state` is `absent`, without removing the configured RADIUS resource.

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: no
    use_for_auth: yes
    fallback_to_local: yes
    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: yes
    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	Returned	Description
accounting_bug boolean	changed	Enables or disables validation of the accounting response vector. Sample: True
retries integer	changed	Number of authentication retries before authentication fails. Sample: 10
servers list / elements=string	changed	The servers value of the resource. Sample: hash/dictionary of values
service_type string	changed	Type of service requested from the RADIUS server. Sample: login

Authors

Andrey Kashcheev (@andreykashcheev)
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_module.html