vultr_user_info – Получение информации о пользователе Vultr

Новая в версии 2.9.

Обзор
Требования
Параметры
Примечания
Примеры
Значения возврата
Статус

Обзор

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

Требования

Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.

python >= 2.6

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
api_account строка	Значение по умолчанию: "default"	Имя раздела ini в файле `vultr.ini`. Переменная среды `VULTR_API_ACCOUNT` используется в качестве значения по умолчанию, если она определена.
api_endpoint строка		URL конечной точки API (без конечного слеша). Переменная среды `VULTR_API_ENDPOINT` используется в качестве значения по умолчанию, если она определена. Значение по умолчанию — https://api.vultr.com, если не указано.
api_key строка		Ключ API Vultr API. Переменная среды `VULTR_API_KEY` используется в качестве значения по умолчанию, если она определена.
api_retries целое число		Количество попыток повтора в случае, если Vultr API возвращает код HTTP 503. Переменная среды `VULTR_API_RETRIES` используется в качестве значения по умолчанию, если она определена. Значение по умолчанию — 5 попыток повтора, если не указано.
api_retry_max_delay целое число добавлено в 2.9		Задержка экспоненциального возврата при повторных попытках в секундах до этого максимального значения. Переменная среды `VULTR_API_RETRY_MAX_DELAY` используется в качестве значения по умолчанию, если она определена. Значение по умолчанию — 12 секунд.
api_timeout целое число		Таймаут HTTP для Vultr API. Переменная среды `VULTR_API_TIMEOUT` используется в качестве значения по умолчанию, если она определена. Значение по умолчанию — 60 секунд, если не указано.
validate_certs булево	Варианты: нет да ←	Проверка сертификатов SSL Vultr API.

Примечания

Примечание

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

Примеры

- name: Get Vultr user infos
  vultr_user_info:
  register: result

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

Значения возврата

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

Ключ		Возвращаемое значение	Описание
vultr_api сложное		успех	Ответ от Vultr API с некоторыми дополнениями/изменениями
	api_account строка	успех	Аккаунт, используемый в файле ini для выбора ключа Пример: default
	api_endpoint строка	успех	Конечная точка, используемая для запросов API Пример: https://api.vultr.com
	api_retries целое число	успех	Максимальное количество повторов запросов API Пример: 5
	api_retry_max_delay целое число добавлено в 2.9	успех	Задержка экспоненциального возврата в секундах между повторными попытками до максимальной задержки. Пример: 12
	api_timeout целое число	успех	Таймаут, используемый для запросов API Пример: 60
vultr_user_info сложное		доступно	Ответ Vultr API как список
	acls список	успех	Список ACL пользователя. Пример: ['manage_users', 'support', 'upgrade']
	api_enabled булево	успех	Включен ли API или нет. Пример: True
	api_key строка	только после создания ресурса	Ключ API пользователя. Пример: 567E6K567E6K567E6K567E6K567E6K
	email строка	успех	Электронная почта пользователя. Пример: john@exmaple.com
	id строка	успех	ID пользователя. Пример: 5904bc6ed9234
	name строка	успех	Имя пользователя. Пример: john

Статус

Данному модулю не гарантируется обратная совместимость. [превью]
Этот модуль поддерживается сообществом Ansible. [сообщество]

Авторы

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

Подсказка

Если вы обнаружите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/vultr_user_info_module.html