SqlServerDsc

17.0.1-preview0003

DSCResources/DSC_SqlAgentAlert/en-US/about_SqlAgentAlert.help.txt

.NAME
    SqlAgentAlert
 
.DESCRIPTION
    The SqlAgentAlert DSC resource is used to add/remove SQL Agent Alerts.
    The resource can also update the severity or message id.
 
    ## 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 https://github.com/dsccommunity/SqlServerDsc/issues?q=is%3Aissue+is%3Aopen+in%3Atitle+SqlAgentAlert.
 
.PARAMETER Name
    Key - String
    The name of the SQL Server Agent alert.
 
.PARAMETER Ensure
    Write - String
    Allowed values: Present, Absent
    Specifies if the SQL Server Agent alert should be present or absent. Default value is 'Present'.
 
.PARAMETER ServerName
    Write - String
    The host name of the SQL Server to be configured. Default value is the current computer name.
 
.PARAMETER InstanceName
    Key - String
    The name of the SQL Server instance to be configured.
 
.PARAMETER Severity
    Write - String
    The severity of the SQL Server Agent alert.
 
.PARAMETER MessageId
    Write - String
    The message id of the SQL Server Agent alert.
 
.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'
        }
    }
}