[This topic is in progress.]

Applies to: Exchange Server 2010 SP3, Exchange Server 2010 SP2

Topic Last Modified: 2011-05-12

Use the Set-MailboxDatabase cmdlet to set the attributes of a mailbox database.

Syntax

Set-MailboxDatabase -Identity <DatabaseIdParameter> [-AllowFileRestore <$true | $false>] [-BackgroundDatabaseMaintenance <$true | $false>] [-CircularLoggingEnabled <$true | $false>] [-Confirm [<SwitchParameter>]] [-DataMoveReplicationConstraint <None | SecondCopy | SecondDatacenter | AllDatacenters | AllCopies>] [-DeletedItemRetention <EnhancedTimeSpan>] [-DomainController <Fqdn>] [-EventHistoryRetentionPeriod <EnhancedTimeSpan>] [-IndexEnabled <$true | $false>] [-IsExcludedFromProvisioning <$true | $false>] [-IssueWarningQuota <Unlimited>] [-IsSuspendedFromProvisioning <$true | $false>] [-JournalRecipient <RecipientIdParameter>] [-MailboxRetention <EnhancedTimeSpan>] [-MaintenanceSchedule <Schedule>] [-MountAtStartup <$true | $false>] [-Name <String>] [-OfflineAddressBook <OfflineAddressBookIdParameter>] [-ProhibitSendQuota <Unlimited>] [-ProhibitSendReceiveQuota <Unlimited>] [-PublicFolderDatabase <DatabaseIdParameter>] [-QuotaNotificationSchedule <Schedule>] [-RecoverableItemsQuota <Unlimited>] [-RecoverableItemsWarningQuota <Unlimited>] [-RetainDeletedItemsUntilBackup <$true | $false>] [-RpcClientAccessServer <ClientAccessServerOrArrayIdParameter>] [-WhatIf [<SwitchParameter>]]

Detailed Description

For more information about permissions, delegating roles, and the rights required to administer Microsoft Exchange Server 2010, see Permissions.

You need to be assigned permissions before you can run this cmdlet. Although all parameters for this cmdlet are listed in this topic, you may not have access to some parameters if they're not included in the permissions assigned to you. To see what permissions you need, see the "Mailbox Database permissions" section in the Mailbox Permissions topic.

Parameters

Parameter Required Type Description

Identity

Required

Microsoft.Exchange.Configuration.Tasks.DatabaseIdParameter

The Identity parameter specifies the mailbox database for which you want to set one or more attributes. You can use the following values:

  • GUID

  • Distinguished name (DN)

  • Name of the mailbox database

If you don't specify the server name, the command searches for the database on the local server.

AllowFileRestore

Optional

System.Boolean

The AllowFileRestore parameter specifies whether to allow restoring a database from a backup. The two possible values are $true or $false. If you specify $true, the command allows a database that doesn't match the database entry in Active Directory to be mounted. If you specify $false, the command doesn't allow a database that doesn't match the database entry in Active Directory to be mounted, so you won't be able to replace an existing database with a newly created database.

BackgroundDatabaseMaintenance

Optional

System.Boolean

The BackgroundDatabaseMaintenance parameter specifies whether the Extensible Storage Engine (ESE) performs database maintenance. The two possible values are $true or $false. If you specify $true, the mailbox database reads the object during database mount and initializes the database to perform the background database maintenance. If you specify $false, the mailbox database reads the object during database mount and initializes the database without the option to perform the background database maintenance.

CircularLoggingEnabled

Optional

System.Boolean

The CircularLoggingEnabled parameter specifies whether circular logging is enabled. If this parameter is set to $true, circular logging is enabled. The default value is $false.

Confirm

Optional

System.Management.Automation.SwitchParameter

The Confirm switch causes the command to pause processing and requires you to acknowledge what the command will do before processing continues. You don't have to specify a value with the Confirm switch.

DataMoveReplicationConstraint

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.DataMoveReplicationConstraintParameter

The DataMoveReplicationConstraint parameter specifies the throttling behavior for high availability mailbox moves. The possible values include:

  • None   Moves shouldn't be throttled to ensure high availability. Use this setting if the database isn't part of a database availability group (DAG).

  • SecondCopy   At least one passive mailbox database copy must have the most recent changes synchronized. This is the default value. Use this setting to indicate that the database is replicated to one or more mailbox database copies.

  • SecondDatacenter   At least one passive mailbox database copy in another Active Directory site must have the most recent changes replicated. Use this setting to indicate that the database is replicated to database copies in multiple Active Directory sites.

  • AllDatacenters   At least one passive mailbox database copy in each Active Directory site must have the most recent changes replicated. Use this setting to indicate that the database is replicated to database copies in multiple Active Directory sites.

  • AllCopies   All copies of the database must have the most recent changes replicated. Use this setting to indicate that the database is replicated to one or more mailbox database copies.

