community.general.ovirt_vm_facts – Retrieve information about one or more oVirt/RHV virtual machines¶
Note
This plugin is part of the community.general collection (version 2.5.1).
To install it use: ansible-galaxy collection install community.general
.
To use it in a playbook, specify: community.general.ovirt_vm_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_vm_info instead.
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_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: 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 all VMs which names start with centos and belong to cluster west
ovirt_vm_info:
pattern: name=centos* and cluster=west
register: result
- name: Print gathered information
ansible.builtin.debug:
msg: "{{ result.ovirt_vms }}"
- name: Gather info about next run configuration of virtual machine named myvm
ovirt_vm_info:
pattern: name=myvm
next_run: true
register: result
- name: Print gathered information
ansible.builtin.debug:
msg: "{{ result.ovirt_vms[0] }}"
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Status¶
This module will be removed in version 3.0.0. [deprecated]
For more information see DEPRECATED.
Authors¶
Ondra Machacek (@machacekondra)