Test-SystemHealth
このコマンドレットは Exchange Server 2010 でのみ使用可能です。
この Test-SystemHealth コマンドレットを使用して、Microsoft Exchange システムについてのデータを収集し、ベスト プラクティスに従ってデータを分析します。
以下の構文セクションのパラメーター セットの詳細については、「Exchangeのコマンドレット構文」を参照してください。
構文
Test-SystemHealth
[-ADCredentials <PSCredential>]
[-Analyze]
[-Collect]
[-ConfigurationData <Byte[]>]
[-ConfigurationFileLocation <LongPath>]
[-Confirm]
[-Description <String>]
[-DomainController <Fqdn>]
[-DownloadConfigurationUpdates]
[-ExchangeCredentials <PSCredential>]
[-Export]
[-GenerateEvents]
[-GenerateSQMData]
[-MaxThreads <Int32>]
[-MergeFileLocation <LongPath>]
[-OutData]
[-OutFileLocation <LongPath>]
[-Roles <String[]>]
[-ScanType <String>]
[-ServerList <String[]>]
[-Timeout <EnhancedTimeSpan>]
[-WhatIf]
[<CommonParameters>]
説明
このコマンドレットを実行する際には、あらかじめアクセス許可を割り当てる必要があります。 このトピックにはこのコマンドレットのすべてのパラメーターが一覧表示されていますが、自分に割り当てられているアクセス許可に含まれていない一部のパラメーターにはアクセスできません。 コマンドレットを組織内で実行するために必要になるアクセス許可とパラメーターを調べるには、「 Find the permissions required to run any Exchange cmdlet」を参照してください。
例
例 1
Test-SystemHealth
この例では、Exchange システムに関するデータを収集します。
例 2
$SysHealth = Test-SystemHealth -OutData
[System.IO.File]::WriteAllBytes('D:\temp\SystemHealthOutData.xml', $SysHealth.FileData)
この例は、出力データをバイト ストリームとして $SysHealth という名前の変数に保存します。 その後、コンテンツは D:\temp フォルダー内のSystemHealthOutData.xml ファイルに書き込まれます。
パラメーター
-ADCredentials
ADCredentials パラメーターは、Active Directory へのアクセスに使用するユーザー名とパスワードを指定します。 通常、このパラメーターはスクリプトや、必要なアクセス許可を持つ別の資格情報を入力する必要がある場合に使用します。
このパラメーターの値には、Get-Credential コマンドレットが必要です。 このコマンドを一時停止し、資格情報の入力を求めるメッセージを表示するには、値(Get-Credential)
を使用します。 または、このコマンドを実行する前に、資格情報を変数 (たとえば、$cred = Get-Credential
) に保存し、このパラメーターに変数名 ($cred
) を使用します。 詳細については、Get-Credentialに関するページをご覧ください。
Type: | PSCredential |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2010 |
-Analyze
Analyze スイッチは収集したデータの分析を有効にするスイッチです。 このスイッチで値を指定する必要はありません。
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2010 |
-Collect
Collect スイッチはデータ収集を有効にするスイッチです。 このスイッチで値を指定する必要はありません。
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2010 |
-ConfigurationData
このパラメーターは、Microsoft の内部使用のために予約されています。
Type: | Byte[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2010 |
-ConfigurationFileLocation
このパラメーターは、Microsoft の内部使用のために予約されています。
Type: | LongPath |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2010 |
-Confirm
Confirm スイッチは、確認プロンプトを表示するか非表示にするかを指定します。 このスイッチがコマンドレットにどのような影響を与えるかは、先に進む前にコマンドレットで確認が必要となるかどうかで決まります。
- 破壊的なコマンドレット (Remove-* コマンドレットなど) には、続行する前にコマンドの確認を強制する組み込みの一時停止があります。 これらのコマンドレットでは、正確な構文
-Confirm:$false
を使用して、確認プロンプトを省略できます。 - 他のほとんどのコマンドレット (New-* コマンドレットや Set-* コマンドレットなど) には、一時停止が組み込まれています。 これらのコマンドレットの場合、値なしで Confirm スイッチを指定すると、先に進む前に、一時停止してコマンドを確認する必要があります。
Type: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2010 |
-Description
Description パラメーターはスキャンの説明ラベルを指定します。
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2010 |
-DomainController
DomainController パラメーターは、このコマンドレットで Active Directory からのデータの読み取りまたは Active Directory へのデータの書き込みに使用されるドメイン コントローラーを指定します。 ドメイン コントローラーは、完全修飾ドメイン名 (FQDN) で識別します。 たとえば、dc01.contoso.com です。
Type: | Fqdn |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2010 |
-DownloadConfigurationUpdates
DownloadConfigurationUpdates スイッチは、構成ファイルの新しいバージョンを確認してダウンロードします。 このスイッチで値を指定する必要はありません。
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2010 |
-ExchangeCredentials
ExchangeCredentials パラメーターは、Exchange サーバーへのアクセスに使用するユーザー名とパスワードを指定します。 通常、このパラメーターはスクリプトや、必要なアクセス許可を持つ別の資格情報を入力する必要がある場合に使用します。
このパラメーターの値には、Get-Credential コマンドレットが必要です。 このコマンドを一時停止し、資格情報の入力を求めるメッセージを表示するには、値(Get-Credential)
を使用します。 または、このコマンドを実行する前に、資格情報を変数 (たとえば、$cred = Get-Credential
) に保存し、このパラメーターに変数名 ($cred
) を使用します。 詳細については、Get-Credentialに関するページをご覧ください。
Type: | PSCredential |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2010 |
-Export
Export スイッチは、指定された出力ファイルから機密データを削除します。 このスイッチで値を指定する必要はありません。
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2010 |
-GenerateEvents
このパラメーターは、Microsoft の内部使用のために予約されています。
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2010 |
-GenerateSQMData
このパラメーターは、Microsoft の内部使用のために予約されています。
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2010 |
-MaxThreads
このパラメーターは、Microsoft の内部使用のために予約されています。
Type: | Int32 |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2010 |
-MergeFileLocation
このパラメーターは、Microsoft の内部使用のために予約されています。
Type: | LongPath |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2010 |
-OutData
OutData スイッチは、出力データをバイトストリームとして送信するかどうかを指定します。 このスイッチで値を指定する必要はありません。
例えば、$temp = Test-SystemHealth -OutData
コマンドを実行すると、$temp
は出力データのバイトストリームを含み、Set-Content コマンドを使用して xml に戻すことができます。 コード サンプルについては、このトピックの「例 2」を参照してください。
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2010 |
-OutFileLocation
OutFileLocation パラメーターは、生成するデータ ファイルの名前とパスを指定します。
Type: | LongPath |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2010 |
-Roles
このパラメーターは、Microsoft の内部使用のために予約されています。
Type: | String[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2010 |
-ScanType
このパラメーターは、Microsoft の内部使用のために予約されています。
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2010 |
-ServerList
このパラメーターは、Microsoft の内部使用のために予約されています。
Type: | String[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2010 |
-Timeout
Timeout パラメーターは、操作がタイムアウトになるまでの秒数を指定します。既定値は 300 秒 (5 分) です。
Type: | EnhancedTimeSpan |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2010 |
-WhatIf
WhatIf スイッチは、コマンドの操作をシミュレートします。 このスイッチを使用すると、実際にその変更内容を適用せずに、発生する変更を確認できます。 このスイッチで値を指定する必要はありません。
Type: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2010 |
入力
Input types
このコマンドレットに使用できる入力の種類を確認するには、「コマンドレットの入力および出力の種類」をご覧ください。 コマンドレットで入力の種類のフィールドが空白の場合、そのコマンドレットには入力データを指定できません。
出力
Output types
このコマンドレットに使用できる戻り値の型 (出力の種類) を確認するには、「コマンドレットの入力および出力の種類」をご覧ください。 出力の種類のフィールドが空白の場合、コマンドレットはデータを返しません。