hitachivantara.vspone_block.sds_block.hv_sds_block_storage_pool module – Manages storage pool on Hitachi SDS Block storage systems.

Note

This module is part of the hitachivantara.vspone_block collection (version 4.1.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 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_pool.

New in hitachivantara.vspone_block 4.1.0

Synopsis

• This module allows the expansion of the storage pool on Hitachi SDS Block storage systems.

• For examples, go to URL https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/sds_block_direct/storage_pool.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. This is a required field.
username string / required	Username for authentication. This is a required field.
spec dictionary / required	Specification for the storage pool.
drive_ids list / elements=string	The drive ids to be added to the pool.
id string	The ID of the storage pool.
name string	The name of the storage pool.
state string / required	The desired state of the storage pool. Choices: "expand"

Attributes

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

Examples

- name: Expand storage pool by pool name
  hitachivantara.vspone_block.sds_block.hv_sds_block_storage_pool:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"
    state: "expand"
    spec:
      name: "SP01"
      drive_ids: ["6a14d3cb-264f-41b1-81c0-cdbfab73d358"]

- name: Expand storage pool by pool ID
  hitachivantara.vspone_block.sds_block.hv_sds_block_storage_pool:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"
    state: "expand"
    spec:
      id: "3f9bcecc-9ac5-4c21-abed-5b03e682e7b4"
      drive_ids: ["6a14d3cb-264f-41b1-81c0-cdbfab73d358"]

Return Values

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

Key	Description
storage_pools dictionary	A list of storage pools. Returned: always
storage_pool_info dictionary	Information about the storage pool. Returned: success
blocked_physical_capacity_mb integer	The blocked capacity in the effective physical capacity of the storage pool in MiB. Returned: success Sample: 0
capacity_manage dictionary	Capacity management. Returned: success
maximum_reserve_rate integer	Maximum reserve rate (unit -%). -1 indicates the capacity is unlimited. Returned: success Sample: -1
threshold_depletion integer	The Depletion threshold (unit - %). Returned: success Sample: 80
threshold_storage_controller_depletion integer	The depletion threshold of the storage controller managing the storage pool (unit - %) Returned: success Sample: 95
threshold_warning integer	The warning threshold (unit - %). Returned: success Sample: 80
used_capacity_rate integer	Usage rate (unit - %). Returned: success Sample: 80
data_redundancy integer	Redundancy of user data. Value of 0 means no redundancy, and -1 means that the user data has been lost. Returned: success Sample: 1
encryption_status string	The state of storage pool data encryption. Returned: success Sample: "Disabled"
free_capacity_mb integer	The available capacity of the storage pool in MiB. Returned: success Sample: 7425600
id string	The ID of the storage pool. Returned: success Sample: "fa632b0d8-0ae6-408c-ad41-555cdde9fe83"
meta_data_physical_capacity_mb integer	The capacity for control information in the total physical capacity of the storage pool in MiB. Returned: success Sample: 3563650
name string	The name of the storage pool. Returned: success Sample: "SP01"
number_of_volumes integer	The number of volumes belonging to the storage pool. Returned: success Sample: 3
other_volume_capacity_mb integer	The total capacity of other volumes that have been created on this storage controller in MiB. Returned: success Sample: 0
protection_domain_id string	The ID of the protection domain to which the volume is belonging. Returned: success Sample: "4090c412-edf2-4368-8175-1f60507afbb8"
provisioned_volume_capacity_mb integer	The total capacity of provisioned volumes that have been created on this storage controller in MiB. Returned: success Sample: 2969
rebuild_capacity_policy string	Rebuild capacity policy. Returned: success Sample: "Fixed"
rebuild_capacity_resource_setting dictionary	Resource type and the number of resources of rebuild capacity. Returned: success
number_of_tolerable_drive_failures integer	The number of drive failures that can be tolerated. Returned: success Sample: 1
rebuild_capacity_status string	The status of securing rebuild capacity. Returned: success Sample: "Sufficient"
rebuildable_resources dictionary	Resource for which Rebuild is possible. Returned: success
number_of_drives integer	The number of drives for which Rebuild is possible. Returned: success Sample: 1
redundant_policy string	User data protection method. Returned: success Sample: "Mirroring"
redundant_type string	User data protection type. Returned: success Sample: "Duplication"
reserved_physical_capacity_mb integer	The internally reserved area in the effective physical capacity of the storage pool in MiB. This area cannot be configured redundantly. Returned: success Sample: 3574368
saving_effects dictionary	Effect of the data reduction function on the storage pool. Returned: success
calculation_end_time string	Date and time the calculation ended. Returned: success Sample: "2025-07-10T22:50:34Z"
calculation_start_time string	Date and time the calculation started. Returned: success Sample: "2025-07-10T22:49:52Z"
data_reduction_without_system_data_status string	Status of the reduction effect of the data reduction function. Returned: success Sample: "NoTargetData"
total_efficiency_status string	Status of total efficiency. Returned: success Sample: "NoTargetData"
status string	The storage pool status. Returned: success Sample: "Normal"
status_summary string	The summary of the storage pool status. Returned: success Sample: "Normal"
storage_controller_capacities_general_status string	Summary information about the capacity status of all the storage controllers managing the storage pool. Returned: success Sample: "Normal"
temporary_volume_capacity_mb integer	The total capacity of temporary volumes that have been created on this storage controller in MiB. Returned: success Sample: 0
total_capacity_mb integer	The logical capacity of the storage pool in MiB. Returned: success Sample: 2370312
total_physical_capacity_mb integer	The total physical capacity of the storage pool in MiB. Returned: success Sample: 10683344
total_raw_capacity_mb integer	The effective physical capacity in the total physical capacity of the storage pool in MiB. Returned: success Sample: 8340192
total_volume_capacity_mb integer	The total capacity of volumes that have been created on this storage controller in MiB. Returned: success Sample: 2969
usable_physical_capacity_mb integer	The capacity which can be used as the logical capacity in the effective physical capacity of the storage pool in MiB. Returned: success Sample: 4765824
used_capacity_mb integer	The used capacity of the storage pool in MiB. Returned: success Sample: 0

Authors

• Hitachi Vantara LTD (@hitachi-vantara)

Collection links

• Issue Tracker
• Repository (Sources)