Share via

Test-SystemHealth

  • Article

 

Applies to: Exchange Server 2007 SP1, Exchange Server 2007 SP2, Exchange Server 2007 SP3

Use the Test-SystemHealth cmdlet to gather data about your Microsoft Exchange system and to analyze the data according to best practices.

Syntax

test-SystemHealth [-ADCredentials <PSCredential>] [-Analyze <SwitchParameter>] [-Collect <SwitchParameter>] [-ConfigurationFileLocation <LongPath>] [-Confirm [<SwitchParameter>]] [-Description <String>] [-DomainController <Fqdn>] [-DownloadConfigurationUpdates <SwitchParameter>] [-ExchangeCredentials <PSCredential>] [-Export <SwitchParameter>] [-GenerateEvents <SwitchParameter>] [-GenerateSQMData <SwitchParameter>] [-MaxThreads <Int32>] [-MergeFileLocation <LongPath>] [-OutFileLocation <LongPath>] [-Roles <String[]>] [-ScanType <String>] [-ServerList <String[]>] [-Timeout <EnhancedTimeSpan>] [-WhatIf [<SwitchParameter>]]

Detailed Description

To run the Test-SystemHealth cmdlet, the account you use must be delegated the following:

  • Exchange Server Administrator role and local Administrators group for the target server

For more information about permissions, delegating roles, and the rights that are required to administer Exchange Server 2007, see Permission Considerations.

Parameters

Parameter Required Type Description

ADCredentials

Optional

System.Management.Automation.PSCredential

The ADCredentials parameter specifies the credentials that are used to access the Active Directory directory service. The default value is the current user's credentials.

Analyze

Optional

System.Management.Automation.SwitchParameter

The Analyze parameter enables analysis on the data gathered. A value of $true enables analysis. The default value is $true.

Collect

Optional

System.Management.Automation.SwitchParameter

The Collect parameter enables data collection. A value of $true enables data collection. The default value is $true.

ConfigurationFileLocation

Optional

Microsoft.Exchange.Data.LongPath

Reserved for internal use.

Confirm

Optional

System.Management.Automation.SwitchParameter

The Confirm parameter causes the command to pause processing and requires you to acknowledge what the command will do before processing continues. You do not have to specify a value with the Confirm parameter.

Description

Optional

System.String

The Description parameter specifies a descriptive label for the scan.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

The DomainController parameter specifies the domain controller to use to access Active Directory. Use the fully qualified domain name (FQDN) of the domain controller that you want to use.

DownloadConfigurationUpdates

Optional

System.Management.Automation.SwitchParameter

The DownloadConfigurationUpdates parameter checks for and downloads newer versions of the configuration file. The default value is $true, which checks for and downloads newer versions of the configuration file.

ExchangeCredentials

Optional

System.Management.Automation.PSCredential

The ExchangeCredentials parameter identifies the credentials to apply to the run for access to servers that are running Exchange.

Export

Optional

System.Management.Automation.SwitchParameter

The Export parameter causes sensitive data to be removed from the output file specified. A value of $true causes data removal. The default value is $false.

GenerateEvents

Optional

System.Management.Automation.SwitchParameter

Reserved for internal use.

GenerateSQMData

Optional

System.Management.Automation.SwitchParameter

Reserved for internal use.

MaxThreads

Optional

System.Int32

Reserved for internal use.

MergeFileLocation

Optional

Microsoft.Exchange.Data.LongPath

Reserved for internal use.

OutFileLocation

Optional

Microsoft.Exchange.Data.LongPath

The OutFileLocation parameter identifies the name and path to the data file to generate.

Roles

Optional

System.String[]

Reserved for internal use.

ScanType

Optional

System.String

Reserved for internal use.

ServerList

Optional

System.String[]

Reserved for internal use.

Timeout

Optional

Microsoft.Exchange.Data.EnhancedTimeSpan

The Timeout parameter specifies the number of seconds before the operation times out. The default value is 300 seconds (5 minutes).

WhatIf

Optional

System.Management.Automation.SwitchParameter

The WhatIf parameter instructs the command to simulate the actions that it would take on the object. By using the WhatIf parameter, you can view what changes would occur without having to apply any of those changes. You do not have to specify a value with the WhatIf parameter.

Input Types

Return Types

Errors

Error Description

 

 

Exceptions

Exceptions Description

 

 

Example

The following code is an example of the Test-SystemHealth command.

Test-SystemHealth