Export (0) Print
Expand All
Related Help Topics
Loading
No resources found.
Related Blog Articles
Loading
No resources found.
Expand Minimize
This topic has not yet been rated - Rate this topic

Set-JournalRule

Exchange 2010
 

Applies to: Exchange Server 2010 SP3, Exchange Server 2010 SP2

Topic Last Modified: 2012-11-19

Use the Set-JournalRule cmdlet to modify an existing journal rule on a Hub Transport server.


Set-JournalRule -Identity <RuleIdParameter> [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-ExpiryDate <DateTime>] [-FullReport <$true | $false>] [-JournalEmailAddress <RecipientIdParameter>] [-LawfulInterception <SwitchParameter>] [-Name <String>] [-Recipient <SmtpAddress>] [-Scope <Internal | External | Global>] [-WhatIf [<SwitchParameter>]]

The Set-JournalRule cmdlet modifies an existing journal rule used by the Journaling agent on Hub Transport servers.

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.

 

Parameter Required Type Description

Identity

Required

Microsoft.Exchange.MessagingPolicies.Rules.Tasks.RuleIdParameter

The Identity parameter specifies the GUID or name of the rule to be modified.

The Identity parameter is a positional parameter. When using positional parameters in a command, you can omit the parameter label.

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.

ExpiryDate

Optional

System.DateTime

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 ExpiryDate parameter specifies when a journal rule that has lawful interception enabled should expire.

Use the short date format defined in the Regional Options settings for the computer on which the command is run. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 03/01/2010 to specify March 1, 2010. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, you must enclose the argument in quotation marks ("), for example, "10/05/2010 5:00 PM".

FullReport

Optional

System.Boolean

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 FullReport parameter specifies that if the LawfulInterception parameter is enabled, e-mail message content is journaled. If you don't specify this parameter, only the message header is journaled.

JournalEmailAddress

Optional

Microsoft.Exchange.Configuration.Tasks.RecipientIdParameter

The JournalEmailAddress parameter specifies a journal recipient. Journal reports for the specified rule are sent to the journal recipient.

LawfulInterception

Optional

System.Management.Automation.SwitchParameter

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 LawfulInterception parameter specifies that this journal rule is being used to conduct interception for a legal purpose, such as a search warrant. To use this parameter, you must also specify the Recipient parameter. Journal rules that have lawful interception enabled aren't written to the organization container of the tenant organization. Instead, they're written to the organization container of the hosting organization and therefore aren't viewable by the tenant organization.

Name

Optional

System.String

The Name parameter specifies the name of the journal rule. The name of the rule can be up to 64 characters.

Recipient

Optional

Microsoft.Exchange.Data.SmtpAddress

The Recipient parameter specifies the SMTP address of a mailbox, contact, or distribution group to journal. If you specify a distribution group, all recipients in that distribution group are journaled. All messages sent to or received from a recipient are journaled.

Scope

Optional

Microsoft.Exchange.MessagingPolicies.Journaling.JournalRuleScope

The Scope parameter specifies the scope of e-mail messages to which the journal rule is applied. You can use the following values:

  • Global   Global rules process all e-mail messages that pass through a Hub Transport server. This includes e-mail messages that were already processed by the external and internal rules. The default value is Global.
  • Internal   Internal rules process e-mail messages sent to and received by recipients in the Microsoft Exchange Server 2010 organization.
  • External   External rules process e-mail messages sent to recipients or from senders outside the Exchange 2010 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.

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.

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.

This example modifies the journal e-mail address to which journal reports are sent by the existing journal rule Consolidated Messenger.

Set-JournalRule "Consolidated Messenger" -JournalEmailAddress "ArchiveMailbox@contoso.com"
noteNote:
The Identity parameter is a positional parameter. When using positional parameters in a command, you can omit the parameter label. For more information about parameters, see Parameters.

This example modifies the journal e-mail address for all journal rules. The Get-JournalRule cmdlet is used to retrieve all journal rules. The results are piped to the Set-JournalRule cmdlet to modify the journal recipient.

Get-JournalRule | Set-JournalRule -JournalEmailAddress "Archive Mailbox"
 © 2010 Microsoft Corporation. All rights reserved.
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.