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
state=present .One or more of the choices list, some depend on each other.
aliases: acl |
api_account |
Default: default
|
Name of the ini section in the
vultr.ini file.The ENV variable
VULTR_API_ACCOUNT is used as default, when defined. |
api_enabled
bool |
|
Whether the API is enabled or not.
|
api_endpoint |
URL to API endpint (without trailing slash).
The ENV variable
VULTR_API_ENDPOINT is used as default, when defined.Fallback value is https://api.vultr.com if not specified.
|
|
api_key |
API key of the Vultr API.
The ENV variable
VULTR_API_KEY is used as default, when defined. |
|
api_retries |
Amount of retries in case of the Vultr API retuns an HTTP 503 code.
The ENV variable
VULTR_API_RETRIES is used as default, when defined.Fallback value is 5 retries if not specified.
|
|
api_timeout |
HTTP timeout to Vultr API.
The ENV variable
VULTR_API_TIMEOUT is used as default, when defined.Fallback value is 60 seconds if not specified.
|
|
Email of the user.
Required if
state=present . |
||
force
bool |
|
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
force=yes . |
|
state |
|
State of the user.
|
validate_certs
bool |
|
Validate SSL certs of the Vultr API.
|
Notes¶
Note
- Also see the API documentation on https://www.vultr.com/api/.
Examples¶
- name: Ensure a user exists
local_action:
module: vultr_user
name: john
email: john.doe@example.com
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_endpoint
string
|
success |
Endpoint used for the API requests
Sample:
https://api.vultr.com
|
|
api_timeout
int
|
success |
Timeout used for the API requests
Sample:
60
|
|
api_retries
int
|
success |
Amount of max retries for the API requests
Sample:
5
|
|
api_account
string
|
success |
Account used in the ini file to select the key
Sample:
default
|
|
vultr_user
complex
|
success |
Response from Vultr API
|
|
acls
list
|
success |
List of ACLs of the user.
Sample:
['manage_users', 'support', 'upgrade']
|
|
name
string
|
success |
Name of the user.
Sample:
john
|
|
api_enabled
bool
|
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
|
|
id
string
|
success |
ID of the user.
Sample:
5904bc6ed9234
|
|
email
string
|
success |
Email of the user.
Sample:
john@exmaple.com
|
Status¶
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Maintenance¶
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.
Author¶
- René Moser (@resmo)
Hint
If you notice any issues in this documentation you can edit this document to improve it.