Start-SpbmReplicationFailover
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.
Syntax
Parameters
| Required | Parameter Name | Type | Position | Features | Description |
|---|---|---|---|---|---|
| required
|
ReplicationGroup | SpbmReplicationGroup[] | named |
|
Specifies the target replication groups to failover at. |
| optional | CheckOnly | SwitchParameter | named |
|
Does not perform the failover, but checks if the configuration is correct to perform the failover. |
| optional | PointInTimeReplica | SpbmPointInTimeReplica[] | named |
|
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. |
| optional | ProgressAction | ActionPreference | named |
|
|
| optional | RunAsync | SwitchParameter | named |
|
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. |
| optional | Server | VIServer[] | named |
|
Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet. |
| optional | SourceVvolIdMap | Hashtable | named |
|
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. |
| optional | Unplanned | SwitchParameter | named |
|
Specifies an unplanned failover. |
Output
System.StringExamples
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 Commands
SpbmReplicationFailover
This cmdlet performs a failover of the devices in the specified replication groups.
SpbmReplicationGroup
This cmdlet retrieves replication groups.
This cmdlet synchronizes the data between source and replica for the specified replication group.
SpbmReplicationPair
This cmdlet retrieves the relation of replication groups in a pair of source and target replication group.
SpbmReplicationPrepareFailover
This cmdlet prepares the specified replication groups to fail over.
SpbmReplicationPromote
This cmdlet promotes a target replication group from InTest to FailedOver state.
SpbmReplicationReverse
This cmdlet initiates reverse replication, by making the currently failed over replication group the source and its peer replication group the target.
SpbmReplicationTestFailover
This cmdlet performs a test failover of a target replication group.
This cmdlet stops the test failover on the specified replication groups and tries to perform a cleanup on the target site.