Applies to: Exchange Server 2007
Topic Last Modified: 2007-06-11
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>] [-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>]
|
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 |
Collect |
Optional |
System.Management.Automation.SwitchParameter |
The Collect parameter enables data collection. A value of
|
ConfigurationFileLocation |
Optional |
Microsoft.Exchange.Data.LongPath |
Reserved for internal use. |
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 |
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 |
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). |
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.
Input Types
Return Types
Errors
Error | Description |
---|---|
|
|
Exceptions
Exceptions | Description |
---|---|
|
|
Example
The following code is an example of the Test-SystemHealth command.
Copy Code | |
---|---|
Test-SystemHealth |