Get-SpbmReplicationGroup
This cmdlet retrieves replication groups. The replication groups can be of type source or target.
Syntax
[-FailedOver]
[-FaultDomain <SpbmFaultDomain[]>]
[-Name <String[]>]
[-Server <VIServer[]>]
[-VasaProvider <VasaProvider[]>]
[CommonParameters]
[-FaultDomain <SpbmFaultDomain[]>]
[-Name <String[]>]
[-Server <VIServer[]>]
[-VasaProvider <VasaProvider[]>]
[CommonParameters]
Parameters
| Required | Parameter Name | Type | Position | Features | Description |
|---|---|---|---|---|---|
| optional |
|
SwitchParameter | named |
|
Returns only failed over replication groups. | optional |
|
SpbmFaultDomain[] | named |
|
Specifies the fault domains which the replication groups are in. | optional |
|
String[] | named |
|
Specifies names of replication groups you want to retrieve. | optional |
|
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 Connect-VIServer. | optional |
|
VasaProvider[] | named |
|
Specifies the VASA provider to retrieve replication groups from. |
[-HardDisk
<HardDisk[]>]
[-Server <VIServer[]>]
[-VM <VIObject[]>]
[CommonParameters]
[-Server <VIServer[]>]
[-VM <VIObject[]>]
[CommonParameters]
Parameters
| Required | Parameter Name | Type | Position | Features | Description |
|---|---|---|---|---|---|
| optional |
|
HardDisk[] | named |
|
Specifies virtual disk objects to which replication groups apply. | optional |
|
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 Connect-VIServer. | optional |
|
VIObject[] | named |
|
Specifies the virtual machines to which replication groups apply. This parameter accepts both virtual machine and hard disk objects. |
-Id
<String[]>
[-Server <VIServer[]>]
[CommonParameters]
[-Server <VIServer[]>]
[CommonParameters]
Parameters
| Required | Parameter Name | Type | Position | Features | Description |
|---|---|---|---|---|---|
| required |
|
String[] | named |
|
Filters the retrieved replication groups by ID. | optional |
|
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 Connect-VIServer. |
-StoragePolicy
<SpbmStoragePolicy>
[-Datastore <Datastore[]>]
[-Name <String[]>]
[-Server <VIServer[]>]
[CommonParameters]
[-Datastore <Datastore[]>]
[-Name <String[]>]
[-Server <VIServer[]>]
[CommonParameters]
Parameters
| Required | Parameter Name | Type | Position | Features | Description |
|---|---|---|---|---|---|
| required |
|
SpbmStoragePolicy | named |
|
Specifies the storage policy to which the replication groups comply. | optional |
|
Datastore[] | named |
|
Specifies the datastore to which replication groups apply. If not specified, all datastores which are compatible with the specified storage policy are considered. | optional |
|
String[] | named |
|
Specifies names of replication groups you want to retrieve. | optional |
|
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 Connect-VIServer. |
Output
VMware.VimAutomation.Storage.Types.V1.Spbm.Replication.SpbmReplicationGroup
Examples
Example 1
Get-SpbmReplicationGroup -Name 'ReplicationGroup' -FaultDomain $faultDomain
Retrieves replication groups named 'ReplicationGroup' in the $faultDomain fault domain.
Example 2
Get-SpbmReplicationGroup -Datastore $datastore -StoragePolicy $policy
Retrieves replication groups which are applicable to the $datastore datastore and comply with the $policy storage policy.
Example 3
Get-SpbmReplicationGroup -VM $vm -HardDisk $hd
Retrieves replication groups which are associated with the $vm virtual machine and the $hd hard disk.
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.
