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.The below requirements are needed on the host that executes this module.
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
full_name | Full name of the user. | ||
partition (added in 2.5) | Default: Common | Device partition to manage resources on. | |
partition_access | 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 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 | ||
password_credential | Set the users password to this unencrypted value. password_credential is required when creating a new account. | ||
provider (added in 2.5) | Default: None | A dict object containing connection details. | |
ssh_keyfile | 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 | Default: 10 | 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. | |
server required | The BIG-IP host. You may omit this option by setting the environment variable F5_SERVER . | ||
user 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 . | ||
server_port | Default: 443 | The BIG-IP server port. You may omit this option by setting the environment variable F5_SERVER_PORT . | |
password 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 | ||
validate_certs bool |
| 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 . | |
transport required |
| Configures the transport connection to use when connecting to the remote device. | |
server required | The BIG-IP host. You may omit this option by setting the environment variable F5_SERVER . | ||
server_port (added in 2.2) | Default: 443 | The BIG-IP server port. You may omit this option by setting the environment variable F5_SERVER_PORT . | |
shell |
| Optionally set the users shell. | |
state |
| Whether the account should exist or not, taking action if the state is different from what is stated. | |
update_password |
| 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 . | |
user 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 . | ||
username_credential required | Name of the user to create, remove or modify. The root user may not be removed.aliases: name | ||
validate_certs bool (added in 2.0) |
| 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 . |
Note
pip install f5-sdk
.- name: Add the user 'johnd' as an admin bigip_user: server: lb.mydomain.com user: admin password: secret username_credential: johnd password_credential: password full_name: John Doe partition_access: all:admin update_password: on_create state: present delegate_to: localhost - name: Change the user "johnd's" role and shell bigip_user: server: lb.mydomain.com user: admin password: secret username_credential: johnd partition_access: NewPartition:manager shell: tmsh state: present delegate_to: localhost - name: Make the user 'johnd' an admin and set to advanced shell bigip_user: server: lb.mydomain.com user: admin password: secret name: johnd partition_access: all:admin shell: bash state: present delegate_to: localhost - name: Remove the user 'johnd' bigip_user: server: lb.mydomain.com user: admin password: secret name: johnd state: absent delegate_to: localhost - name: Update password bigip_user: server: lb.mydomain.com user: admin password: secret state: present username_credential: johnd password_credential: newsupersecretpassword 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: server: lb.mydomain.com user: admin password: secret state: present username_credential: admin password_credential: NewSecretPassword delegate_to: localhost - name: Change the root user's password bigip_user: server: lb.mydomain.com user: admin password: secret username_credential: root password_credential: secret state: present 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 |
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.
For a list of other modules that are also maintained by the Ansible Community, see here.
Hint
If you notice any issues in this documentation you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/bigip_user_module.html