Documentation

ovirt_quotas - Module to manage datacenter quotas in oVirt/RHV

New in version 2.3.

Synopsis

  • Module to manage datacenter quotas in oVirt/RHV

Requirements (on host that executes module)

  • python >= 2.7
  • ovirt-engine-sdk-python >= 4.0.0

Options

parameter required default choices comments
auth
yes
Dictionary with values needed to create HTTP/HTTPS connection to oVirt:
username[required] - The name of the user, something like [email protected]. 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
no
Cluster grace(hard limit) defined in percentage (1-100).
cluster_threshold
no
Cluster threshold(soft limit) defined in percentage (0-100).
clusters
no
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
yes
Name of the datacenter where quota should be managed.
description
no
Description of the quota to manage.
fetch_nested
(added in 2.3)
no
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
yes
Name of the quota to manage.
nested_attributes
(added in 2.3)
no
Specifies list of the attributes which should be fetched from the API.
This parameter apply only when fetch_nested is true.
poll_interval
no 3
Number of the seconds the module waits until another poll request on entity status is sent.
state
no present
  • present
  • absent
Should the quota be present/absent.
storage_grace
no
Storage grace(hard limit) defined in percentage (1-100).
storage_threshold
no
Storage threshold(soft limit) defined in percentage (0-100).
storages
no
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
no 180
The amount of time in seconds the module should wait for the instance to get into desired state.
wait
no
True if the module should wait for the entity to get into desired state.

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 Return Values, the following are the fields unique to this module:

name description returned type sample
id
ID of the quota which is managed
On success if quota is found. str 7de90f31-222c-436c-a1ca-7e655bd5b60c
quota
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.
On success if quota is found. dict


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

Status

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

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.