Get-ServerHealth

This cmdlet is available only in on-premises Exchange. 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 Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx).

Syntax

Get-ServerHealth
   [-Identity] <ServerIdParameter>
   [-HaImpactingOnly]
   [-HealthSet <String>]
   [<CommonParameters>]

Description

You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx).

The cmdlet returns health values that you can use to determine the state of the server. See Server health and performance (https://technet.microsoft.com/library/jj150551.aspx) 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

Examples

-------------------------- Example 1 --------------------------

Get-ServerHealth -Identity Server01

This example returns the server health for server Server01.

Required Parameters

-Identity

The Identity parameter specifies the identity of the server you want health information for.

Type:ServerIdParameter
Position:1
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
Applies to:Exchange Server 2013, Exchange Server 2016

Optional Parameters

-HaImpactingOnly

The HaImpactingOnly switch specifies whether the cmdlet must roll up only the monitors that have HaImpacting set to True.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2013, Exchange Server 2016
-HealthSet

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.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2013, Exchange Server 2016

Inputs

To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data.

Outputs

To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data.