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

Topic Last Modified: 2012-11-15

Use the Set-PublicFolderDatabase cmdlet to set attributes of public folder databases.

Syntax


Set-PublicFolderDatabase -Identity <DatabaseIdParameter> [-AllowFileRestore <$true \| $false>] [-BackgroundDatabaseMaintenance <$true \| $false>] [-CircularLoggingEnabled <$true \| $false>] [-Confirm [<SwitchParameter>]] [-CustomReferralServerList <MultiValuedProperty>] [-DataMoveReplicationConstraint <None \| SecondCopy \| SecondDatacenter \| AllDatacenters \| AllCopies>] [-DeletedItemRetention <EnhancedTimeSpan>] [-DomainController <Fqdn>] [-EventHistoryRetentionPeriod <EnhancedTimeSpan>] [-IssueWarningQuota <Unlimited>] [-ItemRetentionPeriod <Unlimited>] [-MaintenanceSchedule <Schedule>] [-MaxItemSize <Unlimited>] [-MountAtStartup <$true \| $false>] [-Name <String>] [-ProhibitPostQuota <Unlimited>] [-QuotaNotificationSchedule <Schedule>] [-ReplicationMessageSize <ByteQuantifiedSize>] [-ReplicationPeriod <UInt32>] [-ReplicationSchedule <Schedule>] [-RetainDeletedItemsUntilBackup <$true \| $false>] [-RpcClientAccessServer <ClientAccessServerOrArrayIdParameter>] [-UseCustomReferralServerList <$true \| $false>] [-WhatIf [<SwitchParameter>]]

Set-PublicFolderDatabase -Identity
<DatabaseIdParameter> [-AllowFileRestore <$true |
$false>] [-BackgroundDatabaseMaintenance <$true | $false>]
[-CircularLoggingEnabled <$true | $false>] [-Confirm
[<SwitchParameter>]] [-CustomReferralServerList
<MultiValuedProperty>] [-DataMoveReplicationConstraint
<None | SecondCopy | SecondDatacenter | AllDatacenters |
AllCopies>] [-DeletedItemRetention <EnhancedTimeSpan>]
[-DomainController <Fqdn>] [-EventHistoryRetentionPeriod
<EnhancedTimeSpan>] [-IssueWarningQuota <Unlimited>]
[-ItemRetentionPeriod <Unlimited>] [-MaintenanceSchedule
<Schedule>] [-MaxItemSize <Unlimited>] [-MountAtStartup
<$true | $false>] [-Name <String>] [-ProhibitPostQuota
<Unlimited>] [-QuotaNotificationSchedule <Schedule>]
[-ReplicationMessageSize <ByteQuantifiedSize>]
[-ReplicationPeriod <UInt32>] [-ReplicationSchedule
<Schedule>] [-RetainDeletedItemsUntilBackup <$true |
$false>] [-RpcClientAccessServer
<ClientAccessServerOrArrayIdParameter>]
[-UseCustomReferralServerList <$true | $false>] [-WhatIf
[<SwitchParameter>]]

Detailed Description

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 "Public folder databases" entry in the Mailbox Permissions topic.

Parameters

Parameter Required Type Description

Identity

Required

Microsoft.Exchange.Configuration.Tasks.DatabaseIdParameter

The Identity parameter specifies a public folder database. You can use the following values:

GUID
Distinguished name (DN)
Database name

If you don't specify the server name, the command searches for databases on the local server. If you have multiple databases with the same name, the command retrieves all databases with the same name in the specified scope.

AllowFileRestore

Optional

System.Boolean

The AllowFileRestore parameter specifies that the public folder database can be overwritten if the public folder database is restored. The default value is $false.

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 public folder database reads the object during database mount and initializes the database to perform the background database maintenance. If you specify $false, the public folder 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 to enable circular logging. If you specify a value of $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.

CustomReferralServerList

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The CustomReferralServerList parameter specifies public folder referral costs to individual servers manually. Costs can be any positive number. Servers not included on the list aren't included for referrals. If this parameter is set with no servers in the list, there are no public folder referrals.

The CustomReferralServerList parameter accepts an array in the following format: "serverID:cost". Use a comma to separate multiple servers, for example, "MBXSERVER01:1","MBXSERVER02:5".

DataMoveReplicationConstraint

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.DataMoveReplicationConstraintParameter

