Spec-Zone.ru › Ansible 2.7

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 API.
Переменная среды VULTR_API_KEY используется в качестве значения по умолчанию, если она определена.
api_retries
-
Количество попыток при возвращении кода HTTP 503 от Vultr API.
Переменная среды VULTR_API_RETRIES используется в качестве значения по умолчанию, если она определена.
Значение по умолчанию – 5 попыток, если не указано.
api_timeout
-
Таймаут HTTP для Vultr API.
Переменная среды VULTR_API_TIMEOUT используется в качестве значения по умолчанию, если она определена.
Значение по умолчанию – 60 секунд, если не указано.
name
- / обязательно
Имя тома блочного хранилища.

псевдонимы: описание, метка
region
- / обязательно
Регион, в котором развернут том блочного хранилища.
size
- / обязательно
Размер тома блочного хранилища в ГБ.
state
-
    Варианты:
  • present ←
  • absent
Состояние тома блочного хранилища.
validate_certs
boolean
    Варианты:
  • no
  • yes ←
Проверять SSL-сертификаты Vultr API.

Примечания

Примечание

  • Также обратитесь к документации 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
сложный
success
Ответ от Vultr API с некоторыми дополнениями/изменениями

api_account
строка
success
Аккаунт, используемый в файле ini для выбора ключа

Пример:
default
api_endpoint
строка
success
Конечная точка, используемая для запросов API

Пример:
https://api.vultr.com
api_retries
целое число
success
Максимальное количество попыток для запросов API

Пример:
5
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
Статус развертывания тома

Пример:
активный


Статус

  • Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
  • Этот модуль поддерживается сообществом Ansible. [community]

Авторы

  • 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.7/modules/vultr_block_storage_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API