Export (0) Print
Expand All

Set-MailboxServer

 

Applies to: Exchange Server 2013

Topic Last Modified: 2015-01-08

This cmdlet is available only in on-premises Exchange Server 2013.

Use the Set-MailboxServer cmdlet to modify the mailbox configuration settings and attributes of an Exchange 2013 Mailbox server.

For information about the parameter sets in the Syntax section below, see Syntax.

Set-MailboxServer -Identity <MailboxServerIdParameter> [-AutoDagServerConfigured <$true | $false>] [-AutoDatabaseMountDial <Lossless | GoodAvailability | BestAvailability>] [-CalendarRepairIntervalEndWindow <Int32>] [-CalendarRepairLogDirectorySizeLimit <Unlimited>] [-CalendarRepairLogEnabled <$true | $false>] [-CalendarRepairLogFileAgeLimit <EnhancedTimeSpan>] [-CalendarRepairLogPath <LocalLongFullPath>] [-CalendarRepairLogSubjectLoggingEnabled <$true | $false>] [-CalendarRepairMissingItemFixDisabled <$true | $false>] [-CalendarRepairMode <ValidateOnly | RepairAndValidate>] [-CalendarRepairWorkCycle <EnhancedTimeSpan>] [-CalendarRepairWorkCycleCheckpoint <EnhancedTimeSpan>] [-Confirm [<SwitchParameter>]] [-DarTaskStoreTimeBasedAssistantWorkCycle <EnhancedTimeSpan>] [-DarTaskStoreTimeBasedAssistantWorkCycleCheckpoint <EnhancedTimeSpan>] [-DatabaseCopyActivationDisabledAndMoveNow <$true | $false>] [-DatabaseCopyAutoActivationPolicy <Unrestricted | IntrasiteOnly | Blocked>] [-DirectoryProcessorWorkCycle <EnhancedTimeSpan>] [-DirectoryProcessorWorkCycleCheckpoint <EnhancedTimeSpan>] [-DomainController <Fqdn>] [-FaultZone <String>] [-FolderLogForManagedFoldersEnabled <$true | $false>] [-ForceGroupMetricsGeneration <$true | $false>] [-GroupMailboxWorkCycle <EnhancedTimeSpan>] [-GroupMailboxWorkCycleCheckpoint <EnhancedTimeSpan>] [-InferenceDataCollectionWorkCycle <EnhancedTimeSpan>] [-InferenceDataCollectionWorkCycleCheckpoint <EnhancedTimeSpan>] [-InferenceTrainingWorkCycle <EnhancedTimeSpan>] [-InferenceTrainingWorkCycleCheckpoint <EnhancedTimeSpan>] [-IsExcludedFromProvisioning <$true | $false>] [-JournalingLogForManagedFoldersEnabled <$true | $false>] [-JunkEmailOptionsCommitterWorkCycle <EnhancedTimeSpan>] [-Locale <MultiValuedProperty>] [-LogDirectorySizeLimitForManagedFolders <Unlimited>] [-LogFileAgeLimitForManagedFolders <EnhancedTimeSpan>] [-LogFileSizeLimitForManagedFolders <Unlimited>] [-LogPathForManagedFolders <LocalLongFullPath>] [-MailboxAssociationReplicationWorkCycle <EnhancedTimeSpan>] [-MailboxAssociationReplicationWorkCycleCheckpoint <EnhancedTimeSpan>] [-MailboxProcessorWorkCycle <EnhancedTimeSpan>] [-ManagedFolderAssistantSchedule <ScheduleInterval[]>] [-ManagedFolderWorkCycle <EnhancedTimeSpan>] [-ManagedFolderWorkCycleCheckpoint <EnhancedTimeSpan>] [-MAPIEncryptionRequired <$true | $false>] [-MaximumActiveDatabases <Int32>] [-MaximumPreferredActiveDatabases <Int32>] [-MaxTransportSyncDispatchers <Int32>] [-MigrationLogFilePath <LocalLongFullPath>] [-MigrationLogLoggingLevel <None | Error | Warning | Information | Verbose | Instrumentation>] [-MigrationLogMaxAge <EnhancedTimeSpan>] [-MigrationLogMaxDirectorySize <ByteQuantifiedSize>] [-MigrationLogMaxFileSize <ByteQuantifiedSize>] [-OABGeneratorWorkCycle <EnhancedTimeSpan>] [-OABGeneratorWorkCycleCheckpoint <EnhancedTimeSpan>] [-PeopleCentricTriageWorkCycle <EnhancedTimeSpan>] [-PeopleCentricTriageWorkCycleCheckpoint <EnhancedTimeSpan>] [-PeopleRelevanceWorkCycle <EnhancedTimeSpan>] [-PeopleRelevanceWorkCycleCheckpoint <EnhancedTimeSpan>] [-ProbeTimeBasedAssistantWorkCycle <EnhancedTimeSpan>] [-ProbeTimeBasedAssistantWorkCycleCheckpoint <EnhancedTimeSpan>] [-PublicFolderWorkCycle <EnhancedTimeSpan>] [-PublicFolderWorkCycleCheckpoint <EnhancedTimeSpan>] [-RetentionLogForManagedFoldersEnabled <$true | $false>] [-SearchIndexRepairTimeBasedAssistantWorkCycle <EnhancedTimeSpan>] [-SearchIndexRepairTimeBasedAssistantWorkCycleCheckpoint <EnhancedTimeSpan>] [-SharePointSignalStoreWorkCycle <EnhancedTimeSpan>] [-SharePointSignalStoreWorkCycleCheckpoint <EnhancedTimeSpan>] [-SharingPolicySchedule <ScheduleInterval[]>] [-SharingPolicyWorkCycle <EnhancedTimeSpan>] [-SharingPolicyWorkCycleCheckpoint <EnhancedTimeSpan>] [-SharingSyncWorkCycle <EnhancedTimeSpan>] [-SharingSyncWorkCycleCheckpoint <EnhancedTimeSpan>] [-SiteMailboxWorkCycle <EnhancedTimeSpan>] [-SiteMailboxWorkCycleCheckpoint <EnhancedTimeSpan>] [-StoreDsMaintenanceWorkCycle <EnhancedTimeSpan>] [-StoreDsMaintenanceWorkCycleCheckpoint <EnhancedTimeSpan>] [-StoreIntegrityCheckWorkCycle <EnhancedTimeSpan>] [-StoreIntegrityCheckWorkCycleCheckpoint <EnhancedTimeSpan>] [-StoreMaintenanceWorkCycle <EnhancedTimeSpan>] [-StoreMaintenanceWorkCycleCheckpoint <EnhancedTimeSpan>] [-StoreScheduledIntegrityCheckWorkCycle <EnhancedTimeSpan>] [-StoreScheduledIntegrityCheckWorkCycleCheckpoint <EnhancedTimeSpan>] [-StoreUrgentMaintenanceWorkCycle <EnhancedTimeSpan>] [-StoreUrgentMaintenanceWorkCycleCheckpoint <EnhancedTimeSpan>] [-SubjectLogForManagedFoldersEnabled <$true | $false>] [-SubmissionServerOverrideList <MultiValuedProperty>] [-TopNWorkCycle <EnhancedTimeSpan>] [-TopNWorkCycleCheckpoint <EnhancedTimeSpan>] [-TransportSyncDispatchEnabled <$true | $false>] [-TransportSyncLogEnabled <$true | $false>] [-TransportSyncLogFilePath <LocalLongFullPath>] [-TransportSyncLogLoggingLevel <None | Error | Information | Verbose | RawData | Debugging>] [-TransportSyncLogMaxAge <EnhancedTimeSpan>] [-TransportSyncLogMaxDirectorySize <ByteQuantifiedSize>] [-TransportSyncLogMaxFileSize <ByteQuantifiedSize>] [-TransportSyncMailboxHealthLogEnabled <$true | $false>] [-TransportSyncMailboxHealthLogFilePath <LocalLongFullPath>] [-TransportSyncMailboxHealthLogMaxAge <EnhancedTimeSpan>] [-TransportSyncMailboxHealthLogMaxDirectorySize <ByteQuantifiedSize>] [-TransportSyncMailboxHealthLogMaxFileSize <ByteQuantifiedSize>] [-UMReportingWorkCycle <EnhancedTimeSpan>] [-UMReportingWorkCycleCheckpoint <EnhancedTimeSpan>] [-WhatIf [<SwitchParameter>]]

