Failover-ReplicationSession
SYNOPSIS
Fails over a replication session.
SYNTAX
Failover-ReplicationSession [-Cluster] <Cluster> [-Id] <String> [-Planned <Boolean>] [-Reverse] [-Confirm] [-Force]
[-WhatIf] [<CommonParameters>]
DESCRIPTION
Fails over a replication session. Failing over the replication session changes the role of the destination system. After a failover, the original destination system becomes the source system, and production access is enabled for hosts and applications for recovery. Failovers can be planned or unplanned. Unplanned failovers must be directed to the destination cluster.
EXAMPLES
Example 1
PS C:\> Failover-ReplicationSession -Cluster $cluster -Id sessionId
Where $cluster is a PowerStore cluster instance. Performs a planned failover of the replication session with Id sessionId.
Example 2
PS C:\> Failover-ReplicationSession -Cluster $cluster -Id sessionId -Planned:$false
Where $cluster is a PowerStore cluster instance. Performs an unplanned failover of the replication session with Id sessionId.
Example 3
PS C:\> Failover-ReplicationSession -Cluster $cluster -Id sessionId -Reverse
Where $cluster is a PowerStore cluster instance. Performs a planned failover of the replication session with Id sessionId and activates the session in the reverse direction.
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
-Planned
Set the failover to be planned or unplanned.
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: True
Accept pipeline input: False
Accept wildcard characters: False
-Reverse
Indicates whether the system is auto-reprotected. Auto-reprotect is combination of failover and reprotect.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
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: None
Accept pipeline input: False
Accept wildcard characters: False
-Force
Suppress confirmation prompt before failing over the session.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
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: None
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.