ibm.storage_virtualize.ibm_sv_manage_cloud_backups (2.3.1) — module

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 backupvolume, backupvolumegroup, and rmvolumebackupgeneration commands.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Create cloud backup of volume
  ibm.storage_virtualize.ibm_sv_manage_cloud_backups:
    clustername: "{{cluster}}"
    username: "{{username}}"
    password: "{{password}}"
    volume_name: vol1
    full: true
    state: present

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Create cloud backup of volumegroup
  ibm.storage_virtualize.ibm_sv_manage_cloud_backups:
    clustername: "{{cluster}}"
    username: "{{username}}"
    password: "{{password}}"
    volumegroup_name: VG1
    full: true
    state: present

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Delete cloud backup
  ibm.storage_virtualize.ibm_sv_manage_cloud_backups:
    clustername: "{{cluster}}"
    username: "{{username}}"
    password: "{{password}}"
    volume_UID: 6005076400B70038E00000000000001C
    all: true
    state: absent

Inputs

    
all:
    description:
    - Specifies to delete all cloud backup generations.
    - Applies when I(state=absent) to delete a backup.
    - The parameters I(all) and I(generation) are mutually exclusive.
    - Either I(generation) or I(all) is required to delete cloud backup.
    type: bool

full:
    description:
    - Specifies that the snapshot generation for the volume should be a full snapshot.
    - Applies when I(state=present).
    type: bool

state:
    choices:
    - present
    - absent
    description:
    - Creates (C(present)) or deletes (C(absent)) a cloud backup.
    required: true
    type: str

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

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 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 I(state=absent) to delete a generation of a volume backup.
    - The parameters I(all) and I(generation) are mutually exclusive.
    - Either I(generation) or I(all) is required to delete cloud backup.
    type: int

volume_UID:
    description:
    - 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 I(volume_UID) and I(volume_name) are mutually exclusive.
    - Applies when I(state=absent) to delete cloud backups.
    type: str

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

volume_name:
    description:
    - Specifies the volume name for the volume being backed up.
    - The parameters I(volume_name) and I(volumegroup_name) are mutually exclusive.
    type: str

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

volumegroup_name:
    description:
    - Specifies the volumegroup name for the volume to back up.
    - The parameters I(volume_name) and I(volumegroup_name) are mutually exclusive.
    - Applies when I(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.
    type: str