Get-AuvikAlert

SYNOPSIS

Get Auvik alert events that have been triggered by your Auvik collector(s).

SYNTAX

indexByMultiAlertGeneral (Default)

Get-AuvikAlert [-tenants <String[]>] [-filter_alertDefinitionId <String>] [-filter_severity <String>]
 [-filter_status <String>] [-filter_entityId <String>] [-filter_dismissed] [-filter_dispatched]
 [-filter_detectedTimeAfter <DateTime>] [-filter_detectedTimeBefore <DateTime>] [-page_first <Int64>]
 [-page_after <String>] [-page_last <Int64>] [-page_before <String>] [-allPages] [<CommonParameters>]

indexBySingleAlertGeneral

Get-AuvikAlert -id <String> [<CommonParameters>]

DESCRIPTION

The Get-AuvikAlert cmdlet allows you to view the alert events that has been triggered by your Auvik collector(s).

EXAMPLES

EXAMPLE 1

Get-AuvikAlert

Pulls general information about the first 100 alerts Auvik has discovered

EXAMPLE 2

Get-AuvikAlert -id 123456789

Pulls general information for the defined alert Auvik has discovered

EXAMPLE 3

Get-AuvikAlert -page_first 1000 -allPages

Pulls general information for all alerts found by Auvik.

PARAMETERS

-id

ID of alert

Type: String
Parameter Sets: indexBySingleAlertGeneral
Aliases:

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

-tenants

Comma delimited list of tenant IDs to request info from

Type: String[]
Parameter Sets: indexByMultiAlertGeneral
Aliases:

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

-filter_alertDefinitionId

Filter by alert definition ID

Type: String
Parameter Sets: indexByMultiAlertGeneral
Aliases:

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

-filter_severity

Filter by alert severity

Allowed values: “unknown”, “emergency”, “critical”, “warning”, “info”

Type: String
Parameter Sets: indexByMultiAlertGeneral
Aliases:

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

-filter_status

Filter by the status of the alert

Allowed values: “created”, “resolved”, “paused”, “unpaused”

Type: String
Parameter Sets: indexByMultiAlertGeneral
Aliases:

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

-filter_entityId

Filter by the related entity ID

Type: String
Parameter Sets: indexByMultiAlertGeneral
Aliases:

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

-filter_dismissed

Filter by the dismissed status

As of 2023-10 this parameter does not appear to work

Type: SwitchParameter
Parameter Sets: indexByMultiAlertGeneral
Aliases:

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

-filter_dispatched

Filter by dispatched status

As of 2023-10 this parameter does not appear to work

Type: SwitchParameter
Parameter Sets: indexByMultiAlertGeneral
Aliases:

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

-filter_detectedTimeAfter

Filter by the time which is greater than the given timestamp

Type: DateTime
Parameter Sets: indexByMultiAlertGeneral
Aliases:

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

-filter_detectedTimeBefore

Filter by the time which is less than or equal to the given timestamp

Type: DateTime
Parameter Sets: indexByMultiAlertGeneral
Aliases:

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

-page_first

For paginated responses, the first N elements will be returned Used in combination with page[after]

Default Value: 100

Type: Int64
Parameter Sets: indexByMultiAlertGeneral
Aliases:

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

-page_after

Cursor after which elements will be returned as a page The page size is provided by page[first]

Type: String
Parameter Sets: indexByMultiAlertGeneral
Aliases:

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

-page_last

For paginated responses, the last N services will be returned Used in combination with page[before]