Set-MailboxServer

Identity

Required

Microsoft.Exchange.Configuration.Tasks.MailboxServerIdParameter

The Identity parameter specifies the Mailbox server. You can use the following values:

• GUID
  
• Distinguished name (DN)
  
• Name of a Mailbox server
  

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. You can use the following values:

• BestAvailability   If you specify this value, 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   If you specify this value, 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   If you specify this value, the database doesn't automatically mount until all logs that were generated on the active copy have been copied to the passive copy.
  

The default value is BestAvailability. 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 transport dumpster feature, (which is enabled by default) helps protect against data loss by resubmitting messages that are in the transport dumpster queue.

CalendarRepairIntervalEndWindow

Optional

System.Int32

The CalendarRepairIntervalEndWindow parameter specifies the number of days into the future to repair calendars. For example, if this parameter is set to 90, the Calendar Repair Assistant repairs calendars on this Mailbox server 90 days from now. The default value is 30 days.

CalendarRepairLogDirectorySizeLimit

Optional

Microsoft.Exchange.Data.Unlimited

The CalendarRepairLogDirectorySizeLimit parameter specifies the size limit for all log files for the Calendar Repair Assistant. After the limit is reached, the oldest files are deleted.

The maximum size of the calendar repair log directory is calculated as the total size of all log files that have the same name prefix. Other files that don't follow the name prefix convention 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.

Calendar repair log files for the Mailbox server role begin with the name prefix CRA.

The default value is unlimited. 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.

CalendarRepairLogEnabled

Optional

System.Boolean

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

The default value is $true.

CalendarRepairLogFileAgeLimit

Optional

Microsoft.Exchange.Data.EnhancedTimeSpan

The CalendarRepairLogFileAgeLimit parameter specifies how long to retain calendar repair logs. Log files that exceed the maximum retention period 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-day interval, enter 30.00:00:00. The default value is 00.00:00:00, which specifies that there's no limit on file retention (and not that files are overwritten immediately).

CalendarRepairLogPath

Optional

Microsoft.Exchange.Data.LocalLongFullPath

The CalendarRepairLogPath parameter specifies the path to the directory that stores the calendar repair log files. The default value is <Exchange installation path>\Logging\Calendar Repair Assistant.

CalendarRepairLogSubjectLoggingEnabled

Optional

System.Boolean

The CalendarRepairLogSubjectLoggingEnabled parameter specifies that the subject of the repaired calendar item is logged in the calendar repair log. The default value is $true.

CalendarRepairMissingItemFixDisabled

Optional

System.Boolean

The CalendarRepairMissingItemFixDisabled parameter specifies that the Calendar Repair Assistant won't fix missing attendee calendar items for mailboxes homed on this Mailbox server. The default value is $false.

CalendarRepairSchedule

Optional

Microsoft.Exchange.Common.ScheduleInterval[]

The CalendarRepairSchedule parameter specifies the intervals each week during which the Calendar Repair Assistant applies checks for calendar failures. 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 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 Calendar Repair 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.

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.

DatabaseCopyAutoActivationPolicy

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.DatabaseCopyAutoActivationPolicyType

The DatabaseCopyAutoActivationPolicy parameter specifies the type of automatic activation available for mailbox database copies on the selected Mailbox servers. Values for this parameter are:

• Blocked   Databases can't be automatically activated on the selected Mailbox servers.
  
• IntrasiteOnly    The database copy is allowed to be activated on servers in the same Active Directory site. This prevents cross-site failover or activation. This property is for incoming mailbox database copies (for example, a passive copy being made an active copy). Databases can't be activated on this Mailbox server for database copies that are active in another Active Directory site.
  
• Unrestricted   There are no special restrictions on activating mailbox database copies on the selected Mailbox servers.
  

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.

FolderLogForManagedFoldersEnabled

Optional

System.Boolean

The FolderLogForManagedFoldersEnabled parameter specifies whether the folder log for managed folders is enabled for messages that were moved to managed folders. The two possible values for this parameter are $true or $false. If you specify $true, information about folders that have managed folder mailbox policies applied to them is logged.

GroupMetricsGenerationEnabled

Optional

System.Boolean

