dellemc.unity.replication_session (2.0.0) — module

Install collection

Install with ansible-galaxy collection install dellemc.unity:==2.0.0

Add to requirements.yml

  collections:
    - name: dellemc.unity
      version: 2.0.0

Description

Managing replication session on Unity storage system includes getting details, pause, resume, sync, failover, failback and deleting the replication session.

Requirements

• A Dell Unity Storage device version 5.1 or later.
• Ansible-core 2.14 or later.
• Python 3.9, 3.10 or 3.11.
• Storops Python SDK 1.2.11.

Usage examples

Scanned by Steampunk Spotter

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

- name: Get replication session details
  dellemc.unity.replication_session:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    session_name: "fs_replication"

Scanned by Steampunk Spotter

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

- name: Get replication session details based on session_id
  dellemc.unity.replication_session:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    session_id: "103079215114_APM00213404195_0000_103079215274_APM00213404194_0000"

Scanned by Steampunk Spotter

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

- name: Pause a replication session
  dellemc.unity.replication_session:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    session_name: "fs_replication"
    pause: true

Scanned by Steampunk Spotter

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

- name: Resume a replication session
  dellemc.unity.replication_session:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    session_name: "fs_replication"
    pause: false
    force_full_copy: true

Scanned by Steampunk Spotter

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

- name: Sync a replication session
  dellemc.unity.replication_session:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    session_name: "fs_replication"
    sync: true

Scanned by Steampunk Spotter

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

- name: Failover with sync a replication session
  dellemc.unity.replication_session:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    session_name: "fs_replication"
    failover_with_sync: true
    force: true

Scanned by Steampunk Spotter

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

- name: Failover a replication session
  dellemc.unity.replication_session:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    session_name: "fs_replication"
    failover_with_sync: false

Scanned by Steampunk Spotter

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

- name: Failback a replication session
  dellemc.unity.replication_session:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    session_name: "fs_replication"
    failback: true
    force_full_copy: true

Scanned by Steampunk Spotter

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

- name: Delete a replication session
  dellemc.unity.replication_session:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    session_name: "fs_replication"
    state: "absent"

Inputs

    
port:
    default: 443
    description:
    - Port number through which communication happens with Unity management server.
    type: int

sync:
    description:
    - Sync a replication session.
    type: bool

force:
    description:
    - Skip pre-checks on file system(s) replication sessions of a NAS server when a replication
      failover is issued from the source NAS server.
    type: bool

pause:
    description:
    - Pause or resume replication session.
    type: bool

state:
    choices:
    - absent
    - present
    default: present
    description:
    - State variable to determine whether replication session will exist or not.
    type: str

failback:
    description:
    - Failback a replication session.
    type: bool

password:
    description:
    - The password of the Unity management server.
    required: true
    type: str

username:
    description:
    - The username of the Unity management server.
    required: true
    type: str

session_id:
    description:
    - ID of replication session.
    type: str

session_name:
    description:
    - Name of replication session.
    type: str

unispherehost:
    description:
    - IP or FQDN of the Unity management server.
    required: true
    type: str

validate_certs:
    aliases:
    - verifycert
    default: true
    description:
    - Boolean variable to specify whether or not to validate SSL certificate.
    - C(true) - Indicates that the SSL certificate should be verified.
    - C(false) - Indicates that the SSL certificate should not be verified.
    type: bool

force_full_copy:
    description:
    - Indicates whether to sync back all data from the destination SP to the source SP
      during the failback session. Needed during resume operation when replication session
      goes out of sync due to a fault.
    type: bool

failover_with_sync:
    description:
    - If C(true), Sync the source and destination resources before failing over the asynchronous
      replication session or keep them in sync after failing over the synchronous replication
      session.
    - If C(false), Failover a replication session.
    type: bool

Outputs

changed:
  description: Whether or not the resource has changed.
  returned: always
  sample: true
  type: bool
replication_session_details:
  contains:
    currentTransferEstRemainTime:
      description: Estimated time left for the replication synchronization to complete.
      type: int
    dstResourceId:
      description: Identifier of the destination resource.
      type: str
    dstStatus:
      description: Status of the destination end of the replication session.
      type: str
    id:
      description: Unique identifier of the replicationSession instance.
      type: str
    lastSyncTime:
      description: Date and time of the last replication synchronization.
      type: str
    maxTimeOutOfSync:
      description: Maximum time to wait before the system syncs the source and destination
        resources.
      type: int
    name:
      description: User-specified replication session name.
      type: str
    networkStatus:
      description: Status of the network connection used by the replication session.
      type: str
    remoteSystem:
      contains:
        UnityRemoteSystem:
          contains:
            id:
              description: Unique identifier of the remote system instance.
              type: str
            serialNumber:
              description: Serial number of the remote system.
              type: str
          description: Information about remote storage system.
          type: dict
      description: Specifies the remote system to use as the destination for the replication
        session.
      type: dict
    replicationResourceType:
      description: Replication resource type of replication session endpoints.
      type: str
    srcStatus:
      description: Status of the source end of the session.
      type: str
    status:
      description: Replication status of the replication session.
      type: str
    syncProgress:
      description: Synchronization completion percentage between source and destination
        resources of the replication session.
      type: int
    syncState:
      description: Synchronization state between source and destination resource of
        the replication session.
      type: str
  description: Details of the replication session.
  returned: When replication session exists.
  sample:
    current_transfer_est_remain_time: 0
    daily_snap_replication_policy: null
    dst_resource_id: nas_8
    dst_spa_interface:
      UnityRemoteInterface:
        hash: 8771253398547
        id: APM00213404195:if_181
    dst_spb_interface:
      UnityRemoteInterface:
        hash: 8771253424144
        id: APM00213404195:if_180
    dst_status: ReplicationSessionStatusEnum.OK
    existed: true
    hash: 8771259012271
    health:
      UnityHealth:
        hash: 8771253424168
    hourly_snap_replication_policy: null
    id: 103079215114_APM00213404195_0000_103079215274_APM00213404194_0000
    last_sync_time: '2023-04-18 10:35:25+00:00'
    local_role: ReplicationSessionReplicationRoleEnum.DESTINATION
    max_time_out_of_sync: 0
    members: null
    name: rep_sess_nas
    network_status: ReplicationSessionNetworkStatusEnum.OK
    remote_system:
      UnityRemoteSystem:
        hash: 8771253380142
    replication_resource_type: ReplicationEndpointResourceTypeEnum.NASSERVER
    src_resource_id: nas_213
    src_spa_interface:
      UnityRemoteInterface:
        hash: 8771253475010
        id: APM00213404194:if_195
    src_spb_interface:
      UnityRemoteInterface:
        hash: 8771253374169
        id: APM00213404194:if_194
    src_status: ReplicationSessionStatusEnum.OK
    status: ReplicationOpStatusEnum.ACTIVE
    sync_progress: 0
    sync_state: ReplicationSessionSyncStateEnum.IN_SYNC
  type: dict