Модуль vultr.cloud.block_storage_info – Получение информации о блочном хранилище Vultr

Примечание

Этот модуль является частью коллекции vultr.cloud (версия 1.13.0).

У вас, возможно, уже установлена эта коллекция, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

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

Чтобы использовать его в книге задач, укажите: vultr.cloud.block_storage_info.

Новое в vultr.cloud 1.0.0

Описание
Параметры
Примечания
Примеры
Возвращаемые значения

Описание

Получение информации о доступных блочных хранилищах.

Параметры

Параметр	Комментарии
api_endpoint строка	URL конечной точки API (без конечного слэша). Обращается к переменной среды `VULTR_API_ENDPOINT`. По умолчанию: `"https://api.vultr.com/v2"`
api_key строка / обязательно	Ключ API для Vultr API. Обращается к переменной среды `VULTR_API_KEY`.
api_retries целое число	Количество попыток при возврате кода HTTP ошибки Vultr API, например: - 429 Слишком много запросов - 500 Внутренняя ошибка сервера - 504 Истечение времени ожидания шлюза Обращается к переменной среды `VULTR_API_RETRIES`. По умолчанию: `5`
api_retry_max_delay целое число	Задержка отката при повторных попытках в секундах, экспоненциально увеличивающаяся до этого максимального значения. Обращается к переменной среды `VULTR_API_RETRY_MAX_DELAY`. По умолчанию: `12`
api_timeout целое число	Таймаут HTTP для Vultr API. Обращается к переменной среды `VULTR_API_TIMEOUT`. По умолчанию: `180`
validate_certs логическое значение	Проверка SSL-сертификатов Vultr API. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

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

Примеры

- name: Get Vultr block_storage infos
  vultr.cloud.block_storage_info:
  register: result

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

END_OF_DOCUMENT_MARKER

Значения возврата

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

Ключ	Описание
vultr_api словарь	Ответ от API Vultr с некоторыми дополнениями/изменениями. Возвращено: успешно
api_endpoint строка	Точка входа, используемая для запросов API. Возвращено: успешно Пример: `"https://api.vultr.com/v2"`
api_retries целое число	Максимальное количество повторных попыток для запросов API. Возвращено: успешно Пример: `5`
api_retry_max_delay целое число	Время экспоненциального замедления в секундах между повторными попытками до этого максимального значения. Возвращено: успешно Пример: `12`
api_timeout целое число	Таймаут, используемый для запросов API. Возвращено: успешно Пример: `60`
vultr_block_storage_info список / элементы=строка	Ответ от API Vultr в виде списка. Возвращено: успешно
attached_to_instance строка	ID серверного экземпляра, к которому прикреплен том. Возвращено: успешно Пример: `"cb676a46-66fd-4dfb-b839-443f2e6c0b60"`
cost вещественное число	Стоимость тома в месяц. Возвращено: успешно Пример: `1.0`
date_created строка	Дата создания тома. Возвращено: успешно Пример: `"2020-10-10T01:56:20+00:00"`
id строка	ID тома блочного хранилища. Возвращено: успешно Пример: `"cb676a46-66fd-4dfb-b839-443f2e6c0b60"`
label строка	Метка тома. Возвращено: успешно Пример: `"my volume"`
mount_id строка	ID подмонтирования тома. Возвращено: успешно Пример: `"ewr-2f5d7a314fe44f"`
region строка	Регион развертывания тома. Возвращено: успешно Пример: `"ews"`
size_gb целое число	Информация о размере тома в ГБ. Возвращено: успешно Пример: `50`
status строка	Статус развертывания тома. Возвращено: успешно Пример: `"active"`

Авторы

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

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/vultr/cloud/block_storage_info_module.html