The GroupMetricsGenerationEnabled parameter specifies that group metrics is enabled for the specified Mailbox server. By default, group metrics is enabled on the Mailbox server in your organization that generates the offline address book (OAB). Group metrics is the collection of data about distribution groups. For more information, see Understanding Group Metrics.

GroupMetricsGenerationTime

Optional

System.String

The GroupMetricsGenerationTime parameter specifies the time of day when group metrics data is generated on a Mailbox server. You must use the 24-hour clock notation (HH:MM) when specifying the generation time.

IsExcludedFromProvisioning

Optional

System.Boolean

The IsExcludedFromProvisioning parameter specifies that the Mailbox server isn't considered by the OAB provisioning load balancer. If the IsExcludedFromProvisioning parameter is set to $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 the log for managed folders is enabled for journaling. The two possible values for this parameter are $true or $false. If you specify $true, information about messages that were journaled is logged. The logs are located at the location you specify with the LogPathForManagedFolders parameter.

Locale

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The Locale parameter specifies the locale. 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 a complete list, see CultureInfo Class.

LogDirectorySizeLimitForManagedFolders

Optional

Microsoft.Exchange.Data.Unlimited

The LogDirectorySizeLimitForManagedFolders parameter specifies the size limit for all managed folder log files from a single message database. After the limit is reached for a set of managed folder log files from a message database, the oldest files are deleted to make space for new files.

The size of the managed folder log files is calculated as the total size of all log files that have the same name prefix. For example, for a file with the name Managed_Folder_Assistant[Mailbox Database 01]20061018-1.log, the prefix is Managed_Folder_Assistant[Mailbox Database 01]. If you rename log files or copy other files into the managed folder log directory, these files aren't counted in the log files size calculation. The managed folder log files for each message database have a unique name prefix. Therefore, this limit applies to the log files for each message database, and not to all the log files in the directory. If you have more than one message database, the maximum size of the managed folder log directory isn't the size specified in the LogDirectorySizeLimitForManagedFolders parameter because the managed folder log files generated by different databases have different name prefixes. The maximum size of the managed folder log directory is X times the specified value if you have X message databases.

You must specify either an integer or unlimited. The default value is unlimited. 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.

LogFileAgeLimitForManagedFolders

Optional

Microsoft.Exchange.Data.EnhancedTimeSpan

The LogFileAgeLimitForManagedFolders parameter specifies how long to retain managed folder logs. Log files that exceed the maximum retention period 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-day interval, enter 30.00:00:00. The default value is 00.00:00:00, which specifies that there's no limit on file retention (and not that files are overwritten immediately).

LogFileSizeLimitForManagedFolders

Optional

Microsoft.Exchange.Data.Unlimited

The LogFileSizeLimtiForManagedFolders parameter specifies the maximum size for each managed folder log file. When the log file size limit is reached, 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.

LogPathForManagedFolders

Optional

Microsoft.Exchange.Data.LocalLongFullPath

The LogPathForManagedFolders parameter specifies the path to the directory that stores the managed folder log files. The default value is <Exchange installation path>\Logging\Managed Folder Assistant.

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

MAPIEncryptionRequired

Optional

System.Boolean

The MAPIEncryptionRequired parameter specifies whether Exchange blocks MAPI clients that don't use encrypted remote procedure calls (RPCs). The two possible values for this parameter are $true or $false.

MaximumActiveDatabases

Optional

System.Nullable

The MaximumActiveDatabases parameter specifies the number of databases that can be mounted on this Mailbox server. This parameter accepts numeric values.

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 server won't allow databases to be mounted.

MaxTransportSyncDispatchers

Optional

System.Int32

This parameter is reserved for internal Microsoft use.

MessageTrackingLogEnabled

Optional

System.Boolean

The MessageTrackingLogEnabled parameter specifies whether message tracking is enabled. The default value is $true.

MessageTrackingLogMaxAge

Optional

Microsoft.Exchange.Data.EnhancedTimeSpan

The MessageTrackingLogMaxAge parameter specifies the message tracking log maximum file age. Log files older than the specified value are deleted. The default value is 30 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 valid input range for this parameter is 00:00:00 to 24855.03:14:07. Setting the value of the MessageTrackingLogMaxAge parameter to 00:00:00 prevents the automatic removal of message tracking log files because of their age.

