Set-ReplicationSession
SYNOPSIS
Modifies a replication session.
SYNTAX
RoleById
Set-ReplicationSession [-Cluster] <Cluster> [-Id] <String> -Role {Destination | MetroNonPreferred | MetroPreferred | Source } [-Force] [-WhatIf] [-Confirm]
[<CommonParameters>]
StartFailoverTestById
Set-ReplicationSession [-Cluster] <Cluster> [-Id] <String> [-StartFailoverTest] [-SnapshotId <String>] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]
StopFailoverTestById
Set-ReplicationSession [-Cluster] <Cluster> [-Id] <String> [-StopFailoverTest] [-CreateEndOfTestSnapshot] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
Modifies a replication session. This can be used to start/stop a disaster recovery failover simulation test. From cluster version 3.0.0 and above, this can also be used to set the role associated to a replication session.
EXAMPLES
Example 1
PS C:\> Set-ReplicationSession -Cluster $cluster -Id sessionId -Role MetroNonPreferred
Where $cluster is a PowerStore cluster instance. Modifies the replication session with Id sessionId and role as MetroNonPreferred.
Example 2
PS C:\> Set-ReplicationSession -Cluster $cluster -Id sessionId -StartFailoverTest -SnapshotId snapXYZ
Where $cluster is a PowerStore cluster instance. Starts a disaster recovery failover simulation test using snapshot with ID snapXYZ for replication session with Id sessionId.
Example 3
PS C:\> Set-ReplicationSession -Cluster $cluster -Id sessionId -StopFailoverTest -CreateEndOfTestSnapshot
Where $cluster is a PowerStore cluster instance.
Stops a disaster recovery failover simulation test for replication session with Id sessionId.
A snapshot will be created in the format “failover_test_STOPPED_
PARAMETERS
-Cluster
A PowerStore cluster instance.
Type: Cluster
Parameter Sets: (All)
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Id
The replication session ID.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False
-Role
Role to be assigned.
Type: String
Parameter Sets: RoleById
Aliases:
Accepted values: Destination, MetroNonPreferred, MetroPreferred, Source
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-StartFailoverTest
Starts a disaster recovery failover simulation test.
Type: SwitchParameter
Parameter Sets: StartFailoverTestById
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-SnapshotId
Snapshot ID for failover test start.
Type: String
Parameter Sets: StartFailoverTestById
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-StopFailoverTest
Stops a disaster recovery failover simulation test.
Type: SwitchParameter
Parameter Sets: StopFailoverTestById
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-CreateEndOfTestSnapshot
Indicates whether a snapshot of the destination resource should be created at the end of the test.
Type: SwitchParameter
Parameter Sets: StopFailoverTestById
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Confirm
Prompts you for confirmation before running the cmdlet.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-Force
Suppress confirmation prompt before modifying the session.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.