Applies to: Exchange Server 2013
Topic Last Modified: 2013-01-11
Use the Test-ReplicationHealth cmdlet to check all aspects of replication and replay, or to provide status for a specific Mailbox server in a database availability group (DAG).
For information about the parameter sets in the Syntax section below, see Syntax.
Syntax
Test-ReplicationHealth [-Identity
<ServerIdParameter>] [-ActiveDirectoryTimeout <Int32>]
[-Confirm [<SwitchParameter>]] [-DomainController
<Fqdn>] [-MonitoringContext <$true | $false>]
[-OutputObjects <SwitchParameter>]
[-TransientEventSuppressionWindow <UInt32>] [-WhatIf
[<SwitchParameter>]]
|
Examples
EXAMPLE 1
This example tests the health of replication for the Mailbox server MBX1.
 Copy Code |
|
|---|---|
Test-ReplicationHealth -Identity MBX1 |
|
Detailed Description
The Test-ReplicationHealth cmdlet is designed for the proactive monitoring of continuous replication and the continuous replication pipeline, the availability of Active Manager, and the health and status of the underlying cluster service, quorum, and network components. The Test-ReplicationHealth cmdlet can be run locally or remotely against any Mailbox server in a DAG.
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 "Database availability groups" entry in the High Availability and Site Resilience Permissions topic.
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
ActiveDirectoryTimeout |
Optional |
System.Int32 |
The ActiveDirectoryTimeout parameter specifies the amount of time, in seconds, allowed for each directory service operation to complete before the operation times out. The default value is 15 seconds. |
|
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. |
|
Identity |
Optional |
Microsoft.Exchange.Configuration.Tasks.ServerIdParameter |
The Identity parameter specifies the name of the Mailbox server that you want to test. |
|
MonitoringContext |
Optional |
System.Boolean |
The MonitoringContext parameter includes or excludes the
associated monitoring events and performance counters in the
results. Valid input for this parameter is |
|
OutputObjects |
Optional |
System.Management.Automation.SwitchParameter |
The OutputObjects switch specifies whether to output an array of information regarding failures. |
|
TransientEventSuppressionWindow |
Optional |
System.UInt32 |
The TransientEventSuppressionWindow parameter specifies the number of minutes that the queue lengths can be exceeded before the queue length tests are considered to have failed. This parameter is used to reduce the number of failures due to transient load generation. |
|
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.