Test-CsClientAuth
トピックの最終更新日: 2012-03-26
証明書プロビジョニング サービスからダウンロードした証明書を使用して、ユーザーが Microsoft Lync Server 2010 にログオンできるかどうかを判定します。
構文
Test-CsClientAuth [-TargetFqdn <String>] -UserCredential <PSCredential> -UserSipAddress <String> [-Force <SwitchParameter>] [-OutVerboseVariable <String>] [-RegistrarPort <Nullable>] [-TargetUri <String>]
解説
クライアント証明書を使用すると、ユーザーは Lync Server 2010 によって別の方法で認証を受けることができます。クライアント証明書を使用してユーザーがシステムにログインできるかどうかを判定するために、Test-CsClientAuth コマンドレットを実行することができます。この Test-CsClientAuth を実行するには、レジストラー プールおよびテストするユーザー アカウントの SIP アドレスを指定する必要があります。ユーザーのログオン名およびパスワードも入力できる必要があります。Test-CsClientAuth を呼び出すと、このコマンドレットは証明書プロビジョニング サービスに問い合わせて、指定したユーザー用のクライアント証明書のコピーをダウンロードします。クライアント証明書が見つかりダウンロードできた場合、次に Test-CsClientAuth はその証明書を使用してログオンを試行します。ログオンが成功すると、Test-CsClientAuth はログオフしてテストが成功したことを報告します。
証明書が見つからないかダウンロードできない場合、またはダウンロードした証明書を使用してログオンできない場合、Test-CsClientAuth はテストが失敗したことを報告します。
このコマンドレットを実行できるユーザー: このコマンドレットが割り当てられているすべての役割ベースのアクセス制御 (RBAC) の役割の一覧 (自身が作成したカスタムの RBAC の役割を含む) を戻すには、Windows PowerShell プロンプトから次のコマンドを実行します。
Get-CsAdminRole | Where-Object {$_.Cmdlets –match "Test-CsClientAuth"}
パラメーター
| パラメーター | 必須かどうか | 型 | 説明 |
|---|---|---|---|
UserCredential |
必須 |
PS 資格情報オブジェクト |
テストで使用されるユーザー アカウントのユーザーの資格情報オブジェクトです。UserCredential に渡す値は、Get-Credential コマンドレットを使用して取得したオブジェクト参照である必要があります。たとえば次のコードは、litwareinc\kenmyer というユーザーの資格情報オブジェクトを戻し、そのオブジェクトを $x という名前の変数に格納します。 $x = Get-Credential "litwareinc\kenmyer" このコマンドを実行するときは、ユーザーのパスワードを入力する必要があります。 |
UserSipAddress |
必須 |
SIP アドレス |
テストで使用されるユーザーの SIP アドレスです。次に例を示します。-UserSipAddress sip:kenmyer@litwareinc.com。 |
RegistrarPort |
省略可能 |
整数 |
レジストラー サービスが使用する SIP ポートです。レジストラーが既定のポート 5061 を使用する場合、このパラメーターは必要ありません。 |
TargetUri |
省略可能 |
文字列 |
証明書プロビジョニング サービスの URL です。このパラメーターが含まれていない場合、Test-CsClientAuth はレジストラー プール用に構成されている証明書プロビジョニング サービスを使用します。 |
TargetFqdn |
省略可能 |
文字列 |
クライアント認証がテストされるレジストラー プールの完全修飾ドメイン名 (FQDN) です。次に例を示します。-TargetFqdn "atl-cs-001.litwareinc.com"。 |
OutVerboseVariable |
省略可能 |
文字列 |
コマンドレットを実行した結果の詳細な出力が、指定された変数に保存されます。たとえば、$TestOutput という名前の変数に出力を保存するには、次の構文を使用します。 -OutVerboseVariable TestOutput 変数名を指定するときは、先頭に $ 記号を使用しないでください。 |
Force |
省略可能 |
スイッチ パラメーター |
コマンド実行中に発生する可能性のある、致命的ではないすべてのエラー メッセージを表示しないようにします。 |
Verbose |
省略可能 |
スイッチ パラメーター |
コマンドレット実行中に、画面に詳細情報を表示します。 |
入力の種類
なし。
戻り値の種類
Test-CsClientAuth は、Microsoft.Rtc.SyntheticTransactions.TaskOutput オブジェクトのインスタンスを戻します。
例
-------------------------- 例 1 --------------------------
$cred1 = Get-Credential "litwareinc\kenmyer"
Test-CsClientAuth -TargetFqdn atl-cs-001.litwareinc.com -UserSipAddress "sip:kenmyer@litwareinc.com" -UserCredential $cred1
例 1 に示すコマンドでは、ユーザー litwareinc\kenmyer がクライアント証明書を使用して、レジストラー プール atl-cs-001.litwareinc.com にログオンできるかテストします。このタスクを実行するため、この例の最初のコマンドで Get-Credential を使用して、対象ユーザーの資格情報オブジェクトを作成します。その結果の資格情報オブジェクト (ユーザーのパスワードの入力が必要です) が $cred1 という名前の変数に格納されます。
次に 2 番目のコマンドで Test-CsClientAuth を呼び出し、レジストラー プールの FQDN (TargetFqdn)、ユーザーの SIP アドレス (UserSipAddress)、および最初のコマンドで作成した資格情報オブジェクト (UserCredential) を指定します。