ovirt_storage_vm_facts – Retrieve facts about one or more oVirt/RHV virtual machines relate to a storage domain
ovirt_storage_vm_facts – Retrieve facts about one or more oVirt/RHV virtual machines relate to a storage domain
New in version 2.4.
Synopsis
- Retrieve facts about one or more oVirt/RHV virtual machines relate to a storage domain.
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:
| |
fetch_nested boolean added in 2.3 |
|
If yes 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 |
max - |
Sets the maximum number of virtual machines to return. If not specified all the virtual machines are returned. | |
nested_attributes list added in 2.3 |
Specifies list of the attributes which should be fetched from the API. This parameter apply only when | |
storage_domain - |
The storage domain name where the virtual machines should be listed. | |
unregistered boolean |
|
Flag which indicates whether to get unregistered virtual machines which contain one or more disks which reside on a storage domain or diskless virtual machines. |
Notes
Note
- This module creates a new top-level
ovirt_storage_vms
fact, which contains a list of virtual machines. - 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.3.0
Examples
# Examples don't contain auth parameter for simplicity,
# look at ovirt_auth module to see how to reuse authentication:
# Gather facts about all VMs which relate to a storage domain and
# are unregistered:
- ovirt_vms_facts:
unregistered=True
- debug:
var: ovirt_storage_vms
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
ovirt_storage_vms list |
On success. |
List of dictionaries describing the VMs. VM attributes are mapped to dictionary keys, all VMs attributes can be found at following url: http://ovirt.github.io/ovirt-engine-api-model/master/#types/vm.
|
Status
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors
- Maor Lipchuk (@machacekondra)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/ovirt_storage_vm_facts_module.html