community.general.ovirt_quota_facts – Retrieve information about one or more oVirt/RHV quotas
community.general.ovirt_quota_facts – Retrieve information about one or more oVirt/RHV quotas
Note
This plugin is part of the community.general collection (version 2.0.1).
To install it use: ansible-galaxy collection install community.general
.
To use it in a playbook, specify: community.general.ovirt_quota_facts
.
DEPRECATED
- Removed in
- version 3.0.0
- Why
- When migrating to collection we decided to use only _info modules.
- Alternative
- Use ovirt.ovirt.ovirt_quota_info instead.
Synopsis
- Retrieve information about one or more oVirt/RHV quotas.
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:
| |
data_center string / required |
Name of the datacenter where quota resides. | |
fetch_nested boolean |
|
If yes the module will fetch additional data from the API. It will fetch only IDs of nested entity. It doesn't fetch multiple levels of nested attributes. Only the attributes of the current entity. User can configure to fetch other attributes of the nested entities by specifying |
name string |
Name of the quota, can be used as glob expression. | |
nested_attributes list / elements=string |
Specifies list of the attributes which should be fetched from the API. This parameter apply only when |
Notes
Note
- This module returns a variable
ovirt_quotas
, which contains a list of quotas. You need to register the result with the register keyword to use it. - 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: ansible.builtin.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:
- name: Gather information about quota named C<myquota> in Default datacenter
ovirt_quota_info:
data_center: Default
name: myquota
register: result
- name: Print gathered information
ansible.builtin.debug:
msg: "{{ result.ovirt_quotas }}"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
ovirt_quotas list / elements=string |
On success. |
List of dictionaries describing the quotas. Quota attributes are mapped to dictionary keys, all quotas attributes can be found at following url: http://ovirt.github.io/ovirt-engine-api-model/master/#types/quota.
|
Status
- This module will be removed in version 3.0.0. [deprecated]
- For more information see DEPRECATED.
Authors
- Maor Lipchuk (@machacekondra)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/general/ovirt_quota_facts_module.html