ovirt.ovirt.ovirt_vm_os_info – Retrieve information on all supported oVirt/RHV operating systems
ovirt.ovirt.ovirt_vm_os_info – Retrieve information on all supported oVirt/RHV operating systems
Note
This plugin is part of the ovirt.ovirt collection (version 1.2.4).
To install it use: ansible-galaxy collection install ovirt.ovirt
.
To use it in a playbook, specify: ovirt.ovirt.ovirt_vm_os_info
.
New in version 1.1.0: of ovirt.ovirt
Synopsis
- Retrieve information on all supported oVirt/RHV operating systems.
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 | Choices/Defaults | Comments |
---|---|---|
auth dictionary / required |
Dictionary with values needed to create HTTP/HTTPS connection to oVirt:
| |
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 |
filter_keys list / elements=string |
List of attributes which should be in returned. | |
name string |
Name of the operating system which should be returned. | |
nested_attributes list / elements=string |
Specifies list of the attributes which should be fetched from the API. This parameter apply only when |
Notes
Note
- This module returns a variable
ovirt_operating_systems
, which contains a list of operating systems. 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
# Look at ovirt_auth module to see how to reuse authentication:
- ovirt.ovirt.ovirt_vm_os_info:
auth: "{{ ovirt_auth }}"
register: result
- ansible.builtin.debug:
msg: "{{ result.ovirt_operating_systems }}"
- ovirt.ovirt.ovirt_vm_os_info:
auth: "{{ ovirt_auth }}"
filter_keys: name,architecture
register: result
- ansible.builtin.debug:
msg: "{{ result.ovirt_operating_systems }}"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
ovirt_operating_systems list / elements=string |
On success. |
List of dictionaries describing the operating systems. Operating system attributes are mapped to dictionary keys, all operating systems attributes can be found at following url: http://ovirt.github.io/ovirt-engine-api-model/master/#types/operating_system_info.
|
Authors
- Martin Necas (@mnecas)
- Chris Brown (@snecklifter)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/ovirt/ovirt/ovirt_vm_os_info_module.html