Commands › Exchange Online

Get-HealthReport

Exchange Online ExchangeOnlineManagement Get-*

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.

Quick start script

# Get-HealthReport — quick start (serv365.ai)
# 1. Connect (app-only shown; interactive: omit the certificate parameters)
Connect-ExchangeOnline -CertificateThumbprint $thumb -AppId $appId -Organization $org

# 2. Run and inspect
Get-HealthReport -Identity <ServerIdParameter> | Format-List

# 3. Export for evidence / drift tracking
Get-HealthReport | Export-Clixml .\HealthReport-$(Get-Date -Format yyyyMMdd).xml

Syntax

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

Parameters (6)

Parameter	Type	Required	What it controls
-Identity	ServerIdParameter	yes	The Identity parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example:
-GroupSize	Int32		The GroupSize parameter determines the size of the group to process against for a rollup. The default value is 12.
-HaImpactingOnly	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	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...
-MinimumOnlinePercent	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	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.

Reference facts derived from Microsoft documentation, © Microsoft, licensed CC BY 4.0; restructured with original guidance by serv365.ai.