Export (0) Print
Expand All
Expand Minimize

Get-TransportRule

 

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

Topic Last Modified: 2014-07-14

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

Use the Get-TransportRule cmdlet to view transport rules configured in your organization.

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

Get-TransportRule [-Identity <RuleIdParameter>] [-DlpPolicy <String>] [-DomainController <Fqdn>] [-Filter <String>] [-Organization <OrganizationIdParameter>] [-ResultSize <Unlimited>] [-State <Enabled | Disabled>]

This example returns all transport rules configured in your organization.

Get-TransportRule

This example returns only the rule that matches the name "Block email messages between Sales and Brokerage Groups". The command is piped to the Format-List cmdlet to display the detailed configuration of the specified transport rule.

Get-TransportRule "Block email messages between Sales and Brokerage Groups" | Format-List

For more information about pipelining, see Pipelining. For more information about how to work with the output of a command, see Working with command output.

This example returns the rules that are used to enforce the DLP policy PII (U.S.) in your organization.

Get-TransportRule -DlpPolicy "PII (U.S.)"

This example returns all rules in your organization that are used to enforce DLP policies in your organization. The command output is filtered to display only those rules that have a value for their DlpPolicy attribute.

Get-TransportRule | Where {$_.DlpPolicy -ne $null}

The Get-TransportRule cmdlet lets you view the configuration of transport rules that are defined in your organization.

For information about how to configure transport rules in your organization, see Set-TransportRule. 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.

 

Parameter Required Type Description

DlpPolicy

Optional

System.String

The DlpPolicy parameter specifies the data loss prevention (DLP) policy when you want to view the rules associated with a specific DLP policy. DLP policies in your organization allow you to prevent unintentional disclosure of sensitive information. Each DLP policy is enforced using a set of transport rules. If you want to view the rules that are used to support a specific DLP policy, use this parameter to specify the name of that policy.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

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

The DomainController parameter specifies the fully qualified domain name (FQDN) of the domain controller that retrieves data from Active Directory.

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.

Filter

Optional

System.String

The Filter parameter specifies an OPath filter that returns all transport rules that match the specified search criteria. This parameter searches the Description property, which includes the conditions, exceptions, actions and the associated values of a transport rule.

This parameter uses the syntax -Filter "Description -like '*<text>*'". For example, -Filter "Description -like *192.168.1.1*'".

Identity

Optional

Microsoft.Exchange.MessagingPolicies.Rules.Tasks.RuleIdParameter

The Identity parameter specifies the transport rule you want to view. Enter either the name or GUID of the rule. You can omit this parameter label.

Organization

Optional

Microsoft.Exchange.Configuration.Tasks.OrganizationIdParameter

The Organization parameter is reserved for internal Microsoft use.

ResultSize

Optional

Microsoft.Exchange.Data.Unlimited

The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000.

State

Optional

Microsoft.Exchange.MessagingPolicies.Rules.RuleState

The State parameter specifies whether to return only the rules that are enabled or the ones that are disabled. The following values are valid for this parameter:

  • Enabled   The command returns only the rules that are currently enabled.

  • Disabled   The command returns only the rules that are currently disabled.

If you don't use this parameter, the command returns all rules, both enabled and disabled.

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.

 
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft