Resource Type: dsc_sqlservermaxdop

Defined in:

lib/puppet/type/dsc_sqlservermaxdop.rb

Providers:

powershell

Overview

The DSC SqlServerMaxDop resource type. Automatically generated from ‘SqlServerDsc/DSCResources/MSFT_SqlServerMaxDop/MSFT_SqlServerMaxDop.schema.mof’

To learn more about PowerShell Desired State Configuration, please visit technet.microsoft.com/en-us/library/dn249912.aspx.

For more information about built-in DSC Resources, please visit technet.microsoft.com/en-us/library/dn249921.aspx.

For more information about xDsc Resources, please visit github.com/PowerShell/DscResources.

Properties

• ensure

  The basic property that the resource should be in.

  Supported values:

  • exists?
  • present
  • absent

Parameters

• dsc_dynamicalloc

  DynamicAlloc - 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.

  Supported values:

  • true
  • false
• dsc_ensure

  Ensure - 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. Valid values are Present, Absent.

• dsc_instancename

  InstanceName - The name of the SQL instance to be configured.

• dsc_isactivenode

  IsActiveNode - Determines if the current node is actively hosting the SQL Server instance.

  Supported values:

  • true
  • false
• dsc_maxdop

  MaxDop - A numeric value to limit the number of processors used in parallel plan execution.

• dsc_processonlyonactivenode

  ProcessOnlyOnActiveNode - 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.

  Supported values:

  • true
  • false
• dsc_psdscrunascredential

  PsDscRunAsCredential

• dsc_servername

  ServerName - The host name of the SQL Server to be configured. Default value is $env:COMPUTERNAME.

• name (namevar)
• provider

  The specific backend to use for this ‘dsc_sqlservermaxdop` resource. You will seldom need to specify this — Puppet will usually discover the appropriate provider for your platform.