hitachivantara.vspone_block.vsp.hv_vsp_one_volume_facts module – Retrieves facts about VSP E series, VSP One Block 20 series, and VSP One Block 80 series storage systems.

Note

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

New in hitachivantara.vspone_block 4.2.0

Synopsis
Requirements
Parameters
Attributes
Notes
Examples
Returned Facts

Synopsis

This module gathers information about volumes in VSP E series, VSP One Block 20 series, and VSP One Block 80 series storage systems.
It supports filtering by pool, server, volume nickname, capacity, and volume ID.
For usage examples, see https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/vsp_direct/vsp_one_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.
api_token string	Token used to operate on locked resources.
password string	Password for authentication. This is a required field.
username string	Username for authentication. This is a required field.
spec dictionary	Specification for the volume task.
begin_volume_id aliases: start_volume_id string	Starting volume ID. Required for the Get facts for a range of volumes by begin_volume_id and count task.
count integer	Number of volumes. Required for the Get facts for a range of volumes by begin_volume_id and count task.
max_total_capacity string	Maximum total capacity. Required for the Get facts for volumes with capacity filters task.
max_used_capacity string	Maximum used capacity. Required for the Get facts for volumes with capacity filters task.
min_total_capacity string	Minimum total capacity. Required for the Get facts for volumes with capacity filters task.
min_used_capacity string	Minimum used capacity. Required for the Get facts for volumes with capacity filters task.
nickname string	Nickname of the volume. Required for the Get facts for a volume by nickname task.
pool_id integer	ID of the pool. Required for the Get facts for volumes in a specific pool by pool ID task.
pool_name string	Name of the pool. if both pool_id is present, it will ignore this parameter. Required for the Get facts for volumes in a specific pool by pool name task.
server_id integer	ID of the server. Required for the Get facts for volumes attached to a server by server ID task.
server_nickname string	Nickname of the server. if both server_id is present, it will ignore this parameter. Required for the Get facts for volumes attached to a server by server nickname task.
volume_id string	ID of the volume. Required for the Get facts for a specific volume by volume_id task.

Attributes

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

Notes

Note

With each request, you can obtain information about a maximum of 500 volumes.
To obtain information about additional volumes, execute the ansible task multiple times by using a combination of the count and start_volume_id parameters.
By specifying the count parameter, you can also filter the volume information you require.
The parameter start_volume_id will be deprecated in the future. Please use begin_volume_id instead.

Examples

- name: Get facts for volumes in a specific pool by pool_id
  hitachivantara.vspone_block.vsp.hv_vsp_one_volume_facts:
    connection_info:
      address: vsp.company.com
      username: "admin"
      password: "password"
    spec:
      pool_id: 1

- name: Get facts for volumes in a specific pool by pool_name
  hitachivantara.vspone_block.vsp.hv_vsp_one_volume_facts:
    connection_info:
      address: vsp.company.com
      username: "admin"
      password: "password"
    spec:
      pool_name: "SP01"

- name: Get facts for volumes attached to a server by server_id
  hitachivantara.vspone_block.vsp.hv_vsp_one_volume_facts:
    connection_info:
      address: vsp.company.com
      username: "admin"
      password: "password"
    spec:
      server_id: 2001

- name: Get facts for volumes attached to a server by server_nickname
  hitachivantara.vspone_block.vsp.hv_vsp_one_volume_facts:
    connection_info:
      address: vsp.company.com
      username: "admin"
      password: "password"
    spec:
      server_nickname: "ComputeNode-1"

- name: Get facts for a volume by nickname
  hitachivantara.vspone_block.vsp.hv_vsp_one_volume_facts:
    connection_info:
      address: vsp.company.com
      username: "admin"
      password: "password"
    spec:
      nickname: "RD-volume-0004"

- name: Get facts for volumes with capacity filters
  hitachivantara.vspone_block.vsp.hv_vsp_one_volume_facts:
    connection_info:
      address: vsp.company.com
      username: "admin"
      password: "password"
    spec:
      min_total_capacity: 100
      max_total_capacity: 500
      min_used_capacity: 50
      max_used_capacity: 400

- name: Get facts for a range of volumes by start_volume_id and count
  hitachivantara.vspone_block.vsp.hv_vsp_one_volume_facts:
    connection_info:
      address: vsp.company.com
      username: "admin"
      password: "password"
    spec:
      start_volume_id: 1000
      count: 10

- name: Get facts for a specific volume by volume_id
  hitachivantara.vspone_block.vsp.hv_vsp_one_volume_facts:
    connection_info:
      address: vsp.company.com
      username: "admin"
      password: "password"
    spec:
      volume_id: 12345

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 volume information objects. Returned: success
capacity_saving string	Capacity saving setting (e.g., DEDUPLICATION_AND_COMPRESSION). Returned: success
capacity_saving_progress integer	Capacity saving progress. Returned: success
capacity_saving_status string	Capacity saving status. Returned: success
compression_acceleration boolean	Whether compression acceleration is enabled. Returned: success
compression_acceleration_status string	Compression acceleration status. Returned: success
free_capacity integer	Free capacity of the volume. Returned: success
free_capacity_in_mb integer	Free capacity in MB. Returned: success
id integer	ID of the volume. Returned: success
id_hex string	ID of the volume in hexadecimal. Returned: success
is_data_reduction_share_enabled boolean	Whether data reduction share is enabled. Returned: success
luns list / elements=dictionary	List of LUNs associated with the volume. Returned: success
nickname string	Nickname of the volume. Returned: success
number_of_connecting_servers integer	Number of servers connected to the volume. Returned: success
number_of_snapshots integer	Number of snapshots for the volume. Returned: success
parent_volume_id integer	ID of the parent volume. Returned: success
parent_volume_id_hex string	ID of the parent volume in hexadecimal. Returned: success
pool_id integer	ID of the pool. Returned: success
pool_name string	Name of the pool. Returned: success
qos_settings dictionary	QoS settings for the volume. Returned: success
reserved_capacity integer	Reserved capacity of the volume. Returned: success
total_capacity integer	Total capacity of the volume. Returned: success
total_capacity_in_mb integer	Total capacity in MB. Returned: success
used_capacity integer	Used capacity of the volume. Returned: success
used_capacity_in_mb integer	Used capacity in MB. Returned: success
volume_types list / elements=string	List of volume types. Returned: success

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/projects/ansible/latest/collections/hitachivantara/vspone_block/vsp.hv_vsp_one_volume_facts_module.html