< Back

Get-SpbmReplicationGroup

Sun Jan 19, 2020 7:15 pm

NAME 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>]





DESCRIPTION

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





PARAMETERS

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



Required? false

Position? named

Default value None

Accept pipeline input? True (ByValue)

Accept wildcard characters? true



-FailedOver [<SwitchParameter>]

Returns only failed over replication groups.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-FaultDomain <SpbmFaultDomain[]>

Specifies the fault domains which the replication groups are in.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? true



-HardDisk <HardDisk[]>

Specifies virtual disk objects to which replication groups apply.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Id <String[]>

Filters the retrieved replication groups by ID.



Required? true

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Name <String[]>

Specifies names of replication groups you want to retrieve.



Required? false

Position? 1

Default value None

Accept pipeline input? False

Accept wildcard characters? true



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



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? true



-StoragePolicy <SpbmStoragePolicy>

Specifies the storage policy to which the replication groups comply.



Required? true

Position? named

Default value None

Accept pipeline input? True (ByValue)

Accept wildcard characters? true



-VasaProvider <VasaProvider[]>

Specifies the VASA provider to retrieve replication groups from.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? true



-VM <VIObject[]>

Specifies the virtual machines to which replication groups apply. This parameter accepts both virtual machine

and hard disk objects.



Required? false

Position? named

Default value None

Accept pipeline input? True (ByValue)

Accept wildcard characters? true



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS

Zero or more SpbmReplicationGroup objects







NOTES









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

Online Version: https://code.vmware.com/doc/preview?id= ... Group.html