W3cubDocs

/Ansible

hitachivantara.vspone_block.sds_block.hv_sds_block_vps module – Manages Hitachi SDS block storage system Virtual Private Storages (VPS) volume ADR setting.

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.sds_block.hv_sds_block_vps.

New in hitachivantara.vspone_block 3.1.0

Synopsis
Requirements
Parameters
Attributes
Examples
Return Values

Synopsis

This module allows to update Virtual Private Storages volume ADR setting.
For examples go to URL https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/sds_block_direct/update_vps_volume_adr_setting.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.
connection_type string	Type of connection to the storage system. Choices: `"direct"` ← (default)
password string / required	Password for authentication.
username string / required	Username for authentication.
spec dictionary / required	Specification for VPS information.
capacity_saving string	Capacity saving for the VPS volumes. Choices: `"Disabled"` ← (default) `"Compression"`
vps_id string	ID of the VPS to retrieve information for.
vps_name string	VPS name to retrieve information for.
state string	State of the VPS volume ADR setting. Choices: `"present"` ← (default) `"absent"`

Attributes

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

Examples

- name: Update VPS Volume ADR setting by VPS Id
  hitachivantara.vspone_block.sds_block.hv_sds_block_vps:
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"

    spec:
      vps_id: "464e1fd1-9892-4134-866c-6964ce786676"
      capacity_saving: "Disabled"

- name: Update VPS Volume ADR setting by VPS name
  hitachivantara.vspone_block.sds_block.hv_sds_block_vps:
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"

    spec:
      vps_name: "VPS_01"
      capacity_saving: "Compression"

Return Values

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

Key	Description
vps dictionary	Attributes of the VPS. Returned: always
id string	ID of the VPS. Returned: success Sample: `"d2c1fa60-5c41-486a-9551-ec41c74d9f01"`
name string	Name of the VPS. Returned: success Sample: `"VPS_01"`
number_of_hbas_created integer	Number of HBAs created. Returned: success Sample: `0`
number_of_servers_created integer	Number of servers created. Returned: success Sample: `0`
number_of_sessions_created integer	Number of sessions created. Returned: success Sample: `0`
number_of_user_groups_created integer	Number of user groups created. Returned: success Sample: `0`
number_of_users_created integer	Number of users created. Returned: success Sample: `0`
number_of_volume_server_connections_created integer	Number of volume server connections created. Returned: success Sample: `0`
upper_limit_for_number_of_hbas integer	Upper limit for the number of HBAs. Returned: success Sample: `400`
upper_limit_for_number_of_servers integer	Upper limit for the number of servers. Returned: success Sample: `100`
upper_limit_for_number_of_sessions integer	Upper limit for the number of sessions. Returned: success Sample: `436`
upper_limit_for_number_of_user_groups integer	Upper limit for the number of user groups. Returned: success Sample: `256`
upper_limit_for_number_of_users integer	Upper limit for the number of users. Returned: success Sample: `256`
upper_limit_for_number_of_volume_server_connections integer	Upper limit for the number of volume server connections. Returned: success Sample: `100`
volume_settings dictionary	Settings for the volumes. Returned: success
capacity_of_volumes_created integer	Capacity of volumes created. Returned: success Sample: `0`
capacity_saving_of_volume string	Capacity saving mode of the volume. Returned: success Sample: `"Compression"`
number_of_volumes_created integer	Number of volumes created. Returned: success Sample: `0`
pool_id string	Pool ID associated with the volume. Returned: success Sample: `"f5ef8935-ed38-4894-a90b-f821ab6d3d89"`
qos_param dictionary	Quality of Service parameters for the volume. Returned: success
upper_alert_allowable_time_of_volume integer	Upper alert allowable time of the volume. Returned: success Sample: `-1`
upper_limit_for_iops_of_volume integer	Upper limit for IOPS of the volume. Returned: success Sample: `-1`
upper_limit_for_transfer_rate_of_volume integer	Upper limit for transfer rate of the volume. Returned: success Sample: `-1`
saving_mode_of_volume string	Saving mode of the volume. Returned: success Sample: `"Inline"`
upper_limit_for_capacity_of_single_volume integer	Upper limit for the capacity of a single volume. Returned: success Sample: `-1`
upper_limit_for_capacity_of_volumes integer	Upper limit for the capacity of volumes. Returned: success Sample: `100`
upper_limit_for_number_of_volumes integer	Upper limit for the number of volumes. Returned: success Sample: `50`

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/sds_block.hv_sds_block_vps_module.html