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 cmdlet。运行此 Test-CsClientAuth 时,必须指定要测试的用户帐户的注册器池和 SIP 地址,还必须能够提供用户的登录名和密码。呼叫 Test-CsClientAuth 之后,cmdlet 将与证书提供服务联系,并下载一份指定用户的任意客户端证书。如果能够找到并下载客户端证书,则 Test-CsClientAuth 将尝试使用该证书登录。如果登录成功,则 Test-CsClientAuth 将注销并报告测试成功。
如果无法找到或下载证书,或者 cmdlet 无法使用该证书登录,则 Test-CsClientAuth 将报告测试失败。
谁能运行此 cmdlet:要返回分配了此 cmdlet 的所有基于角色的访问控制 (RBAC) 角色列表(包括您自己创建的任何自定义 RBAC 角色),请从 Windows PowerShell 提示符处运行以下命令:
Get-CsAdminRole | Where-Object {$_.Cmdlets –match "Test-CsClientAuth"}
参数
参数 | 必需 | 类型 | 描述 |
---|---|---|---|
UserCredential |
必需 |
PS 凭据对象 |
要在测试中使用的用户帐户的用户凭据对象。传递给 UserCredential 的值应是使用 Get-Credential cmdlet 获取的对象引用。例如,以下代码返回用户 litwareinc\kenmyer 的凭据对象,并将该对象存储在名为 $x 的变量中: $x = Get-Credential "litwareinc\kenmyer" 运行此命令时,需要提供用户密码。 |
UserSipAddress |
必需 |
SIP 地址 |
要在测试中使用的用户的 SIP 地址。例如:-UserSipAddress sip:kenmyer@litwareinc.com。 |
RegistrarPort |
可选 |
整数 |
注册器服务使用的 SIP 端口。如果 Registrar 使用默认端口 5061,则不需要此参数。 |
TargetUri |
可选 |
字符串 |
证书提供服务的 URL。如果未包含此参数,则 Test-CsClientAuth 将使用为注册器池配置的证书提供服务。 |
TargetFqdn |
可选 |
字符串 |
要进行客户端身份验证测试的注册器池的完全限定域名 (FQDN)。例如:-TargetFqdn "atl-cs-001.litwareinc.com"。 |
OutVerboseVariable |
可选 |
字符串 |
存在此参数时,运行该 cmdlet 的详细输出将存储在指定变量中。例如,若要将输出存储在名为 $TestOutput 的变量中,可使用以下语法: -OutVerboseVariable TestOutput 指定变量名称时不要在前面附加 $ 字符。 |
Force |
可选 |
开关参数 |
禁止显示运行此命令时可能出现的任何非严重错误消息。 |
Verbose |
可选 |
开关参数 |
cmdlet 运行过程中,在屏幕上报告详细的活动情况。 |
输入类型
无。
返回类型
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 的变量中。
然后,第二个命令调用 Test-CsClientAuth,并指定注册器池的 FQDN (TargetFqdn)、用户的 SIP 地址 (UserSipAddress) 以及在初始命令中创建的凭据对象 (UserCredential)。