hitachivantara.vspone_block.vsp.hv_storage_system module – This module specifies storage systems settings like updating the date and time.

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_storage_system.

New in hitachivantara.vspone_block 4.0.0

Synopsis
Requirements
Parameters
Attributes
Notes
Examples
Return Values

Synopsis

This module allows you to configure various storage system settings, such as updating the date and time, enabling or disabling NTP, setting time zones.
For example usage, visit https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/vsp_direct/storage_system.yml

Requirements

The below requirements are needed on the host that executes this module.

python >= 3.8

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 / required	Specification storage system.
date_time dictionary / required	Date and time configuration for the storage system.
adjusts_daylight_saving_time boolean	Whether daylight saving time is adjusted. Optional for the Set date and time in Storage System with NTP enabled task. Choices: `false` `true`
is_ntp_enabled boolean / required	Whether NTP is enabled. Required for the Set date and time in Storage System with NTP disabled /Set date and time in Storage System with NTP enabled tasks. Choices: `false` `true`
ntp_server_names list / elements=string	List of NTP server names. Optional for the Set date and time in Storage System with NTP enabled task.
synchronizes_now boolean	Whether to synchronize time immediately. Required for the Set date and time in Storage System with NTP disabled task. Optional for the Set date and time in Storage System with NTP enabled task. Choices: `false` `true`
synchronizing_local_time string	Synchronizing local time. Optional for the Set date and time in Storage System with NTP enabled task.
system_time string / required	System time in ISO format. Required for the Set date and time in Storage System with NTP disabled /Set date and time in Storage System with NTP enabled tasks.
time_zone_id string / required	Time zone identifier. Required for the Set date and time in Storage System with NTP disabled /Set date and time in Storage System with NTP enabled tasks.

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.
For Set date and time in Storage System with NTP disabled
This feature is supported on the following block storage systems
1. VSP One Block 20 series
1. VSP E series
1. VSP G350, G370, G700, G900
1. VSP F350, F370, F700, F900
For Set date and time in Storage System with NTP enabled - This feature is supported on the following block storage systems
1. VSP One Block 20 series
1. VSP E series
1. VSP G350, G370, G700, G900
1. VSP F350, F370, F700, F900

Examples

- name: Configure storage system date and time settings
  hitachivantara.vspone_block.vsp.hv_storage_system:
    connection_info:
      address: 192.0.2.10
      username: admin
      password: secret
    spec:
      date_time:
        is_ntp_enabled: true
        ntp_server_names:
          - "ntp1.example.com"
          - "ntp2.example.com"
        time_zone_id: "UTC"
        system_time: "2024-06-01T12:00:00Z"
        synchronizing_local_time: "2024-06-01T12:00:00Z"
        adjusts_daylight_saving_time: true
        synchronizes_now: false

Return Values

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

