[This is preliminary documentation and is subject to change. Blank topics are included as placeholders.]

Enables you to return information about the audio test service application contacts currently in use in your organization.

Syntax


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

Parameters

Parameter	Required	Type	Description
Identity	Optional	User ID parameter	SIP address of the audio test service contact.
Filter	Optional	String	Enables you to limit the returned data by filtering on Microsoft Communications Server-specific attributes. For example, you can limit returned data to audio test contact objects that have a specific display name or have not been assigned a display number. The -Filter parameter uses the same Windows PowerShell filtering syntax that is used by the Where-Object cmdlet. For example, a filter that returns only contacts that have been enabled for Enterprise Voice would look like this, with EnterpriseVoiceEnabled representing the Active Directory Domain Services attribute, -eq representing the comparison operator (equal to), and $True (a built-in Windows PowerShell variable) representing the filter value: -Filter {EnterpriseVoiceEnabled -eq $True} For details, see the about_communications_server_filters Help topic. You cannot use both the –Filter and the –Identity parameters in the same command.
OU	Optional	Active Directory distinguished name	Enables you to limit the retrieved information from a specific Active Directory Domain Services organizational unit (OU). This returns data from both the specified OU and any of its child OUs. For example, if the Finance OU has two child OUS--AccountsPayable and AccountsReceivable--users will be returned from each of these three OUs. When specifying an OU, use the distinguished name of that container; for example: OU=Finance,dc=litwareinc,dc=com.
DomainControler	Optional	FQDN	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, atl-mcs-001.litwareinc.com).
Credential	Optional	PS Credential object	Enables you to run the cmdlet under alternate credentials. This might be required if the account you used to log on to the 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 using the Get-Credential cmdlet. For details, see the Get-Credential cmdlet Help topic.
ResultSize	Optional	Integer	Enables you to limit the number of records returned by a command. For example, to return seven users (regardless of how many users are in your forest) include the ResultSize parameter and set the parameter value to 7. Note that there is no way to guarantee which 7 users will be returned. If you set the ResultSize to 7 but you have only three users in your forest, the command will return those three users, 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.

Detailed Description

The Audio Test Service enables Microsoft Communicator users to test their voice connections before they make a voice call. To do this, users click the Check call quality button found on the Audio Device tab of the Communicator Options dialog box. When a user clicks this button, a call will be made to an automated audio test service application contact. The call will be answered and, after a brief introductory recording is played, the caller will be prompted to record a brief message (10 seconds maximum). That recording will then be replayed, enabling the caller to hear what he or she sounds like over the current connection.

Audio test service contacts are automatically created for you when you install Unified Communications Application Server; there is no provision for manually creating these contacts. Administrators can use the Get-CsAudioTestServiceApplicationContact cmdlet to retrieve information about the various test service contacts currently in use in the organization.

Return Types

Set-CsAudioTestServiceApplicationContact does not create any objects.

Examples

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

	Copy Code
Get-CsAudioTestServiceApplicationContact

In the preceding example, Get-CsAudioTestServiceApplicationContact is called without any additional parameters in order to return a collection of all the audio test service contacts currently in use in the organization.

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

	Copy Code
Get-CsAudioTestServiceApplicationContact -Identity "sip:RedmondAudioTest@litwareinc.com"

In Example 2, a single audio test service contact is returned: the contact that has the Identity sip:RedmondAudioTest@litwareinc.com.

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

	Copy Code
Get-CsAudioTestServiceApplicationContact -Filter {DisplayNumber -eq "1-425-555-1298"}

Example 3 returns the audio test service contact that has the display number 1-425-555-1298. To do this, the command uses the –Filter parameter and the filter value {DisplayNumber –eq "1-425-555-1298"; that filter value limits the returned data to contacts that have a display number equal to (-eq) 1-425-555-1298. Note that the display number requires an exact match; a contact with the display number 1.800.425.555.1298 will not be returned by this query.