Start-SpbmReplicationFailover Command | Vmware PowerCLI Reference


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.


-ReplicationGroup < SpbmReplicationGroup[] >
[-CheckOnly ]
[-PointInTimeReplica < SpbmPointInTimeReplica[] > ]
[-RunAsync ]
[-Server < VIServer[] > ]
[-SourceVvolIdMap < Hashtable > ]
[-Unplanned ]


Required Parameter Name Type Position Features Description
ReplicationGroup SpbmReplicationGroup[] named
  • pipeline
  • wildcards
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 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
  • wildcards
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.




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


This cmdlet performs a failover of the devices in the specified replication groups.


This cmdlet retrieves replication groups.

This cmdlet synchronizes the data between source and replica for the specified replication group.


This cmdlet retrieves the relation of replication groups in a pair of source and target replication group.


This cmdlet prepares the specified replication groups to fail over.


This cmdlet promotes a target replication group from InTest to FailedOver state.


This cmdlet initiates reverse replication, by making the currently failed over replication group the source and its peer replication group the target.


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.