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

Примечание

Этот модуль входит в коллекцию vultr.cloud (версия 1.13.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 строка	URL конечной точки API (без конечной косой черты). По умолчанию используется переменная среды `VULTR_API_ENDPOINT`. По умолчанию: `"https://api.vultr.com/v2"`
api_key строка / обязательно	Ключ API для Vultr API. По умолчанию используется переменная среды `VULTR_API_KEY`.
api_retries целое число	Количество попыток повторного выполнения запроса в случае возвращения кода ошибки Vultr API, например, - 429 Слишком много запросов - 500 Внутренняя ошибка сервера - 504 Время ожидания прокси-сервера истекло По умолчанию используется переменная среды `VULTR_API_RETRIES`. По умолчанию: `5`
api_retry_max_delay целое число	Задержка повторной попытки в секундах, экспоненциально увеличивающаяся до максимального значения. По умолчанию используется переменная среды `VULTR_API_RETRY_MAX_DELAY`. По умолчанию: `12`
api_timeout целое число	Таймаут HTTP-запроса к Vultr API. По умолчанию используется переменная среды `VULTR_API_TIMEOUT`. По умолчанию: `180`
validate_certs логическое	Проверка SSL-сертификатов Vultr API. Варианты: `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 словарь	Ответ от API Vultr с некоторыми дополнениями/изменениями. Возвращено: успешно
api_endpoint строка	Точка входа, используемая для запросов API. Возвращено: успешно Пример: `"https://api.vultr.com/v2"`
api_retries целое число	Количество максимальных попыток повторных запросов API. Возвращено: успешно Пример: `5`
api_retry_max_delay целое число	Задержка экспоненциального возврата в секундах между повторными попытками до этого максимального значения задержки. Возвращено: успешно Пример: `12`
api_timeout целое число	Таймаут, используемый для запросов API. Возвращено: успешно Пример: `60`
vultr_user_info список / элементы=строка	Ответ от API Vultr в виде списка. Возвращено: доступно
acls список / элементы=строка	Список ACL пользователя. Возвращено: успешно Пример: `["manage_users", "support", "upgrade"]`
api_enabled логическое значение	Включен ли API или нет. Возвращено: успешно Пример: `true`
api_key строка	Ключ API пользователя. Возвращено: только после создания ресурса Пример: `"567E6K567E6K567E6K567E6K567E6K"`
email строка	Электронная почта пользователя. Возвращено: успешно Пример: `"john@example.com"`
id строка	Идентификатор пользователя. Возвращено: успешно Пример: `"7d726ffe-9be2-4f88-8cda-fa7eba1da2b5"`
name строка	Имя пользователя. Возвращено: успешно Пример: `"john"`

Авторы

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

Ссылки на сборку

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