netapp_eseries.santricity.netapp_e_amg_sync – NetApp E-Series conduct synchronization actions on asynchronous mirror groups.

Note

This plugin is part of the netapp_eseries.santricity collection (version 1.1.0).

To install it use: ansible-galaxy collection install netapp_eseries.santricity.

To use it in a playbook, specify: netapp_eseries.santricity.netapp_e_amg_sync.

New in version 2.2: of netapp_eseries.santricity

Synopsis
Parameters
Examples
Return Values

Synopsis

Allows for the initialization, suspension and resumption of an asynchronous mirror group’s synchronization for NetApp E-series storage arrays.

Parameters

Parameter	Choices/Defaults	Comments
api_password string / required		The password to authenticate with the SANtricity WebServices Proxy or embedded REST API.
api_url string / required		The url to the SANtricity WebServices Proxy or embedded REST API.
api_username string / required		The username to authenticate with the SANtricity WebServices Proxy or embedded REST API.
delete_recovery_point boolean	no ← yes	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 string / required		The name of the async mirror group you wish to target
ssid string		The ID of the storage array containing the AMG you wish to target
state string / required	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 boolean	no yes ←	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, the following are the fields unique to this module:

Key	Returned	Description
json string	success	The object attributes of the AMG. Sample: {'changed': False, 'connectionType': 'fc', 'groupRef': '3700000060080E5000299C24000006EF57ACAC70', 'groupState': 'optimal', 'id': '3700000060080E5000299C24000006EF57ACAC70', 'label': 'made_with_ansible', 'localRole': 'primary', 'mirrorChannelRemoteTarget': '9000000060080E5000299C24005B06E557AC7EEC', 'orphanGroup': False, 'recoveryPointAgeAlertThresholdMinutes': 20, 'remoteRole': 'secondary', 'remoteTarget': {'nodeName': {'ioInterfaceType': 'fc', 'iscsiNodeName': None, 'remoteNodeWWN': '20040080E5299F1C'}, 'remoteRef': '9000000060080E5000299C24005B06E557AC7EEC', 'scsiinitiatorTargetBaseProperties': {'ioInterfaceType': 'fc', 'iscsiinitiatorTargetBaseParameters': None}}, 'remoteTargetId': 'ansible2', 'remoteTargetName': 'Ansible2', 'remoteTargetWwn': '60080E5000299F880000000056A25D56', 'repositoryUtilizationWarnThreshold': 80, 'roleChangeProgress': 'none', 'syncActivity': 'idle', 'syncCompletionTimeAlertThresholdMinutes': 10, 'syncIntervalMinutes': 10, 'worldWideName': '60080E5000299C24000006EF57ACAC70'}

Authors

Kevin Hulquest (@hulquest)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/netapp_eseries/santricity/netapp_e_amg_sync_module.html