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 Vultr. Переменная среды VULTR_API_KEY используется в качестве значения по умолчанию, если она определена. | |
| api_retries целое число | Количество попыток при возврате Vultr API кода HTTP 503. Переменная среды VULTR_API_RETRIES используется в качестве значения по умолчанию, если она определена.Значение по умолчанию — 5 попыток, если не указано иначе. | |
| api_retry_max_delay целое число добавлен в 2.9 | Задержка повторной попытки в секундах — экспоненциально увеличивается до этого максимального значения. Переменная среды VULTR_API_RETRY_MAX_DELAY используется в качестве значения по умолчанию, если она определена.Значение по умолчанию — 12 секунд. | |
| 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_retry_max_delay целое число добавлен в 2.9 | успех | Экспоненциальная задержка повторной попытки в секундах между повторами до этого максимального значения. Пример: 12 | |
| 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. [сообщество]
Авторы
- Янис Гуенан (@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.9/modules/vultr_block_storage_module.html
