ibm.spectrum_virtualize.ibm_sv_manage_snapshotpolicy module – This module manages snapshot policy configuration 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_snapshotpolicy
.
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.9.0
Synopsis
Ansible interface to manage ‘mksnapshotpolicy’ and ‘rmsnapshotpolicy’ snapshot policy commands.
Snapshot policy is introduced in IBM Spectrum Virtualize 8.5.1.0.
Parameters
Parameter |
Comments |
---|---|
Specifies the backup interval. Applies when state=present. |
|
Specifies the start time of backup in the format YYMMDDHHMM. Applies when state=present. |
|
Specifies the backup unit in mentioned metric. Applies when state=present. Choices:
|
|
The hostname or management IP of the Spectrum Virtualize storage system. |
|
Domain for the Spectrum Virtualize storage system. Valid when hostname is used for the parameter clustername. |
|
Path of debug log file. |
|
Specifies a unique name of the snapshot policy. Not applicable when state=suspend or state=resume. |
|
REST API password for the Spectrum Virtualize storage system. The parameters username and password are required if not using token to authenticate a user. |
|
Specify to remove the volume group association from the snapshot policy. Applies when state=absent. This option is allowed only for SecurityAdmin users. Choices:
|
|
Specifies the retention days for the backup. Applies when state=present. |
|
Creates ( Resume ( Choices:
|
|
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. |
|
REST API username for the Spectrum Virtualize storage system. The parameters username and password are required if not using token to authenticate a user. |
|
Validates certification. Choices:
|
Notes
Note
This module supports
check_mode
.
Examples
- name: Create snapshot policy
ibm.spectrum_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.spectrum_virtualize.ibm_sv_manage_snapshotpolicy:
clustername: "{{cluster}}"
username: "{{username}}"
password: "{{password}}"
state: suspend
- name: Resume snapshot policy functionality
ibm.spectrum_virtualize.ibm_sv_manage_snapshotpolicy:
clustername: "{{cluster}}"
username: "{{username}}"
password: "{{password}}"
state: resume
- name: Delete snapshot policy
ibm.spectrum_virtualize.ibm_sv_manage_snapshotpolicy:
clustername: "{{cluster}}"
username: "{{username}}"
password: "{{password}}"
name: policy0
state: absent