Модуль ngine_io.cloudstack.volume — управление томами в облаках на базе Apache CloudStack.

Примечание

Этот модуль входит в коллекцию ngine_io.cloudstack (версия 3.0.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в состав ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install ngine_io.cloudstack. Для работы с этим модулем требуются дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать модуль в сценарии, укажите: ngine_io.cloudstack.volume.

Добавлено в ngine_io.cloudstack 0.1.0

Обзор
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

Создание, удаление, подключение, отключение, извлечение и загрузка томов.

Псевдонимы: cs_volume

Требования

На узле, выполняющем этот модуль, должны быть установлены следующие компоненты.

python >= 2.6
cs >= 0.9.0

Параметры

Параметр	Комментарии
account string	Учетная запись, к которой относится том.
api_http_method string	Метод HTTP, используемый для обращения к конечной точке API. Если параметр не задан, используется переменная окружения `CLOUDSTACK_METHOD`. Варианты: `"get"` ← (по умолчанию) `"post"`
api_key string / обязательный	Ключ API CloudStack. Если параметр не задан, используется переменная окружения `CLOUDSTACK_KEY`.
api_secret string / обязательный	Секретный ключ API CloudStack. Если параметр не задан, используется переменная окружения `CLOUDSTACK_SECRET`.
api_timeout integer	Тайм-аут HTTP в секундах. Если параметр не задан, используется переменная окружения `CLOUDSTACK_TIMEOUT`. По умолчанию: `10`
api_url string / обязательный	URL API CloudStack, например https://cloud.example.com/client/api. Если параметр не задан, используется переменная окружения `CLOUDSTACK_ENDPOINT`.
api_verify_ssl_cert string	Проверять файл сертификата центра сертификации. Если параметр не задан, используется переменная окружения `CLOUDSTACK_VERIFY`.
custom_id string	Пользовательский идентификатор ресурса. Доступно только администраторам Root.
device_id integer	Идентификатор устройства виртуальной машины, к которому подключен том. Учитывается, только если state равен `attached`.
disk_offering string	Название используемого предложения диска. Если том еще не находится в состоянии state=present, необходимо указать один из параметров: disk_offering или snapshot.
display_volume boolean	Определяет, будет ли том отображаться конечному пользователю. Доступно только администраторам Root. Варианты: `false` `true`
domain string	Название домена, в котором будет развернут том.
force boolean	Принудительно удалить том, даже если он подключен к виртуальной машине. Учитывается только при state=absent. Варианты: `false` ← (по умолчанию) `true`
format string	Формат тома. Учитывается, только если state=uploaded. Варианты: `"QCOW2"` `"RAW"` `"VHD"` `"VHDX"` `"OVA"`
max_iops integer	Максимальное количество операций ввода-вывода в секунду.
min_iops integer	Минимальное количество операций ввода-вывода в секунду.
mode string	Режим извлечения тома. Учитывается, только если state=extracted. Варианты: `"http_download"` ← (по умолчанию) `"ftp_upload"`
name string / обязательный	Название тома. В name можно использовать только буквы ASCII.
poll_async boolean	Ожидать завершения асинхронных заданий, опрашивая их состояние. Варианты: `false` `true` ← (по умолчанию)
project string	Название проекта, в котором будет развернут том.
shrink_ok boolean	Разрешить уменьшение размера тома. Варианты: `false` ← (по умолчанию) `true`
size integer	Размер диска в ГБ.
snapshot string	Название снимка дискового тома. Если том еще не находится в состоянии state=present, необходимо указать один из параметров: disk_offering или snapshot.
state string	Состояние тома. Варианты: `"present"` ← (по умолчанию) `"absent"` `"attached"` `"detached"` `"extracted"` `"uploaded"`
tags псевдонимы: tag list / элементы=dictionary	Список тегов. Теги представляют собой список словарей с ключами key и value. Чтобы удалить все теги, задайте пустой список, например tags: [].
url string	URL, по которому будет извлечен том при state=extracted или URL для загрузки тома при state=uploaded. Учитывается, только если state равен `extracted` или `uploaded`.
validate_certs boolean добавлено в ngine_io.cloudstack 2.4.0	Если значение равно `false`, сертификаты SSL не проверяются. Если параметр не задан, используется переменная окружения `CLOUDSTACK_DANGEROUS_NO_TLS_VERIFY`. Используйте этот параметр только на подконтрольных вам сайтах с самоподписанными сертификатами. Варианты: `false` `true` ← (по умолчанию)
vm string	Название виртуальной машины, к которой нужно подключить том.
zone string / обязательный	Название зоны, в которой следует развернуть том.

Примечания

Примечание

Подробное руководство по модулям CloudStack доступно в разделе Руководство по облаку CloudStack.
Этот модуль поддерживает режим проверки.

Примеры

- name: create volume within project and zone with specified storage options
  ngine_io.cloudstack.volume:
    name: web-vm-1-volume
    project: Integration
    zone: ch-zrh-ix-01
    disk_offering: PerfPlus Storage
    size: 20

- name: create/attach volume to instance
  ngine_io.cloudstack.volume:
    name: web-vm-1-volume
    zone: zone01
    disk_offering: PerfPlus Storage
    size: 20
    vm: web-vm-1
    state: attached

- name: detach volume
  ngine_io.cloudstack.volume:
    name: web-vm-1-volume
    zone: zone01
    state: detached

- name: remove volume
  ngine_io.cloudstack.volume:
    name: web-vm-1-volume
    zone: zone01
    state: absent

- name: Extract DATA volume to make it downloadable
  ngine_io.cloudstack.volume:
    state: extracted
    name: web-vm-1-volume
    zone: zone01
  register: data_vol_out

- name: Create new volume by downloading source volume
  ngine_io.cloudstack.volume:
    state: uploaded
    name: web-vm-1-volume-2
    zone: zone01
    format: VHD
    url: "{{ data_vol_out.url }}"

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:

Ключ	Описание
attached string	Дата подключения тома. Возвращается: при успешном выполнении Пример: `"2014-12-01T14:57:57+0100"`
created string	Дата создания тома. Возвращается: при успешном выполнении Пример: `"2014-12-01T14:57:57+0100"`
device_id integer	Идентификатор устройства пользовательской виртуальной машины, к которому подключен том (не возвращается, если том отключен). Возвращается: при успешном выполнении Пример: `1`
display_name string	Отображаемое имя тома. Возвращается: при успешном выполнении Пример: `"web-volume-01"`
domain string	Домен, которому принадлежит том. Возвращается: при успешном выполнении Пример: `"example domain"`
group string	Группа, которой принадлежит том. Возвращается: при успешном выполнении Пример: `"web"`
id string	Идентификатор тома. Возвращается: при успешном выполнении
name string	Название тома. Возвращается: при успешном выполнении Пример: `"web-volume-01"`
project string	Проект, которому принадлежит том. Возвращается: при успешном выполнении Пример: `"Production"`
size integer	Размер дискового тома. Возвращается: при успешном выполнении Пример: `20`
state string	Состояние тома. Возвращается: при успешном выполнении Пример: `"Attached"`
type string	Тип дискового тома. Возвращается: при успешном выполнении Пример: `"DATADISK"`
url string	URL загруженного тома или URL для скачивания, в зависимости от режима извлечения. Возвращается: при успешном выполнении, если state=extracted Пример: `"http://1.12.3.4/userdata/387e2c7c-7c42-4ecc-b4ed-84e8367a1965.vhd"`
vm string	Название виртуальной машины, к которой подключен том (не возвращается, если том отключен). Возвращается: при успешном выполнении Пример: `"web-01"`
zone string	Название зоны, в которой находится том. Возвращается: при успешном выполнении Пример: `"ch-gva-2"`

Авторы

Jefferson Girão (@jeffersongirao)
René Moser (@resmo)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/ngine_io/cloudstack/volume_module.html