W3cubDocs

/Ansible

hitachivantara.vspone_block.sds_block.hv_sds_block_storage_system_facts module – Retrieves information about a specific Hitachi SDS block storage system.

Note

This module is part of the hitachivantara.vspone_block collection (version 3.5.1).

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 hitachivantara.vspone_block. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: hitachivantara.vspone_block.sds_block.hv_sds_block_storage_system_facts.

New in hitachivantara.vspone_block 3.0.0

Synopsis
Requirements
Parameters
Attributes
Examples
Returned Facts

Synopsis

This module gathers facts about a specific storage system.
For examples go to URL https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/sds_block_direct/storagesystem_facts.yml

Requirements

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

python >= 3.9

Parameters

Parameter	Comments
connection_info dictionary / required	Information required to establish a connection to the storage system.
address string / required	IP address or hostname of the storage system.
connection_type string	Type of connection to the storage system. Choices: `"direct"` ← (default)
password string / required	Password for authentication.
username string / required	Username for authentication.

Attributes

Attribute	Support	Description
check_mode	Support: full	Determines if the module should run in check mode.

Examples

- name: Get Storage System
  hitachivantara.vspone_block.sds_block.hv_sds_block_storage_system_facts:
      connection_info:
          address: sdsb.company.com
          username: "admin"
          password: "secret"

Returned Facts

Facts returned by this module are added/updated in the hostvars host facts and can be referenced by name just like any other host fact. They do not need to be registered in order to use them.

Key	Description
storagesystem dictionary	The storage system information. Returned: success
efficiency_data_reduction integer	Efficiency data reduction percentage. Returned: success Sample: `100`
free_pool_capacity_in_mb integer	Free pool capacity in megabytes. Returned: success Sample: `9518292`
health_statuses list / elements=dictionary	List of health statuses. Returned: success
protection_domain_id string	Protection domain identifier. Returned: success Sample: `""`
status string	Health status. Returned: success Sample: `"Normal"`
type string	Type of health status. Returned: success Sample: `"License"`
number_of_compute_ports integer	Number of compute ports. Returned: success Sample: `3`
number_of_drives integer	Number of drives. Returned: success Sample: `36`
number_of_fault_domains integer	Number of fault domains. Returned: success Sample: `1`
number_of_storage_pools integer	Number of storage pools. Returned: success Sample: `1`
number_of_total_servers integer	Number of total servers. Returned: success Sample: `16`
number_of_total_storage_nodes integer	Number of total storage nodes. Returned: success Sample: `0`
number_of_total_volumes integer	Number of total volumes. Returned: success Sample: `14`
total_efficiency integer	Total efficiency percentage. Returned: success Sample: `210`
total_pool_capacity_in_mb integer	Total pool capacity in megabytes. Returned: success Sample: `9519048`
used_pool_capacity_in_mb integer	Used pool capacity in megabytes. Returned: success Sample: `756`

Authors

Hitachi Vantara LTD (@hitachi-vantara)

Collection links

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/hitachivantara/vspone_block/sds_block.hv_sds_block_storage_system_facts_module.html