Share via

Set-MailboxServer

  • Article

 

Applies to: Exchange Server 2007 SP1, Exchange Server 2007 SP2, Exchange Server 2007 SP3

Use the Set-MailboxServer cmdlet to modify attributes on an Exchange Mailbox server by specifying the Mailbox server's identity and the attributes that you want to modify.

Syntax

Set-MailboxServer -Identity <MailboxServerIdParameter> [-AutoDatabaseMountDial <Lossless | GoodAvailability | BestAvailability>] [-ClusteredStorageType <Disabled | NonShared | Shared>] [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-FolderLogForManagedFoldersEnabled <$true | $false>] [-ForcedDatabaseMountAfter <Unlimited>] [-JournalingLogForManagedFoldersEnabled <$true | $false>] [-Locale <MultiValuedProperty>] [-LogDirectorySizeLimitForManagedFolders <Unlimited>] [-LogFileAgeLimitForManagedFolders <EnhancedTimeSpan>] [-LogFileSizeLimitForManagedFolders <Unlimited>] [-LogPathForManagedFolders <LocalLongFullPath>] [-ManagedFolderAssistantSchedule <ScheduleInterval[]>] [-MAPIEncryptionRequired <$true | $false>] [-MessageTrackingLogEnabled <$true | $false>] [-MessageTrackingLogMaxAge <EnhancedTimeSpan>] [-MessageTrackingLogMaxDirectorySize <Unlimited>] [-MessageTrackingLogMaxFileSize <Unlimited>] [-MessageTrackingLogPath <LocalLongFullPath>] [-MessageTrackingLogSubjectLoggingEnabled <$true | $false>] [-RedundantMachines <MultiValuedProperty>] [-ReplicationNetworks <PrivateOnly | PrivateThenMixed | AllNetworks>] [-RetentionLogForManagedFoldersEnabled <$true | $false>] [-SubjectLogForManagedFoldersEnabled <$true | $false>] [-SubmissionServerOverrideList <MultiValuedProperty>] [-WhatIf [<SwitchParameter>]]

Set-MailboxServer [-AutoDatabaseMountDial <Lossless | GoodAvailability | BestAvailability>] [-ClusteredStorageType <Disabled | NonShared | Shared>] [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-FolderLogForManagedFoldersEnabled <$true | $false>] [-ForcedDatabaseMountAfter <Unlimited>] [-Instance <MailboxServer>] [-JournalingLogForManagedFoldersEnabled <$true | $false>] [-Locale <MultiValuedProperty>] [-LogDirectorySizeLimitForManagedFolders <Unlimited>] [-LogFileAgeLimitForManagedFolders <EnhancedTimeSpan>] [-LogFileSizeLimitForManagedFolders <Unlimited>] [-LogPathForManagedFolders <LocalLongFullPath>] [-ManagedFolderAssistantSchedule <ScheduleInterval[]>] [-MAPIEncryptionRequired <$true | $false>] [-MessageTrackingLogEnabled <$true | $false>] [-MessageTrackingLogMaxAge <EnhancedTimeSpan>] [-MessageTrackingLogMaxDirectorySize <Unlimited>] [-MessageTrackingLogMaxFileSize <Unlimited>] [-MessageTrackingLogPath <LocalLongFullPath>] [-MessageTrackingLogSubjectLoggingEnabled <$true | $false>] [-RedundantMachines <MultiValuedProperty>] [-ReplicationNetworks <PrivateOnly | PrivateThenMixed | AllNetworks>] [-RetentionLogForManagedFoldersEnabled <$true | $false>] [-SubjectLogForManagedFoldersEnabled <$true | $false>] [-SubmissionServerOverrideList <MultiValuedProperty>] [-WhatIf [<SwitchParameter>]]

Detailed Description

To run the Set-MailboxServer 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 Microsoft Exchange Server 2007, see Permission Considerations.

To modify the message tracking settings on a server that has both the Mailbox and the Hub Transport server roles installed, you can use the message tracking parameters with either the Set-MailboxServer cmdlet or the Set-TransportServer cmdlet. To modify the message tracking settings on a server that has the Mailbox server role installed but not the Hub Transport server role installed, you must use the message tracking parameters with the Set-MailboxServer cmdlet. To modify the message tracking settings on a server that has the Hub Transport server role installed but not the Mailbox server role installed, you must use the message tracking parameters with the Set-TransportServer cmdlet.

Parameters

Parameter Required Type Description

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 cluster continuous replication (CCR) solution after a clustered mailbox server failover. You can use the following values:

  • BestAvailability. If you specify this value, the databases will automatically mount 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 node that need to be replicated. If the copy queue length is more than six, the databases will not automatically mount. When the copy queue length is less than or equal to six, Exchange will attempt to replicate the remaining logs to the passive node and will mount the databases.

  • GoodAvailability. If you specify this value, the databases will automatically mount immediately after a failover if the copy queue length is less than or equal to three. The copy queue length is the number of logs recognized by the passive node that need to be replicated. If the copy queue length is more than three, the databases will not automatically mount. When the copy queue length is less than or equal to two, Exchange will attempt to replicate the remaining logs to the passive node and will mount the databases.

  • Lossless. If you specify this value, the databases will not automatically mount until all logs that were generated on the active node have been copied to the passive node.

