Spec-Zone.ru › Ansible 2.9

vultr_plan_info – Сбор информации о доступных планах Vultr

Новое в версии 2.9.

  • Описание
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения
  • Статус

Описание

  • Сбор информации о доступных планах для загрузки серверов.

Требования

Ниже перечислены требования к хосту, на котором выполняется этот модуль.

  • 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
целое число
Количество попыток при получении кода HTTP 503 от Vultr API.
Переменная среды 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 plans information
  local_action:
    module: vultr_plan_info
  register: result

- name: Print the gathered information
  debug:
    var: result.vultr_plan_info

Возвращаемые значения

Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:

Ключ Возвращено Описание
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_plan_info
сложное
успех
Ответ от Vultr API

plan
список
успех
Список доступных планов.

Пример:
[{'available_locations': [1], 'bandwidth': 40.0, 'bandwidth_gb': 40960, 'disk': 110, 'id': 118, 'name': '32768 МБ ОЗУ, 110 ГБ SSD, 40,00 ТБ пропускной способности', 'plan_type': 'DEDICATED', 'price_per_month': 240.0, 'ram': 32768, 'vcpu_count': 8, 'windows': False}]


Статус

  • Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
  • Этот модуль поддерживается сообществом Ansible. [сообщество]

Авторы

  • 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_plan_info_module.html

Spec-Zone.ru

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