SqlAgentAlert

SqlAgentAlert

Parameters

Parameter	Attribute	DataType	Description	Allowed Values
Name	Key	String	The name of the SQL Agent Alert.
Ensure	Write	String	Specifies if the SQL Agent Alert should be present or absent. Default is Present.	Present, Absent
ServerName	Write	String	The host name of the SQL Server to be configured. Default is $env:COMPUTERNAME.
InstanceName	Key	String	The name of the SQL instance to be configured.
Severity	Write	String	The severity of the SQL Agent Alert.
MessageId	Write	String	The message id of the SQL Agent Alert.

Description

The SqlAgentFailsafe DSC resource is used to add/remove the SQL Agent Failsafe Operator. The resource can also update the Notification method.

Requirements

• Target machine must be running Windows Server 2012 or later.
• Target machine must be running SQL Server Database Engine 2012 or later.

Known issues

All issues are not listed here, see here for all open issues.

Examples

Example 1

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'
        }
    }
}

Example 2

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'
        }
    }
}