f5networks.f5_modules.bigip_device_auth module – Manage system authentication on a BIG-IP
Note
This module is part of the f5networks.f5_modules collection (version 1.32.1).
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
.
New in f5networks.f5_modules 1.0.0
Synopsis
Manage the system authentication configuration. This module can assist in configuring a number of different system authentication types. Note that this module can not be used to configure APM authentication types.
Parameters
Parameter |
Comments |
---|---|
Specifies how the system returns accounting information, such as which services users access and the amount of network resources they consume, to the TACACS+ server. When When This parameter is supported by the Choices:
|
|
Specifies the process the system employs when sending authentication requests. When When This parameter is supported by the Choices:
|
|
Specifies the protocol associated with the value specified in Note that the majority of TACACS+ implementations are of protocol type 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:
|
|
Secret key used to encrypt and decrypt packets sent or received from the server. Do not use the pound/hash sign in the secret for TACACS+ servers. When configuring TACACS+ auth for the first time, this value is required. |
|
Specifies a list of the IPv4 addresses for servers using the Terminal Access Controller Access System (TACACS)+ protocol with which the system communicates to obtain authorization data. For each address, an alternate TCP port number may be optionally specified by specifying the If no port number is specified, the default port This parameter is supported by the |
|
The IP address of the server. This field is required, unless you are specifying a simple list of servers. In that case, the simple list can specify server IPs. See the examples for more clarification. |
|
The port of the server. |
|
Specifies the name of the service the user is requesting to be authorized to use. Identifying what the user is asking to be authorized for enables the TACACS+ serverc to behave differently for different types of authorization requests. This setting is required when configuring this form of system authentication. Note that the majority of TACACS+ implementations are of service type Choices:
|
|
The state of the authentication configuration on the system. When When Choices:
|
|
The authentication type to manage with this module. Take special note that the parameters supported by this module will vary depending on the At this time, this module only supports a subset of the total available auth types. Choices:
|
|
Choices:
|
|
Specifies whether or not this auth source is put in use on the system. Choices:
|
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: Set the system auth to TACACS+, default server port
bigip_device_auth:
type: tacacs
authentication: use-all-servers
accounting: send-to-all-servers
protocol_name: ip
secret: secret
servers:
- 10.10.10.10
- 10.10.10.11
service_name: ppp
state: present
use_for_auth: true
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
- name: Set the system auth to TACACS+, override server port
bigip_device_auth:
type: tacacs
authentication: use-all-servers
protocol_name: ip
secret: secret
servers:
- address: 10.10.10.10
port: 1234
- 10.10.10.11
service_name: ppp
use_for_auth: true
state: present
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 |
---|---|
Which servers to send information to when using TACACS. Returned: changed Sample: |
|
Process the system uses to serve authentication requests when using TACACS. Returned: changed Sample: |
|
Name of the protocol associated with Returned: changed Sample: |
|
List of servers used in TACACS authentication. Returned: changed Sample: |
|
Name of the service the user is requesting to be authorized to use. Returned: changed Sample: |