Files
ZertoApiWrapper/docs/Set-ZertoAlert.md
T
2020-04-04 10:26:56 -04:00

2.9 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/Set-ZertoAlert.md 2.0.0

Set-ZertoAlert

SYNOPSIS

Dismisses or Undismisses a Zerto Alert

SYNTAX

dismiss

Set-ZertoAlert -alertId <String[]> [-dismiss] [-WhatIf] [-Confirm] [<CommonParameters>]

undismiss

Set-ZertoAlert -alertId <String[]> [-undismiss] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Dismisses or Undismisses a Zerto Alert

EXAMPLES

Example 1

PS C:\> Set-ZertoAlert -alertId "AlertId" -dismiss

Dismiss alert with alert identifier "AlertId"

Example 2

PS C:\> Set-ZertoAlert -alertId "AlertId" -undismiss

Undismiss alert with alert identifier "AlertId"

PARAMETERS

-alertId

Alert identifier(s) to be dismissed or undismissed.

Type: String[]
Parameter Sets: (All)
Aliases: alertIdentifier, identifier, id

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

-dismiss

Will dismiss the selected alert.

Type: SwitchParameter
Parameter Sets: dismiss
Aliases:

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

-undismiss

Will undismiss the selected alert.

Type: SwitchParameter
Parameter Sets: undismiss
Aliases:

Required: True
Position: Named
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

System.String[]

OUTPUTS

System.Object

NOTES

Zerto REST API Alerts End Point Documentation