ibm.storage_virtualize.ibm_sv_manage_snapshotpolicy (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 'mksnapshotpolicy' and 'rmsnapshotpolicy' snapshot policy commands.

Snapshot policy is introduced in IBM Storage Virtualize 8.5.1.0.

Usage examples

Scanned by Steampunk Spotter

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

- name: Create snapshot policy
  ibm.storage_virtualize.ibm_sv_manage_snapshotpolicy:
    clustername: "{{cluster}}"
    username: "{{username}}"
    password: "{{password}}"
    name: policy0
    backupunit: day
    backupinterval: 1
    backupstarttime: 2102281800
    retentiondays: 15
    state: present

Scanned by Steampunk Spotter

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

- name: Suspend snapshot policy functionality
  ibm.storage_virtualize.ibm_sv_manage_snapshotpolicy:
    clustername: "{{cluster}}"
    username: "{{username}}"
    password: "{{password}}"
    state: suspend

Scanned by Steampunk Spotter

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

- name: Resume snapshot policy functionality
  ibm.storage_virtualize.ibm_sv_manage_snapshotpolicy:
    clustername: "{{cluster}}"
    username: "{{username}}"
    password: "{{password}}"
    state: resume

Scanned by Steampunk Spotter

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

- name: Delete snapshot policy
  ibm.storage_virtualize.ibm_sv_manage_snapshotpolicy:
    clustername: "{{cluster}}"
    username: "{{username}}"
    password: "{{password}}"
    name: policy0
    state: absent

Inputs

    
name:
    description:
    - Specifies a unique name of the snapshot policy.
    - Not applicable when I(state=suspend) or I(state=resume).
    type: str

state:
    choices:
    - present
    - absent
    - suspend
    - resume
    description:
    - Creates (C(present)) or deletes (C(absent)) a snapshot policy.
    - Resume (C(resume)) or suspend (C(suspend)) the snapshot policy, system-wide.
    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

backupunit:
    choices:
    - minute
    - hour
    - day
    - week
    - month
    description:
    - Specifies the backup unit in mentioned metric.
    - Applies when I(state=present).
    type: str

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

retentiondays:
    description:
    - Specifies the retention days for the backup.
    - Applies when I(state=present).
    type: str

backupinterval:
    description:
    - Specifies the backup interval.
    - Applies when I(state=present).
    type: str

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

backupstarttime:
    description:
    - Specifies the start time of backup in the format YYMMDDHHMM.
    - Applies when I(state=present).
    type: str

removefromvolumegroups:
    description:
    - Specify to remove the volume group association from the snapshot policy.
    - Applies when I(state=absent).
    - This option is allowed only for SecurityAdmin users.
    type: bool