Files
ZertoApiWrapper/docs/Start-ZertoFailoverTest.md
T
2019-04-06 23:50:53 -04:00

2.8 KiB

external help file, Module Name, online version, schema
external help file Module Name online version schema
ZertoApiWrapper-help.xml ZertoApiWrapper https://github.com/wcarroll/ZertoApiWrapper/blob/master/docs/Start-ZertoFailoverTest.md 2.0.0

Start-ZertoFailoverTest

SYNOPSIS

Start a Test Failover of a specific Virtual Protection Group

SYNTAX

Start-ZertoFailoverTest [-vpgName] <String> [[-checkpointIdentifier] <String>] [[-vmName] <String[]>] [-WhatIf]
 [-Confirm] [<CommonParameters>]

DESCRIPTION

Start a Test Failover of a specific Virtual Protection Group

EXAMPLES

Example 1

PS C:\> Start-ZertoFailoverTest -vpgName "MyVpg"

Starts a Failover test of a Virtual Protection Group "MyVpg" at the latest checkpoint with all virtual machines.

PARAMETERS

-checkpointIdentifier

The identifier of the checkpoint to use for testing. If unspecified, the latest checkpoint will be used.

Type: String
Parameter Sets: (All)
Aliases: checkpointId

Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-vmName

The name(s) of the VMs within the selected VPG you wish to test. If unspecified, all VMs in the VPG will be tested.

Type: String[]
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-vpgName

Name of VPG to failover test

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Confirm

Prompts you for confirmation before running the cmdlet.

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.

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).

INPUTS

None

OUTPUTS

System.Object

NOTES

Zerto REST API VPG End Point Documentation