W3cubDocs

/Ansible

netapp_e_amg_sync - Conduct synchronization actions on asynchronous member groups.

New in version 2.2.

Synopsis

Allows for the initialization, suspension and resumption of an asynchronous mirror group’s synchronization 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.
api_username
yes
The username to authenticate with the SANtricity WebServices Proxy or embedded REST API.
delete_recovery_point
no
  • True
  • False
Indicates whether the failures point can be deleted on the secondary if necessary to achieve the synchronization.
If true, and if the amount of unsynchronized data exceeds the CoW repository capacity on the secondary for any member volume, the last failures point will be deleted and synchronization will continue.
If false, the synchronization will be suspended if the amount of unsynchronized data exceeds the CoW Repository capacity on the secondary and the failures point will be preserved.
NOTE: This only has impact for newly launched syncs.
name
yes
The name of the async mirror group you wish to target
ssid
no
The ID of the storage array containing the AMG you wish to target
state
yes
  • running
  • suspended
The synchronization action you'd like to take.
If running then it will begin syncing if there is no active sync or will resume a suspended sync. If there is already a sync in progress, it will return with an OK status.
If suspended it will suspend any ongoing sync action, but return OK if there is no active sync or if the sync is already suspended
validate_certs
no True
Should https certificates be validated?

Examples

- name: start AMG async
  netapp_e_amg_sync:
    name: "{{ amg_sync_name }}"
    state: running
    ssid: "{{ ssid }}"
    api_url: "{{ netapp_api_url }}"
    api_username: "{{ netapp_api_username }}"
    api_password: "{{ netapp_api_password }}"

Return Values

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

name description returned type sample
json The object attributes of the AMG. success string

This is an Extras Module

For more information on what this means please read Extras Modules

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

© 2012–2016 Michael DeHaan
© 2016 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/netapp_e_amg_sync_module.html