ngine_io.vultr.vultr_user – Manages users on Vultr.
Note
This plugin is part of the ngine_io.vultr collection (version 1.1.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 ngine_io.vultr
.
To use it in a playbook, specify: ngine_io.vultr.vultr_user
.
New in version 0.1.0: of ngine_io.vultr
Requirements
The below requirements are needed on the host that executes this module.
python >= 2.6
Parameters
Parameter |
Comments |
---|---|
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. Choices:
|
|
Name of the ini section in the The ENV variable Default: “default” |
|
Whether the API is enabled or not. Choices:
|
|
URL to API endpint (without trailing slash). The ENV variable Fallback value is https://api.vultr.com if not specified. |
|
API key of the Vultr API. The ENV variable |
|
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. |
|
Retry backoff delay in seconds is exponential up to this max. value, in seconds. The ENV variable Fallback value is 12 seconds. |
|
HTTP timeout to Vultr API. The ENV variable Fallback value is 60 seconds if not specified. |
|
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
ngine_io.vultr.vultr_user:
name: john
email: [email protected]
password: s3cr3t
acls:
- upgrade
- dns
- manage_users
- subscriptions
- upgrade
- name: Remove a user
ngine_io.vultr.vultr_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 |
|
Account used in the ini file to select the key Returned: success Sample: “default” |
|
Amount of max retries for the API requests Returned: success Sample: 5 |
|
Exponential backoff delay in seconds between retries up to this max delay value. Returned: success Sample: 12 |
|
Timeout used for the API requests Returned: success Sample: 60 |
|
Response from Vultr API Returned: success |
|
List of ACLs of the user. Returned: success Sample: [“manage_users”, “support”, “upgrade”] |
|
Whether the API is enabled or not. Returned: success Sample: true |
|
API key of the user. Returned: only after resource was created Sample: “567E6K567E6K567E6K567E6K567E6K” |
|
ID of the user. Returned: success Sample: “5904bc6ed9234” |
|
Name of the user. Returned: success Sample: “john” |
Authors
René Moser (@resmo)