ovirt.ovirt.ovirt_quota – Module to manage datacenter quotas 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_quota.

New in version 1.0.0: of ovirt.ovirt

Synopsis
Requirements
Parameters
Notes
Examples
Return Values

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.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 `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	no yes	A boolean flag that indicates if the server TLS certificate and host name should be checked.
	kerberos boolean	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_grace integer			Cluster grace(hard limit) defined in percentage (1-100). aliases: cluster_hard_limit
cluster_threshold integer			Cluster threshold(soft limit) defined in percentage (0-100). aliases: cluster_soft_limit
clusters list / elements=dictionary			List of dictionary of cluster limits, which is valid to specific cluster. If cluster isn't specified it's valid to all clusters in system:
	cluster string		Name of the cluster.
	cpu string		CPU limit.
	memory string		Memory limit (in GiB).
data_center string / required			Name of the datacenter where quota should be managed.
description string			Description of the quota to manage.
fetch_nested boolean		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 string			ID of the quota to manage.
name string / required			Name of the quota to manage.
nested_attributes list / elements=string			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.
state string		present ← absent	Should the quota be present/absent.
storage_grace integer			Storage grace(hard limit) defined in percentage (1-100). aliases: storage_hard_limit
storage_threshold integer			Storage threshold(soft limit) defined in percentage (0-100). aliases: storage_soft_limit
storages list / elements=dictionary			List of dictionary of storage limits, which is valid to specific storage. If storage isn't specified it's valid to all storages in system:
	size string		Size limit (in GiB).
	storage string		Name of the storage.
timeout integer		Default: 180	The amount of time in seconds the module should wait for the instance to get into desired state.
wait boolean		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.4.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.ovirt.ovirt_quota:
    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.ovirt.ovirt_quota:
    name: quota2
    data_center: dcX
    clusters:
        - memory: 30
          cpu: 15

# Add storage quota to storage data1 with size limit to 100GiB
- ovirt.ovirt.ovirt_quota:
    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.ovirt.ovirt_quota:
    state: absent
    data_center: dcX
    name: quota1

# Change Quota Name
- ovirt.ovirt.ovirt_quota:
    id: 00000000-0000-0000-0000-000000000000
    name: "new_quota_name"
    data_center: dcX

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 quota is found.	ID of the quota which is managed Sample: 7de90f31-222c-436c-a1ca-7e655bd5b60c
quota dictionary	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.

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_quota_module.html