ovirt_vm_info – Retrieve information about one or more oVirt/RHV virtual machines
ovirt_vm_info – Retrieve information about one or more oVirt/RHV virtual machines
Synopsis
- Retrieve information about one or more oVirt/RHV virtual machines.
- This module was called
ovirt_vm_facts
before Ansible 2.9, returningansible_facts
. Note that the ovirt_vm_info module no longer returnsansible_facts
!
Aliases: ovirt_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
Parameter | Choices/Defaults | Comments |
---|---|---|
all_content boolean |
|
If true all the attributes of the virtual machines should be included in the response. |
auth dictionary / required |
Dictionary with values needed to create HTTP/HTTPS connection to oVirt:
| |
case_sensitive boolean |
|
If true performed search will take case into account. |
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 |
max - |
The maximum number of results to return. | |
nested_attributes list |
Specifies list of the attributes which should be fetched from the API. This parameter apply only when | |
next_run boolean added in 2.8 |
|
Indicates if the returned result describes the virtual machine as it is currently running or if describes the virtual machine with the modifications that have already been performed but that will only come into effect when the virtual machine is restarted. By default the value is set by engine. |
pattern - |
Search term which is accepted by oVirt/RHV search backend. For example to search VM X from cluster Y use following pattern: name=X and cluster=Y |
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: 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 names start with C(centos) and
# belong to cluster C(west):
- ovirt_vm_info:
pattern: name=centos* and cluster=west
register: result
- debug:
msg: "{{ result.ovirt_vms }}"
# Gather info about next run configuration of virtual machine named myvm
- ovirt_vm_info:
pattern: name=myvm
next_run: true
register: result
- debug:
msg: "{{ result.ovirt_vms[0] }}"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
ovirt_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
- Ondra Machacek (@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.9/modules/ovirt_vm_info_module.html