vultr.cloud.user_info module – Get information about the Vultr users

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_info.

New in vultr.cloud 1.0.0

Synopsis

  • Get infos about users available.

Parameters

Parameter

Comments

api_endpoint

string

URL to API endpint (without trailing slash).

Fallback environment variable VULTR_API_ENDPOINT.

Default: "https://api.vultr.com/v2"

api_key

string / required

API key of the Vultr API.

Fallback environment variable VULTR_API_KEY.

api_retries

integer

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 VULTR_API_RETRIES.

Default: 5

api_retry_max_delay

integer

Retry backoff delay in seconds is exponential up to this max. value, in seconds.

Fallback environment variable VULTR_API_RETRY_MAX_DELAY.

Default: 12

api_timeout

integer

HTTP timeout to Vultr API.

Fallback environment variable VULTR_API_TIMEOUT.

Default: 180

validate_certs

boolean

Validate SSL certs of the Vultr API.

Choices:

  • false

  • true ← (default)

Notes

Note

Examples

- name: Get Vultr user infos
  vultr.cloud.user_info:
  register: result

- name: Print the infos
  ansible.builtin.debug:
    var: result.vultr_user_info

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

vultr_api

dictionary

Response from Vultr API with a few additions/modification.

Returned: success

api_endpoint

string

Endpoint used for the API requests.

Returned: success

Sample: "https://api.vultr.com/v2"

api_retries

integer

Amount of max retries for the API requests.

Returned: success

Sample: 5

api_retry_max_delay

integer

Exponential backoff delay in seconds between retries up to this max delay value.

Returned: success

Sample: 12

api_timeout

integer

Timeout used for the API requests.

Returned: success

Sample: 60

vultr_user_info

list / elements=string

Response from Vultr API as list.

Returned: available

acls

list / elements=string

List of ACLs of the user.

Returned: success

Sample: ["manage_users", "support", "upgrade"]

api_enabled

boolean

Whether the API is enabled or not.

Returned: success

Sample: true

api_key

string

API key of the user.

Returned: only after resource was created

Sample: "567E6K567E6K567E6K567E6K567E6K"

email

string

Email of the user.

Returned: success

Sample: "john@example.com"

id

string

ID of the user.

Returned: success

Sample: "7d726ffe-9be2-4f88-8cda-fa7eba1da2b5"

name

string

Name of the user.

Returned: success

Sample: "john"

Authors

  • Yanis Guenane (@Spredzy)

  • René Moser (@resmo)