W3cubDocs

/Ansible

hitachivantara.vspone_block.vsp.hv_ddp_pool module – Manages DDP Pools on Hitachi VSP storage systems.

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.vsp.hv_ddp_pool.

New in hitachivantara.vspone_block 3.4.0

Synopsis
Requirements
Parameters
Attributes
Notes
Examples
Return Values

Synopsis

- This module manages DDP Pools on Hitachi VSP storage systems. - It allows for the creation, deletion, and modification of DDP Pools. - This module supports only on VSP One storage systems. - For examples go to URL
https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/vsp_direct/ddp_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.
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 DDP pool tasks.
drives list / elements=dictionary	List of drives to be added to the DDP Pool.
data_drive_count integer	Specify at least 9 for the number of data drives. if not specified, the number of data drives will be selected with recommend count.
drive_type_code string	Specify a drive type code consisting of 12 characters. if not specified, the drive type code will be selected automatically.
is_encryption_enabled boolean	Whether encryption is enabled for the DDP Pool. Choices: `false` `true`
pool_id integer	ID of the DDP Pool.
pool_name string	Name of the DDP Pool.
threshold_depletion integer	Depletion threshold for the DDP Pool.
threshold_warning integer	Warning threshold for the DDP Pool.
state string	The level of the Remote connection task. Choices are `present`, `absent` `expand`. Choices: `"present"` ← (default) `"absent"` `"expand"`

Attributes

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

Notes

Note

Connection type gateway was removed starting from version 3.4.0. Please use an earlier version if you require this connection type.

Examples

- name: Create a new DDP Pool
  hitachivantara.vspone_block.vsp.hv_ddp_pool:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "password"
    state: present
    spec:
      pool_name: "GK-21268"
      is_encryption_enabled: true
      threshold_warning: 70
      threshold_depletion: 80
      drives:
        - drive_type_code: "NM5C-R1R9NC"
          data_drive_count: 9

- name: Create a new DDP Pool with automatic drive type code and count
  hitachivantara.vspone_block.vsp.hv_ddp_pool:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "password"
    state: present
    spec:
      pool_name: "GK-21268"

- name: Update the DDP Pool Settings
  hitachivantara.vspone_block.vsp.hv_ddp_pool:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "password"
    state: present
    spec:
      pool_id: 12
      threshold_warning: 70
      threshold_depletion: 80
      pool_name: "GK-21268"

- name: Expand the DDP Pool size
  hitachivantara.vspone_block.vsp.hv_ddp_pool:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "password"
    state: expand
    spec:
      pool_id: 12
      drives:
        - drive_type_code: "NM5C-R1R9NC"
          data_drive_count: 9

- name: Delete a DDP Pool
  hitachivantara.vspone_block.vsp.hv_ddp_pool:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "password"
    state: absent
    spec:
      pool_id: 12

Return Values

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

Key	Description
DDP_Pool dictionary	Details of the managed DDP Pool. Returned: success
capacity_manage dictionary	Capacity management details of the DDP Pool. Returned: success
threshold_depletion integer	Depletion threshold for the pool. Returned: success Sample: `80`
threshold_warning integer	Warning threshold for the pool. Returned: success Sample: `70`
used_capacity_rate integer	Used capacity rate of the pool. Returned: success Sample: `0`
config_status list / elements=string	Configuration status of the pool. Returned: success
contains_capacity_saving_volume boolean	Indicates if the pool contains capacity-saving volumes. Returned: success Sample: `false`
drives list / elements=dictionary	List of drives in the DDP Pool. Returned: success
display_drive_capacity string	Display capacity of the drive. Returned: success Sample: `"1.9 TB"`
drive_capacity integer	Capacity of the drive in GB. Returned: success Sample: `1900`
drive_interface string	Interface type of the drive. Returned: success Sample: `"NVMe"`
drive_rpm string	RPM of the drive. Returned: success Sample: `"NUMBER_0"`
drive_type string	Type of the drive. Returned: success Sample: `"SSD"`
locations list / elements=string	Physical locations of the drives. Returned: success Sample: `["0-0", "0-1", "0-2", "0-3"]`
number_of_drives integer	Number of drives in the pool. Returned: success Sample: `4`
parity_group_type string	Parity group type of the drives. Returned: success Sample: `"DEFAULT"`
raid_level string	RAID level of the drives. Returned: success Sample: `"RAID5"`
total_capacity integer	Total capacity of the drives in GB. Returned: success Sample: `7600`
effective_capacity integer	Effective capacity of the pool in GB. Returned: success Sample: `3990`
encryption string	Encryption status of the pool. Returned: success Sample: `"DISABLED"`
free_capacity integer	Free capacity of the pool in GB. Returned: success Sample: `3990`
id integer	ID of the DDP Pool. Returned: success Sample: `15`
name string	Name of the DDP Pool. Returned: success Sample: `"GK-21268"`
number_of_drive_types integer	Number of drive types in the pool. Returned: success Sample: `1`
number_of_tiers integer	Number of tiers in the pool. Returned: success Sample: `0`
number_of_volumes integer	Number of volumes in the pool. Returned: success Sample: `13`
saving_effects dictionary	Data saving effects of the pool. Returned: success
calculation_end_time string	End time of the saving calculation. Returned: success Sample: `"2025-04-03T22:23:00Z"`
calculation_start_time string	Start time of the saving calculation. Returned: success Sample: `"2025-04-03T22:21:19Z"`
data_reduction_without_system_data integer	Data reduction without system data. Returned: success Sample: `-1`
data_reduction_without_system_data_status string	Status of data reduction without system data. Returned: success Sample: `"NoTargetData"`
efficiency_data_reduction integer	Efficiency of data reduction. Returned: success Sample: `-1`
efficiency_fmd_saving integer	Efficiency of FMD saving. Returned: success Sample: `-1`
is_total_efficiency_support boolean	Indicates if total efficiency is supported. Returned: success Sample: `true`
post_capacity_fmd_saving integer	Post-capacity FMD saving. Returned: success Sample: `0`
pre_capacity_fmd_saving integer	Pre-capacity FMD saving. Returned: success Sample: `0`
software_saving_without_system_data integer	Software saving without system data. Returned: success Sample: `-1`
software_saving_without_system_data_status string	Status of software saving without system data. Returned: success Sample: `"NoTargetData"`
total_efficiency integer	Total efficiency of the pool. Returned: success Sample: `9223372036854775807`
total_efficiency_status string	Status of total efficiency. Returned: success Sample: `"Valid"`
status string	Status of the DDP Pool. Returned: success Sample: `"Normal"`
subscription_limit dictionary	Subscription limit details of the pool. Returned: success
current_rate integer	Current subscription rate. Returned: success Sample: `396`
is_enabled boolean	Indicates if subscription limit is enabled. Returned: success Sample: `false`
tiers list / elements=dictionary	List of tiers in the pool. Returned: success
total_capacity integer	Total capacity of the pool in GB. Returned: success Sample: `3990`
used_capacity integer	Used capacity of the pool in GB. Returned: success Sample: `0`

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/vsp.hv_ddp_pool_module.html