< Back
Start-SpbmReplicationFailover
Post
NAME Start-SpbmReplicationFailover
SYNOPSIS
This cmdlet performs a failover of the devices in the specified replication groups.
SYNTAX
Start-SpbmReplicationFailover [-ReplicationGroup] <SpbmReplicationGroup[]> [-CheckOnly] [-PointInTimeReplica
<SpbmPointInTimeReplica[]>] [-RunAsync] [-Server <VIServer>] [-SourceVvolIdMap <Hashtable>] [-Unplanned]
[-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
This cmdlet performs a failover of the devices in the specified replication groups. This cmdlet should be called
at the replication target location. After the operation succeeds, the devices will be ready to be registered by
using the virtual machine file path.
PARAMETERS
-CheckOnly [<SwitchParameter>]
Does not perform the failover, but checks if the configuration is correct to perform the failover.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-PointInTimeReplica <SpbmPointInTimeReplica[]>
Specifies the point in time replica object you want to use for the corresponding replication group failover.
If no replica is specified for a replication group, the latest available replica is used by default by the
VASA provider. If more than one replica is specified for a replication group, a non-terminating error is
generated for that replication group.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ReplicationGroup <SpbmReplicationGroup[]>
Specifies the target replication groups to failover at.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? true
-RunAsync [<SwitchParameter>]
Indicates that the command returns immediately without waiting for the task to complete. In this mode, the
output of the cmdlet is a Task object. For more information about the RunAsync parameter, run "help
About_RunAsync" in the VMware PowerCLI console.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Server <VIServer>
Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this
parameter, the command runs on the default servers. For more information about default servers, see the
description of the Connect-VIServer cmdlet.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? true
-SourceVvolIdMap <Hashtable>
This parameter is no longer required and will be removed in a future release. This will contain a map of
sourceVvolId (of the devices) to containerId (of the VVol datastore) for all the devices in the specified
replication groups.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Unplanned [<SwitchParameter>]
Specifies an unplanned failover.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false,
the cmdlet runs without asking for user confirmation.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are
modified.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
VM file paths corresponding to recovered devices. One VM file path for a VM and all its disks together.
NOTES
-------------------------- Example 1 --------------------------
Start-SpbmReplicationFailover -ReplicationGroup $targetRg -CheckOnly
Checks whether the target replication group has the correct configuration to perform the failover.
-------------------------- Example 2 --------------------------
Start-SpbmReplicationFailover -ReplicationGroup $targetRg -Unplanned
Performs an unplanned failover on the $targetRg target replication group.
RELATED LINKS
Online Version: https://code.vmware.com/doc/preview?id= ... lover.html
SYNOPSIS
This cmdlet performs a failover of the devices in the specified replication groups.
SYNTAX
Start-SpbmReplicationFailover [-ReplicationGroup] <SpbmReplicationGroup[]> [-CheckOnly] [-PointInTimeReplica
<SpbmPointInTimeReplica[]>] [-RunAsync] [-Server <VIServer>] [-SourceVvolIdMap <Hashtable>] [-Unplanned]
[-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
This cmdlet performs a failover of the devices in the specified replication groups. This cmdlet should be called
at the replication target location. After the operation succeeds, the devices will be ready to be registered by
using the virtual machine file path.
PARAMETERS
-CheckOnly [<SwitchParameter>]
Does not perform the failover, but checks if the configuration is correct to perform the failover.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-PointInTimeReplica <SpbmPointInTimeReplica[]>
Specifies the point in time replica object you want to use for the corresponding replication group failover.
If no replica is specified for a replication group, the latest available replica is used by default by the
VASA provider. If more than one replica is specified for a replication group, a non-terminating error is
generated for that replication group.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ReplicationGroup <SpbmReplicationGroup[]>
Specifies the target replication groups to failover at.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? true
-RunAsync [<SwitchParameter>]
Indicates that the command returns immediately without waiting for the task to complete. In this mode, the
output of the cmdlet is a Task object. For more information about the RunAsync parameter, run "help
About_RunAsync" in the VMware PowerCLI console.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Server <VIServer>
Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is given to this
parameter, the command runs on the default servers. For more information about default servers, see the
description of the Connect-VIServer cmdlet.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? true
-SourceVvolIdMap <Hashtable>
This parameter is no longer required and will be removed in a future release. This will contain a map of
sourceVvolId (of the devices) to containerId (of the VVol datastore) for all the devices in the specified
replication groups.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Unplanned [<SwitchParameter>]
Specifies an unplanned failover.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
If the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false,
the cmdlet runs without asking for user confirmation.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are
modified.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
VM file paths corresponding to recovered devices. One VM file path for a VM and all its disks together.
NOTES
-------------------------- Example 1 --------------------------
Start-SpbmReplicationFailover -ReplicationGroup $targetRg -CheckOnly
Checks whether the target replication group has the correct configuration to perform the failover.
-------------------------- Example 2 --------------------------
Start-SpbmReplicationFailover -ReplicationGroup $targetRg -Unplanned
Performs an unplanned failover on the $targetRg target replication group.
RELATED LINKS
Online Version: https://code.vmware.com/doc/preview?id= ... lover.html