Note
This plugin is part of the ovirt.ovirt collection (version 1.6.4).
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.
To use it in a playbook, specify: ovirt.ovirt.ovirt_storage_domain_info.
New in version 1.0.0: of ovirt.ovirt
ovirt_storage_domain_facts before Ansible 2.9, returning ansible_facts. Note that the ovirt.ovirt.ovirt_storage_domain_info module no longer returns ansible_facts!The below requirements are needed on the host that executes this module.
| 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 ca_file parameter is not set, system wide CA certificate store is used.Default value is set by OVIRT_CAFILE environment variable. | ||
| compress boolean |
| Flag indicating if compression is used for connection. | |
| 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 OVIRT_HOSTNAME environment variable.Either url or hostname is required. | ||
| 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 | The password of the user. Default value is set by OVIRT_PASSWORD environment variable. | ||
| timeout integer | Number of seconds to wait for response. | ||
| token string | Token to be used instead of login with username/password. Default value is set by OVIRT_TOKEN environment variable. | ||
| 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 OVIRT_URL environment variable.Either url or hostname is required. | ||
| username string | The name of the user, something like admin@internal. Default value is set by OVIRT_USERNAME environment variable. | ||
| 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.This parameter is deprecated and replaced by follows. | |
| follows list / elements=string added in 1.5.0 of ovirt.ovirt | List of linked entities, which should be fetched along with the main entity. This parameter replaces usage of fetch_nested and nested_attributes. | ||
| nested_attributes list / elements=string | Specifies list of the attributes which should be fetched from the API. This parameter apply only when fetch_nested is true.This parameter is deprecated and replaced by follows. | ||
| pattern string | Search term which is accepted by oVirt/RHV search backend. For example to search storage domain X from datacenter Y use following pattern: name=X and datacenter=Y | ||
Note
ovirt_storage_domains, which contains a list of storage domains. You need to register the result with the register keyword to use it.# Examples don't contain auth parameter for simplicity,
# look at ovirt_auth module to see how to reuse authentication:
# Gather information about all storage domains which names start with C(data) and
# belong to data center C(west):
- ovirt.ovirt.ovirt_storage_domain_info:
pattern: name=data* and datacenter=west
register: result
- ansible.builtin.debug:
msg: "{{ result.ovirt_storage_domains }}"
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
| ovirt_storage_domains list / elements=string | On success. | List of dictionaries describing the storage domains. Storage_domain attributes are mapped to dictionary keys, all storage domains attributes can be found at following url: http://ovirt.github.io/ovirt-engine-api-model/master/#types/storage_domain. |
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/ovirt/ovirt/ovirt_storage_domain_info_module.html