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 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 | По умолчанию: "no" | Если 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. Он загрузит идентификаторы дисков, снимков VM и т. д. Пользователь может настроить загрузку других атрибутов вложенных сущностей, указав nested_attributes. | |
| id (добавлено в 2.4) | ID шаблона, который нужно зарегистрировать. | |
| image_disk | При state импортирован и image_provider используется этот параметр задаёт имя диска, который нужно импортировать как шаблон.псевдонимы: glance_image_disk_name | |
| image_provider | При state импортирован этот параметр задаёт имя поставщика изображений, который нужно использовать. | |
| 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 истина. | |
| 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 (добавлено в 2.5) | По умолчанию: "no" | «Запечатывание» — операция, стирающая все конфигурации, специфичные для машины, из файловой системы: это включает SSH ключи, правила UDEV, MAC адреса, идентификатор системы, имя хоста и т. д. Если true, последующие виртуальные машины, созданные из этого шаблона, избегут наследования конфигурации. Этот параметр используется только когда state присутствует. |
| state |
| Шаблон должен быть present/absent/exported/imported/registered. Когда state registered, и имя незарегистрированного шаблона принадлежит уже зарегистрированному в движке шаблону в том же DC, то мы не сможем зарегистрировать незарегистрированный шаблон. |
| 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.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_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 по следующему адресу: http://ovirt.github.io/ovirt-engine-api-model/master/#types/template. |
Статус
Этот модуль помечен как превью, что означает, что обратная совместимость не гарантируется.
Техническое обслуживание
Этот модуль помечен как сообщество, что означает, что он поддерживается сообществом Ansible. Подробности о техническом обслуживании модулей см. в разделе Техническое обслуживание и поддержка модулей.
Список других модулей, также поддерживаемых сообществом 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.6/modules/ovirt_templates_module.html
