W3cubDocs

/Ansible

hitachivantara.vspone_block.vsp.hv_storagesystem module – Manages 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_storagesystem.

New in hitachivantara.vspone_block 3.0.0

DEPRECATED
Synopsis
Requirements
Parameters
Attributes
Notes
Examples
Return Values
Status

DEPRECATED

Removed in:: version 4.0.0
Why:: The connection type gateway is deprecated.
Alternative:: Not available.

Synopsis

This module manages Hitachi VSP storage systems.
This module is supported only for gateway connection type.
For examples go to URL https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/vsp_uai_gateway/storagesystem.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 either the UAI gateway.
api_token string	Token value to access UAI gateway. This is a required field for `gateway` connection type.
connection_type string / required	Type of connection to the storage system. Choices: `"gateway"`
password string	Password for authentication. This field is valid for `direct` connection type only, and it is a required field. Not needed for this module.
subscriber_id string	This field is valid for `gateway` connection type only. This is an optional field and only needed to support multi-tenancy environment.
username string	Username for authentication. This field is valid for `direct` connection type only, and it is a required field. Not needed for this module.
state string	The desired state of the storage system. Choices: `"present"` ← (default) `"absent"`
storage_system_info dictionary / required	Information about the Hitachi storage system. This field is required for gateway connection type only.
address string / required	IP address or hostname of the storage system.
password string / required	Password for authentication. This field is valid for `direct` connection type only, and it is a required field.
remote_gateway_address string	Remote gateway address for the storage system.
serial string	Serial number of the Hitachi storage system.
username string / required	Username for authentication. This field is valid for `direct` connection type only, and it is a required field.

Attributes

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

Notes

Note

This module is deprecated and will be removed in a future release.

Examples

- name: Add Storage System for gateway connection type
  hitachivantara.vspone_block.vsp.hv_storagesystem:
    storage_system_info:
      serial: "811150"
      address: storage1.company.com
      username: "username"
      password: "password"
    connection_info:
      address: gateway.company.com
      api_token: "api token value"
      connection_type: "gateway"
      subscriber_id: 12345
    state: present

- name: Delete Storage System for gateway connection type
  hitachivantara.vspone_block.vsp.hv_storagesystem:
    storage_system_info:
      serial: "811150"
    connection_info:
      address: gateway.company.com
      api_token: "api token value"
      connection_type: "gateway"
      subscriber_id: 12345
    state: absent

Return Values

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

Key	Description
storage_systems dictionary	Dictionary containing the discovered properties of the storage systems. Returned: always
controller_address string	IP address of the storage system controller. Returned: success Sample: `"192.168.0.126"`
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: `true`
max_value integer	Maximum value of the range. Returned: success Sample: `16384`
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: `true`
max_value integer	Maximum value of the range. Returned: success Sample: `4096`
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: `true`
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: `true`
max_value integer	Maximum value of the range. Returned: success Sample: `32`
min_value integer	Minimum value of the range. Returned: success Sample: `1`
free_capacity string	Free capacity of the storage system. Returned: success Sample: `"15.88 TB"`
free_capacity_in_mb integer	Free capacity of the storage system in megabytes. Returned: success Sample: `16655844`
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`
management_address string	Management IP address of the storage system. Returned: success Sample: `"192.168.0.126"`
microcode_version string	Microcode version of the storage system. Returned: success Sample: `"93-07-23-80/01"`
model string	Model of the storage system. Returned: success Sample: `"VSP E1090H"`
operational_status string	Operational status of the storage system. Returned: success Sample: `"Normal"`
serial_number string	Serial number of the storage system. Returned: success Sample: `"715036"`
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: `"192.168.0.143"`
syslog_server_port string	Port of the syslog server. Returned: success Sample: `"514"`
total_capacity string	Total capacity of the storage system. Returned: success Sample: `"27.62 TB"`
total_capacity_in_mb integer	Total capacity of the storage system in megabytes. Returned: success Sample: `28958726`

Status

This module will be removed in version 4.0.0. [deprecated]
For more information see DEPRECATED.

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