commands

^

Get-DbaAgentAlertCategory

Author Patrick Flynn (@sqllensman)
Availability Windows, Linux, macOS

 

Synopsis

Get-DbaAgentAlertCategory retrieves the alert categories.

Description

Get-DbaAgentAlertCategory makes it possible to retrieve the alert categories.

Syntax

Get-DbaAgentAlertCategory
    [-SqlInstance] <DbaInstanceParameter[]>
    [[-SqlCredential] <PSCredential>]
    [[-Category] <String[]>]
    [-EnableException]
    [<CommonParameters>]

 

Examples

 

Example: 1
PS C:\> Get-DbaAgentAlertCategory -SqlInstance sql1

Return all the agent alert categories.

Example: 2
PS C:\> Get-DbaAgentAlertCategory -SqlInstance sql1 -Category 'Severity Alert'

Return all the agent alert categories that have the name 'Severity Alert'.

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.

Alias
Required True
Pipeline true (ByValue)
Default Value

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.

Alias
Required False
Pipeline false
Default Value
-Category

The name of the category to filter out. If no category is used all categories will be returned.

Alias
Required False
Pipeline false
Default Value
-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.

Alias
Required False
Pipeline false
Default Value False

 

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