Class: Ansible::Ruby::Modules::Ovirt_template

Inherits:

Base

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

Defined in:

lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_template.rb,
lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_templates.rb

Overview

Module to manage virtual machine templates in oVirt/RHV.

Instance Method Summary

• #allow_partial_import ⇒ Symbol^?

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

• #clone_permissions ⇒ Symbol^?

  If I(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 C(state) I(present).

• #cluster ⇒ String^?

  Name of the cluster, where template should be created/imported.

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

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

• #cpu_profile ⇒ String^?

  CPU profile to be set to template.

• #description ⇒ String^?

  Description of the template.

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

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

• #exclusive ⇒ Symbol^?

  When C(state) is I(exported) this parameter indicates if the existing templates with the same name should be overwritten.

• #export_domain ⇒ Object^?

  When C(state) is I(exported) or I(imported) this parameter specifies the name of the export storage domain.

• #id ⇒ String^?

  ID of the template to be registered.

• #image_disk ⇒ String^?

  When C(state) is I(imported) and C(image_provider) is used this parameter specifies the name of disk to be imported as template.

• #image_provider ⇒ String^?

  When C(state) is I(imported) this parameter specifies the name of the image provider to be used.

• #io_threads ⇒ Object^?

  Number of IO threads used by virtual machine.

• #memory ⇒ Object^?

  Amount of memory of the template.

• #memory_guaranteed ⇒ Object^?

  Amount of minimal guaranteed memory of the template.

• #memory_max ⇒ Object^?

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

• #name ⇒ String^?

  Name of the template to manage.

• #operating_system ⇒ Object^?

  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.

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

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

• #seal ⇒ Symbol^?

  ‘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.

• #state ⇒ :present, ...

  Should the template be present/absent/exported/imported/registered.

• #storage_domain ⇒ String^?

  When C(state) is I(imported) this parameter specifies the name of the destination data storage domain.

• #template_image_disk_name ⇒ String^?

  When C(state) is I(imported) and C(image_provider) is used this parameter specifies the new name for imported disk, if omitted then I(image_disk) name is used by default.

• #vm ⇒ String^?

  Name of the VM, which will be used to create template.

• #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.

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

#allow_partial_import ⇒ Symbol^?

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

Returns:

• (Symbol, nil) —

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

# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_template.rb', line 40

attribute :allow_partial_import

#clone_permissions ⇒ Symbol^?

Returns If I(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 C(state) I(present).

Returns:

• (Symbol, nil) —

  If I(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 C(state) I(present).

# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_template.rb', line 86

attribute :clone_permissions

#cluster ⇒ String^?

Returns Name of the cluster, where template should be created/imported.

Returns:

• (String, nil) —

  Name of the cluster, where template should be created/imported.

# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_template.rb', line 36

attribute :cluster

#cluster_mappings ⇒ Array<Hash>, ...

Returns Mapper which maps cluster name between Template’s OVF and the destination cluster this Template 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 Template’s OVF and the destination cluster this Template 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_template.rb', line 48

attribute :cluster_mappings

#cpu_profile ⇒ String^?

Returns CPU profile to be set to template.

Returns:

• (String, nil) —

  CPU profile to be set to template.

# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_template.rb', line 32

attribute :cpu_profile

#description ⇒ String^?

Returns Description of the template.

Returns:

• (String, nil) —

  Description of the template.

# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_template.rb', line 28

attribute :description

#domain_mappings ⇒ Array<Hash>, ...

Returns Mapper which maps aaa domain name between Template’s OVF and the destination aaa domain this Template 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 Template’s OVF and the destination aaa domain this Template 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_template.rb', line 56

attribute :domain_mappings

#exclusive ⇒ Symbol^?

Returns When C(state) is I(exported) this parameter indicates if the existing templates with the same name should be overwritten.

Returns:

• (Symbol, nil) —

  When C(state) is I(exported) this parameter indicates if the existing templates with the same name should be overwritten.

# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_template.rb', line 60

attribute :exclusive

#export_domain ⇒ Object^?

Returns When C(state) is I(exported) or I(imported) this parameter specifies the name of the export storage domain.

Returns:

• (Object, nil) —

  When C(state) is I(exported) or I(imported) this parameter specifies the name of the export storage domain.

# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_template.rb', line 64

attribute :export_domain

#id ⇒ String^?

Returns ID of the template to be registered.

Returns:

• (String, nil) —

  ID of the template to be registered.

# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_template.rb', line 16

attribute :id

#image_disk ⇒ String^?

Returns When C(state) is I(imported) and C(image_provider) is used this parameter specifies the name of disk to be imported as template.

Returns:

• (String, nil) —

  When C(state) is I(imported) and C(image_provider) is used this parameter specifies the name of disk to be imported as template.

# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_template.rb', line 71

attribute :image_disk

#image_provider ⇒ String^?

Returns When C(state) is I(imported) this parameter specifies the name of the image provider to be used.

Returns:

• (String, nil) —

  When C(state) is I(imported) this parameter specifies the name of the image provider to be used.

# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_template.rb', line 67

attribute :image_provider

#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_template.rb', line 75

attribute :io_threads

#memory ⇒ Object^?

Returns Amount of memory of the template. Prefix uses IEC 60027-2 standard (for example 1GiB, 1024MiB).

Returns:

• (Object, nil) —

  Amount of memory of the template. Prefix uses IEC 60027-2 standard (for example 1GiB, 1024MiB).

# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_template.rb', line 97

attribute :memory

#memory_guaranteed ⇒ Object^?

Returns Amount of minimal guaranteed memory of the template. Prefix uses IEC 60027-2 standard (for example 1GiB, 1024MiB).,C(memory_guaranteed) parameter can’t be lower than C(memory) parameter.

Returns:

• (Object, nil) —

  Amount of minimal guaranteed memory of the template. Prefix uses IEC 60027-2 standard (for example 1GiB, 1024MiB).,C(memory_guaranteed) parameter can’t be lower than C(memory) parameter.

# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_template.rb', line 100

attribute :memory_guaranteed

#memory_max ⇒ Object^?

Returns Upper bound of template memory up to which memory hot-plug can be performed. Prefix uses IEC 60027-2 standard (for example 1GiB, 1024MiB).

Returns:

• (Object, nil) —

  Upper bound of template memory up to which memory hot-plug can be performed. Prefix uses IEC 60027-2 standard (for example 1GiB, 1024MiB).

# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_template.rb', line 103

attribute :memory_max

#name ⇒ String^?

Returns Name of the template to manage.

Returns:

• (String, nil) —

  Name of the template to manage.

# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_template.rb', line 12

attribute :name

#operating_system ⇒ Object^?

Returns 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.

Returns:

• (Object, nil) —

  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

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

attribute :operating_system

#role_mappings ⇒ Array<Hash>, ...

Returns Mapper which maps role name between Template’s OVF and the destination role this Template 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 Template’s OVF and the destination role this Template 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_template.rb', line 52

attribute :role_mappings

#seal ⇒ Symbol^?

Returns ‘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 I(true) subsequent virtual machines made from this template will avoid configuration inheritance.,This parameter is used only when C(state) I(present).

Returns:

• (Symbol, nil) —

  ‘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 I(true) subsequent virtual machines made from this template will avoid configuration inheritance.,This parameter is used only when C(state) I(present).

# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_template.rb', line 90

attribute :seal

#state ⇒ :present, ...

Returns Should the template be present/absent/exported/imported/registered. When C(state) is I(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.

Returns:

• (:present, :absent, :exported, :imported, :registered, nil) —

  Should the template be present/absent/exported/imported/registered. When C(state) is I(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.

# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_template.rb', line 20

attribute :state

#storage_domain ⇒ String^?

Returns When C(state) is I(imported) this parameter specifies the name of the destination data storage domain. When C(state) is I(registered) this parameter specifies the name of the data storage domain of the unregistered template.

Returns:

• (String, nil) —

  When C(state) is I(imported) this parameter specifies the name of the destination data storage domain. When C(state) is I(registered) this parameter specifies the name of the data storage domain of the unregistered template.

# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_template.rb', line 82

attribute :storage_domain

#template_image_disk_name ⇒ String^?

Returns When C(state) is I(imported) and C(image_provider) is used this parameter specifies the new name for imported disk, if omitted then I(image_disk) name is used by default. This parameter is used only in case of importing disk image from Glance domain.

Returns:

• (String, nil) —

  When C(state) is I(imported) and C(image_provider) is used this parameter specifies the new name for imported disk, if omitted then I(image_disk) name is used by default. This parameter is used only in case of importing disk image from Glance domain.

# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_template.rb', line 78

attribute :template_image_disk_name

#vm ⇒ String^?

Returns Name of the VM, which will be used to create template.

Returns:

• (String, nil) —

  Name of the VM, which will be used to create template.

# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_template.rb', line 24

attribute :vm

#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_template.rb', line 44

attribute :vnic_profile_mappings