This example throttles the Calendar Repair Assistant to detect and repair calendar inconsistencies for the Mailbox server MBX02 in a 7-day period. During that 7-day period, all mailboxes will be scanned, and at the end of the period, the process will start over.

Set-MailboxServer -Identity MBX02 -CalendarRepairWorkCycle 7.00:00:00 -CalendarRepairWorkCycleCheckpoint 7.00:00:00

This example throttles the Managed Folder Assistant, which applies message retention settings to all mailboxes for the Mailbox server MBX02 in a 10-day period. During that 10-day period, all mailboxes will be scanned, and at the end of the period, the process will start over.

Set-MailboxServer -Identity MBX02 -ManagedFolderWorkCycle 10.00:00:00 -ManagedFolderWorkCycleCheckpoint 10.00:00:00

This example throttles the Sharing Policy and Sharing Sync Assistants to apply sharing policies, sync shared calendars, and free/busy information for the mailboxes on server MBX02 in a 7-day period. During that 7-day period, all mailboxes will be scanned, and at the end of the period, the process will start over.

Set-MailboxServer -Identity MBX02 -SharingPolicyWorkCycle 7.00:00:00 -SharingPolicyWorkCycleCheckpoint 7.00:00:00 -SharingSyncWorkCycle 7.00:00:00 -SharingSyncWorkCycleCheckpoint 7.00:00:00

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 Server Permissions" section in the Recipients Permissions topic.

 

Parameter Required Type Description

Identity

Required

Microsoft.Exchange.Configuration.Tasks.MailboxServerIdParameter

The Identity parameter specifies the Mailbox server that you want to modify. You can use any value that uniquely identifies the server. For example:

  • Name

  • Distinguished name (DN)

  • GUID

AutoDagServerConfigured

Optional

System.Boolean

This parameter is reserved for internal Microsoft use.

AutoDatabaseMountDial

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.AutoDatabaseMountDial

