From 38a9f69c76ef9a0bc689d9058316a46b738623fa Mon Sep 17 00:00:00 2001 From: Wes Carroll Date: Tue, 12 Mar 2019 15:45:05 -0400 Subject: [PATCH] Updated Help Docs for Remove-ZertoVpg --- .../Public/en-us/ZertoApiWrapper-help.xml | 149 ++++++++++++++---- docs/Get-ZertoVpg.md | 74 +++++++-- docs/Remove-ZertoVpg.md | 80 ++++++++-- 3 files changed, 242 insertions(+), 61 deletions(-) diff --git a/ZertoApiWrapper/Public/en-us/ZertoApiWrapper-help.xml b/ZertoApiWrapper/Public/en-us/ZertoApiWrapper-help.xml index d3be543..1ae92cc 100644 --- a/ZertoApiWrapper/Public/en-us/ZertoApiWrapper-help.xml +++ b/ZertoApiWrapper/Public/en-us/ZertoApiWrapper-help.xml @@ -5015,7 +5015,7 @@ System.Object - + JSON data returned from the API as a PowerShell object containing settings for the selected VPG(s). @@ -5033,7 +5033,7 @@ - -------------------------- Example 1 -------------------------- + -------------------------- Example 2 -------------------------- PS C:\> Get-ZertoVpg -name "MyVpg" Returns information about VPG with the name "MyVpg" @@ -9664,26 +9664,13 @@ Remove-ZertoVpg - - vpgName - - Name of the VPG to delete. - - String - - String - - - None - 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. - Boolean - Boolean + SwitchParameter False @@ -9691,11 +9678,81 @@ 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. - Boolean - Boolean + SwitchParameter + + + False + + + vpgidentifier + + vpgIdentifier(s) of the VPG(s) to delete. + + String[] + + String[] + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + + Remove-ZertoVpg + + vpgName + + Name(s) of the VPG(s) to delete. + + String[] + + String[] + + + None + + + force + + Use this switch to force delete the VPG. If unused, a non-forced remove vpg operation will be executed. + + + SwitchParameter + + + False + + + keepRecoveryVolumes + + 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. + + + SwitchParameter False @@ -9728,11 +9785,11 @@ 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. - Boolean + SwitchParameter - Boolean + SwitchParameter False @@ -9740,23 +9797,35 @@ 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. - Boolean + SwitchParameter - Boolean + SwitchParameter False - + + vpgidentifier + + vpgIdentifier(s) of the VPG(s) to delete. + + String[] + + String[] + + + None + + vpgName - Name of the VPG to delete. + Name(s) of the VPG(s) to delete. - String + String[] - String + String[] None @@ -9802,7 +9871,7 @@ System.Object - + Task Identifier of the Remove operation @@ -9821,9 +9890,23 @@ -------------------------- Example 2 -------------------------- - 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 -------------------------- + 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 -------------------------- + 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. diff --git a/docs/Get-ZertoVpg.md b/docs/Get-ZertoVpg.md index 9acdbd1..299b221 100644 --- a/docs/Get-ZertoVpg.md +++ b/docs/Get-ZertoVpg.md @@ -8,68 +8,80 @@ schema: 2.0.0 # Get-ZertoVpg ## SYNOPSIS + Returns information about VPGs ## SYNTAX ### main (Default) -``` + +```PowerShell Get-ZertoVpg [] ``` ### stats -``` + +```PowerShell Get-ZertoVpg -protectionGroupIdentifier [-checkpointsStats] [] ``` ### checkpoints -``` -Get-ZertoVpg -protectionGroupIdentifier [-checkpoints] [-startDate ] [-endDate ] - [] + +```PowerShell +Get-ZertoVpg -protectionGroupIdentifier [-checkpoints] [-startDate ] [-endDate ] [] ``` ### protectionGroupIdentifier -``` + +```PowerShell Get-ZertoVpg -protectionGroupIdentifier [] ``` ### entityTypes -``` + +```PowerShell Get-ZertoVpg [-entityTypes] [] ``` ### failoverCommitPolicies -``` + +```PowerShell Get-ZertoVpg [-failoverCommitPolicies] [] ``` ### failoverShutdownPolicies -``` + +```PowerShell Get-ZertoVpg [-failoverShutdownPolicies] [] ``` ### priorities -``` + +```PowerShell Get-ZertoVpg [-priorities] [] ``` ### retentionPolicies -``` + +```PowerShell Get-ZertoVpg [-retentionPolicies] [] ``` ### statuses -``` + +```PowerShell Get-ZertoVpg [-statuses] [] ``` ### subStatuses -``` + +```PowerShell Get-ZertoVpg [-subStatuses] [] ``` ### filter -``` + +```PowerShell Get-ZertoVpg [-name ] [-status ] [-subStatus ] [-protectedSiteType ] [-recoverySiteType ] [-protectedSiteIdentifier ] [-recoverySiteIdentifier ] [-organizationName ] [-zorgIdentifier ] [-priority ] @@ -77,18 +89,21 @@ Get-ZertoVpg [-name ] [-status ] [-subStatus ] [-protect ``` ## 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 1 +### Example 2 + ```powershell PS C:\> Get-ZertoVpg -name "MyVpg" ``` @@ -98,6 +113,7 @@ Returns information about VPG with the name "MyVpg" ## PARAMETERS ### -backupEnabled + If backup is enabled. ```yaml @@ -113,6 +129,7 @@ Accept wildcard characters: False ``` ### -checkpoints + Return checkpoints for the selected Virtual Protection Group. ```yaml @@ -128,6 +145,7 @@ Accept wildcard characters: False ``` ### -checkpointsStats + Return earliest and latest checkpoints for the selected Virtual Protection Group ```yaml @@ -143,6 +161,7 @@ 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. @@ -160,6 +179,7 @@ Accept wildcard characters: False ``` ### -entityTypes + Return Valid VPG entityTypes ```yaml @@ -175,6 +195,7 @@ Accept wildcard characters: False ``` ### -failoverCommitPolicies + Valid Failover Commit Policies ```yaml @@ -190,6 +211,7 @@ Accept wildcard characters: False ``` ### -failoverShutdownPolicies + Valid Failover Shutdown Policies ```yaml @@ -205,6 +227,7 @@ Accept wildcard characters: False ``` ### -name + The name of the VPG. ```yaml @@ -220,6 +243,7 @@ Accept wildcard characters: False ``` ### -organizationName + The ZORG for this VPG. ```yaml @@ -235,6 +259,7 @@ Accept wildcard characters: False ``` ### -priorities + Valid VPG priorities ```yaml @@ -250,6 +275,7 @@ Accept wildcard characters: False ``` ### -priority + The VPG priority. Possible values are: '0' or 'Low', '1' or 'Medium', '2' or 'High' @@ -266,6 +292,7 @@ Accept wildcard characters: False ``` ### -protectedSiteIdentifier + The identifier of the protected site where the VPG virtual machines are protected. ```yaml @@ -281,6 +308,7 @@ 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. @@ -298,6 +326,7 @@ Accept wildcard characters: False ``` ### -protectionGroupIdentifier + The identifier(s) of the Virtual Protection Group to return ```yaml @@ -313,6 +342,7 @@ Accept wildcard characters: False ``` ### -recoverySiteIdentifier + The identifier of the protected site where the VPG virtual machines are recovered. ```yaml @@ -328,6 +358,7 @@ 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. @@ -345,6 +376,7 @@ Accept wildcard characters: False ``` ### -retentionPolicies + Valid retention policies ```yaml @@ -360,6 +392,7 @@ Accept wildcard characters: False ``` ### -serviceProfileIdentifier + The identifier of the service profile to use for the VPG when a Zerto Cloud Manager is used. ```yaml @@ -375,6 +408,7 @@ 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. @@ -392,6 +426,7 @@ Accept wildcard characters: False ``` ### -status + The status of the VPG. Please use 'Get-ZertoVpg -statuses' for valid values @@ -408,6 +443,7 @@ Accept wildcard characters: False ``` ### -statuses + Valid VPG statuses ```yaml @@ -423,6 +459,7 @@ Accept wildcard characters: False ``` ### -subStatus + The substatus of the VPG. Please use 'Get-ZertoVpg -substatuses' for valid values @@ -439,6 +476,7 @@ Accept wildcard characters: False ``` ### -subStatuses + Valid VPG sub statuses ```yaml @@ -454,6 +492,7 @@ Accept wildcard characters: False ``` ### -zorgIdentifier + The internal identifier for the ZORG. ```yaml @@ -469,14 +508,19 @@ 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 diff --git a/docs/Remove-ZertoVpg.md b/docs/Remove-ZertoVpg.md index 1a3b0b4..9fba18b 100644 --- a/docs/Remove-ZertoVpg.md +++ b/docs/Remove-ZertoVpg.md @@ -8,21 +8,32 @@ schema: 2.0.0 # Remove-ZertoVpg ## SYNOPSIS + Deletes a Zerto Virtual Protection Group ## SYNTAX -``` -Remove-ZertoVpg [-vpgName] [-keepRecoveryVolumes ] [-force ] [-WhatIf] [-Confirm] +### vpgIdentifier (Default) + +```PowerShell +Remove-ZertoVpg -vpgidentifier [-keepRecoveryVolumes] [-force] [-WhatIf] [-Confirm] [] ``` +### vpgName + +```PowerShell +Remove-ZertoVpg [-vpgName] [-keepRecoveryVolumes] [-force] [-WhatIf] [-Confirm] [] +``` + ## DESCRIPTION + Deletes a Zerto Virtual Protection Group. ## EXAMPLES ### Example 1 + ```powershell 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. ### Example 2 + ```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 ### -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 -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) Aliases: @@ -54,10 +83,11 @@ Accept wildcard characters: False ``` ### -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 -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) Aliases: @@ -68,22 +98,40 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -vpgName -Name of the VPG to delete. +### -vpgidentifier + +vpgIdentifier(s) of the VPG(s) to delete. ```yaml -Type: String -Parameter Sets: (All) +Type: String[] +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: Required: True Position: 0 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml @@ -99,6 +147,7 @@ Accept wildcard characters: False ``` ### -WhatIf + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -115,14 +164,19 @@ 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 + +Task Identifier of the Remove operation + ## NOTES ## RELATED LINKS