ovirt.ovirt.ovirt_host_storage_info module – Retrieve information about one or more oVirt/RHV HostStorages (applicable only for block storage)

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_host_storage_info.

New in ovirt.ovirt 1.0.0

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, returning ansible_facts. Note that the ovirt.ovirt.ovirt_host_storage_info module no longer returns ansible_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
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. Choices: `false` `true` ← (default)
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. Choices: `false` ← (default) `true`
kerberos boolean	A boolean flag indicating if Kerberos authentication should be used instead of the default basic authentication. Choices: `false` `true`
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.
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 `nested_attributes`. This parameter is deprecated and replaced by `follow`. Choices: `false` ← (default) `true`
follow aliases: follows list / elements=string added in ovirt.ovirt 1.5.0	List of linked entities, which should be fetched along with the main entity. This parameter replaces usage of `fetch_nested` and `nested_attributes`. All follow parameters can be found at following url: https://ovirt.github.io/ovirt-engine-api-model/master/#types/host_storage/links_summary
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 `fetch_nested` is true. This parameter is deprecated and replaced by `follow`.

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 }}"

- name: Gather information about all storages
  ovirt.ovirt.ovirt_host_storage_info:
    host: myhost

- name: Gather information about all iscsi storages
  ovirt.ovirt.ovirt_host_storage_info:
    host: myhost
    iscsi: {}

- name: Gather information about all fcp storages
  ovirt.ovirt.ovirt_host_storage_info:
    host: myhost
    fcp: {}

Return Values 

Common return values are documented here, the following are the fields unique to this module:

Key	Description
ovirt_host_storages list / elements=string	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. Returned: On success.

Authors

Daniel Erez (@derez)

ovirt.ovirt.ovirt_host_storage_info module – Retrieve information about one or more oVirt/RHV HostStorages (applicable only for block storage)

Synopsis

Requirements

Parameters

Notes

Examples

Return Values