Resource Type: dsc_sqlserverdatabasemail

Defined in:

lib/puppet/type/dsc_sqlserverdatabasemail.rb

Providers:

powershell

Overview

The DSC SqlServerDatabaseMail resource type. Automatically generated from ‘SqlServerDsc/DSCResources/MSFT_SqlServerDatabaseMail/MSFT_SqlServerDatabaseMail.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_accountname

  AccountName - The name of the Database Mail account.

• dsc_description

  Description - The description of the Database Mail.

• dsc_displayname

  DisplayName - The display name of the outgoing mail server. Default value is the same value assigned to parameter MailServerName.

• dsc_emailaddress

  EmailAddress - The e-mail address from which mail will originate.

• dsc_ensure

  Ensure - Specifies the desired state of the Database Mail. When set to ‘Present’, the Database Mail will be created. When set to ‘Absent’, the Database Mail will be removed. Default value is ‘Present’. Valid values are Present, Absent.

• dsc_instancename

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

• dsc_logginglevel

  LoggingLevel - The logging level that the Database Mail will use. If not specified the default logging level is ‘Extended’. Valid values are Normal, Extended, Verbose.

• dsc_mailservername

  MailServerName - The fully qualified domain name of the mail server name to which e-mail are sent.

• dsc_profilename

  ProfileName - The profile name of the Database Mail.

• dsc_psdscrunascredential

  PsDscRunAsCredential

• dsc_replytoaddress

  ReplyToAddress - The e-mail address to which the receiver of e-mails will reply to. Default value is the same e-mail address assigned to parameter EmailAddress.

• dsc_servername

  ServerName - The hostname of the SQL Server to be configured. Defaults to $env:COMPUTERNAME.

• dsc_tcpport

  TcpPort - The TCP port used for communication. Default value is port 25.

• name (namevar)
• provider

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