Resource Type: dsc_sqlrole

Defined in:

lib/puppet/type/dsc_sqlrole.rb

Overview

The DSC SqlRole resource type. Automatically generated from version 16.6.0

Properties

• dsc_ensure

  An enumerated value that describes if the server role is added (‘’Present’‘) or dropped (`’Absent’‘). Default value is `’Present’‘.

• dsc_members

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

• dsc_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

  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_servername

  The host name of the _SQL Server_ to be configured. Default value is the current computer name.

Parameters

• dsc_instancename (namevar)

  The name of the _SQL Server_ instance to be configured.

• dsc_psdscrunascredential
• dsc_serverrolename (namevar)

  The name of of _SQL Server Database Engine_ role to add or remove.

• dsc_timeout

  The maximum time in seconds to wait for the DSC resource to complete.

• name (namevar)

  Description of the purpose for this resource declaration.

• validation_mode (defaults to: property)

  Whether to check if the resource is in the desired state by property (default) or using Invoke-DscResource in Test mode (resource).