vultr.cloud.user module – Manages users on Vultr
Note
This module is part of the vultr.cloud collection (version 1.13.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 vultr.cloud
.
To use it in a playbook, specify: vultr.cloud.user
.
New in vultr.cloud 1.0.0
Synopsis
Create, update and remove users.
Parameters
Parameter |
Comments |
---|---|
List of ACLs this users should have. Required if One or more of the choices list, some depend on each other. Choices:
|
|
Whether the API is enabled or not. Choices:
|
|
URL to API endpint (without trailing slash). Fallback environment variable Default: |
|
API key of the Vultr API. Fallback environment variable |
|
Amount of retries in case of the Vultr API retuns an HTTP error code, such as - 429 Too Many Requests - 500 Internal Server Error - 504 Gateway Time-out Fallback environment variable Default: |
|
Retry backoff delay in seconds is exponential up to this max. value, in seconds. Fallback environment variable Default: |
|
HTTP timeout to Vultr API. Fallback environment variable Default: |
|
Email of the user. Required if |
|
Password will only be changed with enforcement. Choices:
|
|
Name of the user |
|
Password of the user. Only considered while creating a user or when |
|
State of the user. Choices:
|
|
Validate SSL certs of the Vultr API. Choices:
|
Notes
Note
Also see the API documentation on https://www.vultr.com/api/.
Examples
- name: Ensure a user exists
vultr.cloud.user:
name: john
email: [email protected]
password: s3cr3t
acls:
- manage_users
- subscriptions
- name: Remove a user
vultr.cloud.user:
name: john
state: absent
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Response from Vultr API with a few additions/modification. Returned: success |
|
Endpoint used for the API requests. Returned: success Sample: |
|
Amount of max retries for the API requests. Returned: success Sample: |
|
Exponential backoff delay in seconds between retries up to this max delay value. Returned: success Sample: |
|
Timeout used for the API requests. Returned: success Sample: |
|
Response from Vultr API. Returned: success |
|
List of ACLs of the user. Returned: success Sample: |
|
Whether the API is enabled or not. Returned: success Sample: |
|
API key of the user. Returned: only after resource was created Sample: |
|
Email of the user. Returned: success Sample: |
|
ID of the user. Returned: success Sample: |
|
Name of the user. Returned: success Sample: |