ovirt_storage_vm_info – Retrieve information about one or more oVirt/RHV virtual machines relate to a storage domain¶
New in version 2.4.
Synopsis¶
- Retrieve information about one or more oVirt/RHV virtual machines relate to a storage domain.
- This module was called
ovirt_storage_vm_facts
before Ansible 2.9, returningansible_facts
. Note that the ovirt_storage_vm_info module no longer returnsansible_facts
!
Aliases: ovirt_storage_vm_facts
Requirements¶
The below requirements are needed on the host that executes this module.
- python >= 2.7
- ovirt-engine-sdk-python >= 4.3.0
Parameters¶
Notes¶
Note
- This module returns a variable
ovirt_storage_vms
, which contains a list of virtual machines. 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: 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 information about all VMs which relate to a storage domain and
# are unregistered:
- ovirt_vms_info:
unregistered=True
register: result
- debug:
msg: "{{ result.ovirt_storage_vms }}"
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
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)
Hint
If you notice any issues in this documentation, you can edit this document to improve it.