ovirt.ovirt.ovirt_host_storage_info – Retrieve information about one or more oVirt/RHV HostStorages (applicable only for block storage)
ovirt.ovirt.ovirt_host_storage_info – Retrieve information about one or more oVirt/RHV HostStorages (applicable only for block storage)
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_host_storage_info
.
New in version 1.0.0: of ovirt.ovirt
Synopsis
- Retrieve information about one or more oVirt/RHV HostStorages (applicable only for block storage).
- This module was called
ovirt_host_storage_facts
before Ansible 2.9, returningansible_facts
. Note that the ovirt.ovirt.ovirt_host_storage_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:
| ||
fcp dictionary |
Dictionary with values for fibre channel storage type: | ||
address string |
Address of the fibre channel storage server. | ||
lun_id string |
LUN id. | ||
port string |
Port of the fibre channel storage server. | ||
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 | |
host string / required |
Host to get device list from. | ||
iscsi dictionary |
Dictionary with values for iSCSI storage type: | ||
address string |
Address of the iSCSI storage server. | ||
password string |
A CHAP password for logging into a target. | ||
portal string |
The portal being used to connect with iscsi. | ||
target string |
The target IQN for the storage device. | ||
username string |
A CHAP user name for logging into a target. | ||
nested_attributes list / elements=string |
Specifies list of the attributes which should be fetched from the API. This parameter apply only when |
Notes
Note
- 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 HostStorages with specified target and address:
- ovirt.ovirt.ovirt_host_storage_info:
host: myhost
iscsi:
target: iqn.2016-08-09.domain-01:nickname
address: 10.34.63.204
register: result
- ansible.builtin.debug:
msg: "{{ result.ovirt_host_storages }}"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
ovirt_host_storages list / elements=string |
On success. |
List of dictionaries describing the HostStorage. HostStorage attributes are mapped to dictionary keys, all HostStorage attributes can be found at following url: http://ovirt.github.io/ovirt-engine-api-model/master/#types/host_storage.
|
Authors
- Daniel Erez (@derez)
© 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_host_storage_info_module.html