W3cubDocs

/Ansible

hitachivantara.vspone_block.sds_block.hv_sds_block_volume_facts module – Retrieves information about Hitachi SDS block storage system volumes.

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

New in hitachivantara.vspone_block 3.0.0

Synopsis
Requirements
Parameters
Attributes
Examples
Returned Facts

Synopsis

This module retrieves information about storage volumes.
It provides details about a storage volume such as name, type and other details.
For examples go to URL https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/sds_block_direct/volume_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.
spec dictionary	Specification for retrieving volume information.
capacity_saving string	Settings of the data reduction function for volumes. Choices: `"Disabled"` `"Compression"`
count integer	The maximum number of obtained volume information items. Default is 500. Default: `500`
names list / elements=string	The names of the volumes.
nicknames list / elements=string	The nickname of the volume.

Attributes

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

Examples

- name: Get volumes by default count
  hitachivantara.vspone_block.sds_block.hv_sds_block_volume_facts:
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"

- name: Get volumes by count
  hitachivantara.vspone_block.sds_block.hv_sds_block_volume_facts:
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"

    spec:
      count: 200

- name: Get volumes by names
  hitachivantara.vspone_block.sds_block.hv_sds_block_volume_facts:
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"

    spec:
      names: ['test-volume1', 'test-volume2']

- name: Get volumes by other filters
  hitachivantara.vspone_block.sds_block.hv_sds_block_volume_facts:
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"

    spec:
      count: 200
      capacity_saving: 'Disabled'

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
volumes list / elements=dictionary	List of storage volumes with their attributes. Returned: success
compute_node_info list / elements=dictionary	Information about the compute nodes connected to the volume. Returned: success
id string	Unique identifier for the compute node. Returned: success Sample: `"4f9041aa-ab2f-4789-af2e-df4a0178a4d3"`
name string	Name of the compute node. Returned: success Sample: `"hitachitest"`
volume_info dictionary	Detailed information about the volume. Returned: success
capacity_saving string	Capacity saving status. Returned: success Sample: `"Disabled"`
data_reduction_effects dictionary	Effects of data reduction on the volume. Returned: success
post_capacity_data_reduction integer	Capacity after data reduction. Returned: success Sample: `0`
pre_capacity_data_reduction_without_system_data integer	Capacity before data reduction without system data. Returned: success Sample: `0`
system_data_capacity integer	Capacity of system data. Returned: success Sample: `0`
data_reduction_progress_rate boolean	Progress rate of data reduction. Returned: success Sample: `false`
data_reduction_status string	Status of data reduction. Returned: success Sample: `"Disabled"`
full_allocated boolean	Whether the volume is fully allocated. Returned: success Sample: `false`
id string	Unique identifier for the volume. Returned: success Sample: `"ef69d5c6-ed7c-4302-959f-b8b8a7382f3b"`
naa_id string	NAA identifier for the volume. Returned: success Sample: `"60060e810a85a000600a85a000000017"`
name string	Name of the volume. Returned: success Sample: `"vol010"`
nickname string	Nickname of the volume. Returned: success Sample: `"vol010"`
number_of_connecting_servers integer	Number of servers connected to the volume. Returned: success Sample: `1`
number_of_snapshots integer	Number of snapshots of the volume. Returned: success Sample: `0`
pool_id string	Identifier of the pool to which the volume belongs. Returned: success Sample: `"cb9f7ecf-ceba-4d8e-808b-9c7bc3e59c03"`
pool_name string	Name of the pool to which the volume belongs. Returned: success Sample: `"SP01"`
protection_domain_id string	Identifier of the protection domain. Returned: success Sample: `"645c36b6-da9e-44bb-b711-430e06c7ad2b"`
qos_param dictionary	Quality of Service parameters for the volume. Returned: success
upper_alert_allowable_time integer	Upper alert allowable time. Returned: success Sample: `-1`
upper_alert_time boolean	Upper alert time. Returned: success Sample: `false`
upper_limit_for_iops integer	Upper limit for IOPS. Returned: success Sample: `-1`
upper_limit_for_transfer_rate integer	Upper limit for transfer rate. Returned: success Sample: `-1`
saving_mode boolean	Whether saving mode is enabled. Returned: success Sample: `false`
snapshot_attribute string	Snapshot attribute. Returned: success Sample: `"-"`
snapshot_status boolean	Snapshot status. Returned: success Sample: `false`
status string	Status of the volume. Returned: success Sample: `"Normal"`
status_summary string	Summary of the volume status. Returned: success Sample: `"Normal"`
storage_controller_id string	Identifier of the storage controller. Returned: success Sample: `"fc22f6d3-2bd3-4df5-b5db-8a728e301af9"`
total_capacity_mb integer	Total capacity of the volume in MB. Returned: success Sample: `120`
used_capacity_mb integer	Used capacity of the volume in MB. Returned: success Sample: `0`
volume_number integer	Volume number. Returned: success Sample: `23`
volume_type string	Type of the volume. Returned: success Sample: `"Normal"`
vps_id string	Identifier of the VPS. Returned: success Sample: `"(system)"`
vps_name string	Name of the VPS. Returned: success Sample: `"(system)"`

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_volume_facts_module.html