Get-ProtectionGroups
Gets all the VPGs for a specified site and for all sites paired with the specified site.
Syntax
Get-ProtectionGroups [-ZVMIP] <String> [-ZVMPort] <Int32> [-Username] <String> [-Password] <String> [-SiteName] <String> [-Wait <int32>] [<Common&RiskParameters>] |
Description
The Get-ProtectionGroups cmdlet gets all the VPGs defined on a specified site and on any other site paired with the specified site.
Parameters
[-ZVMIP] <String>
The IP address of the machine where the Zerto Virtual Manager is installed that is used to process the cmdlet. The SiteName parameter can be this Zerto Virtual Manager site or a paired site.
Required? | True |
Position? | 1 or named |
Default Value | None |
Accept Wildcard Characters? | False |
[-ZVMPort] <Int32>
The HTTP port used for inbound communication with the Zerto Virtual Manager for APIs and cmdlets, specified during the installation. The default port recommended during installation is 9080.
Required? | True |
Position? | 2 or named |
Default Value | None |
Accept Wildcard Characters? | False |
[-Username] <String>
A username defined in the users.txt file in the Zerto Virtual Replication installation folder, for the Zerto Virtual Manager where the cmdlet is run.
Required? | True |
Position? | 3 or named |
Default Value | None |
Accept Wildcard Characters? | False |
[-Password] <String>
The password for the specified username, in the users.txt file in the Zerto Virtual Replication installation folder, for the Zerto Virtual Manager where the cmdlet is run, encrypted using SHA-1.
Required? | True |
Position? | 4 or named |
Default Value | None |
Accept Wildcard Characters? | False |
[-SiteName] <String>
The name of the site to use as the root to get the VPGs. All VPGs defined on this site are returned. To return all VPGs defined on this site and on any other site paired with this site specify all as the site name
Required? | True |
Position? | 5 or named |
Default Value | None |
Accept Wildcard Characters? | False |
-Wait <Int32>
The number of seconds to wait before timing out.
Required? | False |
Position? | Named |
Default Value | None |
Accept Wildcard Characters? | False |
<Common&RiskParameters>
This cmdlet supports the parameters described in
Optional PowerShell Parameters.
Inputs and Outputs
The input type is the type of the objects that you can pipe to the cmdlet. The return type is the type of the objects that the cmdlet returns.
Inputs | String A site name, as a string. |
Outputs | Get-ProtectionGroups returns the list of VPG names for the specified site. |
See Also
Example 1
PS C:\Windows\SysWOW64\WindowsPowerShell\v1.0> Get-ProtectionGroups 182.24.123.123 9080 administrator password -SiteName ’New York’ |
This command get the VPGs for the New York site. The Zerto Virtual Manager used to process the cmdlet runs on IP 182.24.123.123 and port 9080.
The cmdlet returns the VPG names:
Windows Server 2003 HR Dallas Example VPG Billing |