Spec-Zone.ru › Ansible 2.11

ngine_io.vultr.vultr_block_storage_info – Получение информации о доступных томах хранилища блоков Vultr.

Примечание

Этот плагин входит в коллекцию ngine_io.vultr (версия 1.1.0).

Для его установки используйте: ansible-galaxy collection install ngine_io.vultr.

Для использования в плейбуке укажите: ngine_io.vultr.vultr_block_storage_info.

Добавлен в версии 0.1.0: of ngine_io.vultr

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

Обзор

  • Получение информации о доступных томах хранилища блоков в 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
булево
    Варианты:
  • no
  • yes ←
Проверка SSL-сертификатов Vultr API.

Примечания

Примечание

  • Также см. документацию API по адресу https://www.vultr.com/api/.

Примеры

- name: Get Vultr block storage infos
  ngine_io.vultr.vultr_block_storage_info:
  register: result

- name: Print the infos
  debug:
    var: result.vultr_block_storage_info

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

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

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

attached_to_id
строка
успех
Хранилище блоков подключено к этому идентификатору сервера.

cost_per_month
вещественное число
успех
Стоимость хранения блоков в месяц.

Пример:
1.0
date_created
строка
успех
Дата создания хранилища блоков.

Пример:
2018-07-24 12:59:59
id
целое число
успех
Идентификатор хранилища блоков.

Пример:
17332323
name
строка
успех
Название хранилища блоков.

Пример:
мой том
region
строка
успех
Регион расположения хранилища блоков.

Пример:
Новый Джерси
size
целое число
успех
Размер хранилища блоков в ГБ.

Пример:
10
status
строка
успех
Статус хранилища блоков.

Пример:
активный


Авторы

  • Yanis Guenane (@Spredzy)
  • René Moser (@resmo)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/ngine_io/vultr/vultr_block_storage_info_module.html

Spec-Zone.ru

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