Test-PowerShellConnectivity

リファレンス

モジュール:: ExchangePowerShell

適用対象:: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

このコマンドレットは、オンプレミスの Exchange でのみ使用可能です。

Test-PowerShellConnectivity コマンドレットを使用して、Exchange リモート PowerShell 仮想ディレクトリへのクライアント接続をテストします。

注: このコマンドレットは、Exchange 2010 で最適に動作します。以降のバージョンの Exchange では、このコマンドレットの機能が Managed Availability に置き換えられました。したがって、このコマンドレットを使用する代わりに、Invoke-MonitoringProbe コマンドレットを使用して関連するアクティブなモニタープローブを指定するのが最良の方法になります。

以下の構文セクションのパラメーターセットの詳細については、「Exchangeのコマンドレット構文」を参照してください。

構文

Test-PowerShellConnectivity
    -ConnectionUri <Uri>
    -TestCredential <PSCredential>
    [-Authentication <AuthenticationMethod>]
    [-Confirm]
    [-DomainController <Fqdn>]
    [-MailboxServer <ServerIdParameter>]
    [-MonitoringContext]
    [-ResetTestAccountCredentials]
    [-TrustAnySSLCertificate]
    [-WhatIf]
    [<CommonParameters>]

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

Authentication パラメーターは、接続に使用される認証の種類を指定します。有効な値は次のとおりです。

既定値
Basic
Credssp
Digest
Kerberos
交渉

Type:	AuthenticationMethod
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

-ClientAccessServer

ClientAccessServer パラメーターは、テストする Exchange サーバーを指定します。このサーバーにはクライアントアクセスサーバーの役割がインストールされており、クライアント接続の受け入れを担当します。

サーバーを一意に識別する任意の値を使用できます。次に例を示します。

名前
識別名 (DN)
ExchangeLegacyDN
GUID

ConnectionUri パラメーターでは、このパラメーターを使用できません。

Type:	ServerIdParameter
Position:	1
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False
Applies to:	Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

-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, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

-ConnectionUri

ConnectionUri パラメーターは、テストするリモート PowerShell 仮想ディレクトリの URL (例: https://contoso.com/powershell) を指定します。

このパラメーターは ClientAccessServer パラメーターと併用できません。

Type:	Uri
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

-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, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

-MailboxServer

MailboxServer パラメーターは、テストする Exchange メールボックスサーバーを指定します。このパラメーターは、クライアントが接続するフロントエンドサーバーからのプロキシ接続を受け入れるバックエンドサーバーを識別します。

MailboxServer パラメーターには、テストする exExchange2k16 または exExchange2k13 メールボックスサーバーを指定します。次に例を示します。

名前
識別名 (DN)
ExchangeLegacyDN
GUID

このパラメーターを使用しない場合は、ローカル Active Directory サイト内のすべてのメールボックスサーバーへの接続がテストされます。

Type:	ServerIdParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

-MonitoringContext

MonitoringContext スイッチは、関連する監視イベントおよびパフォーマンスカウンターを結果に含めます。このスイッチで値を指定する必要はありません。

通常、出力が Microsoft System Center Operations Manager (SCOM) に渡されるときに、監視イベントとパフォーマンスカウンターを結果に含めます。

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

-ResetTestAccountCredentials

ResetTestAccountCredentials スイッチは、このコマンドを実行するために使用されるテストアカウントのパスワードをリセットします。このスイッチで値を指定する必要はありません。

テストアカウントのパスワードは、通常、7 日ごとにリセットされます。セキュリティ上の理由でパスワードのリセットが必要になったときはいつでも、このパラメーターを使用してパスワードを強制的にリセットできます。

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

-TestCredential

TestCredential パラメーターは、テストに使用する資格情報を指定します。

このパラメーターの値には、Get-Credential コマンドレットが必要です。このコマンドを一時停止し、資格情報の入力を求めるメッセージを表示するには、値(Get-Credential)を使用します。または、このコマンドを実行する前に、資格情報を変数 (たとえば、$cred = Get-Credential) に保存し、このパラメーターに変数名 ($cred) を使用します。詳細については、Get-Credentialに関するページをご覧ください。

このパラメーターは ConnectionUri パラメーターでのみ使用できます。

Type:	PSCredential
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

-TestType

TestType パラメーターは、コマンドが内部と外部のどちらの URL をテストするかを指定します。値は Internal と External です。既定値は Internal です。

このパラメーターは、ClientAccessServer パラメーターでのみ使用できます。

Type:	OwaConnectivityTestType
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

-TrustAnySSLCertificate

TrustAnySSLCertificate スイッチを使用すると、Exchange は信頼されていない証明機関 (CA) からの証明書を受け入れます。このスイッチで値を指定する必要はありません。

TrustAnySSLCertificate スイッチは、Secure Sockets Layer (SSL) 証明書の検証エラーを無視するかどうかを指定します。このスイッチで値を指定する必要はありません。

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

-VirtualDirectoryName

VirtualDirectoryName パラメーターは、テストするリモート PowerShell 仮想ディレクトリの名前を指定します。スペースを含む値は引用符 (") で囲んでください。

このパラメーターは、ClientAccessServer パラメーターでのみ使用できます。このパラメーターを使用しない場合、サーバー上で使用可能なすべてのリモート PowerShell 仮想ディレクトリがテストされます。

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

-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, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

入力

Input types

このコマンドレットに使用できる入力の種類を確認するには、「コマンドレットの入力および出力の種類」をご覧ください。コマンドレットで入力の種類のフィールドが空白の場合、そのコマンドレットには入力データを指定できません。

出力

Output types

このコマンドレットに使用できる戻り値の型 (出力の種類) を確認するには、「コマンドレットの入力および出力の種類」をご覧ください。出力の種類のフィールドが空白の場合、コマンドレットはデータを返しません。