Get-CsUser
上一次修改主题: 2012-03-23
返回有关组织中所有已启用 Microsoft Lync Server 2010 或此软件早期版本(如 Microsoft Office Communications Server 2007 R2)的用户的信息。
语法
Get-CsUser [-Identity <UserIdParameter>] [-Credential <PSCredential>] [-DomainController <Fqdn>] [-Filter <String>] [-LdapFilter <String>] [-OnLyncServer <SwitchParameter>] [-OnOfficeCommunicationServer <SwitchParameter>] [-OU <OUIdParameter>] [-ResultSize <Unlimited>] [-UnAssignedUser <SwitchParameter>]
详细说明
结合使用 Get-CsAdUser 和 Get-CsUser 这两个 cmdlet,您可以返回有关所有 Active Directory 用户帐户的详细信息。Get-CsAdUser 返回有关所有用户帐户的信息,其中包括已启用 Lync Server 2010 或 Office Communications Server 的用户,以及未启用 Lync Server 或 Office Communications Server 的用户。这一点与 Get-CsUser 不同,后者仅返回其帐户已启用 Lync Server 或 Office Communications Server 的用户的信息。
尽管 Get-CsUser 和 Get-CsAdUser 之间有一些重叠的地方,但这两个 cmdlet 所返回的信息类型有所不同。通常,Get-CsUser 返回专门与 Lync Server 相关的 Active Directory 属性的值。例如,Get-CsUser 返回的信息包括已分配给某个用户的 Lync Server 策略、为该用户分配的线路统一资源标识符 (URI) 以及有关该用户是否已启用企业语音的详细信息等。除非该用户已启用 Lync Server,否则其用户帐户将不包含这些属性。
相比之下,Get-CsAdUser 则返回常规的 Active Directory 属性值:基本 Active Directory 用户帐户具有这些属性,并且无论用户是否已启用 Lync Server,都存在这些属性。例如,Get-CsAdUser 返回的信息包括用户供职的部门和组织以及用户的职务、电话号码和办公地址等。
要查看 Get-CsUser 返回的属性值的完整列表,请在 Windows PowerShell 命令提示符下键入此命令:
Get-CsUser | Get-Member
Get-CsUser 提供了多种方法,供您筛选运行此 cmdlet 时实际返回的用户集合。例如,如果您不想返回所有 Lync Server 用户帐户,可以应用可选参数 Filter 或 LDAPFilter。(这两个参数互斥:如果在某个命令中使用了 Filter,则不能在同一个命令中再使用 LDAPFilter,反之亦然。)通过 Filter 参数,可将返回的数据限定为满足指定 Lync Server 条件的用户;例如,可以决定仅返回在指定注册器池中拥有帐户的用户或已启用企业语音的用户。使用 LDAPFilter 参数可以将返回的数据限制为满足基于 Active Directory 的其他条件的用户,例如在指定州或省工作的用户,拥有或没有寻呼机的用户,或者拥有指定职务的用户。
谁能运行此 cmdlet:默认情况下,以下各组的成员有权在本地运行 Get-CsUser cmdlet:RTCUniversalUserAdmins、RTCUniversalServerAdmins 和 RTCUniversalReadOnlyAdmins。要返回分配了此 cmdlet 的所有基于角色的访问控制 (RBAC) 角色列表(包括您自己创建的任何自定义 RBAC 角色),请从 Windows PowerShell 提示符处运行以下命令:
Get-CsAdminRole | Where-Object {$_.Cmdlets –match "Get-CsUser\b"}
参数
参数 | 必需 | 类型 | 描述 |
---|---|---|---|
Identity |
可选 |
用户 ID 参数 |
指示要检索的用户帐户的标识。可以使用下列四种格式之一来指定用户标识:1) 用户的 SIP 地址;2) 用户的用户主体名称 (UPN);3) 用户的域名和登录名,格式为“域名\登录名”(如 litwareinc\kenmyer);以及 4) 用户的 Active Directory 显示名称(例如 Ken Myer)。还可以使用用户的 Active Directory 可分辨名称引用用户帐户。 在使用显示名称作为用户标识时,可以使用通配符星号 (*)。例如,Identity“* Smith”会返回显示名称以字符串值“ Smith”结尾的所有用户。 |
Credential |
可选 |
PS 凭据对象 |
使您可以通过备用凭据运行 Get-CsUser cmdlet。如果登录 Windows 时所用的帐户没有使用用户对象所需的必要权限,则可能需要这样做。 要使用 Credential 参数,必须首先通过 Get-Credential cmdlet 创建 PSCredential 对象。有关详细信息,请参阅 Get-Credential cmdlet 帮助主题。 |
DomainController |
可选 |
字符串 |
使您可以连接到指定的域控制器以检索用户信息。要连接到特定的域控制器,请包含 DomainController 参数,后跟完全限定域名 (FQDN)(例如 atl-cs-001.litwareinc.com)。 |
Filter |
可选 |
字符串 |
使您可以通过筛选 Lync Server 特有的属性来限制返回的数据。例如,您可以将返回的数据限定为已分配特定语音策略的用户,或尚未分配特定语音策略的用户。 Filter 参数与 Where-Object cmdlet 使用相同的 Windows PowerShell 筛选语法。例如,仅返回已启用企业语音的用户的筛选器语法如下,其中,EnterpriseVoiceEnabled 代表 Active Directory 属性,-eq 代表比较运算符(等于),$True(内置的 Windows PowerShell 变量)代表筛选器值: {EnterpriseVoiceEnabled -eq $True} |
LDAPFilter |
可选 |
字符串 |
使您可以通过筛选 Active Directory 常规属性(即不是特定于 Lync Server 的属性)来限制返回的数据。例如,您可以将返回的数据限定为在特定部门工作的用户或担任指定的经理或其他职务的用户。 LDAPFilter 参数在创建筛选器时使用 LDAP 查询语言。例如,一个仅返回在 Redmond 市工作的用户的筛选器语法如下:"l=Redmond",其中“l”(小写的 L)代表 Active Directory 属性 (locality);“=”代表比较运算符(等于);“Redmond”代表筛选器值。 |
OnOfficeCommunicationServer |
可选 |
开关参数 |
返回驻留在 Lync Server 早期版本(例如 Office Communications Server 2007 R2)之上的用户的集合。使用此参数时,将不返回在软件当前版本上拥有帐户的用户。 |
OnLyncServer |
可选 |
开关参数 |
返回驻留在 Lync Server 2010 之上的用户的集合。使用此参数时,将不返回在软件的早期版本上拥有帐户的用户。 |
OU |
可选 |
可分辨名称 |
使您可以返回有关特定组织单位 (OU) 或容器中的用户帐户的信息。OU 参数返回来自指定 OU 及其任何子 OU 的数据。例如,如果 Finance OU 有两个子 OU,AccountsPayable 和 AccountsReceivable,则将从这三个 OU 返回用户。 指定 OU 时,请使用此容器的可分辨名称 (DN),例如:-OU "OU=Finance,dc=litwareinc,dc=com"。要从用户容器返回用户帐户,请使用以下语法:-OU "cn=Users,dc=litwareinc,dc=com"。 |
ResultSize |
可选 |
整数 |
使您可以限制 cmdlet 返回的记录数。例如,要返回七个用户(不管林中有多少用户),请包含 ResultSize 参数,并将参数值设置为 7。请注意,无法保证返回哪七个用户。 可以将结果大小设置为 0 到 2147483647(包含边界值)之间的任意整数。如果设置为 0,命令将运行,但是不会返回任何数据。如果将 ResultSize 设置为 7,但是林中仅有三个用户,则此命令将返回这三个用户,操作完成,并且不生成错误。 |
UnassignedUser |
可选 |
开关参数 |
使您可以返回已启用 Lync Server但当前未分配到注册器池的所有用户的集合。用户除非被分配到注册器池,否则不允许登录 Lync Server。 |
输入类型
字符串。Get-CsUser 接受通过管道传递的字符串值,代表已启用 Lync Server 2010 的用户帐户的标识。
返回类型
Get-CsUser 返回 Microsoft.Rtc.Management.ADConnect.Schema.ADUser 对象的实例。
示例
-------------------------- 示例 1 --------------------------
Get-CsUser
上述示例调用了 Get-CsUser(未使用任何参数),以返回已启用 Lync Server 或 Office Communications Server 的所有域用户的集合。
-------------------------- 示例 2 --------------------------
Get-CsUser | Format-Table -Property DisplayName, SipAddress, EnterpriseVoiceEnabled -AutoSize
在示例 2 中,Get-CsUser 返回已启用 Lync Server 或 Office Communications Server 的所有域用户的集合。默认情况下,Get-CsUser 会返回非常多的属性和属性值,其中许多在特定情况下意义很小。因此,在此示例中,检索到的数据通过管道传递给 Format-Table cmdlet。然后,Format-Table 使用 Property 参数选择 DisplayName、SipAddress 和 EnterpriseVoiceEnabled 属性,并在一个表中显示这些属性及其值。
-------------------------- 示例 3 --------------------------
Get-CsUser -Identity "Pilar Ackerman"
示例 3 中使用 Identity 参数,将返回的数据限定为 Identity(本例中为显示名称)为 Pilar Ackerman 的用户帐户。
-------------------------- 示例 4 --------------------------
Get-CsUser -Identity "Pilar*"
示例 4 中在指定用户的 Identity 时使用了通配符 (*)。这将使 Get-CsUser 返回 Identity 以字符串值“Pilar”开头的所有用户。
-------------------------- 示例 5 --------------------------
Get-CsUser -Filter {VoicePolicy -eq $Null}
示例 5 所示的命令返回未被分配每用户语音策略的用户的集合。为执行此操作,该命令使用 Filter 参数,后跟筛选器 VoicePolicy -eq "$Null。在构造与 Get-CsUser 配合使用的筛选器时,您需要指定属性名称 (VoicePolicy),后跟比较运算符(本例中为表示“等于”的比较运算符“eq”)。紧随比较运算符之后的是要测试的值。在此示例中,该值为 $Null,是代表空值的 Windows PowerShell 变量。
要返回未向其分配语音策略的用户集合,请使用以下命令:
Get-CsUser -Filter {VoicePolicy -ne $Null}
-------------------------- 示例 6 --------------------------
Get-CsUser -LDAPFilter "Department=Finance"
上述命令使用 LDAPFilter 参数将返回的数据限定为在 Finance 部门工作的用户。这是通过使用 LDAP 筛选器值“Department=Finance”来实现的。
-------------------------- 示例 7 --------------------------
Get-CsUser -LDAPFilter "&(Department=Finance)(Title=Manager)"
示例 7 展示了 AND 查询与 LDAPFilter 参数的结合使用。此查询(使用“&”字符指示 AND 查询)指定了以下两个条件:“Department=Finance”和“Title=Manager”。对于此查询要返回的用户帐户,必须同时满足以下两个条件:即用户必须在 Finance 部门工作,并且他或她的职位必须是 Manager。
-------------------------- 示例 8 --------------------------
Get-CsUser -LdapFilter "|(Title=Supervisor)(Title=Manager)"
示例 8 所示的命令将 OR 查询(由管道符号“|”指示)与 LDAPFilter 参数配合使用。在示例 7 所示的 AND 查询中,必须同时满足两个条件才能返回用户帐户。而对于 OR 查询,只需满足一个条件即可返回帐户。在本例中,如果用户是 Supervisor 或 Manager,便会返回该用户帐户。
-------------------------- 示例 9 --------------------------
Get-CsUser -OU "ou=Finance,ou=North America,dc=litwareinc,dc=com"
示例 9 返回在 Finance OU 中拥有帐户的所有用户的用户帐户信息。
-------------------------- 示例 10 --------------------------
Get-CsUser -UnassignedUser
上述命令返回已启用 Lync Server 或 Office Communications Server但当前未分配到注册器池的所有用户的集合。