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

Update for explicit switches

Browse Source
This commit is contained in:
Wes Carroll
2020-05-09 16:05:54 -04:00
parent 1e678214b1
commit 804a60be77
1 changed files with 34 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/Invoke-ZertoMoveCommit.md
+34 -11
View File
@@ -12,9 +12,19 @@ Commit a VPG currently undergoing a move operation.
## SYNTAX
### Main (Default)
```
Invoke-ZertoMoveCommit [-vpgName] <String[]> [-reverseProtection] [-keepSourceVms] [-WhatIf] [-Confirm]
[<CommonParameters>]
Invoke-ZertoMoveCommit -vpgName <String[]> [-WhatIf] [-Confirm] [<CommonParameters>]
```
### ReverseProtect
```
Invoke-ZertoMoveCommit -vpgName <String[]> [-reverseProtection] [-WhatIf] [-Confirm] [<CommonParameters>]
```
### KeepSource
```
Invoke-ZertoMoveCommit -vpgName <String[]> [-keepSourceVms] [-WhatIf] [-Confirm] [<CommonParameters>]
```
## 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