hitachivantara.vspone_block.vsp.hv_storagesystem_facts module – retrieves storage system information from VSP block 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_storagesystem_facts.

New in hitachivantara.vspone_block 3.0.0

Synopsis
Requirements
Parameters
Attributes
Notes
Examples
Returned Facts

Synopsis

This module gathers facts about a specific storage system.
For examples, go to URL https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/vsp_direct/storagesystem_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.
connection_type string	Type of connection to the storage system. Choices: `"direct"` ← (default)
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 storage system facts to be gathered.
query list / elements=string	Additional information to be gathered. Required for the Getting a list of time zones that can be used in a storage system task. Choices: `"time_zone"`
storage_system_info dictionary	Information about the storage system. This field is an optional field.
serial string	The serial number of the storage system.

Attributes

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

Notes

Note

The input parameter refresh was removed in version 3.4.0. They were deprecated due to internal API simplification and are no longer supported.
Connection type gateway was removed starting from version 3.4.0. Please use an earlier version if you require this connection type.
For Get storage system facts
1. Use the controller IP instead of the SVP IP to obtain storage capacity details in the task output.

Examples

- name: Get Storage System facts
  hitachivantara.vspone_block.vsp.hv_storagesystem_facts:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"

- name: Get Storage System using query
  hitachivantara.vspone_block.vsp.hv_storagesystem_facts:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"
    spec:
      query: ["time_zone"]

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
storage_system dictionary	The storage system information. Returned: always
controller_address string	IP address of the controller. Returned: success Sample: `"192.168.1.101"`
device_limits dictionary	Limits for various device parameters. Returned: success
external_group_number_range dictionary	Range for external group numbers. Returned: success
is_valid boolean	Indicates if the range is valid. Returned: success Sample: `false`
max_value integer	Maximum value of the range. Returned: success Sample: `-1`
min_value integer	Minimum value of the range. Returned: success Sample: `-1`
external_group_sub_number_range dictionary	Range for external group sub-numbers. Returned: success
is_valid boolean	Indicates if the range is valid. Returned: success Sample: `false`
max_value integer	Maximum value of the range. Returned: success Sample: `-1`
min_value integer	Minimum value of the range. Returned: success Sample: `-1`
parity_group_number_range dictionary	Range for parity group numbers. Returned: success
is_valid boolean	Indicates if the range is valid. Returned: success Sample: `false`
max_value integer	Maximum value of the range. Returned: success Sample: `-1`
min_value integer	Minimum value of the range. Returned: success Sample: `-1`
parity_group_sub_number_range dictionary	Range for parity group sub-numbers. Returned: success
is_valid boolean	Indicates if the range is valid. Returned: success Sample: `false`
max_value integer	Maximum value of the range. Returned: success Sample: `-1`
min_value integer	Minimum value of the range. Returned: success Sample: `-1`
free_capacity string	Free capacity of the storage system. Returned: success Sample: `"1.38TB"`
free_capacity_in_mb integer	Free capacity in megabytes. Returned: success Sample: `1445087`
free_gad_consistency_group_id integer	Free GAD consistency group ID. Returned: success Sample: `-1`
free_local_clone_consistency_group_id integer	Free local clone consistency group ID. Returned: success Sample: `-1`
free_remote_clone_consistency_group_id integer	Free remote clone consistency group ID. Returned: success Sample: `-1`
health_description string	Description of the health status. Returned: success Sample: `""`
health_status string	Health status of the storage system. Returned: success Sample: `""`
is_compression_acceleration_available boolean	Indicates if compression acceleration is available. Returned: success Sample: `true`
management_address string	Management IP address of the storage system. Returned: success Sample: `""`
microcode_version string	Microcode version of the storage system. Returned: success Sample: `"A3-04-21-40/00"`
model string	Model of the storage system. Returned: success Sample: `"VSP One B26"`
operational_status string	Operational status of the storage system. Returned: success Sample: `""`
resource_state string	Resource state of the storage system. Returned: success Sample: `""`
serial_number string	Serial number of the storage system. Returned: success Sample: `"810045"`
syslog_config dictionary	Syslog configuration of the storage system. Returned: success
detailed boolean	Indicates if detailed logging is enabled. Returned: success Sample: `true`
syslog_servers list / elements=dictionary	List of syslog servers. Returned: success
id integer	ID of the syslog server. Returned: success Sample: `0`
syslog_server_address string	Address of the syslog server. Returned: success Sample: `"203.0.113.2"`
syslog_server_port string	Port of the syslog server. Returned: success Sample: `"514"`
system_date_time dictionary	System date and time configuration. Returned: always
adjusts_daylight_saving_time boolean	Indicates if daylight saving time is adjusted. Returned: success
is_ntp_enabled boolean	Indicates if NTP is enabled. Returned: success Sample: `false`
ntp_server_names list / elements=string	List of NTP server names. Returned: success Sample: `[]`
synchronizing_local_time string	Local time synchronization status. Returned: success Sample: `""`
system_time string	Current system time in ISO 8601 format. Returned: success Sample: `"2025-11-24T04:24:59Z"`
time_zone_id string	Time zone identifier. Returned: success Sample: `"Etc/GMT"`
time_zones_info boolean	Time zones information flag. Returned: success Sample: `false`
total_capacity string	Total capacity of the storage system. Returned: success Sample: `"32.84TB"`
total_capacity_in_mb integer	Total capacity in megabytes. Returned: success Sample: `34440151`
total_efficiency dictionary	Total efficiency information of the storage system. Returned: success
accelerated_compression dictionary	Accelerated compression statistics. Returned: success
compression_ratio string	Compression ratio for accelerated compression. Returned: success Sample: `"1.00"`
reclaim_ratio string	Reclaim ratio for accelerated compression. Returned: success Sample: `"1.00"`
total_ratio string	Total ratio for accelerated compression. Returned: success Sample: `"1.00"`
calculation_end_time string	End time of efficiency calculation in ISO 8601 format. Returned: success Sample: `"2025-11-24T04:22:46Z"`
calculation_start_time string	Start time of efficiency calculation in ISO 8601 format. Returned: success Sample: `"2025-11-24T04:20:06Z"`
compression_ratio string	Overall compression ratio. Returned: success Sample: `"1.35"`
dedupe_and_compression dictionary	Deduplication and compression statistics. Returned: success
compression_ratio string	Compression ratio for dedupe and compression. Returned: success Sample: `"1.08"`
dedupe_ratio string	Deduplication ratio. Returned: success Sample: `"1.02"`
reclaim_ratio string	Reclaim ratio for dedupe and compression. Returned: success Sample: `"2.15"`
total_ratio string	Total ratio for dedupe and compression. Returned: success Sample: `"2.38"`
is_calculated boolean	Indicates if efficiency has been calculated. Returned: success Sample: `true`
provisioning_rate string	Provisioning rate percentage. Returned: success Sample: `"99"`
snapshot_ratio string	Snapshot ratio. Returned: success Sample: `"1067.48"`
total_ratio string	Overall total efficiency ratio. Returned: success Sample: `"651.49"`

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