MessageTrackingLogMaxDirectorySize

Optional

Microsoft.Exchange.Data.Unlimited

The MessageTrackingLogMaxDirectorySize parameter specifies the maximum size of the message tracking log directory. When the maximum directory size is reached, the server deletes the oldest log files first.

The maximum size of the message tracking log directory is calculated as the total size of all log files that have the same name prefix. Other files that don't follow the name prefix convention aren't counted in the total directory size calculation. Renaming old log files or copying other files into the message tracking log directory could cause the directory to exceed its specified maximum size.

When the Hub Transport server role and the Mailbox server role are installed on the same server, the maximum size of the message tracking log directory isn't the specified maximum size because the message tracking log files generated by the different server roles have different name prefixes. Message tracking log files for the Hub Transport server role or Edge Transport server role begin with the name prefix MSGTRK. Message tracking log files for the Mailbox server role begin with the name prefix MSGTRKM. When the Hub Transport server role and the Mailbox server role are installed on the same server, the maximum size of the message tracking log directory is two times the specified value.

The default value is 250 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. The value of the MessageTrackingLogMaxFileSize parameter must be less than or equal to the value of the MessageTrackingLogMaxDirectorySize parameter. The valid input range for either parameter is from 1 through 9223372036854775807 bytes.

MessageTrackingLogMaxFileSize

Optional

Microsoft.Exchange.Data.ByteQuantifiedSize

The MessageTrackingLogMaxFileSize parameter specifies the maximum size of the message tracking log files. When a log file reaches its maximum file size, a new log file is created. The default value is 10 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. The value of the MessageTrackingLogMaxFileSize parameter must be less than or equal to the value of the MessageTrackingLogMaxDirectorySize parameter. The valid input range for either parameter is from 1 through 4294967296 bytes (4 GB). If you enter a value of unlimited, no size limit is imposed on the message tracking log files.

MessageTrackingLogPath

Optional

Microsoft.Exchange.Data.LocalLongFullPath

The MessageTrackingLogPath parameter specifies the location of the message tracking logs. The default location is C:\Program Files\Microsoft\Exchange Server TransportRoles\Logs\MessageTracking. If you set the value of the MessageTrackingLogPath parameter to $null, you effectively disable message tracking. However, if you set the value of the MessageTrackingLogPath parameter to $null when the value of the MessageTrackingLogEnabled attribute is $true, event log errors occur. The preferred method to disable message tracking is to use the MessageTrackingLogEnabled parameter.

MessageTrackingLogSubjectLoggingEnabled

Optional

System.Boolean

The MessageTrackingLogSubjectLoggingEnabled parameter specifies if the message subject should be included in the message tracking log. The default value is $true.

RetentionLogForManagedFoldersEnabled

Optional

System.Boolean

The RetentionLogForManagedFoldersEnabled parameter specifies whether the Managed Folder Assistant logs information about messages that have reached their retention limits. The two possible values for this parameter are $true or $false. If you specify $true, information about messages that have been processed because they have reached their retention limits is logged.

SharingPolicySchedule

Optional

Microsoft.Exchange.Common.ScheduleInterval[]

The SharingPolicySchedule parameter specifies the intervals each week during which the sharing policy runs. 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.)
  

SubjectLogForManagedFoldersEnabled

Optional

System.Boolean

The SubjectLogForManagedFoldersEnabled parameter specifies whether the subject of messages is displayed in managed folder logs. The two possible values for this parameter are $true or $false. If you specify $false, the subject of messages is blank in the managed folder logs. The default value is $false.

SubmissionServerOverrideList

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The SubmissionServerOverrideList parameter specifies a static list of Hub Transport servers (which exist in the same Active Directory site as the Mailbox server) that the Mailbox server notifies when messages are ready for retrieval from a sender's outbox. This list overrides the list of dynamically discovered Hub Transport servers and can be used temporarily when you're troubleshooting a Hub Transport server and don't want it to receive mail submission notifications, or can be used to override the automatic load-balancing of notifications among all Hub Transport servers in the same Active Directory site as the Mailbox server.

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.

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.