ibm.spectrum_virtualize.ibm_svc_manage_safeguarded_policy module – This module manages safeguarded 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_svc_manage_safeguarded_policy.

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.8.0

Synopsis

  • Ansible interface to manage ‘mksafeguardedpolicy’ and ‘rmsafeguardedpolicy’ safeguarded policy commands.

  • Safeguarded copy functionality is introduced in IBM Spectrum Virtualize 8.4.2.

Parameters

Parameter

Comments

backupinterval

string

Specifies the interval of backup.

Applies when state=present.

backupstarttime

string

Specifies the start time of backup in the format YYMMDDHHMM.

Applies when state=present.

backupunit

string

Specify 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 Spectrum Virtualize storage system.

domain

string

Domain for the Spectrum Virtualize storage system.

Valid when hostname is used for the parameter clustername.

log_path

string

Path of debug log file.

name

string

Specifies the name of safeguarded policy.

Not applicable when state=suspend or state=resume.

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.

retentiondays

string

Specifies the retention days for the backup.

Applies when state=present.

state

string / required

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

Resume (resume) or suspend (suspend) the safeguarded copy functionality system wide.

Choices:

  • "present"

  • "absent"

  • "suspend"

  • "resume"

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

Notes

Note

  • This module supports check_mode.

Examples

- name: Create safeguarded policy
  ibm.spectrum_virtualize.ibm_svc_manage_safeguarded_policy:
    clustername: "{{cluster}}"
    username: "{{username}}"
    password: "{{password}}"
    name: sgpolicy0
    backupunit: day
    backupinterval: 1
    backupstarttime: 2102281800
    retentiondays: 15
    state: present
- name: Suspend safeguarded copy functionality
  ibm.spectrum_virtualize.ibm_svc_manage_safeguarded_policy:
    clustername: "{{cluster}}"
    username: "{{username}}"
    password: "{{password}}"
    state: suspend
- name: Resume safeguarded copy functionality
  ibm.spectrum_virtualize.ibm_svc_manage_safeguarded_policy:
    clustername: "{{cluster}}"
    username: "{{username}}"
    password: "{{password}}"
    state: resume
- name: Delete safeguarded policy
  ibm.spectrum_virtualize.ibm_svc_manage_safeguarded_policy:
    clustername: "{{cluster}}"
    username: "{{username}}"
    password: "{{password}}"
    name: sgpolicy0
    state: absent

Authors

  • Sanjaikumaar M (@sanjaikumaar)