ovirt_vmpool – Module to manage VM pools in oVirt/RHV — Ansible Documentation

- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Documentation

# ovirt_vmpool – Module to manage VM pools in oVirt/RHV

New in version 2.3.

- Synopsis
- Requirements
- Parameters
- Notes
- Examples
- Return Values
- Status

## 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.3.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 `ca_file` parameter is not set, system wide CA certificate store is used. Default value is set by `OVIRT_CAFILE` environment variable.
| 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 `OVIRT_HOSTNAME` environment variable. Either `url` or `hostname` is required.
| insecure boolean | Choices: no yes | A boolean flag that indicates if the server TLS certificate and host name should be checked.
| kerberos boolean | Choices: no yes | 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 `OVIRT_PASSWORD` environment variable.
| token string |  | Token to be used instead of login with username/password. Default value is set by `OVIRT_TOKEN` environment variable.
| 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 `OVIRT_URL` environment variable. Either `url` or `hostname` is required.
| username string / required |  | The name of the user, something like admin@internal. Default value is set by `OVIRT_USERNAME` environment variable.
cluster - |  | Name of the cluster, where VM pool should be created.
comment - |  | Comment of the Virtual Machine pool.
description - |  | Description of the VM pool.
fetch_nested boolean added in 2.3 | Choices: no yes | 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 `nested_attributes`.
id - added in 2.8 |  | ID of the vmpool to manage.
name - / required |  | Name of the VM pool to manage.
nested_attributes list added in 2.3 |  | Specifies list of the attributes which should be fetched from the API. This parameter apply only when `fetch_nested` is true.
poll_interval integer | Default: 3 | Number of the seconds the module waits until another poll request on entity status is sent.
prestarted - |  | 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 - | Choices: present ← absent | Should the VM pool be present/absent. Note that when `state` is absent all VMs in VM pool are stopped and removed.
template - |  | 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 - | Choices: manual automatic | Type of the VM pool. Either manual or automatic. `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. `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.
vm_count - |  | Number of VMs in the pool. Default value is set by engine.
vm_per_user - |  | Maximum number of VMs a single user can attach to from this pool. Default value is set by engine.
wait boolean | Choices: no yes ← | `yes` 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.3.0

## Examples

    # Examples don't contain auth parameter for simplicity,
    # look at ovirt_auth module to see how to reuse authentication:

    # Create VM pool from template
    - ovirt_vmpool:
        cluster: mycluster
        name: myvmpool
        template: rhel7
        vm_count: 2
        prestarted: 2
        vm_per_user: 1

    # Remove vmpool, note that all VMs in pool will be stopped and removed:
    - ovirt_vmpool:
        state: absent
        name: myvmpool

    # Change Pool Name
    - ovirt_vmpool:
        id: 00000000-0000-0000-0000-000000000000
        name: "new_pool_name"

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

## 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)

Hint

If you notice any issues in this documentation you can edit this document to improve it.