W3cubDocs

/Ansible

ibm.storage_virtualize.ibm_sv_restore_cloud_backup module – This module restores the cloud backup on IBM Storage Virtualize family systems

Note

This module is part of the ibm.storage_virtualize collection (version 2.7.4).

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 ibm.storage_virtualize.

To use it in a playbook, specify: ibm.storage_virtualize.ibm_sv_restore_cloud_backup.

New in ibm.storage_virtualize 1.11.0

Synopsis
Parameters
Notes
Examples

Synopsis

Ansible interface to manage restorevolume command.

Parameters

Parameter	Comments
cancel boolean	Specifies to cancel the restore operation. Choices: `false` `true`
clustername string / required	The hostname or management IP of the Storage Virtualize system.
deletelatergenerations boolean	Specifies that all backup generations should be deleted after the generation is restored. Choices: `false` `true`
domain string	Domain for the Storage Virtualize system. Valid when hostname is used for the parameter clustername.
generation integer	Specifies the snapshot generation to restore. The value must be a number.
log_path string	Path of debug log file.
password string	REST API password for the Storage Virtualize system. The parameters username and password are required if not using token to authenticate a user.
restoreuid boolean	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 source_volume_uid. The restoreuid parameter is not supported if cloud account is in import mode. Choices: `false` `true`
source_volume_uid string	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.
target_volume_name string / required	Specifies the volume name to restore onto.
token string	The authentication token to verify a user on the Storage Virtualize system. To generate a token, use the ibm.storage_virtualize.ibm_svc_auth module.
username string	REST API username for the Storage Virtualize system. The parameters username and password are required if not using token to authenticate a user.
validate_certs boolean	Validates certification. Choices: `false` ← (default) `true`

Notes

Note

This module supports check_mode.

Examples

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

Authors

Sanjaikumaar M (@sanjaikumaar)

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/ibm/storage_virtualize/ibm_sv_restore_cloud_backup_module.html