TechNet
Export (0) Print
Expand All

Set-MailboxServer

 

Applies to: Exchange Server 2016

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

Use the Set-MailboxServer cmdlet to modify the mailbox configuration settings and attributes of Mailbox servers.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet 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>] [-Confirm [<SwitchParameter>]] [-DatabaseCopyActivationDisabledAndMoveNow <$true | $false>] [-DatabaseCopyAutoActivationPolicy <Unrestricted | IntrasiteOnly | Blocked>] [-DomainController <Fqdn>] [-FaultZone <String>] [-FolderLogForManagedFoldersEnabled <$true | $false>] [-ForceGroupMetricsGeneration <$true | $false>] [-IsExcludedFromProvisioning <$true | $false>] [-JournalingLogForManagedFoldersEnabled <$true | $false>] [-Locale <MultiValuedProperty>] [-LogDirectorySizeLimitForManagedFolders <Unlimited>] [-LogFileAgeLimitForManagedFolders <EnhancedTimeSpan>] [-LogFileSizeLimitForManagedFolders <Unlimited>] [-LogPathForManagedFolders <LocalLongFullPath>] [-ManagedFolderAssistantSchedule <ScheduleInterval[]>] [-MAPIEncryptionRequired <$true | $false>] [-MaximumActiveDatabases <Int32>] [-MaximumPreferredActiveDatabases <Int32>] [-MigrationLogFilePath <LocalLongFullPath>] [-MigrationLogLoggingLevel <None | Error | Warning | Information | Verbose | Instrumentation>] [-MigrationLogMaxAge <EnhancedTimeSpan>] [-MigrationLogMaxDirectorySize <ByteQuantifiedSize>] [-MigrationLogMaxFileSize <ByteQuantifiedSize>] [-RetentionLogForManagedFoldersEnabled <$true | $false>] [-SharingPolicySchedule <ScheduleInterval[]>] [-SubjectLogForManagedFoldersEnabled <$true | $false>] [-SubmissionServerOverrideList <MultiValuedProperty>] [-WacDiscoveryEndpoint <String>] [-WhatIf [<SwitchParameter>]]

This example changes some of the default settings of the Calendar Repair Assistant on the server named MBX01.

Set-MailboxServer -Identity MBX01 -CalendarRepairIntervalEndWindow 40 -CalendarRepairLogDirectorySizeLimit 750MB -CalendarRepairLogFileAgeLimit 15.00:00:00 -CalendarRepairLogPath "D:\Exchange Logs\Calendar Repair Assistant"

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 typically treated as bytes, but small values may be rounded up to the nearest kilobyte.

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 dd = days, hh = hours, mm = minutes, and ss = 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.

Confirm

Optional

System.Management.Automation.SwitchParameter

The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding.

  • Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false.

  • Most other cmdlets (for example, New-* and Set-* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding.

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 $truewon'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 or later versions of Exchange, 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.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com.

FaultZone

Optional

System.String

This parameter is reserved for internal Microsoft use.

FolderLogForManagedFoldersEnabled

Optional

System.Boolean

This parameter is used for coexistence with Exchange 2010. Specifically, this parameter works with messaging records management (MRM) 1.0 (managed folders). This parameter doesn't work with MRM 2.0 (retention policies) that were introduced in Exchange 2010 Service Pack 1 (SP1).

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.

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.

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

This parameter is used for coexistence with Exchange 2010. Specifically, this parameter works with messaging records management (MRM) 1.0 (managed folders). This parameter doesn't work with MRM 2.0 (retention policies) that were introduced in Exchange 2010 Service Pack 1 (SP1).

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 typically treated as bytes, but small values may be rounded up to the nearest kilobyte.

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

LogFileAgeLimitForManagedFolders

Optional

Microsoft.Exchange.Data.EnhancedTimeSpan

This parameter is used for coexistence with Exchange 2010. Specifically, this parameter works with messaging records management (MRM) 1.0 (managed folders). This parameter doesn't work with MRM 2.0 (retention policies) that were introduced in Exchange 2010 Service Pack 1 (SP1).

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 dd = days, hh = hours, mm = minutes, and ss = 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

This parameter is used for coexistence with Exchange 2010. Specifically, this parameter works with messaging records management (MRM) 1.0 (managed folders). This parameter doesn't work with MRM 2.0 (retention policies) that were introduced in Exchange 2010 Service Pack 1 (SP1).

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 typically treated as bytes, but small values may be rounded up to the nearest kilobyte.

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

LogPathForManagedFolders

Optional

Microsoft.Exchange.Data.LocalLongFullPath

This parameter is used for coexistence with Exchange 2010. Specifically, this parameter works with messaging records management (MRM) 1.0 (managed folders). This parameter doesn't work with MRM 2.0 (retention policies) that were introduced in Exchange 2010 Service Pack 1 (SP1).

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.

ManagedFolderAssistantSchedule

Optional

Microsoft.Exchange.Common.ScheduleInterval[]

This parameter is used for coexistence with Exchange 2010. Specifically, this parameter works with messaging records management (MRM) 1.0 (managed folders). This parameter doesn't work with MRM 2.0 (retention policies) that were introduced in Exchange 2010 Service Pack 1 (SP1).

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.

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

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.

RetentionLogForManagedFoldersEnabled

Optional

System.Boolean

This parameter is used for coexistence with Exchange 2010. Specifically, this parameter works with messaging records management (MRM) 1.0 (managed folders). This parameter doesn't work with MRM 2.0 (retention policies) that were introduced in Exchange 2010 Service Pack 1 (SP1).

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.

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

SubjectLogForManagedFoldersEnabled

Optional

System.Boolean

This parameter is used for coexistence with Exchange 2010. Specifically, this parameter works with messaging records management (MRM) 1.0 (managed folders). This parameter doesn't work with MRM 2.0 (retention policies) that were introduced in Exchange 2010 Service Pack 1 (SP1).

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.

WacDiscoveryEndpoint

Optional

System.String

PARAMVALUE: String

WhatIf

Optional

System.Management.Automation.SwitchParameter

The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this 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.

 
Show:
© 2016 Microsoft