Applies to: Exchange Server 2013, Exchange Online
Topic Last Modified: 2013-01-15
Use the Import-TransportRuleCollection cmdlet to import a transport rule collection. You can import a rule collection you previously exported as a backup, or import rules that you've exported from an older version of Exchange.
For information about the parameter sets in the Syntax section below, see Syntax.
Syntax
Import-TransportRuleCollection -FileData <Byte[]>
[-Identity <RuleIdParameter>] [-Confirm
[<SwitchParameter>]] [-DomainController <Fqdn>] [-Force
<SwitchParameter>] [-MigrationSource <None | Fope>]
[-Organization <OrganizationIdParameter>] [-WhatIf
[<SwitchParameter>]]
|
Examples
EXAMPLE 1
This example imports a transport rule collection from the XML file ExportedRules.xml.
 Copy Code |
|
|---|---|
[Byte[]]$Data = Get-Content -Path "C:\TransportRules\ExportedRules.xml" -Encoding Byte -ReadCount 0 Import-TransportRuleCollection -FileData $Data |
|
Detailed Description
 Caution: |
|---|
| Importing a transport rule collection from an XML file removes or overwrites all pre-existing transport rules that were defined in your organization. Make sure that you have a backup of your current transport rule collection before you import and overwrite your current transport rules. |
Importing file data is a two-step process. First you must load the data to a variable using the Get-Content cmdlet, and then use that variable to transmit the data to the cmdlet.
For information about how to export a transport rule collection to an XML file, see Export-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 |
|---|---|---|---|
|
FileData |
Required |
System.Byte[] |
The FileData parameter specifies the variable name that contains the content of the XML file. The content is retrieved using the Get-Content cmdlet. |
|
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. |
|
Force |
Optional |
System.Management.Automation.SwitchParameter |
The Force parameter specifies that the command will override any errors or warnings encountered during the import operation. |
|
Identity |
Optional |
Microsoft.Exchange.MessagingPolicies.Rules.Tasks.RuleIdParameter |
The Identity parameter is no longer used and will be deprecated. |
|
MigrationSource |
Optional |
Microsoft.Exchange.Data.Directory.Transport.MigrationSourceType |
This parameter is reserved for internal Microsoft use. |
|
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.