cs_template - Управляет шаблонами на облаках на базе Apache CloudStack.

Новое в версии 2.0.

Краткое описание
Требования (на хосте, на котором выполняется модуль)
Параметры
Примеры
Возвращаемые значения
Примечания
- Статус

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

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

Требования (на хосте, на котором выполняется модуль)

python >= 2.6
cs >= 0.6.10

Параметры

параметр	обязательно	значение по умолчанию	выбор	комментарии
account	нет			Аккаунт, к которому относится шаблон, снимок или ВМ.
api_http_method	нет	get	get post	Используемый HTTP-метод.
api_key	нет			Ключ API CloudStack API.
api_region	нет	cloudstack		Имя раздела ini в файле `cloustack.ini`.
api_secret	нет			Секретный ключ CloudStack API.
api_timeout	нет	10		Таймаут HTTP-запроса.
api_url	нет			URL CloudStack API, например, https://cloud.example.com/client/api.
bits	нет	64		Поддержка 32 или 64 бит.
checksum	нет			Значение контрольной суммы MD5 этого шаблона. Если задано, мы ищем по контрольной сумме вместо имени.
cross_zones	нет			Нужно ли синхронизировать или удалять шаблон по зонам. Используется только если `state` присутствует или отсутствует.
details	нет			Детали шаблона в виде пар ключ/значение.
display_text	нет			Текстовое представление шаблона.
domain	нет			Домен, к которому относится шаблон, снимок или ВМ.
format	нет		QCOW2 RAW VHD OVA	Формат шаблона. Актуально при использовании `state=present`.
hypervisor	нет		KVM VMware BareMetal XenServer LXC HyperV UCS OVM	Название гипервизора, который будет использоваться для создания нового шаблона. Актуально при использовании `state=present`.
is_dynamically_scalable	нет			Зарегистрировать шаблон с установленным инструментом XS/VMWare для поддержки динамического масштабирования процессора/памяти ВМ. Используется только если `state` присутствует.
is_extractable	нет			True, если шаблон или его производные могут быть извлечены.
is_featured	нет			Зарегистрировать шаблон для отображения на главной странице. Используется только если `state` присутствует.
is_public	нет			Зарегистрировать шаблон, чтобы он был доступен всем пользователям. Используется только если `state` присутствует.
is_ready	нет			Этот флаг используется для поиска существующих шаблонов. Если установить в `true`, будут отображены только шаблоны, готовые к развертыванию (например, успешно загруженные и установленные). Рекомендуется установить в `false`.
is_routing	нет			True, если тип шаблона - маршрутизация (то есть шаблон используется для развертывания маршрутизатора). Учитывается только если используется `url`.
mode	нет	http_download	http_download ftp_upload	Режим извлечения шаблона. Используется только если `state=extracted`.
name	да			Имя шаблона.
os_type	нет			Тип ОС, наиболее точно описывающий ОС данного шаблона.
password_enabled	нет			True, если шаблон поддерживает функцию сброса пароля.
poll_async	нет	True		Ожидать завершения асинхронных задач.
project	нет			Имя проекта, в котором будет зарегистрирован шаблон.
requires_hvm	нет			true, если для данного шаблона требуется HVM.
snapshot	нет			Имя снимка, созданного из корневого тома ВМ, на основе которого будет создан шаблон. `vm` требуется вместе с этим аргументом.
sshkey_enabled	нет			True, если шаблон поддерживает функцию загрузки ssh-ключа.
state	нет	present	present absent extacted	Состояние шаблона.
tags (добавлены в 2.4)	нет			Список тегов. Теги — список словарей, имеющих ключи `key` и `value`. Чтобы удалить все теги, задайте пустой список, например, `tags: []`. Синонимы: tag
template_filter	нет	self	featured self selfexecutable sharedexecutable executable community	Имя фильтра, используемого для поиска шаблона.
template_tag	нет			Тег для этого шаблона.
url	нет			URL расположения шаблона на `state=present`. URL для извлечения шаблона на `state=extracted`. Взаимоисключающее с `vm`.
vm	нет			Имя ВМ, из тома или снимка которой будет создан шаблон. ВМ должна быть в состоянии остановки, если создаётся из тома. Взаимоисключающее с `url`.
zone	нет			Имя зоны, в которой вы хотите зарегистрировать или удалить шаблон. Если не указано, используется первая найденная зона.

Примеры

# Register a systemvm template
- local_action:
    module: cs_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)

# Create a template from a stopped virtual machine's volume
- local_action:
    module: cs_template
    name: debian-base-template
    vm: debian-base-vm
    os_type: Debian GNU/Linux 7(64-bit)
    zone: tokio-ix
    password_enabled: yes
    is_public: yes

# Create a template from a virtual machine's root volume snapshot
- local_action:
    module: cs_template
    name: debian-base-template
    vm: debian-base-vm
    snapshot: ROOT-233_2015061509114
    os_type: Debian GNU/Linux 7(64-bit)
    zone: tokio-ix
    password_enabled: yes
    is_public: yes

# Remove a template
- local_action:
    module: cs_template
    name: systemvm-4.2
    cross_zones: yes
    state: absent

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

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

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

Примечания

Примечание

Ansible использует метод конфигурации библиотеки cs, если учетные данные не предоставлены аргументами api_url, api_key, api_secret. Конфигурация считывается из нескольких мест в следующем порядке. - CLOUDSTACK_ENDPOINT, CLOUDSTACK_KEY, CLOUDSTACK_SECRET и CLOUDSTACK_METHOD. Переменные среды. - Переменная среды CLOUDSTACK_CONFIG, указывающая на файл .ini, - Файл cloudstack.ini в текущей рабочей директории. - Файл .cloudstack.ini в домашней директории пользователя. Дополнительно можно указать несколько учетных данных и конечных точек, используя разделы ini в cloudstack.ini. Используйте аргумент api_region для выбора имени раздела, по умолчанию используется cloudstack. Для получения дополнительной информации см. https://github.com/exoscale/cs.
Подробное руководство по модулям cloudstack можно найти на http://docs.ansible.com/ansible/guide_cloudstack.html
Этот модуль поддерживает режим проверки.

Состояние

Этот модуль помечен как stableinterface, что означает, что разработчики этого модуля гарантируют, что не будет внесено обратной несовместимости.

Для получения помощи в разработке модулей, если вы так захотите, прочитайте Информация о сообществе и участие, Тестирование Ansible и Разработка модулей.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/cs_template_module.html