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))自动运行。
综合事务通常以两种不同的方式执行。许多管理员会使用 CsHealthMonitoringConfiguration cmdlet 为其每一个注册器池设置测试用户。这些测试用户是预先配置的与综合事务配合使用的一对用户。(通常,这些帐户是测试帐户,而不是属于实际用户的帐户。)为池配置测试用户后,管理员可以对该池运行综合事务,而不必指定测试中所涉及的用户帐户的标识(也不必提供该帐户的凭据)。
此外,管理员也可以使用实际用户帐户运行综合事务。例如,如果两位用户无法交换即时消息,则管理员可以使用这两个用户帐户(而不是一对测试帐户)来运行综合事务,然后尝试诊断并解决该问题。如果决定使用实际用户帐户执行综合事务,您需要提供每个用户的登录名和密码。
Test-CsAddressBookService cmdlet 提供了一种方法,用于验证用户是否可以连接到通讯簿下载 Web 服务。运行此 cmdlet 时,Test-CsAddressBookService 将连接到指定池中的通讯簿下载 Web 服务,然后请求通讯簿文件的位置。如果通讯簿下载 Web 服务提供该位置,则将测试视为成功。如果请求被拒绝,则将测试视为失败。
可通过两种不同方式测试通讯簿下载 Web 服务:测试该服务自身或测试关联的 Web 服务。
谁能运行此 cmdlet:默认情况下,以下各组的成员有权在本地运行 Test-CsAddressBookService cmdlet:RTCUniversalServerAdmins。要返回分配了此 cmdlet 的所有基于角色的访问控制 (RBAC) 角色列表(包括您自己创建的任何自定义 RBAC 角色),请从 Windows PowerShell 提示符处运行以下命令:
Get-CsAdminRole | Where-Object {$_.Cmdlets –match "Test-CsAddressBookService"}
参数
参数 | 必需 | 类型 | 描述 |
---|---|---|---|
UserCredential |
必需 |
PS 凭据对象 |
要在测试中使用的用户帐户的用户凭据对象。传递给 UserCredential 的值应是使用 Get-Credential cmdlet 获取的对象引用。例如,以下代码返回用户 litwareinc\kenmyer 的凭据对象,并将该对象存储在名为 $x 的变量中: $x = Get-Credential "litwareinc\kenmyer" 运行此命令时,您需要提供用户密码。 |
UserSipAddress |
必需 |
SIP 地址 |
要在测试中使用的用户的 SIP 地址。如果未指定此参数,则 Test-CsAddressBookService 将使用已登录用户的帐户进行检查。 |
External |
可选 |
开关参数 |
使您可以验证外部用户是否可以使用通讯簿下载 Web 服务。 |
RegistrarPort |
可选 |
整数 |
Registrar 服务使用的 SIP 端口。如果 Registrar 使用默认端口 5061,则不需要指定此参数。 |
TargetFqdn |
可选 |
字符串 |
要在其中测试通讯簿下载 Web 服务的注册器池的完全限定域名 (FQDN)。例如:-TargetFqdn "atl-cs-001.litwareinc.com"。 不能在同一个命令中同时使用 TargetUri 参数和 TargetFqdn 参数。 |
TargetUri |
可选 |
字符串 |
通讯簿 Web 查询服务的统一资源标识符 (URI)。例如:-TargetUri "https://atl-cs-001.litwareinc.com/abs/handler"。 不能在同一个命令中同时使用 TargetUri 参数和 TargetFqdn 参数。 |
WebCredential |
可选 |
PS 凭据对象 |
包含用于访问位置信息服务的用户凭据的对象。可通过调用 Get-Credential cmdlet 并提供相应的凭据来检索该对象。 如果指定 TargetUri 和 UserSipAddress 参数,并且从中运行此命令的计算机没有服务器证书,则需要此参数。 |
Force |
可选 |
开关参数 |
禁止显示运行此命令时可能出现的任何非严重错误消息。 |
OutVerboseVariable |
可选 |
字符串 |
存在此参数时,运行该 cmdlet 的详细输出将存储在指定变量中。例如,若要将输出存储在名为 $TestOutput 的变量中,可使用以下语法: -OutVerboseVariable TestOutput 指定变量名称时不要在前面附加 $ 字符。 |
Verbose |
必需 |
开关参数 |
在该 cmdlet 运行时将详细活动显示在屏幕上。 |
输入类型
无。Test-CsAddressBookService 不接受通过管道传递的输入。
返回类型
Test-CsAddressBookService 返回 Microsoft.Rtc.SyntheticTransactions.TaskOutput 对象的实例。
示例
-------------------------- 示例 1 --------------------------
Test-CsAddressBookService -TargetFqdn atl-cs-001.litwareinc.com
上述示例为池 atl-cs-001.litwareinc.com 测试通讯簿下载 Web 服务。此命令使用为池 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 cmdlet 创建一个包含用户 Ken Myer 的名称和密码的 Windows PowerShell 凭据对象。(由于包含的登录名 litwareinc\kenmyer 用作参数,因此,Windows PowerShell 凭据请求对话框将仅要求管理员输入 Ken Myer 帐户的密码。)然后,将生成的凭据对象存储在名为 $cred1 的变量中。
在第二个命令中,使用 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 服务。为执行此操作,调用带有以下两个参数的 Test-CsAddressBookService:TargetUri,用于指定通讯簿下载 Web 服务的 URI;UserSipAddress,包含测试中利用的用户帐户的 Windows PowerShell SIP 地址。