Applies to: Exchange Server 2013
Topic Last Modified: 2013-01-08
Use the Get-HealthReport cmdlet to return health information related to the server you specify. You can use the health values to determine the state of the server.The cmdlet also returns an alert value that provides the specific state of your server.
For information about the parameter sets in the Syntax section below, see Syntax.
Syntax
Get-HealthReport -Identity <ServerIdParameter>
[-GroupSize <Int32>] [-HaImpactingOnly
<SwitchParameter>] [-HealthSet <String>]
[-MinimumOnlinePercent <Int32>] [-RollupGroup
<SwitchParameter>]
|
Examples
EXAMPLE 1
This example retrieves health information about a server running Microsoft Exchange Server 2013.
 Copy Code |
|
|---|---|
Get-HealthReport -RollupGroup |
|
Detailed Description
The following list contains the health values that are returned:
- Online
- Partially Online
- Offline
- Sidelined
- Functional
- Unavailable
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 "Test system health" entry in the Exchange and Shell Infrastructure Permissions topic.
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
Identity |
Required |
Microsoft.Exchange.Configuration.Tasks.ServerIdParameter |
The Identity parameter specifies the identity of the server you want health information for. |
|
GroupSize |
Optional |
System.Int32 |
The GroupSize parameter determines the size of the group to process against for a rollup. The default value is 12. |
|
HaImpactingOnly |
Optional |
System.Management.Automation.SwitchParameter |
The HaImpactingOnly switch specifies whether the cmdlet
must roll up only the monitors that have HaImpacting set to
|
|
HealthSet |
Optional |
System.String |
The HealthSet parameter returns the health state of a group of monitors. Monitors that are similar or are tied to a component’s architecture are grouped to form a health set. You can determine the collection of monitors (and associated probes and responders) in a given health set by using the Get-MonitoringItemIdentity cmdlet. |
|
MinimumOnlinePercent |
Optional |
System.Int32 |
The MinimumOnlinePercent parameter specifies the number of members in the group to be functioning with rollup information Degraded instead of Unhealthy. The default value is 70 percent. |
|
RollupGroup |
Optional |
System.Management.Automation.SwitchParameter |
The RollupGroup parameter specifies that the health data is rolled up across servers with redundancy limits. |
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.