vultr_user – Manages users on Vultr.
vultr_user – Manages users on Vultr.
New in version 2.5.
Synopsis
- Create, update and remove users.
Aliases: vr_user
Requirements
The below requirements are needed on the host that executes this module.
- python >= 2.6
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
acls - |
|
List of ACLs this users should have, see https://www.vultr.com/api/#user_user_list. Required if One or more of the choices list, some depend on each other.
|
api_account - |
Default: "default" |
Name of the ini section in the The ENV variable |
api_enabled boolean |
|
Whether the API is enabled or not. |
api_endpoint - |
URL to API endpint (without trailing slash). The ENV variable Fallback value is https://api.vultr.com if not specified. | |
api_key - |
API key of the Vultr API. The ENV variable | |
api_retries - |
Amount of retries in case of the Vultr API retuns an HTTP 503 code. The ENV variable Fallback value is 5 retries if not specified. | |
api_timeout - |
HTTP timeout to Vultr API. The ENV variable Fallback value is 60 seconds if not specified. | |
- |
Email of the user. Required if | |
force boolean |
|
Password will only be changed with enforcement. |
name - / required |
Name of the user | |
password - |
Password of the user. Only considered while creating a user or when | |
state - |
|
State of the user. |
validate_certs boolean |
|
Validate SSL certs of the Vultr API. |
Notes
Examples
- name: Ensure a user exists
local_action:
module: vultr_user
name: john
email: [email protected]
password: s3cr3t
acls:
- upgrade
- dns
- manage_users
- subscriptions
- upgrade
- name: Remove a user
local_action:
module: vultr_user
name: john
state: absent
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | |
---|---|---|---|
vultr_api complex |
success |
Response from Vultr API with a few additions/modification
| |
api_account string |
success |
Account used in the ini file to select the key
Sample: default | |
api_endpoint string |
success |
Endpoint used for the API requests
Sample: | |
api_retries integer |
success |
Amount of max retries for the API requests
Sample: 5 | |
api_timeout integer |
success |
Timeout used for the API requests
Sample: 60 | |
vultr_user complex |
success |
Response from Vultr API
| |
acls list |
success |
List of ACLs of the user.
Sample: ['manage_users', 'support', 'upgrade'] | |
api_enabled boolean |
success |
Whether the API is enabled or not.
Sample: True | |
api_key string |
only after resource was created |
API key of the user.
Sample: 567E6K567E6K567E6K567E6K567E6K | |
string |
success |
Email of the user.
Sample: | |
id string |
success |
ID of the user.
Sample: 5904bc6ed9234 | |
name string |
success |
Name of the user.
Sample: john |
Status
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors
- René Moser (@resmo)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/vultr_user_module.html