ovirt_template – Модуль для управления шаблонами виртуальных машин в oVirt/RHV
Новая версия с 2.3.
Обзор
- Модуль для управления шаблонами виртуальных машин в oVirt/RHV.
Псевдонимы: ovirt_templates
Требования
Ниже приведены требования к хосту, на котором выполняется этот модуль.
- python >= 2.7
- ovirt-engine-sdk-python >= 4.2.4
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| allow_partial_import boolean добавлен в 2.4 |
| Логическое значение, указывающее, разрешить ли частичную регистрацию шаблона при state. |
| auth - / обязательно | Словарь со значениями, необходимыми для создания HTTP/HTTPS-соединения с oVirt: username[обязательно] - Имя пользователя, например, admin@internal. Значение по умолчанию задаётся переменной среды OVIRT_USERNAME.password[обязательно] - Пароль пользователя. Значение по умолчанию задаётся переменной среды OVIRT_PASSWORD.url - Строка, содержащая URL API сервера, обычно `https://server.example.com/ovirt-engine/api`. Значение по умолчанию задаётся переменной среды OVIRT_URL. Необходимо указать либо url, либо hostname. hostname - Строка, содержащая имя хоста сервера, обычно `server.example.com`. Значение по умолчанию задаётся переменной среды OVIRT_HOSTNAME. Необходимо указать либо url, либо hostname. token - Токен, используемый вместо входа с именем пользователя/паролем. Значение по умолчанию задаётся переменной среды OVIRT_TOKEN.insecure - Логический флаг, указывающий, следует ли проверять сертификат TLS сервера и имя хоста.ca_file - PEM-файл, содержащий доверенные сертификаты CA. Представленный сервером сертификат будет проверен с использованием этих сертификатов CA. Если параметр `ca_file` не задан, используется системный хранилище сертификатов CA. Значение по умолчанию задаётся переменной среды OVIRT_CAFILE.kerberos - Логический флаг, указывающий, следует ли использовать аутентификацию Kerberos вместо стандартной аутентификации.headers - Словарь HTTP-заголовков, которые должны быть добавлены к каждому API-запросу. | |
| clone_permissions boolean |
| Если True, права виртуальной машины (только прямые, а не наследуемые) будут скопированы в созданный шаблон. Этот параметр используется только при state присутствует. |
| cluster - | Имя кластера, в котором шаблон должен быть создан/импортирован. | |
| cluster_mappings - добавлен в 2.5 | Преобразование, которое сопоставляет имя кластера между OVF шаблона и кластером назначения, к которому должен быть зарегистрирован этот шаблон, актуально при регистрации state. Отображение кластера описывается следующим словарем:source_name: Имя исходного кластера.dest_name: Имя целевого кластера. | |
| cpu_profile - | Профиль процессора, который должен быть установлен для шаблона. | |
| description - | Описание шаблона. | |
| domain_mappings - добавлен в 2.5 | Преобразование, которое сопоставляет имя домена aaa между OVF шаблона и целевым домена aaa, к которому должен быть зарегистрирован этот шаблон, актуально при регистрации state. Отображение домена aaa описывается следующим словарем:source_name: Имя исходного домена aaa.dest_name: Имя целевого домена aaa. | |
| exclusive boolean |
| При state экспортируется этот параметр указывает, следует ли перезаписывать существующие шаблоны с таким же именем. |
| export_domain - | При state экспортируется или импортируется этот параметр указывает имя домена экспорта хранилища. | |
| fetch_nested boolean добавлен в 2.3 |
| Если True, модуль загрузит дополнительные данные из API. Он загрузит идентификаторы дисков, снимков VM и т.д. Пользователь может настроить загрузку других атрибутов вложенных сущностей, указав nested_attributes. |
| id - добавлен в 2.4 | Идентификатор шаблона, который должен быть зарегистрирован. | |
| image_disk - | При state импортируется и image_provider используется, этот параметр указывает имя диска, который должен быть импортирован как шаблон.псевдонимы: glance_image_disk_name | |
| image_provider - | При state импортируется этот параметр указывает имя поставщика изображений, который должен быть использован. | |
| io_threads - добавлен в 2.7 | Количество потоков ввода-вывода, используемых виртуальной машиной. 0 означает отключение потоков ввода-вывода. | |
| memory - добавлен в 2.6 | Объём памяти шаблона. Префикс использует стандарт IEC 60027-2 (например, 1GiB, 1024MiB). | |
| memory_guaranteed - добавлен в 2.6 | Минимальный гарантированный объём памяти шаблона. Префикс использует стандарт IEC 60027-2 (например, 1GiB, 1024MiB). memory_guaranteed параметр не может быть меньше memory параметра. | |
| memory_max - добавлен в 2.6 | Максимальный объём памяти шаблона, до которого можно выполнить горячую подкачку памяти. Префикс использует стандарт IEC 60027-2 (например, 1GiB, 1024MiB). | |
| name - | Имя шаблона для управления. | |
| nested_attributes - добавлен в 2.3 | Указывает список атрибутов, которые должны быть загружены из API. Этот параметр применяется только когда fetch_nested равно true. | |
| operating_system - добавлен в 2.6 | Операционная система шаблона. Значение по умолчанию задаётся oVirt/RHV движком. Возможные значения: debian_7, freebsd, freebsdx64, other, other_linux, other_linux_ppc64, other_ppc64, rhel_3, rhel_4, rhel_4x64, rhel_5, rhel_5x64, rhel_6, rhel_6x64, rhel_6_ppc64, rhel_7x64, rhel_7_ppc64, sles_11, sles_11_ppc64, ubuntu_12_04, ubuntu_12_10, ubuntu_13_04, ubuntu_13_10, ubuntu_14_04, ubuntu_14_04_ppc64, windows_10, windows_10x64, windows_2003, windows_2003x64, windows_2008, windows_2008x64, windows_2008r2x64, windows_2008R2x64, windows_2012x64, windows_2012R2x64, windows_7, windows_7x64, windows_8, windows_8x64, windows_xp | |
| poll_interval - | Значение по умолчанию: 3 | Число секунд, в течение которых модуль ждёт, прежде чем отправить другой запрос о состоянии сущности. |
| role_mappings - добавлен в 2.5 | Преобразование, которое сопоставляет имя роли между OVF шаблона и целевой ролью, к которой должен быть зарегистрирован этот шаблон, актуально при регистрации state. Отображение роли описывается следующим словарем:source_name: Имя исходной роли.dest_name: Имя целевой роли. |
| seal boolean added in 2.5 |
| «Запечатывание» — это операция, стирающая все конфигурации, специфичные для машины, из файловой системы: сюда входят ключи SSH, правила UDEV, MAC-адреса, идентификатор системы, имя хоста и т. д. Если значение равно true, последующие виртуальные машины, созданные на основе этой шаблона, избегнут наследования конфигурации. Этот параметр используется только в случае, если state присутствует. |
| state - |
| Шаблон должен присутствовать/отсутствовать/экспортироваться/импортироваться/зарегистрироваться. Когда state зарегистрировано, и имя незарегистрированного шаблона принадлежит уже зарегистрированному шаблону движка в том же ЦОД, то мы не можем зарегистрировать незарегистрированный шаблон. |
| storage_domain - | Если state импортировано, этот параметр указывает имя целевого домена хранилища данных. Если state зарегистрировано, этот параметр указывает имя домена хранилища данных незарегистрированного шаблона. | |
| template_image_disk_name - added in 2.4 | Если state импортировано и image_provider используется, этот параметр указывает новое имя импортированного диска; если опустить, то по умолчанию используется имя image_disk. Этот параметр используется только в случае импорта образа диска из домена Glance. | |
| timeout - | По умолчанию: 180 | Время в секундах, которое модуль должен ожидать, пока экземпляр не перейдет в нужное состояние. |
| vm - | Имя виртуальной машины (ВМ), которое будет использоваться для создания шаблона. | |
| vnic_profile_mappings - added in 2.5 | Маппер, который сопоставляет внешний профиль виртуальной сетевой карты (vNIC) с профилем, существующим в движке, когда state зарегистрирован. vnic_profile описывается следующим словарем:source_network_name: Имя сети источника.source_profile_name: Имя профиля, связанного с исходной сетью.target_profile_id: Идентификатор целевого профиля, который будет сопоставлен в движке. | |
| wait boolean |
|
True, если модуль должен ожидать, пока сущность не перейдет в нужное состояние. |
Примечания
Примечание
- Для использования этого модуля необходимо установить oVirt Python SDK. Чтобы убедиться, что он установлен с правильной версией, можно создать следующую задачу: pip: name=ovirt-engine-sdk-python version=4.2.4
Примеры
# Examples don't contain auth parameter for simplicity,
# look at ovirt_auth module to see how to reuse authentication:
# Create template from vm
- ovirt_template:
cluster: Default
name: mytemplate
vm: rhel7
cpu_profile: Default
description: Test
# Import template
- ovirt_template:
state: imported
name: mytemplate
export_domain: myexport
storage_domain: mystorage
cluster: mycluster
# Remove template
- ovirt_template:
state: absent
name: mytemplate
# Register template
- ovirt_template:
state: registered
storage_domain: mystorage
cluster: mycluster
name: mytemplate
# Register template using id
- ovirt_template:
state: registered
storage_domain: mystorage
cluster: mycluster
id: 1111-1111-1111-1111
# Register template, allowing partial import
- ovirt_template:
state: registered
storage_domain: mystorage
allow_partial_import: "True"
cluster: mycluster
id: 1111-1111-1111-1111
# Register template with vnic profile mappings
- ovirt_template:
state: registered
storage_domain: mystorage
cluster: mycluster
id: 1111-1111-1111-1111
vnic_profile_mappings:
- source_network_name: mynetwork
source_profile_name: mynetwork
target_profile_id: 3333-3333-3333-3333
- source_network_name: mynetwork2
source_profile_name: mynetwork2
target_profile_id: 4444-4444-4444-4444
# Register template with mapping
- ovirt_template:
state: registered
storage_domain: mystorage
cluster: mycluster
id: 1111-1111-1111-1111
role_mappings:
- source_name: Role_A
dest_name: Role_B
domain_mappings:
- source_name: Domain_A
dest_name: Domain_B
cluster_mappings:
- source_name: cluster_A
dest_name: cluster_B
# Import image from Glance s a template
- ovirt_template:
state: imported
name: mytemplate
image_disk: "centos7"
template_image_disk_name: centos7_from_glance
image_provider: "glance_domain"
storage_domain: mystorage
cluster: mycluster
Значения возврата
Общие значения возврата документированы здесь, следующие являются полями, уникальными для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| id строка | При успехе, если шаблон найден. | Идентификатор управляемого шаблона Пример: 7de90f31-222c-436c-a1ca-7e655bd5b60c |
| template словарь | При успехе, если шаблон найден. | Словарь всех атрибутов шаблона. Атрибуты шаблона можно найти на вашем экземпляре oVirt/RHV по следующему URL: http://ovirt.github.io/ovirt-engine-api-model/master/#types/template. |
Статус
- Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [сообщество]
Авторы
- Ondra Machacek (@machacekondra)
Подсказка
Если вы заметите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/ovirt_template_module.html