Disable-TransportRule
Applies to: Exchange Server 2007 SP1, Exchange Server 2007 SP2, Exchange Server 2007 SP3
Use the Disable-TransportRule cmdlet to instruct the Transport Rules agent to disable the processing of a specific transport rule for all e-mail messages that pass through a computer that has the Microsoft Exchange Server 2007 Hub Transport server role or the Edge Transport server role installed.
Syntax
Disable-TransportRule -Identity <RuleIdParameter> [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-WhatIf [<SwitchParameter>]]
Detailed Description
The Disable-TransportRule cmdlet instructs the Transport Rules agent to disable the processing of a specific transport rule for all e-mail messages that pass through a Hub Transport server or an Edge Transport server.
For information about how to enable the processing of transport rules against e-mail messages in an Exchange 2007 organization, see Enable-TransportRule.
For information about the Transport Rules agent, see Overview of Transport Rules.
To run the Disable-TransportRule cmdlet, the account you use must be delegated the following:
- Exchange Organization Administrator role
To run the Disable-TransportRule cmdlet on a computer that has the Edge Transport server role installed, you must log on by using an account that is a member of the local Administrators group on that computer.
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.MessagingPolicies.Rules.Tasks.RuleIdParameter |
Use this parameter to specify the rule to be disabled. Enter either the GUID or the Name of the rule. You can omit the Identity parameter label. |
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 |
To specify the fully qualified domain name (FQDN) of the domain controller that retrieves data from the Active Directory directory service, include the DomainController parameter in the command. The DomainController parameter is not supported on computers that run the Edge Transport server role. The Edge Transport server role writes only to the local Active Directory Application Mode (ADAM) instance. |
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
The following example shows the syntax of the Disable-TransportRule command.
Disable-TransportRule "Block e-mail messages between Sales and Brokerage groups"