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 4.4.2).

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 4.4.0

Synopsis

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 / required

Specification for VPS information.

capacity_saving

string

Capacity saving for the VPS volumes.

Choices:

  • "Disabled" ← (default)

  • "Compression"

id

string

ID of the VPS to retrieve information for.

name

string

VPS name to retrieve information for. Mandatory for creating a VPS.

upper_alert_allowable_time_of_volume

integer

The alert threshold value (in seconds) for the upper limit of volume performance for the VPS. This field is valid for update VPS settings. This is used as the default value for the alert threshold for the upper limit of performance of volumes created on the VPS. To set the alert threshold, specify a value in the range from 1 to 600. To set no alert threshold, specify -1. If you specify 0, jobs will be unsuccessful. A message is output to the event log when restriction of the upper limit of performance specified by upper_limit_for_iops_of_volume or upper_limit_for_transfer_rate_of_volume_mbps continues for the specified length of time. This property can be specified if either upper_limit_for_iops_of_volume or upper_limit_for_transfer_rate_of_volume_mbps, or both, is set. If this property is omitted, -1 is assumed to be specified.

upper_limit_for_capacity_of_single_volume_mb

integer

The upper limit of the capacity (in MiB) of a single volume of the VPS. Values between 0 and 6871947674. This field is valid for update VPS settings. To place no limit on the capacity of a single volume, specify -1. For details about the values to be specified for upper_limit_for_capacity_of_single_volume_mb, contact customer support.

upper_limit_for_capacity_of_volumes_mb

integer

The upper limit of the total volume capacity (in MiB) of the VPS. Values between 0 and 9223372036854775807. This field is valid for update VPS settings. For details about the values to be specified for upper_limit_for_capacity_of_volumes_mb, contact customer support.

upper_limit_for_iops_of_volume

integer

The upper limit of volume performance (in IOPS) of the VPS. This field is valid for update VPS settings. This is used as the default value for the upper limit of performance (in IOPS) of volumes created on the VPS. To set the upper limit of volume performance (in IOPS), specify a value in the range from 100 to 2147483647. To set no upper limit, specify -1. If you specify values from 0 to 99, jobs will be unsuccessful. The VPS administrator who creates volumes can set a value that is no more than this value as the upper limit of performance (in IOPS) for each volume. If you make both of the upper_limit_for_iops_of_volume and upper_limit_for_transfer_rate_of_volume_mbps settings unavailable, the setting of upper_alert_allowable_time_of_volume is also made unavailable. If this property is omitted, -1 is assumed to be specified.

upper_limit_for_number_of_servers

integer

The maximum allowable number of compute nodes on the VPS. Values between 0 and 1024. Mandatory for creating a VPS.

upper_limit_for_number_of_sessions

integer

The maximum number of sessions that can be established for the VPS. Values between 0 and 436. If this property is omitted, 436 is assumed to be specified.

upper_limit_for_number_of_user_groups

integer

The maximum number of user groups that can belong to the VPS. Values between 0 and 256. If this property is omitted, 256 is assumed to be specified.

upper_limit_for_number_of_users

integer

The maximum number of users that can belong to the VPS. Values between 0 and 256. If this property is omitted, 256 is assumed to be specified.

upper_limit_for_number_of_volumes

integer

The upper limit of the number of volumes on the VPS. Valid for update VPS settings. For details about the values to be specified for upper_limit_for_number_of_volumes, contact customer support.

upper_limit_for_transfer_rate_of_volume_mbps

integer

The upper limit of volume performance (in MiB/s) for the VPS. This field is valid for update VPS settings. This is used as the default value for the upper limit of performance (in MiB/s) of volumes created on the VPS. To set the upper limit of volume performance (in MiB/s), specify a value in the range from 1 to 2097151. To set no upper limit, specify -1. If you specify 0, jobs will be unsuccessful. The VPS administrator who creates volumes can set a value that is no more than this value as the upper limit of performance (in MiB/s) for each volume. If you make both of the upper_limit_for_iops_of_volume and upper_limit_for_transfer_rate_of_volume_mbps settings unavailable, the setting of upperAlertAllowableTimeOfVolume is also made unavailable. If this property is omitted, -1 is assumed to be specified.

volume_settings

list / elements=dictionary

List of volume_setting objects. This field is valid and mandatory for creating a VPS.

capacity_saving

string

Capacity saving for the VPS volumes.

Choices:

  • "Disabled" ← (default)

  • "Compression"

pool_id

string / required

The ID of the storage pool to be used on the virtual private storage (VPS). Mandatory for creating a VPS.

upper_alert_allowable_time_of_volume

integer

