Applies to: Exchange Server 2010 SP3, Exchange Server 2010 SP2
Topic Last Modified: 2012-11-19
Use the Export-JournalRuleCollection cmdlet to export journal rules to an XML file.
Syntax
Export-JournalRuleCollection [-Identity
<RuleIdParameter>] [-Confirm [<SwitchParameter>]]
[-DomainController <Fqdn>] [-ExportLegacyRules
<SwitchParameter>] [-Organization
<OrganizationIdParameter>] [-WhatIf
[<SwitchParameter>]]
|
Detailed Description
You can use the Export-JournalRuleCollection cmdlet to export journal rules from a Microsoft Exchange Server 2010 organization, or export legacy journal rules from Exchange Server 2007 and import them to Exchange 2010 using the Import-JournalRuleCollection cmdlet.
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 |
|---|---|---|---|
|
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 specifies whether to export Exchange 2007 journal rules. |
|
Identity |
Optional |
Microsoft.Exchange.MessagingPolicies.Rules.Tasks.RuleIdParameter |
The Identity parameter specifies the name of a journal rule. |
|
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 exports journal rules on an Exchange 2010 Hub Transport server in a two-step process. In the first step, the Export-JournalRuleCollection cmdlet is used to export journal rules to the array $file.
 Copy Code |
|
|---|---|
$file = Export-JournalRuleCollection |
|
In the second step, the Set-Content cmdlet is used to save the exported data to the XML file JournalRules.xml.
| Copy Code |
|
|---|---|
Set-Content -Path "C:\MyDocs\JournalRules.xml" -Value $file.FileData -Encoding Byte |
|
EXAMPLE 2
This example exports legacy journal rules to an XML file using the two-step process similar to the preceding example. In the first step, the Export-JournalRuleCollection cmdlet is used with the ExportLegacyRules switch to export legacy rules to the array $file.
| Copy Code |
|
|---|---|
$file = Export-JournalRuleCollection -ExportLegacyRules |
|
In the second step, the exported data is saved to the XML file Ex2007-JournallRules.xml.
| Copy Code |
|
|---|---|
Set-Content -Path "C:\MyDocs\Ex2007-JournalRules.xml" -Value $file.FileData -Encoding Byte |
|