Test-CsAddressBookWebQuery
トピックの最終更新日: 2012-03-25
ユーザーが アドレス帳 Web クエリ サービス を使用して、アドレス帳の情報を検索し、戻すことができるかテストします。
構文
Test-CsAddressBookWebQuery -TargetFqdn <String> [-External <SwitchParameter>] [-Force <SwitchParameter>] [-OutVerboseVariable <String>] [-RegistrarPort <Nullable>] [-TargetSipAddress <String>] [-UserSipAddress <String>]
Test-CsAddressBookWebQuery -TargetUri <String> -UserSipAddress <String> [-Force <SwitchParameter>] [-OutVerboseVariable <String>] [-TargetSipAddress <String>] [-WebCredential <PSCredential>]
Test-CsAddressBookWebQuery [-TargetFqdn <String>] -UserCredential <PSCredential> -UserSipAddress <String> [-External <SwitchParameter>] [-Force <SwitchParameter>] [-OutVerboseVariable <String>] [-RegistrarPort <Nullable>] [-TargetSipAddress <String>]
解説
Test-CsAddressBookWebQuery は、"代理トランザクション" の一例です。代理トランザクションは Microsoft Lync Server 2010 で使用され、システムへのログオン、インスタント メッセージの交換、公衆交換電話網 (PSTN) 上の電話への発信などの一般的なタスクをユーザーが正常に実行できることを検証するものです。これらのテストは、管理者が手動で実行することも、Microsoft System Center Operations Manager (以前の Microsoft Operations Manager) などのアプリケーションから自動で実行することもできます。
代理トランザクションは通常、2 つの異なる方法で実行されます。多くの管理者は、CsHealthMonitoringConfiguration コマンドレットを使用して、テスト ユーザーを各レジストラー プールに設定します。このテスト ユーザーは、代理トランザクションで使用するためにあらかじめ構成されている 1 組のユーザーです (通常、これらはテスト アカウントであり、実際のユーザーのアカウントではありません)。プールに構成されているテスト ユーザーを使って、管理者はテスト用にユーザー アカウントの ID を指定したり資格情報を入力したりしなくても、そのプールに対して代理トランザクションを実行することができます。
また、管理者は実際のユーザー アカウントを使用して、代理トランザクションを実行することもできます。たとえば、ある 2 人のユーザーがインスタント メッセージの交換を行うことができない場合に、管理者は (テスト アカウントではなく) その 2 つのユーザー アカウントを使って代理トランザクションを実行し、問題の診断と解決を試みることができます。実際のユーザー アカウントを使用して代理トランザクションを実行する場合は、各ユーザーのログオン名とパスワードを入力する必要があります。
管理者は Test-CsAddressBookWebQuery コマンドレットを使って、ユーザーが アドレス帳 Web クエリ サービス を使用して特定の連絡先を検索できることを確認できます。Test-CsAddressBookWebQuery を実行すると、まず認証を行うため Web チケット サービスに接続します。認証に成功すると、今度は アドレス帳 Web クエリ サービス に接続して、指定された連絡先の検索を行います。連絡先が見つかると、その情報をローカル コンピューターへ戻そうとします。これらの手順がすべて完了できる場合にのみ、テストは成功としてマークされます。
このコマンドレットを実行できるユーザー: このコマンドレットが割り当てられているすべての役割ベースのアクセス制御 (RBAC) の役割の一覧 (自身が作成したカスタムの RBAC の役割を含む) を戻すには、Windows PowerShell プロンプトから次のコマンドを実行します。
Get-CsAdminRole | Where-Object {$_.Cmdlets –match "Test-CsAddressBookWebQuery"}
パラメーター
| パラメーター | 必須かどうか | 型 | 説明 |
|---|---|---|---|
TargetFqdn |
必須 |
文字列 |
アドレス帳 Web クエリ サービス がテストされるレジストラー プールの完全修飾ドメイン名 (FQDN) です。次に例を示します。-TargetFqdn "atl-cs-001.litwareinc.com"。 TargetUri パラメーターと TargetFqdn パラメーターの両方を、同じコマンド内で使用することはできません。 |
TargetSipAddress |
必須 |
SIP アドレス |
アドレス帳 Web クエリ サービス によって戻されると想定される連絡先の SIP アドレスです。次に例を示します。-TargetSipAddress "sip:kenmyer@litwareinc.com"。 |
TargetUri |
必須 |
文字列 |
アドレス帳 Web クエリ サービス の Uniform Resource Identifier (URI) です。次に例を示します。-TargetUri "https://atl-cs-001.litwareinc.com/groupexpansion"。 TargetUri パラメーターと TargetFqdn パラメーターの両方を、同じコマンド内で使用することはできません。 |
UserCredential |
必須 |
PSCredential オブジェクト |
テストで使用されるユーザー アカウントのユーザーの資格情報オブジェクトです。UserCredential に渡す値は、Get-Credential コマンドレットを使用して取得したオブジェクト参照である必要があります。たとえば次のコードは、litwareinc\kenmyer というユーザーの資格情報オブジェクトを戻し、そのオブジェクトを $x という名前の変数に格納します。$x = Get-Credential "litwareinc\kenmyer" このコマンドを実行するときは、ユーザーのパスワードを入力する必要があります。 |
UserSipAddress |
必須 |
SIP アドレス |
テストで使用されるユーザーの SIP アドレスです。このパラメーターが指定されていない場合、Test-CsAddressBookWebQuery は、テスト対象のプールの状態監視の構成設定を使って確認を行います。 |
External |
省略可能 |
スイッチ パラメーター |
外部ユーザーが アドレス帳 Web クエリ サービス を使用できるかを確認できます。 |
RegistrarPort |
省略可能 |
整数 |
レジストラー サービスが使用する SIP ポートです。レジストラーが既定のポート 5061 を使用する場合、このパラメーターは必要ありません。 |
WebCredential |
省略可能 |
PS 資格情報オブジェクト |
場所情報サービスにアクセスするユーザー資格情報を含んだオブジェクトです。このオブジェクトは Get-Credential コマンドレットを呼び出し、該当する資格情報を指定することで取得できます。 このパラメーターは、TargetUri パラメーターと UserSipAddress パラメーターが指定されており、このコマンドレットを実行するコンピューターにサーバー証明書が存在しない場合に必須です。 |
Force |
省略可能 |
スイッチ パラメーター |
コマンド実行中に発生する可能性のある、致命的ではないすべてのエラー メッセージを表示しないようにします。 |
OutVerboseVariable |
省略可能 |
文字列 |
コマンドレットを実行した結果の詳細な出力が、指定された変数に保存されます。たとえば、$TestOutput という名前の変数に出力を保存するには、次の構文を使用します。 -OutVerboseVariable TestOutput 変数名を指定するときは、先頭に $ 記号を使用しないでください。 |
Verbose |
省略可能 |
スイッチ パラメーター |
コマンドレット実行中に、画面に詳細情報を表示します。 |
入力の種類
なし。Test-CsAddressBookWebQuery は、パイプ処理による入力を受け入れません。
戻り値の種類
Test-CsAddressBookWebQuery は、Microsoft.Rtc.SyntheticTransactions.TaskOutput オブジェクトのインスタンスを戻します。
例
-------------------------- 例 1 ------------------------
Test-CsAddressBookWebQuery -TargetFqdn atl-cs-001.litwareinc.com -TargetSipAddress "sip:kenmyer@litwareinc.com"
上記の例は、SIP アドレスが sip:kenmyer@litwareinc.com の連絡先を検索して、プール atl-cs-001.litwareinc.com で アドレス帳 Web クエリ サービス をテストします。このコマンドは、プール atl-cs-001.litwareinc.com のテスト ユーザーが定義されている場合のみ機能します。テスト ユーザーが定義されている場合、プールに定義されている最初のテスト ユーザーの資格情報を使ってコマンドが実行されます。
テスト ユーザーが定義されていない場合、コマンドは失敗します。プールのテスト ユーザーを定義していない場合は、UserSipAddress パラメーターと、コマンドの実行に使用するユーザーの資格情報を指定する必要があります。
-------------------------- 例 2 ------------------------
$cred1 = Get-Credential "litwareinc\kenmyer"
Test-CsAddressBookWebQuery -TargetFqdn atl-cs-001.litwareinc.com -UserCredential $cred1 -UserSipAddress "sip:kenmyer@litwareinc.com" -TargetSipAddress "sip:kenmyer@litwareinc.com"
例 2 に示すコマンドも アドレス帳 Web クエリ サービス が使用可能かどうかをテストしますが、この例では、ユーザー Ken Myer (litwareinc\kenmyer) の資格情報を使ってコマンドが実行されます。これを実行するため、最初のコマンドで Get-Credential コマンドレットを使用して、Ken Myer というユーザーの名前とパスワードを含む、Windows PowerShell 資格情報オブジェクトを作成します (ログオン名 litwareinc\kenmyer はパラメーターとして指定されているため、管理者は [Windows PowerShell 資格情報の要求] ダイアログ ボックスで、Ken Myer アカウントのパスワードのみ入力する必要があります)。作成された資格情報オブジェクトは、$cred1 という名前の変数に格納されます。
2 番目のコマンドでは、Test-CsAddressBookWebQuery を使用し、プール atl-cs-001.litwareinc.com で アドレス帳 Web クエリ サービス をテストします。Ken Myer のユーザー資格情報を使ってこのコマンドを実行するため、UserCredential パラメーターを指定し、パラメーター値を $cred1 に設定します。また、TargetSipAddress を使用し、コマンドレットがアドレス帳で SIP アドレスが sip:kenmyer@litwareinc.com の連絡先を検索するよう指定します。
-------------------------- 例 3 ------------------------
Test-CsAddressBookWebQuery -TargetUri https://atl-cs-001.litwareinc.com/groupexpansion -UserSipAddress "sip:packerman@litwareinc.com" -TargetSipAddress "sip:kenmyer@litwareinc.com"
例 3 は、atl-cs-001.litwareinc.com で アドレス帳 Web クエリ サービス をテストする方法を示しています。これを行うため、Test-CsAddressBookWebQuery を呼び出し、次の 3 つのパラメーターを指定します。TargetUri で アドレス帳 Web クエリ サービス の URI を指定し、UserSipAddress でテスト対象のユーザー アカウントの Windows PowerShell SIP アドレスを指定し、TargetSipAddress で検索対象のユーザー アカウントの SIP アドレスを指定します。