Applies to: Exchange Server 2013, Exchange Online
Topic Last Modified: 2013-01-11
Use the Disable-TransportRule cmdlet to disable a specific transport rule for messages that pass through the Transport service on a Mailbox server.
For information about the parameter sets in the Syntax section below, see Syntax.
Syntax
Disable-TransportRule -Identity <RuleIdParameter>
[-Confirm [<SwitchParameter>]] [-DomainController
<Fqdn>] [-WhatIf [<SwitchParameter>]]
|
Examples
EXAMPLE 1
This example disables the transport rule Sales-Disclaimer.
Copy Code | |
---|---|
Disable-TransportRule "Sales-Disclaimer" |
Detailed Description
You can enable or disable specific transport rules at any time using the Disable-TransportRule and Enable-TransportRule cmdlets. To learn more about transport rules, see Transport Rules.
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 "Transport rules" entry in the Messaging Policy and Compliance Permissions topic.
Parameters
Parameter | Required | Type | Description |
---|---|---|---|
Identity |
Required |
Microsoft.Exchange.MessagingPolicies.Rules.Tasks.RuleIdParameter |
The Identity parameter specifies the rule you want to disable. Enter either the name or the GUID of the rule. You can omit the parameter label. |
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.