PowerCLI Reference



This cmdlet retrieves replication groups.


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.


NameTypeDescriptionRequired?Pipeline InputDefault Value
NameString[]Specifies names of replication groups you want to retrieve.falseFalse
DatastoreDatastore[]Specifies the datastore to which replication groups apply. If not specified, all datastores which are compatible with the specified storage policy are considered.falseTrue (ByValue)
FailedOverSwitchParameterReturns only failed over replication groups.falseFalse
FaultDomainSpbmFaultDomain[]Specifies the fault domains which the replication groups are in.falseFalse
HardDiskHardDisk[]Specifies virtual disk objects to which replication groups apply.falseFalse
IdString[]Filters the retrieved replication groups by ID.trueFalse
ServerVIServer[]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.falseFalse
StoragePolicySpbmStoragePolicySpecifies the storage policy to which the replication groups comply.trueTrue (ByValue)
VasaProviderVasaProvider[]Specifies the VASA provider to retrieve replication groups from.falseFalse
VMVIObject[]Specifies the virtual machines to which replication groups apply. This parameter accepts both virtual machine and hard disk objects.falseTrue (ByValue)

Return Type

Zero or more SpbmReplicationGroup objects



-------------------------- 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.

Copyright © VMware, Inc. All rights reserved.