Модуль vultr.cloud.block_storage — управление блочными томами хранения в Vultr

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install vultr.cloud.

Чтобы использовать её в плейбуке, укажите: vultr.cloud.block_storage.

Добавлено в 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_results_per_page целое число добавлено в vultr.cloud 1.14.0	При получении большого количества ресурсов укажите, сколько результатов должно возвращаться при каждом запросе к API. Этот параметр не определяет общее количество возвращаемых результатов: возвращаются все ресурсы, соответствующие другим фильтрам. Максимальное значение для Vultr API — 500. Резервная переменная окружения `VULTR_API_RESULTS_PER_PAGE`. По умолчанию: `100`
api_retries целое число	Количество повторных попыток в случае, если Vultr API возвращает код ошибки HTTP, например: - 429 Too Many Requests - 500 Internal Server Error - 504 Gateway Time-out Резервная переменная окружения `VULTR_API_RETRIES`. По умолчанию: `5`
api_retry_max_delay целое число	Задержка между повторными попытками увеличивается экспоненциально до указанного максимального значения (в секундах). Резервная переменная окружения `VULTR_API_RETRY_MAX_DELAY`. По умолчанию: `12`
api_timeout целое число	Тайм-аут HTTP-запроса к Vultr API. Резервная переменная окружения `VULTR_API_TIMEOUT`. По умолчанию: `180`
attached_to_instance строка	Идентификатор экземпляра сервера, к которому подключён том.
block_type строка добавлено в vultr.cloud 1.2.0	Тип создаваемого блочного тома хранения. Варианты: `"high_perf"` ← (по умолчанию) `"storage_opt"`
label псевдонимы: name строка / обязательный	Имя блочного тома хранения.
live логическое значение	Следует ли подключать или отключать том без перезапуска экземпляра. Варианты: `false` ← (по умолчанию) `true`
region строка	Регион, в котором размещён блочный том хранения. Обязательный, если указан state.
size_gb псевдонимы: size целое число	Размер блочного тома хранения в ГБ. Обязательный, если указан state. Если размер превышает текущий размер тома, размер тома будет увеличен.
state строка	Состояние блочного тома хранения. Варианты: `"present"` ← (по умолчанию) `"absent"`
validate_certs логическое значение	Проверять сертификаты SSL для Vultr API. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

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

Примеры

---
- name: Ensure a block storage volume is present
  vultr.cloud.block_storage:
    name: myvolume
    size_gb: 10
    block_type: storage_opt
    region: ams

- name: Ensure a block storage volume is absent
  vultr.cloud.block_storage:
    name: myvolume
    state: absent

- name: Ensure a block storage volume exists and is attached a server instance
  vultr.cloud.block_storage:
    name: myvolume
    attached_to_instance: cb676a46-66fd-4dfb-b839-443f2e6c0b60
    size_gb: 50
    block_type: high_perf

- name: Ensure a block storage volume exists but is not attached to any server instance
  vultr.cloud.block_storage:
    name: myvolume
    attached_to_instance: ""
    size_gb: 50
    block_type: high_perf

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

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

Ключ	Описание
vultr_api словарь	Ответ Vultr API с несколькими дополнениями и изменениями. Возвращается: при успехе
api_account строка	Учётная запись, указанная в ini-файле для выбора ключа. Возвращается: при успехе Пример: `"default"`
api_endpoint строка	Конечная точка, используемая для запросов к API. Возвращается: при успехе Пример: `"https://api.vultr.com/v2"`
api_results_per_page целое число	Количество результатов, возвращаемых при каждом запросе к API. Возвращается: при успехе Пример: `100`
api_retries целое число	Максимальное количество повторных попыток запросов к API. Возвращается: при успехе Пример: `5`
api_retry_max_delay целое число	Максимальная задержка (в секундах) между повторными попытками с экспоненциальным увеличением интервала. Возвращается: при успехе Пример: `12`
api_timeout целое число	Тайм-аут, используемый для запросов к API. Возвращается: при успехе Пример: `60`
vultr_block_storage словарь	Ответ Vultr API. Возвращается: при успехе
attached_to_instance строка	Идентификатор экземпляра сервера, к которому подключён том. Возвращается: при успехе Пример: `"cb676a46-66fd-4dfb-b839-443f2e6c0b60"`
block_type строка	HDD или NVMe (storage_opt или high_perf) Возвращается: при успехе Пример: `"high_perf"`
cost число с плавающей точкой	Стоимость использования тома в месяц. Возвращается: при успехе Пример: `1.0`
date_created строка	Дата создания тома. Возвращается: при успехе Пример: `"2020-10-10T01:56:20+00:00"`
id строка	Идентификатор блочного тома хранения. Возвращается: при успехе Пример: `"cb676a46-66fd-4dfb-b839-443f2e6c0b60"`
label строка	Метка тома. Возвращается: при успехе Пример: `"my volume"`
mount_id строка	Идентификатор точки монтирования тома. Возвращается: при успехе Пример: `"ewr-2f5d7a314fe44f"`
region строка	Регион, в котором размещён том. Возвращается: при успехе Пример: `"ewr"`
size_gb целое число	Сведения о размере тома в ГБ. Возвращается: при успехе Пример: `50`
status строка	Состояние развертывания тома. Возвращается: при успехе Пример: `"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_module.html