Spec-Zone.ru › Ansible

ngine_io.cloudstack.cs_volume модуль — Управление томами на облаках на основе Apache CloudStack.

Примечание

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

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

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

Чтобы использовать его в плейбуке, укажите: ngine_io.cloudstack.cs_volume.

Новое в ngine_io.cloudstack 0.1.0

  • Описание
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Значения возврата

Описание

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

Требования

Ниже перечислены требования к хосту, на котором выполняется этот модуль.

  • python >= 2.6
  • cs >= 0.9.0

Параметры

Параметр

Комментарии

account

string

Учетная запись, с которой связан том.

api_http_method

string

HTTP-метод, используемый для запроса к конечной точке API.

Если не указано, используется переменная окружения CLOUDSTACK_METHOD.

Варианты:

  • "get" ← (default)
  • "post"

api_key

string / required

API-ключ CloudStack API.

Если не указано, используется переменная окружения CLOUDSTACK_KEY.

api_secret

string / required

Секретный ключ CloudStack API.

Если не указано, используется переменная окружения CLOUDSTACK_SECRET.

api_timeout

integer

Таймаут HTTP в секундах.

Если не указано, используется переменная окружения CLOUDSTACK_TIMEOUT.

По умолчанию: 10

api_url

string / required

URL CloudStack API, например, https://cloud.example.com/client/api.

Если не указано, используется переменная окружения CLOUDSTACK_ENDPOINT.

api_verify_ssl_cert

string

Проверить файл сертификата центра сертификации.

Если не указано, используется переменная окружения CLOUDSTACK_VERIFY.

custom_id

string

Пользовательский идентификатор ресурса.

Разрешено только для Root Admins.

device_id

integer

Идентификатор устройства на виртуальной машине, к которой подключен том.

Учитывается только если state равно attached.

disk_offering

string

Имя предложения дискового пространства, которое будет использоваться.

Требуется один из параметров disk_offering, snapshot, если том ещё не имеет state=present.

display_volume

boolean

Отображать ли том конечному пользователю или нет.

Разрешено только для Root Admins.

Варианты:

  • false
  • true

domain

string

Имя домена, в котором будет развёрнут том.

force

boolean

Принудительно удалить том, даже если он подключен к виртуальной машине.

Учитывается только при state=absent.

Варианты:

  • false ← (default)
  • true

format

string

Формат тома.

Учитывается только если state=uploaded.

Варианты:

  • "QCOW2"
  • "RAW"
  • "VHD"
  • "VHDX"
  • "OVA"

max_iops

integer

Максимальное количество операций ввода-вывода в секунду.

min_iops

integer

Минимальное количество операций ввода-вывода в секунду.

mode

string

Режим извлечения тома.

Учитывается только если state=extracted.

Варианты:

  • "http_download" ← (default)
  • "ftp_upload"

name

string / required

Имя тома.

name может содержать только буквы ASCII.

poll_async

boolean

Опрашивать асинхронные задания до их завершения.

Варианты:

  • false
  • true ← (default)

project

string

Имя проекта, в котором будет развёрнут том.

shrink_ok

boolean

Разрешить уменьшение размера тома.

Варианты:

  • false ← (default)
  • true

size

integer

Размер диска в ГБ

snapshot

string

Имя снимка для диска.

Требуется один из параметров disk_offering, snapshot, если объем не имеет состояния state=present.

state

string

Состояние тома.

Варианты:

  • "present" ← (по умолчанию)
  • "absent"
  • "attached"
  • "detached"
  • "extracted"
  • "uploaded"

tags

aliases: tag

список / элементы=словарь

Список тегов. Теги представлены в виде списка словарей с ключами key и value.

Чтобы удалить все теги, установите пустой список, например, tags: [].

url

строка

URL, на который будет извлечен том в случае state=extracted

или URL для загрузки тома в случае state=uploaded.

Учитывается только если state равен extracted или uploaded.

validate_certs

логическое значение

добавлено в ngine_io.cloudstack 2.4.0

Если false, сертификаты SSL не будут проверены.

Если не указано, рассматривается переменная среды CLOUDSTACK_DANGEROUS_NO_TLS_VERIFY.

Это следует использовать только на сайтах, контролируемых лично, с использованием самозаверяющих сертификатов.

Варианты:

  • false
  • true ← (по умолчанию)

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

строка

Дата подключения тома.

Возвращено: success

Пример: "2014-12-01T14:57:57+0100"

created

строка

Дата создания тома.

Возвращено: success

Пример: "2014-12-01T14:57:57+0100"

device_id

целое число

Идентификатор устройства на виртуальной машине пользователя, к которому подключен том (не возвращается при отключении).

Возвращено: success

Пример: 1

display_name

строка

Отображаемое имя тома.

Возвращено: success

Пример: "web-volume-01"

domain

строка

Домен, к которому принадлежит том.

Возвращено: success

Пример: "example domain"

group

строка

Группа, к которой принадлежит том.

Возвращено: success

Пример: "web"

id

строка

Идентификатор тома.

Возвращено: success

name

строка

Имя тома.

Возвращено: success

Пример: "web-volume-01"

project

строка

Проект, к которому принадлежит том.

Возвращено: success

Пример: "Production"

size

целое число

Размер дискового тома.

Возвращено: success

Пример: 20

state

строка

Состояние тома.

Возвращено: success

Пример: "Attached"

type

строка

Тип дискового тома.

Возвращено: success

Пример: "DATADISK"

url

строка

URL загруженного тома или URL скачивания в зависимости от режима извлечения.

Возвращено: success при state=extracted

Пример: "http://1.12.3.4/userdata/387e2c7c-7c42-4ecc-b4ed-84e8367a1965.vhd"

vm

строка

Имя виртуальной машины, к которой подключен том (не возвращается при отключении).

Возвращено: success

Пример: "web-01"

zone

строка

Имя зоны, в которой находится том.

Возвращено: success

Пример: "ch-gva-2"

Авторы

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

Ссылки на сборку

  • Отслеживание проблем
  • Репозиторий (Исходные коды)

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

Spec-Zone.ru

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