ngine_io.cloudstack.template module – Управление шаблонами в облаках на базе 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.template.

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

Краткое описание
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Краткое описание

Регистрация шаблонов по URL.
Создание шаблонов из ROOT-тома остановленной VM или её снимка.
Обновление, извлечение и удаление шаблонов.

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

Требования

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

python >= 2.6
cs >= 0.9.0

Параметры

Параметр	Комментарии
account string	Учётная запись, к которой относится шаблон, снимок или VM.
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`.
bits integer	Поддержка 32- или 64-разрядной архитектуры. Варианты: `32` `64` ← (по умолчанию)
checksum string	Контрольная сумма MD5 этого шаблона. Если параметр задан, поиск выполняется по контрольной сумме, а не по имени.
cross_zones boolean	Следует ли синхронизировать шаблон между зонами или удалять его из разных зон. Используется только если state равно `present` или `absent`. Варианты: `false` ← (по умолчанию) `true`
details string	Сведения о шаблоне в виде пар ключ/значение.
display_text string	Отображаемый текст шаблона.
domain string	Домен, к которому относится шаблон, снимок или VM.
format string	Формат шаблона. Учитывается только при state=present. Варианты: `"QCOW2"` `"RAW"` `"VHD"` `"OVA"`
hypervisor string	Имя гипервизора, который будет использоваться для создания нового шаблона. Имеет значение при использовании state=present. Возможные значения: `KVM`, `VMware`, `BareMetal`, `XenServer`, `LXC`, `HyperV`, `UCS`, `OVM`, `Simulator`.
is_dynamically_scalable boolean	Зарегистрировать шаблон с установленными инструментами XS/VMware для поддержки динамического масштабирования ЦП/памяти VM. Используется только если state равно `present`. Варианты: `false` `true`
is_extractable boolean	Разрешить извлечение шаблона или его производных. Варианты: `false` `true`
is_featured boolean	Зарегистрировать шаблон как рекомендуемый. Используется только если state равно `present`. Варианты: `false` `true`
is_public boolean	Зарегистрировать шаблон как общедоступный для всех пользователей. Используется только если state равно `present`. Варианты: `false` `true`
is_routing boolean	Задает тип шаблона как маршрутизирующий, то есть предназначенный для развертывания маршрутизаторов. Учитывается только при использовании url. Варианты: `false` `true`
mode string	Режим извлечения шаблона. Используется только если state=extracted. Варианты: `"http_download"` ← (по умолчанию) `"ftp_upload"`
name string / обязательный	Имя шаблона.
os_type string	Тип ОС, который лучше всего соответствует ОС этого шаблона.
password_enabled boolean	Включить поддержку сброса пароля шаблона. Варианты: `false` `true`
poll_async boolean	Опрос асинхронных заданий до их завершения. Варианты: `false` `true` ← (по умолчанию)
project string	Имя проекта, в котором будет зарегистрирован шаблон.
requires_hvm boolean	Требуется ли шаблону HVM. Учитывается только при создании шаблона. Варианты: `false` `true`
snapshot string	Имя снимка, созданного из ROOT-тома VM, на основе которого будет создан шаблон. Этот аргумент необходимо указывать вместе с vm.
sshkey_enabled boolean	Значение True, если шаблон поддерживает загрузку SSH-ключа. Учитывается только при использовании url (ограничение API). Варианты: `false` `true`
state string	Состояние шаблона. Варианты: `"present"` ← (по умолчанию) `"absent"` `"extracted"`
tags псевдонимы: tag list / elements=dictionary	Список тегов. Теги представляют собой список словарей с ключами key и value. Чтобы удалить все теги, задайте пустой список, например tags: [].
template_filter string	Имя фильтра, используемого для поиска шаблона. Фильтр `all` добавлен в версии 2.7. Варианты: `"all"` `"featured"` `"self"` ← (по умолчанию) `"selfexecutable"` `"sharedexecutable"` `"executable"` `"community"`
template_find_options псевдонимы: template_find_option list / elements=string	Параметры для однозначного поиска шаблона. Можно указать несколько параметров. Варианты: `"display_text"` `"checksum"` `"cross_zones"` По умолчанию: `[]`
template_tag string	Тег этого шаблона.
url string	URL, по которому размещён шаблон, при state=present. URL, по которому будет извлечён шаблон, при state=extracted. Несовместим с параметром vm.
validate_certs boolean добавлено в ngine_io.cloudstack 2.4.0	Если значение `false`, SSL-сертификаты проверяться не будут. Если параметр не задан, используется переменная среды `CLOUDSTACK_DANGEROUS_NO_TLS_VERIFY`. Этот параметр следует использовать только на контролируемых вами сайтах с самоподписанными сертификатами. Варианты: `false` `true` ← (по умолчанию)
vm string	Имя VM, из тома которой или, альтернативно, из снимка которой будет создан шаблон. Если шаблон создается из тома VM, она должна быть остановлена. Несовместим с параметром url.
zone string	Имя зоны, в которой нужно зарегистрировать шаблон или из которой его нужно удалить. Обязательно, если cross_zones равно `no`

Примечания

Примечание

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

Примеры

- name: register a systemvm template
  ngine_io.cloudstack.template:
    name: systemvm-vmware-4.5
    url: "http://packages.shapeblue.com/systemvmtemplate/4.5/systemvm64template-4.5-vmware.ova"
    hypervisor: VMware
    format: OVA
    cross_zones: yes
    os_type: Debian GNU/Linux 7(64-bit)

- name: Create a template from a stopped virtual machine's volume
  ngine_io.cloudstack.template:
    name: Debian 9 (64-bit) 20GB ({{ ansible_date_time.date }})
    vm: debian-9-base-vm
    os_type: Debian GNU/Linux 9 (64-bit)
    zone: tokio-ix
    password_enabled: yes
    is_public: yes


# Note: Use template_find_option(s) when a template name is not unique
- name: Create a template from a stopped virtual machine's volume
  ngine_io.cloudstack.template:
    name: Debian 9 (64-bit)
    display_text: Debian 9 (64-bit) 20GB ({{ ansible_date_time.date }})
    template_find_option: display_text
    vm: debian-9-base-vm
    os_type: Debian GNU/Linux 9 (64-bit)
    zone: tokio-ix
    password_enabled: yes
    is_public: yes

- name: create a template from a virtual machine's root volume snapshot
  ngine_io.cloudstack.template:
    name: Debian 9 (64-bit) Snapshot ROOT-233_2015061509114
    snapshot: ROOT-233_2015061509114
    os_type: Debian GNU/Linux 9 (64-bit)
    zone: tokio-ix
    password_enabled: yes
    is_public: yes

- name: Remove a template
  ngine_io.cloudstack.template:
    name: systemvm-4.2
    cross_zones: yes
    state: absent

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

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

Ключ	Описание
account string	Учетная запись, к которой относится шаблон. Возвращается: success Пример: `"example account"`
checksum string	Контрольная сумма MD5 шаблона. Возвращается: если доступно Пример: `"0b31bccccb048d20b551f70830bb7ad0"`
created string	Дата регистрации. Возвращается: success Пример: `"2015-03-29T14:57:06+0200"`
cross_zones boolean	true, если шаблон управляется во всех зонах, в противном случае false. Возвращается: если доступно Пример: `false`
display_text string	Отображаемый текст шаблона. Возвращается: если доступно Пример: `"Debian 7.7 64-bit minimal 2015-03-19"`
domain string	Домен, к которому относится шаблон. Возвращается: success Пример: `"example domain"`
format string	Формат шаблона. Возвращается: если доступно Пример: `"OVA"`
hypervisor string	Гипервизор, связанный с этим шаблоном. Возвращается: если доступно Пример: `"VMware"`
id string	UUID шаблона или извлеченного объекта. Возвращается: success Пример: `"a6f7a5fc-43f8-11e5-a151-feff819cdc9f"`
is_extractable boolean	True, если шаблон можно извлечь. Возвращается: если доступно Пример: `true`
is_featured boolean	True, если шаблон является рекомендуемым. Возвращается: если доступно Пример: `true`
is_public boolean	True, если шаблон является общедоступным. Возвращается: если доступно Пример: `true`
is_ready boolean	True, если шаблон готов к развертыванию. Возвращается: если доступно Пример: `true`
mode string	Режим извлечения Возвращается: при state=extracted Пример: `"http_download"`
name string	Имя шаблона или извлеченного объекта. Возвращается: success Пример: `"Debian 7 64-bit"`
os_type string	Тип ОС. Возвращается: если доступно Пример: `"CentOS 6.5 (64-bit)"`
password_enabled boolean	True, если функция сброса пароля включена, в противном случае false. Возвращается: если доступно Пример: `false`
project string	Имя проекта, к которому относится шаблон. Возвращается: success Пример: `"Production"`
sshkey_enabled boolean	true, если для шаблона включена поддержка sshkey, в противном случае false. Возвращается: если доступно Пример: `false`
state string	Состояние извлеченного шаблона Возвращается: при state=extracted Пример: `"DOWNLOAD_URL_CREATED"`
status string	Статус шаблона или извлеченного объекта. Возвращается: success Пример: `"Download Complete"`
tags list / elements=string	Список тегов ресурса, связанных с шаблоном. Возвращается: если доступно Пример: `["[ { \"key\": \"foo\"", " \"value\": \"bar\" } ]"]`
template_tag string	Тег шаблона, связанный с этим шаблоном. Возвращается: если доступно Пример: `"special"`
template_type string	Тип шаблона. Возвращается: если доступно Пример: `"USER"`
url string	URL, по которому извлечен шаблон Возвращается: при state=extracted Пример: `"http://1.2.3.4/userdata/eb307f13-4aca-45e8-b157-a414a14e6b04.ova"`
zone string	Имя зоны, в которой зарегистрирован шаблон. Возвращается: success Пример: `"zuerich"`

Авторы

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/template_module.html