ovirt.ovirt.ovirt_datacenter_info – Retrieve information about one or more oVirt/RHV datacenters
ovirt.ovirt.ovirt_datacenter_info – Retrieve information about one or more oVirt/RHV datacenters
Note
This plugin is part of the ovirt.ovirt collection (version 1.3.0).
To install it use: ansible-galaxy collection install ovirt.ovirt
.
To use it in a playbook, specify: ovirt.ovirt.ovirt_datacenter_info
.
New in version 1.0.0: of ovirt.ovirt
Synopsis
- Retrieve information about one or more oVirt/RHV datacenters.
- This module was called
ovirt_datacenter_facts
before Ansible 2.9, returningansible_facts
. Note that the ovirt.ovirt.ovirt_datacenter_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 | Choices/Defaults | Comments | |
---|---|---|---|
auth dictionary / required |
Dictionary with values needed to create HTTP/HTTPS connection to oVirt: | ||
ca_file string |
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 | ||
headers dictionary |
Dictionary of HTTP headers to be added to each API call. | ||
hostname string |
A string containing the hostname of the server, usually something like `server.example.com`. Default value is set by Either | ||
insecure boolean |
|
A boolean flag that indicates if the server TLS certificate and host name should be checked. | |
kerberos boolean |
|
A boolean flag indicating if Kerberos authentication should be used instead of the default basic authentication. | |
password string / required |
The password of the user. Default value is set by | ||
token string |
Token to be used instead of login with username/password. Default value is set by | ||
url string |
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 | ||
username string / required |
The name of the user, something like admin@internal. Default value is set by | ||
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 | |
nested_attributes list / elements=string |
Specifies list of the attributes which should be fetched from the API. This parameter apply only when | ||
pattern string |
Search term which is accepted by oVirt/RHV search backend. For example to search datacenter X use following pattern: name=X |
Notes
Note
- This module returns a variable
ovirt_datacenters
, which contains a list of datacenters. 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 data centers which names start with C(production):
- ovirt.ovirt.ovirt_datacenter_info:
pattern: name=production*
register: result
- ansible.builtin.debug:
msg: "{{ result.ovirt_datacenters }}"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
ovirt_datacenters list / elements=string |
On success. |
List of dictionaries describing the datacenters. Datacenter attributes are mapped to dictionary keys, all datacenters attributes can be found at following url: http://ovirt.github.io/ovirt-engine-api-model/master/#types/data_center.
|
Authors
- Ondra Machacek (@machacekondra)
- Martin Necas (@mnecas)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/ovirt/ovirt/ovirt_datacenter_info_module.html