< Back
Set-DbaAgentAlert
Post
NAME Set-DbaAgentAlert
SYNOPSIS
Set-DbaAgentAlert updates the status of a SQL Agent Alert.
SYNTAX
Set-DbaAgentAlert [[-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>] [[-SqlCredential]
<Pscredential>] [[-Alert] <System.Object[]>] [[-NewName] <String>] [-Enabled <Switch>] [-Disabled <Switch>]
[-Force <Switch>] [[-InputObject] <Microsoft.SqlServer.Management.Smo.Agent.Alert[]>] [-EnableException <Switch>]
[<CommonParameters>]
DESCRIPTION
Set-DbaAgentAlert updates an alert in the SQL Server Agent with parameters supplied.
PARAMETERS
-Alert [<System.Object[]>]
The name of the alert.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Disabled [<Switch>]
Disabled the alert.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Enabled [<Switch>]
Enabled the alert.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-EnableException [<Switch>]
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.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Force [<Switch>]
The force parameter will ignore some errors in the parameters and assume defaults.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-InputObject [<Microsoft.SqlServer.Management.Smo.Agent.Alert[]>]
Enables piping alert objects
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-NewName [<String>]
The new name for the alert.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-SqlCredential [<Pscredential>]
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.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-SqlInstance [<Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>]
The target SQL Server instance or instances. You must have sysadmin access and server version must be SQL
Server version 2000 or greater.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
NOTES
Tags: Agent, Alert
Author: Garry Bargsley (@gbargsley), garrybargsley.com
Website: https://dbatools.io
Copyright: (c) 2018 by dbatools, licensed under MIT
License: MIT https://opensource.org/licenses/MIT
-------------------------- 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.
RELATED LINKS
https://dbatools.io/Set-DbaAgentAlert
SYNOPSIS
Set-DbaAgentAlert updates the status of a SQL Agent Alert.
SYNTAX
Set-DbaAgentAlert [[-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>] [[-SqlCredential]
<Pscredential>] [[-Alert] <System.Object[]>] [[-NewName] <String>] [-Enabled <Switch>] [-Disabled <Switch>]
[-Force <Switch>] [[-InputObject] <Microsoft.SqlServer.Management.Smo.Agent.Alert[]>] [-EnableException <Switch>]
[<CommonParameters>]
DESCRIPTION
Set-DbaAgentAlert updates an alert in the SQL Server Agent with parameters supplied.
PARAMETERS
-Alert [<System.Object[]>]
The name of the alert.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Disabled [<Switch>]
Disabled the alert.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Enabled [<Switch>]
Enabled the alert.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-EnableException [<Switch>]
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.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Force [<Switch>]
The force parameter will ignore some errors in the parameters and assume defaults.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-InputObject [<Microsoft.SqlServer.Management.Smo.Agent.Alert[]>]
Enables piping alert objects
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-NewName [<String>]
The new name for the alert.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-SqlCredential [<Pscredential>]
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.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-SqlInstance [<Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>]
The target SQL Server instance or instances. You must have sysadmin access and server version must be SQL
Server version 2000 or greater.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
NOTES
Tags: Agent, Alert
Author: Garry Bargsley (@gbargsley), garrybargsley.com
Website: https://dbatools.io
Copyright: (c) 2018 by dbatools, licensed under MIT
License: MIT https://opensource.org/licenses/MIT
-------------------------- 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.
RELATED LINKS
https://dbatools.io/Set-DbaAgentAlert