Docs4dev
Docs
ansible / 2.6 / modules / na_ontap_snapshot_module.html

na_ontap_snapshot - Manage NetApp Sanpshots

New in version 2.6.

Synopsis

  • Create/Modify/Delete Ontap snapshots

Requirements

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

  • A physical or virtual clustered Data ONTAP system. The modules were developed with Clustered Data ONTAP 9.3
  • Ansible 2.6
  • netapp-lib (2017.10.30). 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
async_bool
bool
    Choices:
  • no
  • yes
If true, the snapshot is to be created asynchronously.
comment
A human readable comment attached with the snapshot. The size of the comment can be at most 255 characters.
hostname
required
The hostname or IP address of the ONTAP instance.
https
bool
    Choices:
  • no ←
  • yes
Enable and disabled https
ignore_owners
bool
    Choices:
  • no
  • yes
if this field is true, snapshot will be deleted even if some other processes are accessing it.
new_comment
A human readable comment attached with the snapshot. The size of the comment can be at most 255 characters. This will replace the existing comment
password
required
Password for the specified user.

aliases: pass
snapmirror_label
A human readable SnapMirror Label attached with the snapshot. Size of the label can be at most 31 characters.
snapshot
required
Name of the snapshot to be managed. The maximum string length is 256 characters.
snapshot_instance_uuid
The 128 bit unique snapshot identifier expressed in the form of UUID.
state
    Choices:
  • present ←
  • absent
If you want to create/modify a snapshot, or delete it.
username
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://goo.gl/BRu78Z.

aliases: user
volume
required
Name of the volume on which the snapshot is to be created.
vserver
The Vserver name

Notes

Note

  • The modules prefixed with na_ontap are built to support the ONTAP storage platform.

Examples

- name: create SnapShot
  tags:
    - create
  na_ontap_snapshot:
    state=present
    snapshot={{ snapshot name }}
    volume={{ vol name }}
    comment="i am a comment"
    vserver={{ vserver name }}
    username={{ netapp username }}
    password={{ netapp password }}
    hostname={{ netapp hostname }}
- name: delete SnapShot
  tags:
    - delete
  na_ontap_snapshot:
    state=absent
    snapshot={{ snapshot name }}
    volume={{ vol name }}
    vserver={{ vserver name }}
    username={{ netapp username }}
    password={{ netapp password }}
    hostname={{ netapp hostname }}
- name: modify SnapShot
  tags:
    - modify
  na_ontap_snapshot:
    state=present
    snapshot={{ snapshot name }}
    new_comment="New comments are great"
    volume={{ vol name }}
    vserver={{ vserver name }}
    username={{ netapp username }}
    password={{ netapp password }}
    hostname={{ netapp hostname }}

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Maintenance

This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.

For a list of other modules that are also maintained by the Ansible Community, see here.

Author

Hint

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

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.6/modules/na_ontap_snapshot_module.html