Resource Type: dsc_sqlserverrole

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

Overview

The DSC SqlServerRole resource type. Automatically generated from ‘SqlServerDsc/DSCResources/MSFT_SqlServerRole/MSFT_SqlServerRole.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_ensure

    Ensure - An enumerated value that describes if the server role is added (Present) or dropped (Absent). Default value is ‘Present’. Valid values are Present, Absent.

  • dsc_instancename

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

  • dsc_members

    Members - The members the server role should have. This parameter will replace all the current server role members with the specified members.

  • dsc_memberstoexclude

    MembersToExclude - The members the server role should exclude. This parameter will only remove members from a server role. Can only be used when parameter Ensure is set to ‘Present’. Can not be used at the same time as parameter Members.

  • dsc_memberstoinclude

    MembersToInclude - The members the server role should include. This parameter will only add members to a server role. Can not be used at the same time as parameter Members.

  • dsc_psdscrunascredential

    PsDscRunAsCredential

  • dsc_servername

    ServerName - The host name of the SQL Server to be configured.

  • dsc_serverrolename

    ServerRoleName - The name of of SQL role to add or remove.

  • name (namevar)
  • provider

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