ovirt_host_storage_facts - Retrieve facts about one or more oVirt/RHV HostStorages (applicable only for block storage)¶

New in version 2.4.

Synopsis
- Requirements
Parameters
Notes
Examples
Return Values
Status
Maintenance
- Author

Synopsis ¶

Retrieve facts about one or more oVirt/RHV HostStorages (applicable only for block storage).

Requirements ¶

The below requirements are needed on the host that executes this module.

python >= 2.7
ovirt-engine-sdk-python >= 4.2.4

Parameters ¶

Parameter	Choices/Defaults	Comments
auth required		Dictionary with values needed to create HTTP/HTTPS connection to oVirt: `username`[required] - The name of the user, something like [email protected]. Default value is set by OVIRT_USERNAME environment variable. `password`[required] - The password of the user. Default value is set by OVIRT_PASSWORD environment variable. `url`- 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. `hostname` - 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. `token` - Token to be used instead of login with username/password. Default value is set by OVIRT_TOKEN environment variable. `insecure` - A boolean flag that indicates if the server TLS certificate and host name should be checked. `ca_file` - 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. `kerberos` - A boolean flag indicating if Kerberos authentication should be used instead of the default basic authentication. `headers` - Dictionary of HTTP headers to be added to each API call.
fcp		Dictionary with values for fibre channel storage type: `address` - Address of the fibre channel storage server. `port` - Port of the fibre channel storage server. `lun_id` - LUN id.
fetch_nested bool (added in 2.3)	Choices: no yes	If True the module will fetch additional data from the API. It will fetch IDs of the VMs disks, snapshots, etc. User can configure to fetch other attributes of the nested entities by specifying `nested_attributes`.
host required		Host to get device list from.
iscsi		Dictionary with values for iSCSI storage type: `address` - Address of the iSCSI storage server. `target` - The target IQN for the storage device. `username` - A CHAP user name for logging into a target. `password` - A CHAP password for logging into a target.
nested_attributes (added in 2.3)		Specifies list of the attributes which should be fetched from the API. This parameter apply only when `fetch_nested` is true.

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

Examples ¶

# Examples don't contain auth parameter for simplicity,
# look at ovirt_auth module to see how to reuse authentication:

# Gather facts about HostStorages with specified target and address:
- ovirt_host_storage_facts:
    host: myhost
    iscsi:
      target: iqn.2016-08-09.domain-01:nickname
      address: 10.34.63.204
- debug:
    var: 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	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.

Status ¶

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Maintenance ¶

This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.

For a list of other modules that are also maintained by the Ansible Community, see here.

Author ¶

Daniel Erez (@derez)

Hint

If you notice any issues in this documentation you can edit this document to improve it.