community.general.netapp_e_amg_sync (0.1.1) — module

Install collection

Install with ansible-galaxy collection install community.general:==0.1.1

Add to requirements.yml

  collections:
    - name: community.general
      version: 0.1.1

Description

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

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

    - 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 }}"

Inputs

    
name:
    description:
    - The name of the async mirror group you wish to target
    required: true

ssid:
    description:
    - The ID of the storage array containing the AMG you wish to target

state:
    choices:
    - running
    - suspended
    description:
    - The synchronization action you'd like to take.
    - If C(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 C(suspended) it will suspend any ongoing sync action, but return OK if there
      is no active sync or if the sync is already suspended
    required: true

api_url:
    description:
    - The url to the SANtricity WebServices Proxy or embedded REST API.
    required: true

api_password:
    description:
    - The password to authenticate with the SANtricity WebServices Proxy or embedded REST
      API.
    required: true

api_username:
    description:
    - The username to authenticate with the SANtricity WebServices Proxy or embedded REST
      API.
    required: true

validate_certs:
    default: true
    description:
    - Should https certificates be validated?
    required: false
    type: bool

delete_recovery_point:
    default: false
    description:
    - 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.'
    type: bool

Outputs

json:
  description: The object attributes of the AMG.
  example:
    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: 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: 60080E5000299C24000006EF57ACAC70
  returned: success
  type: str