Модуль vultr.cloud.block_storage – Управление томами блочного хранилища на Vultr

Примечание

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

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

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

Для использования в playbook, укажите: vultr.cloud.block_storage.

Новое в vultr.cloud 1.0.0

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

Краткое описание

Управление томами блочного хранилища.

Параметры

Параметр	Комментарии
api_endpoint string	URL конечной точки API (без слеша в конце). Резервная переменная окружения `VULTR_API_ENDPOINT`. Значение по умолчанию: `"https://api.vultr.com/v2"`
api_key string / обязательно	API ключ Vultr API. Резервная переменная окружения `VULTR_API_KEY`.
api_retries integer	Количество попыток в случае, если Vultr API возвращает код HTTP ошибки, например: - 429 Too Many Requests - 500 Internal Server Error - 504 Gateway Time-out Резервная переменная окружения `VULTR_API_RETRIES`. Значение по умолчанию: `5`
api_retry_max_delay integer	Задержка повторной попытки в секундах (экспоненциальная, до этого максимального значения, в секундах). Резервная переменная окружения `VULTR_API_RETRY_MAX_DELAY`. Значение по умолчанию: `12`
api_timeout integer	Таймаут HTTP для Vultr API. Резервная переменная окружения `VULTR_API_TIMEOUT`. Значение по умолчанию: `180`
attached_to_instance string	ID серверного экземпляра, к которому подключен том.
block_type string добавлено в vultr.cloud 1.2.0	Тип тома блочного хранилища, который будет создан. Варианты: `"high_perf"` ← (по умолчанию) `"storage_opt"`
label псевдонимы: name string / обязательно	Имя тома блочного хранилища.
live boolean	Следует ли подключать/отключать том без перезагрузки экземпляра. Варианты: `false` ← (по умолчанию) `true`
region string	Регион, в котором развёрнут том блочного хранилища. Обязательно, если state присутствует.
size_gb псевдонимы: size integer	Размер тома блочного хранилища в ГБ. Обязательно, если state присутствует. Если он больше текущего размера тома, том будет изменён в размере.
state string	Состояние тома блочного хранилища. Варианты: `"present"` ← (по умолчанию) `"absent"`
validate_certs boolean	Проверять 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 словарь	Ответ от API Vultr с некоторыми дополнениями/изменениями. Возвращено: success
api_account строка	Аккаунт, используемый в файле ini для выбора ключа. Возвращено: success Пример: `"default"`
api_endpoint строка	Точка входа, используемая для запросов API. Возвращено: success Пример: `"https://api.vultr.com/v2"`
api_retries целое число	Количество максимальных попыток повтора для запросов API. Возвращено: success Пример: `5`
api_retry_max_delay целое число	Экспоненциальная задержка повторной попытки в секундах между повторами до этого максимального значения задержки. Возвращено: success Пример: `12`
api_timeout целое число	Таймаут, используемый для запросов API. Возвращено: success Пример: `60`
vultr_block_storage словарь	Ответ от API Vultr. Возвращено: success
attached_to_instance строка	Идентификатор серверного экземпляра, к которому подключен том. Возвращено: success Пример: `"cb676a46-66fd-4dfb-b839-443f2e6c0b60"`
block_type строка	HDD или NVMe (storage_opt или high_perf) Возвращено: success Пример: `"high_perf"`
cost вещественное число	Стоимость в месяц для тома. Возвращено: success Пример: `1.0`
date_created строка	Дата создания тома. Возвращено: success Пример: `"2020-10-10T01:56:20+00:00"`
id строка	Идентификатор тома блочного хранилища. Возвращено: success Пример: `"cb676a46-66fd-4dfb-b839-443f2e6c0b60"`
label строка	Метка тома. Возвращено: success Пример: `"my volume"`
mount_id строка	Идентификатор подключения тома. Возвращено: success Пример: `"ewr-2f5d7a314fe44f"`
region строка	Регион развертывания тома. Возвращено: success Пример: `"ews"`
size_gb целое число	Информация о размере тома в ГБ. Возвращено: success Пример: `50`
status строка	Статус развертывания тома. Возвращено: success Пример: `"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_module.html