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

New in version 2.3.

Synopsis
Requirements (on host that executes module)
Options
Examples
Return Values
Notes
- Status

Synopsis

Module to manage virtual machine templates in oVirt/RHV.

Requirements (on host that executes module)

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

Options

parameter	required	default	choices	comments
allow_partial_import (added in 2.4)	no			Boolean indication whether to allow partial registration of a template when `state` is registered.
auth	yes			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	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	no			Name of the cluster, where template should be created/imported.
cpu_profile	no			CPU profile to be set to template.
description	no			Description of the template.
exclusive	no			When `state` is exported this parameter indicates if the existing templates with the same name should be overwritten.
export_domain	no			When `state` is exported or imported this parameter specifies the name of the export storage domain.
fetch_nested (added in 2.3)	no			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)	no			ID of the template to be registered.
image_disk	no			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	no			When `state` is imported this parameter specifies the name of the image provider to be used.
name	no			Name of the template to manage.
nested_attributes (added in 2.3)	no			Specifies list of the attributes which should be fetched from the API. This parameter apply only when `fetch_nested` is true.
poll_interval	no	3		Number of the seconds the module waits until another poll request on entity status is sent.
state	no	present	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	no			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)	no			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	no	180		The amount of time in seconds the module should wait for the instance to get into desired state.
vm	no			Name of the VM, which will be used to create template.
wait	no			True if the module should wait for the entity to get into desired state.

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

# 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 Return Values, the following are the fields unique to this module:

name	description	returned	type	sample
id	ID of the template which is managed	On success if template is found.	str	7de90f31-222c-436c-a1ca-7e655bd5b60c
template	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.	On success if template is found.	dict

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

Status

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

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/ovirt_templates_module.html