ibm.spectrum_virtualize.ibm_sv_manage_cloud_backups module – This module configures and manages cloud backups on IBM Spectrum Virtualize family storage systems

Note

This module is part of the ibm.spectrum_virtualize collection (version 2.0.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 ibm.spectrum_virtualize.

To use it in a playbook, specify: ibm.spectrum_virtualize.ibm_sv_manage_cloud_backups.

Note

The ibm.spectrum_virtualize collection has been renamed to ibm.storage_virtualize and will be removed from Ansible 12. The content of ibm.spectrum_virtualize will be replaced by redirects to ibm.storage_virtualize in Ansible 10. If you use content from ibm.spectrum_virtualize, please update FQCNs in your playbooks and roles! When creating new playbooks or roles, directly use content from ibm.storage_virtualize instead.

New in ibm.spectrum_virtualize 1.11.0

Synopsis

  • Ansible interface to manage backupvolume, backupvolumegroup, and rmvolumebackupgeneration commands.

Parameters

Parameter

Comments

all

boolean

Specifies to delete all cloud backup generations.

Applies when state=absent to delete a backup.

The parameters all and generation are mutually exclusive.

Either generation or all is required to delete cloud backup.

Choices:

  • false

  • true

clustername

string / required

The hostname or management IP of the Spectrum Virtualize storage system.

domain

string

Domain for the Spectrum Virtualize storage system.

Valid when hostname is used for the parameter clustername.

full

boolean

Specifies that the snapshot generation for the volume should be a full snapshot.

Applies when state=present.

Choices:

  • false

  • true

generation

integer

Specifies the snapshot generation ID that needs to be deleted for the volume.

If the specified generation is for a snapshot operation that is in progress, that snapshot operation is canceled.

Applies when state=absent to delete a generation of a volume backup.

The parameters all and generation are mutually exclusive.

Either generation or all is required to delete cloud backup.

log_path

string

Path of debug log file.

password

string

REST API password for the Spectrum Virtualize storage system.

The parameters username and password are required if not using token to authenticate a user.

state

string / required

Creates (present) or deletes (absent) a cloud backup.

Choices:

  • "present"

  • "absent"

token

string

The authentication token to verify a user on the Spectrum Virtualize storage system.

To generate a token, use the ibm.spectrum_virtualize.ibm_svc_auth module.

username

string

REST API username for the Spectrum Virtualize storage 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

volume_name

string

Specifies the volume name for the volume being backed up.

The parameters volume_name and volumegroup_name are mutually exclusive.

volume_UID

string

Specifies the volume UID to delete a cloud backup of the volume.

The value for a volume UID must be a value in the range 0-32.

The parameters volume_UID and volume_name are mutually exclusive.

Applies when state=absent to delete cloud backups.

volumegroup_name

string

Specifies the volumegroup name for the volume to back up.

The parameters volume_name and volumegroup_name are mutually exclusive.

Applies when state=present to create cloud backups of all the volume group members.

Cloud backup must be enabled on all the volume group members to execute this.

Notes

Note

  • This module supports check_mode.

Examples

- name: Create cloud backup of volume
  ibm.spectrum_virtualize.ibm_sv_manage_cloud_backups:
    clustername: "{{cluster}}"
    username: "{{username}}"
    password: "{{password}}"
    volume_name: vol1
    full: true
    state: present
- name: Create cloud backup of volumegroup
  ibm.spectrum_virtualize.ibm_sv_manage_cloud_backups:
    clustername: "{{cluster}}"
    username: "{{username}}"
    password: "{{password}}"
    volumegroup_name: VG1
    full: true
    state: present
- name: Delete cloud backup
  ibm.spectrum_virtualize.ibm_sv_manage_cloud_backups:
    clustername: "{{cluster}}"
    username: "{{username}}"
    password: "{{password}}"
    volume_UID: 6005076400B70038E00000000000001C
    all: true
    state: absent

Authors

  • Sanjaikumaar M (@sanjaikumaar)