ovirt_quotas - Module to manage datacenter quotas in oVirt/RHV

New in version 2.3.

Synopsis
- Requirements
Parameters
Notes
Examples
Return Values
Status
- Author

Synopsis

Module to manage datacenter quotas in oVirt/RHV

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: `username`[required] - The name of the user, something like admin@internal. Default value is set by OVIRT_USERNAME environment variable. `password`[required] - The password of the user. Default value is set by OVIRT_PASSWORD environment variable. `url`[required] - A string containing the base URL of the server, usually something like `https://server.example.com/ovirt-engine/api`. Default value is set by OVIRT_URL environment variable. `token` - Token to be used instead of login with username/password. Default value is set by OVIRT_TOKEN environment variable. `insecure` - A boolean flag that indicates if the server TLS certificate and host name should be checked. `ca_file` - 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. `kerberos` - A boolean flag indicating if Kerberos authentication should be used instead of the default basic authentication. `headers` - Dictionary of HTTP headers to be added to each API call.
cluster_grace		Cluster grace(hard limit) defined in percentage (1-100).
cluster_threshold		Cluster threshold(soft limit) defined in percentage (0-100).
clusters		List of dictionary of cluster limits, which is valid to specific cluster. If cluster isn't spefied it's valid to all clusters in system: `cluster` - Name of the cluster. `memory` - Memory limit (in GiB). `cpu` - CPU limit.
data_center required		Name of the datacenter where quota should be managed.
description		Description of the quota to manage.
fetch_nested (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 `nested_attributes`.
name required		Name of the quota 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 `fetch_nested` is true.
poll_interval	Default: 3	Number of the seconds the module waits until another poll request on entity status is sent.
state	Choices: present ← absent	Should the quota be present/absent.
storage_grace		Storage grace(hard limit) defined in percentage (1-100).
storage_threshold		Storage threshold(soft limit) defined in percentage (0-100).
storages		List of dictionary of storage limits, which is valid to specific storage. If storage isn't spefied it's valid to all storages in system: `storage` - Name of the storage. `size` - Size limit (in GiB).
timeout	Default: 180	The amount of time in seconds the module should wait for the instance to get into desired state.
wait		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.0.0

Examples

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

# Add cluster quota to cluster cluster1 with memory limit 20GiB and CPU limit to 10:
- ovirt_quotas:
    name: quota1
    data_center: dcX
    clusters:
        - name: cluster1
          memory: 20
          cpu: 10

# Add cluster quota to all clusters with memory limit 30GiB and CPU limit to 15:
- ovirt_quotas:
    name: quota2
    data_center: dcX
    clusters:
        - memory: 30
          cpu: 15

# Add storage quota to storage data1 with size limit to 100GiB
- ovirt_quotas:
    name: quota3
    data_center: dcX
    storage_grace: 40
    storage_threshold: 60
    storages:
        - name: data1
          size: 100

# Remove quota quota1 (Note the quota must not be assigned to any VM/disk):
- ovirt_quotas:
    state: absent
    data_center: dcX
    name: quota1

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Returned	Description
id str	On success if quota is found.	ID of the quota which is managed Sample: 7de90f31-222c-436c-a1ca-7e655bd5b60c
quota dict	On success if quota is found.	Dictionary of all the quota attributes. Quota attributes can be found on your oVirt/RHV instance at following url: http://ovirt.github.io/ovirt-engine-api-model/master/#types/quota.

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Author

Ondra Machacek (@machacekondra)

Hint

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

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.5/modules/ovirt_quotas_module.html