Test-FederationTrust
このコマンドレットは、オンプレミスの Exchange でのみ使用可能です。
Test-FederationTrust コマンドレットを使用してフェデレーション信頼が想定どおり構成され機能しているかどうかを確認するために使用します。
以下の構文セクションのパラメーター セットの詳細については、「Exchangeのコマンドレット構文」を参照してください。
構文
Test-FederationTrust
[-Confirm]
[-DomainController <Fqdn>]
[-MonitoringContext <Boolean>]
[-UserIdentity <RecipientIdParameter>]
[-WhatIf]
[<CommonParameters>] 説明
初めてこのコマンドレットを使用する場合は、テスト ユーザーの作成が必要になることがあります。 テスト ユーザーを作成するには、次のコマンドを実行します。
& $env:ExchangeInstallPath\Scripts\New-TestCasConnectivityUser.ps1
exchange Management Shell からTest-FederationTrust コマンドレットを実行することも、監視システムでテストを定期的に実行することもできます。
Test-FederationTrust コマンドレットは、次の一連のテストを実行してフェデレーションが想定どおり動作することを確認します。
- Microsoft Federation Gateway との接続が確立されます。 このテストでは、ローカル Exchange サーバーとMicrosoft Federation Gateway間の通信が正常に動作していることを確認します。
- 証明書をチェックし、有効かつ Microsoft Federation Gateway で使用できることを確認します。
- Microsoft Federation Gateway はセキュリティ トークンを要求します。 このテストは、トークンを適切に取得して使用できることを確認します。
このコマンドレットを実行する際には、あらかじめアクセス許可を割り当てる必要があります。 このトピックにはこのコマンドレットのすべてのパラメーターが一覧表示されていますが、自分に割り当てられているアクセス許可に含まれていない一部のパラメーターにはアクセスできません。 コマンドレットを組織内で実行するために必要になるアクセス許可とパラメーターを調べるには、「 Find the permissions required to run any Exchange cmdlet」を参照してください。
例
例 1
Test-FederationTrust次の使用例は、Exchange 組織に展開されているフェデレーション信頼を検証し、Microsoft Federation Gatewayからセキュリティ トークンを取得できるかどうかを確認します。
パラメーター
-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 |
-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 |
-MonitoringContext
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 |
-UserIdentity
UserIdentity パラメーターは、トークンを要求するメールボックス ユーザーを指定します。 メールボックスを一意に識別する任意の値を使用できます。 次に例を示します。
- 名前
- Alias
- 識別名 (DN)
- 正規 DN
- 電子メール アドレス
- GUID
メールボックスを指定しない場合、コマンドは既定のテスト メールボックスを使用します。
| Type: | RecipientIdParameter |
| 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
このコマンドレットに使用できる戻り値の型 (出力の種類) を確認するには、「コマンドレットの入力および出力の種類」をご覧ください。 出力の種類のフィールドが空白の場合、コマンドレットはデータを返しません。