commands

^

Set-DbaAgentAlert

Author Garry Bargsley (@gbargsley), garrybargsley.com
Availability Windows, Linux, macOS

 

Synopsis

Set-DbaAgentAlert updates the status of a SQL Agent Alert.

Description

Set-DbaAgentAlert updates an alert in the SQL Server Agent with parameters supplied.

Syntax

Set-DbaAgentAlert
    [[-SqlInstance] <DbaInstanceParameter[]>]
    [[-SqlCredential] <PSCredential>]
    [[-Alert] <Object[]>]
    [[-NewName] <String>]
    [-Enabled]
    [-Disabled]
    [-Force]
    [[-InputObject] <Alert[]>]
    [-EnableException]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

 

Examples

 

Example: 1
PS C:\> Set-DbaAgentAlert -SqlInstance sql1 -Alert 'Severity 025: Fatal Error' -Disabled

Changes the alert to disabled.

Example: 2
PS C:\> Set-DbaAgentAlert -SqlInstance sql1 -Alert 'Severity 025: Fatal Error', 'Error Number 825', 'Error Number 824' -Enabled

Changes multiple alerts to enabled.

Example: 3
PS C:\> Set-DbaAgentAlert -SqlInstance sql1, sql2, sql3 -Alert 'Severity 025: Fatal Error', 'Error Number 825', 'Error Number 824' -Enabled

Changes multiple alerts to enabled on multiple servers.

Example: 4
PS C:\> Set-DbaAgentAlert -SqlInstance sql1 -Alert 'Severity 025: Fatal Error' -Disabled -WhatIf

Doesn't Change the alert but shows what would happen.

Optional 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 False
Pipeline false
Default Value
-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
-Alert

The name of the alert.

Alias
Required False
Pipeline false
Default Value
-NewName

The new name for the alert.

Alias
Required False
Pipeline false
Default Value
-Enabled

Enabled the alert.

Alias
Required False
Pipeline false
Default Value False
-Disabled

Disabled the alert.

Alias
Required False
Pipeline false
Default Value False
-Force

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

Alias
Required False
Pipeline false
Default Value False
-InputObject

Enables piping alert objects

Alias
Required False
Pipeline true (ByValue)
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
-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 Set-DbaAgentAlert on GitHub.
Want to see the Bill Of Health for this command? Check out Set-DbaAgentAlert.