hitachivantara.vspone_block.sds_block.hv_sds_block_snapshot module – Manages snapshots on Hitachi SDS Block storage systems.

Note

This module is part of the hitachivantara.vspone_block collection (version 4.4.0).

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

New in hitachivantara.vspone_block 4.1.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 the snapshot operation.

master_volume_id

string

The UUID of the master volume. This field is valid for the create operation and is mandatory if the master_volume_name field is not provided.

master_volume_name

string

The name of the master volume. This field is valid for the create operation and is mandatory if the master_volume_id field is not provided.

name

string

The name of the snapshot. This is a valid field for create operation.

operation_type

string

The type of snapshot operation. This field is valid for the create operation and is mandatory.

Choices:

  • "prepare_and_finalize"

  • "prepare"

  • "finalize"

qos

dictionary

QoS settings for the snapshot. This field is valid for the create operation and is optional.

upper_alert_allowable_time

integer

Upper alert allowable time.

upper_limit_for_iops

integer

Upper limit for IOPS.

upper_limit_for_transfer_rate

integer

Upper limit for transfer rate.

snapshot_volume_id

string

The UUID of the snapshot volume. This field is valid for delete and restore operations and is mandatory if the snapshot_volume_name field is not provided.

snapshot_volume_name

string

The name of the snapshot volume. This field is valid for delete and restore operations and is mandatory if the snapshot_volume_id field is not provided.

vps_id

string

The UUID of the VPS.

vps_name

string

The name of the VPS.

state

string

The desired state of the snapshot.

Choices:

  • "present" ← (default)

  • "absent"

  • "restore"

Attributes

Attribute

Support

Description

check_mode

Support: none

Determines if the module should run in check mode.

Examples

- name: Create a snapshot (present)
  hitachivantara.vspone_block.sds_block.hv_sds_block_snapshot:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"
    state: "present"
    spec:
      name: "snapshot1"
      master_volume_name: "volume1"
      operation_type: "prepare_and_finalize"

- name: Delete a snapshot (absent)
  hitachivantara.vspone_block.sds_block.hv_sds_block_snapshot:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"
    state: "absent"
    spec:
      snapshot_volume_name: "snapshot1"

- name: Restore a snapshot (restore)
  hitachivantara.vspone_block.sds_block.hv_sds_block_snapshot:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"
    state: "restore"
    spec:
      snapshot_volume_name: "snapshot1"

Return Values

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

Key

Description

snapshot_info

dictionary

Snapshot volume information retrieved from the storage system.

Returned: always

is_written_in_svol

boolean

Indicates whether data has been written to the secondary volume.

Returned: success

qos_param

dictionary

Quality of Service parameters for the snapshot.

Returned: success

upper_alert_allowable_time

integer

Threshold time for upper alert in seconds.

Returned: success

Sample: 30

upper_alert_time

integer

Current upper alert time setting.

Returned: success

Sample: -1

upper_limit_for_iops

integer

Upper limit for IOPS.

Returned: success

Sample: 120

upper_limit_for_transfer_rate

integer

Upper limit for data transfer rate (MB/s).

Returned: success

Sample: 20

snapshot_concordance_rate

integer

The concordance rate of the snapshot in percentage.

Returned: success

Sample: -1

snapshot_progress_rate

integer

Progress rate of the snapshot operation in percentage.

Returned: success

Sample: -1

snapshot_status

string

Current status of the snapshot.

Returned: success

Sample: "Empty"

snapshot_timestamp

string

Timestamp of the snapshot creation.

Returned: success

Sample: ""

snapshot_type

string

Type of the snapshot.

Returned: success

Sample: "Snapshot"

snapshot_volume_id

string

Unique identifier of the snapshot volume.

Returned: success

Sample: "c3a9d23a-7e03-44a0-b8a3-d39359321947"

snapshot_volume_name

string

Name of the snapshot volume.

Returned: success

Sample: "rd_test_snapshot"

snapshot_volume_nickname

string

Nickname of the snapshot volume.

Returned: success

Sample: "test-volume1"

status

string

Overall snapshot status.

Returned: success

Sample: "Normal"

status_summary

string

Summary of the snapshot status.

Returned: success

Sample: "Normal"

vps_id

string

VPS identifier associated with the snapshot.

Returned: success

Sample: "(system)"

vps_name

string

VPS name associated with the snapshot.

Returned: success

Sample: "(system)"

Authors

  • Hitachi Vantara LTD (@hitachi-vantara)