commands

^

Remove-DbaAgentAlertCategory

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

 

Synopsis

Remove-DbaAgentAlertCategory removes an alert category.

Description

Remove-DbaAgentAlertCategory makes it possible to remove an alert category. Insure that the category you want to remove is not used with any alerts. If an alert uses this category it will be get the category [Uncategorized].

Syntax

Remove-DbaAgentAlertCategory
    [-SqlInstance] <DbaInstanceParameter[]>
    [[-SqlCredential] <PSCredential>]
    [[-Category] <String[]>]
    [-Force]
    [-EnableException]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

 

Examples

 

Example: 1
PS C:\> Remove-DbaAgentAlertCategory -SqlInstance sql1 -Category 'Category 1'

Remove the alert category Category 1 from the instance.

Example: 2
PS C:\> Remove-DbaAgentAlertCategory -SqlInstance sql1 -Category Category1, Category2, Category3

Remove multiple alert categories from the instance.

Example: 3
PS C:\> Remove-DbaAgentAlertCategory -SqlInstance sql1, sql2, sql3 -Category Category1, Category2, Category3

Remove multiple alert categories from the multiple instances.

Required Parameters

-SqlInstance

The target SQL Server instance or instances. You must have sysadmin access and server version must be SQL Server version 2000 or greater.

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

Alias
Required False
Pipeline false
Default Value
-Force

The force parameter will ignore some errors in the parameters and assume defaults.

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

Shows what would happen if the command were to run. No actions are actually performed.

Alias wi
Required False
Pipeline false
Default Value
-Confirm

Prompts you for confirmation before executing any changing operations within the command.

Alias cf
Required False
Pipeline false
Default Value

 

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