ovirt_quotas_facts - Retrieve facts about one or more oVirt quotas¶

New in version 2.3.

Synopsis
Requirements (on host that executes module)
Options
Examples
Return Values
Notes
- Status
- Support

Synopsis ¶

Retrieve facts about one or more oVirt quotas.

Requirements (on host that executes module)¶

python >= 2.7

ovirt-engine-sdk-python >= 4.0.0

Options ¶

parameter	required	comments
auth	yes	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.
data_center	yes	Name of the datacenter where quota resides.
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	no	Name of the quota, can be used as glob expression.
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.

Examples ¶

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

# Gather facts about quota named C<myquota> in Default datacenter:
- ovirt_quotas_facts:
    data_center: Default
    name: myquota
- debug:
    var: ovirt_quotas

Return Values ¶

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

name	description	returned	type	sample
ovirt_quotas	List of dictionaries describing the quotas. Quota attribues are mapped to dictionary keys, all quotas attributes can be found at following url: https://ovirt.example.com/ovirt-engine/api/model#types/quota.	On success.	list

Notes ¶

Note

This module creates a new top-level ovirt_quotas fact, which contains a list of quotas.
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.

Support ¶

This module is community maintained without core committer oversight.

For more information on what this means please read Module Support

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