Applies to: Exchange Server 2010 SP3, Exchange Server 2010 SP2
Topic Last Modified: 2012-11-19
Use the Import-JournalRuleCollection cmdlet to import journal rules exported to an XML file, including legacy journal rules exported from Microsoft Exchange Server 2007 to an Exchange Server 2010 organization.
Syntax
Import-JournalRuleCollection -FileData <Byte[]>
[-Identity <RuleIdParameter>] [-Confirm
[<SwitchParameter>]] [-DomainController <Fqdn>]
[-Organization <OrganizationIdParameter>] [-WhatIf
[<SwitchParameter>]]
|
Detailed Description
The Import-JournalRuleCollection cmdlet imports a previously exported journal rule collection for use by the Journaling agent.
 Caution: |
|---|
| Importing a journal rule collection from an XML file removes or overwrites all pre-existing journal rules that were defined for the Journaling agent. Make sure that you have a backup of your current journal rule collection before you import and overwrite your current journal 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 "Journaling" 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 in the first step of the two-step process used to import file content. For more information about the syntax required to use this parameter, see Understanding Importing and Exporting Files in the Exchange Management Shell. |
|
Confirm |
Optional |
System.Management.Automation.SwitchParameter |
The Confirm switch can be used to suppress the
confirmation prompt that appears by default when this cmdlet is
run. To suppress the confirmation prompt, use the syntax
|
|
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. |
|
Identity |
Optional |
Microsoft.Exchange.MessagingPolicies.Rules.Tasks.RuleIdParameter |
The Identity parameter specifies the name of a journal rule to be imported. |
|
Organization |
Optional |
Microsoft.Exchange.Configuration.Tasks.OrganizationIdParameter |
This parameter is available for multi-tenant deployments. It isn't available for on-premises deployments. For more information about multi-tenant deployments, see Multi-Tenant Support. The Organization parameter specifies the organization in which you'll perform this action. This parameter doesn't accept wildcard characters, and you must use the exact name of the organization. |
|
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.
Examples
EXAMPLE 1
This example imports journal rules from the XML file ExportedJournalRules.xml in a two-step process.
The first step retrieves journal rules from the previously exported XML file ExportedJournalRules.xml using the Get-Content cmdlet, and stores the results in the variable $Data.
 Copy Code |
|
|---|---|
[Byte[]]$Data = Get-Content -Path "C:\JournalRules\ExportedJournalRules.xml" -Encoding Byte -ReadCount 0 |
|
The second step retrieves data from the variable $Data and imports journal rules to the Exchange 2010 organization, overwriting existing journal rules.
| Copy Code |
|
|---|---|
Import-JournalRuleCollection -FileData $Data |
|