Class: Ansible::Ruby::Modules::Ovirt_vmpool

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_vmpool.rb,
lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_vmpools.rb

Overview

Module to manage VM pools in oVirt/RHV.

Instance Method Summary collapse

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

#cluster ⇒ String?

Returns Name of the cluster, where VM pool should be created.

Returns:

  • (String, nil) —

    Name of the cluster, where VM pool should be created.



30
 
# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_vmpool.rb', line 30

attribute :cluster

#comment ⇒ Object?

Returns Comment of the Virtual Machine pool.

Returns:

  • (Object, nil) —

    Comment of the Virtual Machine pool.



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

attribute :comment

#description ⇒ Object?

Returns Description of the VM pool.

Returns:

  • (Object, nil) —

    Description of the VM pool.



27
 
# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_vmpool.rb', line 27

attribute :description

#name ⇒ String

Returns Name of the VM pool to manage.

Returns:

  • (String) —

    Name of the VM pool to manage.



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

attribute :name

#prestarted ⇒ Integer?

Returns Number of pre-started VMs defines the number of VMs in run state, that are waiting to be attached to Users.,Default value is set by engine.

Returns:

  • (Integer, nil) —

    Number of pre-started VMs defines the number of VMs in run state, that are waiting to be attached to Users.,Default value is set by engine.



42
 
# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_vmpool.rb', line 42

attribute :prestarted

#state ⇒ :present, ...

Returns Should the VM pool be present/absent.,Note that when C(state) is I(absent) all VMs in VM pool are stopped and removed.

Returns:

  • (:present, :absent, nil) —

    Should the VM pool be present/absent.,Note that when C(state) is I(absent) all VMs in VM pool are stopped and removed.



19
 
# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_vmpool.rb', line 19

attribute :state

#template ⇒ String?

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

Returns:

  • (String, nil) —

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



23
 
# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_vmpool.rb', line 23

attribute :template

#type ⇒ :manual, ...

Returns Type of the VM pool. Either manual or automatic.,C(manual) - The administrator is responsible for explicitly returning the virtual machine to the pool. The virtual machine reverts to the original base image after the administrator returns it to the pool.,C(Automatic) - When the virtual machine is shut down, it automatically reverts to its base image and is returned to the virtual machine pool.,Default value is set by engine.

Returns:

  • (:manual, :automatic, nil) —

    Type of the VM pool. Either manual or automatic.,C(manual) - The administrator is responsible for explicitly returning the virtual machine to the pool. The virtual machine reverts to the original base image after the administrator returns it to the pool.,C(Automatic) - When the virtual machine is shut down, it automatically reverts to its base image and is returned to the virtual machine pool.,Default value is set by engine.



34
 
# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_vmpool.rb', line 34

attribute :type

#vm_count ⇒ Integer?

Returns Number of VMs in the pool.,Default value is set by engine.

Returns:

  • (Integer, nil) —

    Number of VMs in the pool.,Default value is set by engine.



46
 
# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_vmpool.rb', line 46

attribute :vm_count

#vm_per_user ⇒ Integer?

Returns Maximum number of VMs a single user can attach to from this pool.,Default value is set by engine.

Returns:

  • (Integer, nil) —

    Maximum number of VMs a single user can attach to from this pool.,Default value is set by engine.



38
 
# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_vmpool.rb', line 38

attribute :vm_per_user