The alert threshold value (in seconds) for the upper limit of volume performance for the VPS. This is used as the default value for the alert threshold for the upper limit of performance of volumes created on the VPS. To set the alert threshold, specify a value in the range from 1 to 600. To set no alert threshold, specify -1. If you specify 0, jobs will be unsuccessful. A message is output to the event log when restriction of the upper limit of performance specified by upper_limit_for_iops_of_volume or upper_limit_for_transfer_rate_of_volume_mbps continues for the specified length of time. This property can be specified if either upper_limit_for_iops_of_volume or upper_limit_for_transfer_rate_of_volume_mbps, or both, is set. If this property is omitted, -1 is assumed to be specified.

upper_limit_for_capacity_of_single_volume_mb

integer

The upper limit of the capacity (in MiB) of a single volume of the VPS. Values between 0 and 6871947674. To place no limit on the capacity of a single volume, specify -1. For details about the values to be specified for upper_limit_for_capacity_of_single_volume_mb, contact customer support.

upper_limit_for_capacity_of_volumes_mb

integer / required

The upper limit of the total volume capacity (in MiB) of the VPS. Values between 0 and 9223372036854775807. Mandatory for creating a VPS. For details about the values to be specified for upper_limit_for_capacity_of_volumes_mb, contact customer support.

upper_limit_for_iops_of_volume

integer

The upper limit of volume performance (in IOPS) of the VPS. This is used as the default value for the upper limit of performance (in IOPS) of volumes created on the VPS. To set the upper limit of volume performance (in IOPS), specify a value in the range from 100 to 2147483647. To set no upper limit, specify -1. If you specify values from 0 to 99, jobs will be unsuccessful. The VPS administrator who creates volumes can set a value that is no more than this value as the upper limit of performance (in IOPS) for each volume. If you make both of the upper_limit_for_iops_of_volume and upper_limit_for_transfer_rate_of_volume_mbps settings unavailable, the setting of upper_alert_allowable_time_of_volume is also made unavailable. If this property is omitted, -1 is assumed to be specified.

upper_limit_for_number_of_volumes

integer / required

The upper limit of the number of volumes on the VPS. Mandatory for creating a VPS. For details about the values to be specified for upper_limit_for_number_of_volumes, contact customer support.

upper_limit_for_transfer_rate_of_volume_mbps

integer

The upper limit of volume performance (in MiB/s) for the VPS. This is used as the default value for the upper limit of performance (in MiB/s) of volumes created on the VPS. To set the upper limit of volume performance (in MiB/s), specify a value in the range from 1 to 2097151. To set no upper limit, specify -1. If you specify 0, jobs will be unsuccessful. The VPS administrator who creates volumes can set a value that is no more than this value as the upper limit of performance (in MiB/s) for each volume. If you make both of the upper_limit_for_iops_of_volume and upper_limit_for_transfer_rate_of_volume_mbps settings unavailable, the setting of upperAlertAllowableTimeOfVolume is also made unavailable. If this property is omitted, -1 is assumed to be specified.

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: Create a VPS
  hitachivantara.vspone_block.sds_block.hv_sds_block_vps:
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"
    spec:
      name: "RKD_VPS_02"
      upper_limit_for_number_of_user_groups: 10
      upper_limit_for_number_of_users: 5
      upper_limit_for_number_of_sessions: 20
      upper_limit_for_number_of_servers: 200
      volume_settings:
        - pool_id: "b78fe7d7-22f3-4d43-a9cf-81af3b4d7bf6"
          upper_limit_for_number_of_volumes: 20
          upper_limit_for_capacity_of_volumes_mb: 300000
          upper_limit_for_capacity_of_single_volume_mb: -1
          upper_limit_for_iops_of_volume: -1
          upper_limit_for_transfer_rate_of_volume_mbps: -1
          upper_alert_allowable_time_of_volume: -1
          capacity_saving: "Disabled"

- name: Update settings of a VPS
  hitachivantara.vspone_block.sds_block.hv_sds_block_vps:
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"
    spec:
      id: "ae0f247c-dc56-491c-9cb9-4b2b6d33b345"
      name: "RKD_VPS_03"
      upper_limit_for_number_of_user_groups: 15
      upper_limit_for_number_of_users: 10
      upper_limit_for_number_of_servers: 300
      upper_limit_for_number_of_sessions: 25
      upper_limit_for_number_of_volumes: 22
      upper_limit_for_capacity_of_volumes_mb: 330000
      upper_limit_for_capacity_of_single_volume_mb: 30000
      capacity_saving: "Disabled"
      upper_limit_for_iops_of_volume: 21474836
      upper_limit_for_transfer_rate_of_volume_mbps: 50
      upper_alert_allowable_time_of_volume: 40

- name: Delete a VPS by ID
  hitachivantara.vspone_block.sds_block.hv_sds_block_vps:
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"
      spec:
        id: "ae0f247c-dc56-491c-9cb9-4b2b6d33b345"

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)