Enable-TransportRule

 

Applies to: Exchange Online, Exchange Online Protection, Exchange Server 2016

Topic Last Modified: 2016-10-06

This cmdlet is available in on-premises Exchange Server 2016 and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Enable-TransportRule cmdlet to enable transport rules (mail flow rules) in your organization.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Enable-TransportRule -Identity <RuleIdParameter> [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-Mode <Audit | AuditAndNotify | Enforce>] [-WhatIf [<SwitchParameter>]]

This example enables the transport rule named Disclaimer Finance.

Enable-TransportRule -Identity "Disclaimer-Finance"

This example enables the transport rule named "Require approval of messages to contoso.com" in audit mode, so you can see how the rule would function by analyzing the related entries in the message tracking log.

Enable-TransportRule -Identity "Require approval of messages to contoso.com" -Mode Audit

To disable rules that are enabled, use the Disable-TransportRule cmdlet.

You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet.

 

Parameter Required Type Description

Identity

Required

Microsoft.Exchange.MessagingPolicies.Rules.Tasks.RuleIdParameter

The Identity parameter specifies the rule that you want to enable. You can use any value that uniquely identifies the rule. For example:

  • Name

  • Distinguished name (DN)

  • GUID

Confirm

Optional

System.Management.Automation.SwitchParameter

The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding.

  • Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false.

  • Most other cmdlets (for example, New-* and Set-* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

This parameter is available only in on-premises Exchange 2016.

The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com.

The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data.

Mode

Optional

Microsoft.Exchange.MessagingPolicies.Rules.RuleMode

The Mode parameter specifies how the rule operates after it's enabled. Valid values are:

  • Audit   The actions that the rule would have taken are written to the message tracking log, but no any action is taken on the message that would impact delivery.

  • AuditAndNotify   The rule operates the same as in Audit mode, but notifications are also enabled.

  • Enforce   All actions specified in the rule are taken. This is the default value.

WhatIf

Optional

System.Management.Automation.SwitchParameter

The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch.

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.

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.

 
Show: