/ home / ibm / ibm.storage_virtualize / 2.3.1 / module / ibm_sv_restore_cloud_backup

ibm.storage_virtualize.ibm_sv_restore_cloud_backup (2.3.1) — module

This module restores the cloud backup on IBM Storage Virtualize family systems

| "added in version" 1.11.0 of ibm.storage_virtualize"

Authors: Sanjaikumaar M (@sanjaikumaar)

Install collection

Install with ansible-galaxy collection install ibm.storage_virtualize:==2.3.1

Add to requirements.yml

  collections:
    - name: ibm.storage_virtualize
      version: 2.3.1

Description

Ansible interface to manage restorevolume command.

Usage examples

Scanned by Steampunk Spotter

- name: Restore cloud backup
  ibm.storage_virtualize.ibm_sv_restore_cloud_backup:
    clustername: "{{cluster_A}}"
    username: "{{username_A}}"
    password: "{{password_A}}"
    target_volume_name: vol1
    source_volume_uid: 6005076400B70038E00000000000001C
    generation: 1

Scanned by Steampunk Spotter

- name: Restore cloud backup to different cluster
  ibm.storage_virtualize.ibm_sv_restore_cloud_backup:
    clustername: "{{cluster_B}}"
    username: "{{username_B}}"
    password: "{{password_B}}"
    target_volume_name: vol2
    source_volume_uid: 6005076400B70038E00000000000001C
    generation: 1

Scanned by Steampunk Spotter

- name: Cancel restore operation
  ibm.storage_virtualize.ibm_sv_restore_cloud_backup:
    clustername: "{{cluster_A}}"
    username: "{{username_A}}"
    password: "{{password_A}}"
    target_volume_name: vol1
    cancel: true

Inputs

    
token:
    description:
    - The authentication token to verify a user on the Storage Virtualize system.
    - To generate a token, use the M(ibm.storage_virtualize.ibm_svc_auth) module.
    type: str

cancel:
    description:
    - Specifies to cancel the restore operation.
    type: bool

domain:
    description:
    - Domain for the Storage Virtualize system.
    - Valid when hostname is used for the parameter I(clustername).
    type: str

log_path:
    description:
    - Path of debug log file.
    type: str

password:
    description:
    - REST API password for the Storage Virtualize system.
    - The parameters I(username) and I(password) are required if not using I(token) to
      authenticate a user.
    type: str

username:
    description:
    - REST API username for the Storage Virtualize system.
    - The parameters I(username) and I(password) are required if not using I(token) to
      authenticate a user.
    type: str

generation:
    description:
    - Specifies the snapshot generation to restore. The value must be a number.
    type: int

restoreuid:
    description:
    - Specifies the UID of the restored volume should be set to the UID of the volume
      snapshot that is being restored.
    - This parameter can be used only with I(source_volume_uid).
    - The I(restoreuid) parameter is not supported if cloud account is in import mode.
    type: bool

clustername:
    description:
    - The hostname or management IP of the Storage Virtualize system.
    required: true
    type: str

validate_certs:
    default: false
    description:
    - Validates certification.
    type: bool

source_volume_uid:
    description:
    - Specifies the volume snapshot to restore (specified by volume UID).
    - This parameter is required to restore a backup from a different volume.
    - Specified UID must be different from the UID of the volume being restored.
    type: str

target_volume_name:
    description:
    - Specifies the volume name to restore onto.
    required: true
    type: str

deletelatergenerations:
    description:
    - Specifies that all backup generations should be deleted after the generation is
      restored.
    type: bool