ovirt.ovirt.ovirt_vm_info module – Retrieve information about one or more oVirt/RHV virtual machines
Note
This module is part of the ovirt.ovirt collection (version 3.2.0).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install ovirt.ovirt.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: ovirt.ovirt.ovirt_vm_info.
New in ovirt.ovirt 1.0.0
Synopsis
Retrieve information about one or more oVirt/RHV virtual machines.
This module was called
ovirt_vm_factsbefore Ansible 2.9, returningansible_facts. Note that the ovirt.ovirt.ovirt_vm_info module no longer returnsansible_facts!
Requirements
The below requirements are needed on the host that executes this module.
python >= 2.7
ovirt-engine-sdk-python >= 4.4.0
Parameters
Parameter |
Comments |
|---|---|
If true all the attributes of the virtual machines should be included in the response. Choices:
|
|
Dictionary with values needed to create HTTP/HTTPS connection to oVirt: |
|
A PEM file containing the trusted CA certificates. The certificate presented by the server will be verified using these CA certificates. If Default value is set by |
|
Flag indicating if compression is used for connection. Choices:
|
|
Dictionary of HTTP headers to be added to each API call. |
|
A string containing the hostname of the server, usually something like `server.example.com`. Default value is set by Either |
|
A boolean flag that indicates if the server TLS certificate and host name should be checked. Choices:
|
|
A boolean flag indicating if Kerberos authentication should be used instead of the default basic authentication. Choices:
|
|
The password of the user. Default value is set by |
|
Number of seconds to wait for response. |
|
Token to be used instead of login with username/password. Default value is set by |
|
A string containing the API URL of the server, usually something like `https://server.example.com/ovirt-engine/api`. Default value is set by Either |
|
The name of the user, something like admin@internal. Default value is set by |
|
If true performed search will take case into account. Choices:
|
|
If true it will get from all virtual machines current attached cd. Choices:
|
|
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 This parameter is deprecated and replaced by Choices:
|
|
List of linked entities, which should be fetched along with the main entity. This parameter replaces usage of All follow parameters can be found at following url: https://ovirt.github.io/ovirt-engine-api-model/master/#types/vm/links_summary |
|
The maximum number of results to return. |
|
Specifies list of the attributes which should be fetched from the API. This parameter apply only when This parameter is deprecated and replaced by |
|
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. Choices:
|
|
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.4.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.ovirt.ovirt_vm_info:
pattern: name=centos* and cluster=west
register: result
- ansible.builtin.debug:
msg: "{{ result.ovirt_vms }}"
# Gather info about next run configuration of virtual machine named myvm
- ovirt.ovirt.ovirt_vm_info:
pattern: name=myvm
next_run: true
register: result
- ansible.builtin.debug:
msg: "{{ result.ovirt_vms[0] }}"
# Gather info about VMs original template with follow parameter
- ovirt.ovirt.ovirt_vm_info:
pattern: name=myvm
follow: ['original_template.permissions', 'original_template.nics.vnic_profile']
register: result
- 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:
Key |
Description |
|---|---|
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. Returned: On success. |