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

Add WhatIf and second example

Browse Source
This commit is contained in:
Wes Carroll
2019-04-17 09:12:15 -04:00
parent 2186c26132
commit 902636c517
1 changed files with 41 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/Invoke-ZertoFailover.md
+41 -20
View File
@@ -14,8 +14,8 @@ Start a failover of a VPG
```
Invoke-ZertoFailover [-vpgName] <String> [[-checkpointIdentifier] <String>] [[-commitPolicy] <String>]
[[-commitValue] <String>] [[-shutdownPolicy] <Int32>] [[-timeToWaitBeforeShutdownInSec] <Int64>]
[[-reverseProtection] <Boolean>] [[-vmName] <String[]>] [<CommonParameters>]
[[-shutdownPolicy] <Int32>] [[-timeToWaitBeforeShutdownInSec] <Int32>] [[-reverseProtection] <Boolean>]
[[-vmName] <String[]>] [-WhatIf] [-Confirm] [<CommonParameters>]
```
## DESCRIPTION
@@ -30,6 +30,13 @@ PS C:\> Invoke-ZertoFailover -vpgName "MyVpg"
Start a failover of VPG "MyVpg" with the latest checkpoint and site default policies.
### Example 2
```powershell
PS C:\> Invoke-ZertoFailover -vpgName "MyVpg" -shutdownPolicy 2 -reverseProtection $false -commitPolicy 'Commit' -timeToWaitBeforeShutdownInSec 7200
```
Start a failover of VPG "MyVpg" with the latest checkpoint. VMs will attempt to be gracefully shutdown and if unsuccessful will be forcibly powered off. After 2 hours, if the VPG has not been committed or rolled back, the VPG will auto commit. Reverse protection will not be enabled.
## PARAMETERS
### -checkpointIdentifier
@@ -68,22 +75,6 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -commitValue
The amount of time in seconds the failover waits in a Before Commit state to enable checking that the failover is as required before performing the commitPolicy setting.
Default is the Site Setting
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -reverseProtection
True: Enable reverse protection.
The virtual machines are recovered on the recovery site and then protected using the default reverse protection settings.
@@ -128,10 +119,10 @@ Accept wildcard characters: False
```
### -timeToWaitBeforeShutdownInSec
Time, in seconds, before VMs are forcibly turned off if the Force Shutdown option is seclected after attempting to gracefully shut down the VMs
Time, in seconds, before the commitPolicy is invoked. Default setting is 3600 seconds (60 Minutes). Min value is 300 seconds (5 minutes). Max Value is 86,400 seconds (24 Hours).
```yaml
Type: Int64
Type: Int32
Parameter Sets: (All)
Aliases:
@@ -172,6 +163,36 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Confirm
Prompts you for confirmation before running the cmdlet.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: None
Accept pipeline input: False
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).