ngine_io.vultr.vultr_account_info – Получение информации о счете Vultr.
Примечание
Этот плагин входит в состав коллекции ngine_io.vultr (версия 1.0.0).
Для его установки используйте: ansible-galaxy collection install ngine_io.vultr.
Для использования в playbook, укажите: ngine_io.vultr.vultr_account_info.
Введено в версии 0.1.0: плагина ngine_io.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 account infos
ngine_io.vultr.vultr_account_info:
register: result
- name: Print the infos
debug:
var: result.vultr_account_info
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание | |
|---|---|---|---|
| vultr_account_info сложный | успех | Ответ от Vultr API | |
| balance вещественное число | успех | Баланс вашего счета. Пример: -214.69 | |
| last_payment_amount вещественное число | успех | Сумма последней транзакции платежа. Пример: -250.0 | |
| last_payment_date строка | успех | Дата последнего платежа. Пример: 2017-08-26 12:47:48 | |
| pending_charges вещественное число | успех | Ожидаемые платежи. Пример: 57.03 | |
| 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 | |
Авторы
- 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_account_info_module.html
