ovirt_templates - Module to manage virtual machine templates in oVirt/RHV

New in version 2.3.

Synopsis
- Requirements
Parameters
Notes
Examples
Return Values
Status
- Author

Synopsis

Module to manage virtual machine templates in oVirt/RHV.

Requirements

The below requirements are needed on the host that executes this module.

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

Parameters

Parameter	Choices/Defaults	Comments
allow_partial_import (added in 2.4)		Boolean indication whether to allow partial registration of a template when `state` is registered.
auth required		Dictionary with values needed to create HTTP/HTTPS connection to oVirt: `username`[required] - The name of the user, something like admin@internal. Default value is set by OVIRT_USERNAME environment variable. `password`[required] - The password of the user. Default value is set by OVIRT_PASSWORD environment variable. `url`[required] - A string containing the base URL of the server, usually something like `https://server.example.com/ovirt-engine/api`. Default value is set by OVIRT_URL environment variable. `token` - Token to be used instead of login with username/password. Default value is set by OVIRT_TOKEN environment variable. `insecure` - A boolean flag that indicates if the server TLS certificate and host name should be checked. `ca_file` - A PEM file containing the trusted CA certificates. The certificate presented by the server will be verified using these CA certificates. If ``ca_file`` parameter is not set, system wide CA certificate store is used. Default value is set by OVIRT_CAFILE environment variable. `kerberos` - A boolean flag indicating if Kerberos authentication should be used instead of the default basic authentication. `headers` - Dictionary of HTTP headers to be added to each API call.
clone_permissions	Default: no	If True then the permissions of the VM (only the direct ones, not the inherited ones) will be copied to the created template. This parameter is used only when `state` present.
cluster		Name of the cluster, where template should be created/imported.
cluster_mappings (added in 2.5)		Mapper which maps cluster name between Template's OVF and the destination cluster this Template should be registered to, relevant when `state` is registered. Cluster mapping is described by the following dictionary: `source_name`: The name of the source cluster. `dest_name`: The name of the destination cluster.
cpu_profile		CPU profile to be set to template.
description		Description of the template.
domain_mappings (added in 2.5)		Mapper which maps aaa domain name between Template's OVF and the destination aaa domain this Template should be registered to, relevant when `state` is registered. The aaa domain mapping is described by the following dictionary: `source_name`: The name of the source aaa domain. `dest_name`: The name of the destination aaa domain.
exclusive		When `state` is exported this parameter indicates if the existing templates with the same name should be overwritten.
export_domain		When `state` is exported or imported this parameter specifies the name of the export storage domain.
fetch_nested (added in 2.3)		If True the module will fetch additional data from the API. It will fetch IDs of the VMs disks, snapshots, etc. User can configure to fetch other attributes of the nested entities by specifying `nested_attributes`.
id (added in 2.4)		ID of the template to be registered.
image_disk		When `state` is imported and `image_provider` is used this parameter specifies the name of disk to be imported as template. aliases: glance_image_disk_name
image_provider		When `state` is imported this parameter specifies the name of the image provider to be used.
name		Name of the template to manage.
nested_attributes (added in 2.3)		Specifies list of the attributes which should be fetched from the API. This parameter apply only when `fetch_nested` is true.
poll_interval	Default: 3	Number of the seconds the module waits until another poll request on entity status is sent.
role_mappings (added in 2.5)		Mapper which maps role name between Template's OVF and the destination role this Template should be registered to, relevant when `state` is registered. Role mapping is described by the following dictionary: `source_name`: The name of the source role. `dest_name`: The name of the destination role.
seal (added in 2.5)	Default: no	'Sealing' is an operation that erases all machine-specific configurations from a filesystem: This includes SSH keys, UDEV rules, MAC addresses, system ID, hostname, etc. If true subsequent virtual machines made from this template will avoid configuration inheritance. This parameter is used only when `state` present.
state	Choices: present ← absent exported imported registered	Should the template be present/absent/exported/imported/registered. When `state` is registered and the unregistered template's name belongs to an already registered in engine template in the same DC then we fail to register the unregistered template.
storage_domain		When `state` is imported this parameter specifies the name of the destination data storage domain. When `state` is registered this parameter specifies the name of the data storage domain of the unregistered template.
template_image_disk_name (added in 2.4)		When `state` is imported and `image_provider` is used this parameter specifies the new name for imported disk, if omitted then image_disk name is used by default. This parameter is used only in case of importing disk image from Glance domain.
timeout	Default: 180	The amount of time in seconds the module should wait for the instance to get into desired state.
vm		Name of the VM, which will be used to create template.
vnic_profile_mappings (added in 2.5)		Mapper which maps an external virtual NIC profile to one that exists in the engine when `state` is registered. vnic_profile is described by the following dictionary: `source_network_name`: The network name of the source network. `source_profile_name`: The prfile name related to the source network. `target_profile_id`: The id of the target profile id to be mapped to in the engine.
wait		True if the module should wait for the entity to get into desired state.

Notes

Note

In order to use this module you have to install oVirt Python SDK. To ensure it’s installed with correct version you can create the following task: pip: name=ovirt-engine-sdk-python version=4.0.0

Examples

# 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

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Returned	Description
id str	On success if template is found.	ID of the template which is managed Sample: 7de90f31-222c-436c-a1ca-7e655bd5b60c
template dict	On success if template is found.	Dictionary of all the template attributes. Template attributes can be found on your oVirt/RHV instance at following url: http://ovirt.github.io/ovirt-engine-api-model/master/#types/template.

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Author

Ondra Machacek (@machacekondra)

Hint

If you notice any issues in this documentation you can edit this document to improve it.

© 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