Note:
Any value other than None enables the Microsoft Exchange Mailbox Replication service to coordinate with Active Manager. For more information, see Understanding Active Manager.

DeletedItemRetention

Optional

Microsoft.Exchange.Data.EnhancedTimeSpan

The DeletedItemRetention parameter specifies the length of time to keep deleted items.

To specify a value, enter it as a time span: dd.hh:mm:ss where d = days, h = hours, m = minutes, and s = seconds.

For example, to specify a 15-hour interval, enter 15:00:00. The maximum length of time to retain deleted items is 24,855 days. By default, deleted items are retained for 14 days. This attribute applies to all mailboxes in this mailbox database that don't have their own item retention attribute set.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

The DomainController parameter specifies the fully qualified domain name (FQDN) of the domain controller that writes this configuration change to Active Directory.

EventHistoryRetentionPeriod

Optional

Microsoft.Exchange.Data.EnhancedTimeSpan

The EventHistoryRetentionPeriod parameter specifies the length of time to keep event data. This event data is stored in the event history table in the Exchange store. It includes information about changes to various objects in the mailbox database. You can use this parameter to prevent the event history table from becoming too large and using too much disk space.

To specify a value, enter it as a time span: dd.hh:mm:ss where d = days, h = hours, m = minutes, and s = seconds.

For example, to specify a 15-hour interval, enter 15:00:00.

IndexEnabled

Optional

System.Boolean

The IndexEnabled parameter specifies whether Exchange Search indexes this mailbox database. The two possible values are $true or $false. The default value is $true.

IsExcludedFromProvisioning

Optional

System.Boolean

The IsExcludedFromProvisioning parameter specifies that this database is permanently not considered by the mailbox provisioning load balancer. If the IsExcludedFromProvisioning parameter is enabled, new mailboxes aren't added automatically to this database. You can manually add a mailbox if your role permits.

IssueWarningQuota

Optional

Microsoft.Exchange.Data.Unlimited

The IssueWarningQuota parameter specifies the mailbox size at which a warning message is sent to the user.

This attribute applies to all mailboxes in this mailbox database that don't have their own warning quota attribute set. You must specify either an integer or unlimited. The default value is 1.9 gigabytes (GB).

IsSuspendedFromProvisioning

Optional

System.Boolean

The IsSuspendedFromProvisioning parameter specifies that this database is temporarily not considered by the mailbox provisioning load balancer.

JournalRecipient

Optional

Microsoft.Exchange.Configuration.Tasks.RecipientIdParameter

The JournalRecipient parameter specifies the mailbox to which journal reports are sent.

MailboxRetention

Optional

Microsoft.Exchange.Data.EnhancedTimeSpan

The MailboxRetention parameter specifies the length of time to keep deleted mailboxes.

To specify a value, enter it as a time span: dd.hh:mm:ss where d = days, h = hours, m = minutes, and s = seconds.

For example, to specify a 15-hour interval, enter 15:00:00. The maximum length of time to retain mailboxes is 24,855 days. By default, deleted mailboxes are retained for 30 days. This attribute applies to all mailboxes in this mailbox database.

MaintenanceSchedule

Optional

Microsoft.Exchange.Data.Schedule

The MaintenanceSchedule parameter specifies when maintenance will be performed on the mailbox database. Maintenance includes online defragmentation, removing items that have passed their retention period, removing unused indexes, and other cleanup tasks.

The format is StartDay.Hour:Minute [AM/PM]-EndDay.Hour:Minute [AM/PM]. You can use the following values for the start and end days:

  • Full name of the day

  • Abbreviated name of the day

  • Integer from 0 through 6, where 0 = Sunday

If you prefer to use a 24-hour clock, omit AM/PM. If you use AM/PM, you must include a space between the time and AM or PM.

Formats can be mixed.

The start time and end time must be at least 15 minutes apart. Minutes are rounded down to 0, 15, 30, or 45. If you specify more than one interval, there must be at least 15 minutes between each interval.

The following are examples:

  • "Sun.11:30 PM-Mon.1:30 AM"

  • 6.22:00-6.22:15 (Maintenance will run from Saturday at 10:00 PM until Saturday at 10:15 PM.)

  • "Monday.4:30 AM-Monday.5:30 AM","Wednesday.4:30 AM-Wednesday.5:30 AM" (Maintenance will run on Monday and Wednesday mornings from 4:30 until 5:30.)

  • "Sun.1:15 AM-Monday.23:00"

MountAtStartup

Optional

System.Boolean

The MountAtStartup parameter specifies whether to mount this mailbox database when the Microsoft Exchange Information Store service starts. The two possible values for this parameter are $true or $false.

Name

Optional

System.String

The Name parameter specifies the name of the mailbox database.

OfflineAddressBook

Optional

Microsoft.Exchange.Configuration.Tasks.OfflineAddressBookIdParameter

