ngine_io.vultr.vultr_block_storage_info – Получение информации о доступных томах блочного хранилища Vultr.
Примечание
Этот плагин входит в коллекцию ngine_io.vultr (версия 1.0.0).
Для его установки используйте: ansible-galaxy collection install ngine_io.vultr
Для использования в книге задач укажите: ngine_io.vultr.vultr_block_storage_info
В версии 0.1.0: модуля 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 булево |
| Проверка 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–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_block_storage_info_module.html
