## PowerCLI Reference

# Get-SpbmReplicationGroup

## Synopsis

This cmdlet retrieves replication groups.

Syntax

Get-SpbmReplicationGroup [[-Name] <String[]>] [-FaultDomain <SpbmFaultDomain[]>] [-VasaProvider <VasaProvider[]>] [-FailedOver] [-Server <VIServer[]>] [<CommonParameters>]
Get-SpbmReplicationGroup [[-Name] <String[]>] -StoragePolicy <SpbmStoragePolicy> [-Datastore <Datastore[]>] [-Server <VIServer[]>] [<CommonParameters>]
Get-SpbmReplicationGroup -Id <String[]> [-Server <VIServer[]>] [<CommonParameters>]
Get-SpbmReplicationGroup [-VM <VIObject[]>] [-HardDisk <HardDisk[]>] [-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 | Default Value
--- | --- | --- | --- | --- | ---
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.

Copyright © VMware, Inc. All rights reserved.