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