Test-PowerShellConnectivity
このコマンドレットは、オンプレミスの Exchange でのみ使用可能です。
Test-PowerShellConnectivity コマンドレットを使用して、Exchange リモート PowerShell 仮想ディレクトリへのクライアント接続をテストします。
注: このコマンドレットは、Exchange 2010 で最適に動作します。 以降のバージョンの Exchange では、このコマンドレットの機能は Managed Availability に置き換えられます。 したがって、このコマンドレットを使用する代わりに、Invoke-MonitoringProbe コマンドレットを使用して関連するアクティブなモニター プローブを指定するのが最良の方法になります。
以下の構文セクションのパラメーター セットの詳細については、「Exchangeのコマンドレット構文」を参照してください。
構文
URL
Test-PowerShellConnectivity
-ConnectionUri <Uri>
-TestCredential <PSCredential>
[-Authentication <AuthenticationMethod>]
[-Confirm]
[-DomainController <Fqdn>]
[-MailboxServer <ServerIdParameter>]
[-MonitoringContext]
[-ResetTestAccountCredentials]
[-TrustAnySSLCertificate]
[-WhatIf]
[<CommonParameters>]
Identity
Test-PowerShellConnectivity
[[-ClientAccessServer] <ServerIdParameter>]
[-TestType <OwaConnectivityTestType>]
[-VirtualDirectoryName <String>]
[-Authentication <AuthenticationMethod>]
[-Confirm]
[-DomainController <Fqdn>]
[-MailboxServer <ServerIdParameter>]
[-MonitoringContext]
[-ResetTestAccountCredentials]
[-TrustAnySSLCertificate]
[-WhatIf]
[<CommonParameters>]
説明
Test-PowerShellConnectivity コマンドレットは、指定したリモート PowerShell 仮想ディレクトリ、指定された Exchange サーバー上の任意のリモート PowerShell 仮想ディレクトリ、またはローカル Active Directory サイトで使用できる任意のリモート PowerShell 仮想ディレクトリに接続することで、Exchange リモート PowerShell 接続をテストします。
初めてこのコマンドレットを使用する場合は、テスト ユーザーの作成が必要になることがあります。 テスト ユーザーを作成するには、次のコマンドを実行します。
& $env:ExchangeInstallPath\Scripts\New-TestCasConnectivityUser.ps1
テスト結果が画面上に表示されます。 このコマンドレットは、次の情報を返します。
- CasServer: クライアントが接続している Exchange サーバー。
- LocalSite: ローカル Active Directory サイトの名前。
- シナリオ: テストされる操作。 値はログオン ユーザーです。
- 結果: 返される値は、通常、成功、スキップ、または失敗です。
- Latency(MS): テストを完了するために必要な時間 (ミリ秒単位)。
- エラー: 発生したエラー メッセージ。
結果をファイルに書き込むには、出力を ConvertTo-Html と Set-Content にパイプ処理します。 例: Test-PowerShellConnectivity -ClientAccessServer MBX01 | ConvertTo-Html | Set-Content -Path "C:\My Documents\PowerShell Test.html"。
このコマンドレットを実行する際には、あらかじめアクセス許可を割り当てる必要があります。 この記事ではコマンドレットのすべてのパラメーターを一覧表示しますが、割り当てられたアクセス許可にパラメーターが含まれていない場合は、一部のパラメーターにアクセスできない可能性があります。 コマンドレットを組織内で実行するために必要になるアクセス許可とパラメーターを調べるには、「 Find the permissions required to run any Exchange cmdlet」を参照してください。
例
例 1
Test-PowerShellConnectivity -ClientAccessServer MBX2 -VirtualDirectoryName "PowerShell (Default Web Site)" -TrustAnySSLCertificate
この例では、MBX2 サーバー上の PowerShell (既定の Web サイト) 仮想ディレクトリをテストします。 TrustAnySSLCertificate スイッチは、接続中に証明書のチェックをスキップするために使用されます。
例 2
$UserCredentials = Get-Credential
Test-PowerShellConnectivity -ConnectionUri https://contoso.com/powershell -TestCredential $UserCredentials -Authentication Basic
この例では、 https://contoso.com/powershellで使用できるリモート PowerShell 仮想ディレクトリをテストします。 SSL 証明書と URL の不一致は想定されていないため、TrustAnySSLCertificate スイッチは使用されません。 仮想ディレクトリは、基本認証を使用するように構成されています。
仮想ディレクトリへの接続に使用される資格情報は、$UserCredentials変数に格納されます。 その後、前に説明したようにテストが実行されます。
パラメーター
-Authentication
適用対象: Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019
Authentication パラメーターは、接続に使用される認証の種類を指定します。 有効な値は次のとおりです。
- 既定値
- Basic
- Credssp
- Digest
- Kerberos
- 交渉する
パラメーターのプロパティ
| 型: | AuthenticationMethod |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-ClientAccessServer
適用対象: Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019
ClientAccessServer パラメーターは、テストする Exchange サーバーを指定します。 このサーバーにはクライアント アクセス サーバーの役割がインストールされており、クライアント接続の受け入れを担当します。
サーバーを一意に識別する任意の値を使用できます。 次に例を示します。
- 名前
- 識別名 (DN)
- ExchangeLegacyDN
- GUID
ConnectionUri パラメーターでは、このパラメーターを使用できません。
パラメーターのプロパティ
| 型: | ServerIdParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
Identity
| 配置: | 1 |
| 必須: | False |
| パイプラインからの値: | True |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-Confirm
適用対象: Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019
Confirm スイッチは、確認プロンプトを表示するか非表示にするかを指定します。 このスイッチがコマンドレットにどのような影響を与えるかは、先に進む前にコマンドレットで確認が必要となるかどうかで決まります。
- データを破壊するコマンドレット (たとえば、Remove- コマンドレット) には、先に進む前にユーザーにそのコマンドの確認を強制する組み込みの一時停止があります。 これらのコマンドレットでは、正確な構文
-Confirm:$falseを使用して、確認プロンプトを省略できます。 - 他のほとんどのコマンドレット (たとえば、New-* や Set-* コマンドレット) には、組み込みの一時停止はありません。 これらのコマンドレットの場合、値なしで Confirm スイッチを指定すると、先に進む前に、一時停止してコマンドを確認する必要があります。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | cf |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-ConnectionUri
適用対象: Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019
ConnectionUri パラメーターは、 https://contoso.com/powershellなど、テストするリモート PowerShell 仮想ディレクトリの URL を指定します。
このパラメーターは ClientAccessServer パラメーターと併用できません。
パラメーターのプロパティ
| 型: | Uri |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
URL
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-DomainController
適用対象: Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019
DomainController パラメーターは、このコマンドレットで Active Directory からのデータの読み取りまたは Active Directory へのデータの書き込みに使用されるドメイン コントローラーを指定します。 ドメイン コントローラーは、完全修飾ドメイン名 (FQDN) で識別します。 たとえば、dc01.contoso.com です。
パラメーターのプロパティ
| 型: | Fqdn |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-MailboxServer
適用対象: Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019
MailboxServer パラメーターは、テストする Exchange メールボックス サーバーを指定します。 このパラメーターは、クライアントが接続するフロントエンド サーバーからのプロキシ接続を受け入れるバックエンド サーバーを識別します。
MailboxServer パラメーターには、テストする exExchange2k16 または exExchange2k13 メールボックス サーバーを指定します。 次に例を示します。
- 名前
- 識別名 (DN)
- ExchangeLegacyDN
- GUID
このパラメーターを使用しない場合は、ローカル Active Directory サイト内のすべてのメールボックス サーバーへの接続がテストされます。
パラメーターのプロパティ
| 型: | ServerIdParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-MonitoringContext
適用対象: Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019
MonitoringContext スイッチは、関連する監視イベントおよびパフォーマンス カウンターを結果に含めます。 このスイッチで値を指定する必要はありません。
通常、出力が Microsoft System Center Operations Manager (SCOM) に渡されるときに、監視イベントとパフォーマンス カウンターを結果に含めます。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-ResetTestAccountCredentials
適用対象: Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019
ResetTestAccountCredentials スイッチは、このコマンドを実行するために使用されるテスト アカウントのパスワードをリセットします。 このスイッチで値を指定する必要はありません。
テスト アカウントのパスワードは、通常、7 日ごとにリセットされます。 セキュリティ上の理由でパスワードのリセットが必要になったときはいつでも、このパラメーターを使用してパスワードを強制的にリセットできます。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-TestCredential
適用対象: Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019
TestCredential パラメーターは、テストに使用する資格情報を指定します。
このパラメーターの値には、Get-Credential コマンドレットが必要です。 このコマンドを一時停止し、資格情報の入力を求めるメッセージを表示するには、値(Get-Credential)を使用します。 または、このコマンドを実行する前に、資格情報を変数 (たとえば、$cred = Get-Credential) に保存し、このパラメーターに変数名 ($cred) を使用します。 詳細については、Get-Credentialに関するページをご覧ください。
このパラメーターは ConnectionUri パラメーターでのみ使用できます。
パラメーターのプロパティ
| 型: | PSCredential |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
URL
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-TestType
適用対象: Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019
TestType パラメーターは、コマンドが内部と外部のどちらの URL をテストするかを指定します。 値は Internal と External です。 既定値は Internal です。
このパラメーターは、ClientAccessServer パラメーターでのみ使用できます。
パラメーターのプロパティ
| 型: | OwaConnectivityTestType |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
Identity
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-TrustAnySSLCertificate
適用対象: Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019
TrustAnySSLCertificate スイッチを使用すると、Exchange は信頼されていない証明機関 (CA) からの証明書を受け入れます。 このスイッチで値を指定する必要はありません。
TrustAnySSLCertificate スイッチは、Secure Sockets Layer (SSL) 証明書の検証エラーを無視するかどうかを指定します。 このスイッチで値を指定する必要はありません。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-VirtualDirectoryName
適用対象: Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019
VirtualDirectoryName パラメーターは、テストするリモート PowerShell 仮想ディレクトリの名前を指定します。 スペースを含む値は引用符 (") で囲んでください。
このパラメーターは、ClientAccessServer パラメーターでのみ使用できます。 このパラメーターを使用しない場合、サーバー上で使用可能なすべてのリモート PowerShell 仮想ディレクトリがテストされます。
パラメーターのプロパティ
| 型: | String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
Identity
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-WhatIf
適用対象: Exchange Server 2010、Exchange Server 2013、Exchange Server 2016、Exchange Server 2019
WhatIf スイッチは、コマンドの操作をシミュレートします。 このスイッチを使用すると、実際にその変更内容を適用せずに、発生する変更を確認できます。 このスイッチで値を指定する必要はありません。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | ウィスコンシン |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
CommonParameters
このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。 詳細については、「about_CommonParameters」を参照してください。
入力
Input types
このコマンドレットに使用できる入力の種類を確認するには、「コマンドレットの入力および出力の種類」をご覧ください。 コマンドレットで入力の種類のフィールドが空白の場合、そのコマンドレットには入力データを指定できません。
出力
Output types
このコマンドレットに使用できる戻り値の型 (出力の種類) を確認するには、「コマンドレットの入力および出力の種類」をご覧ください。 出力の種類のフィールドが空白の場合、コマンドレットはデータを返しません。