DSCResources/DSC_SqlMaxDop/en-US/about_SqlMaxDop.help.txt
|
.NAME
SqlMaxDop .DESCRIPTION The `SqlMaxDop` DSC resource set the max degree of parallelism server configuration option. The max degree of parallelism option is used to limit the number of processors to use in parallel plan execution. Read more about max degree of parallelism in this article [Configure the max degree of parallelism Server Configuration Option](https://msdn.microsoft.com/en-us/library/ms189094.aspx) >**NOTE** This configuration option can also be configured using the DSC >resource _SqlConfiguration_ but will not allow the dynamic configuration >as this resource provides. Make sure this value is not configured by both >the resources _SqLMaxDop_ and _SqlConfiguration_! ## Formula for dynamically allocating max degree of parallelism * If the number of configured NUMA nodes configured in SQL Server equals 1, then max degree of parallelism is calculated using number of cores divided in 2 (numberOfCores / 2), then rounded up to the next integer (3.5 > 4). * If the number of cores configured in SQL Server are greater than or equal to 8 cores then max degree of parallelism will be set to 8. * If the number of configured NUMA nodes configured in SQL Server is greater than 2 and the number of cores are less than 8 then max degree of parallelism will be set to the number of cores. ## 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](https://github.com/dsccommunity/SqlServerDsc/issues?q=is%3Aissue+is%3Aopen+in%3Atitle+SqlMaxDop). .PARAMETER Ensure Write - String Allowed values: Present, Absent When set to 'Present' then max degree of parallelism will be set to either the value in parameter MaxDop or dynamically configured when parameter DynamicAlloc is set to $true. When set to 'Absent' max degree of parallelism will be set to 0 which means no limit in number of processors used in parallel plan execution. .PARAMETER DynamicAlloc Write - Boolean If set to $true then max degree of parallelism will be dynamically configured. When this is set parameter is set to $true, the parameter MaxDop must be set to $null or not be configured. .PARAMETER MaxDop Write - SInt32 A numeric value to limit the number of processors used in parallel plan execution. .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 instance to be configured. .PARAMETER ProcessOnlyOnActiveNode Write - Boolean Specifies that the resource will only determine if a change is needed if the target node is the active host of the SQL Server instance. .PARAMETER IsActiveNode Read - Boolean Determines if the current node is actively hosting the SQL Server instance. .EXAMPLE 1 This example shows how to set max degree of parallelism server configuration option with the value equal to 1. Configuration Example { param ( [Parameter(Mandatory = $true)] [System.Management.Automation.PSCredential] $SqlAdministratorCredential ) Import-DscResource -ModuleName 'SqlServerDsc' node localhost { SqlMaxDop 'Set_SqlMaxDop_ToOne' { Ensure = 'Present' DynamicAlloc = $false MaxDop = 1 ServerName = 'sqltest.company.local' InstanceName = 'DSC' PsDscRunAsCredential = $SqlAdministratorCredential } } } .EXAMPLE 2 This example shows how to set max degree of parallelism server configuration option with the automatic configuration. In the event this is applied to a Failover Cluster Instance (FCI), the ProcessOnlyOnActiveNode property will tell the Test-TargetResource function to evaluate if any changes are needed if the node is actively hosting the SQL Server instance. Configuration Example { param ( [Parameter(Mandatory = $true)] [System.Management.Automation.PSCredential] $SqlAdministratorCredential ) Import-DscResource -ModuleName 'SqlServerDsc' node localhost { SqlMaxDop 'Set_SqlMaxDop_ToAuto' { Ensure = 'Present' DynamicAlloc = $true ServerName = 'sqltest.company.local' InstanceName = 'DSC' PsDscRunAsCredential = $SqlAdministratorCredential ProcessOnlyOnActiveNode = $true } } } .EXAMPLE 3 This example shows how to set max degree of parallelism server configuration option with the default configuration. Configuration Example { param ( [Parameter(Mandatory = $true)] [System.Management.Automation.PSCredential] $SqlAdministratorCredential ) Import-DscResource -ModuleName 'SqlServerDsc' node localhost { SqlMaxDop 'Set_SqlMaxDop_ToDefault' { Ensure = 'Absent' ServerName = 'sqltest.company.local' InstanceName = 'DSC' PsDscRunAsCredential = $SqlAdministratorCredential } } } |