Parameter |
Choices/Defaults |
Comments |
allow_partial_import
boolean
added in 2.4 |
|
Boolean indication whether to allow partial registration of a template when state is registered.
|
auth
dictionary
/ required
|
|
Dictionary with values needed to create HTTP/HTTPS connection to oVirt:
|
|
ca_file
string
|
|
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.
|
|
headers
dictionary
|
|
Dictionary of HTTP headers to be added to each API call.
|
|
hostname
string
|
|
A string containing the hostname of the server, usually something like `server.example.com`.
Default value is set by OVIRT_HOSTNAME environment variable.
Either url or hostname is required.
|
|
insecure
boolean
|
|
A boolean flag that indicates if the server TLS certificate and host name should be checked.
|
|
kerberos
boolean
|
|
A boolean flag indicating if Kerberos authentication should be used instead of the default basic authentication.
|
|
password
string
/ required
|
|
The password of the user.
Default value is set by OVIRT_PASSWORD environment variable.
|
|
token
string
|
|
Token to be used instead of login with username/password.
Default value is set by OVIRT_TOKEN environment variable.
|
|
url
string
|
|
A string containing the API URL of the server, usually something like `https://server.example.com/ovirt-engine/api`.
Default value is set by OVIRT_URL environment variable.
Either url or hostname is required.
|
|
username
string
/ required
|
|
The name of the user, something like admin@internal.
Default value is set by OVIRT_USERNAME environment variable.
|
ballooning_enabled
boolean
added in 2.9 |
|
If true, use memory ballooning.
Memory balloon is a guest device, which may be used to re-distribute / reclaim the host memory based on VM needs in a dynamic way. In this way it's possible to create memory over commitment states.
|
clone_name
-
added in 2.8 |
|
Name for importing Template from storage domain.
If not defined, name will be used.
|
clone_permissions
boolean
|
|
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.
|
cloud_init
-
added in 2.9 |
|
Dictionary with values for Unix-like Virtual Machine initialization using cloud init.
|
|
authorized_ssh_keys
-
|
|
Use this SSH keys to login to Virtual Machine.
|
|
custom_script
-
|
|
Cloud-init script which will be executed on Virtual Machine when deployed.
This is appended to the end of the cloud-init script generated by any other options.
|
|
dns_search
-
|
|
DNS search domains to be configured on Virtual Machine.
|
|
dns_servers
-
|
|
DNS servers to be configured on Virtual Machine.
|
|
host_name
-
|
|
Hostname to be set to Virtual Machine when deployed.
|
|
nic_boot_protocol
-
|
Choices:
- none
- dhcp
- static
|
Set boot protocol of the network interface of Virtual Machine.
|
|
nic_gateway
-
|
|
If boot protocol is static, set this gateway to network interface of Virtual Machine.
|
|
nic_ip_address
-
|
|
If boot protocol is static, set this IP address to network interface of Virtual Machine.
|
|
nic_name
-
|
|
Set name to network interface of Virtual Machine.
|
|
nic_netmask
-
|
|
If boot protocol is static, set this netmask to network interface of Virtual Machine.
|
|
nic_on_boot
boolean
|
|
If True network interface will be set to start on boot.
|
|
regenerate_ssh_keys
boolean
|
|
If True SSH keys will be regenerated on Virtual Machine.
|
|
root_password
-
|
|
Password to be set for user specified by user_name parameter.
|
|
timezone
-
|
|
Timezone to be set to Virtual Machine when deployed.
|
|
user_name
-
|
|
Username to be used to set password to Virtual Machine when deployed.
|
cloud_init_nics
-
added in 2.9 |
|
List of dictionaries representing network interfaces to be setup by cloud init.
This option is used, when user needs to setup more network interfaces via cloud init.
If one network interface is enough, user should use cloud_init nic_* parameters. cloud_init nic_* parameters are merged with cloud_init_nics parameters.
|
|
nic_boot_protocol
-
|
|
Set boot protocol of the network interface of Virtual Machine. Can be one of none , dhcp or static .
|
|
nic_gateway
-
|
|
If boot protocol is static, set this gateway to network interface of Virtual Machine.
|
|
nic_ip_address
-
|
|
If boot protocol is static, set this IP address to network interface of Virtual Machine.
|
|
nic_name
-
|
|
Set name to network interface of Virtual Machine.
|
|
nic_netmask
-
|
|
If boot protocol is static, set this netmask to network interface of Virtual Machine.
|
|
nic_on_boot
boolean
|
|
If True network interface will be set to start on boot.
|
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:
|
|
dest_name
-
|
|
The name of the destination cluster.
|
|
source_name
-
|
|
The name of the source 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:
|
|
dest_name
-
|
|
The name of the destination aaa domain.
|
|
source_name
-
|
|
The name of the source aaa domain.
|
exclusive
boolean
|
|
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
boolean
|
|
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.
|
io_threads
-
added in 2.7 |
|
Number of IO threads used by virtual machine. 0 means IO threading disabled.
|
memory
-
added in 2.6 |
|
Amount of memory of the template. Prefix uses IEC 60027-2 standard (for example 1GiB, 1024MiB).
|
memory_guaranteed
-
added in 2.6 |
|
Amount of minimal guaranteed memory of the template. Prefix uses IEC 60027-2 standard (for example 1GiB, 1024MiB).
memory_guaranteed parameter can't be lower than memory parameter.
|
memory_max
-
added in 2.6 |
|
Upper bound of template memory up to which memory hot-plug can be performed. Prefix uses IEC 60027-2 standard (for example 1GiB, 1024MiB).
|
name
-
|
|
Name of the template to manage.
|
nested_attributes
list
|
|
Specifies list of the attributes which should be fetched from the API.
This parameter apply only when fetch_nested is true.
|
nics
-
added in 2.9 |
|
List of NICs, which should be attached to Virtual Machine. NIC is described by following dictionary.
|
|
interface
-
|
Choices:
virtio ←
- e1000
- rtl8139
|
Type of the network interface.
|
|
mac_address
-
|
|
Custom MAC address of the network interface, by default it's obtained from MAC pool.
|
|
name
-
|
|
Name of the NIC.
|
|
profile_name
-
|
|
Profile name where NIC should be attached.
|
operating_system
-
added in 2.6 |
|
Operating system of the template.
Default value is set by oVirt/RHV engine.
Possible values are: 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
|
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:
|
|
dest_name
-
|
|
The name of the destination role.
|
|
source_name
-
|
|
The name of the source role.
|
seal
boolean
added in 2.5 |
|
'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.
|
smartcard_enabled
boolean
added in 2.9 |
|
If true, use smart card authentication.
|
soundcard_enabled
boolean
added in 2.9 |
|
If true, the sound card is added to the virtual machine.
|
sso
boolean
added in 2.9 |
|
True enable Single Sign On by Guest Agent, False to disable it. By default is chosen by oVirt/RHV engine.
|
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.
|
sysprep
-
added in 2.9 |
|
Dictionary with values for Windows Virtual Machine initialization using sysprep.
|
|
active_directory_ou
-
|
|
Active Directory Organizational Unit, to be used for login of user.
|
|
domain
-
|
|
Domain to be set to Windows Virtual Machine.
|
|
host_name
-
|
|
Hostname to be set to Virtual Machine when deployed.
|
|
input_locale
-
|
|
Input localization of the Windows Virtual Machine.
|
|
org_name
-
|
|
Organization name to be set to Windows Virtual Machine.
|
|
root_password
-
|
|
Password to be set for username to Windows Virtual Machine.
|
|
system_locale
-
|
|
System localization of the Windows Virtual Machine.
|
|
timezone
-
|
|
Timezone to be set to Windows Virtual Machine.
|
|
ui_language
-
|
|
UI language of the Windows Virtual Machine.
|
|
user_name
-
|
|
Username to be used for set password to Windows Virtual Machine.
|
|
windows_license_key
-
|
|
License key to be set to Windows Virtual Machine.
|
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
integer
|
Default:
180
|
The amount of time in seconds the module should wait for the instance to get into desired state.
|
timezone
-
added in 2.9 |
|
Sets time zone offset of the guest hardware clock.
For example Etc/GMT
|
usb_support
boolean
added in 2.9 |
|
True enable USB support, False to disable it. By default is chosen by oVirt/RHV engine.
|
version
-
added in 2.8 |
|
name - The name of this version.
number - The index of this version in the versions hierarchy of the template. Used for editing of sub template.
|
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 profile name related to the source network.
|
|
target_profile_id
-
|
|
The id of the target profile id to be mapped to in the engine.
|
wait
boolean
|
|
yes if the module should wait for the entity to get into desired state.
|