Applies to: Exchange Server 2013, Exchange Online
Topic Last Modified: 2012-07-12
Use the Export-JournalRuleCollection cmdlet to export the journal rules in your organization to an XML file.
For information about the parameter sets in the Syntax section below, see Syntax.
Syntax
Export-JournalRuleCollection [-Identity
<RuleIdParameter>] [-Confirm [<SwitchParameter>]]
[-DomainController <Fqdn>] [-ExportLegacyRules
<SwitchParameter>] [-Organization
<OrganizationIdParameter>] [-WhatIf
[<SwitchParameter>]]
|
Examples
EXAMPLE 1
This example exports journal rules in a two-step
process. In the first step, the Export-JournalRuleCollection
cmdlet exports journal rules to the variable $file. In
the second step, the Set-Content cmdlet saves the exported
data to the XML file JournalRules.xml.
 Copy Code |
|
|---|---|
$file = Export-JournalRuleCollection 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. In the second step, the
exported data is saved to the XML file LegacyJournallRules.xml.
| Copy Code |
|
|---|---|
$file = Export-JournalRuleCollection -ExportLegacyRules Set-Content -Path "C:\MyDocs\LegacyJournalRules.xml" -Value $file.FileData -Encoding Byte |
|
Detailed Description
You can use the Export-JournalRuleCollection cmdlet to export journal rules in your organization to create a backup copy of your rules. You can also export legacy journal rules from Exchange Server 2007 and import them to Microsoft Exchange Server 2013 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 journal rules created in previous versions of Exchange. |
|
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 |
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.