Test-MAPIConnectivity
このコマンドレットは、オンプレミスの Exchange およびクラウド ベースのサービスで使用できます。 一部のパラメーターおよび設定は、いずれかの環境専用となっている場合があります。
Test-MapiConnectivity コマンドレットを使用して、指定したメールボックスにログオンし、サーバーの機能を確認します。 メールボックスを指定していない場合、このコマンドレットは指定したデータベース上の SystemMailbox にログオンします。
以下の構文セクションのパラメーター セットの詳細については、「Exchangeのコマンドレット構文」を参照してください。
構文
Test-MAPIConnectivity
-Database <DatabaseIdParameter>
[-ActiveDirectoryTimeout <Int32>]
[-AllConnectionsTimeout <Int32>]
[-Confirm]
[-CopyOnServer <ServerIdParameter>]
[-DomainController <Fqdn>]
[-MonitoringContext <Boolean>]
[-PerConnectionTimeout <Int32>]
[-WhatIf]
[<CommonParameters>]Test-MAPIConnectivity
[-Identity] <MailboxIdParameter>
[-ActiveDirectoryTimeout <Int32>]
[-AllConnectionsTimeout <Int32>]
[-Archive]
[-Confirm]
[-CopyOnServer <ServerIdParameter>]
[-DomainController <Fqdn>]
[-MonitoringContext <Boolean>]
[-PerConnectionTimeout <Int32>]
[-WhatIf]
[<CommonParameters>]Test-MAPIConnectivity
[-Server <ServerIdParameter>]
[-ActiveDirectoryTimeout <Int32>]
[-AllConnectionsTimeout <Int32>]
[-Confirm]
[-DomainController <Fqdn>]
[-IncludePassive]
[-MonitoringContext <Boolean>]
[-PerConnectionTimeout <Int32>]
[-WhatIf]
[<CommonParameters>]説明
Test-MapiConnectivity コマンドレットは、サーバーの機能を検証します。 このコマンドレットは、指定したメールボックス (Identity パラメーターを指定していない場合は SystemMailbox) にログオンし、受信トレイの項目の一覧を取得します。 メールボックスにログオンすることで、クライアントがメールボックス サーバーに接続する際に使用する MAPI および LDAP の 2 つの重要なプロトコルがテストされます。 認証中、Test-MapiConnectivity コマンドレットは、MAPI サーバー、Exchange ストア、ディレクトリ サービス アクセス (DSAccess) が動作していることを間接的に確認します。
このコマンドレットは、ローカル コンピューターにログオンするときに使用したアカウントの資格情報を使用して、指定したメールボックスにログオンします。 認証が成功したら、Test-MapiConnectivity コマンドレットはメールボックスにアクセスして、データベースが機能していることを検証します。 メールボックスへの接続が成功したら、ログオンの試みが発生した時刻も判定されます。
コマンドで使用できるパラメーターは、データベース、ID、サーバーの 3 種類あります。
- Database パラメーターは、データベース ID を受け取って、そのデータベースのシステム メールボックスにログオンできるかどうかをテストします。
- Identity パラメーターは、メールボックスの ID を受け取って、そのメールボックスにログオンできるかどうかをテストします。
- Server パラメーターは、サーバーの ID を受け取って、そのサーバーの各システム メールボックスにログオンできるかどうかをテストします。
このコマンドレットを実行する際には、あらかじめアクセス許可を割り当てる必要があります。 このトピックにはこのコマンドレットのすべてのパラメーターが一覧表示されていますが、自分に割り当てられているアクセス許可に含まれていない一部のパラメーターにはアクセスできません。 コマンドレットを組織内で実行するために必要になるアクセス許可とパラメーターを調べるには、「 Find the permissions required to run any Exchange cmdlet」を参照してください。
例
例 1
Test-MapiConnectivity -Server "Server01"この例は、Server01 というサーバーとの接続をテストします。
例 2
Test-MapiConnectivity -Identity "midwest\john"この例は、ドメイン名とユーザー名を指定して、メールボックスとの接続をテストします。
パラメーター
-ActiveDirectoryTimeout
このパラメーターは、オンプレミスの Exchange でのみ使用できます。
ActiveDirectoryTimeout パラメーターは、操作がタイムアウトするまでの各 Active Directory 操作の完了時間を秒単位で指定します。既定値は 15 秒です。
| Type: | Int32 |
| 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 |
-AllConnectionsTimeout
このパラメーターは、オンプレミスの Exchange でのみ使用できます。
AllConnectionsTimeout パラメーターは、コマンドレットがタイムアウトするまでのすべての接続を完了できる時間を秒単位で指定します。タイムアウト のカウントダウンは、接続を実行するために必要なすべての情報が Active Directory から収集されるまで開始されません。既定値は 90 秒です。
| Type: | Int32 |
| 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 |
-Archive
[アーカイブ] スイッチは、指定したメールボックスに関連付けられている個人用アーカイブの MAPI 接続をテストするかどうかを指定します。 このスイッチで値を指定する必要はありません。
このスイッチを使用しない場合は、プライマリ メールボックスのみがテストされます。
| 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, Exchange Online |
-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, Exchange Online |
-CopyOnServer
このパラメーターは、オンプレミスの Exchange でのみ使用できます。
CopyOnServer パラメーターは、テストする特定のデータベース コピーを保持するメールボックス サーバーを指定します。 サーバーを一意に識別する任意の値を使用できます。 次に例を示します。
- 名前
- FQDN
- 識別名 (DN)
- Exchange の従来の DN
このパラメーターは、識別パラメーターまたはデータベース パラメーターではなく、Server パラメーターでのみ使用できます。
| Type: | ServerIdParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 |
-Database
このパラメーターは、オンプレミスの Exchange でのみ使用できます。
Database パラメーターは、システム メールボックスへの接続をテストするデータベースを指定します。 データベースを一意に識別する、任意の値を使用できます。 以下に例を示します。
- 名前
- 識別名 (DN)
- GUID
このパラメーターまたは Identity パラメーターを使用しない場合、コマンドは、Exchange サーバー上の各アクティブ データベース (ローカルの Exchange サーバーまたはサーバー パラメーターで指定したサーバー) で SystemMailbox をテストします。
同じコマンドで ID、データベース、またはサーバーの各パラメーターを使用することはできません。
| Type: | DatabaseIdParameter |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 |
-DomainController
このパラメーターは、オンプレミスの Exchange でのみ使用できます。
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 |
-Identity
Identity パラメーターは、テスト対象のメールボックスを指定します。 メールボックスを一意に識別する任意の値を使用できます。 次に例を示します。
- 名前
- Alias
- 識別名 (DN)
- 正規 DN
- Domain\Username
- 電子メール アドレス
- GUID
- LegacyExchangeDN
- SamAccountName
- ユーザー ID またはユーザー プリンシパル名 (UPN)
このコマンドレットは、Get-Mailbox または Get-Recipient コマンドレットからのパイプライン入力を受け入れます。 Get-MailboxまたはGet-Recipientコマンドレットから識別をパイプ処理する場合は、このパラメーターを使用する必要はありません。
このパラメーターを使用しない場合、コマンドレットは指定したデータベースで SystemMailbox をテストします。
同じコマンドで ID、データベース、またはサーバーの各パラメーターを使用することはできません。
| Type: | MailboxIdParameter |
| Position: | 1 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-IncludePassive
このパラメーターは、オンプレミスの Exchange でのみ使用できます。
IncludePassive スイッチは、すべてのアクティブおよびパッシブ データベース コピーからの MAPI 接続をテストします。 このスイッチで値を指定する必要はありません。
このスイッチを使用しない場合、コマンドはアクティブなデータベース コピーからの MAPI 接続のみをテストします。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 |
-MonitoringContext
このパラメーターは、オンプレミスの Exchange でのみ使用できます。
MonitoringContext パラメーターは、関連する監視イベントとパフォーマンス カウンターを結果に含めるかどうかを指定します。 有効な値は次のとおりです。
- $true: 監視イベントとパフォーマンス カウンターがコマンドの結果に含まれます。 通常、出力が System Center Operations Manager (SCOM) に渡されるときに、結果に監視イベントとパフォーマンス カウンター Microsoft含めます。
- $false: 監視イベントとパフォーマンス カウンターは、コマンドの結果には含まれません。 これは既定の値です。
| Type: | Boolean |
| 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 |
-PerConnectionTimeout
このパラメーターは、オンプレミスの Exchange でのみ使用できます。
PerConnectionTimeout パラメーターは、それぞれの接続が完了するために許容される秒数を指定します。この時間以内に接続が完了しなければタイムアウトになります。既定値は 10 秒です。
| Type: | Int32 |
| 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 |
-Server
このパラメーターは、オンプレミスの Exchange でのみ使用できます。
Server パラメーターは、MAPI 接続のテスト対象のサーバーを指定します。 指定したサーバー上のアクティブなデータベースにホストされた各システム メールボックスに対する MAPI 接続がテストされます。 サーバーを一意に識別する任意の値を使用できます。 次に例を示します。
- 名前
- FQDN
- 識別名 (DN)
- Exchange の従来の DN
このパラメーターを指定しない場合、ローカル サーバー上のメールボックスがテストされます。
同じコマンドで ID、データベース、またはサーバーの各パラメーターを使用することはできません。
| Type: | ServerIdParameter |
| Position: | Named |
| 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 |
-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, Exchange Online |
入力
Input types
このコマンドレットに使用できる入力の種類を確認するには、「コマンドレットの入力および出力の種類」をご覧ください。 コマンドレットで入力の種類のフィールドが空白の場合、そのコマンドレットには入力データを指定できません。
出力
Output types
このコマンドレットに使用できる戻り値の型 (出力の種類) を確認するには、「コマンドレットの入力および出力の種類」をご覧ください。 出力の種類のフィールドが空白の場合、コマンドレットはデータを返しません。