Remove-ActiveSyncMailboxPolicy
Applies to: Exchange Server 2007 SP1, Exchange Server 2007 SP2, Exchange Server 2007 SP3
The Remove-ActiveSyncMailboxPolicy cmdlet enables you to remove a specific Exchange ActiveSync mailbox policy from a Microsoft Exchange Server 2007 computer that has the Client Access server role installed.
Syntax
remove-ActiveSyncMailboxPolicy -Identity <MailboxPolicyIdParameter> [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-Force [<SwitchParameter>]] [-WhatIf [<SwitchParameter>]]
Detailed Description
An Exchange ActiveSync mailbox policy is a group of settings that specifies how mobile devices connect to Microsoft Exchange. Exchange 2007 supports multiple Exchange ActiveSync mailbox policies. The Remove-ActiveSyncMailboxPolicy cmdlet enables you to remove a specific Exchange ActiveSync mailbox policy from the Client Access server. If any users are assigned to the policy when you remove it, the Remove-ActiveSyncMailboxPolicy cmdlet will fail.
To run the Remove-ActiveSyncMailboxPolicy cmdlet, the account you use must be delegated the Exchange Organization Administrator role.
For more information about permissions, delegating roles, and the rights that are required to administer Exchange 2007, see Permission Considerations.
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
Identity |
Required |
Microsoft.Exchange.Configuration.Tasks.MailboxPolicyIdParameter |
This parameter specifies the policy name. |
Confirm |
Optional |
System.Management.Automation.SwitchParameter |
This parameter causes the command to pause processing and requires that you acknowledge what the command will do before processing continues. You do not have to specify a value with the Confirm parameter. |
DomainController |
Optional |
Microsoft.Exchange.Data.Fqdn |
To specify the fully qualified domain name (FQDN) of the domain controller that writes this configuration change to the Active Directory directory service, include the DomainController parameter in the command. |
Force |
Optional |
System.Management.Automation.SwitchParameter |
The Force parameter specifies that the command should run immediately and bypass confirmation prompts. |
WhatIf |
Optional |
System.Management.Automation.SwitchParameter |
This parameter instructs the command to simulate the actions that it would take on the object. By using this parameter, you can view what changes would occur without having to apply any of those changes. You do not have to specify a value with this parameter. |
Input Types
Return Types
Errors
| Error | Description |
|---|---|
|
|
Exceptions
| Exceptions | Description |
|---|---|
|
|
Example
The following code example removes the Exchange ActiveSync mailbox policy named SalesPolicy.
Remove-ActiveSyncMailboxPolicy -Identity "SalesPolicy"