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