From 804a60be774f82f72ade38b1e6bf9fb75e7b595e Mon Sep 17 00:00:00 2001 From: Wes Carroll Date: Sat, 9 May 2020 16:05:54 -0400 Subject: [PATCH] Update for explicit switches --- docs/Invoke-ZertoMoveCommit.md | 45 +++++++++++++++++++++++++--------- 1 file changed, 34 insertions(+), 11 deletions(-) diff --git a/docs/Invoke-ZertoMoveCommit.md b/docs/Invoke-ZertoMoveCommit.md index 08c6e92..c298a0f 100644 --- a/docs/Invoke-ZertoMoveCommit.md +++ b/docs/Invoke-ZertoMoveCommit.md @@ -12,9 +12,19 @@ Commit a VPG currently undergoing a move operation. ## SYNTAX +### Main (Default) ``` -Invoke-ZertoMoveCommit [-vpgName] [-reverseProtection] [-keepSourceVms] [-WhatIf] [-Confirm] - [] +Invoke-ZertoMoveCommit -vpgName [-WhatIf] [-Confirm] [] +``` + +### ReverseProtect +``` +Invoke-ZertoMoveCommit -vpgName [-reverseProtection] [-WhatIf] [-Confirm] [] +``` + +### KeepSource +``` +Invoke-ZertoMoveCommit -vpgName [-keepSourceVms] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -27,20 +37,33 @@ Commit a VPG currently undergoing a move operation. PS C:\> Invoke-ZertoMoveCommit -vpgName "MyVpg" ``` -Commit VPG "MyVpg" after a move has been started. +Commit VPG "MyVpg" after a move operation has been completed. This commit process with use the `-KeepSourceVms` or `-ReverseProtection` selection made during the move initation. + +### Example 2 +```powershell +PS C:\> Invoke-ZertoMoveCommit -vpgName "MyVpg" -keepSourceVms +``` + +Commit VPG "MyVpg" after a move operation has been completed specifying to keep the vms at the source location and NOT reverse protection. This commit process will overrule any reverse protection or keep source vms selection made during the move initiation. + +### Example 3 +```powershell +PS C:\> Invoke-ZertoMoveCommit -vpgName "MyVpg" -reverseProtection +``` + +Commit VPG "MyVpg" after a move operation has been completed specifying to reverse protection of the VMs back to the source location. The VMs at the source location will be removed from inventory at the source location and the disks will be used as pre-seed volumes. This commit process will overrule any reverse protection or keep source vms selection made during the move initiation. ## PARAMETERS ### -keepSourceVms -Use this switch to keep the source VMs. -If not set, they will be destroyed. +"Use this switch to keep the source VMs at the source site. If neither 'ReverseProtction' nor 'KeepSourceVms' switch is specified, the commit process will use selection made during move initiation." ```yaml Type: SwitchParameter -Parameter Sets: (All) +Parameter Sets: KeepSource Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -48,14 +71,14 @@ Accept wildcard characters: False ``` ### -reverseProtection -Set this to True to reverse protect the VPG(s) to the source site. If not set, will use selection made during move initiation. True or False +"Use this switch to reverse protect the VPG(s) to the source site. If neither 'ReverseProtction' nor 'KeepSourceVms' switch is specified, the commit process will use selection made during move initiation." ```yaml Type: SwitchParameter -Parameter Sets: (All) +Parameter Sets: ReverseProtect Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -71,7 +94,7 @@ Parameter Sets: (All) Aliases: Required: True -Position: 0 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False