PowerCLI Reference

Get-SpbmReplicationGroup

Synopsis

This cmdlet retrieves replication groups.

Syntax

Get-SpbmReplicationGroup [[-Name] <String[]>] [-Datastore <Datastore[]>] [-Server <VIServer[]>] -StoragePolicy <SpbmStoragePolicy> [<CommonParameters>]

Get-SpbmReplicationGroup [[-Name] <String[]>] [-FailedOver] [-FaultDomain <SpbmFaultDomain[]>] [-Server <VIServer[]>] [-VasaProvider <VasaProvider[]>] [<CommonParameters>]

Get-SpbmReplicationGroup [-HardDisk <HardDisk[]>] [-Server <VIServer[]>] [-VM <VIObject[]>] [<CommonParameters>]

Get-SpbmReplicationGroup -Id <String[]> [-Server <VIServer[]>] [<CommonParameters>]

Related Commands

Online Version

Detailed Description

This cmdlet retrieves replication groups. The replication groups can be of type source or target.

Parameters

Name	Type	Description	Required?	Pipeline Input
Name	String[]	Specifies names of replication groups you want to retrieve.	false	False
Datastore	Datastore[]	Specifies the datastore to which replication groups apply. If not specified, all datastores which are compatible with the specified storage policy are considered.	false	True (ByValue)
FailedOver	SwitchParameter	Returns only failed over replication groups.	false	False
FaultDomain	SpbmFaultDomain[]	Specifies the fault domains which the replication groups are in.	false	False
HardDisk	HardDisk[]	Specifies virtual disk objects to which replication groups apply.	false	False
Id	String[]	Filters the retrieved replication groups by ID.	true	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 Connect-VIServer.	false	False
StoragePolicy	SpbmStoragePolicy	Specifies the storage policy to which the replication groups comply.	true	True (ByValue)
VasaProvider	VasaProvider[]	Specifies the VASA provider to retrieve replication groups from.	false	False
VM	VIObject[]	Specifies the virtual machines to which replication groups apply. This parameter accepts both virtual machine and hard disk objects.	false	True (ByValue)

Return Type

Zero or more SpbmReplicationGroup objects

Notes

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.