Resource Type: dsc_xexchmailboxdatabase

Defined in:

lib/puppet/type/dsc_xexchmailboxdatabase.rb

Providers:

powershell

Overview

The DSC xExchMailboxDatabase resource type. Automatically generated from ‘xExchange/DSCResources/MSFT_xExchMailboxDatabase/MSFT_xExchMailboxDatabase.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

Parameters

• dsc_adserversettingspreferredserver

  AdServerSettingsPreferredServer - An optional domain controller to pass to Set-AdServerSettings -PreferredServer

• dsc_allowfilerestore

  AllowFileRestore - The AllowFileRestore parameter specifies whether to allow a database to be restored from a backup.

  Supported values:

  • true
  • false
• dsc_allowservicerestart

  AllowServiceRestart - Whether it is okay to restart the Information Store Service after adding a database. Defaults to $false.

  Supported values:

  • true
  • false
• dsc_autodagexcludefrommonitoring

  AutoDagExcludeFromMonitoring - The AutoDagExcludedFromMonitoringparameter specifies whether to exclude the mailbox database from the ServerOneCopyMonitor, which alerts an administrator when a replicated database has only one healthy copy available.

  Supported values:

  • true
  • false
• dsc_backgrounddatabasemaintenance

  BackgroundDatabaseMaintenance - The BackgroundDatabaseMaintenance parameter specifies whether the Extensible Storage Engine (ESE) performs database maintenance.

  Supported values:

  • true
  • false
• dsc_calendarloggingquota

  CalendarLoggingQuota - The CalendarLoggingQuota parameter specifies the maximum size of the log in the Recoverable Items folder of the mailbox that stores changes to calendar items.

• dsc_circularloggingenabled

  CircularLoggingEnabled - The CircularLoggingEnabled parameter specifies whether circular logging is enabled for the database.

  Supported values:

  • true
  • false
• dsc_credential

  Credential - Credentials used to establish a remote PowerShell session to Exchange

• dsc_databasecopycount

  DatabaseCopyCount - The number of copies that the database will have once fully configured

• dsc_datamovereplicationconstraint

  DataMoveReplicationConstraint - The DataMoveReplicationConstraint parameter specifies the throttling behavior for high availability mailbox moves. Valid values are None, SecondCopy, SecondDatacenter, AllDatacenters, AllCopies.

• dsc_deleteditemretention

  DeletedItemRetention - The DeletedItemRetention parameter specifies the length of time to keep deleted items in the Recoverable Items\Deletions folder in mailboxes.

• dsc_domaincontroller

  DomainController - The DomainController parameter specifies the domain controller that’s used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com.

• dsc_edbfilepath

  EdbFilePath - The EdbFilePath parameter specifies the path to the database files.

• dsc_eventhistoryretentionperiod

  EventHistoryRetentionPeriod - The EventHistoryRetentionPeriod parameter specifies the length of time to keep event data.

• dsc_indexenabled

  IndexEnabled - The IndexEnabled parameter specifies whether Exchange Search indexes the mailbox database.

  Supported values:

  • true
  • false
• dsc_isexcludedfromprovisioning

  IsExcludedFromProvisioning - The IsExcludedFromProvisioning parameter specifies whether to exclude the database from the mailbox provisioning load balancer that distributes new mailboxes randomly and evenly across the available databases.

  Supported values:

  • true
  • false
• dsc_isexcludedfromprovisioningbyoperator

  IsExcludedFromProvisioningByOperator - The IIsExcludedFromProvisioningByOperator parameter specifies whether to exclude the database from the mailbox provisioning load balancer that distributes new mailboxes randomly and evenly across the available databases.

  Supported values:

  • true
  • false
• dsc_isexcludedfromprovisioningduetologicalcorruption

  IsExcludedFromProvisioningDueToLogicalCorruption - The IsExcludedFromProvisioningDueToLogicalCorruption parameter specifies whether to exclude the database from the mailbox provisioning load balancer that distributes new mailboxes randomly and evenly across the available databases.

  Supported values:

  • true
  • false
• dsc_isexcludedfromprovisioningreason

  IsExcludedFromProvisioningReason - The IsExcludedFromProvisioningReason parameter specifies the reason why you excluded the mailbox database from the mailbox provisioning load balancer.

• dsc_issuewarningquota

  IssueWarningQuota - The IssueWarningQuota parameter specifies the warning threshold for the size of the mailbox.

• dsc_issuspendedfromprovisioning

  IsSuspendedFromProvisioning - The IsSuspendedFromProvisioning parameter specifies whether to exclude the database from the mailbox provisioning load balancer that distributes new mailboxes randomly and evenly across the available databases.

  Supported values:

  • true
  • false
• dsc_journalrecipient

  JournalRecipient - The JournalRecipient parameter specifies the journal recipient to use for per-database journaling for all mailboxes on the database.

• dsc_logfolderpath

  LogFolderPath - The LogFolderPath parameter specifies the folder location for log files.

• dsc_mailboxretention

  MailboxRetention - The MailboxRetention parameter specifies the length of time to keep deleted mailboxes before they are permanently deleted or purged.

• dsc_metacachedatabasemaxcapacityinbytes

  MetaCacheDatabaseMaxCapacityInBytes - The MetaCacheDatabaseMaxCapacityInBytes parameter specifies the size of the metacache database in bytes. To convert gigabytes to bytes, multiply the value by 1024^3. For terabytes to bytes, multiply by 1024^4.

• dsc_mountatstartup

  MountAtStartup - The MountAtStartup parameter specifies whether to mount the mailbox database when the Microsoft Exchange Information Store service starts.

  Supported values:

  • true
  • false
• dsc_name

  Name - The Name parameter specifies the unique name of the mailbox database.

• dsc_offlineaddressbook

  OfflineAddressBook - The OfflineAddressBook parameter specifies the offline address book that’s associated with the mailbox database.

• dsc_prohibitsendquota

  ProhibitSendQuota - The ProhibitSendQuota parameter specifies a size limit for the mailbox. If the mailbox reaches or exceeds this size, the mailbox can’t send new messages, and the user receives a descriptive warning message.

• dsc_prohibitsendreceivequota

  ProhibitSendReceiveQuota - The ProhibitSendReceiveQuota parameter specifies a size limit for the mailbox. If the mailbox reaches or exceeds this size, the mailbox can’t send or receive new messages. Messages sent to the mailbox are returned to the sender with a descriptive error message. This value effectively determines the maximum size of the mailbox.

• dsc_psdscrunascredential

  PsDscRunAsCredential

• dsc_recoverableitemsquota

  RecoverableItemsQuota - The RecoverableItemsQuota parameter specifies the maximum size for the Recoverable Items folder of the mailbox.

• dsc_recoverableitemswarningquota

  RecoverableItemsWarningQuota - The RecoverableItemsWarningQuota parameter specifies the warning threshold for the size of the Recoverable Items folder for the mailbox.

• dsc_retaindeleteditemsuntilbackup

  RetainDeletedItemsUntilBackup - The RetainDeletedItemsUntilBackup parameter specifies whether to keep items in the Recoverable Items\Deletions folder of the mailbox until the next database backup occurs.

  Supported values:

  • true
  • false
• dsc_server

  Server - The Server parameter specifies the server on which you want to create the database.

• dsc_skipinitialdatabasemount

  SkipInitialDatabaseMount - Whether the initial mount of databases should be skipped after database creation

  Supported values:

  • true
  • false
• name (namevar)
• provider

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