Spec-Zone.ru › Ansible

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

Примечание

Этот модуль входит в коллекцию vultr.cloud (версия 1.14.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

string

URL конечной точки API (без завершающей косой черты).

Резервная переменная окружения VULTR_API_ENDPOINT.

По умолчанию: "https://api.vultr.com/v2"

api_key

string / обязательный

Ключ API Vultr.

Резервная переменная окружения VULTR_API_KEY.

api_results_per_page

integer

добавлено в vultr.cloud 1.14.0

При получении большого количества ресурсов укажите, сколько результатов должно возвращаться в каждом запросе к API.

Этот параметр не ограничивает общее количество возвращаемых результатов; все ресурсы возвращаются в соответствии с другими фильтрами.

Максимальное значение для API Vultr — 500.

Резервная переменная окружения VULTR_API_RESULTS_PER_PAGE.

По умолчанию: 100

api_retries

integer

Количество повторных попыток в случае, если API Vultr возвращает код ошибки HTTP, например: 429 — слишком много запросов; 500 — внутренняя ошибка сервера; 504 — истекло время ожидания ответа шлюза.

Резервная переменная окружения VULTR_API_RETRIES.

По умолчанию: 5

api_retry_max_delay

integer

Задержка между повторными попытками увеличивается экспоненциально и не превышает указанное максимальное значение в секундах.

Резервная переменная окружения VULTR_API_RETRY_MAX_DELAY.

По умолчанию: 12

api_timeout

integer

Тайм-аут HTTP-запроса к API Vultr.

Резервная переменная окружения VULTR_API_TIMEOUT.

По умолчанию: 180

validate_certs

boolean

Проверять SSL-сертификаты API Vultr.

Варианты:

  • 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

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

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

Ключ

Описание

vultr_api

dictionary

Ответ API Vultr с некоторыми дополнениями и изменениями.

Возвращается: при успехе

api_endpoint

string

Конечная точка, используемая для запросов к API.

Возвращается: при успехе

Пример: "https://api.vultr.com/v2"

api_results_per_page

integer

Количество результатов, возвращаемых в каждом запросе к API.

Возвращается: при успехе

Пример: 100

api_retries

integer

Максимальное количество повторных попыток для запросов к API.

Возвращается: при успехе

Пример: 5

api_retry_max_delay

integer

Экспоненциально увеличивающаяся задержка в секундах между повторными попытками, не превышающая указанное максимальное значение.

Возвращается: при успехе

Пример: 12

api_timeout

integer

Тайм-аут, используемый для запросов к API.

Возвращается: при успехе

Пример: 60

vultr_block_storage_info

list / elements=string

Ответ API Vultr в виде списка.

Возвращается: при успехе

attached_to_instance

string

Идентификатор экземпляра сервера, к которому подключён том.

Возвращается: при успехе

Пример: "cb676a46-66fd-4dfb-b839-443f2e6c0b60"

cost

float

Стоимость тома в месяц.

Возвращается: при успехе

Пример: 1.0

date_created

string

Дата создания тома.

Возвращается: при успехе

Пример: "2020-10-10T01:56:20+00:00"

id

string

Идентификатор тома блочного хранилища.

Возвращается: при успехе

Пример: "cb676a46-66fd-4dfb-b839-443f2e6c0b60"

label

string

Метка тома.

Возвращается: при успехе

Пример: "my volume"

mount_id

string

Идентификатор монтирования тома.

Возвращается: при успехе

Пример: "ewr-2f5d7a314fe44f"

region

string

Регион, в котором размещён том.

Возвращается: при успехе

Пример: "ewr"

size_gb

integer

Информация о размере тома в ГБ.

Возвращается: при успехе

Пример: 50

status

string

Состояние развертывания тома.

Возвращается: при успехе

Пример: "active"

Авторы

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

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

  • Отслеживание проблем
  • Репозиторий (исходный код)

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

Spec-Zone.ru

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