SqlAlwaysOnService

SqlAlwaysOnService

Parameters

Parameter	Attribute	DataType	Description	Allowed Values
InstanceName	Key	String	The name of the SQL instance to be configured.
Ensure	Required	String	An enumerated value that describes if the SQL Server should have Always On high availability and disaster recovery (HADR) property enabled ('Present') or disabled ('Absent').	Present, Absent
ServerName	Write	String	The hostname of the SQL Server to be configured. Default value is $env:COMPUTERNAME.
RestartTimeout	Write	UInt32	The length of time, in seconds, to wait for the service to restart. Default value is 120 seconds.
IsHadrEnabled	Read	Boolean	Returns the status of AlwaysOn high availability and disaster recovery (HADR).

Description

The SqlAlwaysOnService DSC resource enables or disables SQL Server Always On high availability and disaster recovery (Always On HADR) for a SQL Server instance.

Requirements

• Target machine must be running Windows Server 2012 or later.
• Target machine must be running SQL Server Database Engine 2012 or later.
• Target machine must be a member of a Windows Server Failover Cluster.

Known issues

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

Examples

Example 1

This example shows how to enable SQL Server Always On high availability and disaster recovery (HADR).

Configuration Example
{
    param
    (
        [Parameter(Mandatory = $true)]
        [System.Management.Automation.PSCredential]
        $SqlAdministratorCredential
    )

    Import-DscResource -ModuleName 'SqlServerDsc'

    node localhost
    {
        SqlAlwaysOnService 'EnableAlwaysOn'
        {
            Ensure               = 'Present'
            ServerName           = 'SP23-VM-SQL1'
            InstanceName         = 'MSSQLSERVER'
            RestartTimeout       = 120

            PsDscRunAsCredential = $SqlAdministratorCredential
        }
    }
}

Example 2

This example shows how to disable SQL Server Always On high availability and disaster recovery (HADR).

Configuration Example
{
    param
    (
        [Parameter(Mandatory = $true)]
        [System.Management.Automation.PSCredential]
        $SqlAdministratorCredential
    )

    Import-DscResource -ModuleName 'SqlServerDsc'

    node localhost
    {
        SqlAlwaysOnService 'DisableAlwaysOn'
        {
            Ensure               = 'Absent'
            ServerName           = 'SP23-VM-SQL1'
            InstanceName         = 'MSSQLSERVER'
            RestartTimeout       = 120

            PsDscRunAsCredential = $SqlAdministratorCredential
        }
    }
}