Applies to: Exchange Server 2007
Topic Last Modified: 2007-06-06

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

Syntax


Set-PublicFolderDatabase -Identity <DatabaseIdParameter> [-AllowFileRestore <$true \| $false>] [-DeletedItemRetention <EnhancedTimeSpan>] [-DomainController <Fqdn>] [-EventHistoryRetentionPeriod <EnhancedTimeSpan>] [-IssueWarningQuota <Unlimited>] [-ItemRetentionPeriod <Unlimited>] [-MaintenanceSchedule <Schedule>] [-MaxItemSize <Unlimited>] [-MountAtStartup <$true \| $false>] [-Name <String>] [-ProhibitPostQuota <Unlimited>] [-PublicFolderReferralServerList <MultiValuedProperty>] [-QuotaNotificationSchedule <Schedule>] [-ReplicationMessageSize <ByteQuantifiedSize>] [-ReplicationPeriod <UInt32>] [-ReplicationSchedule <Schedule>] [-RetainDeletedItemsUntilBackup <$true \| $false>] [-UseCustomReferralServerList <$true \| $false>]

Set-PublicFolderDatabase -Identity
<DatabaseIdParameter> [-AllowFileRestore <$true |
$false>] [-DeletedItemRetention <EnhancedTimeSpan>]
[-DomainController <Fqdn>] [-EventHistoryRetentionPeriod
<EnhancedTimeSpan>] [-IssueWarningQuota <Unlimited>]
[-ItemRetentionPeriod <Unlimited>] [-MaintenanceSchedule
<Schedule>] [-MaxItemSize <Unlimited>] [-MountAtStartup
<$true | $false>] [-Name <String>] [-ProhibitPostQuota
<Unlimited>] [-PublicFolderReferralServerList
<MultiValuedProperty>] [-QuotaNotificationSchedule
<Schedule>] [-ReplicationMessageSize
<ByteQuantifiedSize>] [-ReplicationPeriod <UInt32>]
[-ReplicationSchedule <Schedule>]
[-RetainDeletedItemsUntilBackup <$true | $false>]
[-UseCustomReferralServerList <$true | $false>]


Set-PublicFolderDatabase [-AllowFileRestore <$true \| $false>] [-DeletedItemRetention <EnhancedTimeSpan>] [-DomainController <Fqdn>] [-EventHistoryRetentionPeriod <EnhancedTimeSpan>] [-Instance <PublicFolderDatabase>] [-IssueWarningQuota <Unlimited>] [-ItemRetentionPeriod <Unlimited>] [-MaintenanceSchedule <Schedule>] [-MaxItemSize <Unlimited>] [-MountAtStartup <$true \| $false>] [-Name <String>] [-ProhibitPostQuota <Unlimited>] [-PublicFolderReferralServerList <MultiValuedProperty>] [-QuotaNotificationSchedule <Schedule>] [-ReplicationMessageSize <ByteQuantifiedSize>] [-ReplicationPeriod <UInt32>] [-ReplicationSchedule <Schedule>] [-RetainDeletedItemsUntilBackup <$true \| $false>] [-UseCustomReferralServerList <$true \| $false>]

Set-PublicFolderDatabase [-AllowFileRestore <$true |
$false>] [-DeletedItemRetention <EnhancedTimeSpan>]
[-DomainController <Fqdn>] [-EventHistoryRetentionPeriod
<EnhancedTimeSpan>] [-Instance <PublicFolderDatabase>]
[-IssueWarningQuota <Unlimited>] [-ItemRetentionPeriod
<Unlimited>] [-MaintenanceSchedule <Schedule>]
[-MaxItemSize <Unlimited>] [-MountAtStartup <$true |
$false>] [-Name <String>] [-ProhibitPostQuota
<Unlimited>] [-PublicFolderReferralServerList
<MultiValuedProperty>] [-QuotaNotificationSchedule
<Schedule>] [-ReplicationMessageSize
<ByteQuantifiedSize>] [-ReplicationPeriod <UInt32>]
[-ReplicationSchedule <Schedule>]
[-RetainDeletedItemsUntilBackup <$true | $false>]
[-UseCustomReferralServerList <$true | $false>]

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)
Server\storage group\database name
Server\database name
Storage groupname\database name

If you do not specify the server name, the cmdlet will search for databases on the local server. If you have multiple databases with the same name, the cmdlet will retrieve 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.

DeletedItemRetention

Optional

Microsoft.Exchange.Data.EnhancedTimeSpan

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

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

To specify the fully qualified domain name (FQDN) of the domain controller that writes this configuration change to the Active Directory directory service, include the DomainController parameter in the command.

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.

Instance

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.PublicFolderDatabase

The Instance parameter enables you to pass an entire object to the command to be processed. It is mainly used in scripts where an entire object must be passed to the command.

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 are 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.

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 cannot post to a folder that is larger than the ProhibitPostQuota parameter value.

PublicFolderReferralServerList

Optional

Microsoft.Exchange.Data.MultiValuedProperty

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

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 are not removed until a backup of the public folder database is performed. The default value is $false.

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.

Detailed Description

To use the Set-PublicFolderDatabase cmdlet, the account you use must be delegated the following:

Exchange Server Administrator role and local Administrators group for the target server

For more information about permissions, delegating roles, and the rights that are required to administer Exchange Server 2007, see Permission Considerations.

Input Types

Return Types

Errors

Error	Description

Exceptions

Exceptions	Description

Example

In this example, the Set-PublicFolderDatabase command is used to set a new name for the public folder database.

	Copy Code
Set-PublicFolderDatabase -Identity "Public Folder Database" -Name "New Public Folder Database Name"