Spec-Zone.ru › Ansible 2.5

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
    Варианты:
  • no
  • yes ←
Проверка 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
сложное
успех
Ответ от Vultr API

last_payment_amount
float
успех
Сумма последней транзакции оплаты.

Пример:
-250.0
balance
float
успех
Баланс вашего счета.

Пример:
-214.69
pending_charges
float
успех
Ожидаемые платежи.

Пример:
57.03
last_payment_date
строка
успех
Дата последней оплаты.

Пример:
2017-08-26 12:47:48
vultr_api
сложное
успех
Ответ от Vultr API с несколькими дополнениями/изменениями

api_endpoint
строка
успех
Конечная точка, используемая для запросов API

Пример:
https://api.vultr.com
api_timeout
целое число
успех
Таймаут, используемый для запросов API

Пример:
60
api_retries
целое число
успех
Максимальное количество попыток повторного выполнения запросов API

Пример:
5
api_account
строка
успех
Аккаунт, используемый в файле ini для выбора ключа

Пример:
default


Статус

Этот модуль помечен как превью, что означает, что его интерфейс не гарантирует обратной совместимости.

Автор

  • 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.5/modules/vr_account_facts_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API