Set-CsAudioTestServiceApplication
Topic Last Modified: 2012-03-27
Enables you to modify the property values for any of the Audio Test service application contacts currently in use in your organization.
Syntax
Set-CsAudioTestServiceApplication -Identity <UserIdParameter> [-Confirm [<SwitchParameter>]] [-CSEnabled <$true | $false>] [-DisplayName <String>] [-DisplayNumber <String>] [-EnabledForFederation <$true | $false>] [-EnterpriseVoiceEnabled <$true | $false>] [-LineURI <String>] [-PassThru <SwitchParameter>] [-PrimaryLanguage <String>] [-SecondaryLanguages <MultiValuedProperty>] [-SipAddress <String>] [-Type <String>] [-WhatIf [<SwitchParameter>]]
Detailed Description
The Audio Test service enables Microsoft Lync 2010 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 Lync 2010 Options dialog box. When a user clicks this button, a call will be made to the automated Audio Test service. The call will be answered and, after an introductory prompt is played, the caller will be asked 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.
The Audio Test service relies, in part, on Active Directory contact objects. These objects are automatically created for you when you install Audio Bot; there is no way to manually create these objects. However, administrators can use the Get-CsAudioTestServiceApplication cmdlet to retrieve information about the various test service contacts currently in use in the organization. Administrators can also use the Set-CsAudioTestServiceApplication to modify the properties of these contacts.
Who can run this cmdlet: By default, members of the following groups are authorized to run the Set-CsAudioTestServiceApplication cmdlet: RTCUniversalServerAdmins. 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 "Set-CsAudioTestServiceApplication"}
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
Identity |
Required |
UserID Parameter |
SIP address of the audio test service contact to be modified. |
Enabled |
Optional |
Boolean |
Indicates whether or not the contact object has been enabled for Lync Server 2010. If you set this value to False ($False), the contact will no longer be able to log on to Lync Server; setting this value to True ($True) re-enables the contact’s logon privileges. |
DisplayName |
Optional |
String |
Active Directory display name of the contact object. |
DisplayNumber |
Optional |
String |
Although a valid property, DisplayNumber is not actually used with the Audio Test service. |
EnabledForFederation |
Optional |
Boolean |
Indicates whether this contact is available to users from a federated domain. If set to False, only users within your organization will have access to the contact. |
EnterpriseVoiceEnabled |
Optional |
Boolean |
Indicates whether the contact object has been enabled for Enterprise Voice, which is the Microsoft implementation of Voice over Internet Protocol (VoIP). With Enterprise Voice, users can use make telephone calls by using the Internet rather than by using the standard telephone network. |
LineUri |
Optional |
String |
Although a valid property, LineUri is not actually used with the Audio Test service. |
PrimaryLanguage |
Optional |
String |
Primary language used for the audio test service. The language must be configured using one of the allowed language codes; for example, en-US for U.S. English; fr-FR for French; etc. To return a list of the available language codes, type the following command at the Windows PowerShell prompt: Get-CsDialInConferencingLanguageList | Select-Object -ExpandProperty Languages. |
SecondaryLanguages |
Optional |
String array |
Although a valid property, SecondaryLanguages is not actually used with the Audio Test service. |
SipAddress |
Optional |
SIP address |
Unique identifier that allows the contact object to communicate by using SIP devices such as Lync 2010. The SIP address must be prefaced by sip:; for example: -SipAddress "sip:kenmyer@litwareinc.com". |
Type |
Optional |
String |
Indicates the type of test contact being deployed. By default, contacts are listed as Automaton, which means they can interact with callers. |
PassThru |
Optional |
Switch Parameter |
Enables you to pass a user object through the pipeline that represents the user being assigned the policy. By default, the Set-CsAudioTestServiceApplication cmdlet does not pass objects through the pipeline. |
WhatIf |
Optional |
Switch Parameter |
Describes what would happen if you executed the command without actually executing the command. |
Confirm |
Optional |
Switch Parameter |
Prompts you for confirmation before executing the command. |
Input Types
Set-CsAudioTestServiceApplication accepts pipelined instances of the Microsoft.Rtc.Management.ADConnect.Schema.OCSADApplicationContact object.
Return Types
Set-CsAudioTestServiceApplication does not return any objects or values.
Example
-------------------------- Example 1 ------------------------
Set-CsAudioTestServiceApplication -Identity "sip:RedmondAudioTest@litwareinc.com" -PrimaryLanguage "en-US"
In Example 1, the primary language for the Audio Test service contact sip:RedmondAudioTest@litwareinc.com is set to U.S. English (en-US).
-------------------------- Example 2 ------------------------
Set-CsAudioTestServiceApplication -Identity "sip:RedmondAudioTest@litwareinc.com" -PrimaryLanguage $Null
The preceding example clears the value of the PrimaryLanguage property for the Audio Test service contact sip:RedmondAudioTest@litwareinc.com. This is done by including the PrimaryLanguage parameter and setting the parameter value to $Null.
-------------------------- Example 3 ------------------------
Get-CsAudioTestServiceApplication | Set-CsAudioTestServiceApplication -PrimaryLanguage "en-US"
In Example 3, all the Audio Test service contacts in use in the organization are configured to use U.S. English as their primary language. To do this, Get-CsAudioTestServiceApplication is first called without any parameters in order to return a collection of the Audio Test service contacts. This collection is then piped to the Set-CsAudioTestServiceApplication, which assigns U.S. English (en-Us) to the PrimaryLanguage property for each contact in the collection.