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