ovirt_cluster – Module to manage clusters in oVirt/RHV
ovirt_cluster – Module to manage clusters in oVirt/RHV
New in version 2.3.
Synopsis
- Module to manage clusters in oVirt/RHV
Aliases: ovirt_clusters
Requirements
The below requirements are needed on the host that executes this module.
- python >= 2.7
- ovirt-engine-sdk-python >= 4.2.4
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
auth - / required |
Dictionary with values needed to create HTTP/HTTPS connection to oVirt:
| |
ballooning - |
If True enable memory balloon optimization. Memory balloon is used to re-distribute / reclaim the host memory based on VM needs in a dynamic way. | |
comment - |
Comment of the cluster. | |
compatibility_version - |
The compatibility version of the cluster. All hosts in this cluster must support at least this compatibility version. | |
cpu_arch - |
|
CPU architecture of cluster. |
cpu_type - |
CPU codename. For example Intel SandyBridge Family. | |
data_center - |
Datacenter name where cluster reside. | |
description - |
Description of the cluster. | |
external_network_providers - added in 2.5 |
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:
This is supported since oVirt version 4.2. | |
fence_connectivity_threshold - |
The threshold used by | |
fence_enabled - |
If True enables fencing on the cluster. Fencing is enabled by default. | |
fence_skip_if_connectivity_broken - |
If 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 | |
fence_skip_if_sd_active - |
If True any hosts in the cluster that are Non Responsive and still connected to storage will not be fenced. | |
fetch_nested boolean added in 2.3 |
|
If True the module will fetch additional data from the API. It will fetch IDs of the VMs disks, snapshots, etc. User can configure to fetch other attributes of the nested entities by specifying |
gluster - |
If 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 - |
If True enables the oVirt/RHV to monitor cluster capacity for highly available virtual machines. | |
host_reason - |
If 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 - |
I True MoM enables to run Kernel Same-page Merging KSM when necessary and when it can yield a memory saving benefit that outweighs its CPU cost. | |
ksm_numa - |
If True enables KSM | |
mac_pool - added in 2.4 |
MAC pool to be used by this cluster.
This is supported since oVirt version 4.1. | |
memory_policy - |
|
disabled - Disables memory page sharing. server - Sets the memory page sharing threshold to 150% of the system memory on each host. desktop - Sets the memory page sharing threshold to 200% of the system memory on each host. |
migration_auto_converge - |
|
If True auto-convergence is used during live migration of virtual machines. Used only when Following options are supported:
|
migration_bandwidth - |
|
The bandwidth settings define the maximum bandwidth of both outgoing and incoming migrations per host. Following bandwidth options are supported:
|
migration_bandwidth_limit - |
Set the custom migration bandwidth limit. This parameter is used only when | |
migration_compressed - |
|
If True compression is used during live migration of the virtual machine. Used only when Following options are supported:
|
migration_policy - |
|
A migration policy defines the conditions for live migrating virtual machines in the event of host failure. Following policies are supported:
|
name - / required |
Name of the cluster to manage. | |
nested_attributes - added in 2.3 |
Specifies list of the attributes which should be fetched from the API. This parameter apply only when | |
network - |
Management network of cluster to access cluster hosts. | |
poll_interval - |
Default: 3 |
Number of the seconds the module waits until another poll request on entity status is sent. |
resilience_policy - |
|
The resilience policy defines how the virtual machines are prioritized in the migration. Following values are supported:
|
rng_sources - |
List that specify the random number generator devices that all hosts in the cluster will use. Supported generators are: hwrng and random. | |
scheduling_policy - |
Name of the scheduling policy to be used for cluster. | |
scheduling_policy_properties - added in 2.6 |
Custom scheduling policy properties of the cluster. These optional properties override the properties of the scheduling policy specified by the | |
serial_policy - |
Specify a serial number policy for the virtual machines in the cluster. Following options are supported:
| |
serial_policy_value - |
Allows you to specify a custom serial number. This parameter is used only when | |
spice_proxy - |
The proxy by which the SPICE client will connect to virtual machines. The address must be in the following format: protocol://[host]:[port] | |
state - |
|
Should the cluster be present or absent. |
switch_type - |
|
Type of switch to be used by all networks in given cluster. Either legacy which is using linux bridge or ovs using Open vSwitch. |
threads_as_cores - |
If True the exposed host threads would be treated as cores which can be utilized by virtual machines. | |
timeout - |
Default: 180 |
The amount of time in seconds the module should wait for the instance to get into desired state. |
trusted_service - |
If True enables integration with an OpenAttestation server. | |
virt - |
If True, hosts in this cluster will be used to run virtual machines. | |
vm_reason - |
If 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. | |
wait boolean |
|
True if the module should wait for the entity to get into desired state. |
Notes
Note
- In order to use this module you have to install oVirt Python SDK. To ensure it’s installed with correct version you can create the following task: pip: name=ovirt-engine-sdk-python version=4.2.4
Examples
# Examples don't contain auth parameter for simplicity,
# look at ovirt_auth module to see how to reuse authentication:
# Create cluster
- ovirt_cluster:
data_center: mydatacenter
name: mycluster
cpu_type: Intel SandyBridge Family
description: mycluster
compatibility_version: 4.0
# Create virt service cluster:
- ovirt_cluster:
data_center: mydatacenter
name: mycluster
cpu_type: Intel Nehalem Family
description: mycluster
switch_type: legacy
compatibility_version: 4.0
ballooning: true
gluster: false
threads_as_cores: true
ha_reservation: true
trusted_service: false
host_reason: false
vm_reason: true
ksm_numa: true
memory_policy: server
rng_sources:
- hwrng
- random
# Create cluster with default network provider
- ovirt_cluster:
name: mycluster
data_center: Default
cpu_type: Intel SandyBridge Family
external_network_providers:
- name: ovirt-provider-ovn
# Remove cluster
- ovirt_cluster:
state: absent
name: mycluster
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
cluster dictionary |
On success if cluster is found. |
Dictionary of all the cluster attributes. Cluster attributes can be found on your oVirt/RHV instance at following url: http://ovirt.github.io/ovirt-engine-api-model/master/#types/cluster.
|
id string |
On success if cluster is found. |
ID of the cluster which is managed
Sample: 7de90f31-222c-436c-a1ca-7e655bd5b60c |
Status
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors
- Ondra Machacek (@machacekondra)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/ovirt_cluster_module.html