The OfflineAddressBook parameter specifies the associated address book for this mailbox database.

ProhibitSendQuota

Optional

Microsoft.Exchange.Data.Unlimited

The ProhibitSendQuota parameter specifies the mailbox size at which users associated with mailboxes in this mailbox database can no longer send messages. This attribute applies to all mailboxes in this mailbox database that don't have their own prohibit send quota attributes set.

You must specify either an integer or unlimited.

ProhibitSendReceiveQuota

Optional

Microsoft.Exchange.Data.Unlimited

The ProhibitSendReceiveQuota parameter specifies the mailbox size at which the user associated with this mailbox can no longer send or receive messages. This attribute applies to all mailboxes in this mailbox database that don't have their own prohibit send receive quota attributes set.

You must specify either an integer or unlimited.

PublicFolderDatabase

Optional

Microsoft.Exchange.Configuration.Tasks.DatabaseIdParameter

The PublicFolderDatabase parameter specifies the associated public folder database for this mailbox database. You can use the following values:

  • GUID

  • Distinguished name (DN)

  • Name of the public folder database

  • Database name

QuotaNotificationSchedule

Optional

Microsoft.Exchange.Data.Schedule

The QuotaNotificationSchedule parameter specifies when quota messages are sent to mailboxes that have reached one of the quota values.

The format is StartDay.Hour:Minute [AM/PM]-EndDay.Hour:Minute [AM/PM]. You can use the following values for the start and end days:

  • Full name of the day

  • Abbreviated name of the day

  • Integer from 0 through 6, where 0 = Sunday

If you prefer to use a 24-hour clock, omit AM/PM.

Formats can be mixed.

The start time and end time must be at least 15 minutes apart. Minutes are rounded down to 0, 15, 30, or 45. If you specify more than one interval, there must be at least 15 minutes between each interval.

The following are examples:

  • "Sun.11:30 PM-Mon.1:30 AM"

  • 6.22:00-6.22:15 (Notification will run from Saturday at 10:00 PM until Saturday at 10:15 PM.)

  • "Monday.4:30 AM-Monday.5:30 AM","Wednesday.4:30 AM-Wednesday.5:30 AM" (Notification will run on Monday and Wednesday mornings from 4:30 until 5:30.)

  • "Sun.1:15 AM-Monday.23:00"

RecoverableItemsQuota

Optional

Microsoft.Exchange.Data.Unlimited

The RecoverableItemsQuota parameter specifies the limit for the Recovery Items folder. When you reach the quota limit, you can't put any more items in the Recovery Items folder.

RecoverableItemsWarningQuota

Optional

Microsoft.Exchange.Data.Unlimited

The RecoverableItemsWarningQuota parameter specifies the quota for when a warning event is entered in Event Viewer.

RetainDeletedItemsUntilBackup

Optional

System.Boolean

The RetainDeletedItemsUntilBackup parameter specifies whether to retain deleted items until the next backup occurs. The two possible values for this parameter are $true or $false.

RpcClientAccessServer

Optional

Microsoft.Exchange.Configuration.Tasks.ClientAccessServerOrArrayIdParameter

The RpcClientAccessServer parameter specifies the Client Access server or Client Access server array through which RPC clients (for example, Microsoft Office Outlook 2007 clients) access their mailboxes. This feature is supported for all versions of Outlook.

When connecting with Outlook 2003 clients, RPC encryption is disabled by default. Unless RPC encryption is enabled on Outlook 2003 or disabled on the server, Outlook 2003 clients won't be able to connect. For more information, see Understanding RPC Client Access.

WhatIf

Optional

System.Management.Automation.SwitchParameter

The WhatIf switch instructs the command to simulate the actions that it would take on the object. By using the WhatIf switch, you can view what changes would occur without having to apply any of those changes. You don't have to specify a value with the WhatIf switch.

Input Types

To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types. If the Input Type field for a cmdlet is blank, the cmdlet doesn’t accept input data.

Return Types

To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types. If the Output Type field is blank, the cmdlet doesn’t return data.

Examples

EXAMPLE 1

This example sets the length of time that deleted items are retained. If a particular mailbox has its own item retention set, that value is used instead of this value, which is set on the mailbox database.

Copy Code 
Set-MailboxDatabase "Mailbox Database01" -DeletedItemRetention 7.00:00:00

EXAMPLE 2

This example updates a mailbox database so that all client connections for mailboxes on the database come through the Client Access server or Client Access server array. You can also use this command to change the Client Access server or Client Access server array through which the client is connecting to the Mailbox server.

Copy Code 
Set-MailboxDatabase <Mailbox Database Name> -RpcClientAccessServer <ClientAccessServer or ClientAccessServerArrayID>

For more information about RPC access through Client Access servers, see Set-RpcClientAccess and Set-ClientAccessArray.