ovirt.ovirt.ovirt_vmpool – Module to manage VM pools in oVirt/RHV
ovirt.ovirt.ovirt_vmpool – Module to manage VM pools in oVirt/RHV
Note
This plugin is part of the ovirt.ovirt collection (version 1.2.4).
To install it use: ansible-galaxy collection install ovirt.ovirt
.
To use it in a playbook, specify: ovirt.ovirt.ovirt_vmpool
.
New in version 1.0.0: of ovirt.ovirt
Synopsis
- Module to manage VM pools in oVirt/RHV.
Requirements
The below requirements are needed on the host that executes this module.
- python >= 2.7
- ovirt-engine-sdk-python >= 4.4.0
Parameters
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
auth dictionary / required |
Dictionary with values needed to create HTTP/HTTPS connection to oVirt: | ||
ca_file string |
A PEM file containing the trusted CA certificates. The certificate presented by the server will be verified using these CA certificates. If Default value is set by | ||
headers dictionary |
Dictionary of HTTP headers to be added to each API call. | ||
hostname string |
A string containing the hostname of the server, usually something like `server.example.com`. Default value is set by Either | ||
insecure boolean |
|
A boolean flag that indicates if the server TLS certificate and host name should be checked. | |
kerberos boolean |
|
A boolean flag indicating if Kerberos authentication should be used instead of the default basic authentication. | |
password string / required |
The password of the user. Default value is set by | ||
token string |
Token to be used instead of login with username/password. Default value is set by | ||
url string |
A string containing the API URL of the server, usually something like `https://server.example.com/ovirt-engine/api`. Default value is set by Either | ||
username string / required |
The name of the user, something like admin@internal. Default value is set by | ||
cluster string |
Name of the cluster, where VM pool should be created. | ||
comment string |
Comment of the Virtual Machine pool. | ||
description string |
Description of the VM pool. | ||
fetch_nested boolean |
|
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 | |
id string |
ID of the vmpool to manage. | ||
name string / required |
Name of the VM pool to manage. | ||
nested_attributes list / elements=string |
Specifies list of the attributes which should be fetched from the API. This parameter apply only when | ||
poll_interval integer |
Default: 3 |
Number of the seconds the module waits until another poll request on entity status is sent. | |
prestarted integer |
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. | ||
state string |
|
Should the VM pool be present/absent. Note that when | |
template string |
Name of the template, which will be used to create VM pool. | ||
timeout integer |
Default: 180 |
The amount of time in seconds the module should wait for the instance to get into desired state. | |
type string |
|
Type of the VM pool. Either manual or automatic.
Default value is set by engine. | |
vm dictionary |
For creating vm pool without editing template. Note: You can use | ||
cloud_init string |
Dictionary with values for Unix-like Virtual Machine initialization using cloud init.
| ||
comment string |
Comment of the Virtual Machine. | ||
memory string |
Amount of memory of the Virtual Machine. Prefix uses IEC 60027-2 standard (for example 1GiB, 1024MiB). Default value is set by engine. | ||
memory_guaranteed string |
Amount of minimal guaranteed memory of the Virtual Machine. Prefix uses IEC 60027-2 standard (for example 1GiB, 1024MiB).
Default value is set by engine. | ||
memory_max string |
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. | ||
nics string |
List of NICs, which should be attached to Virtual Machine. NIC is described by following dictionary.
NOTE - This parameter is used only when To manage NICs of the VM in more depth please use ovirt.ovirt.ovirt_nics module instead. | ||
smartcard_enabled boolean |
|
If true, use smart card authentication. | |
sso boolean |
|
True enable Single Sign On by Guest Agent, False to disable it. By default is chosen by oVirt/RHV engine. | |
timezone string |
Sets time zone offset of the guest hardware clock. For example | ||
vm_count integer |
Number of VMs in the pool. Default value is set by engine. | ||
vm_per_user integer |
Maximum number of VMs a single user can attach to from this pool. Default value is set by engine. | ||
wait boolean |
|
|
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.4.0
Examples
# Examples don't contain auth parameter for simplicity,
# look at ovirt_auth module to see how to reuse authentication:
- name: Create VM pool from template
ovirt.ovirt.ovirt_vmpool:
cluster: mycluster
name: myvmpool
template: rhel7
vm_count: 2
prestarted: 2
vm_per_user: 1
- name: Remove vmpool, note that all VMs in pool will be stopped and removed
ovirt.ovirt.ovirt_vmpool:
state: absent
name: myvmpool
- name: Change Pool Name
ovirt.ovirt.ovirt_vmpool:
id: 00000000-0000-0000-0000-000000000000
name: "new_pool_name"
- name: Create vm pool and override the pool values
ovirt.ovirt.ovirt_vmpool:
cluster: mycluster
name: vmpool
template: blank
vm_count: 2
prestarted: 1
vm_per_user: 1
vm:
memory: 4GiB
memory_guaranteed: 4GiB
memory_max: 10GiB
comment: vncomment
cloud_init:
nic_boot_protocol: static
nic_ip_address: 10.34.60.86
nic_netmask: 255.255.252.0
nic_gateway: 10.34.63.254
nic_name: eth1
host_name: example.com
custom_script: |
write_files:
- content: |
Hello, world!
path: /tmp/greeting.txt
permissions: '0644'
user_name: root
root_password: super_password
nics:
- name: nicname
interface: virtio
profile_name: network
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
id string |
On success if VM pool is found. |
ID of the VM pool which is managed
Sample: 7de90f31-222c-436c-a1ca-7e655bd5b60c |
vm_pool dictionary |
On success if VM pool is found. |
Dictionary of all the VM pool attributes. VM pool attributes can be found on your oVirt/RHV instance at following url: http://ovirt.github.io/ovirt-engine-api-model/master/#types/vm_pool.
|
Authors
- Ondra Machacek (@machacekondra)
- Martin Necas (@mnecas)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/ovirt/ovirt/ovirt_vmpool_module.html