vultr_user_facts – Сбор фактов о пользователе Vultr
Новое в версии 2.7.
УСТАРЕВШЕЕ
| Удалено в Ansible: | |
|---|---|
| версия: 2.12 | |
| Почему: | Преобразовано в модуль информации. |
| Альтернатива: | Используйте vultr_user_info вместо этого. |
Описание
- Сбор фактов о пользователях, доступных в 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: Gather Vultr user facts
local_action:
module: vultr_user_facts
- name: Print the gathered facts
debug:
var: ansible_facts.vultr_user_facts
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращено | Описание | |
|---|---|---|---|
| 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_facts
сложный
|
успех | Ответ от Vultr API Пример: {'vultr_user_facts': [{'acls': [], 'api_enabled': 'да', 'email': 'mytestuser@example.com', 'id': 'a235b4f45e87f', 'name': 'mytestuser'}]} |
|
Статус
- Этот модуль будет удален в версии 2.12. [устаревший]
- Дополнительную информацию см. в разделе УСТАРЕВШЕЕ.
Авторы
- Yanis Guenane (@Spredzy)
Подсказка
Если вы обнаружите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 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_facts_module.html