The AutoDatabaseMountDial parameter specifies the automatic database mount behavior for a continuous replication environment after a database failover on the Mailbox server. You can use the following values:

  • BestAvailability   The database automatically mounts immediately after a failover if the copy queue length is less than or equal to 12. The copy queue length is the number of logs recognized by the passive copy that needs to be replicated. If the copy queue length is more than 12, the database doesn't automatically mount. When the copy queue length is less than or equal to 12, Exchange attempts to replicate the remaining logs to the passive copy and mounts the database.

  • GoodAvailability   The database automatically mounts immediately after a failover if the copy queue length is less than or equal to six. The copy queue length is the number of logs recognized by the passive copy that needs to be replicated. If the copy queue length is more than six, the database doesn't automatically mount. When the copy queue length is less than or equal to six, Exchange attempts to replicate the remaining logs to the passive copy and mounts the database.

  • Lossless   The database doesn't automatically mount until all logs that were generated on the active copy have been copied to the passive copy. This setting also causes Active Manager's best copy selection algorithm to sort potential candidates for activation based on the database copy's activation preference value and not its copy queue length.

The default value is GoodAvailability. If you specify either BestAvailability or GoodAvailability, and all of the logs from the active copy haven't been replicated to the passive copy, you may lose some mailbox data. However, the Safety Net feature, (which is enabled by default) helps protect against data loss by resubmitting messages that are in Safety Net.

CalendarRepairIntervalEndWindow

Optional

System.Int32

The CalendarRepairIntervalEndWindow parameter specifies the number of days into the future to repair calendar items in mailboxes on the Mailbox server. The default value is 30. This means the Calendar Repair Assistant repairs meetings in calendars up to 30 days from now. Meetings that are scheduled to occur more than 30 days in the future aren't repaired.

CalendarRepairLogDirectorySizeLimit

Optional

Microsoft.Exchange.Data.Unlimited

The CalendarRepairLogDirectorySizeLimit parameter specifies the maximum size of calendar repair log directory on the Mailbox server. When the directory reaches its maximum size, the server deletes the oldest log files first.

Calendar repair log files begin with the name prefix CRA. The maximum size of the calendar repair log directory is calculated as the total size of all log files that have the CRA name prefix. Other files aren't counted in the total directory size calculation. Renaming old log files or copying other files into the calendar repair log directory could cause the directory to exceed its specified maximum size.

The default value is 500 megabytes (MB).

When you enter a value, qualify the value with one of the following units:

  • B (bytes)

  • KB (kilobytes)

  • MB (megabytes)

  • GB (gigabytes)

  • TB (terabytes)

Unqualified values are treated as bytes.

If you enter the value unlimited, no size limit is imposed on the calendar repair log directory.

CalendarRepairLogEnabled

Optional

System.Boolean

The CalendarRepairLogEnabled parameter specifies whether the Calendar Repair Attendant logs items that it repairs on the Mailbox server. The repair log doesn't contain failed repair attempts.

Valid input for this parameter is $true or $false. The default value is $true.

The value of this parameter affects the following parameters:

  • CalendarRepairLogDirectorySizeLimit

  • CalendarRepairLogFileAgeLimit

  • CalendarRepairLogPath

  • CalendarRepairLogSubjectLoggingEnabled

CalendarRepairLogFileAgeLimit

Optional

Microsoft.Exchange.Data.EnhancedTimeSpan

The CalendarRepairLogFileAgeLimit parameter specifies the calendar repair log maximum file age on the Mailbox server. Log files older than the specified value are deleted. The default value is 10 days.

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 30 days, enter 30.00:00:00. The value 00:00:00 prevents the automatic removal of calendar repair log files because of their age.

CalendarRepairLogPath

Optional

Microsoft.Exchange.Data.LocalLongFullPath

The CalendarRepairLogPath parameter specifies the location of the calendar repair log files on the Mailbox server. The default value is %ExchangeInstallPath%Logging\Calendar Repair Assistant.

CalendarRepairLogSubjectLoggingEnabled

Optional

System.Boolean

The CalendarRepairLogSubjectLoggingEnabled parameter specifies whether to include the subject of repaired calendar items in the calendar repair log on the Mailbox server. Valid input for this parameter is $true or $false. The default value is $true.

CalendarRepairMissingItemFixDisabled

Optional

System.Boolean

The CalendarRepairMissingItemFixDisabled parameter specifies whether the Calendar Repair Assistant won't fix missing calendar items in mailboxes on the Mailbox server. Valid input for this parameter is $true or $false. The default value is $false.

CalendarRepairMode

Optional

Microsoft.Exchange.Data.CalendarRepairType

The CalendarRepairMode parameter specifies the Calendar Repair Assistant mode on the Mailbox server. Valid values for this parameter are ValidateOnly or RepairAndValidate. The default value is RepairAndValidate.

CalendarRepairWorkCycle

Optional

Microsoft.Exchange.Data.EnhancedTimeSpan

The CalendarRepairWorkCycle parameter specifies the time span in which all mailboxes on the Mailbox server will be scanned by the Calendar Repair Assistant. The default value is 1 day.

Calendars that have inconsistencies will be flagged and repaired according to the interval specified by the CalendarRepairWorkCycleCheckpoint parameter.

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 2 days for this parameter, use 2.00:00:00. The Calendar Repair Assistant will then process all mailboxes on this server every 2 days.

CalendarRepairWorkCycleCheckpoint

Optional

Microsoft.Exchange.Data.EnhancedTimeSpan

