na_ontap_cg_snapshot – NetApp ONTAP manage consistency group snapshot

New in version 2.7.

Synopsis

  • Create consistency group snapshot for ONTAP volumes.

Requirements

The below requirements are needed on the host that executes this module.

  • A physical or virtual clustered Data ONTAP system. The modules support Data ONTAP 9.1 and onward

  • Ansible 2.6

  • Python2 netapp-lib (2017.10.30) or later. Install using ‘pip install netapp-lib’

  • Python3 netapp-lib (2018.11.13) or later. Install using ‘pip install netapp-lib’

  • To enable http on the cluster you must run the following commands ‘set -privilege advanced;’ ‘system services web modify -http-enabled true;’

Parameters

Parameter Choices/Defaults Comments
hostname
string / required
The hostname or IP address of the ONTAP instance.
http_port
integer
Override the default port (80 or 443) with this port
https
boolean
    Choices:
  • no ←
  • yes
Enable and disable https
ontapi
integer
The ontap api version to use
password
string / required
Password for the specified user.

aliases: pass
snapmirror_label
-
A human readable SnapMirror label to be attached with the consistency group snapshot copies.
snapshot
- / required
The provided name of the snapshot that is created in each volume.
state
-
Default:
"present"
If you want to create a snapshot.
timeout
-
    Choices:
  • urgent
  • medium ←
  • relaxed
Timeout selector.
username
string / required
This can be a Cluster-scoped or SVM-scoped account, depending on whether a Cluster-level or SVM-level API is required. For more information, please read the documentation https://mysupport.netapp.com/NOW/download/software/nmsdk/9.4/.

aliases: user
validate_certs
boolean
    Choices:
  • no
  • yes ←
If set to no, the SSL certificates will not be validated.
This should only set to False used on personally controlled sites using self-signed certificates.
volumes
- / required
A list of volumes in this filer that is part of this CG operation.
vserver
- / required
Name of the vserver.

Notes

Note

  • The modules prefixed with na\_ontap are built to support the ONTAP storage platform.

Examples

- name:
  na_ontap_cg_snapshot:
    state: present
    vserver: vserver_name
    snapshot: snapshot name
    volumes: vol_name
    username: "{{ netapp username }}"
    password: "{{ netapp password }}"
    hostname: "{{ netapp hostname }}"

Status

Authors

Hint

If you notice any issues in this documentation you can edit this document to improve it.