ngine_io.vultr.vultr_block_storage – Управляет томами блочного хранения на Vultr.
Примечание
Этот плагин входит в коллекцию ngine_io.vultr (версия 1.0.0).
Для его установки используйте: ansible-galaxy collection install ngine_io.vultr.
Для использования в книге задач укажите: ngine_io.vultr.vultr_block_storage.
Добавлено в версии 0.1.0: of 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 целое число | Количество попыток повторного выполнения в случае, если Vultr API возвращает код HTTP 503. Переменная среды VULTR_API_RETRIES используется в качестве значения по умолчанию, если она определена.Значение по умолчанию — 5 попыток повторного выполнения, если не указано. | |
| api_retry_max_delay целое число | Задержка экспоненциального отката при повторном выполнении в секундах до максимального значения. Переменная среды VULTR_API_RETRY_MAX_DELAY используется в качестве значения по умолчанию, если она определена.Значение по умолчанию — 12 секунд, если не указано. | |
| api_timeout целое число | Таймаут HTTP для Vultr API. Переменная среды VULTR_API_TIMEOUT используется в качестве значения по умолчанию, если она определена.Значение по умолчанию — 60 секунд, если не указано. | |
| name строка / обязательно | Имя тома блочного хранения. псевдонимы: описание, метка | |
| 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
Возвращаемые значения
Общие возвращаемые значения описаны в разделе здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание | |
|---|---|---|---|
| vultr_api сложный | success | Ответ от Vultr API с несколькими дополнениями/изменениями | |
| api_account строка | success | Аккаунт, используемый в файле ini для выбора ключа Пример: default | |
| api_endpoint строка | success | Конечная точка, используемая для запросов API Пример: https://api.vultr.com | |
| api_retries целое число | success | Максимальное количество попыток повторного выполнения запросов API Пример: 5 | |
| api_retry_max_delay целое число | success | Экспоненциальная задержка отката при повторном выполнении в секундах до максимального значения задержки. Пример: 12 | |
| api_timeout целое число | success | Таймаут, используемый для запросов API Пример: 60 | |
| vultr_block_storage сложный | success | Ответ от Vultr API | |
| attached_to_id строка | success | Идентификатор сервера, к которому прикреплен том Пример: 10194376 | |
| cost_per_month вещественное число | success | Стоимость за месяц использования тома Пример: 1.0 | |
| date_created строка | success | Дата создания тома Пример: 2017-08-26 12:47:48 | |
| id строка | success | Идентификатор тома блочного хранения Пример: 1234abcd | |
| name строка | success | Имя тома Пример: ansible-test-volume | |
| region строка | success | Регион развертывания тома Пример: Новый Джерси | |
| size целое число | success | Информация о размере тома в ГБ Пример: 10 | |
| status строка | success | Статус развертывания тома Пример: active | |
Авторы
- 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.10/collections/ngine_io/vultr/vultr_block_storage_module.html
