vultr_block_storage_info – Получение информации о доступных томах хранилища блоков Vultr
Новое в версии 2.9.
Обзор
- Получение информации о доступных томах хранилища блоков в 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-ключ API Vultr. Переменная среды VULTR_API_KEY используется в качестве значения по умолчанию, если она определена. | |
| api_retries целое число | Количество попыток повторного выполнения в случае, если API Vultr возвращает код HTTP 503. Переменная среды VULTR_API_RETRIES используется в качестве значения по умолчанию, если она определена.Значение по умолчанию — 5 попыток, если не указано. | |
| api_retry_max_delay целое число добавлено в 2.9 | Задержка экспоненциального возврата при повторном выполнении в секундах, до максимального значения. Переменная среды VULTR_API_RETRY_MAX_DELAY используется в качестве значения по умолчанию, если она определена.Значение по умолчанию — 12 секунд. | |
| api_timeout целое число | Таймаут HTTP для API Vultr. Переменная среды VULTR_API_TIMEOUT используется в качестве значения по умолчанию, если она определена.Значение по умолчанию — 60 секунд, если не указано. | |
| validate_certs логическое |
| Проверка SSL-сертификатов API Vultr. |
Примечания
Примечание
- См. также документацию API на https://www.vultr.com/api/.
Примеры
- name: Get Vultr block storage infos
vultr_block_storage_info:
register: result
- name: Print the infos
debug:
var: result.vultr_block_storage_info
Возвращаемые значения
Общие возвращаемые значения описаны здесь, а следующие поля уникальны для этого модуля:
| Ключ | Возвращается | Описание | |
|---|---|---|---|
| vultr_api сложное | успех | Ответ от API Vultr с несколькими дополнениями/изменениями | |
| 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_block_storage_info сложное | успех | Ответ от API Vultr в виде списка | |
| attached_to_id строка | успех | Хранилище блоков подключено к этому идентификатору сервера. | |
| cost_per_month число с плавающей точкой | успех | Стоимость хранилища блоков в месяц. Пример: 1.0 | |
| date_created строка | успех | Дата создания хранилища блоков. Пример: 2018-07-24 12:59:59 | |
| id целое число | успех | Идентификатор хранилища блоков. Пример: 17332323 | |
| name строка | успех | Имя хранилища блоков. Пример: my volume | |
| region строка | успех | Регион, в котором расположено хранилище блоков. Пример: Новый Джерси | |
| size целое число | успех | Размер хранилища блоков в ГБ. Пример: 10 | |
| status строка | успех | Статус хранилища блоков. Пример: активный | |
Статус
- Данный модуль не гарантирует обратной совместимости интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- 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.9/modules/vultr_block_storage_info_module.html