Resource Type: dsc_xexchmailboxdatabase

Defined in:
lib/puppet/type/dsc_xexchmailboxdatabase.rb

Overview

The DSC xExchMailboxDatabase resource type. Automatically generated from version 1.33.0

Properties

  • dsc_adserversettingspreferredserver

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

  • dsc_allowfilerestore

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

  • dsc_allowservicerestart

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

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

  • dsc_backgrounddatabasemaintenance

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

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

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

  • dsc_databasecopycount

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

  • dsc_datamovereplicationconstraint

    The DataMoveReplicationConstraint parameter specifies the throttling behavior for high availability mailbox moves.

  • dsc_deleteditemretention

    The DeletedItemRetention parameter specifies the length of time to keep deleted items in the Recoverable ItemsDeletions folder in mailboxes.

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

    The EdbFilePath parameter specifies the path to the database files.

  • dsc_eventhistoryretentionperiod

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

  • dsc_indexenabled

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

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

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

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

  • dsc_isexcludedfromprovisioningreason

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

  • dsc_issuewarningquota

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

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

  • dsc_journalrecipient

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

  • dsc_logfolderpath

    The LogFolderPath parameter specifies the folder location for log files.

  • dsc_mailboxretention

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

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

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

  • dsc_offlineaddressbook

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

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

    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_recoverableitemsquota

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

  • dsc_recoverableitemswarningquota

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

  • dsc_retaindeleteditemsuntilbackup

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

  • dsc_server

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

  • dsc_skipinitialdatabasemount

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

Parameters

  • dsc_credential

    Credentials used to establish a remote PowerShell session to Exchange

  • dsc_name (namevar)

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

  • dsc_psdscrunascredential
  • 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).