Files
ZertoApiWrapper/docs/Stop-ZertoFailoverTest.md
T
2020-04-04 10:26:56 -04:00

2.7 KiB

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

Stop-ZertoFailoverTest

SYNOPSIS

Stops a running Failover Test operation.

SYNTAX

Stop-ZertoFailoverTest [-vpgName] <String[]> [[-failoverTestSuccess] <Boolean>]
 [[-failoverTestSummary] <String>] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Stops a running Failover Test operation.

EXAMPLES

Example 1

PS C:\> Stop-ZertoFailoverTest -vpgName "MyVpg" -failoverTestSummary "All Good"

Stop Failover Test for virtual protection group "MyVpg" indicating a success and making a note of "All Good"

PARAMETERS

-failoverTestSuccess

Was the test successful? True or False. True is Default.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-failoverTestSummary

Free text field for any notes to add to the test report.

Type: String
Parameter Sets: (All)
Aliases:

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

-vpgName

Name(s) of VPG(s) to stop testing.

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.

INPUTS

None

OUTPUTS

System.Object

NOTES

Zerto REST API VPG End Point Documentation