SqlAgentFailsafe - dsccommunity/SqlServerDsc GitHub Wiki
Parameters
Parameter | Attribute | DataType | Description | Allowed Values |
---|---|---|---|---|
InstanceName | Key | String | The name of the SQL Server instance to be configured. | |
Name | Required | String | The name of the SQL Server Agent failsafe operator. | |
Ensure | Write | String | Specifies if the SQL Server Agent failsafe operator should be present or absent. Default value is 'Present' . |
Present , Absent |
NotificationMethod | Write | String | The method of notification for the failsafe operator. The default value is 'None' . |
None , NotifyEmail , Pager , NetSend , NotifyAll |
ServerName | Write | String | The host name of the SQL Server to be configured. Default value is the current computer name. |
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 Failsafe Operator 'FailsafeOp' exists with the correct Notification.
Configuration Example
{
Import-DscResource -ModuleName 'SqlServerDsc'
node localhost
{
SqlAgentFailsafe 'Add_FailsafeOp'
{
Ensure = 'Present'
Name = 'FailsafeOp'
ServerName = 'TestServer'
InstanceName = 'MSSQLServer'
NotificationMethod = 'NotifyEmail'
}
}
}
Example 2
This example shows how to ensure that the SQL Agent failsafe operator FailsafeOp does not exist.
Configuration Example
{
Import-DscResource -ModuleName 'SqlServerDsc'
node localhost
{
SqlAgentFailsafe 'Remove_FailsafeOp'
{
Ensure = 'Absent'
Name = 'FailsafeOp'
ServerName = 'TestServer'
InstanceName = 'MSSQLServer'
}
}
}