hitachivantara.vspone_block.sds_block.hv_sds_block_storage_system module – Manages storage system settings on VSP One SDS Block and Cloud systems.

Note

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

New in hitachivantara.vspone_block 4.4.0

Synopsis

• This module manages storage system configuration including certificate management, cache settings, and other system-level configurations on VSP One SDS Block and Cloud systems.

• For examples, see the project repository on GitHub.

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.
connection_type string	Type of connection to the storage system. Choices: "direct" ← (default)
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 storage system configuration settings.
download_path string	Local path where files will be downloaded.
enable_write_back_mode_with_cache_protection boolean	Enable write-back mode with cache protection for improved performance. Choices: false true
force boolean	Force the operation even if it might cause data loss or system disruption. Choices: false true
root_certificate_file_path string	Path to the root certificate file for SSL/TLS authentication.
state string	Desired state of the storage system choices are present, absent, delete_root_certificate, import_root_certificate, download_root_certificate. Choices: "present" ← (default) "absent" "delete_root_certificate" "import_root_certificate" "download_root_certificate"

Attributes

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

Examples

- name: Configure storage system with write-back cache protection
  hitachivantara.vspone_block.sds_block.hv_sds_block_storage_system:
    connection_info:
      address: "{{ storage_system_ip }}"
      username: "{{ username }}"
      password: "{{ password }}"
    state: present
    spec:
      enable_write_back_mode_with_cache_protection: true

- name: Import root certificate
  hitachivantara.vspone_block.sds_block.hv_sds_block_storage_system:
    connection_info:
      address: "{{ storage_system_ip }}"
      username: "{{ username }}"
      password: "{{ password }}"
    state: import_root_certificate
    spec:
      root_certificate_file_path: "/path/to/certificate.pem"

- name: Download root certificate
  hitachivantara.vspone_block.sds_block.hv_sds_block_storage_system:
    connection_info:
      address: "{{ storage_system_ip }}"
      username: "{{ username }}"
      password: "{{ password }}"
    state: download_root_certificate
    spec:
      download_path: "/local/path/certificates/"

- name: Delete root certificate
  hitachivantara.vspone_block.sds_block.hv_sds_block_storage_system:
    connection_info:
      address: "{{ storage_system_ip }}"
      username: "{{ username }}"
      password: "{{ password }}"
    state: delete_root_certificate
    spec:
      force: true

Return Values

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

Key	Description
storage_system dictionary	The storage system information. Returned: always
free_pool_capacity integer	Free pool capacity in bytes (or unit as returned by API). Returned: success Sample: 9518460
free_pool_capacity_in_mb integer	Free pool capacity in megabytes. Returned: success Sample: 9518460
id string	Storage system UUID. Returned: success Sample: "20ea66d2-99a5-43ed-a733-304d99dafe42"
internal_id string	Internal identifier for the storage system. Returned: success Sample: "095562"
meta_data_redundancy_of_cache_protection_summary integer	Summary value for cache protection metadata redundancy. Returned: success Sample: 1
model_name string	Model name of the storage system. Returned: success Sample: "VSSBB1"
nickname string	User-friendly name for the storage system. Returned: success Sample: "SC01"
number_of_fault_domains integer	Number of fault domains. Returned: success Sample: 1
number_of_ready_storage_nodes integer	Number of ready storage nodes. Returned: success Sample: 3
number_of_total_servers integer	Number of total servers. Returned: success Sample: 14
number_of_total_storage_nodes integer	Number of total storage nodes. Returned: success Sample: 3
number_of_total_volumes integer	Number of total volumes. Returned: success Sample: 30
saving_effects dictionary	Efficiency and saving related metrics. Returned: success
efficiency_data_reduction integer	Efficiency data reduction percentage. Returned: success Sample: 100
total_efficiency integer	Total efficiency metric (as returned by API). Returned: success Sample: 75385
service_id string	Service identifier if present. Returned: success Sample: ""
software_version string	Software version installed on the storage system. Returned: success Sample: "01.18.01.40"
status string	Operational status of the storage system. Returned: success Sample: "Ready"
status_summary string	Summary of health/status. Returned: success Sample: "Normal"
storage_device_id string	Storage device identifier. Returned: success Sample: "400000095562"
system_requirements_file_version integer	Version of the system requirements file. Returned: success Sample: 20250830
total_pool_capacity integer	Total pool capacity in bytes (or unit as returned by API). Returned: success Sample: 9519048
total_pool_capacity_in_mb integer	Total pool capacity in megabytes. Returned: success Sample: 9519048
total_pool_physical_capacity integer	Total physical capacity of the pool in bytes (or unit as returned by API). Returned: success Sample: 30523824
total_pool_physical_capacity_in_mb integer	Total physical capacity in megabytes. Returned: success Sample: 30523824
total_pool_raw_capacity integer	Total raw capacity of the pool in bytes (or unit as returned by API). Returned: success Sample: 24226272
total_pool_raw_capacity_in_mb integer	Total raw capacity in megabytes. Returned: success Sample: 24226272
used_pool_capacity integer	Used pool capacity in bytes (or unit as returned by API). Returned: success Sample: 588
used_pool_capacity_in_mb integer	Used pool capacity in megabytes. Returned: success Sample: 588
write_back_mode_with_cache_protection string	Write-back mode with cache protection status. Returned: success Sample: "Enabled"

Authors

• Hitachi Vantara LTD (@hitachi-vantara)

Collection links

• Issue Tracker
• Repository (Sources)