Resource Type: dsc_sqlservermemory

Defined in:
lib/puppet/type/dsc_sqlservermemory.rb
Providers:
powershell

Overview

The DSC SqlServerMemory resource type. Automatically generated from ‘SqlServerDsc/DSCResources/MSFT_SqlServerMemory/MSFT_SqlServerMemory.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 memory will be dynamically configured. When this is set parameter is set to $true, the parameter MaxMemory must be set to $null or not be configured. Default value is $false.

    Supported values:
    • true
    • false
  • dsc_ensure

    Ensure - When set to ‘Present’ then min and max memory will be set to either the value in parameter MinMemory and MaxMemory or dynamically configured when parameter DynamicAlloc is set to $true. When set to ‘Absent’ min and max memory will be set to default values. Default value is Present. 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_maxmemory

    MaxMemory - Maximum amount of memory, in MB, in the buffer pool used by the instance of SQL Server.

  • dsc_minmemory

    MinMemory - Minimum amount of memory, in MB, in the buffer pool used by the instance of SQL Server.

  • 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_sqlservermemory` resource. You will seldom need to specify this — Puppet will usually discover the appropriate provider for your platform.