ansible / ansible.builtin / v2.9.26 / module / na_ontap_snapshot NetApp ONTAP manage Snapshots | "added in version" 2.6 of ansible.builtin" Authors: NetApp Ansible Team (@carchi8py) <ng-ansibleteam@netapp.com> preview | supported by communityansible.builtin.na_ontap_snapshot (v2.9.26) — module
pip
Install with pip install ansible==2.9.26
Create/Modify/Delete ONTAP snapshots
- 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 }}" comment: "New comments are great" volume: "{{ vol name }}" vserver: "{{ vserver name }}" username: "{{ netapp username }}" password: "{{ netapp password }}" hostname: "{{ netapp hostname }}"
https: default: false description: - Enable and disable https. - Ignored when using REST as only https is supported. - Ignored when using SSL certificate authentication as it requires SSL. type: bool state: choices: - present - absent default: present description: - If you want to create/modify a snapshot, or delete it. ontapi: description: - The ontap api version to use type: int volume: description: - Name of the volume on which the snapshot is to be created. required: true comment: description: A human readable comment attached with the snapshot. The size of the comment can be at most 255 characters. vserver: description: - The Vserver name required: true hostname: description: - The hostname or IP address of the ONTAP instance. required: true type: str password: aliases: - pass description: - Password for the specified user. type: str snapshot: description: Name of the snapshot to be managed. The maximum string length is 256 characters. required: true use_rest: choices: - Never - Always - Auto default: Auto description: - REST API if supported by the target system for all the resources and attributes the module requires. Otherwise will revert to ZAPI. - Always -- will always use the REST API - Never -- will always use the ZAPI - Auto -- will try to use the REST Api type: str username: aliases: - user description: - 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 U(https://mysupport.netapp.com/NOW/download/software/nmsdk/9.4/). - Two authentication methods are supported - 1. basic authentication, using username and password, - 2. SSL certificate authentication, using a ssl client cert file, and optionally a private key file. - To use a certificate, the certificate must have been installed in the ONTAP cluster, and cert authentication must have been enabled. type: str from_name: description: - Name of the existing snapshot to be renamed to. version_added: '2.8' version_added_collection: ansible.builtin http_port: description: - Override the default port (80 or 443) with this port type: int async_bool: description: - If true, the snapshot is to be created asynchronously. type: bool key_filepath: description: - path to SSL client key file. type: str version_added: 20.6.0 version_added_collection: netapp.ontap cert_filepath: description: - path to SSL client cert file (.pem). - not supported with python 2.6. type: str version_added: 20.6.0 version_added_collection: netapp.ontap feature_flags: description: - Enable or disable a new feature. - This can be used to enable an experimental feature or disable a new feature that breaks backward compatibility. - Supported keys and values are subject to change without notice. Unknown keys are ignored. type: dict version_added: 20.5.0 version_added_collection: netapp.ontap ignore_owners: description: - if this field is true, snapshot will be deleted even if some other processes are accessing it. type: bool validate_certs: default: true description: - If set to C(no), the SSL certificates will not be validated. - This should only set to C(False) used on personally controlled sites using self-signed certificates. type: bool snapmirror_label: description: A human readable SnapMirror Label attached with the snapshot. Size of the label can be at most 31 characters. snapshot_instance_uuid: description: - The 128 bit unique snapshot identifier expressed in the form of UUID.