vultr_block_storage – Управление томами блочного хранилища на Vultr
Новая версия с 2.7.
Обзор
- Управление томами блочного хранилища на 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 для API Vultr. Переменная окружения VULTR_API_KEY используется в качестве значения по умолчанию, если она определена. | |
| api_retries целое число | Количество попыток в случае, если API Vultr возвращает код HTTP 503. Переменная окружения VULTR_API_RETRIES используется в качестве значения по умолчанию, если она определена.Значение по умолчанию — 5 попыток, если не указано. | |
| api_timeout целое число | Таймаут HTTP-запросов к API Vultr. Переменная окружения VULTR_API_TIMEOUT используется в качестве значения по умолчанию, если она определена.Значение по умолчанию — 60 секунд, если не указано. | |
| name - / обязательно | Имя тома блочного хранилища. псевдонимы: описание, метка | |
| region - / обязательно | Регион, в котором развернут том блочного хранилища. | |
| size - / обязательно | Размер тома блочного хранилища в ГБ. | |
| state - |
| Состояние тома блочного хранилища. |
| validate_certs булево |
| Проверять SSL-сертификаты API Vultr. |
Примечания
Примечание
- Также см. документацию API по адресу https://www.vultr.com/api/.
Примеры
- name: Ensure a block storage volume is present
local_action:
module: vultr_block_storage
name: myvolume
size: 10
region: Amsterdam
- name: Ensure a block storage volume is absent
local_action:
module: vultr_block_storage
name: myvolume
state: absent
Возвращаемые значения
Общие значения, возвращаемые модулем, описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание | |
|---|---|---|---|
| vultr_api сложный | успех | Ответ от API Vultr с некоторыми добавленными/измененными параметрами | |
| api_account строка | успех | Аккаунт, используемый в файле ini для выбора ключа Пример: default | |
| api_endpoint строка | успех | Конечная точка, используемая для запросов API Пример: https://api.vultr.com | |
| api_retries целое число | успех | Максимальное количество попыток для запросов API Пример: 5 | |
| api_timeout целое число | успех | Таймаут, используемый для запросов API Пример: 60 | |
| vultr_block_storage сложный | успех | Ответ от API Vultr | |
| attached_to_id строка | успех | Идентификатор сервера, к которому подключен том Пример: 10194376 | |
| cost_per_month вещественное число | успех | Стоимость в месяц за том Пример: 1.0 | |
| date_created строка | успех | Дата создания тома Пример: 2017-08-26 12:47:48 | |
| id строка | успех | Идентификатор тома блочного хранилища Пример: 1234abcd | |
| name строка | успех | Имя тома Пример: ansible-test-volume | |
| region строка | успех | Регион, в котором развернут том Пример: Нью-Джерси | |
| size целое число | успех | Информация о размере тома в ГБ Пример: 10 | |
| status строка | успех | Состояние развертывания тома Пример: активный | |
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [сообщество]
Авторы
- Yanis Guenane (@Spredzy)
Подсказка
Если вы заметите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/vultr_block_storage_module.html
