ngine_io.vultr.vultr_user_info – Получить информацию о пользователе Vultr.
Примечание
Этот плагин входит в состав коллекции ngine_io.vultr (версия 1.0.0).
Для его установки используйте: ansible-galaxy collection install ngine_io.vultr.
Для использования в книге задач укажите: ngine_io.vultr.vultr_user_info.
Новое в версии 0.1.0: of 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 список / элементы=строка | успех | Список разрешений доступа (ACL) пользователя. Пример: ['manage_users', 'support', 'upgrade'] | |
| api_enabled булево | успех | Включен ли API или нет. Пример: True | |
| api_key строка | только после создания ресурса | Ключ API пользователя. Пример: 567E6K567E6K567E6K567E6K567E6K | |
| email строка | успех | Электронная почта пользователя. Пример: john@example.com | |
| id строка | успех | Идентификатор пользователя. Пример: 5904bc6ed9234 | |
| name строка | успех | Имя пользователя. Пример: john | |
Авторы
- 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.10/collections/ngine_io/vultr/vultr_user_info_module.html
