You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

netapp_e_volume_copy - Create volume copy pairs¶

New in version 2.2.

Synopsis
Options
Examples
Return Values
- Status

Synopsis ¶

Create and delete snapshots images on volume groups for NetApp E-series storage arrays.

Options ¶

parameter	required	default	choices	comments
api_password	yes			The password to authenticate with the SANtricity WebServices Proxy or embedded REST API.
api_url	yes			The url to the SANtricity WebServices Proxy or embedded REST API, for example `https://prod-1.wahoo.acme.com/devmgr/v2`.
api_username	yes			The username to authenticate with the SANtricity WebServices Proxy or embedded REST API.
create_copy_pair_if_does_not_exist	no	True	True False	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	no			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
search_volume_id	no			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	no			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	yes			The ID of the array to manage. This value must be unique for each array.
start_stop_copy	no			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	yes		present absent	Whether the specified volume copy pair should exist or not.
validate_certs	no	True		Should https certificates be validated?
volume_copy_pair_id	no			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)

Examples ¶

---
msg:
    description: Success message
    returned: success
    type: string
    sample: Json facts for the volume copy that was created.

Return Values ¶

Common return values are documented here Return Values, the following are the fields unique to this module:

name	description	returned	type	sample
msg	Success message	success	string	Created Volume Copy Pair with ID

Status ¶

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

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.