Import-TransportRuleCollection
Applies to: Exchange Server 2007 SP1, Exchange Server 2007 SP2, Exchange Server 2007 SP3
Use the Import-TransportRuleCollection cmdlet to import a previously exported transport rule collection for use by the Transport Rules agent on a computer that has the Microsoft Exchange Server 2007 Hub Transport server role or the Edge Transport server role installed.
Syntax
Import-TransportRuleCollection -FileName <String> [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-WhatIf [<SwitchParameter>]]
Detailed Description
The Import-TransportRuleCollection cmdlet imports a previously exported transport rule collection for use by the Transport Rules agent.
Warning
Importing a transport rule collection from an XML file removes or overwrites all preexisting transport rules that were defined for the Transport Rules agent. Make sure that you have a backup of your current transport rule collection before you import and overwrite your current transport rules.
On Hub Transport servers, the Import-TransportRuleCollection command overwrites all transport rules that are configured in the Exchange 2007 organization, except for transport rules on Edge Transport servers. On Edge Transport servers, this command overwrites transport rules that are configured on the local computer only.
For information about how to export a transport rule collection to an XML file, see Export-TransportRuleCollection.
For information about the Transport Rules agent, see Overview of Transport Rules.
To run the Import-TransportRuleCollection cmdlet, the account you use must be delegated the following:
- Exchange Organization Administrator role
To run the Import-TransportRuleCollection cmdlet on a computer that has the Edge Transport server role installed, you must log on by using an account that is a member of the local Administrators group on that computer.
For more information about permissions, delegating roles, and the rights that are required to administer Exchange 2007, see Permission Considerations.
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
FileName |
Required |
System.String |
Use this parameter to specify the full path and file name of the XML file to import. If the path or file name contains spaces, enclose the whole string in quotation marks. For example, |
Confirm |
Optional |
System.Management.Automation.SwitchParameter |
The Confirm parameter 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 parameter. |
DomainController |
Optional |
Microsoft.Exchange.Data.Fqdn |
To specify the fully qualified domain name (FQDN) of the domain controller that retrieves data from the Active Directory directory service, include the DomainController parameter in the command. The DomainController parameter is not supported on computers that run the Edge Transport server role. The Edge Transport server role writes only to the local Active Directory Application Mode (ADAM) instance. |
WhatIf |
Optional |
System.Management.Automation.SwitchParameter |
The WhatIf parameter instructs the command to simulate the actions that it would take on the object. By using the WhatIf parameter, 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 parameter. |
Input Types
Return Types
Errors
| Error | Description |
|---|---|
|
|
Exceptions
| Exceptions | Description |
|---|---|
|
|
Example
The following example shows the syntax of the Import-TransportRuleCollection command.
Import-TransportRuleCollection -FileName "c:\transport rules\new transport rules.xml"