ansible.builtin.netapp_e_volume_copy (v2.3.3.0-1) — module

Create volume copy pairs

| "added in version" 2.2 of ansible.builtin"

Authors: Kevin Hulquest (@hulquest)

preview | supported by community

Install Ansible via pip

Install with pip install ansible==2.3.3.0.post1

Description

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

Inputs

    
state:
    choices:
    - present
    - absent
    description:
    - Whether the specified volume copy pair should exist or not.
    required: true

api_url:
    description:
    - The url to the SANtricity WebServices Proxy or embedded REST API, for example C(https://prod-1.wahoo.acme.com/devmgr/v2).
    required: true

api_password:
    description:
    - The password to authenticate with the SANtricity WebServices Proxy or embedded REST
      API.
    required: true

api_username:
    description:
    - The username to authenticate with the SANtricity WebServices Proxy or embedded REST
      API.
    required: true

validate_certs:
    default: true
    description:
    - Should https certificates be validated?
    required: false

start_stop_copy:
    description:
    - 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

search_volume_id:
    description:
    - 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:
    description:
    - The 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

volume_copy_pair_id:
    description:
    - The 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)

destination_volume_id:
    description:
    - The 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

create_copy_pair_if_does_not_exist:
    choices:
    - true
    - false
    default: true
    description:
    - 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.

Outputs

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