ibm.storage_virtualize.ibm_sv_manage_snapshotpolicy module – This module manages snapshot policy configuration on IBM Storage Virtualize family systems

Note

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

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

New in ibm.storage_virtualize 1.9.0

Synopsis

  • Ansible interface to manage ‘mksnapshotpolicy’ and ‘rmsnapshotpolicy’ snapshot policy commands.

  • Snapshot policy is introduced in IBM Storage Virtualize 8.5.1.0.

Parameters

Parameter

Comments

backupinterval

string

Specifies the backup interval.

Applies when state=present.

backupstarttime

string

Specifies the start time of backup in the format YYMMDDHHMM.

Applies when state=present.

backupunit

string

Specifies the backup unit in mentioned metric.

Applies when state=present.

Choices:

  • "minute"

  • "hour"

  • "day"

  • "week"

  • "month"

clustername

string / required

The hostname or management IP of the Storage Virtualize system.

domain

string

Domain for the Storage Virtualize system.

Valid when hostname is used for the parameter clustername.

log_path

string

Path of debug log file.

name

string

Specifies a unique name of the snapshot policy.

Not applicable when state=suspend or state=resume.

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.

removefromvolumegroups

boolean

Specify to remove the volume group association from the snapshot policy.

Applies when state=absent.

This option is allowed only for SecurityAdmin users.

Choices:

  • false

  • true

retentiondays

string

Specifies the retention days for the backup.

Applies when state=present.

state

string / required

Creates (present) or deletes (absent) a snapshot policy.

Resume (resume) or suspend (suspend) the snapshot policy, system-wide.

Choices:

  • "present"

  • "absent"

  • "suspend"

  • "resume"

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: 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
- name: Suspend snapshot policy functionality
  ibm.storage_virtualize.ibm_sv_manage_snapshotpolicy:
    clustername: "{{ cluster }}"
    username: "{{ username }}"
    password: "{{ password }}"
    state: suspend
- name: Resume snapshot policy functionality
  ibm.storage_virtualize.ibm_sv_manage_snapshotpolicy:
    clustername: "{{ cluster }}"
    username: "{{ username }}"
    password: "{{ password }}"
    state: resume
- name: Delete snapshot policy
  ibm.storage_virtualize.ibm_sv_manage_snapshotpolicy:
    clustername: "{{ cluster }}"
    username: "{{ username }}"
    password: "{{ password }}"
    name: policy0
    state: absent

Authors

  • Shilpi Jain(@Shilpi-J)