hitachivantara.vspone_block.sds_block.hv_sds_block_snapshot_facts module – Retrieves information about snapshots.

Note

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

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.

ca_cert

string

Path to a CA certificate file or directory on the Ansible control node used to verify the storage system SSL certificate.

Required when connection_info.validate_cert is true and the storage system uses a self-signed or privately issued certificate.

Accepts a PEM file path or a directory of hashed CA certificates.

client_cert

string

Path to client SSL certificate file or CA certificate directory for mutual TLS authentication.

Must be provided together with connection_info.client_key.

client_key

string

Path to the client private key file for mutual TLS authentication.

Must be provided together with connection_info.client_cert.

connection_type

string

Type of connection to the storage system.

Choices:

  • "direct" ← (default)

password

string / required

Password for authentication. This is a required field.

suppress_validate_cert_warning

boolean

Whether to suppress the SSL certificate validation warning.

When set to false (default), a warning is displayed if certificate validation is disabled.

Set to true to suppress the warning.

Choices:

  • false ← (default)

  • true

username

string / required

Username for authentication. This is a required field.

validate_cert

boolean

Whether to validate the storage system SSL certificate.

When set to false (default), certificate validation is disabled. A security warning will be displayed unless connection_info.suppress_validate_cert_warning is true.

Set to true to enable certificate validation. When true, provide connection_info.ca_cert if the storage system uses a self-signed certificate.

Note: Starting with major version 5.0, the default value will change to true. It is strongly recommended to enable certificate validation in production environments.

Choices:

  • false ← (default)

  • true

spec

dictionary / required

Parameters for filtering or identifying snapshots to gather facts about.

master_volume_id

string

ID of the master volume associated with the snapshot. Required for the Get Snapshots using master volume ID task.

master_volume_name

string

Name of the master volume associated with the snapshot.

snapshot_volume_id

string

ID of the snapshot volume. Required for the Get Snapshots using snapshot volume ID task.

snapshot_volume_name

string

Name of the snapshot volume. Required for the Get Snapshots using snapshot volume name task.

vps_id

string

The ID of the VPS.

vps_name

string

The name of the VPS.

Attributes

Attribute

Support

Description

check_mode

Support: full

Determines if the module should run in check mode.

Examples

- name: Gather all snapshots using master volume name
  hitachivantara.vspone_block.sds_block.hv_sds_block_snapshot_facts:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"
    spec:
      master_volume_name: "snPvol"

- name: Gather all snapshots using master volume name and snapshot volume name
  hitachivantara.vspone_block.sds_block.hv_sds_block_snapshot_facts:
    connection_info:
      address: storage1.company.com
      username: "admin"
      password: "secret"
    spec:
      master_volume_name: "volume1"
      snapshot_volume_name: "snapshot1"

Returned Facts

Facts returned by this module are added/updated in the hostvars host facts and can be referenced by name just like any other host fact. They do not need to be registered in order to use them.

Key

Description

snapshots_info

list / elements=dictionary

List of snapshot volume information retrieved from the storage system.

Returned: always

is_written_in_svol

boolean

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

upper_alert_time

integer

Current upper alert time setting.

Returned: success

upper_limit_for_iops

integer

Upper limit for IOPS.

Returned: success

upper_limit_for_transfer_rate

integer

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

Returned: success

snapshot_concordance_rate

integer

The concordance rate of the snapshot in percentage.

Returned: success

snapshot_progress_rate

integer

Progress rate of the snapshot operation in percentage.

Returned: success

snapshot_status

string

Current status of the snapshot.

Returned: success

snapshot_timestamp

string

Timestamp of the snapshot creation.

Returned: success

snapshot_type

string

Type of the snapshot.

Returned: success

snapshot_volume_id

string

Unique identifier of the snapshot volume.

Returned: success

snapshot_volume_name

string

Name of the snapshot volume.

Returned: success

snapshot_volume_nickname

string

Nickname of the snapshot volume.

Returned: success

status

string

Overall snapshot status.

Returned: success

status_summary

string

Summary of the snapshot status.

Returned: success

vps_id

string

VPS identifier associated with the snapshot.

Returned: success

vps_name

string

VPS name associated with the snapshot.

Returned: success

Authors

  • Hitachi Vantara LTD (@hitachi-vantara)