Try SpotterReplication session operations on a PowerStore storage system
| "added in version" 1.2.0 of dellemc.powerstore"
Authors: P Srinivas Rao (@srinivas-rao5) <ansible.team@dell.com>
Install with ansible-galaxy collection install dellemc.powerstore:==3.2.0
collections:
- name: dellemc.powerstore
version: 3.2.0Performs 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.
- 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"
- name: Modify a replication session
dellemc.powerstore.replicationsession:
array_ip: "{{array_ip}}"
verifycert: "{{verifycert}}"
user: "{{user}}"
password: "{{password}}"
volume: "sample_volume_1"
role: "Metro_Preferred"
- name: Get details of a replication session
dellemc.powerstore.replicationsession:
array_ip: "{{array_ip}}"
verifycert: "{{verifycert}}"
user: "{{user}}"
password: "{{password}}"
volume: "sample_volume_1"
- 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"
port:
description:
- Port number for the PowerStore array.
- If not passed, it will take 443 as default.
type: int
role:
choices:
- Metro_Preferred
- Metro_Non_Preferred
description:
- Role of the metro replication session.
type: str
user:
description:
- The username of the PowerStore host.
required: true
type: str
volume:
description:
- Name/ID of the volume for which replication session exists.
- Parameter I(filesystem), I(nas_server), I(volume_group), I(volume), I(replication_group),
and I(session_id) are mutually exclusive.
type: str
timeout:
default: 120
description:
- Time after which the connection will get terminated.
- It is to be mentioned in seconds.
type: int
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
filesystem:
description:
- Name/ID of the filesystem for which replication session exists.
- Parameter I(filesystem), I(nas_server), I(volume_group), I(volume), I(replication_group),
and I(session_id) are mutually exclusive.
type: str
nas_server:
description:
- Name/ID of the NAS server for which replication session exists.
- Parameter I(filesystem), I(nas_server), I(volume_group), I(volume), I(replication_group),
and I(session_id) are mutually exclusive.
type: str
session_id:
description:
- ID of the replication session.
- Parameter I(filesystem), I(nas_server), I(volume_group), I(volume), I(replication_group),
and I(session_id) are mutually exclusive.
type: str
volume_group:
description:
- Name/ID of the volume group for which a replication session exists.
- Parameter I(filesystem), I(nas_server), I(volume_group), I(volume), I(replication_group),
and I(session_id) are mutually exclusive.
type: str
session_state:
choices:
- failed_over
- paused
- synchronizing
description:
- State in which the replication session is present after performing the task.
type: str
validate_certs:
aliases:
- verifycert
default: true
description:
- Boolean variable to specify whether to validate SSL certificate or not.
- C(true) - indicates that the SSL certificate should be verified. Set the environment
variable REQUESTS_CA_BUNDLE to the path of the SSL certificate.
- C(false) - indicates that the SSL certificate should not be verified.
type: bool
replication_group:
description:
- Name or ID of the replication group for which replication session exists.
- Parameter I(filesystem), I(nas_server), I(volume_group), I(volume), I(replication_group),
and I(session_id) are mutually exclusive.
type: str
changed:
description: Whether or not the resource has changed.
returned: always
sample: 'false'
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
sample:
estimated_completion_timestamp: null
id: b05b5108-26b6-4567-a1d8-1c7795b2e6bc
last_sync_timestamp: '2022-01-06T06:55:01.870946+00:00'
local_resource_id: b0acb8de-446b-48e4-82ae-89ed05a35d01
local_resource_name: sample_volume
migration_session: null
progress_percentage: null
remote_resource_id: c1535ab7-e874-42eb-8692-7aa12aa4346e
remote_system:
id: b5f62edd-f7aa-483a-afaa-4364ab6fcd3a
name: WN-D8989
remote_system_id: b5f62edd-f7aa-483a-afaa-4364ab6fcd3a
replication_rule:
id: 05777d33-b2fb-4e65-8202-208ff4fe5878
name: sample_replication_rule
replication_rule_id: 05777d33-b2fb-4e65-8202-208ff4fe5878
resource_type: Volume
resource_type_l10n: Volume
role: Destination
role_l10n: Destination
state: Paused
state_l10n: Paused
storage_element_pairs:
- local_storage_element_id: b0acb8de-446b-48e4-82ae-89ed05a35d01
remote_storage_element_id: c1535ab7-e874-42eb-8692-7aa12aa4346e
replication_shadow_id: null
storage_element_type: volume
type: complex