PowerCLI Reference

Get-SpbmPointInTimeReplica

Synopsis

This cmdlet retrieves the point in time replica objects for the specified target replication groups.

Syntax

Get-SpbmPointInTimeReplica [[-Name] <String[]>] [-Count <Int32>] [-FromDate <DateTime>] [-ReplicationGroup <SpbmReplicationGroup[]>] [-Server <VIServer[]>] [-ToDate <DateTime>] [-VasaProvider <VasaProvider[]>] [-VasaTag <String[]>] [<CommonParameters>]

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

Related Commands

Online Version

Detailed Description

This cmdlet retrieves the point in time replica objects for the specified target replication groups. The cmdlet retrieves the point in time replicas by replication group, from date (inclusive), to date (exclusive), name, VASA tag, VASA provider, and replica ID.

Parameters

NameTypeDescriptionRequired?Pipeline InputDefault Value
NameString[]Filters the retrieved point in time replica objects by name.falseFalse
CountInt32Specifies the number of point in time replica objects you want to retrieve for each replication group. This restricts the result to a maximum count number of replica objects for each replication group.falseFalse
FromDateDateTimeRetrieves point in time replica objects created on the specified date or later.falseFalse
IdString[]Filters the retrieved point in time replica objects by ID.trueFalse
ReplicationGroupSpbmReplicationGroup[]Specifies the target replication group for which you want to retrieve replica objects.falseTrue (ByValue)
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
ToDateDateTimeRetrieves point in time replica objects created earlier than the specified date.falseFalse
VasaProviderVasaProvider[]Specifies the VASA provider from which you want to retrieve replica objects.falseTrue (ByValue)
VasaTagString[]Restricts results to replica objects that have at least one of the specified VASA tags. The tags are case-sensitive.falseFalse

Return Type

Zero or more SpbmPointInTimeReplica objects

Notes

Examples

-------------------------- Example 1 --------------------------

Get-SpbmPointInTimeReplica -ReplicationGroup $targetRg

Retrieves all point in time replicas from the $targetRg target replication group.

-------------------------- Example 2 --------------------------

Get-SpbmPointInTimeReplica -VasaProvider $vasaProvider -FromDate $from -ToDate $to

Retrieves point in time replicas created between $from and $to by the $vasaProvider VASA provider for all its target replication groups.


Copyright © VMware, Inc. All rights reserved.