On this page
netapp.aws.aws_netapp_cvs_snapshots – NetApp AWS Cloud Volumes Service Manage Snapshots.
Note
This plugin is part of the netapp.aws collection (version 20.9.0).
To install it use: ansible-galaxy collection install netapp.aws
.
To use it in a playbook, specify: netapp.aws.aws_netapp_cvs_snapshots
.
New in version 2.9.0: of netapp.aws
Synopsis
- Create, Update, Delete Snapshot on AWS Cloud Volumes Service.
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
api_key
string / required
|
The access key to authenticate with the AWSCVS Web Services Proxy or Embedded Web Services API.
|
|
api_url
string / required
|
The url to the AWSCVS Web Services Proxy or Embedded Web Services API.
|
|
fileSystemId
string
|
Name or Id of the filesystem.
Required for create operation
|
|
from_name
string
|
ID or Name of the snapshot to rename.
Required to create an snapshot called 'name' by renaming 'from_name'.
|
|
name
string / required
|
Name of the snapshot
|
|
region
string / required
|
The region to which the snapshot belongs to.
|
|
secret_key
string / required
|
The secret_key to authenticate with the AWSCVS Web Services Proxy or Embedded Web Services API.
|
|
state
string / required
|
|
Whether the specified snapshot should exist or not.
|
validate_certs
boolean
|
|
Should https certificates be validated?
|
Notes
Note
- The modules prefixed with aws_cvs_netapp are built to Manage AWS Cloud Volumes Service .
Examples
- name: Create Snapshot
aws_netapp_cvs_snapshots:
state: present
region: us-east-1
name: testSnapshot
fileSystemId: testVolume
api_url : cds-aws-bundles.netapp.com
api_key: myApiKey
secret_key : mySecretKey
- name: Update Snapshot
aws_netapp_cvs_snapshots:
state: present
region: us-east-1
name: testSnapshot - renamed
from_name: testSnapshot
fileSystemId: testVolume
api_url : cds-aws-bundles.netapp.com
api_key: myApiKey
secret_key : mySecretKey
- name: Delete Snapshot
aws_netapp_cvs_snapshots:
state: absent
region: us-east-1
name: testSnapshot
api_url : cds-aws-bundles.netapp.com
api_key: myApiKey
secret_key : mySecretKey
Authors
- NetApp Ansible Team (@carchi8py) <ng-ansibleteam@netapp.com>
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/netapp/aws/aws_netapp_cvs_snapshots_module.html