On this page
netapp_e_amg_role - Update the role of a storage array within an Asynchronous Mirror Group (AMG).
New in version 2.2.
Synopsis
- Update a storage array to become the primary or secondary instance in an asynchronous mirror group
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.
|
||
force |
no |
Whether to force the role reversal regardless of the online-state of the primary
|
||
noSync |
no |
|
Whether to avoid synchronization prior to role reversal
|
|
role |
yes |
|
Whether the array should be the primary or secondary array for the AMG
|
|
ssid |
yes |
The ID of the primary storage array for the async mirror action
|
||
validate_certs |
no | True |
Should https certificates be validated?
|
Examples
- name: Update the role of a storage array
netapp_e_amg_role:
name: updating amg role
role: primary
ssid: "{{ ssid }}"
api_url: "{{ netapp_api_url }}"
api_username: "{{ netapp_api_username }}"
api_password: "{{ netapp_api_password }}"
validate_certs: "{{ netapp_api_validate_certs }}"
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 |
Failure message
|
failure | string | No Async Mirror Group with the name. |
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_role_module.html