Applies to: Exchange Server 2013, Exchange Online
Topic Last Modified: 2012-09-17
Use the Export-TransportRuleCollection cmdlet to export the transport rules in your organization.
For information about the parameter sets in the Syntax section below, see Syntax.
Syntax
Export-TransportRuleCollection [-Identity
<RuleIdParameter>] [-Confirm [<SwitchParameter>]]
[-DomainController <Fqdn>] [-ExportLegacyRules
<SwitchParameter>] [-Organization
<OrganizationIdParameter>] [-WhatIf
[<SwitchParameter>]]
|
Examples
EXAMPLE 1
This example exports transport rules. Rule data is
first exported to the variable $file, and then written
to the XML file Rules.xml in the
C:\MyDocs folder.
 Copy Code |
|
|---|---|
$file = Export-TransportRuleCollection Set-Content -Path "C:\MyDocs\Rules.xml" -Value $file.FileData -Encoding Byte |
|
EXAMPLE 2
This example exports legacy transport rules created in Exchange 2007 using the ExportLegacyRules switch. The cmdlet should be run from an Exchange 2013 server. The exported rules collection can then be imported to Exchange 2013 using the Import-TransportRuleCollection cmdlet.
| Copy Code |
|
|---|---|
$file = Export-TransportRuleCollection -ExportLegacyRules Set-Content -Path "C:\MyDocs\LegacyRules.xml" -Value $file.FileData -Encoding Byte |
|
Detailed Description
The Export-TransportRuleCollection cmdlet can be used to export the transport rule collection in your organization. You can also export legacy transport rules created in Exchange Server 2007 and then import them to Microsoft Exchange Server 2013.
Exporting the rules collection is a two-step process. You first export the rules collection to a variable, and then use the Set-Content cmdlet to write the data to an XML file. For more information, see Set-Content.
For information about how to import a transport rule collection from an XML file, see Import-TransportRuleCollection.
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 |
|---|---|---|---|
|
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 retrieves data from Active Directory. |
|
ExportLegacyRules |
Optional |
System.Management.Automation.SwitchParameter |
The ExportLegacyRules switch is used to export transport rules created in previous versions of Exchange. |
|
Identity |
Optional |
Microsoft.Exchange.MessagingPolicies.Rules.Tasks.RuleIdParameter |
The Identity parameter is no longer used and will be deprecated. |
|
Organization |
Optional |
Microsoft.Exchange.Configuration.Tasks.OrganizationIdParameter |
The Organization parameter is reserved for internal Microsoft use. |
|
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.