Get-DbaAgentAlert

Want to see the source code for this command? Check out Get-DbaAgentAlert on GitHub.
Want to see the Bill Of Health for this command? Check out Get-DbaAgentAlert.

Synopsis

Returns SQL Agent alerts on a SQL Server Agent.

Description

This function returns SQL Agent alerts.

Syntax

Get-DbaAgentAlert
    [-SqlInstance] <DbaInstanceParameter[]>
    [[-SqlCredential] <PSCredential>]
    [[-Alert] <String[]>]
    [[-ExcludeAlert] <String[]>]
    [-EnableException]
    [<CommonParameters>]

Examples

Example: 1

PS C:\> Get-DbaAgentAlert -SqlInstance ServerA,ServerB\instanceB

Returns all SQL Agent alerts on serverA and serverB\instanceB

Example: 2

PS C:\> Get-DbaAgentAlert -SqlInstance ServerA,ServerB\instanceB -Alert MyAlert*

Returns SQL Agent alert on serverA and serverB\instanceB whose names match 'MyAlert*'

Example: 3

PS C:\> 'serverA','serverB\instanceB' | Get-DbaAgentAlert

Returns all SQL Agent alerts on serverA and serverB\instanceB

Required Parameters

-SqlInstance

The target SQL Server instance or instances. This can be a collection and receive pipeline input to allow the function to be executed against multiple SQL Server instances.

Optional Parameters

-SqlCredential

Login to the target instance using alternative credentials. Accepts PowerShell credentials (Get-Credential). Windows Authentication, SQL Server Authentication, Active Directory - Password, and Active Directory - Integrated are all supported. For MFA support, please use Connect-DbaInstance.

-Alert

The name of the alerts to return. If null, will get all alerts from the server. Note - this parameter accepts wildcards.

-ExcludeAlert

The name of the alerts to exclude. If not provided, no alerts will be excluded. Note - this parameter accepts wildcards.

-EnableException

By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message. This avoids overwhelming you with "sea of red" exceptions, but is inconvenient because it basically disables advanced scripting. Using this switch turns this "nice by default" feature off and enables you to catch exceptions with your own try/catch.