Get-TransportRule
This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other.
Use the Get-TransportRule cmdlet to view transport rules (mail flow rules) in your organization.
For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.
Syntax
Default (Default)
Get-TransportRule
[[-Identity] <RuleIdParameter>]
[-DomainController <Fqdn>]
[-State <RuleState>]
[-DlpPolicy <String>]
[-ExcludeConditionActionDetails <Boolean>]
[-Filter <String>]
[-ResultSize <Unlimited>]
[<CommonParameters>]
Description
On Mailbox servers, this cmdlet returns all rules in the Exchange organization that are stored in Active Directory. On an Edge Transport server, this cmdlet only returns rules that are configured on the local server.
You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't 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.
Examples
Example 1
Get-TransportRule
This example returns a summary list of all rules in your organization.
Example 2
Get-TransportRule "Ethical Wall - Sales and Brokerage Departments" | Format-List
This example returns detailed information for the rule named "Ethical Wall - Sales and Brokerage Departments".
For more information about pipelining, see About Pipelines. For more information about how to work with the output of a command, see Working with command output.
Example 3
Get-TransportRule -DlpPolicy "PII (U.S.)"
In on-premises Exchange, this example returns a summary list of the rules that enforce the DLP policy named PII (U.S.) in the organization.
Example 4
Get-TransportRule | Where {$_.DlpPolicy -ne $null}
In on-premises Exchange, this example returns a summary list of all rules that enforce DLP policies in the organization.
Parameters
-DlpPolicy
Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online
Note: This parameter is functional only in on-premises Exchange.
The DlpPolicy parameter filters the results by the name of the specified data loss prevention (DLP) policy. If the value contains spaces, enclose the value in quotation marks (").
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.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-DomainController
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE
This parameter is available only in on-premises Exchange.
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.
Parameter properties
| Type: | Fqdn |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ExcludeConditionActionDetails
Applicable: Exchange Online, Exchange Online Protection
This parameter is available only in the cloud-based service.
The ExcludeConditionActionDetails parameter specifies whether to hide specific details from the results. Valid values are:
- $true: The Description, Conditions, and Actions properties, as well as any configured condition, exception and action property values are blank.
- $false: No properties or property values are hidden. This value is the default.
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Filter
Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection
The Filter parameter filters the results by using an OPATH. 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 "Description -like 'Text*'". For example, "Description -like '192.168.1.1*'".
For detailed information about OPATH filters in Exchange, see Additional OPATH syntax information.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Identity
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection
The Identity parameter specifies the rule that you want to view. You can use any value that uniquely identifies the rule. For example:
- Name
- Distinguished name (DN)
- GUID
Parameter properties
| Type: | RuleIdParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 1 |
| Mandatory: | False |
| Value from pipeline: | True |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-ResultSize
Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection
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.
Parameter properties
| Type: | Unlimited |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-State
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Exchange Online Protection
The State parameter specifies filters the results by enabled or disabled rules. Valid values are:
- Enabled: Only enabled rules are returned in the results.
- Disabled: Only disabled rules are returned in the results.
If you don't use this parameter, the command returns all rules, both enabled and disabled.
Parameter properties
| Type: | RuleState |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs
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.
Outputs
Output 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.