W3cubDocs

/Ansible

hitachivantara.vspone_block.vsp.hv_ddp_pool_facts module – Get facts of 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_facts.

New in hitachivantara.vspone_block 3.4.0

Synopsis
Requirements
Parameters
Attributes
Notes
Examples
Returned Facts

Synopsis

- This module retrieves details of DDP Pools on Hitachi VSP storage systems. - This module is only available for VSP One storage systems. - For examples go to URL
https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/vsp_direct/ddp_pool_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.
password string / required	Password for authentication. This is a required field.
username string / required	Username for authentication. This is a required field.
spec dictionary	Specification for retrieving DDP pool information.
pool_id integer	ID of the DDP Pool.
pool_name string	Name of the DDP Pool.

Attributes

Attribute	Support	Description
check_mode	Support: full	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: Get all DDP Pools
  hitachivantara.vspone_block.vsp.hv_ddp_pool_facts:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "password"

- name: Get DDP Pool by ID
  hitachivantara.vspone_block.vsp.hv_ddp_pool_facts:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "password"
    spec:
      pool_id: 15

- name: Get DDP Pool by Name
  hitachivantara.vspone_block.vsp.hv_ddp_pool_facts:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "password"
    spec:
      pool_name: "DDP-1"

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
DDP_Pools dictionary	A list of DDP pools information. Returned: success
capacity_manage list / elements=dictionary	Capacity management details. Returned: success
threshold_depletion integer	Threshold for capacity depletion. Returned: success Sample: `80`
threshold_warning integer	Threshold for capacity warning. Returned: success Sample: `70`
used_capacity_rate integer	Used capacity rate. 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	Details of the drives in the pool. Returned: success
display_drive_capacity string	Display capacity of the drive. Returned: success Sample: `"1.9 TB"`
drive_capacity_gb 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	Drive RPM. Returned: success Sample: `"NUMBER_0"`
drive_type string	Type of the drive. Returned: success Sample: `"SSD"`
locations list / elements=string	Locations of the drives. Returned: success Sample: `["0-0", "0-1", "0-2", "0-3"]`
number_of_drives integer	Number of drives. Returned: success Sample: `4`
parity_group_type string	Parity group type. Returned: success Sample: `"DEFAULT"`
raid_level string	RAID level. 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_mb integer	Free capacity of the pool in MB. 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	Details of saving effects in the pool. Returned: success
calculation_end_time string	End time of the calculation. Returned: success Sample: `"2025-04-03T22:23:00Z"`
calculation_start_time string	Start time of the 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 pool. Returned: success Sample: `"Normal"`
subscription_limit dictionary	Subscription limit details. 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	Details of the tiers in the pool. Returned: success
total_capacity_mb integer	Total capacity of the pool in MiB. Returned: success Sample: `3990`
used_capacity_mb integer	Used capacity of the pool in MB. 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_facts_module.html