--- external help file: ZertoApiWrapper-help.xml Module Name: ZertoApiWrapper online version: https://github.com/wcarroll/ZertoApiWrapper/blob/master/docs/Get-ZertoVpg.md schema: 2.0.0 --- # Get-ZertoVpg ## SYNOPSIS Returns information about VPGs ## SYNTAX ### main (Default) ``` Get-ZertoVpg [] ``` ### stats ``` Get-ZertoVpg -protectionGroupIdentifier [-checkpointsStats] [] ``` ### checkpoints ``` Get-ZertoVpg -protectionGroupIdentifier [-checkpoints] [-startDate ] [-endDate ] [] ``` ### protectionGroupIdentifier ``` Get-ZertoVpg -protectionGroupIdentifier [] ``` ### entityTypes ``` Get-ZertoVpg [-entityTypes] [] ``` ### failoverCommitPolicies ``` Get-ZertoVpg [-failoverCommitPolicies] [] ``` ### failoverShutdownPolicies ``` Get-ZertoVpg [-failoverShutdownPolicies] [] ``` ### priorities ``` Get-ZertoVpg [-priorities] [] ``` ### retentionPolicies ``` Get-ZertoVpg [-retentionPolicies] [] ``` ### statuses ``` Get-ZertoVpg [-statuses] [] ``` ### subStatuses ``` Get-ZertoVpg [-subStatuses] [] ``` ### filter ``` Get-ZertoVpg [-name ] [-status ] [-subStatus ] [-protectedSiteType ] [-recoverySiteType ] [-protectedSiteIdentifier ] [-recoverySiteIdentifier ] [-organizationName ] [-zorgIdentifier ] [-priority ] [-serviceProfileIdentifier ] [-backupEnabled] [] ``` ## DESCRIPTION returns information about VPGs ## EXAMPLES ### Example 1 ```powershell PS C:\> Get-ZertoVpg ``` Returns information about all VPGs in the site processing the request ### Example 2 ```powershell PS C:\> Get-ZertoVpg -name "MyVpg" ``` Returns information about VPG with the name "MyVpg" ## PARAMETERS ### -backupEnabled If backup is enabled. ```yaml Type: SwitchParameter Parameter Sets: filter Aliases: Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -checkpoints Return checkpoints for the selected Virtual Protection Group. ```yaml Type: SwitchParameter Parameter Sets: checkpoints Aliases: Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -checkpointsStats Return earliest and latest checkpoints for the selected Virtual Protection Group ```yaml Type: SwitchParameter Parameter Sets: stats Aliases: Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -endDate Return checkpoints before the specified start date. Valid formats include: 'yyyy-MM-ddTHH:mm:ss.fffZ', 'yyyy-MM-ddTHH:mm:ssZ', 'yyyy-MM-ddTHH:mmZ', 'yyyy-MM-ddTHHZ', 'yyyy-MM-dd', 'yyyy-MM', 'yyyy'. Adding Z to the end of the time sets the time to UTC. ```yaml Type: String Parameter Sets: checkpoints Aliases: Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -entityTypes Return Valid VPG entityTypes ```yaml Type: SwitchParameter Parameter Sets: entityTypes Aliases: Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -failoverCommitPolicies Valid Failover Commit Policies ```yaml Type: SwitchParameter Parameter Sets: failoverCommitPolicies Aliases: Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -failoverShutdownPolicies Valid Failover Shutdown Policies ```yaml Type: SwitchParameter Parameter Sets: failoverShutdownPolicies Aliases: Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -name The name of the VPG. ```yaml Type: String Parameter Sets: filter Aliases: vpgName Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -organizationName The ZORG for this VPG. ```yaml Type: String Parameter Sets: filter Aliases: Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -priorities Valid VPG priorities ```yaml Type: SwitchParameter Parameter Sets: priorities Aliases: Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -priority The VPG priority. Possible values are: 'Low', 'Medium', 'High' ```yaml Type: String Parameter Sets: filter Aliases: Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -protectedSiteIdentifier The identifier of the protected site where the VPG virtual machines are protected. ```yaml Type: String Parameter Sets: filter Aliases: Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -protectedSiteType The protected site environment. This filter behaves in the same way as the sourceType filter. Please see Zerto API Documentation for vaild values and discriptions. ```yaml Type: String Parameter Sets: filter Aliases: Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -protectionGroupIdentifier The identifier(s) of the Virtual Protection Group to return ```yaml Type: String[] Parameter Sets: stats, checkpoints, protectionGroupIdentifier Aliases: vpgId, protectionGroupId, pgId Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -recoverySiteIdentifier The identifier of the protected site where the VPG virtual machines are recovered. ```yaml Type: String Parameter Sets: filter Aliases: Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -recoverySiteType The recovery site environment. This filter behaves in the same way as the sourceType filter. Please see Zerto API Documentation for vaild values and discriptions. ```yaml Type: String Parameter Sets: filter Aliases: Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -retentionPolicies Valid retention policies ```yaml Type: SwitchParameter Parameter Sets: retentionPolicies Aliases: Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -serviceProfileIdentifier The identifier of the service profile to use for the VPG when a Zerto Cloud Manager is used. ```yaml Type: String Parameter Sets: filter Aliases: Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -startDate Return checkpoints after the specified start date. Valid formats include: 'yyyy-MM-ddTHH:mm:ss.fffZ', 'yyyy-MM-ddTHH:mm:ssZ', 'yyyy-MM-ddTHH:mmZ', 'yyyy-MM-ddTHHZ', 'yyyy-MM-dd', 'yyyy-MM', 'yyyy'. Adding Z to the end of the time sets the time to UTC. ```yaml Type: String Parameter Sets: checkpoints Aliases: Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -status The status of the VPG. Please use 'Get-ZertoVpg -statuses' for valid values ```yaml Type: String Parameter Sets: filter Aliases: Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -statuses Valid VPG statuses ```yaml Type: SwitchParameter Parameter Sets: statuses Aliases: Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -subStatus The substatus of the VPG. Please use 'Get-ZertoVpg -substatuses' for valid values ```yaml Type: String Parameter Sets: filter Aliases: Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -subStatuses Valid VPG sub statuses ```yaml Type: SwitchParameter Parameter Sets: subStatuses Aliases: Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -zorgIdentifier The internal identifier for the ZORG. ```yaml Type: String Parameter Sets: filter Aliases: Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS ### None ## OUTPUTS ### System.Object JSON data returned from the API as a PowerShell object containing settings for the selected VPG(s). ## NOTES ## RELATED LINKS [Zerto REST API VPG End Point Documentation](http://s3.amazonaws.com/zertodownload_docs/Latest/Zerto%20Virtual%20Replication%20Zerto%20Virtual%20Manager%20%28ZVM%29%20-%20vSphere%20Online%20Help/RestfulAPIs/StatusAPIs.5.100.html#)