vr_account_facts - Сбор фактов о счёте Vultr.
Новое в версии 2.5.
Обзор
- Сбор фактов о балансе счёта, платежах и оплатах.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- python >= 2.6
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_account | Значение по умолчанию: "default" | Имя раздела ini в файле vultr.ini.Переменная среды VULTR_API_ACCOUNT используется в качестве значения по умолчанию, если она определена. |
| api_endpoint | Значение по умолчанию: "https://api.vultr.com" | URL конечной точки API (без конечной косой черты). Переменная среды VULTR_API_ENDPOINT используется в качестве значения по умолчанию, если она определена. |
| api_key | Ключ API для Vultr API. Переменная среды VULTR_API_KEY используется в качестве значения по умолчанию, если она определена. | |
| api_retries | Значение по умолчанию: 5 | Количество попыток повторного выполнения в случае, если Vultr API возвращает код HTTP 503. Переменная среды VULTR_API_RETRIES используется в качестве значения по умолчанию, если она определена. |
| api_timeout | Значение по умолчанию: 60 | Таймаут HTTP для Vultr API. Переменная среды VULTR_API_TIMEOUT используется в качестве значения по умолчанию, если она определена. |
| validate_certs bool |
| Проверка SSL-сертификатов Vultr API. |
Примечания
Примечание
- Также см. документацию API по адресу https://www.vultr.com/api/.
Примеры
- name: Gather Vultr account facts
local_action:
module: vr_account_facts
- name: Print the gathered facts
debug:
var: ansible_facts.vultr_account_facts
Возвращаемые значения
Общие возвращаемые значения описаны здесь, а следующие — поля, уникальные для данного модуля:
| Ключ | Результат | Описание | |
|---|---|---|---|
| vultr_account_facts сложный | успех | Ответ от API Vultr | |
| balance число с плавающей точкой | успех | Баланс вашего счета. Пример: -214.69 | |
| pending_charges число с плавающей точкой | успех | Ожидаемые платежи. Пример: 57.03 | |
| last_payment_date строка | успех | Дата последнего платежа. Пример: 2017-08-26 12:47:48 | |
| last_payment_amount число с плавающей точкой | успех | Сумма последней транзакции платежа. Пример: -250.0 | |
| vultr_api сложный | успех | Ответ от API Vultr с некоторыми дополнениями/изменениями | |
| api_account строка | успех | Аккаунт, используемый в файле ini для выбора ключа Пример: default | |
| api_timeout целое число | успех | Таймаут, используемый для запросов API Пример: 60 | |
| api_retries целое число | успех | Количество максимальных попыток повторного выполнения запросов API Пример: 5 | |
| api_endpoint строка | успех | Точка входа, используемая для запросов API Пример: https://api.vultr.com | |
Статус
Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость.
Техническое обслуживание
Этот модуль помечен как сообщество, что означает, что он поддерживается сообществом Ansible. См. Техническое обслуживание и поддержка модулей для получения дополнительной информации.
Список других модулей, которые также поддерживаются сообществом Ansible, см. здесь.
Автор
- 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.6/modules/vr_account_facts_module.html