Stop-ManagedFolderAssistant
Applies to: Exchange Server 2007 SP1, Exchange Server 2007 SP2, Exchange Server 2007 SP3
Use the Stop-ManagedFolderAssistant cmdlet to stop Messaging Records Management (MRM) processing of users' mailboxes on the specified servers immediately.
Syntax
Stop-ManagedFolderAssistant [-Identity <ServerIdParameter>] [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-WhatIf [<SwitchParameter>]]
Detailed Description
The Managed Folder Assistant uses the managed folder and Managed Folder Mailbox Policy settings of users to process mailbox items for retention and journaling as needed. Use the Stop-ManagedFolderAssistant cmdlet to stop the Managed Folder Assistant as soon as processing of the current mailbox is completed.
To run the Stop-ManagedFolderAssistant 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 Exchange Server 2007, see Permission Considerations.
Parameters
Parameter | Required | Type | Description |
---|---|---|---|
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 don't have to specify a value with the Confirm parameter. |
DomainController |
Optional |
Microsoft.Exchange.Data.Fqdn |
The DomainController parameter specifies the domain controller to use to write this configuration change to Active Directory. Use the fully qualified domain name (FQDN) of the domain controller that you want to use. |
Identity |
Optional |
Microsoft.Exchange.Configuration.Tasks.ServerIdParameter |
The Identity parameter specifies the names of servers on which managed folder assistants are to be stopped. If a server is not specified, the managed folder assistant on the local server is stopped. |
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 don't have to specify a value with the WhatIf parameter. |
Input Types
Return Types
Errors
Error | Description |
---|---|
Exceptions
Exceptions | Description |
---|---|
Example
In the first example, the Stop-ManagedFolderAssistant command is used without parameters. The Managed Folder Assistant is stopped as soon as processing of the current mailbox is completed on the current server.
In the second example, the Stop-ManagedFolderAssistant command is used for two servers, and the Managed Folder Assistant is stopped on both of the servers specified.
Stop-ManagedFolderAssistant
Stop-ManagedFolderAssistant -Identity ExchSrvr1, ExchSrvr2