TechNet
Export (0) Print
Expand All

Get-HealthReport

 

Applies to: Exchange Server 2016

This cmdlet is available only in on-premises Exchange Server 2016.

Use the Get-HealthReport cmdlet to return health information for the Exchange server that 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 Exchange cmdlet syntax.

Get-HealthReport -Identity <ServerIdParameter> [-GroupSize <Int32>] [-HaImpactingOnly <SwitchParameter>] [-HealthSet <String>] [-MinimumOnlinePercent <Int32>] [-RollupGroup <SwitchParameter>]

This example retrieves health information for the server named Mailbox01.

Get-HealthReport -Identity Mailbox01-RollupGroup

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 infrastructure and PowerShell permissions topic.

 

Parameter Required Type Description

Identity

Required

Microsoft.Exchange.Configuration.Tasks.ServerIdParameter

The Identity parameter specifies the Exchange server that you want to view. You can use the following values to identify the server:

  • Name

  • Distinguished name (DN)

  • FQDN

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 filters the results to only the monitors that have HaImpacting set to True. You don't need to specify a value with this switch.

HealthSet

Optional

System.String

The HealthSet parameter filters the results by the specified health set. 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 switch specifies that the health data is rolled up across servers with redundancy limits. You don't need to specify a value with this switch.

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.

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.

 
Show:
© 2016 Microsoft