Applies to: Exchange Server 2013
Topic Last Modified: 2012-07-27
Use the Suspend-PublicFolderMigrationRequest cmdlet to suspend a migration request any time after the request was created, but before it reaches the status of CompletionInProgress. You can resume the migration request by using the Resume-PublicFolderMigrationRequest cmdlet.
For information about the parameter sets in the Syntax section below, see Syntax.
Syntax
Suspend-PublicFolderMigrationRequest -Identity
<PublicFolderMigrationRequestIdParameter> [-Confirm
[<SwitchParameter>]] [-DomainController <Fqdn>]
[-SuspendComment <String>] [-WhatIf
[<SwitchParameter>]]
|
Examples
EXAMPLE 1
This example suspends the public folder migration request PFMigReq1.
 Copy Code |
|
|---|---|
Suspend-PublicFolderMigrationRequest -Identity PFMigReq1 |
|
EXAMPLE 2
This example suspends all migration requests that are
in progress by using the Get-PublicFolderMigrationRequest
cmdlet to retrieve all migration requests with a Status
value of InProgress, and then pipelining the output to
the Suspend-PublicFolderMigrationRequest cmdlet.
| Copy Code |
|
|---|---|
Get-PublicFolderMigrationRequest -Status InProgress | Suspend-PublicFolderMigrationRequest |
|
Detailed Description
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 migration request. This parameter accepts the following values:
|
|
Confirm |
Optional |
System.Management.Automation.SwitchParameter |
The Confirm switch can be used to suppress the
confirmation prompt that appears by default when this cmdlet is
run. To suppress the confirmation prompt, use the syntax
|
|
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. |
|
SuspendComment |
Optional |
System.String |
The SuspendComment parameter specifies a description as to why the request was suspended. |
|
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.