Spec-Zone.ru › Ansible 2.8

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

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

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

Описание

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

Требования

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

  • python >= 2.7
  • ovirt-engine-sdk-python >= 4.3.0

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
allow_partial_import
boolean
добавлен в 2.4
    Варианты:
  • нет
  • да
Логическое значение, указывающее разрешение частичной регистрации шаблона, когда state зарегистрирован.
auth
словарь / обязательно
Словарь со значениями, необходимыми для создания подключения HTTP/HTTPS к oVirt:
ca_file
строка
Файл PEM, содержащий доверенные сертификаты CA.
Представленный сервером сертификат будет проверен с использованием этих сертификатов CA.
Если параметр ca_file не задан, используется системный хранилище сертификатов CA.
Значение по умолчанию задается переменной среды OVIRT_CAFILE.
headers
словарь
Словарь HTTP-заголовков, которые будут добавлены к каждому API-запросу.
hostname
строка
Строка, содержащая имя хоста сервера, обычно что-то вроде `server.example.com`.
Значение по умолчанию задается переменной среды OVIRT_HOSTNAME.
Требуется либо url, либо hostname.
insecure
boolean
    Варианты:
  • нет
  • да
Логический флаг, указывающий, следует ли проверять сертификат TLS сервера и имя хоста.
kerberos
boolean
    Варианты:
  • нет
  • да
Логический флаг, указывающий, следует ли использовать аутентификацию Kerberos вместо стандартной аутентификации.
password
строка / обязательно
Пароль пользователя.
Значение по умолчанию задается переменной среды OVIRT_PASSWORD.
token
строка
Токен, который используется вместо входа с именем пользователя/паролем.
Значение по умолчанию задается переменной среды OVIRT_TOKEN.
url
строка
Строка, содержащая URL API сервера, обычно что-то вроде `https://server.example.com/ovirt-engine/api`.
Значение по умолчанию задается переменной среды OVIRT_URL.
Требуется либо url, либо hostname.
username
строка / обязательно
Имя пользователя, например admin@internal.
Значение по умолчанию задается переменной среды OVIRT_USERNAME.
clone_name
-
добавлен в 2.8
Имя для импорта шаблона из домена хранилища.
Если не определено, будет использовано name.
clone_permissions
boolean
    Варианты:
  • нет ←
  • да
Если True, то права виртуальной машины (только прямые, а не унаследованные) будут скопированы в созданный шаблон.
Этот параметр используется только, когда state присутствует.
cluster
-
Имя кластера, в котором шаблон должен быть создан/импортирован.
cluster_mappings
-
добавлен в 2.5
Отображение, которое сопоставляет имя кластера между OVF шаблона и целевым кластером, к которому этот шаблон должен быть зарегистрирован, актуально при регистрации state. Отображение кластеров описывается следующим словарем:
dest_name
-
Имя целевого кластера.
source_name
-
Имя исходного кластера.
cpu_profile
-
Профиль процессора, который должен быть установлен для шаблона.
description
-
Описание шаблона.
domain_mappings
-
добавлен в 2.5
Отображение, которое сопоставляет имя домена aaa между OVF шаблона и целевым доменем aaa, к которому этот шаблон должен быть зарегистрирован, актуально при регистрации state. Отображение домена aaa описывается следующим словарем:
dest_name
-
Имя целевого домена aaa.
source_name
-
Имя исходного домена aaa.
exclusive
boolean
    Варианты:
  • нет
  • да
Когда state экспортируется, этот параметр указывает, следует ли перезаписывать существующие шаблоны с тем же именем.
export_domain
-
Когда state экспортируется или импортируется, этот параметр указывает имя экспортного хранилища.
fetch_nested
boolean
добавлен в 2.3
    Варианты:
  • нет
  • да
Если True, модуль получит дополнительные данные из API.
Он получит идентификаторы дисков ВМ, снимков и т. д. Пользователь может настроить загрузку других атрибутов вложенных сущностей, указав 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 (например, 1ГБ, 1024МБ).
memory_guaranteed
-
добавлен в 2.6
Объем минимально гарантированной памяти шаблона. Префикс использует стандарт IEC 60027-2 (например, 1ГБ, 1024МБ).
Параметр memory_guaranteed не может быть меньше параметра memory.
memory_max
-
добавлен в 2.6
Верхний предел памяти шаблона, до которого можно выполнить горячую подмену памяти. Префикс использует стандарт IEC 60027-2 (например, 1ГБ, 1024МБ).
name
-
Имя шаблона, который нужно управлять.
END_OF_DOCUMENT_MARKER
nested_attributes
list
added in 2.3
Указывает список атрибутов, которые должны быть извлечены из API.
Этот параметр применяется только тогда, когда fetch_nested равен true.
operating_system
-
added in 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
integer
По умолчанию:
3
Количество секунд, которое модуль ожидает, прежде чем отправить другой запрос опроса состояния сущности.
role_mappings
-
added in 2.5
Маппер, который сопоставляет имя роли между OVF шаблона и целевой ролью, к которой должен быть зарегистрирован этот шаблон, актуально, когда state зарегистрирован. Отображение ролей описывается следующим словарем:
dest_name
-
Имя целевой роли.
source_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
integer
По умолчанию:
180
Количество времени в секундах, которое модуль должен ждать, пока экземпляр не перейдет в нужное состояние.
version
-
added in 2.8
name — Имя этой версии.
number — Индекс этой версии в иерархии версий шаблона. Используется для редактирования подшаблона.
vm
-
Имя виртуальной машины, которое будет использоваться для создания шаблона.
vnic_profile_mappings
-
added in 2.5
Маппер, который сопоставляет внешний профиль виртуальной сетевой карты с профилем, существующим в движке, когда state зарегистрирован. vnic_profile описывается следующим словарем:
source_network_name
-
Имя сети источника.
source_profile_name
-
Имя профиля, связанного с исходной сетью.
target_profile_id
-
Идентификатор целевого профиля, который должен быть сопоставлен в движке.
wait
boolean
    Варианты:
  • нет
  • да ←
yes если модуль должен ждать, пока сущность не перейдет в нужное состояние.

Примечания

Примечание

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

# Change Template Name
- ovirt_template:
    id: 00000000-0000-0000-0000-000000000000
    name: "new_template_name"

# 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

# Edit template subversion
- ovirt_template:
    cluster: mycluster
    name: mytemplate
    vm: rhel7
    version:
        number: 2
        name: subversion

# Create new template subversion
- ovirt_template:
    cluster: mycluster
    name: mytemplate
    vm: rhel7
    version:
        name: subversion

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

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

Ключ Возвращаемое значение Описание
id
string
При успехе, если шаблон найден.
Идентификатор шаблона, который управляется

Пример:
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.8/modules/ovirt_template_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API