W3cubDocs

/Ansible

netapp_eseries.santricity.netapp_e_amg_role – NetApp E-Series update the role of a storage array within an Asynchronous Mirror Group (AMG).

Note

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

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

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

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

New in version 2.2: of netapp_eseries.santricity

Synopsis

  • Update a storage array to become the primary or secondary instance in an asynchronous mirror group

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.
force
boolean
    Choices:
  • no ←
  • yes
Whether to force the role reversal regardless of the online-state of the primary
name
string / required
Name of the role
noSync
boolean
    Choices:
  • no ←
  • yes
Whether to avoid synchronization prior to role reversal
role
string / required
    Choices:
  • primary
  • secondary
Whether the array should be the primary or secondary array for the AMG
ssid
string / required
The ID of the primary storage array for the async mirror action
validate_certs
boolean
    Choices:
  • no
  • yes ←
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, the following are the fields unique to this module:

Key Returned Description
msg
string
failure
Failure message

Sample:
No Async Mirror Group with the name.


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/latest/collections/netapp_eseries/santricity/netapp_e_amg_role_module.html