Set-CsAudioTestServiceApplication

Enables you to modify the property values for any of the Audio Test service application contacts currently in use in your organization. This cmdlet was introduced in Lync Server 2010.

Syntax

Set-CsAudioTestServiceApplication
   [-Identity] <UserIdParameter>
   [-Enabled <Boolean>]
   [-DisplayName <String>]
   [-DisplayNumber <String>]
   [-EnabledForFederation <Boolean>]
   [-EnterpriseVoiceEnabled <Boolean>]
   [-PrimaryLanguage <String>]
   [-SecondaryLanguages <Microsoft.Rtc.Management.ADConnect.Core.MultiValuedProperty`1[System.String]>]
   [-SipAddress <String>]
   [-Type <String>]
   [-PassThru]
   [-WhatIf]
   [-Confirm]
   [-LineURI <String>]
   [-ExchangeArchivingPolicy <ExchangeArchivingPolicyOptionsEnum>]
   [<CommonParameters>]

Description

The Audio Test service enables Skype for Business Server 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 Skype for Business 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 cmdlet to modify the properties of these contacts.

Examples

-------------------------- 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

Example 2 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, the Get-CsAudioTestServiceApplication cmdlet 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.

Required Parameters

-Identity

SIP address of the audio test service contact to be modified.

Type:UserIdParameter
Position:1
Default value:None
Accept pipeline input:True (ByPropertyName, ByValue)
Accept wildcard characters:False
Applies to:Lync Server 2010, Lync Server 2013, Skype for Business Server 2015

Optional Parameters

-Confirm

Prompts you for confirmation before executing the command.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Lync Server 2010, Lync Server 2013, Skype for Business Server 2015
-DisplayName

Active Directory display name of the contact object.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Lync Server 2010, Lync Server 2013, Skype for Business Server 2015
-DisplayNumber

Although a valid property, DisplayNumber is not actually used with the Audio Test service.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Lync Server 2010, Lync Server 2013, Skype for Business Server 2015
-Enabled

Indicates whether or not the contact object has been enabled for Skype for Business Server. If you set this value to False ($False), the contact will no longer be able to log on to Skype for Business Server; setting this value to True ($True) re-enables the contact's logon privileges.

Type:Boolean
Aliases:CsEnabled
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Lync Server 2010, Lync Server 2013, Skype for Business Server 2015
-EnabledForFederation

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.

Type:Boolean
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Lync Server 2010, Lync Server 2013, Skype for Business Server 2015
-EnterpriseVoiceEnabled

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.

Type:Boolean
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Lync Server 2010, Lync Server 2013, Skype for Business Server 2015
-ExchangeArchivingPolicy

Indicates where the contact's instant messaging sessions are archived. Allowed values are:

Uninitialized

UseLyncArchivingPolicy

ArchivingToExchange

NoArchiving

Type:ExchangeArchivingPolicyOptionsEnum
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Lync Server 2013, Skype for Business Server 2015
-LineURI

Although a valid property, LineUri is not actually used with the Audio Test service.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Lync Server 2010, Lync Server 2013, Skype for Business Server 2015
-PassThru

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.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Lync Server 2010, Lync Server 2013, Skype for Business Server 2015
-PrimaryLanguage

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.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Lync Server 2010, Lync Server 2013, Skype for Business Server 2015
-SecondaryLanguages

Although a valid property, SecondaryLanguages is not actually used with the Audio Test service.

Type:Microsoft.Rtc.Management.ADConnect.Core.MultiValuedProperty`1[System.String]
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Lync Server 2010, Lync Server 2013, Skype for Business Server 2015
-SipAddress

This parameter is currently disabled. You cannot change the SIP address using Set-CsAudioTestServiceApplication.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Lync Server 2010, Lync Server 2013, Skype for Business Server 2015
-Type

Indicates the type of test contact being deployed. By default, contacts are listed as Automaton, which means they can interact with callers.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Lync Server 2010, Lync Server 2013, Skype for Business Server 2015
-WhatIf

Describes what would happen if you executed the command without actually executing the command.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Lync Server 2010, Lync Server 2013, Skype for Business Server 2015

Inputs

The Set-CsAudioTestServiceApplication cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.ADConnect.Schema.OCSADApplicationContact object.

Outputs

The Set-CsAudioTestServiceApplication cmdlet does not return any objects or values.