New in version 2.4.
root, you may only change the password. Your other parameters will be ignored in this case. Changing the root password is not an idempotent operation. Therefore, it will change it every time this module attempts to change it.| Parameter | Choices/Defaults | Comments | |
|---|---|---|---|
| full_name string | Full name of the user. | ||
| partition string added in 2.5 | Default: "Common" | Device partition to manage resources on. | |
| partition_access list | Specifies the administrative partition to which the user has access. partition_access is required when creating a new account. Should be in the form "partition:role".Valid roles include acceleration-policy-editor, admin, application-editor, auditor, certificate-manager, guest, irule-manager, manager, no-access, operator, resource-admin, user-manager, web-application-security-administrator, and web-application-security-editor.Partition portion of tuple should be an existing partition or the value 'all'. | ||
| password_credential string | Set the users password to this unencrypted value. password_credential is required when creating a new account. | ||
| provider dictionary added in 2.5 | 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. | ||
| 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. | |
| ssh_keyfile path | Specifies the SSH keyfile to use to authenticate the connection to the remote device. This argument is only used for cli transports. You may omit this option by setting the environment variable ANSIBLE_NET_SSH_KEYFILE. | ||
| 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. | |
| shell string |
| Optionally set the users shell. | |
| state string |
| Whether the account should exist or not, taking action if the state is different from what is stated. | |
| update_password string |
| always will allow to update passwords if the user chooses to do so. on_create will only set the password for newly created users.When username_credential is root, this value will be forced to always. | |
| username_credential string / required | Name of the user to create, remove or modify. The root user may not be removed.aliases: name | ||
Note
- name: Add the user 'johnd' as an admin
bigip_user:
username_credential: johnd
password_credential: password
full_name: John Doe
partition_access: all:admin
update_password: on_create
state: present
provider:
server: lb.mydomain.com
user: admin
password: secret
delegate_to: localhost
- name: Change the user "johnd's" role and shell
bigip_user:
username_credential: johnd
partition_access: NewPartition:manager
shell: tmsh
state: present
provider:
server: lb.mydomain.com
user: admin
password: secret
delegate_to: localhost
- name: Make the user 'johnd' an admin and set to advanced shell
bigip_user:
name: johnd
partition_access: all:admin
shell: bash
state: present
provider:
server: lb.mydomain.com
user: admin
password: secret
delegate_to: localhost
- name: Remove the user 'johnd'
bigip_user:
name: johnd
state: absent
provider:
server: lb.mydomain.com
user: admin
password: secret
delegate_to: localhost
- name: Update password
bigip_user:
state: present
username_credential: johnd
password_credential: newsupersecretpassword
provider:
server: lb.mydomain.com
user: admin
password: secret
delegate_to: localhost
# Note that the second time this task runs, it would fail because
# The password has been changed. Therefore, it is recommended that
# you either,
#
# * Put this in its own playbook that you run when you need to
# * Put this task in a `block`
# * Include `ignore_errors` on this task
- name: Change the Admin password
bigip_user:
state: present
username_credential: admin
password_credential: NewSecretPassword
provider:
server: lb.mydomain.com
user: admin
password: secret
delegate_to: localhost
- name: Change the root user's password
bigip_user:
username_credential: root
password_credential: secret
state: present
provider:
server: lb.mydomain.com
user: admin
password: secret
delegate_to: localhost
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
| full_name string | changed and success | Full name of the user Sample: John Doe |
| partition_access list | changed and success | List of strings containing the user's roles and which partitions they are applied to. They are specified in the form "partition:role". Sample: ['all:admin'] |
| shell string | changed and success | The shell assigned to the user account Sample: tmsh |
Hint
If you notice any issues in this documentation, you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/bigip_user_module.html