Applies to: Exchange Server 2013
Topic Last Modified: 2013-01-16
Use the Get-ServerHealth cmdlet to return health information related to the server you specify.
For information about the parameter sets in the Syntax section below, see Syntax.
Syntax
Get-ServerHealth -Identity <ServerIdParameter>
[-HaImpactingOnly <SwitchParameter>] [-HealthSet
<String>]
|
Examples
EXAMPLE 1
This example returns the server health for server Server01.
 Copy Code |
|
|---|---|
Get-ServerHealth -Identity Server01 |
|
Detailed Description
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.
The cmdlet returns health values that you can use to determine the state of the server. See Server Health and Performance for related information.
The cmdlet also returns an alert value that provides the specific state of your server. The following values may be returned:
- Degraded
- Unhealthy
- Repairing
- Disabled
- Unavailable
- UnInitialized
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. |
|
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. |
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.