ngine_io.vultr.vultr_block_storage – Управляет томами блочного хранилища на Vultr.
Примечание
Этот плагин входит в коллекцию ngine_io.vultr (версия 1.1.0).
Для его установки используйте: ansible-galaxy collection install ngine_io.vultr.
Для использования в плейбуке укажите: ngine_io.vultr.vultr_block_storage.
Новое в версии 0.1.0: из ngine_io.vultr
Обзор
- Управление томами блочного хранилища на 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 Vultr API. Переменная среды VULTR_API_KEY используется в качестве значения по умолчанию, если она определена. | |
| api_retries целое число | Количество попыток при получении кода HTTP 503 от Vultr API. Переменная среды VULTR_API_RETRIES используется в качестве значения по умолчанию, если она определена.Значение по умолчанию — 5 попыток, если не указано. | |
| api_retry_max_delay целое число | Задержка повторной попытки в секундах, экспоненциально возрастающая до максимального значения. Переменная среды VULTR_API_RETRY_MAX_DELAY используется в качестве значения по умолчанию, если она определена.Значение по умолчанию — 12 секунд. | |
| api_timeout целое число | Таймаут HTTP-запросов к Vultr API. Переменная среды VULTR_API_TIMEOUT используется в качестве значения по умолчанию, если она определена.Значение по умолчанию — 60 секунд, если не указано. | |
| attached_to_SUBID целое число | Идентификатор сервера, к которому прикреплен том. Требуется, если state — attached. Псевдонимы: attached_to_id | |
| live_attachment булево |
| Указывает, следует ли подключать/отключать том, даже если сервер не остановлен. |
| name строка / обязательно | Имя тома блочного хранилища. Псевдонимы: description, label | |
| region строка | Регион развертывания тома блочного хранилища. Требуется, если state задано. | |
| size целое число | Размер тома блочного хранилища в ГБ. Требуется, если state задано. Если он больше, чем текущий размер тома, том будет изменён. | |
| state строка |
| Состояние тома блочного хранилища. |
| validate_certs булево |
| Проверка SSL-сертификатов Vultr API. |
Примечания
Примечание
- Также обратитесь к документации API по адресу https://www.vultr.com/api/.
Примеры
- name: Ensure a block storage volume is present
ngine_io.vultr.vultr_block_storage:
name: myvolume
size: 10
region: Amsterdam
- name: Ensure a block storage volume is absent
ngine_io.vultr.vultr_block_storage:
name: myvolume
state: absent
- name: Ensure a block storage volume exists and is attached to server 114
ngine_io.vultr.vultr_block_storage:
name: myvolume
state: attached
attached_to_id: 114
size: 10
- name: Ensure a block storage volume exists and is not attached to any server
ngine_io.vultr.vultr_block_storage:
name: myvolume
state: detached
size: 10
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое | Описание | |
|---|---|---|---|
| vultr_api сложное | успех | Ответ от Vultr API с некоторыми дополнениями/изменениями | |
| api_account строка | успех | Аккаунт, используемый в файле ini для выбора ключа Пример: default | |
| api_endpoint строка | успех | Конечная точка, используемая для запросов API Пример: https://api.vultr.com | |
| api_retries целое число | успех | Максимальное количество попыток для запросов API Пример: 5 | |
| api_retry_max_delay целое число | успех | Задержка экспоненциального отката в секундах между повторными попытками до максимального значения задержки. Пример: 12 | |
| api_timeout целое число | успех | Таймаут, используемый для запросов API Пример: 60 | |
| vultr_block_storage сложное | успех | Ответ от Vultr API | |
| attached_to_id строка | успех | Идентификатор сервера, к которому прикреплен том Пример: 10194376 | |
| cost_per_month число с плавающей точкой | успех | Стоимость в месяц за том Пример: 1.0 | |
| date_created строка | успех | Дата создания тома Пример: 2017-08-26 12:47:48 | |
| id строка | успех | Идентификатор тома блочного хранилища Пример: 1234abcd | |
| name строка | успех | Имя тома Пример: ansible-test-volume | |
| region строка | успех | Регион развертывания тома Пример: New Jersey | |
| size целое число | успех | Информация о размере тома в ГБ Пример: 10 | |
| status строка | успех | Статус развертывания тома Пример: active | |
Авторы
- Yanis Guenane (@Spredzy)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/ngine_io/vultr/vultr_block_storage_module.html
