--- external help file: ZertoApiWrapper-help.xml Module Name: ZertoApiWrapper online version: https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Get-ZertoAlert.md schema: 2.0.0 --- # Get-ZertoAlert ## SYNOPSIS Get Alerts from the Zerto Virtual Manager ## SYNTAX ### main (Default) ``` Get-ZertoAlert [] ``` ### alertId ``` Get-ZertoAlert -alertId [] ``` ### entities ``` Get-ZertoAlert [-entities] [] ``` ### helpIdentifiers ``` Get-ZertoAlert [-helpIdentifiers] [] ``` ### levels ``` Get-ZertoAlert [-levels] [] ``` ### filter ``` Get-ZertoAlert [-startDate ] [-endDate ] [-vpgIdentifier ] [-siteIdentifier ] [-zorgIdentifier ] [-level ] [-helpIdentifier ] [-entity ] [-isDismissed ] [] ``` ## DESCRIPTION This function will return all alerts from the Zerto Virtual Manager when called witout any parameters. When the filter parameter set is used it will return any alerts that suit the passed criteria depending on the parameters that are defined. The parameters are combined with "AND" logic so it will only return alerts that meet all the criteria passed. Any of the other parameter sets used will return valid settings for each setting type. ## EXAMPLES ### Example 1 ```powershell PS C:\> Get-ZertoAlert ``` Returns all current alerts. ### Example 2 ```powershell PS C:\> Get-ZertoAlert -startDate "2019-02-01T08:00:00.000" -endDate "2019-02-02T20:30:00.000" ``` Returns all alerts that were started after Feb. 01, 2019 8 AM ZVM local time and Feb. 02 2019 8 PM ZVM local time. ### Example 3 ```powershell PS C:\> Get-ZertoAlert -alertId "Need to Fill This In" ``` Returns information on the alert with alert identifier "Need to Fill This In" ### Example 4 ```powershell PS C:\> Get-ZertoAlert -entities ``` Returns entities information ### Example 5 ```powershell PS C:\> Get-ZertoAlert -helpIdentifiers ``` Returns Help Identifiers information ### Example 6 ```powershell PS C:\> Get-ZertoAlert -levels ``` Returns information about alert levels ## PARAMETERS ### -alertId AlertId or array of AlertIds to be queried ```yaml Type: String[] Parameter Sets: alertId Aliases: Required: True Position: Named Default value: None Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` ### -endDate Returns Alerts before the End Date. Provide the string in the format of 'yyyy-MM-ddTHH:mm:ss.fff' ```yaml Type: String Parameter Sets: filter Aliases: Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -entities Switch to return the entities information from the API ```yaml Type: SwitchParameter Parameter Sets: entities Aliases: Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -entity Returns alerts for the specified entity ```yaml Type: String Parameter Sets: filter Aliases: Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -helpIdentifier Returns alerts for the specified helpIdentifier ```yaml Type: String Parameter Sets: filter Aliases: helpId Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -helpIdentifiers Switch to get the Help Identifiers information from the API ```yaml Type: SwitchParameter Parameter Sets: helpIdentifiers Aliases: Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -isDismissed Returns alerts that are dismissed when set to $true an undismissed alerts when set to $false ```yaml Type: Boolean Parameter Sets: filter Aliases: Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -level Returns alerts for the specified level ```yaml Type: String Parameter Sets: filter Aliases: Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -levels Switch to return Alert Levels information from the API ```yaml Type: SwitchParameter Parameter Sets: levels Aliases: Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -siteIdentifier Returns alerts for the specified siteIdentifier ```yaml Type: String Parameter Sets: filter Aliases: siteId Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -startDate Returns Alerts after the Start Date. Provide the string in the format of 'yyyy-MM-ddTHH:mm:ss.fff' ```yaml Type: String Parameter Sets: filter Aliases: Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -vpgIdentifier Returns alerts for the specified vraIdentifier ```yaml Type: String Parameter Sets: filter Aliases: vpgId Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -zorgIdentifier Returns alerts for the specified zorgIdentifier ```yaml Type: String Parameter Sets: filter Aliases: zorgId 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 ### System.String[] ## OUTPUTS ### System.Object ## NOTES ## RELATED LINKS [Zerto REST API Alerts End Point Documentation](http://s3.amazonaws.com/zertodownload_docs/Latest/Zerto%20Virtual%20Replication%20Zerto%20Virtual%20Manager%20%28ZVM%29%20-%20vSphere%20Online%20Help/index.html#page/RestfulAPIs%2FStatusAPIs.5.009.html%23)