Модуль vultr.cloud.user_info — получение информации о пользователях Vultr

Примечание

Этот модуль входит в коллекцию vultr.cloud (версия 1.14.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните команду ansible-galaxy collection list.

Чтобы установить её, используйте: ansible-galaxy collection install vultr.cloud.

Чтобы использовать её в плейбуке, укажите: vultr.cloud.user_info.

Добавлено в vultr.cloud 1.0.0

Краткое описание
Параметры
Примечания
Примеры
Возвращаемые значения

Краткое описание

Получение информации о доступных пользователях.

Параметры

Параметр	Комментарии
api_endpoint string	URL конечной точки API (без завершающей косой черты). Резервная переменная окружения `VULTR_API_ENDPOINT`. По умолчанию: `"https://api.vultr.com/v2"`
api_key string / обязательный	Ключ API Vultr. Резервная переменная окружения `VULTR_API_KEY`.
api_results_per_page integer добавлено в vultr.cloud 1.14.0	При получении большого количества ресурсов укажите, сколько результатов возвращать за один вызов API. Этот параметр не определяет общее количество возвращаемых результатов; все ресурсы возвращаются с учётом других фильтров. Максимальное значение для API Vultr — 500. Резервная переменная окружения `VULTR_API_RESULTS_PER_PAGE`. По умолчанию: `100`
api_retries integer	Количество повторных попыток в случае, если API Vultr возвращает код ошибки HTTP, например: 429 Too Many Requests, 500 Internal Server Error или 504 Gateway Time-out. Резервная переменная окружения `VULTR_API_RETRIES`. По умолчанию: `5`
api_retry_max_delay integer	Задержка между повторными попытками увеличивается экспоненциально, но не превышает указанное максимальное значение в секундах. Резервная переменная окружения `VULTR_API_RETRY_MAX_DELAY`. По умолчанию: `12`
api_timeout integer	Тайм-аут HTTP-запроса к API Vultr. Резервная переменная окружения `VULTR_API_TIMEOUT`. По умолчанию: `180`
validate_certs boolean	Проверять сертификаты SSL API Vultr. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

Также см. документацию API: https://www.vultr.com/api/.

Примеры

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

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

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:

Ключ	Описание
vultr_api dictionary	Ответ API Vultr с несколькими дополнениями и изменениями. Возвращается: success
api_endpoint string	Конечная точка, используемая для запросов API. Возвращается: success Пример: `"https://api.vultr.com/v2"`
api_results_per_page integer	Количество результатов, возвращаемых за один вызов API. Возвращается: success Пример: `100`
api_retries integer	Максимальное количество повторных попыток для запросов API. Возвращается: success Пример: `5`
api_retry_max_delay integer	Максимальная задержка в секундах при экспоненциальном увеличении интервала между повторными попытками. Возвращается: success Пример: `12`
api_timeout integer	Тайм-аут, используемый для запросов API. Возвращается: success Пример: `60`
vultr_user_info list / элементы=string	Ответ API Vultr в виде списка. Возвращается: available
acls list / элементы=string	Список ACL пользователя. Возвращается: success Пример: `["manage_users", "support", "upgrade"]`
api_enabled boolean	Включён ли API. Возвращается: success Пример: `true`
api_key string	Ключ API пользователя. Возвращается: только после создания ресурса Пример: `"567E6K567E6K567E6K567E6K567E6K"`
email string	Адрес электронной почты пользователя. Возвращается: success Пример: `"john@example.com"`
id string	ID пользователя. Возвращается: success Пример: `"7d726ffe-9be2-4f88-8cda-fa7eba1da2b5"`
name string	Имя пользователя. Возвращается: success Пример: `"john"`

Авторы

Yanis Guenane (@Spredzy)
René Moser (@resmo)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/vultr/cloud/user_info_module.html