dellemc.powerstore.dellemc_powerstore_replicationsession (1.3.0) — module

Install collection

Install with ansible-galaxy collection install dellemc.powerstore:==1.3.0

Add to requirements.yml

  collections:
    - name: dellemc.powerstore
      version: 1.3.0

Description

Performs all replication session state change operations on a PowerStore Storage System. This module supports get details of an existing replication session. Updating the state of the replication session.

Requirements

• A Dell EMC PowerStore Storage System.
• Ansible 2.9 or 2.10

Usage examples

Scanned by Steampunk Spotter

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

- name: Pause a replication session
  dellemc_powerstore_replicationsession:
    array_ip: "{{array_ip}}"
    verifycert: "{{verifycert}}"
    user: "{{user}}"
    password: "{{password}}"
    volume: "sample_volume_1"
    session_state: "paused"

Scanned by Steampunk Spotter

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

- name: Synchronize a replication session
  dellemc_powerstore_replicationsession:
    array_ip: "{{array_ip}}"
    verifycert: "{{verifycert}}"
    user: "{{user}}"
    password: "{{password}}"
    volume: "sample_volume_1"
    session_state: "synchronizing"

Scanned by Steampunk Spotter

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

- name: Get details of a replication session
  dellemc_powerstore_replicationsession:
    array_ip: "{{array_ip}}"
    verifycert: "{{verifycert}}"
    user: "{{user}}"
    password: "{{password}}"
    volume: "sample_volume_1"

Scanned by Steampunk Spotter

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

- name: Fail over a replication session
  dellemc_powerstore_replicationsession:
    array_ip: "{{array_ip}}"
    verifycert: "{{verifycert}}"
    user: "{{user}}"
    password: "{{password}}"
    volume: "sample_volume_1"
    session_state: "failed_over"

Inputs

    
user:
    description:
    - The username of the PowerStore host.
    required: true
    type: str

volume:
    description:
    - Name/ID of the volume for which replication session exists.
    - volume_group, volume, and session_id are mutually exclusive.
    required: false
    type: str

array_ip:
    description:
    - IP or FQDN of the PowerStore management system.
    required: true
    type: str

password:
    description:
    - The password of the PowerStore host.
    required: true
    type: str

session_id:
    description:
    - ID of the replication session.
    - volume_group, volume, and session_id are mutually exclusive.
    required: false
    type: str

verifycert:
    choices:
    - true
    - false
    description:
    - Boolean variable to specify whether to validate SSL certificate or not.
    - True - indicates that the SSL certificate should be verified. Set the environment
      variable REQUESTS_CA_BUNDLE to the path of the SSL certificate.
    - False - indicates that the SSL certificate should not be verified.
    required: true
    type: bool

volume_group:
    description:
    - Name/ID of the volume group for which a replication session exists.
    - volume_group, volume, and session_id are mutually exclusive.
    required: false
    type: str

session_state:
    choices:
    - failed_over
    - paused
    - synchronizing
    description:
    - State in which the replication session is present after performing the task.
    required: false
    type: str

Outputs

changed:
  description: Whether or not the resource has changed
  returned: always
  type: bool
replication_session_details:
  contains:
    estimated_completion_timestamp:
      description: Estimated completion time of the current replication operation.
      type: str
    id:
      description: The system generated ID of the replication session. Unique across
        source and destination roles.
      type: str
    last_sync_timestamp:
      description: Time of last successful synchronization.
      type: str
    local_resource_id:
      description: Unique identifier of the local storage resource for the replication
        session.
      type: str
    name:
      description: Name of the replication rule.
      type: str
    progress_percentage:
      description: Progress of the current replication operation.
      type: int
    remote_resource_id:
      description: Unique identifier of the remote storage resource for the replication
        session.
      type: str
    remote_system_id:
      description: Unique identifier of the remote system instance.
      type: str
    replication_rule_id:
      description: Associated replication rule instance if created by policy engine.
      type: str
    resource_type:
      description: Storage resource type eligible for replication protection. volume
        - Replication session created on a volume. volume_group - Replication session
        created on a volume group.
      type: str
    role:
      description: Role of the replication session. Source - The local resource is
        the source of the remote replication session. Destination - The local resource
        is the destination of the remote replication session.
      type: str
    state:
      description: State of the replication session.
      type: str
  description: Details of the replication session
  returned: When replication session exists
  type: complex