ovirt_templates - Модуль для управления шаблонами виртуальных машин в oVirt/RHV

Новая версия с 2.3.

Описание
- Требования
Параметры
Примечания
Примеры
Возвращаемые значения
Статус
- Автор

Описание

Модуль для управления шаблонами виртуальных машин в oVirt/RHV.

Требования

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

python >= 2.7
ovirt-engine-sdk-python >= 4.2.4

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
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		Имя кластера, в котором шаблон должен быть создан/импортирован.
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		Если `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` равно истинно.
poll_interval	По умолчанию: 3	Количество секунд, которое модуль ожидает, прежде чем отправлять другой запрос на проверку состояния сущности.
role_mappings (добавлено в 2.5)		Карта, которая сопоставляет имя роли между OVF шаблона и целевой ролью, в которую этот шаблон должен быть зарегистрирован, актуально при `state` регистрируется. Сопоставление ролей описывается следующим словарем: `source_name`: Имя исходной роли. `dest_name`: Имя целевой роли.
seal (добавлено в 2.5)	По умолчанию: нет	«Запечатывание» — это операция, которая стирает все конфигурации, специфичные для машины, из файловой системы: это включает SSH-ключи, правила UDEV, MAC-адреса, системный идентификатор, имя хоста и т. д. Если значение true, последующие виртуальные машины, созданные на основе этого шаблона, будут избегать наследования конфигурации. Этот параметр используется только когда `state` присутствует.
state	Варианты: present ← absent exported imported registered	Шаблон должен быть present/absent/exported/imported/registered. Когда `state` registered, и имя не зарегистрированного шаблона принадлежит уже зарегистрированному в движке шаблону в том же ЦОД, то регистрация не зарегистрированного шаблона не выполняется.
storage_domain		Если `state` импортируется, этот параметр указывает имя целевого домена хранилища данных. Если `state` registered, этот параметр указывает имя домена хранилища данных не зарегистрированного шаблона.
template_image_disk_name (добавлено в 2.4)		Если `state` импортируется и `image_provider` используется, этот параметр указывает новое имя для импортированного диска; если он опущен, то используется имя image_disk по умолчанию. Этот параметр используется только при импорте изображения диска из домена Glance.
timeout	По умолчанию: 180	Время в секундах, которое модуль должен ждать, пока экземпляр не перейдет в нужное состояние.
vm		Имя ВМ, которое будет использоваться для создания шаблона.
vnic_profile_mappings (добавлено в 2.5)		Карта, которая сопоставляет внешний профиль виртуальной сетевой карты с профилем, который существует в движке, когда `state` зарегистрирован. Профиль vnic описывается следующим словарем: `source_network_name`: Имя сети источника. `source_profile_name`: Имя профиля, относящегося к сети источника. `target_profile_id`: Идентификатор целевого профиля, который должен быть сопоставлен в движке.
wait		True, если модуль должен ждать, пока сущность не перейдет в нужное состояние.

Примечания

Примечание

Для использования этого модуля необходимо установить oVirt Python SDK. Чтобы убедиться, что он установлен с правильной версией, можно создать следующую задачу: pip: name=ovirt-engine-sdk-python version=4.0.0

Примеры

# 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

# Register template with vnic profile mappings
- ovirt_templates:
    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_templates:
    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_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 dict	При успехе, если шаблон найден.	Словарь всех атрибутов шаблона. Атрибуты шаблона можно найти на вашем экземпляре oVirt/RHV по следующему URL: http://ovirt.github.io/ovirt-engine-api-model/master/#types/template.

Статус

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

Автор

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.5/modules/ovirt_templates_module.html