Applies to: Exchange Server 2013
Topic Last Modified: 2012-08-01
Use the Remove-PublicFolderMigrationRequest cmdlet to cancel or complete a migration request that was initiated using the New-PublicFolderMigrationRequest cmdlet. You use must this cmdlet to remove the public folder migration request before you can create another public folder migration request.
For information about the parameter sets in the Syntax section below, see Syntax.
Syntax
Remove-PublicFolderMigrationRequest -Identity
<PublicFolderMigrationRequestIdParameter> <COMMON
PARAMETERS>
|
Remove-PublicFolderMigrationRequest -RequestGuid
<Guid> -RequestQueue <DatabaseIdParameter> <COMMON
PARAMETERS>
|
COMMON PARAMETERS: [-Confirm [<SwitchParameter>]]
[-DomainController <Fqdn>] [-WhatIf
[<SwitchParameter>]]
|
Examples
EXAMPLE 1
This example cancels any public folder migration request that's actively running.
 Copy Code |
|
|---|---|
Get-PublicFolderMigrationRequest | Remove-PublicFolderMigrationRequest |
|
EXAMPLE 2
This example cancels a migration request by using the RequestGuid parameter for a mailbox on MBXDB01.
 Note: |
|---|
| The RequestGuid and RequestQueue parameters are for debugging purposes only. |
| Copy Code |
|
|---|---|
Remove-PublicFolderMigrationRequest -RequestQueue MBXDB01 -RequestGuid 25e0eaf2-6cc2-4353-b83e-5cb7b72d441f |
|
Detailed Description
The RequestQueue and RequestGuid parameters are for debugging purposes only.
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.
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
Identity |
Required |
Microsoft.Exchange.Management.RecipientTasks.PublicFolderMigrationRequestIdParameter |
The Identity parameter specifies the identity of the public folder migration request. You can't use this parameter in conjunction with the RequestGuid or RequestQueue parameters. |
|
RequestGuid |
Required |
System.Guid |
The RequestGuid parameter specifies the GUID of the migration request. If you specify the RequestGuid parameter, you must also specify the RequestQueue parameter. You can't use this parameter in conjunction with the Identity parameter. |
|
RequestQueue |
Required |
Microsoft.Exchange.Configuration.Tasks.DatabaseIdParameter |
The RequestQueue parameter specifies the database on which the migration request is queued. If you specify the RequestQueue parameter, you must also specify the RequestGuid parameter. You can use the following values:
You can't use this parameter in conjunction with the Identity parameter. |
|
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. |
|
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. |
|
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. |
Input Types
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.
Return Types
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.