Parameters

Get-CsAdUser returns information about all the user accounts in Active Directory, including user accounts that have been enabled for as well as user accounts that have not enabled for Lync Server. This differs from Get-CsUser, which returns information only for users whose accounts have been enabled for Lync Server or an earlier version of the software (such as Microsoft Office Communications Server 2007 R2).

Although there is some overlap between the cmdlets, Get-CsAdUser and Get-CsUser also differ in the type of information they return. In general, Get-CsUser returns values for Active Directory attributes specifically related to Lync Server. For example, Get-CsUser can tell you which Lync Server policies have been assigned to a user; the line Uniform Resource Identifier (URI) assigned to that user; and indicate whether or not the user has been enabled for Enterprise Voice. These attributes will not be part of a user account unless that user has been enabled for Lync Server.

By contrast, Get-CsAdUser returns generic Active Directory attribute values; that is, it returns information about attributes that are part of the basic Active Directory user account and are present whether or not a user has been enabled for Lync Server. For example, Get-CsAdUser returns information such as which department and organization the user works for along with the user’s job title, 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 prompt:

Get-CsAdUser | Get-Member

Get-CsAdUser provides several ways to filter the collection of users returned when you run the cmdlet. For example, if you don't want to return all of your Active Directory users 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 criteria for Lync Server-specific attributes. For example, you can use the Filter parameter to return a collection of users who either have or have not been enabled for Lync Server. The LdapFilter parameter enables you to limit the returned data for users who fit other criteria based on generic Active Directory attributes; for example, users who work in a specified state or province, users who do or do not have a pager, or users with a designated job title.

One important thing to note about the Get-CsAdUser cmdlet is this: although the Enabled attribute, which determines whether or not a user has been enabled for Lync Server, is a Boolean value, this property actually has three valid values:

True. The user has been enabled for Lync Server

False. The user has temporarily had their Lync Server account disabled. This is typically carried out by using the Set-CsUser cmdlet and setting the Enabled parameter to $False.

Null. The user has not been enabled for Lync Server.

What that means is that, if you want to return a list of users who are not enabled for Lync Server then you must use a command that returns all the users where the Enabled attribute is null:

Get-CsAdUser –Filter {Enabled –eq $Null}

By contrast, the following command returns only those user who have Lync Server accounts that have temporarily been disabled:

Get-CsAdUser –Filter {Enabled –eq $False}

Users who have not been enabled for Lync Server will not be returned when you run the preceding command.

Who can run this cmdlet: By default, members of the following groups are authorized to run the Get-CsAdUser cmdlet locally: RTCUniversalUserAdmins, RTCUniversalServerAdmins, RTCUniversalReadOnlyAdmins. To return a list of all the role-based access control (RBAC) roles this cmdlet has been assigned to (including any custom RBAC roles you have created yourself), run the following command from the Windows PowerShell prompt:

Get-CsAdminRole | Where-Object {$_.Cmdlets –match "Get-CsAdUser"}

String. Get-CsAdUser accepts a pipelined string value representing the Identity of an Active Directory user account.

Get-CsAdUser returns instances of the Microsoft.Rtc.Management.ADConnect.Schema.CSADUser object.

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

	Copy Code
Get-CsAdUser

The command shown in Example 1 returns a collection of all the user accounts in your Active Directory domain.

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

	Copy Code
Get-CsAdUser -Identity "Pilar Ackerman"

In Example 2, Get-CsAdUser returns user account information for Pilar Ackerman. In this example, the user's display name is used to specify her Identity.

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

	Copy Code
Get-CsAdUser -OU "ou=Finance,dc=litwareinc,dc=com"

Example 3 returns user account information for all the users in the Finance organizational unit. To do this, the DN of the OU must be passed to the OU parameter.

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

	Copy Code
Get-CsAdUser -Filter {Enabled -ne $True} | Select-Object DisplayName

In the preceding command, all the users who have not been enabled for Lync Server 2010 or Office Communications Server are returned. To do this, the Filter parameter is used with Get-CsAdUser to restrict the returned data to user accounts where the Enabled property is not equal to True. This filter tells Get-CsAdUser to return only those user accounts that have not been enabled for use with Lync Server or Office Communications Server. After the data has been retrieved, the information is piped to the Select-Object cmdlet, which then identifies the only property (in this case, DisplayName) that will actually be displayed on the screen.

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

	Copy Code
Get-CsAdUser -LdapFilter "Department=Finance"

In Example 5 the LdapFilter parameter is used to limit the returned data to users who work in the Finance department. The is done by using the LDAP filter value "Department=Finance".

Other Resources