The CalendarRepairWorkCycleCheckpoint parameter specifies the time span at which all mailboxes on the Mailbox server will be identified as needing work completed on them. The default value is 1 day.

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 2 days for this parameter, use 2.00:00:00. The Calendar Repair Assistant will then process all mailboxes on this server every 2 days.

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.

DarTaskStoreTimeBasedAssistantWorkCycle

Optional

Microsoft.Exchange.Data.EnhancedTimeSpan

This parameter is reserved for internal Microsoft use.

DarTaskStoreTimeBasedAssistantWorkCycleCheckpoint

Optional

Microsoft.Exchange.Data.EnhancedTimeSpan

This parameter is reserved for internal Microsoft use.

DatabaseCopyActivationDisabledAndMoveNow

Optional

System.Boolean

The DatabaseCopyActivationDisabledAndMoveNow parameter specifies whether to prevent databases from being mounted on this Mailbox server if there are other healthy copies of the databases on other Mailbox servers. It will also immediately move any mounted databases on the server to other servers if copies exist and are healthy.

Valid input for this parameter is $true or $false. The default value is $false.

Setting this parameter to $true won't cause databases to move to a server that has the DatabaseCopyAutoActivationPolicy parameter set to Blocked.

DatabaseCopyAutoActivationPolicy

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.DatabaseCopyAutoActivationPolicyType

The DatabaseCopyAutoActivationPolicy parameter specifies the type of automatic activation available for mailbox database copies on the specified Mailbox server. Valid values for this parameter are:

  • Blocked   Databases can't be automatically activated on the specified Mailbox server. In Exchange 2013 prior to Cumulative Update 7 (CU7), this setting stops server locator requests to the specified server, which prevents all client access to manually activated databases on the server if all DAG members are configured with a value of Blocked.

    In Exchange 2013 CU7, server locator requests are sent to a blocked server if no other Mailbox servers are available, thus client access is not impacted.

  • IntrasiteOnly   The database copy is allowed to be activated only on Mailbox servers in the same Active Directory site. This prevents cross-site failover and activation.

  • Unrestricted   There are no special restrictions on activating mailbox database copies on the specified Mailbox server. This is the default value.

DirectoryProcessorWorkCycle

Optional

Microsoft.Exchange.Data.EnhancedTimeSpan

This parameter is reserved for internal Microsoft use.

DirectoryProcessorWorkCycleCheckpoint

Optional

Microsoft.Exchange.Data.EnhancedTimeSpan

This parameter is reserved for internal Microsoft use.

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.

FaultZone

Optional

System.String

This parameter is reserved for internal Microsoft use.

FolderLogForManagedFoldersEnabled

Optional

System.Boolean

The FolderLogForManagedFoldersEnabled parameter specifies whether managed folder logging is enabled on the Mailbox server. Valid input for this parameter is $true or $false. The default value is $false.

If you specify $true, managed folder logging is enabled. Message activity in folders that have managed folder mailbox policies applied to them is logged.

The value of this parameter affects the following parameters:

  • JournalingLogForManagedFoldersEnabled

  • LogDirectorySizeLimitForManagedFolders

  • LogFileAgeLimitForManagedFolders

  • LogFileSizeLimitForManagedFolders

  • LogPathForManagedFolders

  • RetentionLogForManagedFoldersEnabled

  • SubjectLogForManagedFoldersEnabled

ForceGroupMetricsGeneration

Optional

System.Boolean

The ForceGroupMetricsGeneration parameter specifies that group metrics information must be generated on the Mailbox server regardless of whether that server generates an offline address book (OAB). Valid input for this parameter is $true or $false. The default value is $false.

By default, group metrics are generated only on servers that generate OABs. Group metrics information is used by MailTips to inform senders about how many recipients their messages will be sent to. You need to set this parameter to $true if your organization doesn't generate OABs and you want the group metrics data to be available.

GroupMailboxWorkCycle

Optional

Microsoft.Exchange.Data.EnhancedTimeSpan

This parameter is reserved for internal Microsoft use.

GroupMailboxWorkCycleCheckpoint

Optional

Microsoft.Exchange.Data.EnhancedTimeSpan

This parameter is reserved for internal Microsoft use.

InferenceDataCollectionWorkCycle

Optional

Microsoft.Exchange.Data.EnhancedTimeSpan

This parameter is reserved for internal Microsoft use.

InferenceDataCollectionWorkCycleCheckpoint

Optional

Microsoft.Exchange.Data.EnhancedTimeSpan

This parameter is reserved for internal Microsoft use.

InferenceTrainingWorkCycle

Optional

Microsoft.Exchange.Data.EnhancedTimeSpan

This parameter is reserved for internal Microsoft use.

InferenceTrainingWorkCycleCheckpoint

Optional

Microsoft.Exchange.Data.EnhancedTimeSpan

This parameter is reserved for internal Microsoft use.

IsExcludedFromProvisioning

Optional

System.Boolean

The IsExcludedFromProvisioning parameter specifies that the Mailbox server isn't considered by the OAB provisioning load balancer. Valid input for this parameter is $true or $false. The default value is $false.

If you specify $true, the server won't be used for provisioning a new OAB or for moving existing OABs.

JournalingLogForManagedFoldersEnabled

Optional

System.Boolean

