netapp_eseries.santricity.netapp_e_volume_copy – NetApp E-Series create volume copy pairs
Note
This plugin is part of the netapp_eseries.santricity collection (version 1.2.13).
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_eseries.santricity.
To use it in a playbook, specify: netapp_eseries.santricity.netapp_e_volume_copy.
New in version 2.2: of netapp_eseries.santricity
Synopsis
- Create and delete snapshots images on volume groups for NetApp E-series storage arrays.
Parameters
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| api_password
string / required
|
The password to authenticate with the SANtricity WebServices Proxy or embedded REST API.
|
|
| api_url
string / required
|
The url to the SANtricity WebServices Proxy or embedded REST API, for example https://prod-1.wahoo.acme.com/devmgr/v2.
|
|
| api_username
string / required
|
The username to authenticate with the SANtricity WebServices Proxy or embedded REST API.
|
|
| copy_priority
integer
|
Default:
0
|
Copy priority level
|
| create_copy_pair_if_does_not_exist
boolean
|
|
Defines if a copy pair will be created if it does not exist.
If set to True destination_volume_id and source_volume_id are required.
|
| destination_volume_id
string
|
The id of the volume copy destination.
If used, must be paired with source_volume_id
Mutually exclusive with volume_copy_pair_id, and search_volume_id
|
|
| onlineCopy
boolean
|
|
Whether copy should be online
|
| search_volume_id
string
|
Searches for all valid potential target and source volumes that could be used in a copy_pair
Mutually exclusive with volume_copy_pair_id, destination_volume_id and source_volume_id
|
|
| source_volume_id
string
|
The id of the volume copy source.
If used, must be paired with destination_volume_id
Mutually exclusive with volume_copy_pair_id, and search_volume_id
|
|
| ssid
string
|
Default:
"1"
|
Storage system identifier
|
| start_stop_copy
string
|
|
starts a re-copy or stops a copy in progress
Note: If you stop the initial file copy before it it done the copy pair will be destroyed
Requires volume_copy_pair_id
|
| state
string / required
|
|
Whether the specified volume copy pair should exist or not.
|
| targetWriteProtected
boolean
|
|
Whether target should be write protected
|
| validate_certs
boolean
|
|
Should https certificates be validated?
|
| volume_copy_pair_id
string
|
The id of a given volume copy pair
Mutually exclusive with destination_volume_id, source_volume_id, and search_volume_id
Can use to delete or check presence of volume pairs
Must specify this or (destination_volume_id and source_volume_id)
|
Notes
Note
- The E-Series Ansible modules require either an instance of the Web Services Proxy (WSP), to be available to manage the storage-system, or an E-Series storage-system that supports the Embedded Web Services API.
- Embedded Web Services is currently available on the E2800, E5700, EF570, and newer hardware models.
- M(netapp_e_storage_system) may be utilized for configuring the systems managed by a WSP instance.
Examples
---
msg:
description: Success message
returned: success
type: str
sample: Json facts for the volume copy that was created.
Return Values
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
| msg
string
|
success |
Success message
Sample:
Created Volume Copy Pair with ID
|
Authors
- Kevin Hulquest (@hulquest)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/netapp_eseries/santricity/netapp_e_volume_copy_module.html