netapp.cloudmanager.na_cloudmanager_snapmirror module – NetApp Cloud Manager SnapMirror
Note
This module is part of the netapp.cloudmanager collection (version 21.24.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 netapp.cloudmanager
.
To use it in a playbook, specify: netapp.cloudmanager.na_cloudmanager_snapmirror
.
New in netapp.cloudmanager 21.6.0
Synopsis
Create or Delete SnapMirror relationship on Cloud Manager.
Parameters
Parameter |
Comments |
---|---|
The volume capacity tier for tiering cold data to object storage. The default values for each cloud provider are as follows, Amazon ‘S3’, Azure ‘Blob’, GCP ‘cloudStorage’. If NONE, the capacity tier will not be set on volume creation. Choices:
|
|
The connector ID of the Cloud Manager Connector. |
|
The aggregate in which the volume will be created. If not provided, Cloud Manager chooses the best aggregate for you. |
|
The name of the destination SVM. The default SVM name is used, if a name is not provided. |
|
The name of the destination volume to be created for snapmirror relationship. |
|
The public ID of the working environment of the destination volume. |
|
The working environment name of the destination volume. |
|
The environment for NetApp Cloud Manager API operations. Choices:
|
|
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. |
|
Maximum transfer rate limit KB/s. Use 0 for no limit, otherwise use number between 1024 and 2,147,482,624. Default: |
|
The SnapMirror policy name. Default: |
|
The underlying cloud provider volume type. For AWS [‘gp3’, ‘gp2’, ‘io1’, ‘st1’, ‘sc1’]. For Azure [‘Premium_LRS’,’Standard_LRS’,’StandardSSD_LRS’]. For GCP [‘pd-balanced’,’pd-ssd’,’pd-standard’]. |
|
The refresh token for NetApp Cloud Manager API operations. |
|
The service account secret client ID for NetApp Cloud Manager API operations. |
|
The service account secret key for NetApp Cloud Manager API operations. |
|
The name of the Schedule. Default: |
|
The name of the source SVM. The default SVM name is used, if a name is not provided. |
|
The name of the source volume. |
|
The public ID of the working environment of the source volume. |
|
The working environment name of the source volume. |
|
Whether the specified snapmirror relationship should exist or not. Choices:
|
|
The NetApp account ID that the Connector will be associated with. To be used only when using FSx. |
Notes
Note
Support check_mode.
The modules prefixed with na_cloudmanager are built to manage CloudManager and CVO deployments in AWS/GCP/Azure clouds.
If sa_client_id and sa_secret_key are provided, service account will be used in operations. refresh_token will be ignored.
Examples
- name: Create snapmirror with working_environment_name
netapp.cloudmanager.na_cloudmanager_snapmirror:
state: present
source_working_environment_name: source
destination_working_environment_name: dest
source_volume_name: source
destination_volume_name: source_copy
policy: MirrorAllSnapshots
schedule: 5min
max_transfer_rate: 102400
client_id: client_id
refresh_token: refresh_token
- name: Delete snapmirror
netapp.cloudmanager.na_cloudmanager_snapmirror:
state: absent
source_working_environment_name: source
destination_working_environment_name: dest
source_volume_name: source
destination_volume_name: source_copy
client_id: client_id
refresh_token: refresh_token