The JournalingLogForManagedFoldersEnabled parameter specifies whether journaling activity is recorded in the managed folder log on the Mailbox server. Valid input for this parameter is $true or $false. The default value is $false.

If you specify $true, information about messages that were journaled in managed folders is logged. The managed folder log directory is specified by the LogPathForManagedFolders parameter.

JunkEmailOptionsCommitterWorkCycle

Optional

Microsoft.Exchange.Data.EnhancedTimeSpan

This parameter is reserved for internal Microsoft use.

Locale

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The Locale parameter specifies the locale of the Mailbox server. A locale is a collection of language-related user preferences such as writing system, calendar, and date format. The following are examples:

  • en-US (English - United States)

  • de-AT (German - Austria)

  • es-CL (Spanish - Chile)

For more information, see CultureInfo Class.

To enter multiple values and overwrite any existing entries, use the following syntax: <value1>,<value2>.... If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "<value1>","<value2>"....

To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="<value1>","<value2>"...; Remove="<value1>","<value2>"...}.

LogDirectorySizeLimitForManagedFolders

Optional

Microsoft.Exchange.Data.Unlimited

The LogDirectorySizeLimitForManagedFolders parameter specifies the maximum size of all managed folder logs from a single mailbox database in the managed folder log directory on the Mailbox server. When a set of log files reaches its maximum size, the server deletes the oldest log files first.

Every mailbox database on the server uses a different log file name prefix (for example, Managed_Folder_Assistant[Mailbox database name]). Therefore, the maximum size of the managed folder log directory is the number of mailbox databases multiplied by the value of the LogDirectorySizeLimitForManagedFolders parameter. Other files aren't counted in the total size calculation. Renaming old log files or copying other files into the managed folder log directory could cause the directory to exceed its specified maximum size.

When you enter a value, qualify the value with one of the following units:

  • B (bytes)

  • KB (kilobytes)

  • MB (megabytes)

  • GB (gigabytes)

  • TB (terabytes)

Unqualified values are treated as bytes.

The default value is unlimited, which means no size limit is imposed on the managed folder log directory.

LogFileAgeLimitForManagedFolders

Optional

Microsoft.Exchange.Data.EnhancedTimeSpan

The LogFileAgeLimitForManagedFolders parameter specifies how long to retain managed folder logs on the Mailbox server. Log files older than the specified value are deleted.

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 30 days, enter 30.00:00:00. The default value is 00:00:00, which prevents the automatic removal of managed folder log files because of their age.

LogFileSizeLimitForManagedFolders

Optional

Microsoft.Exchange.Data.Unlimited

The LogFileSizeLimitForManagedFolders parameter specifies the maximum size for each managed folder log file on the Mailbox server. When a log file reaches its maximum size, a new log file is created. The default value is 10 megabytes (MB).

When you enter a value, qualify the value with one of the following units:

  • B (bytes)

  • KB (kilobytes)

  • MB (megabytes)

  • GB (gigabytes)

  • TB (terabytes)

Unqualified values are treated as bytes.

If you enter the value unlimited, no size limit is imposed on a managed folder log file.

LogPathForManagedFolders

Optional

Microsoft.Exchange.Data.LocalLongFullPath

The LogPathForManagedFolders parameter specifies the location of the managed folder log files on the Mailbox server. The default value is %ExchangeInstallPath%Logging\ Managed Folder Assistant.

MailboxAssociationReplicationWorkCycle

Optional

Microsoft.Exchange.Data.EnhancedTimeSpan

This parameter is reserved for internal Microsoft use.

MailboxAssociationReplicationWorkCycleCheckpoint

Optional

Microsoft.Exchange.Data.EnhancedTimeSpan

This parameter is reserved for internal Microsoft use.

MailboxProcessorWorkCycle

Optional

Microsoft.Exchange.Data.EnhancedTimeSpan

The MailboxProcessorWorkCycle parameter specifies how often to scan for locked mailboxes on the Mailbox server. The default value is 1 day.

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

ManagedFolderAssistantSchedule

Optional

Microsoft.Exchange.Common.ScheduleInterval[]