The default value is BestAvailability. If you specify either BestAvailability or GoodAvailability, and all of the data on the active node has not been replicated to the passive node, you may lose some mailbox data. However, the transport dumpster feature (which is enabled by default) will help protect against data loss by resubmitting messages that are in the transport dumpster queue. For more information about the transport dumpster, see Cluster Continuous Replication.

If specifying one of these values results in a database not being mounted after a failover, you can use the ForcedDatabaseMountAfter parameter to force the database to mount after a specified amount of time.

For more information about the Lossless, GoodAvailability, and BestAvailability values, see Scheduled and Unscheduled Outages.

ClusteredStorageType

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.ClusteredStorageType

The ClusteredStorageType parameter specifies the type of shared storage for a clustered mailbox server. You can use the following values:

  • Disabled

  • NonShared (for cluster continuous replication)

  • Shared (for single copy cluster)

Confirm

Optional

System.Management.Automation.SwitchParameter

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

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.

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 will be logged.

ForcedDatabaseMountAfter

Optional

Microsoft.Exchange.Data.Unlimited

The ForcedDatabaseMountAfter parameter specifies the amount of time to wait after a clustered mailbox server failover before the databases will automatically mount. 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 time-out of two hours, enter 2:00:00.

If you set the AutoDatabaseMountDial parameter to GoodAvailability or BestAvailability, and the databases have lost more than the number of log files allowed based on the value of the AutoDatabaseMountDial parameter, then the Mailbox server will wait the amount of time specified by the ForcedDatabaseMountAfter parameter before automatically mounting the database.

Instance

Optional

Microsoft.Exchange.Data.Directory.Management.MailboxServer

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. It is included in the parameters table for developer reference.

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 will be 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. Some example are the following:

  • 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 will be deleted to make room 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[Storage Group 01][Mailbox Database 01]20061018-1.log, the prefix is Managed_Folder_Assistant[Storage Group 01][Mailbox Database 01]. If you rename log files or copy other files into the managed folder log directory, these files are not 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, 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 is not the size specified in the LogDirectorySizeLimitForManagedFolders parameter because the managed folder log files that are generated by different databases have different name prefixes. The maximum size of the managed folder log directory will be 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 is 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 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 to 6, where 0 = Sunday

The start time and end time must be at least 15 minutes apart. Minutes will be 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.

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 does not finish processing the mailboxes on the server during the time that you have scheduled, it automatically resumes processing where it left off the next time it runs.

MAPIEncryptionRequired

Optional

System.Boolean

The MAPIEncryptionRequired parameter specifies whether Exchange will block MAPI clients that do not use encrypted remote procedure calls (RPCs). The two possible values for this parameter are $true or $false.

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 that are older than the specified value are deleted. The default value is 30 days. To specify a value, enter the value 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 do not follow the name prefix convention are not 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 is not the specified maximum size because the message tracking log files that are 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 1 to 9223372036854775807 bytes.

MessageTrackingLogMaxFileSize

Optional

Microsoft.Exchange.Data.Unlimited

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 1 to 9223372036854775807 bytes.

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. In a single copy cluster (SCC) environment, move the message tracking log directory to a physical disk resource that is located on the shared storage resource. This enables searches of message tracking logs to continue to function if a failover occurs. 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, you will generate event log errors. The preferred method to disable message tracking is to use the MessageTrackingLogEnabled parameter.

MessageTrackingLogSubjectLoggingEnabled

Optional

System.Boolean

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

RedundantMachines

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The RedundantMachines parameter specifies the possible and preferred owners for cluster resources.

ReplicationNetworks

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.ReplicationNetworks

The ReplicationNetworks parameter is a deprecated parameter that does not function in Exchange Server 2007 RTM or SP1. You should not use this parameter when running the Set-MailboxServer cmdlet.

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 will be logged.

SubjectLogForManagedFoldersEnabled

Optional

System.Boolean

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

SubmissionServerOverrideList

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The SubmissionServerOverrideList parameter is a static list of Hub Transport servers (which exist in the same Active Directory site as the Mailbox server) that the Mailbox server will notify 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 are troubleshooting a Hub Transport server and do not 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.

WhatIf

Optional

System.Management.Automation.SwitchParameter

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

Input Types

Return Types

Errors

Error Description

 

Exceptions

Exceptions Description

 

Example

In this example, the Set-MailboxServer command is used to set the server override list to HubServer01, HubServer02, and HubServer03.

Set-MailboxServer -Identity Server1 -SubmissionServerOverrideList HubServer01,HubServer02,HubServer03