Class: Ansible::Ruby::Modules::Ovirt_cluster
- Inherits:
-
Base
- Object
- Ansible::Ruby::Models::Base
- Base
- Ansible::Ruby::Modules::Ovirt_cluster
- Defined in:
- lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_cluster.rb,
lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_clusters.rb
Overview
Module to manage clusters in oVirt/RHV
Instance Method Summary collapse
-
#ballooning ⇒ Boolean?
If I(True) enable memory balloon optimization.
-
#comment ⇒ Object?
Comment of the cluster.
-
#compatibility_version ⇒ Float?
The compatibility version of the cluster.
-
#cpu_arch ⇒ :x86_64, ...
CPU architecture of cluster.
-
#cpu_type ⇒ String?
CPU codename.
-
#data_center ⇒ String?
Datacenter name where cluster reside.
-
#description ⇒ String?
Description of the cluster.
-
#external_network_providers ⇒ Array<Hash>, ...
List of references to the external network providers available in the cluster.
-
#fence_connectivity_threshold ⇒ Object?
The threshold used by C(fence_skip_if_connectivity_broken).
-
#fence_enabled ⇒ Object?
If I(True) enables fencing on the cluster.,Fencing is enabled by default.
-
#fence_skip_if_connectivity_broken ⇒ Object?
If I(True) fencing will be temporarily disabled if the percentage of hosts in the cluster that are experiencing connectivity issues is greater than or equal to the defined threshold.,The threshold can be specified by C(fence_connectivity_threshold).
-
#fence_skip_if_sd_active ⇒ Object?
If I(True) any hosts in the cluster that are Non Responsive and still connected to storage will not be fenced.
-
#gluster ⇒ Boolean?
If I(True), hosts in this cluster will be used as Gluster Storage server nodes, and not for running virtual machines.,By default the cluster is created for virtual machine hosts.
-
#ha_reservation ⇒ Boolean?
If I(True) enables the oVirt/RHV to monitor cluster capacity for highly available virtual machines.
-
#host_reason ⇒ Boolean?
If I(True) enables an optional reason field when a host is placed into maintenance mode from the Manager, allowing the administrator to provide an explanation for the maintenance.
-
#ksm ⇒ Object?
I I(True) MoM enables to run Kernel Same-page Merging I(KSM) when necessary and when it can yield a memory saving benefit that outweighs its CPU cost.
-
#ksm_numa ⇒ Boolean?
If I(True) enables KSM C(ksm) for best performance inside NUMA nodes.
-
#mac_pool ⇒ Object?
MAC pool to be used by this cluster.,C(Note:),This is supported since oVirt version 4.1.
-
#memory_policy ⇒ :disabled, ...
I(disabled) - Disables memory page sharing.,I(server) - Sets the memory page sharing threshold to 150% of the system memory on each host.,I(desktop) - Sets the memory page sharing threshold to 200% of the system memory on each host.
-
#migration_auto_converge ⇒ :true, ...
If I(True) auto-convergence is used during live migration of virtual machines.,Used only when C(migration_policy) is set to I(legacy).,Following options are supported:,C(true) - Override the global setting to I(true).,C(false) - Override the global setting to I(false).,C(inherit) - Use value which is set globally.
-
#migration_bandwidth ⇒ :auto, ...
The bandwidth settings define the maximum bandwidth of both outgoing and incoming migrations per host.,Following bandwidth options are supported:,C(auto) - Bandwidth is copied from the I(rate limit) [Mbps] setting in the data center host network QoS.,C(hypervisor_default) - Bandwidth is controlled by local VDSM setting on sending host.,C(custom) - Defined by user (in Mbps).
-
#migration_bandwidth_limit ⇒ Object?
Set the I(custom) migration bandwidth limit.,This parameter is used only when C(migration_bandwidth) is I(custom).
-
#migration_compressed ⇒ :true, ...
If I(True) compression is used during live migration of the virtual machine.,Used only when C(migration_policy) is set to I(legacy).,Following options are supported:,C(true) - Override the global setting to I(true).,C(false) - Override the global setting to I(false).,C(inherit) - Use value which is set globally.
-
#migration_policy ⇒ :legacy, ...
A migration policy defines the conditions for live migrating virtual machines in the event of host failure.,Following policies are supported:,C(legacy) - Legacy behavior of 3.6 version.,C(minimal_downtime) - Virtual machines should not experience any significant downtime.,C(suspend_workload) - Virtual machines may experience a more significant downtime.,C(post_copy) - Virtual machines should not experience any significant downtime.
-
#name ⇒ String
Name of the cluster to manage.
-
#network ⇒ Object?
Management network of cluster to access cluster hosts.
-
#resilience_policy ⇒ :do_not_migrate, ...
The resilience policy defines how the virtual machines are prioritized in the migration.,Following values are supported:,C(do_not_migrate) - Prevents virtual machines from being migrated.
-
#rng_sources ⇒ Array<String>, ...
List that specify the random number generator devices that all hosts in the cluster will use.,Supported generators are: I(hwrng) and I(random).
-
#scheduling_policy ⇒ Object?
Name of the scheduling policy to be used for cluster.
-
#scheduling_policy_properties ⇒ Object?
Custom scheduling policy properties of the cluster.,These optional properties override the properties of the scheduling policy specified by the C(scheduling_policy) parameter.
-
#serial_policy ⇒ Object?
Specify a serial number policy for the virtual machines in the cluster.,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).
-
#spice_proxy ⇒ Object?
The proxy by which the SPICE client will connect to virtual machines.,The address must be in the following format: I(protocol://:[port]).
-
#state ⇒ :present, ...
Should the cluster be present or absent.
-
#switch_type ⇒ :legacy, ...
Type of switch to be used by all networks in given cluster.
-
#threads_as_cores ⇒ Boolean?
If I(True) the exposed host threads would be treated as cores which can be utilized by virtual machines.
-
#trusted_service ⇒ Boolean?
If I(True) enables integration with an OpenAttestation server.
-
#virt ⇒ Object?
If I(True), hosts in this cluster will be used to run virtual machines.
-
#vm_reason ⇒ Boolean?
If I(True) enables an optional reason field when a virtual machine is shut down from the Manager, allowing the administrator to provide an explanation for the maintenance.
Methods inherited from Base
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
#ballooning ⇒ Boolean?
Returns If I(True) enable memory balloon optimization. Memory balloon is used to re-distribute / reclaim the host memory based on VM needs in a dynamic way.
34 |
# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_cluster.rb', line 34 attribute :ballooning |
#comment ⇒ Object?
Returns Comment of the cluster.
28 |
# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_cluster.rb', line 28 attribute :comment |
#compatibility_version ⇒ Float?
Returns The compatibility version of the cluster. All hosts in this cluster must support at least this compatibility version.
142 |
# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_cluster.rb', line 142 attribute :compatibility_version |
#cpu_arch ⇒ :x86_64, ...
Returns CPU architecture of cluster.
130 |
# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_cluster.rb', line 130 attribute :cpu_arch |
#cpu_type ⇒ String?
Returns CPU codename. For example I(Intel SandyBridge Family).
134 |
# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_cluster.rb', line 134 attribute :cpu_type |
#data_center ⇒ String?
Returns Datacenter name where cluster reside.
20 |
# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_cluster.rb', line 20 attribute :data_center |
#description ⇒ String?
Returns Description of the cluster.
24 |
# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_cluster.rb', line 24 attribute :description |
#external_network_providers ⇒ Array<Hash>, ...
Returns List of references to the external network providers available in the cluster. If the automatic deployment of the external network provider is supported, the networks of the referenced network provider are available on every host in the cluster.,External network provider is described by following dictionary:,C(name) - Name of the external network provider. Either C(name) or C(id) is required.,C(id) - ID of the external network provider. Either C(name) or C(id) is required.,This is supported since oVirt version 4.2.
149 |
# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_cluster.rb', line 149 attribute :external_network_providers |
#fence_connectivity_threshold ⇒ Object?
Returns The threshold used by C(fence_skip_if_connectivity_broken).
92 |
# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_cluster.rb', line 92 attribute :fence_connectivity_threshold |
#fence_enabled ⇒ Object?
Returns If I(True) enables fencing on the cluster.,Fencing is enabled by default.
83 |
# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_cluster.rb', line 83 attribute :fence_enabled |
#fence_skip_if_connectivity_broken ⇒ Object?
Returns If I(True) fencing will be temporarily disabled if the percentage of hosts in the cluster that are experiencing connectivity issues is greater than or equal to the defined threshold.,The threshold can be specified by C(fence_connectivity_threshold).
89 |
# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_cluster.rb', line 89 attribute :fence_skip_if_connectivity_broken |
#fence_skip_if_sd_active ⇒ Object?
Returns If I(True) any hosts in the cluster that are Non Responsive and still connected to storage will not be fenced.
86 |
# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_cluster.rb', line 86 attribute :fence_skip_if_sd_active |
#gluster ⇒ Boolean?
Returns If I(True), hosts in this cluster will be used as Gluster Storage server nodes, and not for running virtual machines.,By default the cluster is created for virtual machine hosts.
41 |
# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_cluster.rb', line 41 attribute :gluster |
#ha_reservation ⇒ Boolean?
Returns If I(True) enables the oVirt/RHV to monitor cluster capacity for highly available virtual machines.
56 |
# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_cluster.rb', line 56 attribute :ha_reservation |
#host_reason ⇒ Boolean?
Returns If I(True) enables an optional reason field when a host is placed into maintenance mode from the Manager, allowing the administrator to provide an explanation for the maintenance.
68 |
# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_cluster.rb', line 68 attribute :host_reason |
#ksm ⇒ Object?
Returns I I(True) MoM enables to run Kernel Same-page Merging I(KSM) when necessary and when it can yield a memory saving benefit that outweighs its CPU cost.
49 |
# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_cluster.rb', line 49 attribute :ksm |
#ksm_numa ⇒ Boolean?
Returns If I(True) enables KSM C(ksm) for best performance inside NUMA nodes.
52 |
# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_cluster.rb', line 52 attribute :ksm_numa |
#mac_pool ⇒ Object?
Returns MAC pool to be used by this cluster.,C(Note:),This is supported since oVirt version 4.1.
146 |
# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_cluster.rb', line 146 attribute :mac_pool |
#memory_policy ⇒ :disabled, ...
Returns I(disabled) - Disables memory page sharing.,I(server) - Sets the memory page sharing threshold to 150% of the system memory on each host.,I(desktop) - Sets the memory page sharing threshold to 200% of the system memory on each host.
72 |
# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_cluster.rb', line 72 attribute :memory_policy |
#migration_auto_converge ⇒ :true, ...
Returns If I(True) auto-convergence is used during live migration of virtual machines.,Used only when C(migration_policy) is set to I(legacy).,Following options are supported:,C(true) - Override the global setting to I(true).,C(false) - Override the global setting to I(false).,C(inherit) - Use value which is set globally.
106 |
# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_cluster.rb', line 106 attribute :migration_auto_converge |
#migration_bandwidth ⇒ :auto, ...
Returns The bandwidth settings define the maximum bandwidth of both outgoing and incoming migrations per host.,Following bandwidth options are supported:,C(auto) - Bandwidth is copied from the I(rate limit) [Mbps] setting in the data center host network QoS.,C(hypervisor_default) - Bandwidth is controlled by local VDSM setting on sending host.,C(custom) - Defined by user (in Mbps).
99 |
# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_cluster.rb', line 99 attribute :migration_bandwidth |
#migration_bandwidth_limit ⇒ Object?
Returns Set the I(custom) migration bandwidth limit.,This parameter is used only when C(migration_bandwidth) is I(custom).
103 |
# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_cluster.rb', line 103 attribute :migration_bandwidth_limit |
#migration_compressed ⇒ :true, ...
Returns If I(True) compression is used during live migration of the virtual machine.,Used only when C(migration_policy) is set to I(legacy).,Following options are supported:,C(true) - Override the global setting to I(true).,C(false) - Override the global setting to I(false).,C(inherit) - Use value which is set globally.
110 |
# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_cluster.rb', line 110 attribute :migration_compressed |
#migration_policy ⇒ :legacy, ...
Returns A migration policy defines the conditions for live migrating virtual machines in the event of host failure.,Following policies are supported:,C(legacy) - Legacy behavior of 3.6 version.,C(minimal_downtime) - Virtual machines should not experience any significant downtime.,C(suspend_workload) - Virtual machines may experience a more significant downtime.,C(post_copy) - Virtual machines should not experience any significant downtime. If the VM migration is not converging for a long time, the migration will be switched to post-copy. Added in version I(2.4).
114 |
# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_cluster.rb', line 114 attribute :migration_policy |
#name ⇒ String
Returns Name of the cluster to manage.
12 |
# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_cluster.rb', line 12 attribute :name |
#network ⇒ Object?
Returns Management network of cluster to access cluster hosts.
31 |
# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_cluster.rb', line 31 attribute :network |
#resilience_policy ⇒ :do_not_migrate, ...
Returns The resilience policy defines how the virtual machines are prioritized in the migration.,Following values are supported:,C(do_not_migrate) - Prevents virtual machines from being migrated. ,C(migrate) - Migrates all virtual machines in order of their defined priority.,C(migrate_highly_available) - Migrates only highly available virtual machines to prevent overloading other hosts.
95 |
# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_cluster.rb', line 95 attribute :resilience_policy |
#rng_sources ⇒ Array<String>, ...
Returns List that specify the random number generator devices that all hosts in the cluster will use.,Supported generators are: I(hwrng) and I(random).
76 |
# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_cluster.rb', line 76 attribute :rng_sources |
#scheduling_policy ⇒ Object?
Returns Name of the scheduling policy to be used for cluster.
124 |
# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_cluster.rb', line 124 attribute :scheduling_policy |
#scheduling_policy_properties ⇒ Object?
Returns Custom scheduling policy properties of the cluster.,These optional properties override the properties of the scheduling policy specified by the C(scheduling_policy) parameter.
127 |
# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_cluster.rb', line 127 attribute :scheduling_policy_properties |
#serial_policy ⇒ Object?
Returns Specify a serial number policy for the virtual machines in the cluster.,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).
118 |
# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_cluster.rb', line 118 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).
121 |
# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_cluster.rb', line 121 attribute :serial_policy_value |
#spice_proxy ⇒ Object?
Returns The proxy by which the SPICE client will connect to virtual machines.,The address must be in the following format: I(protocol://:[port]).
80 |
# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_cluster.rb', line 80 attribute :spice_proxy |
#state ⇒ :present, ...
Returns Should the cluster be present or absent.
16 |
# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_cluster.rb', line 16 attribute :state |
#switch_type ⇒ :legacy, ...
Returns Type of switch to be used by all networks in given cluster. Either I(legacy) which is using linux bridge or I(ovs) using Open vSwitch.
138 |
# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_cluster.rb', line 138 attribute :switch_type |
#threads_as_cores ⇒ Boolean?
Returns If I(True) the exposed host threads would be treated as cores which can be utilized by virtual machines.
45 |
# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_cluster.rb', line 45 attribute :threads_as_cores |
#trusted_service ⇒ Boolean?
Returns If I(True) enables integration with an OpenAttestation server.
60 |
# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_cluster.rb', line 60 attribute :trusted_service |
#virt ⇒ Object?
Returns If I(True), hosts in this cluster will be used to run virtual machines.
38 |
# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_cluster.rb', line 38 attribute :virt |
#vm_reason ⇒ Boolean?
Returns If I(True) enables an optional reason field when a virtual machine is shut down from the Manager, allowing the administrator to provide an explanation for the maintenance.
64 |
# File 'lib/ansible/ruby/modules/generated/cloud/ovirt/ovirt_cluster.rb', line 64 attribute :vm_reason |