The ManagedFolderAssistantSchedule parameter specifies the intervals each week during which the Managed Folder Assistant applies messaging records management (MRM) settings to managed folders in mailboxes on the Mailbox server. The interval format is StartDay.Time-EndDay.Time. 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

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 (The assistant 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" (The assistant will run on Monday and Wednesday mornings from 4:30 until 5:30.)

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

If the Managed Folder Assistant doesn't finish processing the mailboxes on the server during the time that you've scheduled, it automatically resumes processing where it left off the next time it runs.

ManagedFolderWorkCycle

Optional

Microsoft.Exchange.Data.EnhancedTimeSpan

The ManagedFolderWorkCycle parameter specifies the time span in which all mailboxes on the Mailbox server will be processed by the Managed Folder Assistant. The default value is 1 day.

The Managed Folder Assistant applies retention policies according to the ManagedFolderWorkCycleCheckpoint interval.

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 2 days for this parameter, use 2.00:00:00. The Managed Folder Assistant will then process all mailboxes on this server every 2 days.

ManagedFolderWorkCycleCheckpoint

Optional

Microsoft.Exchange.Data.EnhancedTimeSpan

The ManagedFolderWorkCycleCheckpoint parameter specifies the time span at which to refresh the list of mailboxes on the Mailbox server so that new mailboxes that have been created or moved will be part of the work queue. The default value is 1 day.

Also, as mailboxes are prioritized, existing mailboxes that haven't been successfully processed for a long time will be placed higher in the queue and will have a greater chance of being processed again in the same work cycle.

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 2 days for this parameter, use 2.00:00:00.

MAPIEncryptionRequired

Optional

System.Boolean

The MAPIEncryptionRequired parameter specifies whether Exchange blocks MAPI client connections to the Mailbox server that don't use encrypted remote procedure calls (RPCs). Valid input for this parameter is $true or $false. The default value is $false.

MaximumActiveDatabases

Optional

System.Int32

The MaximumActiveDatabases parameter specifies the maximum number of databases that can be mounted on the Mailbox server.

When the maximum number is reached, the database copies on the server won't be activated if a failover or switchover occurs. If the copies are already active on a server, the Information Store on the server won't allow databases to be mounted.

The default value is blank ($null), which means no maximum value is configured.

MaximumPreferredActiveDatabases

Optional

System.Int32

The MaximumPreferredActiveDatabases parameter specifies a preferred maximum number of databases that the Mailbox server should have. This value is different from the actual maximum, which is configured using the MaximumActiveDatabases parameter. The value of MaximumPreferredActiveDatabases is only honored during best copy and server selection, database and server switchovers, and when rebalancing the DAG.

The default value is blank ($null), which means no maximum value is configured.

MaxTransportSyncDispatchers

Optional

System.Int32

This parameter is reserved for internal Microsoft use.

MigrationLogFilePath

Optional

Microsoft.Exchange.Data.LocalLongFullPath

This parameter is reserved for internal Microsoft use.

MigrationLogLoggingLevel

Optional

Microsoft.Exchange.Data.MigrationEventType

This parameter is reserved for internal Microsoft use.

MigrationLogMaxAge

Optional

Microsoft.Exchange.Data.EnhancedTimeSpan

This parameter is reserved for internal Microsoft use.

MigrationLogMaxDirectorySize

Optional

Microsoft.Exchange.Data.ByteQuantifiedSize

This parameter is reserved for internal Microsoft use.

MigrationLogMaxFileSize

Optional

Microsoft.Exchange.Data.ByteQuantifiedSize

This parameter is reserved for internal Microsoft use.

OABGeneratorWorkCycle

Optional

Microsoft.Exchange.Data.EnhancedTimeSpan

The OABGeneratorWorkCycle parameter specifies the time span in which the OAB generation on the Mailbox server will be processed. The default value is 8 hours.

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 16 hours for this parameter, use 16:00:00.

OABGeneratorWorkCycleCheckpoint

Optional

Microsoft.Exchange.Data.EnhancedTimeSpan

The OABGeneratorWorkCycleCheckpoint parameter specifies the time span at which to run OAB generation on the Mailbox server. The default value is 1 hour.

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 2 hours for this parameter, use 02:00:00.

PeopleCentricTriageWorkCycle

Optional

Microsoft.Exchange.Data.EnhancedTimeSpan

This parameter is reserved for internal Microsoft use.

PeopleCentricTriageWorkCycleCheckpoint

Optional

Microsoft.Exchange.Data.EnhancedTimeSpan

This parameter is reserved for internal Microsoft use.

PeopleRelevanceWorkCycle

Optional

Microsoft.Exchange.Data.EnhancedTimeSpan

This parameter is reserved for internal Microsoft use.

PeopleRelevanceWorkCycleCheckpoint

Optional

Microsoft.Exchange.Data.EnhancedTimeSpan

This parameter is reserved for internal Microsoft use.

ProbeTimeBasedAssistantWorkCycle

Optional

Microsoft.Exchange.Data.EnhancedTimeSpan

This parameter is reserved for internal Microsoft use.

ProbeTimeBasedAssistantWorkCycleCheckpoint

Optional

Microsoft.Exchange.Data.EnhancedTimeSpan

This parameter is reserved for internal Microsoft use.

PublicFolderWorkCycle

Optional

Microsoft.Exchange.Data.EnhancedTimeSpan

The PublicFolderWorkCycle parameter is used by the public folder assistant to determine how often the mailboxes in a database are processed by the assistant on the Mailbox server. The default value is 1 day.

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

PublicFolderWorkCycleCheckpoint

Optional

Microsoft.Exchange.Data.EnhancedTimeSpan

The PublicFolderWorkCycleCheckpoint determines how often the mailbox list for a database is evaluated on the Mailbox server. The processing speed is also calculated. The default value is 1 day.

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

RetentionLogForManagedFoldersEnabled

Optional

System.Boolean

The RetentionLogForManagedFoldersEnabled parameter specifies whether retention policy activity is recorded in the managed folder log on the Mailbox server. Valid input for this parameter is $true or $false. The default value is $false.

If you specify $true, information about messages in managed folders that have been processed because they have reached their retention limits is logged. The managed folder log directory is specified by the LogPathForManagedFolders parameter.

SearchIndexRepairTimeBasedAssistantWorkCycle

Optional

Microsoft.Exchange.Data.EnhancedTimeSpan

This parameter is reserved for internal Microsoft use.

SearchIndexRepairTimeBasedAssistantWorkCycleCheckpoint

Optional

Microsoft.Exchange.Data.EnhancedTimeSpan

This parameter is reserved for internal Microsoft use.

SharePointSignalStoreWorkCycle

Optional

Microsoft.Exchange.Data.EnhancedTimeSpan

This parameter is reserved for internal Microsoft use.

SharePointSignalStoreWorkCycleCheckpoint

Optional

Microsoft.Exchange.Data.EnhancedTimeSpan

This parameter is reserved for internal Microsoft use.

SharingPolicySchedule

Optional

Microsoft.Exchange.Common.ScheduleInterval[]

The SharingPolicySchedule parameter specifies the intervals each week during which the sharing policy runs on the Mailbox server. The Sharing Policy Assistant checks permissions on shared calendar items and contact folders in users' mailboxes against the assigned sharing policy. The assistant lowers or removes permissions according to the policy. The format is StartDay.Time-EndDay.Time. 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

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 (The assistant will run from Saturday at 10:00 PM until Saturday 10:15 PM.)

SharingPolicyWorkCycle

Optional

Microsoft.Exchange.Data.EnhancedTimeSpan

The SharingPolicyWorkCycle parameter specifies the time span in which all mailboxes on the Mailbox server will be scanned by the Sharing Policy Assistant. The default value is 1 day.

The Sharing Policy Assistant scans all mailboxes and enables or disables sharing polices according to the interval specified by the SharingPolicyWorkCycle.

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 2 days for this parameter, use 2.00:00:00. The Sharing Policy Assistant will then process all mailboxes on this server every 2 days.

SharingPolicyWorkCycleCheckpoint

Optional

Microsoft.Exchange.Data.EnhancedTimeSpan

The SharingPolicyWorkCycleCheckpoint parameter specifies the time span at which to refresh the list of mailboxes on the Mailbox server so that new mailboxes that have been created or moved will be part of the work queue. The default value is 1 day.

Also, as mailboxes are prioritized, existing mailboxes that haven't been successfully processed for a long time will be placed higher in the queue and will have a greater chance of being processed again in the same work cycle.

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 2 days for this parameter, use 2.00:00:00. The Sharing Policy Assistant will then process all mailboxes on this server every 2 days.

SharingSyncWorkCycle

Optional

Microsoft.Exchange.Data.EnhancedTimeSpan

The SharingSyncWorkCycle parameter specifies the time span in which all mailboxes on the Mailbox server will be synced to the cloud-based service by the Sharing Sync Assistant. The default value is 3 hours.

Mailboxes that require syncing will be synced according to the interval specified by the SharingSyncWorkCycleCheckpoint parameter.

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 8 hours for this parameter, use 08:00:00. The Sharing Sync Assistant will then process all mailboxes on this server every 8 hours.

SharingSyncWorkCycleCheckpoint

Optional

Microsoft.Exchange.Data.EnhancedTimeSpan

The SharingSyncWorkCycleCheckpoint parameter specifies the time span at which to refresh the list of mailboxes on the Mailbox server so that new mailboxes that have been created or moved will be part of the work queue. The default value is 3 hours.

Also, as mailboxes are prioritized, existing mailboxes that haven't been successfully processed for a long time will be placed higher in the queue and will have a greater chance of being processed again in the same work cycle.

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 8 hours for this parameter, use 08:00:00. The Sharing Sync Assistant will then process all mailboxes on this server every 8 hours.

SiteMailboxWorkCycle

Optional

Microsoft.Exchange.Data.EnhancedTimeSpan

The SiteMailboxWorkCycle parameter specifies the time span in which the site mailbox information on the Mailbox server will be processed. The default value is 6 hours.

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 8 hours for this parameter, use 08:00:00.

SiteMailboxWorkCycleCheckpoint

Optional

Microsoft.Exchange.Data.EnhancedTimeSpan

The SiteMailboxWorkCycleCheckpoint parameter specifies the time span at which to refresh the site mailbox workcycle on the Mailbox server. The default value is 6 hours.

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 8 hours for this parameter, use 08:00:00.

StoreDsMaintenanceWorkCycle

Optional

Microsoft.Exchange.Data.EnhancedTimeSpan

This parameter is reserved for internal Microsoft use.

StoreDsMaintenanceWorkCycleCheckpoint

Optional

Microsoft.Exchange.Data.EnhancedTimeSpan

This parameter is reserved for internal Microsoft use.

StoreIntegrityCheckWorkCycle

Optional

Microsoft.Exchange.Data.EnhancedTimeSpan

This parameter is reserved for internal Microsoft use.

StoreIntegrityCheckWorkCycleCheckpoint

Optional

Microsoft.Exchange.Data.EnhancedTimeSpan

This parameter is reserved for internal Microsoft use.

StoreMaintenanceWorkCycle

Optional

Microsoft.Exchange.Data.EnhancedTimeSpan

This parameter is reserved for internal Microsoft use.

StoreMaintenanceWorkCycleCheckpoint

Optional

Microsoft.Exchange.Data.EnhancedTimeSpan

This parameter is reserved for internal Microsoft use.

StoreScheduledIntegrityCheckWorkCycle

Optional

Microsoft.Exchange.Data.EnhancedTimeSpan

This parameter is reserved for internal Microsoft use.

StoreScheduledIntegrityCheckWorkCycleCheckpoint

Optional

Microsoft.Exchange.Data.EnhancedTimeSpan

This parameter is reserved for internal Microsoft use.

StoreUrgentMaintenanceWorkCycle

Optional

Microsoft.Exchange.Data.EnhancedTimeSpan

This parameter is reserved for internal Microsoft use.

StoreUrgentMaintenanceWorkCycleCheckpoint

Optional

Microsoft.Exchange.Data.EnhancedTimeSpan

This parameter is reserved for internal Microsoft use.

SubjectLogForManagedFoldersEnabled

Optional

System.Boolean

The SubjectLogForManagedFoldersEnabled parameter specifies whether to include the subject of messages in the managed folder logs on the Mailbox server. Valid input for this parameter is $true or $false. The default value is $false.

By default, the subject of messages is blank in the managed folder log.

SubmissionServerOverrideList

Optional

Microsoft.Exchange.Data.MultiValuedProperty

This parameter is reserved for internal Microsoft use.

TopNWorkCycle

Optional

Microsoft.Exchange.Data.EnhancedTimeSpan

The TopNWorkCycle parameter specifies the time span in which all mailboxes that have Unified Messaging on the Mailbox server will be scanned by the TopN Words Assistant. The default value is 7 days.

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

The TopN Words Assistant scans voice mail for the most frequently used words to aid in transcription. The most common words are then indexed according to the interval specified by the TopNWorkCycleCheckpoint parameter.

For example, to specify 10 days for this parameter, use 10.00:00:00. The TopN Words Assistant will then process all mailboxes on which Unified Messaging is enabled on this server every 10 days.

TopNWorkCycleCheckpoint

Optional

Microsoft.Exchange.Data.EnhancedTimeSpan

The TopNWorkCycleCheckpoint parameter specifies the time span at which to refresh the list of mailboxes on the Mailbox server so that new mailboxes that have been created or moved will be part of the work queue. The default value is 1 day.

Also, as mailboxes are prioritized, existing mailboxes that haven't been successfully processed for a long time will be placed higher in the queue and will have a greater chance of being processed again in the same work cycle.

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 2 days for this parameter, use 2.00:00:00. The TopN Words Assistant will then process all mailboxes on this server every 2 days.

TransportSyncDispatchEnabled

Optional

System.Boolean

This parameter is reserved for internal Microsoft use.

TransportSyncLogEnabled

Optional

System.Boolean

This parameter is reserved for internal Microsoft use.

TransportSyncLogFilePath

Optional

Microsoft.Exchange.Data.LocalLongFullPath

This parameter is reserved for internal Microsoft use.

TransportSyncLogLoggingLevel

Optional

Microsoft.Exchange.Data.SyncLoggingLevel

This parameter is reserved for internal Microsoft use.

TransportSyncLogMaxAge

Optional

Microsoft.Exchange.Data.EnhancedTimeSpan

This parameter is reserved for internal Microsoft use.

TransportSyncLogMaxDirectorySize

Optional

Microsoft.Exchange.Data.ByteQuantifiedSize

This parameter is reserved for internal Microsoft use.

TransportSyncLogMaxFileSize

Optional

Microsoft.Exchange.Data.ByteQuantifiedSize

This parameter is reserved for internal Microsoft use.

TransportSyncMailboxHealthLogEnabled

Optional

System.Boolean

This parameter is reserved for internal Microsoft use.

TransportSyncMailboxHealthLogFilePath

Optional

Microsoft.Exchange.Data.LocalLongFullPath

This parameter is reserved for internal Microsoft use.

TransportSyncMailboxHealthLogMaxAge

Optional

Microsoft.Exchange.Data.EnhancedTimeSpan

This parameter is reserved for internal Microsoft use.

TransportSyncMailboxHealthLogMaxDirectorySize

Optional

Microsoft.Exchange.Data.ByteQuantifiedSize

This parameter is reserved for internal Microsoft use.

TransportSyncMailboxHealthLogMaxFileSize

Optional

Microsoft.Exchange.Data.ByteQuantifiedSize

This parameter is reserved for internal Microsoft use.

UMReportingWorkCycle

Optional

Microsoft.Exchange.Data.EnhancedTimeSpan

The UMReportingWorkCycle parameter specifies the time span in which the arbitration mailbox named SystemMailbox{e0dc1c29-89c3-4034-b678-e6c29d823ed9} on the Mailbox server will be scanned by the Unified Messaging Reporting Assistant. The default value is 1 day.

The Unified Messaging Reporting Assistant updates the Call Statistics reports by reading Unified Messaging call data records for an organization on a regular basis.

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 2 days for this parameter, use 2.00:00:00. The Unified Messaging Reporting Assistant will then process all mailboxes that have Unified Messaging enabled on this server every 2 days.

NoteNote:
Changing the default work cycle for this assistant might impact the performance of the Mailbox server.

UMReportingWorkCycleCheckpoint

Optional

Microsoft.Exchange.Data.EnhancedTimeSpan

The UMReportingWorkCycleCheckpoint parameter specifies the time span at which the arbitration mailbox named SystemMailbox{e0dc1c29-89c3-4034-b678-e6c29d823ed9} on the Mailbox server will be marked by processing. The default value is 1 day.

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 2 days for this parameter, use 2.00:00:00.

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.

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.

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.

 
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2015 Microsoft