zerto/ZertoApiWrapper
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Updated Help Docs for Remove-ZertoVpg

Browse Source
This commit is contained in:
Wes Carroll
2019-03-12 15:45:05 -04:00
parent 0d9df95166
commit 38a9f69c76
3 changed files with 242 additions and 61 deletions
Download Patch File Download Diff File Expand all files Collapse all files
ZertoApiWrapper/Public/en-us/ZertoApiWrapper-help.xml
+116 -33
View File
@@ -5015,7 +5015,7 @@
<maml:name>System.Object</maml:name> <maml:name>System.Object</maml:name>
</dev:type> </dev:type>
<maml:description> <maml:description>
<maml:para></maml:para> <maml:para>JSON data returned from the API as a PowerShell object containing settings for the selected VPG(s).</maml:para>
</maml:description> </maml:description>
</command:returnValue> </command:returnValue>
</command:returnValues> </command:returnValues>
@@ -5033,7 +5033,7 @@
</dev:remarks> </dev:remarks>
</command:example> </command:example>
<command:example> <command:example>
<maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:title>-------------------------- Example 2 --------------------------</maml:title>
<dev:code>PS C:\&gt; Get-ZertoVpg -name "MyVpg"</dev:code> <dev:code>PS C:\&gt; Get-ZertoVpg -name "MyVpg"</dev:code>
<dev:remarks> <dev:remarks>
<maml:para>Returns information about VPG with the name "MyVpg"</maml:para> <maml:para>Returns information about VPG with the name "MyVpg"</maml:para>
@@ -9664,26 +9664,13 @@
<command:syntax> <command:syntax>
<command:syntaxItem> <command:syntaxItem>
<maml:name>Remove-ZertoVpg</maml:name> <maml:name>Remove-ZertoVpg</maml:name>
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none">
<maml:name>vpgName</maml:name>
<maml:Description>
<maml:para>Name of the VPG to delete.</maml:para>
</maml:Description>
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
<dev:type>
<maml:name>String</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>None</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
<maml:name>force</maml:name> <maml:name>force</maml:name>
<maml:Description> <maml:Description>
<maml:para>Use this parameter to force delete the VPG, by setting this parameter equal to true.</maml:para> <maml:para>Use this switch to force delete the VPG. If unused, a non-forced remove vpg operation will be executed.</maml:para>
</maml:Description> </maml:Description>
<command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue>
<dev:type> <dev:type>
<maml:name>Boolean</maml:name> <maml:name>SwitchParameter</maml:name>
<maml:uri /> <maml:uri />
</dev:type> </dev:type>
<dev:defaultValue>False</dev:defaultValue> <dev:defaultValue>False</dev:defaultValue>
@@ -9691,11 +9678,81 @@
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
<maml:name>keepRecoveryVolumes</maml:name> <maml:name>keepRecoveryVolumes</maml:name>
<maml:Description> <maml:Description>
<maml:para>Use this parameter to keep the recovery volumes at the target site, by setting it to True. If the virtual machines in the deleted VPG are re-protected, these volumes can be used as pre-seed volumes to speed up the initial synchronization of the new VPG. Default is to remove Recovery Volumes</maml:para> <maml:para>Use this switch to keep the recovery volumes at the target site. If the virtual machines in the deleted VPG are re-protected, these volumes can be used as pre-seed volumes to speed up the initial synchronization of the new VPG. If this switch is not set, recovery volumes will not be retained. If required to be retained, get the path to these volumes prior to the deletion to use as pre-seed volumes for an easier operation.</maml:para>
</maml:Description> </maml:Description>
<command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue>
<dev:type> <dev:type>
<maml:name>Boolean</maml:name> <maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>False</dev:defaultValue>
</command:parameter>
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none">
<maml:name>vpgidentifier</maml:name>
<maml:Description>
<maml:para>vpgIdentifier(s) of the VPG(s) to delete.</maml:para>
</maml:Description>
<command:parameterValue required="true" variableLength="false">String[]</command:parameterValue>
<dev:type>
<maml:name>String[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>None</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf">
<maml:name>Confirm</maml:name>
<maml:Description>
<maml:para>Prompts you for confirmation before running the cmdlet.</maml:para>
</maml:Description>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>False</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi">
<maml:name>WhatIf</maml:name>
<maml:Description>
<maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
</maml:Description>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>False</dev:defaultValue>
</command:parameter>
</command:syntaxItem>
<command:syntaxItem>
<maml:name>Remove-ZertoVpg</maml:name>
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none">
<maml:name>vpgName</maml:name>
<maml:Description>
<maml:para>Name(s) of the VPG(s) to delete.</maml:para>
</maml:Description>
<command:parameterValue required="true" variableLength="false">String[]</command:parameterValue>
<dev:type>
<maml:name>String[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>None</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
<maml:name>force</maml:name>
<maml:Description>
<maml:para>Use this switch to force delete the VPG. If unused, a non-forced remove vpg operation will be executed.</maml:para>
</maml:Description>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>False</dev:defaultValue>
</command:parameter>
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
<maml:name>keepRecoveryVolumes</maml:name>
<maml:Description>
<maml:para>Use this switch to keep the recovery volumes at the target site. If the virtual machines in the deleted VPG are re-protected, these volumes can be used as pre-seed volumes to speed up the initial synchronization of the new VPG. If this switch is not set, recovery volumes will not be retained. If required to be retained, get the path to these volumes prior to the deletion to use as pre-seed volumes for an easier operation.</maml:para>
</maml:Description>
<dev:type>
<maml:name>SwitchParameter</maml:name>
<maml:uri /> <maml:uri />
</dev:type> </dev:type>
<dev:defaultValue>False</dev:defaultValue> <dev:defaultValue>False</dev:defaultValue>
@@ -9728,11 +9785,11 @@
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
<maml:name>force</maml:name> <maml:name>force</maml:name>
<maml:Description> <maml:Description>
<maml:para>Use this parameter to force delete the VPG, by setting this parameter equal to true.</maml:para> <maml:para>Use this switch to force delete the VPG. If unused, a non-forced remove vpg operation will be executed.</maml:para>
</maml:Description> </maml:Description>
<command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type> <dev:type>
<maml:name>Boolean</maml:name> <maml:name>SwitchParameter</maml:name>
<maml:uri /> <maml:uri />
</dev:type> </dev:type>
<dev:defaultValue>False</dev:defaultValue> <dev:defaultValue>False</dev:defaultValue>
@@ -9740,23 +9797,35 @@
<command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
<maml:name>keepRecoveryVolumes</maml:name> <maml:name>keepRecoveryVolumes</maml:name>
<maml:Description> <maml:Description>
<maml:para>Use this parameter to keep the recovery volumes at the target site, by setting it to True. If the virtual machines in the deleted VPG are re-protected, these volumes can be used as pre-seed volumes to speed up the initial synchronization of the new VPG. Default is to remove Recovery Volumes</maml:para> <maml:para>Use this switch to keep the recovery volumes at the target site. If the virtual machines in the deleted VPG are re-protected, these volumes can be used as pre-seed volumes to speed up the initial synchronization of the new VPG. If this switch is not set, recovery volumes will not be retained. If required to be retained, get the path to these volumes prior to the deletion to use as pre-seed volumes for an easier operation.</maml:para>
</maml:Description> </maml:Description>
<command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
<dev:type> <dev:type>
<maml:name>Boolean</maml:name> <maml:name>SwitchParameter</maml:name>
<maml:uri /> <maml:uri />
</dev:type> </dev:type>
<dev:defaultValue>False</dev:defaultValue> <dev:defaultValue>False</dev:defaultValue>
</command:parameter> </command:parameter>
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="none">
<maml:name>vpgidentifier</maml:name>
<maml:Description>
<maml:para>vpgIdentifier(s) of the VPG(s) to delete.</maml:para>
</maml:Description>
<command:parameterValue required="true" variableLength="false">String[]</command:parameterValue>
<dev:type>
<maml:name>String[]</maml:name>
<maml:uri />
</dev:type>
<dev:defaultValue>None</dev:defaultValue>
</command:parameter>
<command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none">
<maml:name>vpgName</maml:name> <maml:name>vpgName</maml:name>
<maml:Description> <maml:Description>
<maml:para>Name of the VPG to delete.</maml:para> <maml:para>Name(s) of the VPG(s) to delete.</maml:para>
</maml:Description> </maml:Description>
<command:parameterValue required="true" variableLength="false">String</command:parameterValue> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue>
<dev:type> <dev:type>
<maml:name>String</maml:name> <maml:name>String[]</maml:name>
<maml:uri /> <maml:uri />
</dev:type> </dev:type>
<dev:defaultValue>None</dev:defaultValue> <dev:defaultValue>None</dev:defaultValue>
@@ -9802,7 +9871,7 @@
<maml:name>System.Object</maml:name> <maml:name>System.Object</maml:name>
</dev:type> </dev:type>
<maml:description> <maml:description>
<maml:para></maml:para> <maml:para>Task Identifier of the Remove operation</maml:para>
</maml:description> </maml:description>
</command:returnValue> </command:returnValue>
</command:returnValues> </command:returnValues>
@@ -9821,9 +9890,23 @@
</command:example> </command:example>
<command:example> <command:example>
<maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:title>-------------------------- Example 2 --------------------------</maml:title>
<dev:code>PS C:\&gt; Remove-ZertoVpg -vpgName "MyVpg" -keepRecoveryVolumes</dev:code> <dev:code>PS C:\&gt; Remove-ZertoVpg -vpgName "MyVpg", "MyOtherVpg" -keepRecoveryVolumes</dev:code>
<dev:remarks> <dev:remarks>
<maml:para>Deletes Zerto Virtual Protection Group named "MyVpg". Recovery volumes at the recovery site will be retained.</maml:para> <maml:para>Deletes Zerto Virtual Protection Groups named "MyVpg" and "MyOtherVpg." Recovery volumes at the recovery site will be retained for both VPGs.</maml:para>
</dev:remarks>
</command:example>
<command:example>
<maml:title>-------------------------- Example 3 --------------------------</maml:title>
<dev:code>PS C:\&gt; Remove-ZertoVpg -vpgIdentifier "MyVpgIdentifier" -keepRecoveryVolumes</dev:code>
<dev:remarks>
<maml:para>Deletes Zerto Virtual Protection Group with vpgIdentifier "MyVpgIdentifier". Recovery volumes at the recovery site will be retained.</maml:para>
</dev:remarks>
</command:example>
<command:example>
<maml:title>-------------------------- Example 4 --------------------------</maml:title>
<dev:code>PS C:\&gt; Get-ZertoVpg -recoverySiteIdentifier "MyRecoverySiteIdentifier" | Remove-ZertoVpg</dev:code>
<dev:remarks>
<maml:para>Uses the `Get-ZertoVpg` function to get all VPGs currently being protected to recovery site with identifier "MyRecoverySiteIdentifier." This information is piped into the `Remove-ZertoVpg` function and will remove all VPGs being protected to the specified recovery site.</maml:para>
</dev:remarks> </dev:remarks>
</command:example> </command:example>
</command:examples> </command:examples>
docs/Get-ZertoVpg.md
+59 -15
View File
@@ -8,68 +8,80 @@ schema: 2.0.0
# Get-ZertoVpg # Get-ZertoVpg
## SYNOPSIS ## SYNOPSIS
Returns information about VPGs Returns information about VPGs
## SYNTAX ## SYNTAX
### main (Default) ### main (Default)
```
```PowerShell
Get-ZertoVpg [<CommonParameters>] Get-ZertoVpg [<CommonParameters>]
``` ```
### stats ### stats
```
```PowerShell
Get-ZertoVpg -protectionGroupIdentifier <String[]> [-checkpointsStats] [<CommonParameters>] Get-ZertoVpg -protectionGroupIdentifier <String[]> [-checkpointsStats] [<CommonParameters>]
``` ```
### checkpoints ### checkpoints
```
Get-ZertoVpg -protectionGroupIdentifier <String[]> [-checkpoints] [-startDate <String>] [-endDate <String>] ```PowerShell
[<CommonParameters>] Get-ZertoVpg -protectionGroupIdentifier <String[]> [-checkpoints] [-startDate <String>] [-endDate <String>] [<CommonParameters>]
``` ```
### protectionGroupIdentifier ### protectionGroupIdentifier
```
```PowerShell
Get-ZertoVpg -protectionGroupIdentifier <String[]> [<CommonParameters>] Get-ZertoVpg -protectionGroupIdentifier <String[]> [<CommonParameters>]
``` ```
### entityTypes ### entityTypes
```
```PowerShell
Get-ZertoVpg [-entityTypes] [<CommonParameters>] Get-ZertoVpg [-entityTypes] [<CommonParameters>]
``` ```
### failoverCommitPolicies ### failoverCommitPolicies
```
```PowerShell
Get-ZertoVpg [-failoverCommitPolicies] [<CommonParameters>] Get-ZertoVpg [-failoverCommitPolicies] [<CommonParameters>]
``` ```
### failoverShutdownPolicies ### failoverShutdownPolicies
```
```PowerShell
Get-ZertoVpg [-failoverShutdownPolicies] [<CommonParameters>] Get-ZertoVpg [-failoverShutdownPolicies] [<CommonParameters>]
``` ```
### priorities ### priorities
```
```PowerShell
Get-ZertoVpg [-priorities] [<CommonParameters>] Get-ZertoVpg [-priorities] [<CommonParameters>]
``` ```
### retentionPolicies ### retentionPolicies
```
```PowerShell
Get-ZertoVpg [-retentionPolicies] [<CommonParameters>] Get-ZertoVpg [-retentionPolicies] [<CommonParameters>]
``` ```
### statuses ### statuses
```
```PowerShell
Get-ZertoVpg [-statuses] [<CommonParameters>] Get-ZertoVpg [-statuses] [<CommonParameters>]
``` ```
### subStatuses ### subStatuses
```
```PowerShell
Get-ZertoVpg [-subStatuses] [<CommonParameters>] Get-ZertoVpg [-subStatuses] [<CommonParameters>]
``` ```
### filter ### filter
```
```PowerShell
Get-ZertoVpg [-name <String>] [-status <String>] [-subStatus <String>] [-protectedSiteType <String>] Get-ZertoVpg [-name <String>] [-status <String>] [-subStatus <String>] [-protectedSiteType <String>]
[-recoverySiteType <String>] [-protectedSiteIdentifier <String>] [-recoverySiteIdentifier <String>] [-recoverySiteType <String>] [-protectedSiteIdentifier <String>] [-recoverySiteIdentifier <String>]
[-organizationName <String>] [-zorgIdentifier <String>] [-priority <String>] [-organizationName <String>] [-zorgIdentifier <String>] [-priority <String>]
@@ -77,18 +89,21 @@ Get-ZertoVpg [-name <String>] [-status <String>] [-subStatus <String>] [-protect
``` ```
## DESCRIPTION ## DESCRIPTION
returns information about VPGs returns information about VPGs
## EXAMPLES ## EXAMPLES
### Example 1 ### Example 1
```powershell ```powershell
PS C:\> Get-ZertoVpg PS C:\> Get-ZertoVpg
``` ```
Returns information about all VPGs in the site processing the request Returns information about all VPGs in the site processing the request
### Example 1 ### Example 2
```powershell ```powershell
PS C:\> Get-ZertoVpg -name "MyVpg" PS C:\> Get-ZertoVpg -name "MyVpg"
``` ```
@@ -98,6 +113,7 @@ Returns information about VPG with the name "MyVpg"
## PARAMETERS ## PARAMETERS
### -backupEnabled ### -backupEnabled
If backup is enabled. If backup is enabled.
```yaml ```yaml
@@ -113,6 +129,7 @@ Accept wildcard characters: False
``` ```
### -checkpoints ### -checkpoints
Return checkpoints for the selected Virtual Protection Group. Return checkpoints for the selected Virtual Protection Group.
```yaml ```yaml
@@ -128,6 +145,7 @@ Accept wildcard characters: False
``` ```
### -checkpointsStats ### -checkpointsStats
Return earliest and latest checkpoints for the selected Virtual Protection Group Return earliest and latest checkpoints for the selected Virtual Protection Group
```yaml ```yaml
@@ -143,6 +161,7 @@ Accept wildcard characters: False
``` ```
### -endDate ### -endDate
Return checkpoints before the specified start date. 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'. 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. Adding Z to the end of the time sets the time to UTC.
@@ -160,6 +179,7 @@ Accept wildcard characters: False
``` ```
### -entityTypes ### -entityTypes
Return Valid VPG entityTypes Return Valid VPG entityTypes
```yaml ```yaml
@@ -175,6 +195,7 @@ Accept wildcard characters: False
``` ```
### -failoverCommitPolicies ### -failoverCommitPolicies
Valid Failover Commit Policies Valid Failover Commit Policies
```yaml ```yaml
@@ -190,6 +211,7 @@ Accept wildcard characters: False
``` ```
### -failoverShutdownPolicies ### -failoverShutdownPolicies
Valid Failover Shutdown Policies Valid Failover Shutdown Policies
```yaml ```yaml
@@ -205,6 +227,7 @@ Accept wildcard characters: False
``` ```
### -name ### -name
The name of the VPG. The name of the VPG.
```yaml ```yaml
@@ -220,6 +243,7 @@ Accept wildcard characters: False
``` ```
### -organizationName ### -organizationName
The ZORG for this VPG. The ZORG for this VPG.
```yaml ```yaml
@@ -235,6 +259,7 @@ Accept wildcard characters: False
``` ```
### -priorities ### -priorities
Valid VPG priorities Valid VPG priorities
```yaml ```yaml
@@ -250,6 +275,7 @@ Accept wildcard characters: False
``` ```
### -priority ### -priority
The VPG priority. The VPG priority.
Possible values are: '0' or 'Low', '1' or 'Medium', '2' or 'High' Possible values are: '0' or 'Low', '1' or 'Medium', '2' or 'High'
@@ -266,6 +292,7 @@ Accept wildcard characters: False
``` ```
### -protectedSiteIdentifier ### -protectedSiteIdentifier
The identifier of the protected site where the VPG virtual machines are protected. The identifier of the protected site where the VPG virtual machines are protected.
```yaml ```yaml
@@ -281,6 +308,7 @@ Accept wildcard characters: False
``` ```
### -protectedSiteType ### -protectedSiteType
The protected site environment. The protected site environment.
This filter behaves in the same way as the sourceType filter. This filter behaves in the same way as the sourceType filter.
Please see Zerto API Documentation for vaild values and discriptions. Please see Zerto API Documentation for vaild values and discriptions.
@@ -298,6 +326,7 @@ Accept wildcard characters: False
``` ```
### -protectionGroupIdentifier ### -protectionGroupIdentifier
The identifier(s) of the Virtual Protection Group to return The identifier(s) of the Virtual Protection Group to return
```yaml ```yaml
@@ -313,6 +342,7 @@ Accept wildcard characters: False
``` ```
### -recoverySiteIdentifier ### -recoverySiteIdentifier
The identifier of the protected site where the VPG virtual machines are recovered. The identifier of the protected site where the VPG virtual machines are recovered.
```yaml ```yaml
@@ -328,6 +358,7 @@ Accept wildcard characters: False
``` ```
### -recoverySiteType ### -recoverySiteType
The recovery site environment. The recovery site environment.
This filter behaves in the same way as the sourceType filter. This filter behaves in the same way as the sourceType filter.
Please see Zerto API Documentation for vaild values and discriptions. Please see Zerto API Documentation for vaild values and discriptions.
@@ -345,6 +376,7 @@ Accept wildcard characters: False
``` ```
### -retentionPolicies ### -retentionPolicies
Valid retention policies Valid retention policies
```yaml ```yaml
@@ -360,6 +392,7 @@ Accept wildcard characters: False
``` ```
### -serviceProfileIdentifier ### -serviceProfileIdentifier
The identifier of the service profile to use for the VPG when a Zerto Cloud Manager is used. The identifier of the service profile to use for the VPG when a Zerto Cloud Manager is used.
```yaml ```yaml
@@ -375,6 +408,7 @@ Accept wildcard characters: False
``` ```
### -startDate ### -startDate
Return checkpoints after the specified start date. 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'. 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. Adding Z to the end of the time sets the time to UTC.
@@ -392,6 +426,7 @@ Accept wildcard characters: False
``` ```
### -status ### -status
The status of the VPG. The status of the VPG.
Please use 'Get-ZertoVpg -statuses' for valid values Please use 'Get-ZertoVpg -statuses' for valid values
@@ -408,6 +443,7 @@ Accept wildcard characters: False
``` ```
### -statuses ### -statuses
Valid VPG statuses Valid VPG statuses
```yaml ```yaml
@@ -423,6 +459,7 @@ Accept wildcard characters: False
``` ```
### -subStatus ### -subStatus
The substatus of the VPG. The substatus of the VPG.
Please use 'Get-ZertoVpg -substatuses' for valid values Please use 'Get-ZertoVpg -substatuses' for valid values
@@ -439,6 +476,7 @@ Accept wildcard characters: False
``` ```
### -subStatuses ### -subStatuses
Valid VPG sub statuses Valid VPG sub statuses
```yaml ```yaml
@@ -454,6 +492,7 @@ Accept wildcard characters: False
``` ```
### -zorgIdentifier ### -zorgIdentifier
The internal identifier for the ZORG. The internal identifier for the ZORG.
```yaml ```yaml
@@ -469,14 +508,19 @@ Accept wildcard characters: False
``` ```
### CommonParameters ### 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). 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 ## INPUTS
### None ### None
## OUTPUTS ## OUTPUTS
### System.Object ### System.Object
JSON data returned from the API as a PowerShell object containing settings for the selected VPG(s).
## NOTES ## NOTES
## RELATED LINKS ## RELATED LINKS
docs/Remove-ZertoVpg.md
+67 -13
View File
@@ -8,21 +8,32 @@ schema: 2.0.0
# Remove-ZertoVpg # Remove-ZertoVpg
## SYNOPSIS ## SYNOPSIS
Deletes a Zerto Virtual Protection Group Deletes a Zerto Virtual Protection Group
## SYNTAX ## SYNTAX
``` ### vpgIdentifier (Default)
Remove-ZertoVpg [-vpgName] <String> [-keepRecoveryVolumes <Boolean>] [-force <Boolean>] [-WhatIf] [-Confirm]
```PowerShell
Remove-ZertoVpg -vpgidentifier <String[]> [-keepRecoveryVolumes] [-force] [-WhatIf] [-Confirm]
[<CommonParameters>] [<CommonParameters>]
``` ```
### vpgName
```PowerShell
Remove-ZertoVpg [-vpgName] <String[]> [-keepRecoveryVolumes] [-force] [-WhatIf] [-Confirm] [<CommonParameters>]
```
## DESCRIPTION ## DESCRIPTION
Deletes a Zerto Virtual Protection Group. Deletes a Zerto Virtual Protection Group.
## EXAMPLES ## EXAMPLES
### Example 1 ### Example 1
```powershell ```powershell
PS C:\> Remove-ZertoVpg -vpgName "MyVpg" PS C:\> Remove-ZertoVpg -vpgName "MyVpg"
``` ```
@@ -30,19 +41,37 @@ PS C:\> Remove-ZertoVpg -vpgName "MyVpg"
Deletes Zerto Virtual Protection Group named "MyVpg". Recovery volumes at the recovery site will be deleted. Deletes Zerto Virtual Protection Group named "MyVpg". Recovery volumes at the recovery site will be deleted.
### Example 2 ### Example 2
```powershell ```powershell
PS C:\> Remove-ZertoVpg -vpgName "MyVpg" -keepRecoveryVolumes PS C:\> Remove-ZertoVpg -vpgName "MyVpg", "MyOtherVpg" -keepRecoveryVolumes
``` ```
Deletes Zerto Virtual Protection Group named "MyVpg". Recovery volumes at the recovery site will be retained. Deletes Zerto Virtual Protection Groups named "MyVpg" and "MyOtherVpg." Recovery volumes at the recovery site will be retained for both VPGs.
### Example 3
```powershell
PS C:\> Remove-ZertoVpg -vpgIdentifier "MyVpgIdentifier" -keepRecoveryVolumes
```
Deletes Zerto Virtual Protection Group with vpgIdentifier "MyVpgIdentifier". Recovery volumes at the recovery site will be retained.
### Example 4
```powershell
PS C:\> Get-ZertoVpg -recoverySiteIdentifier "MyRecoverySiteIdentifier" | Remove-ZertoVpg
```
Uses the `Get-ZertoVpg` function to get all VPGs currently being protected to recovery site with identifier "MyRecoverySiteIdentifier." This information is piped into the `Remove-ZertoVpg` function and will remove all VPGs being protected to the specified recovery site.
## PARAMETERS ## PARAMETERS
### -force ### -force
Use this parameter to force delete the VPG, by setting this parameter equal to true.
Use this switch to force delete the VPG. If unused, a non-forced remove vpg operation will be executed.
```yaml ```yaml
Type: Boolean Type: SwitchParameter
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
@@ -54,10 +83,11 @@ Accept wildcard characters: False
``` ```
### -keepRecoveryVolumes ### -keepRecoveryVolumes
Use this parameter to keep the recovery volumes at the target site, by setting it to True. If the virtual machines in the deleted VPG are re-protected, these volumes can be used as pre-seed volumes to speed up the initial synchronization of the new VPG. Default is to remove Recovery Volumes
Use this switch to keep the recovery volumes at the target site. If the virtual machines in the deleted VPG are re-protected, these volumes can be used as pre-seed volumes to speed up the initial synchronization of the new VPG. If this switch is not set, recovery volumes will not be retained. If required to be retained, get the path to these volumes prior to the deletion to use as pre-seed volumes for an easier operation.
```yaml ```yaml
Type: Boolean Type: SwitchParameter
Parameter Sets: (All) Parameter Sets: (All)
Aliases: Aliases:
@@ -68,22 +98,40 @@ Accept pipeline input: False
Accept wildcard characters: False Accept wildcard characters: False
``` ```
### -vpgName ### -vpgidentifier
Name of the VPG to delete.
vpgIdentifier(s) of the VPG(s) to delete.
```yaml ```yaml
Type: String Type: String[]
Parameter Sets: (All) Parameter Sets: vpgIdentifier
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False
```
### -vpgName
Name(s) of the VPG(s) to delete.
```yaml
Type: String[]
Parameter Sets: vpgName
Aliases: Aliases:
Required: True Required: True
Position: 0 Position: 0
Default value: None Default value: None
Accept pipeline input: False Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False Accept wildcard characters: False
``` ```
### -Confirm ### -Confirm
Prompts you for confirmation before running the cmdlet. Prompts you for confirmation before running the cmdlet.
```yaml ```yaml
@@ -99,6 +147,7 @@ Accept wildcard characters: False
``` ```
### -WhatIf ### -WhatIf
Shows what would happen if the cmdlet runs. Shows what would happen if the cmdlet runs.
The cmdlet is not run. The cmdlet is not run.
@@ -115,14 +164,19 @@ Accept wildcard characters: False
``` ```
### CommonParameters ### 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). 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 ## INPUTS
### None ### None
## OUTPUTS ## OUTPUTS
### System.Object ### System.Object
Task Identifier of the Remove operation
## NOTES ## NOTES
## RELATED LINKS ## RELATED LINKS