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

Примечание

Этот плагин входит в коллекцию ngine_io.vultr (версия 1.1.0).

Для его установки используйте: ansible-galaxy collection install ngine_io.vultr.

Для использования в playbook, укажите: ngine_io.vultr.vultr_user_info.

Новое в версии 0.1.0: модуль ngine_io.vultr

Обзор
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

Получение информации о доступных пользователях 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 целое число		Задержка повторного выполнения (экспоненциально возрастающая) до максимального значения в секундах. Переменная среды `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
  ngine_io.vultr.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 целое число	успех	Задержка повторных попыток (экспоненциально возрастающая) до максимальной задержки в секундах. Пример: 12
	api_timeout целое число	успех	Таймаут для запросов API Пример: 60
vultr_user_info сложный тип		доступно	Ответ от Vultr API в виде списка
	acls список / элементы=строка	успех	Список ACLs пользователя. Пример: ['manage_users', 'support', 'upgrade']
	api_enabled логическое	успех	Включен ли API или нет. Пример: True
	api_key строка	только после создания ресурса	Ключ API пользователя. Пример: 567E6K567E6K567E6K567E6K567E6K
	email строка	успех	Электронная почта пользователя. Пример: john@example.com
	id строка	успех	ID пользователя. Пример: 5904bc6ed9234
	name строка	успех	Имя пользователя. Пример: john

Авторы

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

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/ngine_io/vultr/vultr_user_info_module.html