netapp_e_amg - Create, Remove, and Update Asynchronous Mirror Groups

New in version 2.2.

Synopsis

  • Allows for the creation, removal and updating of Asynchronous Mirror Groups 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.
interfaceType
 no
  • iscsi
  • fibre
The intended protocol to use if both Fibre and iSCSI are available.
manualSync
 no
Setting this to true will cause other synchronization values to be ignored
name
 yes
The name of the async array you wish to target, or create.
If state is present and the name isn't found, it will attempt to create.
recoveryWarnThresholdMinutes
 no 20
Recovery point warning threshold (minutes). The user will be warned when the age of the last good failures point exceeds this value
repoUtilizationWarnThreshold
 no 80
Recovery point warning threshold
secondaryArrayId
 yes
The ID of the secondary array to be used in mirroing process
ssid
 yes
The ID of the array to manage. This value must be unique for each array.
state
 yes
A state of present will either create or update the async mirror group.
A state of absent will remove the async mirror group.
syncIntervalMinutes
 no 10
The synchronization interval in minutes
syncWarnThresholdMinutes
 no 10
The threshold (in minutes) for notifying the user that periodic synchronization has taken too long to complete.
validate_certs
 no True
Should https certificates be validated?

Examples

- name: AMG removal
  na_eseries_amg:
    state: absent
    ssid: "{{ ssid }}"
    secondaryArrayId: "{{amg_secondaryArrayId}}"
    api_url: "{{ netapp_api_url }}"
    api_username: "{{ netapp_api_username }}"
    api_password: "{{ netapp_api_password }}"
    new_name: "{{amg_array_name}}"
    name: "{{amg_name}}"
  when: amg_create

- name: AMG create
  netapp_e_amg:
    state: present
    ssid: "{{ ssid }}"
    secondaryArrayId: "{{amg_secondaryArrayId}}"
    api_url: "{{ netapp_api_url }}"
    api_username: "{{ netapp_api_username }}"
    api_password: "{{ netapp_api_password }}"
    new_name: "{{amg_array_name}}"
    name: "{{amg_name}}"
  when: amg_create

Return Values

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

name description returned type sample
msg
Successful creation
 success string {"changed": true, "connectionType": "fc", "groupRef": "3700000060080E5000299C24000006E857AC7EEC", "groupState": "optimal", "id": "3700000060080E5000299C24000006E857AC7EEC", "label": "amg_made_by_ansible", "localRole": "primary", "mirrorChannelRemoteTarget": "9000000060080E5000299C24005B06E557AC7EEC", "orphanGroup": false, "recoveryPointAgeAlertThresholdMinutes": 20, "remoteRole": "secondary", "remoteTarget": {"nodeName": {"ioInterfaceType": "fc", "iscsiNodeName": null, "remoteNodeWWN": "20040080E5299F1C"}, "remoteRef": "9000000060080E5000299C24005B06E557AC7EEC", "scsiinitiatorTargetBaseProperties": {"ioInterfaceType": "fc", "iscsiinitiatorTargetBaseParameters": null}}, "remoteTargetId": "ansible2", "remoteTargetName": "Ansible2", "remoteTargetWwn": "60080E5000299F880000000056A25D56", "repositoryUtilizationWarnThreshold": 80, "roleChangeProgress": "none", "syncActivity": "idle", "syncCompletionTimeAlertThresholdMinutes": 10, "syncIntervalMinutes": 10, "worldWideName": "60080E5000299C24000006E857AC7EEC"}

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

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

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