Export (0) Print
Expand All

Set-JournalRule

 

Applies to: Exchange Server 2007 SP3, Exchange Server 2007 SP2, Exchange Server 2007 SP1

Topic Last Modified: 2009-04-09

Use the Set-JournalRule cmdlet to modify an existing journal rule on a computer that has the Microsoft Exchange Server 2007 Hub Transport server role installed.


Set-JournalRule -Identity <RuleIdParameter> [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-JournalEmailAddress <RecipientIdParameter>] [-Name <String>] [-Recipient <Nullable>] [-Scope <Internal | External | Global>] [-WhatIf [<SwitchParameter>]]


Set-JournalRule [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-Instance <JournalRuleObject>] [-JournalEmailAddress <RecipientIdParameter>] [-Name <String>] [-Recipient <Nullable>] [-Scope <Internal | External | Global>] [-WhatIf [<SwitchParameter>]]

The Set-JournalRule cmdlet modifies an existing journal rule that is used with the Journaling agent.

To run the Set-JournalRule cmdlet, the account you use must be delegated the following:

  • Exchange Organization Administrator role

For more information about permissions, delegating roles, and the rights that are required to administer Exchange 2007, see Permission Considerations.

 

Parameter Required Type Description

Identity

Required

Microsoft.Exchange.MessagingPolicies.Rules.Tasks.RuleIdParameter

Use this parameter to specify the GUID or name of the rule to be modified.

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 writes this configuration change to the Active Directory directory service, include the DomainController parameter on the command.

Instance

Optional

Microsoft.Exchange.MessagingPolicies.Journaling.JournalRuleObject

Use this parameter to you to pass an entire object to the command to be processed. It is mainly used in scripts where an entire object must be passed to the command.

JournalEmailAddress

Optional

Microsoft.Exchange.Configuration.Tasks.RecipientIdParameter

Use this parameter to specify a recipient object to which journal reports are sent. Journal reports can be sent to a mailbox, a contact, a mail user, or a distribution group. However, a Public Folder should not be used as a JournalEmailAddress and is not a supported option.

Name

Optional

System.String

Use this parameter to modify the name of the journal rule. The name of the rule can be up to 64 characters long.

Recipient

Optional

System.Nullable

Use this parameter to specify 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 from a recipient are journaled.

Scope

Optional

Microsoft.Exchange.MessagingPolicies.Journaling.JournalRuleScope

Use this parameter to specify the e-mail messages to which the journal rule is applied. Valid values for this parameter are as follows:

  • 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 that are sent and received by recipients in the Exchange Server 2007 organization.

  • External   External rules process e-mail messages that are sent to recipients or from senders outside the Exchange Server 2007 organization.

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.

 

Error Description

 

 

Exceptions Description

 

The following example shows how to modify the journal e-mail address to which journal reports are sent by an existing journal rule.

Set-JournalRule "Brokerage Communications" -JournalEmailAddress "Archive Mailbox"
 
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft