Disable-JournalRule
Applies to: Exchange Server 2007 SP1, Exchange Server 2007 SP2, Exchange Server 2007 SP3
Use the Disable-JournalRule cmdlet to disable an existing journal rule on a computer that has the Hub Transport server role installed.
Syntax
Disable-JournalRule -Identity <RuleIdParameter> [-Confirm <SwitchParameter>] [-DomainController <Fqdn>] [-WhatIf [<SwitchParameter>]]
Detailed Description
The Disable-JournalRule cmdlet disables an existing rule that is used by the Journaling agent.
To run the Disable-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 Microsoft Exchange Server 2007, see Permission Considerations.
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
Identity |
Required |
Microsoft.Exchange.MessagingPolicies.Rules.Tasks.RuleIdParameter |
This parameter specifies the rule to be disabled. Enter either the GUID or the name of the journal rule. You can omit the Identity parameter label. |
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. |
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. |
Input Types
Return Types
Errors
| Error | Description |
|---|---|
Exceptions
| Exceptions | Description |
|---|---|
Example
The following example shows how to disable an existing journal rule.
Disable-JournalRule "Brokerage Communications"