Topic Last Modified: 2010-10-01

Retrieves one or more hosted Exchange Unified Messaging (UM) contact objects.


Get-CsExUmContact [-Identity <UserIdParameter>] [-Credential <PSCredential>] [-DomainController <Fqdn>] [-Filter <String>] [-LdapFilter <String>] [-OU <OUIdParameter>] [-ResultSize <Unlimited>]


Parameter Required Type Description




The unique identifier of the contact object you want to retrieve. Contact identities can be specified using one of four formats: 1) the contact's SIP address; 2) the contact's user principal name (UPN); 3) the contact's domain name and logon name, in the form domain\logon (for example, litwareinc\exum1); and, 4) the contact's Active Directory display name (for example, Team Auto Attendant).

Full data type: Microsoft.Rtc.Management.AD.UserIdParameter




Enables you to limit the returned data by filtering on Lync Server 2010-specific attributes. For example, you can limit returned data to contacts that have line URIs beginning with "tel:555".

The Filter parameter uses a subset of the Windows PowerShell filtering syntax used by the Where-Object cmdlet. For example, a filter that returns only contacts who have been enabled for Enterprise Voice would look like this: {EnterpriseVoiceEnabled -eq $True}, with EnterpriseVoiceEnabled representing the Active Directory attribute; -eq representing the comparison operator (equal to); and $True (a built-in Windows PowerShell variable) representing the filter value.




Enables you to limit the returned data by filtering "generic" Active Directory attributes (that is, attributes that are not specific to Lync Server).

The LdapFilter parameter uses LDAP query language when creating filters.




Enables you to run the cmdlet under alternate credentials; this might be required if the account you used to log on to Windows does not have the necessary privileges required to work with contact objects.

To use the Credential parameter, you must first create a PSCredential object by calling the Get-Credential cmdlet.




Enables you to connect to the specified domain controller in order to retrieve contact information. To connect to a particular domain controller, include the DomainController parameter followed by the computer name (for example, atl-mcs-001) or its fully qualified domain name (for example,

Full data type: Microsoft.Rtc.Management.Deploy.Fqdn




Enables you to limit the retrieved information to a specific Active Directory organizational unit (OU). Note that this returns data from the specified OU and any child OUs.

When specifying an OU, use the distinguished name of that container; for example, OU=ExUmContacts,dc=litwareinc,dc=com.




Enables you to limit the number of records returned by a command. For example, to return just seven contacts (regardless of how many contacts are in your forest) simply include the ResultSize parameter and set the parameter value to 7. Note that there is no way to guarantee which seven contacts will be returned. If you set the ResultSize to 7 but you have only three contacts in your forest, the command will return those three contacts, and then complete without error.

The result size can be set to any whole number between 0 and 2147483647, inclusive. If set to 0 the command will run, but no data will be returned.

Full data type: Microsoft.Rtc.Management.ADConnect.Core.Unlimited

Detailed Description

Microsoft Lync Server 2010 works with Exchange UM to provide several voice-related capabilities, including Auto Attendant and Subscriber Access. When Exchange UM is provided as a hosted service (rather than on-premises), contact objects must be created by using Windows PowerShell to apply the Auto Attendant and Subscriber Access functionality. This cmdlet retrieves one or more of these contacts.

Who can run this cmdlet: By default, members of the following groups are authorized to run the Get-CsExUmContact 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-CsExUmContact"}

Input Types

String. Accepts a pipelined string value representing the Identity of an Exchange UM contact object.

Return Types

Returns an object of type Microsoft.Rtc.Management.ADConnect.Schema.OCSADExUmContact.


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

Copy Code

This example retrieves all Exchange UM contacts defined within a Lync Server 2010 deployment.

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

Copy Code
Get-CsExUmContact -Identity

This example retrieves the Exchange UM contact with the SIP address

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

Copy Code
Get-CsExUmContact -Filter {Enabled -eq $False}

In this example, we use the Filter parameter to retrieve all Exchange UM contacts that are not enabled for Lync Server 2010. We do this by filtering on the Enabled property to see if the value of this property is equal to (-eq) False ($False). Contacts returned by this command will not function.

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

Copy Code
Get-CsExUmContact -Filter {LineURI -like "tel:555*"}

This command filters on the LineURI property to retrieve all Exchange UM contacts with a LineURI beginning with tel:555. In other words, it retrieves all contacts with a phone number that begins with 555.

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

Copy Code
Get-CsExUmContact -OU "OU=ExUmContacts,DC=Vdomain,DC=com"

The command in this example uses the OU parameter to retrieve all Exchange UM contacts that are in the Active Directory OU OU=ExUmContacts,DC=Vdomain,DC=com.

See Also