ovirt_templates - Модуль для управления шаблонами виртуальных машин в oVirt/RHV
Новое в версии 2.3.
- Описание
- Требования (к хосту, на котором выполняется модуль)
- Параметры
- Примеры
- Возвращаемые значения
- Примечания
Описание
- Модуль для управления шаблонами виртуальных машин в oVirt/RHV.
Требования (к хосту, на котором выполняется модуль)
- python >= 2.7
- ovirt-engine-sdk-python >= 4.0.0
Параметры
| параметр | обязателен | по умолчанию | варианты | комментарии |
|---|---|---|---|---|
| allow_partial_import (добавлено в 2.4)
| нет | Указывает, разрешить ли частичную регистрацию шаблона при регистрации state. | ||
| auth | да | Словарь с необходимыми значениями для создания подключения HTTP/HTTPS к oVirt: username[обязательно] - Имя пользователя, например, admin@internal. Значение по умолчанию устанавливается переменной среды OVIRT_USERNAME.password[обязательно] - Пароль пользователя. Значение по умолчанию устанавливается переменной среды OVIRT_PASSWORD.url[обязательно] - Строка, содержащая базовый URL сервера, обычно что-то вроде `https://server.example.com/ovirt-engine/api`. Значение по умолчанию устанавливается переменной среды OVIRT_URL.token - Токен, используемый вместо входа с именем пользователя/паролем. Значение по умолчанию устанавливается переменной среды OVIRT_TOKEN.insecure - Флаг, указывающий, нужно ли проверять сертификат TLS сервера и имя хоста.ca_file - PEM-файл, содержащий доверенные сертификаты CA. Сертификат, представленный сервером, будет проверен с использованием этих сертификатов CA. Если параметр `ca_file` не установлен, используется системное хранилище сертификатов CA. Значение по умолчанию устанавливается переменной среды OVIRT_CAFILE.kerberos - Флаг, указывающий, следует ли использовать аутентификацию Kerberos вместо стандартной аутентификации.headers - Словарь HTTP-заголовков, которые должны добавляться к каждому API-запросу. | ||
| clone_permissions | нет | Если True, то права виртуальной машины (только прямые, а не унаследованные) будут скопированы в созданный шаблон. Этот параметр используется только когда state присутствует. | ||
| cluster | нет | Имя кластера, в котором шаблон должен быть создан/импортирован. | ||
| cpu_profile | нет | Профиль ЦП, который нужно установить для шаблона. | ||
| description | нет | Описание шаблона. | ||
| exclusive | нет | Если state экспортируется, этот параметр указывает, следует ли перезаписывать существующие шаблоны с тем же именем. | ||
| export_domain | нет | Если state экспортируется или импортируется, этот параметр задаёт имя домена экспорта хранилища. | ||
| fetch_nested (добавлено в 2.3)
| нет | Если True, модуль извлечет дополнительные данные из API. Он извлечет идентификаторы дисков, снимков и т. д. виртуальных машин. Пользователь может настроить извлечение других атрибутов вложенных сущностей, указав nested_attributes. | ||
| id (добавлено в 2.4)
| нет | Идентификатор шаблона, который нужно зарегистрировать. | ||
| image_disk | нет | Если state импортируется и используется image_provider, этот параметр задаёт имя диска, который нужно импортировать как шаблон.псевдонимы: glance_image_disk_name | ||
| image_provider | нет | Если state импортируется, этот параметр задаёт имя поставщика изображений, который нужно использовать. | ||
| name | нет | Имя шаблона, который необходимо обработать. | ||
| nested_attributes (добавлено в 2.3)
| нет | Указывает список атрибутов, которые нужно извлечь из API. Этот параметр применяется только если fetch_nested равно true. | ||
| poll_interval | нет | 3 | Количество секунд, которое модуль ждёт, прежде чем отправить следующий запрос о статусе сущности. | |
| state | нет | present |
| Требуется наличие шаблона (present/absent/exported/imported/registered). Если state равно registered и имя не зарегистрированного шаблона относится к уже зарегистрированному в движке шаблону в том же ЦОД, попытка регистрации не зарегистрированного шаблона завершится ошибкой. |
| storage_domain | нет | Если state импортируется, этот параметр указывает имя целевого домена хранения данных. Если state регистрируется, этот параметр указывает имя домена хранения данных не зарегистрированного шаблона. | ||
| template_image_disk_name (добавлено в 2.4)
| нет | Если state импортируется и image_provider используется, этот параметр указывает новое имя импортированного диска. Если опущен, используется имя image_disk по умолчанию. Этот параметр используется только при импорте образа диска из домена Glance. | ||
| timeout | нет | 180 | Время в секундах, которое модуль должен ждать, пока экземпляр не перейдет в нужное состояние. | |
| vm | нет | Имя виртуальной машины, которая будет использоваться для создания шаблона. | ||
| wait | нет |
True, если модуль должен ждать, пока сущность не перейдет в нужное состояние. |
Примеры
# Examples don't contain auth parameter for simplicity,
# look at ovirt_auth module to see how to reuse authentication:
# Create template from vm
- ovirt_templates:
cluster: Default
name: mytemplate
vm: rhel7
cpu_profile: Default
description: Test
# Import template
- ovirt_templates:
state: imported
name: mytemplate
export_domain: myexport
storage_domain: mystorage
cluster: mycluster
# Remove template
- ovirt_templates:
state: absent
name: mytemplate
# Register template
- ovirt_templates:
state: registered
storage_domain: mystorage
cluster: mycluster
name: mytemplate
# Register template using id
- ovirt_templates:
state: registered
storage_domain: mystorage
cluster: mycluster
id: 1111-1111-1111-1111
# Register template, allowing partial import
- ovirt_templates:
state: registered
storage_domain: mystorage
allow_partial_import: "True"
cluster: mycluster
id: 1111-1111-1111-1111
# Import image from Glance s a template
- ovirt_templates:
state: imported
name: mytemplate
image_disk: "centos7"
template_image_disk_name: centos7_from_glance
image_provider: "glance_domain"
storage_domain: mystorage
cluster: mycluster
Возвращаемые значения
Общие возвращаемые значения описаны здесь Возвращаемые значения, следующие поля уникальны для этого модуля:
| имя | описание | возвращается | тип | пример |
|---|---|---|---|---|
| id | Идентификатор управляемого шаблона | При успехе, если шаблон найден. | str | 7de90f31-222c-436c-a1ca-7e655bd5b60c |
| template | Словарь всех атрибутов шаблона. Атрибуты шаблонов можно найти на вашем экземпляре oVirt/RHV по следующему URL: http://ovirt.github.io/ovirt-engine-api-model/master/#types/template. | При успехе, если шаблон найден. | dict |
Примечания
Примечание
- Для использования этого модуля необходимо установить oVirt Python SDK. Чтобы убедиться, что он установлен с правильной версией, можно создать следующую задачу: pip: name=ovirt-engine-sdk-python version=4.0.0
Статус
Этот модуль помечен как бета-версия, что означает, что интерфейс не гарантирует обратную совместимость.
Для помощи в разработке модулей, если вы заинтересованы, прочитайте Информация о сообществе и участие, Тестирование 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/ovirt_templates_module.html
