Get-CsUser [-Identity <UserIdParameter>] [-Credential <PSCredential>] [-DomainController <Fqdn>] [-Filter <String>] [-LdapFilter <String>] [-OU <OUIdParameter>] [-ResultSize <Unlimited>] [-UnAssignedUser <SwitchParameter>] [-WithCurrentClient <SwitchParameter>] [-WithLegacyClient <SwitchParameter>]

Parameters

Used together, the cmdlets Get-CsAdUser and Get-CsUser enable you to return detailed information about all your Active Directory Domain Services user accounts. Get-CsAdUser returns information about all your user accounts, including both users who have been enabled for Communications Server and users who have not been enabled for Communications Server. This differs from Get-CsUser, which returns information only for users whose accounts have been enabled for Communications Server.

Although there is some overlap, the two cmdlets also differ in the type of information they return. In general, Get-CsUser returns values for Active Directory Domain Services attributes specifically related to Communications Server. For example, Get-CsUser returns information such as which Communications Server policies have been assigned to a user, the line Uniform Resource Identifier (URI) and line server URI that belong to a user, and whether or not the user has been enabled for Enterprise Voice and/or remote call control. These attributes will not be part of a user account unless that user has been enabled for Communications Server.

By contrast, Get-CsAdUser returns generic Active Directory Domain Services attribute values; that is, it returns information about attributes that are part of the basic Active Directory Domain Services user account and are present whether or not a user has been enabled for Communications Server. For example, Get-CsAdUser returns information such as the department and organization the user works for, the user's job title, and the user’s telephone number and office address. To see a complete list of the attribute values returned by Get-CsAdUser, type this command at the Windows PowerShell command prompt: Get-CsAdUser | Get-Member.

Get-CsAdUser provides numerous ways for you filter the collection of users actually returned when you run the cmdlet. For example, if you don't want to return all Active Directory Domain Services user accounts, you can apply the optional parameters Filter or LDAPFilter. (These parameters are mutually exclusive: if you use Filter in a command you cannot use LDAPFilter in that same command, and vice-versa.) The Filter parameter enables you to limit the returned data to users who meet the specified Microsoft Communications Server criteria; for example, you might decide to return only users with accounts on the specified registrar pool, or only users who have been enabled for Enterprise Voice. The LDAPFilter parameter enables you to limit the returned data to users who fit other criteria stored in Active Directory Domain Services; for example, users who work in a specified state or province, users who do or do not have a pager, and users with a designated job title. Both of these parameters allow for more sophisticated filtering: for example, all the users with an account on a specific registrar pool and who have been enabled for Enterprise Voice;, or all the users in the state of Washington who have the job title Systems Analyst.

Get-CsUser returns instances of the Microsoft.Rtc.Management.ADConnect.Schema.ADUser object.

-------------------------- Example 1 --------------------------

	Copy Code
Get-CsUser

In the preceding example, Get-CsUser is called without any parameters in order to return a collection of all the domain users who have been enabled for Communications Server. To return a collection of all the domain users, including those who have not been enabled for Communications Server, use the Get-CsAdUser cmdlet.

-------------------------- Example 2 --------------------------

	Copy Code
Get-CsUser | Format-Table -Property DisplayName, SipAddress, CSEnabled, EnterpriseVoiceEnabled

In Example 2, Get-CsUser is again used to return a collection of all the domain users who have been enabled for Communications Server. By default, Get-CsUser returns a very large number of properties and property values, many of which will be of no interest in a given situation. Therefore, in this example the data returned by calling Get-CsUser is piped to the Format-Table cmdlet. Format-Table then uses the Property parameter to select the properties DisplayName, SipAddress, CSEnabled, and EnterpriseVoiceEnabled, and then display just those four properties and their values in a table.

-------------------------- Example 3 --------------------------

	Copy Code
Get-CsUser -Identity "Pilar Ackerman"

In Example 3, the Identity parameter is used to limit the returned data to the user account with the Identity Pilar Ackerman. In this case, the user's first name and last name are used to indicate her identity. Alternatively, you can use the user's distinguished name, universal principal name, or SIP address when providing a value to the Identity parameter. Identities can also be expressed using the domain\username format; for example, litwareinc\pilarackerman.

-------------------------- Example 4 --------------------------

	Copy Code
Get-CsUser -Identity "Pilar*"

In Example 4, the wildcard character (*) is used when specifying the user's Identity. In this case, Get-CsUser will return all the users who have a first name equal to Pilar (or, more correctly, all the users who have an identity that begins with the string value Pilar).

-------------------------- Example 5 --------------------------

	Copy Code
Get-CsUser -Filter {VoicePolicy -ne "*"}

The command shown in Example 5 returns a collection of users who do not have a voice policy assigned to them. To do this, the command uses the Filter parameter followed by the filter VoicePolicy -ne "*". When constructing filters for use with Get-CsUser, specify the property name (VoicePolicy) followed by the comparison operator (in this case, -ne, the comparison operator that means "not equal to"). Immediately following the comparison operator is the value you are testing for. In this case that value is the wildcard character (asterisk); that's equivalent to setting the value to "anything at all." Thus this filter returns a collection of users who have a voice policy that is not equal to anything at all; in other words, users who do not have a voice policy of any kind assigned to them.

-------------------------- Example 6 --------------------------

	Copy Code
Get-CsUser -LDAPFilter "Department=Finance"

The preceding command uses the LDAPFilter parameter to limit the returned data to users who are members of the Finance department.

-------------------------- Example 7 --------------------------

	Copy Code
Get-CsUser -LDAPFilter "&(Department=Finance)(Title=Manager)"

Example 7 demonstrates the use of an AND query in conjunction with the LDAPFilter parameter. This query (which uses the ampersand character & to indicate an AND query) specifies two conditions: Department=Finance and Title=Manager. For a user account to be returned by this query, both conditions must be true: a user must be a member of the Finance department, and he must be a Manager.

-------------------------- Example 8 --------------------------

	Copy Code
Get-CsUser -LdapFilter "|(Title=Supervisor)(Title=Manager)"

In the command shown in Example 8, an OR query (indicated by the pipe symbol |) is used with the LDAPFilter parameter. In the AND query shown in Example 7, both conditions had to be true in order for a user account to be returned. With an OR query, only one condition must be true for the account to be returned. In this case, a user account will be returned if the user is a Supervisor or if the user is a Manager.

-------------------------- Example 9 --------------------------

	Copy Code
Get-CsUser -OU "ou=Finance,ou=North America,dc=litwareinc,dc=com"

Example 9 returns user account information for the Finance OU in Active Directory Domain Services. The distinguished name of the OU must be passed to the OU parameter.

-------------------------- Example 10 --------------------------

	Copy Code
Get-CsUser -UnassignedUser

The preceding command returns a collection of all the users who have been enabled for Communications Server but are not currently assigned to a registrar pool.