Key	Description
system_info dictionary	Detailed information about the storage system, including configuration, capacity, and health status. Returned: always
controller_address string	Controller IP address of the storage system. Returned: success Sample: `""`
device_limits dictionary	Device number limits and ranges for parity and external groups. Returned: success
external_group_number_range dictionary	Range of valid 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 external group number. Returned: success Sample: `-1`
min_value integer	Minimum value of the external group number. Returned: success Sample: `-1`
external_group_sub_number_range dictionary	Range of valid sub-numbers for external groups. Returned: success
is_valid boolean	Indicates if the range is valid. Returned: success Sample: `false`
max_value integer	Maximum value of the sub-number. Returned: success Sample: `-1`
min_value integer	Minimum value of the sub-number. Returned: success Sample: `-1`
parity_group_number_range dictionary	Range of valid parity group numbers. Returned: success
is_valid boolean	Indicates if the range is valid. Returned: success Sample: `false`
max_value integer	Maximum parity group number. Returned: success Sample: `-1`
min_value integer	Minimum parity group number. Returned: success Sample: `-1`
parity_group_sub_number_range dictionary	Range of valid sub-numbers for parity groups. Returned: success
is_valid boolean	Indicates if the range is valid. Returned: success Sample: `false`
max_value integer	Maximum sub-number. Returned: success Sample: `-1`
min_value integer	Minimum sub-number. Returned: success Sample: `-1`
free_capacity string	Total available free capacity in human-readable format. Returned: success Sample: `"1.68TB"`
free_capacity_in_mb integer	Free capacity in megabytes. Returned: success Sample: `1756387`
free_gad_consistency_group_id integer	Available GAD consistency group ID. Returned: success Sample: `-1`
free_local_clone_consistency_group_id integer	Available local clone consistency group ID. Returned: success Sample: `-1`
free_logical_unit_list list / elements=string	List of available logical units. Returned: success
free_remote_clone_consistency_group_id integer	Available remote clone consistency group ID. Returned: success Sample: `-1`
health_description string	Detailed description of the system health. Returned: success Sample: `""`
health_status string	Overall system health status. Returned: success Sample: `""`
journal_pools list / elements=string	List of journal pools configured in the system. Returned: success Sample: `[]`
management_address string	Management IP address of the storage system. Returned: success Sample: `""`
microcode_version string	Microcode (firmware) version of the system. Returned: success Sample: `"A3-04-21-40/00"`
model string	Model name of the storage system. Returned: success Sample: `"VSP One B26"`
operational_status string	Current operational status of the system. Returned: success Sample: `""`
ports list / elements=string	List of configured ports in the system. Returned: success Sample: `[]`
quorum_disks list / elements=string	List of quorum disks configured in the system. Returned: success Sample: `[]`
resource_state string	Current resource state of the system. Returned: success Sample: `""`
serial_number string	Serial number of the storage system. Returned: success Sample: `"810045"`
storage_pools list / elements=string	List of available storage pools in the system. Returned: success Sample: `[]`
syslog_config dictionary	Syslog server configuration for system logging. Returned: success
detailed boolean	Indicates if detailed syslog output is enabled. Returned: success Sample: `true`
syslog_servers list / elements=dictionary	List of configured syslog servers. Returned: success
id integer	ID of the syslog server. Returned: success Sample: `0`
syslog_server_address string	IP address or hostname of the syslog server. Returned: success Sample: `"203.0.113.2"`
syslog_server_port string	Syslog server port number. Returned: success Sample: `"514"`
system_date_time dictionary	System date, time, and time synchronization information. Returned: success
adjusts_daylight_saving_time boolean	Indicates if daylight saving time adjustment is enabled. Returned: success
is_ntp_enabled boolean	Indicates if NTP synchronization is enabled. Returned: success Sample: `false`
ntp_server_names list / elements=string	List of configured NTP servers. 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-10-23T11:32:50Z"`
time_zone_id string	Configured system time zone. Returned: success Sample: `"Etc/GMT"`
time_zones_info list / elements=string	Information about available time zones. Returned: success
total_capacity string	Total system capacity in human-readable format. Returned: success Sample: `"28.98TB"`
total_capacity_in_mb integer	Total system capacity in megabytes. Returned: success Sample: `30387994`
total_efficiency dictionary	Efficiency and compression metrics of the system. Returned: success
accelerated_compression dictionary	Accelerated compression efficiency ratios. 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 efficiency ratio for accelerated compression. Returned: success Sample: `"1.00"`
calculation_end_time string	End time of the efficiency calculation. Returned: success Sample: `"2025-10-04T06:55:45Z"`
calculation_start_time string	Start time of the efficiency calculation. Returned: success Sample: `"2025-10-04T06:52:58Z"`
compression_ratio string	Overall compression ratio. Returned: success Sample: `"1.26"`
dedupe_and_compression dictionary	Dedupe and compression efficiency ratios. Returned: success
compression_ratio string	Compression ratio after deduplication. Returned: success Sample: `"1.07"`
dedupe_ratio string	Deduplication ratio. Returned: success Sample: `"1.02"`
reclaim_ratio string	Reclaim ratio for dedupe and compression. Returned: success Sample: `"1.80"`
total_ratio string	Total ratio combining dedupe and compression. Returned: success Sample: `"1.98"`
is_calculated boolean	Indicates if efficiency ratios were calculated successfully. Returned: success Sample: `true`
provisioning_rate string	Provisioning rate percentage. Returned: success Sample: `"99"`
snapshot_ratio string	Snapshot space efficiency ratio. Returned: success Sample: `"1156.81"`
total_ratio string	Overall total efficiency ratio. Returned: success Sample: `"1056.78"`

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