This parameter is reserved for internal Microsoft use.

DeletedItemRetention

Optional

Microsoft.Exchange.Data.EnhancedTimeSpan

The DeletedItemRetention parameter specifies the time that deleted items are kept in the dumpster before being permanently deleted during store maintenance.

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 that events are retained in the event history table. Events can be retained for up to one week.

IssueWarningQuota

Optional

Microsoft.Exchange.Data.Unlimited

The IssueWarningQuota parameter specifies the public folder size at which a warning is issued to public folder owners stating that the folder is almost full.

ItemRetentionPeriod

Optional

Microsoft.Exchange.Data.Unlimited

The ItemRetentionPeriod parameter specifies the length of time that items are retained in a folder before they're deleted during store maintenance.

MaintenanceSchedule

Optional

Microsoft.Exchange.Data.Schedule

The MaintenanceSchedule parameter specifies the store maintenance schedule.

MaxItemSize

Optional

Microsoft.Exchange.Data.Unlimited

The MaxItemSize parameter specifies the maximum size of an item that can be posted to or received by a public folder.

MountAtStartup

Optional

System.Boolean

The MountAtStartup parameter specifies whether the database should be mounted when the store starts. The default value is $true.

Name

Optional

System.String

The Name parameter specifies the name of the public folder database. Use this parameter to change the name of the public folder database.

ProhibitPostQuota

Optional

Microsoft.Exchange.Data.Unlimited

The ProhibitPostQuota parameter specifies the size of a public folder at which users are notified that the public folder is full. Users can't post to a folder larger than the ProhibitPostQuota parameter value.

QuotaNotificationSchedule

Optional

Microsoft.Exchange.Data.Schedule

The QuotaNotificationSchedule parameter specifies the interval at which warning messages are sent when public folders exceed their specified size limit.

ReplicationMessageSize

Optional

Microsoft.Exchange.Data.ByteQuantifiedSize

The ReplicationMessageSize parameter specifies the size of replication messages. Small items may be aggregated into a single replication message that can be as large as this setting, but items larger than this setting are replicated with messages larger than this size.

ReplicationPeriod

Optional

System.UInt32

The ReplicationPeriod parameter specifies the interval at which replication of public folders or content updates may occur.

ReplicationSchedule

Optional

Microsoft.Exchange.Data.Schedule

The ReplicationSchedule parameter specifies the time intervals during which replication of public folders or contents may occur.

RetainDeletedItemsUntilBackup

Optional

System.Boolean

The RetainDeletedItemsUntilBackup parameter specifies that deleted items aren't removed until a backup of the public folder database is performed. The default value is $false.

RpcClientAccessServer

Optional

Microsoft.Exchange.Configuration.Tasks.ClientAccessServerOrArrayIdParameter

This parameter is reserved for internal Microsoft use.

UseCustomReferralServerList

Optional

System.Boolean

The UseCustomReferralServerList parameter specifies whether to use the server costs specified by the PublicFolderReferralServerList parameter. If set to $true, the server uses the PublicFolderReferralServerList parameter costs to make public folder referrals. If set to $false, the server uses Active Directory inter-site costs to make public folder referrals.

Note:
Setting this parameter to `$false` also clears the PublicFolderReferralServerList parameter.

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 deleted items retention on the public folder database PFDB01 to 10 days.

	Copy Code
Set-PublicFolderDatabase -Identity 'PFDB01' -DeletedItemRetention '10.00:00:00'

EXAMPLE 2

This example sets the database maintenance schedule on PFDB01 to run daily from 02:00 (2:00 A.M.) until 06:00 (6:00 A.M.).

Copy Code

Set-PublicFolderDatabase -Identity 'PFDB01'-MaintenanceSchedule 'Sun.2:00 AM-Sun.6:00 AM, Mon.2:00 AM-Mon.6:00 AM, Tue.2:00 AM-Tue.6:00 AM, Wed.2:00 AM-Wed.6:00 AM, Thu.2:00 AM-Thu.6:00 AM, Fri.2:00 AM-Fri.6:00 AM, Sat.2:00 AM-Sat.6:00 AM'

EXAMPLE 3

This example prevents the deleted items in the public folder database PFDB01 from being permanently deleted until after the database has been backed up.

	Copy Code
Set-PublicFolderDatabase -RetainDeletedItemsUntilBackup $true -Identity 'PFDB01'