netapp_e_volume_copy – NetApp E-Series create volume copy pairs

From Get docs
Ansible/docs/2.8/modules/netapp e volume copy module


netapp_e_volume_copy – NetApp E-Series create volume copy pairs

New in version 2.2.


Synopsis

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

Parameters

Parameter Choices/Defaults Comments

api_password

- / required

The password to authenticate with the SANtricity WebServices Proxy or embedded REST API.

api_url

- / required

The url to the SANtricity WebServices Proxy or embedded REST API, for example https://prod-1.wahoo.acme.com/devmgr/v2.

api_username

- / required

The username to authenticate with the SANtricity WebServices Proxy or embedded REST API.

create_copy_pair_if_does_not_exist

boolean

  • no
  • yes

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

-

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

-

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

-

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

-

Default:

1

The ID of the array to manage. This value must be unique for each array.

start_stop_copy

-

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

- / required

  • present
  • absent

Whether the specified volume copy pair should exist or not.

validate_certs

boolean

  • no
  • yes

Should https certificates be validated?

volume_copy_pair_id

-

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.
  • 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




Status

Authors

  • Kevin Hulquest (@hulquest)

Hint

If you notice any issues in this documentation you can edit this document to improve it.


© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/netapp_e_volume_copy_module.html