New in version 2.2.
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 |
|
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 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 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 | ||
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 |
|
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 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) |
--- msg: description: Success message returned: success type: string sample: Json facts for the volume copy that was created.
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 |
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
This module is community maintained without core committer oversight.
For more information on what this means please read Module Support
For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Helping Testing PRs and Developing Modules.