Any suggestions? Export (0) Print
Expand All

Set-PublicFolderMigrationRequest

 

Applies to: Exchange Online, Exchange Server 2016

This cmdlet is available in on-premises Exchange Server 2016 and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Set-PublicFolderMigrationRequest cmdlet to change migration request options after the request has been created. You can use the Set-PublicFolderMigrationRequest cmdlet to recover from failed migration requests.

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

Set-PublicFolderMigrationRequest [-AcceptLargeDataLoss <SwitchParameter>] [-BadItemLimit <Unlimited>] [-BatchName <String>] [-CompletedRequestAgeLimit <Unlimited>] [-InternalFlags <InternalMrsFlag[]>] [-LargeItemLimit <Unlimited>] [-Priority <Lowest | Lower | Low | Normal | High | Higher | Highest | Emergency>] [-SkipMerging <SkippableMergeComponent[]>] <COMMON PARAMETERS>

Set-PublicFolderMigrationRequest -RemoteCredential <PSCredential> <COMMON PARAMETERS>

Set-PublicFolderMigrationRequest -RehomeRequest <SwitchParameter> <COMMON PARAMETERS>

COMMON PARAMETERS: -Identity <PublicFolderMigrationRequestIdParameter> [-AuthenticationMethod <Basic | Digest | Ntlm | Fba | WindowsIntegrated | LiveIdFba | LiveIdBasic | WSSecurity | Certificate | NegoEx | OAuth | Adfs | Kerberos | Negotiate | LiveIdNegotiate | Misconfigured>] [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-OutlookAnywhereHostName <Fqdn>] [-PreventCompletion <$true | $false>] [-RemoteMailboxLegacyDN <String>] [-RemoteMailboxServerLegacyDN <String>] [-RequestExpiryInterval <Unlimited>] [-WhatIf [<SwitchParameter>]]

This example changes the setting of the PublicFolderMigration migration request to accept up to five corrupted public folder items.

Set-PublicFolderMigrationRequest -Identity PublicFolderMigration -BadItemLimit 5

You can pipeline the Set-PublicFolderMigrationRequest cmdlet from the Get-PublicFolderMigrationRequestStatistics, Get-PublicFolderMigrationRequst, or the Get-PublicFolder cmdlets.

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 "Public folders" entry in the Sharing and collaboration permissions topic.

 

Parameter Required Type Description

Identity

Required

Microsoft.Exchange.MailboxReplicationService.PublicFolderMigrationRequestIdParameter

The Identity parameter specifies the identity of the public folder migration request.

RehomeRequest

Required

System.Management.Automation.SwitchParameter

This parameter is available only in on-premises Exchange 2016.

The RehomeRequest parameter specifies to the Microsoft Exchange Mailbox Replication service (MRS) that the request needs to be moved to the same database as the public folder being migrated. This parameter is used primarily for debugging purposes.

RemoteCredential

Required

System.Management.Automation.PSCredential

This parameter is available only in the cloud-based service.

The RemoteCredential parameter specifies an administrator who has permission to perform the migration request, for example, Administrator@humongousinsurance.com.

This parameter requires you to create a credentials object by using the Get-Credential cmdlet. For more information, see Get-Credential.

AcceptLargeDataLoss

Optional

System.Management.Automation.SwitchParameter

The AcceptLargeDataLoss switch specifies the request should continue even if a large number of items in the source mailbox can't be copied to the target mailbox. You need to use this switch if you set either the BadItemLimit or LargeItemLimit parameters to a value of 51 or higher. Otherwise, the command will fail.

AuthenticationMethod

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.AuthenticationMethod

This parameter is reserved for internal Microsoft use.

BadItemLimit

Optional

Microsoft.Exchange.Data.Unlimited

The BadItemLimit parameter specifies the maximum number of bad items that are allowed before the request fails. A bad item is a corrupt item in the source mailbox that can't be copied to the target mailbox. Also included in the bad item limit are missing items. Missing items are items in the source mailbox that can't be found in the target mailbox when the request is ready to complete.

