ngine_io.cloudstack.cs_volume – Управляет томами на облаках, основанных на Apache CloudStack.
Примечание
Этот плагин является частью коллекции ngine_io.cloudstack (версия 2.0.0).
Для его установки используйте: ansible-galaxy collection install ngine_io.cloudstack
Для использования в плейбуке укажите: ngine_io.cloudstack.cs_volume
Новый в версии 0.1.0: of ngine_io.cloudstack
Обзор
- Создание, удаление, подключение, отключение, извлечение или загрузка томов.
Требования
Ниже перечислены требования, которые должны быть выполнены на хосте, на котором выполняется этот модуль.
- python >= 2.6
- cs >= 0.9.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| account строка | Аккаунт, к которому относится том. | |
| api_http_method строка |
| HTTP-метод, используемый для запроса к API-точке. Если не указано, используется значение переменной среды CLOUDSTACK_METHOD. |
| api_key строка / обязательно | API-ключ CloudStack API. Если не указано, используется значение переменной среды CLOUDSTACK_KEY. | |
| api_secret строка / обязательно | Секретный ключ CloudStack API. Если не задано, используется значение переменной среды CLOUDSTACK_SECRET. | |
| api_timeout целое число | По умолчанию: 10 | Таймаут HTTP в секундах. Если не указано, используется значение переменной среды CLOUDSTACK_TIMEOUT. |
| api_url строка / обязательно | URL CloudStack API, например, https://cloud.example.com/client/api. Если не указано, используется значение переменной среды CLOUDSTACK_ENDPOINT. | |
| api_verify_ssl_cert строка | Проверка сертификата CA. Если не указано, используется значение переменной среды CLOUDSTACK_VERIFY. | |
| custom_id строка | Пользовательский идентификатор ресурса. Доступно только для администраторов. | |
| device_id целое число | ID устройства на виртуальной машине, к которой подключен том. Учитывается только если state равен attached. | |
| disk_offering строка | Имя предложения диска, которое будет использоваться. Требуется один из параметров disk_offering, snapshot, если состояние тома не state=present. | |
| display_volume логическое значение |
| Определяет, отображать ли том конечному пользователю. Доступно только для администраторов. |
| domain строка | Имя домена, в котором должен быть развернут том. | |
| force логическое значение |
| Принудительно удалить том, даже если он подключен к виртуальной машине. Учитывается только при state=absent. |
| format строка |
| Формат тома. Учитывается только при state=uploaded. |
| max_iops целое число | Максимальная интенсивность операций ввода-вывода. | |
| min_iops целое число | Минимальная интенсивность операций ввода-вывода. | |
| mode строка |
| Режим для извлечения тома. Учитывается только при state=extracted. |
| name строка / обязательно | Имя тома.
name может содержать только ASCII символы. | |
| poll_async логическое значение |
| Проверить асинхронные задачи до завершения работы. |
| project строка | Имя проекта, в котором должен быть развернут том. | |
| shrink_ok логическое значение |
| Разрешить уменьшение размера тома. |
| size целое число | Размер диска в ГБ. | |
| snapshot строка | Имя снимка для диска. Требуется один из параметров disk_offering, snapshot, если состояние тома не state=present. | |
| state строка |
| Состояние тома. |
| tags список / элементы=словарь | Список тегов. Теги представлены списком словарей с ключами key и value. Чтобы удалить все теги, установите пустой список, например, tags: []. псевдонимы: tag | |
| url строка | URL, на который будет извлечен том при state=extracted или URL, откуда загрузить том при state=uploaded. Учитывается только если state равен extracted или uploaded. | |
| vm строка | Имя виртуальной машины, к которой нужно подключить том. | |
| zone строка / обязательно | Имя зоны, в которой должен быть развернут том. |
Примечания
Примечание
- Подробное руководство по модулям cloudstack можно найти в Руководстве по облаку CloudStack.
- Этот модуль поддерживает режим проверки.
Примеры
- name: create volume within project and zone with specified storage options
ngine_io.cloudstack.cs_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.cs_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.cs_volume:
name: web-vm-1-volume
zone: zone01
state: detached
- name: remove volume
ngine_io.cloudstack.cs_volume:
name: web-vm-1-volume
zone: zone01
state: absent
- name: Extract DATA volume to make it downloadable
ngine_io.cloudstack.cs_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.cs_volume:
state: uploaded
name: web-vm-1-volume-2
zone: zone01
format: VHD
url: "{{ data_vol_out.url }}"
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| attached string | success | Дата присоединения тома. Пример: 2014-12-01T14:57:57+0100 |
| created string | success | Дата создания тома. Пример: 2014-12-01T14:57:57+0100 |
| device_id integer | success | Идентификатор устройства на виртуальной машине пользователя, к которому присоединен том (не возвращается при отключении). Пример: 1 |
| display_name string | success | Отображаемое имя тома. Пример: web-volume-01 |
| domain string | success | Домен, к которому принадлежит том. Пример: example domain |
| group string | success | Группа, к которой принадлежит том. Пример: web |
| id string | success | Идентификатор тома. |
| name string | success | Имя тома. Пример: web-volume-01 |
| project string | success | Проект, к которому принадлежит том. Пример: Production |
| size integer | success | Размер дискового тома. Пример: 20 |
| state string | success | Состояние тома. Пример: Присоединён |
| type string | success | Тип дискового тома. Пример: DATADISK |
| url string | success когда state=extracted | URL загруженного тома или URL для скачивания в зависимости от режима извлечения. Пример: http://1.12.3.4/userdata/387e2c7c-7c42-4ecc-b4ed-84e8367a1965.vhd |
| vm string | success | Имя виртуальной машины, к которой присоединен том (не возвращается при отключении). Пример: web-01 |
| zone string | success | Имя зоны, в которой находится том. Пример: ch-gva-2 |
Авторы
- Jefferson Girão (@jeffersongirao)
- René Moser (@resmo)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/ngine_io/cloudstack/cs_volume_module.html
