Get-SpbmPointInTimeReplica
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.
Syntax
[-Count
< Int32 > ]
[-FromDate
< DateTime > ]
[-Name
< String[] > ]
[-ProgressAction
< ActionPreference > ]
[-ReplicationGroup
< SpbmReplicationGroup[] > ]
[-Server
< VIServer[] > ]
[-ToDate
< DateTime > ]
[-VasaProvider
< VasaProvider[] > ]
[-VasaTag
< String[] > ]
[CommonParameters]
Parameters
| Required | Parameter Name | Type | Position | Features | Description |
|---|---|---|---|---|---|
| optional | Count | Int32 | named |
|
Specifies 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. |
| optional | FromDate | DateTime | named |
|
Retrieves point in time replica objects created on the specified date or later. |
| optional | Name | String[] | named |
|
Filters the retrieved point in time replica objects by name. |
| optional | ProgressAction | ActionPreference | named |
|
|
| optional | ReplicationGroup | SpbmReplicationGroup[] | named |
|
Specifies the target replication group for which you want to retrieve replica objects. |
| optional | Server | VIServer[] | named |
|
Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer. |
| optional | ToDate | DateTime | named |
|
Retrieves point in time replica objects created earlier than the specified date. |
| optional | VasaProvider | VasaProvider[] | named |
|
Specifies the VASA provider from which you want to retrieve replica objects. |
| optional | VasaTag | String[] | named |
|
Restricts results to replica objects that have at least one of the specified VASA tags. The tags are case-sensitive. |
-Id
< String[] >
[-ProgressAction
< ActionPreference > ]
[-Server
< VIServer[] > ]
[CommonParameters]
Parameters
| Required | Parameter Name | Type | Position | Features | Description |
|---|---|---|---|---|---|
| required
|
Id | String[] | named |
|
Filters the retrieved point in time replica objects by ID. |
| optional | ProgressAction | ActionPreference | named |
|
|
| optional | Server | VIServer[] | named |
|
Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer. |
Output
VMware.VimAutomation.Storage.Types.V1.Spbm.Replication.SpbmFaultDomainExamples
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.
Related Commands
SpbmPointInTimeReplica
This cmdlet retrieves the point in time replica objects for the specified target replication groups.