Class: Ansible::Ruby::Modules::Ovirt_vm

Inherits:

Base

• Object
• Ansible::Ruby::Models::Base
• Base
• Ansible::Ruby::Modules::Ovirt_vm

Defined in:

lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_vm.rb,
lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_vms.rb

Overview

This module manages whole lifecycle of the Virtual Machine(VM) in oVirt/RHV. Since VM can hold many states in oVirt/RHV, this see notes to see how the states of the VM are handled.

Instance Method Summary

• #affinity_group_mappings ⇒ Array<Hash>, ...

  Mapper which maps affinty name between VM’s OVF and the destination affinity this VM should be registered to, relevant when C(state) is registered.

• #affinity_label_mappings ⇒ Array<Hash>, ...

  Mappper which maps affinity label name between VM’s OVF and the destination label this VM should be registered to, relevant when C(state) is registered.

• #allow_partial_import ⇒ Symbol^?

  Boolean indication whether to allow partial registration of Virtual Machine when C(state) is registered.

• #ballooning_enabled ⇒ Symbol^?

  If I(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.

• #boot_devices ⇒ :cdrom, ...

  List of boot devices which should be used to boot.

• #boot_menu ⇒ Symbol^?

  I(True) enable menu to select boot device, I(False) to disable it.

• #cd_iso ⇒ String^?

  ISO file from ISO storage domain which should be attached to Virtual Machine.,If you pass empty string the CD will be ejected from VM.,If used with C(state) I(running) or I(present) and VM is running the CD will be attached to VM.,If used with C(state) I(running) or I(present) and VM is down the CD will be attached to VM persistently.

• #clone ⇒ :yes, ...

  If I(yes) then the disks of the created virtual machine will be cloned and independent of the template.,This parameter is used only when C(state) is I(running) or I(present) and VM didn’t exist before.

• #clone_permissions ⇒ :yes, ...

  If I(yes) then the permissions of the template (only the direct ones, not the inherited ones) will be copied to the created virtual machine.,This parameter is used only when C(state) is I(running) or I(present) and VM didn’t exist before.

• #cloud_init ⇒ Hash^?

  Dictionary with values for Unix-like Virtual Machine initialization using cloud init.,C(host_name) - Hostname to be set to Virtual Machine when deployed.,C(timezone) - Timezone to be set to Virtual Machine when deployed.,C(user_name) - Username to be used to set password to Virtual Machine when deployed.,C(root_password) - Password to be set for user specified by C(user_name) parameter.,C(authorized_ssh_keys) - Use this SSH keys to login to Virtual Machine.,C(regenerate_ssh_keys) - If I(True) SSH keys will be regenerated on Virtual Machine.,C(custom_script) - Cloud-init script which will be executed on Virtual Machine when deployed.

• #cloud_init_nics ⇒ Array<Hash>, ...

  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 C(cloud_init) I(nic_*) parameters.

• #cloud_init_persist ⇒ Symbol^?

  If I(true) the C(cloud_init) or C(sysprep) parameters will be saved for the virtual machine and won’t be virtual machine won’t be started as run-once.

• #cluster ⇒ String^?

  Name of the cluster, where Virtual Machine should be created.,Required if creating VM.

• #cluster_mappings ⇒ Array<Hash>, ...

  Mapper which maps cluster name between VM’s OVF and the destination cluster this VM should be registered to, relevant when C(state) is registered.

• #comment ⇒ Object^?

  Comment of the Virtual Machine.

• #cpu_cores ⇒ Integer^?

  Number of virtual CPUs cores of the Virtual Machine.,Default value is set by oVirt/RHV engine.

• #cpu_mode ⇒ Object^?

  CPU mode of the virtual machine.

• #cpu_pinning ⇒ Object^?

  CPU Pinning topology to map virtual machine CPU to host CPU.,CPU Pinning topology is a list of dictionary which can have following values:,C(cpu) - Number of the host CPU.,C(vcpu) - Number of the virtual machine CPU.

• #cpu_shares ⇒ Integer^?

  Set a CPU shares for this Virtual Machine.,Default value is set by oVirt/RHV engine.

• #cpu_sockets ⇒ Integer^?

  Number of virtual CPUs sockets of the Virtual Machine.,Default value is set by oVirt/RHV engine.

• #cpu_threads ⇒ Object^?

  Number of virtual CPUs sockets of the Virtual Machine.,Default value is set by oVirt/RHV engine.

• #custom_compatibility_version ⇒ Object^?

  Enables a virtual machine to be customized to its own compatibility version.

• #custom_properties ⇒ Object^?

  Properties sent to VDSM to configure various hooks.,Custom properties is a list of dictionary which can have following values:,C(name) - Name of the custom property.

• #delete_protected ⇒ Symbol^?

  If I(yes) Virtual Machine will be set as delete protected.,If I(no) Virtual Machine won’t be set as delete protected.,If no value is passed, default value is set by oVirt/RHV engine.

• #description ⇒ Object^?

  Description of the Virtual Machine.

• #disk_format ⇒ :cow, ...

  Specify format of the disk.,If C(cow) format is used, disk will by created as sparse, so space will be allocated for the volume as needed, also known as I(thin provision).,If C(raw) format is used, disk storage will be allocated right away, also known as I(preallocated).,Note that this option isn’t idempotent as it’s not currently possible to change format of the disk via API.,This parameter is considered only when C(template) and C(storage domain) is provided.

• #disks ⇒ Array<Hash>, ...

  List of disks, which should be attached to Virtual Machine.

• #domain_mappings ⇒ Array<Hash>, ...

  Mapper which maps aaa domain name between VM’s OVF and the destination aaa domain this VM should be registered to, relevant when C(state) is registered.

• #force ⇒ :yes, ...

  Please check to I(Synopsis) to more detailed description of force parameter, it can behave differently in different situations.

• #graphical_console ⇒ Hash^?

  Assign graphical console to the virtual machine.,Graphical console is a dictionary which can have following values:,C(headless_mode) - If I(true) disable the graphics console for this virtual machine.,C(protocol) - Graphical protocol, a list of I(spice), I(vnc), or both.

• #high_availability ⇒ Symbol^?

  If I(yes) Virtual Machine will be set as highly available.,If I(no) Virtual Machine won’t be set as highly available.,If no value is passed, default value is set by oVirt/RHV engine.

• #high_availability_priority ⇒ Integer^?

  Indicates the priority of the virtual machine inside the run and migration queues.

• #host ⇒ String^?

  Specify host where Virtual Machine should be running.

• #host_devices ⇒ Array<Hash>, ...

  Single Root I/O Virtualization - technology that allows single device to expose multiple endpoints that can be passed to VMs,host_devices is an list which contain dictinary with name and state of device.

• #id ⇒ String^?

  ID of the Virtual Machine to manage.

• #initrd_path ⇒ Object^?

  Path to an initial ramdisk to be used with the kernel specified by C(kernel_path) option.,Ramdisk image must be stored on either the ISO domain or on the host’s storage.

• #instance_type ⇒ Object^?

  Name of virtual machine’s hardware configuration.,By default no instance type is used.

• #io_threads ⇒ Object^?

  Number of IO threads used by virtual machine.

• #kernel_params ⇒ Object^?

  Kernel command line parameters (formatted as string) to be used with the kernel specified by C(kernel_path) option.

• #kernel_path ⇒ Object^?

  Path to a kernel image used to boot the virtual machine.,Kernel image must be stored on either the ISO domain or on the host’s storage.

• #kvm ⇒ Object^?

  Dictionary of values to be used to connect to kvm and import a virtual machine to oVirt.,Dictionary can contain following values.,C(name) - The name of the KVM virtual machine.,C(username) - The username to authenticate against the KVM.,C(password) - The password to authenticate against the KVM.,C(url) - The URL to be passed to the I(virt-v2v) tool for conversion.

• #lease ⇒ Object^?

  Name of the storage domain this virtual machine lease reside on.,NOTE - Supported since oVirt 4.1.

• #lun_mappings ⇒ Array<Hash>, ...

  Mapper which maps lun between VM’s OVF and the destination lun this VM should contain, relevant when C(state) is registered.

• #memory ⇒ String^?

  Amount of memory of the Virtual Machine.

• #memory_guaranteed ⇒ Object^?

  Amount of minimal guaranteed memory of the Virtual Machine.

• #memory_max ⇒ Object^?

  Upper bound of virtual machine memory up to which memory hot-plug can be performed.

• #name ⇒ String^?

  Name of the Virtual Machine to manage.,If VM don’t exists C(name) is required.

• #nics ⇒ Array<Hash>, ...

  List of NICs, which should be attached to Virtual Machine.

• #numa_nodes ⇒ Array<Hash>, ...

  List of vNUMA Nodes to set for this VM and pin them to assigned host’s physical NUMA node.,Each vNUMA node is described by following dictionary:,C(index) - The index of this NUMA node (mandatory).,C(memory) - Memory size of the NUMA node in MiB (mandatory).,C(cores) - list of VM CPU cores indexes to be included in this NUMA node (mandatory).,C(numa_node_pins) - list of physical NUMA node indexes to pin this virtual NUMA node to.

• #numa_tune_mode ⇒ :interleave, ...

  Set how the memory allocation for NUMA nodes of this VM is applied (relevant if NUMA nodes are set for this VM).,It can be one of the following: I(interleave), I(preferred) or I(strict).,If no value is passed, default value is set by oVirt/RHV engine.

• #operating_system ⇒ String^?

  Operating system of the Virtual Machine.,Default value is set by oVirt/RHV engine.,Possible values: 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.

• #placement_policy ⇒ String^?

  The configuration of the virtual machine’s placement policy.,Placement policy can be one of the following values:,C(migratable) - Allow manual and automatic migration.,C(pinned) - Do not allow migration.,C(user_migratable) - Allow manual migration only.,If no value is passed, default value is set by oVirt/RHV engine.

• #quota_id ⇒ String^?

  Virtual Machine quota ID to be used for disk.

• #reassign_bad_macs ⇒ Symbol^?

  Boolean indication whether to reassign bad macs when C(state) is registered.

• #rng_device ⇒ Object^?

  Random number generator (RNG).

• #role_mappings ⇒ Array<Hash>, ...

  Mapper which maps role name between VM’s OVF and the destination role this VM should be registered to, relevant when C(state) is registered.

• #serial_console ⇒ Symbol^?

  I(True) enable VirtIO serial console, I(False) to disable it.

• #serial_policy ⇒ :vm, ...

  Specify a serial number policy for the Virtual Machine.,Following options are supported.,C(vm) - Sets the Virtual Machine’s UUID as its serial number.,C(host) - Sets the host’s UUID as the Virtual Machine’s serial number.,C(custom) - Allows you to specify a custom serial number in C(serial_policy_value).

• #serial_policy_value ⇒ Object^?

  Allows you to specify a custom serial number.,This parameter is used only when C(serial_policy) is I(custom).

• #smartcard_enabled ⇒ Symbol^?

  If I(true), use smart card authentication.

• #soundcard_enabled ⇒ Symbol^?

  If I(true), the sound card is added to the virtual machine.

• #sso ⇒ Symbol^?

  I(True) enable Single Sign On by Guest Agent, I(False) to disable it.

• #state ⇒ :absent, ...

  Should the Virtual Machine be running/stopped/present/absent/suspended/next_run/registered.

• #stateless ⇒ Symbol^?

  If I(yes) Virtual Machine will be set as stateless.,If I(no) Virtual Machine will be unset as stateless.,If no value is passed, default value is set by oVirt/RHV engine.

• #storage_domain ⇒ String^?

  Name of the storage domain where all template disks should be created.,This parameter is considered only when C(template) is provided.,IMPORTANT - This parameter is not idempotent, if the VM exists and you specfiy different storage domain, disk won’t move.

• #sysprep ⇒ Hash^?

  Dictionary with values for Windows Virtual Machine initialization using sysprep.,C(host_name) - Hostname to be set to Virtual Machine when deployed.,C(active_directory_ou) - Active Directory Organizational Unit, to be used for login of user.,C(org_name) - Organization name to be set to Windows Virtual Machine.,C(domain) - Domain to be set to Windows Virtual Machine.,C(timezone) - Timezone to be set to Windows Virtual Machine.,C(ui_language) - UI language of the Windows Virtual Machine.,C(system_locale) - System localization of the Windows Virtual Machine.,C(input_locale) - Input localization of the Windows Virtual Machine.,C(windows_license_key) - License key to be set to Windows Virtual Machine.,C(user_name) - Username to be used for set password to Windows Virtual Machine.,C(root_password) - Password to be set for username to Windows Virtual Machine.

• #template ⇒ String^?

  Name of the template, which should be used to create Virtual Machine.,Required if creating VM.,If template is not specified and VM doesn’t exist, VM will be created from I(Blank) template.

• #template_version ⇒ Object^?

  Version number of the template to be used for VM.,By default the latest available version of the template is used.

• #ticket ⇒ Symbol^?

  If I(true), in addition return I(remote_vv_file) inside I(vm) dictionary, which contains compatible content for remote-viewer application.

• #timezone ⇒ Object^?

  Sets time zone offset of the guest hardware clock.,For example C(Etc/GMT).

• #type ⇒ :desktop, ...

  Type of the Virtual Machine.,Default value is set by oVirt/RHV engine.,I(high_performance) is supported since Ansible 2.5 and oVirt/RHV 4.2.

• #usb_support ⇒ Symbol^?

  I(True) enable USB support, I(False) to disable it.

• #use_latest_template_version ⇒ Symbol^?

  Specify if latest template version should be used, when running a stateless VM.,If this parameter is set to I(yes) stateless VM is created.

• #vmware ⇒ Hash^?

  Dictionary of values to be used to connect to VMware and import a virtual machine to oVirt.,Dictionary can contain following values.,C(username) - The username to authenticate against the VMware.,C(password) - The password to authenticate against the VMware.,C(url) - The URL to be passed to the I(virt-v2v) tool for conversion.

• #vnic_profile_mappings ⇒ Array<Hash>, ...

  Mapper which maps an external virtual NIC profile to one that exists in the engine when C(state) is registered.

• #watchdog ⇒ Object^?

  Assign watchdog device for the virtual machine.,Watchdogs is a dictionary which can have following values:,C(model) - Model of the watchdog device.

• #xen ⇒ Object^?

  Dictionary of values to be used to connect to XEN and import a virtual machine to oVirt.,Dictionary can contain following values.,C(url) - The URL to be passed to the I(virt-v2v) tool for conversion.

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, fix_inclusion, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#affinity_group_mappings ⇒ Array<Hash>, ...

Returns Mapper which maps affinty name between VM’s OVF and the destination affinity this VM should be registered to, relevant when C(state) is registered.

Returns:

• (Array<Hash>, Hash, nil) —

  Mapper which maps affinty name between VM’s OVF and the destination affinity this VM should be registered to, relevant when C(state) is registered.

# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_vm.rb', line 49

attribute :affinity_group_mappings

#affinity_label_mappings ⇒ Array<Hash>, ...

Returns Mappper which maps affinity label name between VM’s OVF and the destination label this VM should be registered to, relevant when C(state) is registered.

Returns:

• (Array<Hash>, Hash, nil) —

  Mappper which maps affinity label name between VM’s OVF and the destination label this VM should be registered to, relevant when C(state) is registered.

# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_vm.rb', line 53

attribute :affinity_label_mappings

#allow_partial_import ⇒ Symbol^?

Returns Boolean indication whether to allow partial registration of Virtual Machine when C(state) is registered.

Returns:

• (Symbol, nil) —

  Boolean indication whether to allow partial registration of Virtual Machine when C(state) is registered.

# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_vm.rb', line 29

attribute :allow_partial_import

#ballooning_enabled ⇒ Symbol^?

Returns If I(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.

Returns:

• (Symbol, nil) —

  If I(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.

# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_vm.rb', line 274

attribute :ballooning_enabled

#boot_devices ⇒ :cdrom, ...

Returns List of boot devices which should be used to boot. For example C([ cdrom, hd ]).,Default value is set by oVirt/RHV engine.

Returns:

• (:cdrom, :hd, :network, nil) —

  List of boot devices which should be used to boot. For example C([ cdrom, hd ]).,Default value is set by oVirt/RHV engine.

# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_vm.rb', line 121

attribute :boot_devices

#boot_menu ⇒ Symbol^?

Returns I(True) enable menu to select boot device, I(False) to disable it. By default is chosen by oVirt/RHV engine.

Returns:

• (Symbol, nil) —

  I(True) enable menu to select boot device, I(False) to disable it. By default is chosen by oVirt/RHV engine.

# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_vm.rb', line 125

attribute :boot_menu

#cd_iso ⇒ String^?

Returns ISO file from ISO storage domain which should be attached to Virtual Machine.,If you pass empty string the CD will be ejected from VM.,If used with C(state) I(running) or I(present) and VM is running the CD will be attached to VM.,If used with C(state) I(running) or I(present) and VM is down the CD will be attached to VM persistently.

Returns:

• (String, nil) —

  ISO file from ISO storage domain which should be attached to Virtual Machine.,If you pass empty string the CD will be ejected from VM.,If used with C(state) I(running) or I(present) and VM is running the CD will be attached to VM.,If used with C(state) I(running) or I(present) and VM is down the CD will be attached to VM persistently.

# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_vm.rb', line 179

attribute :cd_iso

#clone ⇒ :yes, ...

Returns If I(yes) then the disks of the created virtual machine will be cloned and independent of the template.,This parameter is used only when C(state) is I(running) or I(present) and VM didn’t exist before.

Returns:

• (:yes, :no, nil) —

  If I(yes) then the disks of the created virtual machine will be cloned and independent of the template.,This parameter is used only when C(state) is I(running) or I(present) and VM didn’t exist before.

# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_vm.rb', line 171

attribute :clone

#clone_permissions ⇒ :yes, ...

Returns If I(yes) then the permissions of the template (only the direct ones, not the inherited ones) will be copied to the created virtual machine.,This parameter is used only when C(state) is I(running) or I(present) and VM didn’t exist before.

Returns:

• (:yes, :no, nil) —

  If I(yes) then the permissions of the template (only the direct ones, not the inherited ones) will be copied to the created virtual machine.,This parameter is used only when C(state) is I(running) or I(present) and VM didn’t exist before.

# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_vm.rb', line 175

attribute :clone_permissions

#cloud_init ⇒ Hash^?

Returns Dictionary with values for Unix-like Virtual Machine initialization using cloud init.,C(host_name) - Hostname to be set to Virtual Machine when deployed.,C(timezone) - Timezone to be set to Virtual Machine when deployed.,C(user_name) - Username to be used to set password to Virtual Machine when deployed.,C(root_password) - Password to be set for user specified by C(user_name) parameter.,C(authorized_ssh_keys) - Use this SSH keys to login to Virtual Machine.,C(regenerate_ssh_keys) - If I(True) SSH keys will be regenerated on Virtual Machine.,C(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.,C(dns_servers) - DNS servers to be configured on Virtual Machine.,C(dns_search) - DNS search domains to be configured on Virtual Machine.,C(nic_boot_protocol) - Set boot protocol of the network interface of Virtual Machine. Can be one of C(none), C(dhcp) or C(static).,C(nic_ip_address) - If boot protocol is static, set this IP address to network interface of Virtual Machine.,C(nic_netmask) - If boot protocol is static, set this netmask to network interface of Virtual Machine.,C(nic_gateway) - If boot protocol is static, set this gateway to network interface of Virtual Machine.,C(nic_name) - Set name to network interface of Virtual Machine.,C(nic_on_boot) - If I(True) network interface will be set to start on boot.

Returns:

• (Hash, nil) —

  Dictionary with values for Unix-like Virtual Machine initialization using cloud init.,C(host_name) - Hostname to be set to Virtual Machine when deployed.,C(timezone) - Timezone to be set to Virtual Machine when deployed.,C(user_name) - Username to be used to set password to Virtual Machine when deployed.,C(root_password) - Password to be set for user specified by C(user_name) parameter.,C(authorized_ssh_keys) - Use this SSH keys to login to Virtual Machine.,C(regenerate_ssh_keys) - If I(True) SSH keys will be regenerated on Virtual Machine.,C(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.,C(dns_servers) - DNS servers to be configured on Virtual Machine.,C(dns_search) - DNS search domains to be configured on Virtual Machine.,C(nic_boot_protocol) - Set boot protocol of the network interface of Virtual Machine. Can be one of C(none), C(dhcp) or C(static).,C(nic_ip_address) - If boot protocol is static, set this IP address to network interface of Virtual Machine.,C(nic_netmask) - If boot protocol is static, set this netmask to network interface of Virtual Machine.,C(nic_gateway) - If boot protocol is static, set this gateway to network interface of Virtual Machine.,C(nic_name) - Set name to network interface of Virtual Machine.,C(nic_on_boot) - If I(True) network interface will be set to start on boot.

# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_vm.rb', line 199

attribute :cloud_init

#cloud_init_nics ⇒ Array<Hash>, ...

Returns 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 C(cloud_init) I(nic_*) parameters. C(cloud_init) I(nic_*) parameters are merged with C(cloud_init_nics) parameters.,Dictionary can contain following values.,C(nic_boot_protocol) - Set boot protocol of the network interface of Virtual Machine. Can be one of C(none), C(dhcp) or C(static).,C(nic_ip_address) - If boot protocol is static, set this IP address to network interface of Virtual Machine.,C(nic_netmask) - If boot protocol is static, set this netmask to network interface of Virtual Machine.,C(nic_gateway) - If boot protocol is static, set this gateway to network interface of Virtual Machine.,C(nic_name) - Set name to network interface of Virtual Machine.,C(nic_on_boot) - If I(True) network interface will be set to start on boot.

Returns:

• (Array<Hash>, Hash, nil) —

  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 C(cloud_init) I(nic_*) parameters. C(cloud_init) I(nic_*) parameters are merged with C(cloud_init_nics) parameters.,Dictionary can contain following values.,C(nic_boot_protocol) - Set boot protocol of the network interface of Virtual Machine. Can be one of C(none), C(dhcp) or C(static).,C(nic_ip_address) - If boot protocol is static, set this IP address to network interface of Virtual Machine.,C(nic_netmask) - If boot protocol is static, set this netmask to network interface of Virtual Machine.,C(nic_gateway) - If boot protocol is static, set this gateway to network interface of Virtual Machine.,C(nic_name) - Set name to network interface of Virtual Machine.,C(nic_on_boot) - If I(True) network interface will be set to start on boot.

# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_vm.rb', line 203

attribute :cloud_init_nics

#cloud_init_persist ⇒ Symbol^?

Returns If I(true) the C(cloud_init) or C(sysprep) parameters will be saved for the virtual machine and won’t be virtual machine won’t be started as run-once.

Returns:

• (Symbol, nil) —

  If I(true) the C(cloud_init) or C(sysprep) parameters will be saved for the virtual machine and won’t be virtual machine won’t be started as run-once.

# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_vm.rb', line 207

attribute :cloud_init_persist

#cluster ⇒ String^?

Returns Name of the cluster, where Virtual Machine should be created.,Required if creating VM.

Returns:

• (String, nil) —

  Name of the cluster, where Virtual Machine should be created.,Required if creating VM.

# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_vm.rb', line 25

attribute :cluster

#cluster_mappings ⇒ Array<Hash>, ...

Returns Mapper which maps cluster name between VM’s OVF and the destination cluster this VM should be registered to, relevant when C(state) is registered. Cluster mapping is described by the following dictionary:,C(source_name): The name of the source cluster.,C(dest_name): The name of the destination cluster.

Returns:

• (Array<Hash>, Hash, nil) —

  Mapper which maps cluster name between VM’s OVF and the destination cluster this VM should be registered to, relevant when C(state) is registered. Cluster mapping is described by the following dictionary:,C(source_name): The name of the source cluster.,C(dest_name): The name of the destination cluster.

# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_vm.rb', line 37

attribute :cluster_mappings

#comment ⇒ Object^?

Returns Comment of the Virtual Machine.

Returns:

• (Object, nil) —

  Comment of the Virtual Machine.

# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_vm.rb', line 226

attribute :comment

#cpu_cores ⇒ Integer^?

Returns Number of virtual CPUs cores of the Virtual Machine.,Default value is set by oVirt/RHV engine.

Returns:

• (Integer, nil) —

  Number of virtual CPUs cores of the Virtual Machine.,Default value is set by oVirt/RHV engine.

# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_vm.rb', line 98

attribute :cpu_cores

#cpu_mode ⇒ Object^?

Returns CPU mode of the virtual machine. It can be some of the following: I(host_passthrough), I(host_model) or I(custom).,For I(host_passthrough) CPU type you need to set C(placement_policy) to I(pinned).,If no value is passed, default value is set by oVirt/RHV engine.

Returns:

• (Object, nil) —

  CPU mode of the virtual machine. It can be some of the following: I(host_passthrough), I(host_model) or I(custom).,For I(host_passthrough) CPU type you need to set C(placement_policy) to I(pinned).,If no value is passed, default value is set by oVirt/RHV engine.

# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_vm.rb', line 249

attribute :cpu_mode

#cpu_pinning ⇒ Object^?

Returns CPU Pinning topology to map virtual machine CPU to host CPU.,CPU Pinning topology is a list of dictionary which can have following values:,C(cpu) - Number of the host CPU.,C(vcpu) - Number of the virtual machine CPU.

Returns:

• (Object, nil) —

  CPU Pinning topology to map virtual machine CPU to host CPU.,CPU Pinning topology is a list of dictionary which can have following values:,C(cpu) - Number of the host CPU.,C(vcpu) - Number of the virtual machine CPU.

# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_vm.rb', line 260

attribute :cpu_pinning

#cpu_shares ⇒ Integer^?

Returns Set a CPU shares for this Virtual Machine.,Default value is set by oVirt/RHV engine.

Returns:

• (Integer, nil) —

  Set a CPU shares for this Virtual Machine.,Default value is set by oVirt/RHV engine.

# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_vm.rb', line 94

attribute :cpu_shares

#cpu_sockets ⇒ Integer^?

Returns Number of virtual CPUs sockets of the Virtual Machine.,Default value is set by oVirt/RHV engine.

Returns:

• (Integer, nil) —

  Number of virtual CPUs sockets of the Virtual Machine.,Default value is set by oVirt/RHV engine.

# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_vm.rb', line 102

attribute :cpu_sockets

#cpu_threads ⇒ Object^?

Returns Number of virtual CPUs sockets of the Virtual Machine.,Default value is set by oVirt/RHV engine.

Returns:

• (Object, nil) —

  Number of virtual CPUs sockets of the Virtual Machine.,Default value is set by oVirt/RHV engine.

# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_vm.rb', line 106

attribute :cpu_threads

#custom_compatibility_version ⇒ Object^?

Returns Enables a virtual machine to be customized to its own compatibility version. If ‘C(custom_compatibility_version)’ is set, it overrides the cluster’s compatibility version for this particular virtual machine.

Returns:

• (Object, nil) —

  Enables a virtual machine to be customized to its own compatibility version. If ‘C(custom_compatibility_version)’ is set, it overrides the cluster’s compatibility version for this particular virtual machine.

# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_vm.rb', line 156

attribute :custom_compatibility_version

#custom_properties ⇒ Object^?

Returns Properties sent to VDSM to configure various hooks.,Custom properties is a list of dictionary which can have following values:,C(name) - Name of the custom property. For example: I(hugepages), I(vhost), I(sap_agent), etc.,C(regexp) - Regular expression to set for custom property.,C(value) - Value to set for custom property.

Returns:

• (Object, nil) —

  Properties sent to VDSM to configure various hooks.,Custom properties is a list of dictionary which can have following values:,C(name) - Name of the custom property. For example: I(hugepages), I(vhost), I(sap_agent), etc.,C(regexp) - Regular expression to set for custom property.,C(value) - Value to set for custom property.

# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_vm.rb', line 289

attribute :custom_properties

#delete_protected ⇒ Symbol^?

Returns If I(yes) Virtual Machine will be set as delete protected.,If I(no) Virtual Machine won’t be set as delete protected.,If no value is passed, default value is set by oVirt/RHV engine.

Returns:

• (Symbol, nil) —

  If I(yes) Virtual Machine will be set as delete protected.,If I(no) Virtual Machine won’t be set as delete protected.,If no value is passed, default value is set by oVirt/RHV engine.

# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_vm.rb', line 163

attribute :delete_protected

#description ⇒ Object^?

Returns Description of the Virtual Machine.

Returns:

• (Object, nil) —

  Description of the Virtual Machine.

# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_vm.rb', line 223

attribute :description

#disk_format ⇒ :cow, ...

Returns Specify format of the disk.,If C(cow) format is used, disk will by created as sparse, so space will be allocated for the volume as needed, also known as I(thin provision).,If C(raw) format is used, disk storage will be allocated right away, also known as I(preallocated).,Note that this option isn’t idempotent as it’s not currently possible to change format of the disk via API.,This parameter is considered only when C(template) and C(storage domain) is provided.

Returns:

• (:cow, :raw, nil) —

  Specify format of the disk.,If C(cow) format is used, disk will by created as sparse, so space will be allocated for the volume as needed, also known as I(thin provision).,If C(raw) format is used, disk storage will be allocated right away, also known as I(preallocated).,Note that this option isn’t idempotent as it’s not currently possible to change format of the disk via API.,This parameter is considered only when C(template) and C(storage domain) is provided.

# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_vm.rb', line 80

attribute :disk_format

#disks ⇒ Array<Hash>, ...

Returns List of disks, which should be attached to Virtual Machine. Disk is described by following dictionary.,C(name) - Name of the disk. Either C(name) or C(id) is required.,C(id) - ID of the disk. Either C(name) or C(id) is required.,C(interface) - Interface of the disk, either I(virtio) or I(IDE), default is I(virtio).,C(bootable) - I(True) if the disk should be bootable, default is non bootable.,C(activate) - I(True) if the disk should be activated, default is activated.,NOTE - This parameter is used only when C(state) is I(running) or I(present) and is able to only attach disks. To manage disks of the VM in more depth please use M(ovirt_disks) module instead.

Returns:

• (Array<Hash>, Hash, nil) —

  List of disks, which should be attached to Virtual Machine. Disk is described by following dictionary.,C(name) - Name of the disk. Either C(name) or C(id) is required.,C(id) - ID of the disk. Either C(name) or C(id) is required.,C(interface) - Interface of the disk, either I(virtio) or I(IDE), default is I(virtio).,C(bootable) - I(True) if the disk should be bootable, default is non bootable.,C(activate) - I(True) if the disk should be activated, default is activated.,NOTE - This parameter is used only when C(state) is I(running) or I(present) and is able to only attach disks. To manage disks of the VM in more depth please use M(ovirt_disks) module instead.

# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_vm.rb', line 191

attribute :disks

#domain_mappings ⇒ Array<Hash>, ...

Returns Mapper which maps aaa domain name between VM’s OVF and the destination aaa domain this VM should be registered to, relevant when C(state) is registered. The aaa domain mapping is described by the following dictionary:,C(source_name): The name of the source aaa domain.,C(dest_name): The name of the destination aaa domain.

Returns:

• (Array<Hash>, Hash, nil) —

  Mapper which maps aaa domain name between VM’s OVF and the destination aaa domain this VM should be registered to, relevant when C(state) is registered. The aaa domain mapping is described by the following dictionary:,C(source_name): The name of the source aaa domain.,C(dest_name): The name of the destination aaa domain.

# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_vm.rb', line 45

attribute :domain_mappings

#force ⇒ :yes, ...

Returns Please check to I(Synopsis) to more detailed description of force parameter, it can behave differently in different situations.

Returns:

• (:yes, :no, nil) —

  Please check to I(Synopsis) to more detailed description of force parameter, it can behave differently in different situations.

# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_vm.rb', line 183

attribute :force

#graphical_console ⇒ Hash^?

Returns Assign graphical console to the virtual machine.,Graphical console is a dictionary which can have following values:,C(headless_mode) - If I(true) disable the graphics console for this virtual machine.,C(protocol) - Graphical protocol, a list of I(spice), I(vnc), or both.

Returns:

• (Hash, nil) —

  Assign graphical console to the virtual machine.,Graphical console is a dictionary which can have following values:,C(headless_mode) - If I(true) disable the graphics console for this virtual machine.,C(protocol) - Graphical protocol, a list of I(spice), I(vnc), or both.

# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_vm.rb', line 295

attribute :graphical_console

#high_availability ⇒ Symbol^?

Returns If I(yes) Virtual Machine will be set as highly available.,If I(no) Virtual Machine won’t be set as highly available.,If no value is passed, default value is set by oVirt/RHV engine.

Returns:

• (Symbol, nil) —

  If I(yes) Virtual Machine will be set as highly available.,If I(no) Virtual Machine won’t be set as highly available.,If no value is passed, default value is set by oVirt/RHV engine.

# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_vm.rb', line 145

attribute :high_availability

#high_availability_priority ⇒ Integer^?

Returns Indicates the priority of the virtual machine inside the run and migration queues. Virtual machines with higher priorities will be started and migrated before virtual machines with lower priorities. The value is an integer between 0 and 100. The higher the value, the higher the priority.,If no value is passed, default value is set by oVirt/RHV engine.

Returns:

• (Integer, nil) —

  Indicates the priority of the virtual machine inside the run and migration queues. Virtual machines with higher priorities will be started and migrated before virtual machines with lower priorities. The value is an integer between 0 and 100. The higher the value, the higher the priority.,If no value is passed, default value is set by oVirt/RHV engine.

# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_vm.rb', line 149

attribute :high_availability_priority

#host ⇒ String^?

Returns Specify host where Virtual Machine should be running. By default the host is chosen by engine scheduler.,This parameter is used only when C(state) is I(running) or I(present).

Returns:

• (String, nil) —

  Specify host where Virtual Machine should be running. By default the host is chosen by engine scheduler.,This parameter is used only when C(state) is I(running) or I(present).

# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_vm.rb', line 141

attribute :host

#host_devices ⇒ Array<Hash>, ...

Returns Single Root I/O Virtualization - technology that allows single device to expose multiple endpoints that can be passed to VMs,host_devices is an list which contain dictinary with name and state of device.

Returns:

• (Array<Hash>, Hash, nil) —

  Single Root I/O Virtualization - technology that allows single device to expose multiple endpoints that can be passed to VMs,host_devices is an list which contain dictinary with name and state of device

# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_vm.rb', line 159

attribute :host_devices

#id ⇒ String^?

Returns ID of the Virtual Machine to manage.

Returns:

• (String, nil) —

  ID of the Virtual Machine to manage.

# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_vm.rb', line 17

attribute :id

#initrd_path ⇒ Object^?

Returns Path to an initial ramdisk to be used with the kernel specified by C(kernel_path) option.,Ramdisk image must be stored on either the ISO domain or on the host’s storage.

Returns:

• (Object, nil) —

  Path to an initial ramdisk to be used with the kernel specified by C(kernel_path) option.,Ramdisk image must be stored on either the ISO domain or on the host’s storage.

# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_vm.rb', line 214

attribute :initrd_path

#instance_type ⇒ Object^?

Returns Name of virtual machine’s hardware configuration.,By default no instance type is used.

Returns:

• (Object, nil) —

  Name of virtual machine’s hardware configuration.,By default no instance type is used.

# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_vm.rb', line 220

attribute :instance_type

#io_threads ⇒ Object^?

Returns Number of IO threads used by virtual machine. I(0) means IO threading disabled.

Returns:

• (Object, nil) —

  Number of IO threads used by virtual machine. I(0) means IO threading disabled.

# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_vm.rb', line 271

attribute :io_threads

#kernel_params ⇒ Object^?

Returns Kernel command line parameters (formatted as string) to be used with the kernel specified by C(kernel_path) option.

Returns:

• (Object, nil) —

  Kernel command line parameters (formatted as string) to be used with the kernel specified by C(kernel_path) option.

# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_vm.rb', line 217

attribute :kernel_params

#kernel_path ⇒ Object^?

Returns Path to a kernel image used to boot the virtual machine.,Kernel image must be stored on either the ISO domain or on the host’s storage.

Returns:

• (Object, nil) —

  Path to a kernel image used to boot the virtual machine.,Kernel image must be stored on either the ISO domain or on the host’s storage.

# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_vm.rb', line 211

attribute :kernel_path

#kvm ⇒ Object^?

Returns Dictionary of values to be used to connect to kvm and import a virtual machine to oVirt.,Dictionary can contain following values.,C(name) - The name of the KVM virtual machine.,C(username) - The username to authenticate against the KVM.,C(password) - The password to authenticate against the KVM.,C(url) - The URL to be passed to the I(virt-v2v) tool for conversion. For example I(qemu:///system). This is required parameter.,C(drivers_iso) - The name of the ISO containing drivers that can be used during the I(virt-v2v) conversion process.,C(sparse) - Specifies the disk allocation policy of the resulting virtual machine. I(true) for sparse, I(false) for preallocated. Default value is I(true).,C(storage_domain) - Specifies the target storage domain for converted disks. This is required parameter.

Returns:

• (Object, nil) —

  Dictionary of values to be used to connect to kvm and import a virtual machine to oVirt.,Dictionary can contain following values.,C(name) - The name of the KVM virtual machine.,C(username) - The username to authenticate against the KVM.,C(password) - The password to authenticate against the KVM.,C(url) - The URL to be passed to the I(virt-v2v) tool for conversion. For example I(qemu:///system). This is required parameter.,C(drivers_iso) - The name of the ISO containing drivers that can be used during the I(virt-v2v) conversion process.,C(sparse) - Specifies the disk allocation policy of the resulting virtual machine. I(true) for sparse, I(false) for preallocated. Default value is I(true).,C(storage_domain) - Specifies the target storage domain for converted disks. This is required parameter.

# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_vm.rb', line 246

attribute :kvm

#lease ⇒ Object^?

Returns Name of the storage domain this virtual machine lease reside on.,NOTE - Supported since oVirt 4.1.

Returns:

• (Object, nil) —

  Name of the storage domain this virtual machine lease reside on.,NOTE - Supported since oVirt 4.1.

# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_vm.rb', line 153

attribute :lease

#lun_mappings ⇒ Array<Hash>, ...

Returns Mapper which maps lun between VM’s OVF and the destination lun this VM should contain, relevant when C(state) is registered. lun_mappings is described by the following dictionary: - C(logical_unit_id): The logical unit number to identify a logical unit, - C(logical_unit_port): The port being used to connect with the LUN disk. - C(logical_unit_portal): The portal being used to connect with the LUN disk. - C(logical_unit_address): The address of the block storage host. - C(logical_unit_target): The iSCSI specification located on an iSCSI server - C(logical_unit_username): Username to be used to connect to the block storage host. - C(logical_unit_password): Password to be used to connect to the block storage host. - C(storage_type): The storage type which the LUN reside on (iscsi or fcp).

Returns:

• (Array<Hash>, Hash, nil) —

  Mapper which maps lun between VM’s OVF and the destination lun this VM should contain, relevant when C(state) is registered. lun_mappings is described by the following dictionary: - C(logical_unit_id): The logical unit number to identify a logical unit, - C(logical_unit_port): The port being used to connect with the LUN disk. - C(logical_unit_portal): The portal being used to connect with the LUN disk. - C(logical_unit_address): The address of the block storage host. - C(logical_unit_target): The iSCSI specification located on an iSCSI server - C(logical_unit_username): Username to be used to connect to the block storage host. - C(logical_unit_password): Password to be used to connect to the block storage host. - C(storage_type): The storage type which the LUN reside on (iscsi or fcp)

# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_vm.rb', line 57

attribute :lun_mappings

#memory ⇒ String^?

Returns Amount of memory of the Virtual Machine. Prefix uses IEC 60027-2 standard (for example 1GiB, 1024MiB).,Default value is set by engine.

Returns:

• (String, nil) —

  Amount of memory of the Virtual Machine. Prefix uses IEC 60027-2 standard (for example 1GiB, 1024MiB).,Default value is set by engine.

# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_vm.rb', line 84

attribute :memory

#memory_guaranteed ⇒ Object^?

Returns Amount of minimal guaranteed memory of the Virtual Machine. Prefix uses IEC 60027-2 standard (for example 1GiB, 1024MiB).,C(memory_guaranteed) parameter can’t be lower than C(memory) parameter.,Default value is set by engine.

Returns:

• (Object, nil) —

  Amount of minimal guaranteed memory of the Virtual Machine. Prefix uses IEC 60027-2 standard (for example 1GiB, 1024MiB).,C(memory_guaranteed) parameter can’t be lower than C(memory) parameter.,Default value is set by engine.

# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_vm.rb', line 88

attribute :memory_guaranteed

#memory_max ⇒ Object^?

Returns Upper bound of virtual machine memory up to which memory hot-plug can be performed. Prefix uses IEC 60027-2 standard (for example 1GiB, 1024MiB).,Default value is set by engine.

Returns:

• (Object, nil) —

  Upper bound of virtual machine memory up to which memory hot-plug can be performed. Prefix uses IEC 60027-2 standard (for example 1GiB, 1024MiB).,Default value is set by engine.

# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_vm.rb', line 91

attribute :memory_max

#name ⇒ String^?

Returns Name of the Virtual Machine to manage.,If VM don’t exists C(name) is required. Otherwise C(id) or C(name) can be used.

Returns:

• (String, nil) —

  Name of the Virtual Machine to manage.,If VM don’t exists C(name) is required. Otherwise C(id) or C(name) can be used.

# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_vm.rb', line 13

attribute :name

#nics ⇒ Array<Hash>, ...

Returns List of NICs, which should be attached to Virtual Machine. NIC is described by following dictionary.,C(name) - Name of the NIC.,C(profile_name) - Profile name where NIC should be attached.,C(interface) - Type of the network interface. One of following I(virtio), I(e1000), I(rtl8139), default is I(virtio).,C(mac_address) - Custom MAC address of the network interface, by default it’s obtained from MAC pool.,NOTE - This parameter is used only when C(state) is I(running) or I(present) and is able to only create NICs. To manage NICs of the VM in more depth please use M(ovirt_nics) module instead.

Returns:

• (Array<Hash>, Hash, nil) —

  List of NICs, which should be attached to Virtual Machine. NIC is described by following dictionary.,C(name) - Name of the NIC.,C(profile_name) - Profile name where NIC should be attached.,C(interface) - Type of the network interface. One of following I(virtio), I(e1000), I(rtl8139), default is I(virtio).,C(mac_address) - Custom MAC address of the network interface, by default it’s obtained from MAC pool.,NOTE - This parameter is used only when C(state) is I(running) or I(present) and is able to only create NICs. To manage NICs of the VM in more depth please use M(ovirt_nics) module instead.

# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_vm.rb', line 187

attribute :nics

#numa_nodes ⇒ Array<Hash>, ...

Returns List of vNUMA Nodes to set for this VM and pin them to assigned host’s physical NUMA node.,Each vNUMA node is described by following dictionary:,C(index) - The index of this NUMA node (mandatory).,C(memory) - Memory size of the NUMA node in MiB (mandatory).,C(cores) - list of VM CPU cores indexes to be included in this NUMA node (mandatory).,C(numa_node_pins) - list of physical NUMA node indexes to pin this virtual NUMA node to.

Returns:

• (Array<Hash>, Hash, nil) —

  List of vNUMA Nodes to set for this VM and pin them to assigned host’s physical NUMA node.,Each vNUMA node is described by following dictionary:,C(index) - The index of this NUMA node (mandatory).,C(memory) - Memory size of the NUMA node in MiB (mandatory).,C(cores) - list of VM CPU cores indexes to be included in this NUMA node (mandatory).,C(numa_node_pins) - list of physical NUMA node indexes to pin this virtual NUMA node to.

# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_vm.rb', line 282

attribute :numa_nodes

#numa_tune_mode ⇒ :interleave, ...

Returns Set how the memory allocation for NUMA nodes of this VM is applied (relevant if NUMA nodes are set for this VM).,It can be one of the following: I(interleave), I(preferred) or I(strict).,If no value is passed, default value is set by oVirt/RHV engine.

Returns:

• (:interleave, :preferred, :strict, nil) —

  Set how the memory allocation for NUMA nodes of this VM is applied (relevant if NUMA nodes are set for this VM).,It can be one of the following: I(interleave), I(preferred) or I(strict).,If no value is passed, default value is set by oVirt/RHV engine.

# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_vm.rb', line 278

attribute :numa_tune_mode

#operating_system ⇒ String^?

Returns Operating system of the Virtual Machine.,Default value is set by oVirt/RHV engine.,Possible values: 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.

Returns:

• (String, nil) —

  Operating system of the Virtual Machine.,Default value is set by oVirt/RHV engine.,Possible values: 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

# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_vm.rb', line 117

attribute :operating_system

#placement_policy ⇒ String^?

Returns The configuration of the virtual machine’s placement policy.,Placement policy can be one of the following values:,C(migratable) - Allow manual and automatic migration.,C(pinned) - Do not allow migration.,C(user_migratable) - Allow manual migration only.,If no value is passed, default value is set by oVirt/RHV engine.

Returns:

• (String, nil) —

  The configuration of the virtual machine’s placement policy.,Placement policy can be one of the following values:,C(migratable) - Allow manual and automatic migration.,C(pinned) - Do not allow migration.,C(user_migratable) - Allow manual migration only.,If no value is passed, default value is set by oVirt/RHV engine.

# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_vm.rb', line 252

attribute :placement_policy

#quota_id ⇒ String^?

Returns Virtual Machine quota ID to be used for disk. By default quota is chosen by oVirt/RHV engine.

Returns:

• (String, nil) —

  Virtual Machine quota ID to be used for disk. By default quota is chosen by oVirt/RHV engine.

# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_vm.rb', line 113

attribute :quota_id

#reassign_bad_macs ⇒ Symbol^?

Returns Boolean indication whether to reassign bad macs when C(state) is registered.

Returns:

• (Symbol, nil) —

  Boolean indication whether to reassign bad macs when C(state) is registered.

# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_vm.rb', line 61

attribute :reassign_bad_macs

#rng_device ⇒ Object^?

Returns Random number generator (RNG). You can choose of one the following devices I(urandom), I(random) or I(hwrng).,In order to select I(hwrng), you must have it enabled on cluster first.,/dev/urandom is used for cluster version >= 4.1, and /dev/random for cluster version <= 4.0.

Returns:

• (Object, nil) —

  Random number generator (RNG). You can choose of one the following devices I(urandom), I(random) or I(hwrng).,In order to select I(hwrng), you must have it enabled on cluster first.,/dev/urandom is used for cluster version >= 4.1, and /dev/random for cluster version <= 4.0

# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_vm.rb', line 286

attribute :rng_device

#role_mappings ⇒ Array<Hash>, ...

Returns Mapper which maps role name between VM’s OVF and the destination role this VM should be registered to, relevant when C(state) is registered. Role mapping is described by the following dictionary:,C(source_name): The name of the source role.,C(dest_name): The name of the destination role.

Returns:

• (Array<Hash>, Hash, nil) —

  Mapper which maps role name between VM’s OVF and the destination role this VM should be registered to, relevant when C(state) is registered. Role mapping is described by the following dictionary:,C(source_name): The name of the source role.,C(dest_name): The name of the destination role.

# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_vm.rb', line 41

attribute :role_mappings

#serial_console ⇒ Symbol^?

Returns I(True) enable VirtIO serial console, I(False) to disable it. By default is chosen by oVirt/RHV engine.

Returns:

• (Symbol, nil) —

  I(True) enable VirtIO serial console, I(False) to disable it. By default is chosen by oVirt/RHV engine.

# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_vm.rb', line 133

attribute :serial_console

#serial_policy ⇒ :vm, ...

Returns Specify a serial number policy for the Virtual Machine.,Following options are supported.,C(vm) - Sets the Virtual Machine’s UUID as its serial number.,C(host) - Sets the host’s UUID as the Virtual Machine’s serial number.,C(custom) - Allows you to specify a custom serial number in C(serial_policy_value).

Returns:

• (:vm, :host, :custom, nil) —

  Specify a serial number policy for the Virtual Machine.,Following options are supported.,C(vm) - Sets the Virtual Machine’s UUID as its serial number.,C(host) - Sets the host’s UUID as the Virtual Machine’s serial number.,C(custom) - Allows you to specify a custom serial number in C(serial_policy_value).

# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_vm.rb', line 232

attribute :serial_policy

#serial_policy_value ⇒ Object^?

Returns Allows you to specify a custom serial number.,This parameter is used only when C(serial_policy) is I(custom).

Returns:

• (Object, nil) —

  Allows you to specify a custom serial number.,This parameter is used only when C(serial_policy) is I(custom).

# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_vm.rb', line 236

attribute :serial_policy_value

#smartcard_enabled ⇒ Symbol^?

Returns If I(true), use smart card authentication.

Returns:

• (Symbol, nil) —

  If I(true), use smart card authentication.

# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_vm.rb', line 267

attribute :smartcard_enabled

#soundcard_enabled ⇒ Symbol^?

Returns If I(true), the sound card is added to the virtual machine.

Returns:

• (Symbol, nil) —

  If I(true), the sound card is added to the virtual machine.

# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_vm.rb', line 263

attribute :soundcard_enabled

#sso ⇒ Symbol^?

Returns I(True) enable Single Sign On by Guest Agent, I(False) to disable it. By default is chosen by oVirt/RHV engine.

Returns:

• (Symbol, nil) —

  I(True) enable Single Sign On by Guest Agent, I(False) to disable it. By default is chosen by oVirt/RHV engine.

# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_vm.rb', line 137

attribute :sso

#state ⇒ :absent, ...

Returns Should the Virtual Machine be running/stopped/present/absent/suspended/next_run/registered. When C(state) is I(registered) and the unregistered VM’s name belongs to an already registered in engine VM in the same DC then we fail to register the unregistered template.,I(present) state will create/update VM and don’t change its state if it already exists.,I(running) state will create/update VM and start it.,I(next_run) state updates the VM and if the VM has next run configuration it will be rebooted.,Please check I(notes) to more detailed description of states.,I(registered) is supported since 2.4.

Returns:

• (:absent, :next_run, :present, :registered, :running, :stopped, :suspended, nil) —

  Should the Virtual Machine be running/stopped/present/absent/suspended/next_run/registered. When C(state) is I(registered) and the unregistered VM’s name belongs to an already registered in engine VM in the same DC then we fail to register the unregistered template.,I(present) state will create/update VM and don’t change its state if it already exists.,I(running) state will create/update VM and start it.,I(next_run) state updates the VM and if the VM has next run configuration it will be rebooted.,Please check I(notes) to more detailed description of states.,I(registered) is supported since 2.4.

# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_vm.rb', line 21

attribute :state

#stateless ⇒ Symbol^?

Returns If I(yes) Virtual Machine will be set as stateless.,If I(no) Virtual Machine will be unset as stateless.,If no value is passed, default value is set by oVirt/RHV engine.

Returns:

• (Symbol, nil) —

  If I(yes) Virtual Machine will be set as stateless.,If I(no) Virtual Machine will be unset as stateless.,If no value is passed, default value is set by oVirt/RHV engine.

# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_vm.rb', line 167

attribute :stateless

#storage_domain ⇒ String^?

Returns Name of the storage domain where all template disks should be created.,This parameter is considered only when C(template) is provided.,IMPORTANT - This parameter is not idempotent, if the VM exists and you specfiy different storage domain, disk won’t move.

Returns:

• (String, nil) —

  Name of the storage domain where all template disks should be created.,This parameter is considered only when C(template) is provided.,IMPORTANT - This parameter is not idempotent, if the VM exists and you specfiy different storage domain, disk won’t move.

# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_vm.rb', line 76

attribute :storage_domain

#sysprep ⇒ Hash^?

Returns Dictionary with values for Windows Virtual Machine initialization using sysprep.,C(host_name) - Hostname to be set to Virtual Machine when deployed.,C(active_directory_ou) - Active Directory Organizational Unit, to be used for login of user.,C(org_name) - Organization name to be set to Windows Virtual Machine.,C(domain) - Domain to be set to Windows Virtual Machine.,C(timezone) - Timezone to be set to Windows Virtual Machine.,C(ui_language) - UI language of the Windows Virtual Machine.,C(system_locale) - System localization of the Windows Virtual Machine.,C(input_locale) - Input localization of the Windows Virtual Machine.,C(windows_license_key) - License key to be set to Windows Virtual Machine.,C(user_name) - Username to be used for set password to Windows Virtual Machine.,C(root_password) - Password to be set for username to Windows Virtual Machine.

Returns:

• (Hash, nil) —

  Dictionary with values for Windows Virtual Machine initialization using sysprep.,C(host_name) - Hostname to be set to Virtual Machine when deployed.,C(active_directory_ou) - Active Directory Organizational Unit, to be used for login of user.,C(org_name) - Organization name to be set to Windows Virtual Machine.,C(domain) - Domain to be set to Windows Virtual Machine.,C(timezone) - Timezone to be set to Windows Virtual Machine.,C(ui_language) - UI language of the Windows Virtual Machine.,C(system_locale) - System localization of the Windows Virtual Machine.,C(input_locale) - Input localization of the Windows Virtual Machine.,C(windows_license_key) - License key to be set to Windows Virtual Machine.,C(user_name) - Username to be used for set password to Windows Virtual Machine.,C(root_password) - Password to be set for username to Windows Virtual Machine.

# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_vm.rb', line 195

attribute :sysprep

#template ⇒ String^?

Returns Name of the template, which should be used to create Virtual Machine.,Required if creating VM.,If template is not specified and VM doesn’t exist, VM will be created from I(Blank) template.

Returns:

• (String, nil) —

  Name of the template, which should be used to create Virtual Machine.,Required if creating VM.,If template is not specified and VM doesn’t exist, VM will be created from I(Blank) template.

# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_vm.rb', line 65

attribute :template

#template_version ⇒ Object^?

Returns Version number of the template to be used for VM.,By default the latest available version of the template is used.

Returns:

• (Object, nil) —

  Version number of the template to be used for VM.,By default the latest available version of the template is used.

# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_vm.rb', line 69

attribute :template_version

#ticket ⇒ Symbol^?

Returns If I(true), in addition return I(remote_vv_file) inside I(vm) dictionary, which contains compatible content for remote-viewer application. Works only C(state) is I(running).

Returns:

• (Symbol, nil) —

  If I(true), in addition return I(remote_vv_file) inside I(vm) dictionary, which contains compatible content for remote-viewer application. Works only C(state) is I(running).

# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_vm.rb', line 256

attribute :ticket

#timezone ⇒ Object^?

Returns Sets time zone offset of the guest hardware clock.,For example C(Etc/GMT).

Returns:

• (Object, nil) —

  Sets time zone offset of the guest hardware clock.,For example C(Etc/GMT)

# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_vm.rb', line 229

attribute :timezone

#type ⇒ :desktop, ...

Returns Type of the Virtual Machine.,Default value is set by oVirt/RHV engine.,I(high_performance) is supported since Ansible 2.5 and oVirt/RHV 4.2.

Returns:

• (:desktop, :server, :high_performance, nil) —

  Type of the Virtual Machine.,Default value is set by oVirt/RHV engine.,I(high_performance) is supported since Ansible 2.5 and oVirt/RHV 4.2.

# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_vm.rb', line 109

attribute :type

#usb_support ⇒ Symbol^?

Returns I(True) enable USB support, I(False) to disable it. By default is chosen by oVirt/RHV engine.

Returns:

• (Symbol, nil) —

  I(True) enable USB support, I(False) to disable it. By default is chosen by oVirt/RHV engine.

# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_vm.rb', line 129

attribute :usb_support

#use_latest_template_version ⇒ Symbol^?

Returns Specify if latest template version should be used, when running a stateless VM.,If this parameter is set to I(yes) stateless VM is created.

Returns:

• (Symbol, nil) —

  Specify if latest template version should be used, when running a stateless VM.,If this parameter is set to I(yes) stateless VM is created.

# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_vm.rb', line 72

attribute :use_latest_template_version

#vmware ⇒ Hash^?

Returns Dictionary of values to be used to connect to VMware and import a virtual machine to oVirt.,Dictionary can contain following values.,C(username) - The username to authenticate against the VMware.,C(password) - The password to authenticate against the VMware.,C(url) - The URL to be passed to the I(virt-v2v) tool for conversion. For example I(vpx://wmware_user@vcenter-host/DataCenter/Cluster/esxi-host?no_verify=1),C(drivers_iso) - The name of the ISO containing drivers that can be used during the I(virt-v2v) conversion process.,C(sparse) - Specifies the disk allocation policy of the resulting virtual machine. I(true) for sparse, I(false) for preallocated. Default value is I(true).,C(storage_domain) - Specifies the target storage domain for converted disks. This is required parameter.

Returns:

• (Hash, nil) —

  Dictionary of values to be used to connect to VMware and import a virtual machine to oVirt.,Dictionary can contain following values.,C(username) - The username to authenticate against the VMware.,C(password) - The password to authenticate against the VMware.,C(url) - The URL to be passed to the I(virt-v2v) tool for conversion. For example I(vpx://wmware_user@vcenter-host/DataCenter/Cluster/esxi-host?no_verify=1),C(drivers_iso) - The name of the ISO containing drivers that can be used during the I(virt-v2v) conversion process.,C(sparse) - Specifies the disk allocation policy of the resulting virtual machine. I(true) for sparse, I(false) for preallocated. Default value is I(true).,C(storage_domain) - Specifies the target storage domain for converted disks. This is required parameter.

# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_vm.rb', line 239

attribute :vmware

#vnic_profile_mappings ⇒ Array<Hash>, ...

Returns Mapper which maps an external virtual NIC profile to one that exists in the engine when C(state) is registered. vnic_profile is described by the following dictionary:,C(source_network_name): The network name of the source network.,C(source_profile_name): The profile name related to the source network.,C(target_profile_id): The id of the target profile id to be mapped to in the engine.

Returns:

• (Array<Hash>, Hash, nil) —

  Mapper which maps an external virtual NIC profile to one that exists in the engine when C(state) is registered. vnic_profile is described by the following dictionary:,C(source_network_name): The network name of the source network.,C(source_profile_name): The profile name related to the source network.,C(target_profile_id): The id of the target profile id to be mapped to in the engine.

# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_vm.rb', line 33

attribute :vnic_profile_mappings

#watchdog ⇒ Object^?

Returns Assign watchdog device for the virtual machine.,Watchdogs is a dictionary which can have following values:,C(model) - Model of the watchdog device. For example: I(i6300esb), I(diag288) or I(null).,C(action) - Watchdog action to be performed when watchdog is triggered. For example: I(none), I(reset), I(poweroff), I(pause) or I(dump).

Returns:

• (Object, nil) —

  Assign watchdog device for the virtual machine.,Watchdogs is a dictionary which can have following values:,C(model) - Model of the watchdog device. For example: I(i6300esb), I(diag288) or I(null).,C(action) - Watchdog action to be performed when watchdog is triggered. For example: I(none), I(reset), I(poweroff), I(pause) or I(dump).

# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_vm.rb', line 292

attribute :watchdog

#xen ⇒ Object^?

Returns Dictionary of values to be used to connect to XEN and import a virtual machine to oVirt.,Dictionary can contain following values.,C(url) - The URL to be passed to the I(virt-v2v) tool for conversion. For example I(xen+ssh://root@zen.server). This is required parameter.,C(drivers_iso) - The name of the ISO containing drivers that can be used during the I(virt-v2v) conversion process.,C(sparse) - Specifies the disk allocation policy of the resulting virtual machine. I(true) for sparse, I(false) for preallocated. Default value is I(true).,C(storage_domain) - Specifies the target storage domain for converted disks. This is required parameter.

Returns:

• (Object, nil) —

  Dictionary of values to be used to connect to XEN and import a virtual machine to oVirt.,Dictionary can contain following values.,C(url) - The URL to be passed to the I(virt-v2v) tool for conversion. For example I(xen+ssh://root@zen.server). This is required parameter.,C(drivers_iso) - The name of the ISO containing drivers that can be used during the I(virt-v2v) conversion process.,C(sparse) - Specifies the disk allocation policy of the resulting virtual machine. I(true) for sparse, I(false) for preallocated. Default value is I(true).,C(storage_domain) - Specifies the target storage domain for converted disks. This is required parameter.

# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_vm.rb', line 243

attribute :xen