ngine_io.vultr.vultr_user – Manages users on Vultr.  Note This plugin is part of the ngine_io.vultr collection (version 1.1.0). 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   Synopsis Requirements Parameters Notes Examples Return Values  Synopsis  Create, update and remove users.  Requirements The below requirements are needed on the host that executes this module.  python >= 2.6  Parameters   Parameter Choices/Defaults Comments    acls  list / elements=string    
Choices: manage_users subscriptions provisioning billing support abuse dns upgrade    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.ini file. The ENV variable VULTR_API_ACCOUNT is used as default, when defined.     api_enabled  boolean    
Choices: no 
yes ←    Whether the API is enabled or not.     api_endpoint  string      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  string      API key of the Vultr API. The ENV variable VULTR_API_KEY is 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_RETRIES is used as default, when defined. Fallback value is 5 retries if not specified.     api_retry_max_delay  integer      Retry backoff delay in seconds is exponential up to this max. value, in seconds. The ENV variable VULTR_API_RETRY_MAX_DELAY is used as default, when defined. Fallback value is 12 seconds.     api_timeout  integer      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  string      Email of the user. Required if state=present.     force  boolean    
Choices: 
no ← yes    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    
Choices: 
present ← absent    State of the user.     validate_certs  boolean    
Choices: no 
yes ←    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
  ngine_io.vultr.vultr_user:
    name: john
    email: lucasmack@example.net
    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 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: https://api.vultr.com       api_retries  integer   success  Amount of max retries for the API requests  Sample: 5       api_retry_max_delay  integer   success  Exponential backoff delay in seconds between retries up to this max delay value.  Sample: 12       api_timeout  integer   success  Timeout used for the API requests  Sample: 60     vultr_user  complex   success  Response from Vultr API        acls  list / elements=string   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       email  string   success  Email of the user.  Sample: lucasmack@example.net       id  string   success  ID of the user.  Sample: 5904bc6ed9234       name  string   success  Name of the user.  Sample: john     Authors  René Moser (@resmo) 

    © 2012–2018 Michael DeHaan
{'path': 'public/docs/ansible~2.11/collections/ngine_io/vultr/vultr_user_module.html', 'source': 'DevDocs.IO'}