vultr_user – Manages users on Vultr¶
New in version 2.5.
Requirements¶
The below requirements are needed on the host that executes this module.
- python >= 2.6
Parameters¶
| Parameter | Choices/Defaults | Comments | 
|---|---|---|
| acls 
                    list
                                                                 | 
 | 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 
                    string
                                                                 | Default: "default" | Name of the ini section in the  vultr.inifile.The ENV variable  VULTR_API_ACCOUNTis used as default, when defined. | 
| api_enabled 
                    boolean
                                                                 | 
 | Whether the API is enabled or not. | 
| api_endpoint 
                    string
                                                                 | URL to API endpint (without trailing slash). The ENV variable  VULTR_API_ENDPOINTis used as default, when defined.Fallback value is https://api.vultr.com if not specified. | |
| api_key 
                    string
                                                                 | API key of the Vultr API. The ENV variable  VULTR_API_KEYis used as default, when defined. | |
| api_retries 
                    integer
                                                                 | Amount of retries in case of the Vultr API retuns an HTTP 503 code. The ENV variable  VULTR_API_RETRIESis used as default, when defined.Fallback value is 5 retries if not specified. | |
| api_retry_max_delay 
                    integer
                                                                 added in 2.9 | Retry backoff delay in seconds is exponential up to this max. value, in seconds. The ENV variable  VULTR_API_RETRY_MAX_DELAYis used as default, when defined.Fallback value is 12 seconds. | |
| api_timeout 
                    integer
                                                                 | HTTP timeout to Vultr API. The ENV variable  VULTR_API_TIMEOUTis used as default, when defined.Fallback value is 60 seconds if not specified. | |
| email 
                    string
                                                                 | Email of the user. Required if  state=present. | |
| force 
                    boolean
                                                                 | 
 | Password will only be changed with enforcement. | 
| name 
                    string
                                             / required                     | Name of the user | |
| password 
                    string
                                                                 | Password of the user. Only considered while creating a user or when  force=yes. | |
| state 
                    string
                                                                 | 
 | State of the user. | 
| validate_certs 
                    boolean
                                                                 | 
 | 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:
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)
Hint
If you notice any issues in this documentation, you can edit this document to improve it.
