-
Notifications
You must be signed in to change notification settings - Fork 225
SqlAgentAlert
dscbot edited this page Aug 13, 2024
·
11 revisions
Parameter | Attribute | DataType | Description | Allowed Values |
---|---|---|---|---|
Name | Key | String | The name of the SQL Server Agent alert. | |
Ensure | Write | String | Specifies if the SQL Server Agent alert should be present or absent. Default value is 'Present' . |
Present , Absent
|
ServerName | Write | String | The host name of the SQL Server to be configured. Default value is the current computer name. | |
InstanceName | Key | String | The name of the SQL Server instance to be configured. | |
Severity | Write | String | The severity of the SQL Server Agent alert. | |
MessageId | Write | String | The message id of the SQL Server Agent alert. |
The SqlAgentAlert
DSC resource is used to add/remove SQL Agent Alerts.
The resource can also update the severity or message id.
- Target machine must be running Windows Server 2012 or later.
- Target machine must be running SQL Server Database Engine 2012 or later.
All issues are not listed here, see here for all open issues.
This example shows how to ensure that the SQL Agent Alert Sev17 exists with the correct severity level, and SQL Agent Alert Msg825 with the correct message id.
Configuration Example
{
Import-DscResource -ModuleName 'SqlServerDsc'
node localhost
{
SqlAgentAlert 'Add_Sev17'
{
Ensure = 'Present'
Name = 'Sev17'
ServerName = 'TestServer'
InstanceName = 'MSSQLServer'
Severity = '17'
}
SqlAgentAlert 'Add_Msg825'
{
Ensure = 'Present'
Name = 'Msg825'
ServerName = 'TestServer'
InstanceName = 'MSSQLServer'
MessageId = '825'
}
}
}
This example shows how to ensure that the SQL Agent Alert Sev17 does not exist, or that the SQL Agent Alert Msg825 does not exist.
Configuration Example
{
Import-DscResource -ModuleName 'SqlServerDsc'
node localhost
{
SqlAgentAlert 'Remove_Sev17'
{
Ensure = 'Absent'
Name = 'Sev17'
ServerName = 'TestServer'
InstanceName = 'MSSQLServer'
}
SqlAgentAlert 'Remove_Msg825'
{
Ensure = 'Absent'
Name = 'Msg825'
ServerName = 'TestServer'
InstanceName = 'MSSQLServer'
}
}
}
- Add-SqlDscNode
- Add-SqlDscTraceFlag
- Complete-SqlDscFailoverCluster
- Complete-SqlDscImage
- Connect-SqlDscDatabaseEngine
- ConvertFrom-SqlDscDatabasePermission
- ConvertFrom-SqlDscServerPermission
- ConvertTo-SqlDscDatabasePermission
- ConvertTo-SqlDscServerPermission
- Disable-SqlDscAudit
- Disconnect-SqlDscDatabaseEngine
- Enable-SqlDscAudit
- Get-SqlDscAudit
- Get-SqlDscConfigurationOption
- Get-SqlDscDatabasePermission
- Get-SqlDscManagedComputer
- Get-SqlDscManagedComputerService
- Get-SqlDscPreferredModule
- Get-SqlDscServerPermission
- Get-SqlDscStartupParameter
- Get-SqlDscTraceFlag
- Import-SqlDscPreferredModule
- Initialize-SqlDscRebuildDatabase
- Install-SqlDscServer
- Invoke-SqlDscQuery
- New-SqlDscAudit
- Remove-SqlDscAudit
- Remove-SqlDscNode
- Remove-SqlDscTraceFlag
- Repair-SqlDscServer
- Save-SqlDscSqlServerMediaFile
- Set-SqlDscAudit
- Set-SqlDscDatabasePermission
- Set-SqlDscServerPermission
- Set-SqlDscStartupParameter
- Set-SqlDscTraceFlag
- Test-SqlDscIsDatabasePrincipal
- Test-SqlDscIsLogin
- Test-SqlDscIsSupportedFeature
- Uninstall-SqlDscServer
- SqlAG
- SqlAGDatabase
- SqlAgentAlert
- SqlAgentFailsafe
- SqlAgentOperator
- SqlAGListener
- SqlAGReplica
- SqlAlias
- SqlAlwaysOnService
- SqlAudit
- SqlConfiguration
- SqlDatabase
- SqlDatabaseDefaultLocation
- SqlDatabaseMail
- SqlDatabaseObjectPermission
- SqlDatabasePermission
- SqlDatabaseRole
- SqlDatabaseUser
- SqlEndpoint
- SqlEndpointPermission
- SqlLogin
- SqlMaxDop
- SqlMemory
- SqlPermission
- SqlProtocol
- SqlProtocolTcpIp
- SqlReplication
- SqlRole
- SqlRS
- SqlRSSetup
- SqlScript
- SqlScriptQuery
- SqlSecureConnection
- SqlServiceAccount
- SqlSetup
- SqlTraceFlag
- SqlWaitForAG
- SqlWindowsFirewall