Valid input for this parameter is an integer or the value unlimited. The default value is 0, which means the request will fail if any bad items are detected. If you are OK with leaving a few bad items behind, you can set this parameter to a reasonable value (we recommend 10 or lower) so the request can proceed. If too many bad items are detected, consider using the New-MailboxRepairRequest cmdlet to attempt to fix corrupted items in the source mailbox, and try the request again.

noteNote:
If you set this value to 51 or higher, you also need to use the AcceptLargeDataLoss switch. Otherwise, the command will fail.

BatchName

Optional

System.String

The BatchName parameter specifies a descriptive name for the public folder batch migration. You can use the BatchName parameter as a search string when you use the Get-PublicFolderMigrationRequest cmdlet.

CompletedRequestAgeLimit

Optional

Microsoft.Exchange.Data.Unlimited

The CompletedRequestAgeLimit parameter specifies how long the request is kept after it has completed before being automatically removed. The default CompletedRequestAgeLimit parameter value is 30 days.

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.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

This parameter is available only in on-premises Exchange 2016.

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.

InternalFlags

Optional

Microsoft.Exchange.Management.RecipientTasks.InternalMrsFlag[]

The InternalFlags parameter specifies the optional steps in the request. This parameter is used primarily for debugging purposes.

LargeItemLimit

Optional

Microsoft.Exchange.Data.Unlimited

The LargeItemLimit parameter specifies the maximum number of large items that are allowed before the request fails. A large item is a message in the source mailbox that exceeds the maximum message size that's allowed in the target mailbox. If the target mailbox doesn't have a specifically configured maximum message size value, the organization-wide value is used.

For more information about maximum message size values, see the following topics:

Valid input for this parameter is an integer or the value unlimited. The default value is 0, which means the request will fail if any large items are detected. If you are OK with leaving a few large items behind, you can set this parameter to a reasonable value (we recommend 10 or lower) so the request can proceed.

noteNote:
If you set this value to 51 or higher, you also need to use the AcceptLargeDataLoss switch. Otherwise, the command will fail.

OutlookAnywhereHostName

Optional

Microsoft.Exchange.Data.Fqdn

This parameter is reserved for internal Microsoft use.

PreventCompletion

Optional

System.Boolean

The PreventCompletion parameter specifies whether to run the migration request, but not allow it to complete. Valid values are:

  • $true   The migration request is run, but is not allowed to complete. To complete the migration request, set this parameter to $false before you run the Resume-PublicFolderMigrationRequest cmdlet.

  • $false   The migration request is run and allowed to complete. This is the default value.

Priority

Optional

Microsoft.Exchange.MailboxReplicationService.RequestPriority

This parameter is available only in on-premises Exchange 2016.

The Priority parameter specifies the order in which the request should be processed in the request queue. Requests are processed in order, based on server health, status, priority, and last update time. Valid priority values are:

  • Lowest

  • Lower

  • Low

  • Normal   This is the default value.

  • High

  • Higher

  • Highest

  • Emergency

RemoteMailboxLegacyDN

Optional

System.String

This parameter is available only in the cloud-based service.

The RemoteMailboxLegacyDN parameter specifies the ExchangeLegacyDN of the remote mailbox.

RemoteMailboxServerLegacyDN

Optional

System.String

This parameter is available only in the cloud-based service.

The RemoteMailboxServerLegacyDN parameter specifies the server legacy DN of the back-end server. To find the LegacyExchangeServerDN value, run the following command: Get-ExchangeServer <Identity> | Format-List LegacyExchangeServerDN.

RequestExpiryInterval

Optional

Microsoft.Exchange.Data.Unlimited

The RequestExpiryInterval parameter specifies an age limit for a completed or failed request. When you use this parameter, the completed or failed request is automatically removed after the specified interval expires. If you don't use this parameter:

  • The completed request is automatically removed based on the CompletedRequestAgeLimit parameter value.

  • If the request fails, you need to manually remove it by using the corresponding Remove-*Request cmdlet.

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

When you use the value Unlimited, the completed request isn't automatically removed.

SkipMerging

Optional

Microsoft.Exchange.Management.RecipientTasks.SkippableMergeComponent[]

The SkipMerging parameter specifies whether certain stages of a migration are to be skipped for debugging purposes. Don't use this parameter unless directed to do so by Microsoft Customer Service and Support or specific documentation.

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