f5networks.f5_modules.bigip_password_policy – Manages the authentication password policy on a BIG-IP
Note
This plugin is part of the f5networks.f5_modules collection (version 1.12.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_password_policy.
New in version 1.0.0: of f5networks.f5_modules
Synopsis
- Manages the authentication password policy on a BIG-IP device.
Parameters
| Parameter | Choices/Defaults | Comments | |
|---|---|---|---|
| expiration_warning
integer
|
Specifies the number of days before a password expires.
This value determines when the BIG-IP system automatically warns users their password is about to expire.
|
||
| max_duration
integer
|
Specifies the maximum number of days a password is valid.
|
||
| max_login_failures
integer
|
Specifies the number of consecutive unsuccessful login attempts the system allows before locking out the user.
Specify zero (0) to disable this parameter.
|
||
| min_duration
integer
|
Specifies the minimum number of days a password is valid.
|
||
| min_length
integer
|
Specifies the minimum number of characters in a valid password.
This value must be between 6 and 255.
|
||
| password_memory
integer
|
Specifies whether the user has configured the BIG-IP system to remember a password on a specific computer and how many passwords to remember.
|
||
| policy_enforcement
boolean
|
|
Enables or disables the password policy on the BIG-IP system.
|
|
| 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
yes, TEEM telemetry data is not sent to F5.
You may omit this option by setting the environment variable
F5_TELEMETRY_OFF.
Previously used variable F5_TEEM is deprecated as its name was confusing.
|
|
| 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
|
|
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
|
|
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.
|
|
| required_lowercase
integer
|
Specifies the number of lowercase alpha characters that must be present in a password for the password to be valid.
|
||
| required_numeric
integer
|
Specifies the number of numeric characters that must be present in a password for the password to be valid.
|
||
| required_special
integer
|
Specifies the number of special characters that must be present in a password for the password to be valid.
|
||
| required_uppercase
integer
|
Specifies the number of uppercase alpha characters that must be present in a password for the password to be valid.
|
||
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: Change password policy to require 2 numeric characters
bigip_password_policy:
required_numeric: 2
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 |
|---|---|---|
| expiration_warning
integer
|
changed |
The new expiration warning.
Sample:
7
|
| max_duration
integer
|
changed |
The new max duration.
Sample:
99999
|
| max_login_failures
integer
|
changed |
The new max login failures.
|
| min_duration
integer
|
changed |
The new minimum duration.
|
| min_length
integer
|
changed |
The new minimum password length.
Sample:
6
|
| password_memory
integer
|
changed |
The new number of remembered passwords
|
| policy_enforcement
boolean
|
changed |
The new policy enforcement setting.
Sample:
True
|
| required_lowercase
integer
|
changed |
The lowercase requirement.
Sample:
1
|
| required_numeric
integer
|
changed |
The numeric requirement.
Sample:
2
|
| required_special
integer
|
changed |
The special character requirement.
Sample:
1
|
| required_uppercase
integer
|
changed |
The uppercase character requirement.
Sample:
1
|
Authors
- Tim Rupp (@caphrim007)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/f5networks/f5_modules/bigip_password_policy_module.html