Set-CsUserAcp
Topic Last Modified: 2012-03-27
Adds a new audio conferencing provider to a user or group of users, or modifies an existing audio conferencing provider already assigned to a user.
Syntax
Set-CsUserAcp -Identity <UserIdParameter> -Domain <String> -Name <String> -ParticipantPasscode <String> -TollNumber <String> [-Confirm [<SwitchParameter>]] [-IsDefault <$true | $false>] [-PassThru <SwitchParameter>] [-TollFreeNumbers <String[]>] [-Url <String>] [-WhatIf [<SwitchParameter>]]
Detailed Description
An audio conferencing provider is a third-party company that provides organizations with conferencing services. Among other things, audio conferencing providers offer a way for users located off site, and not connected to the corporate network or the Internet, to participate in the audio portion of a conference or meeting. Audio conferencing providers often include high-end services such as live translation, transcription, and live per-conference operator assistance.
Microsoft Lync Server 2010 does not allow for complete integration with audio conferencing providers. The CsUserAcp cmdlets enable administrators to set a phone number and passcode, and to configure other information that can be used for audio conferencing provider integration any time a user schedules a meeting. However, because these cmdlets were not designed for the on-premises version of Lync Server (instead, they are primarily intended for use with Microsoft Lync Online 2010) no additional audio conferencing provider integration is provided beyond assigning property values.
Audio conferencing providers can be assigned to a user account by using the Set-CsUserAcp cmdlet. (Note that a user can be assigned multiple audio conferencing providers.) Set-CsUserAcp is also used to modify the properties of an existing audio conferencing provider. If you call Set-CsUserAcp, the cmdlet uses the parameter information included in the call to check the existing audio conferencing providers assigned to the user. If a match is found, then the existing provider is modified. For example, supposed you issue the following command:
Set-CsUserAcp –Identity "Ken Myer" –TollNumber "15554251298" –ParticipantPassCode 13761 –Domain "fabrikam.com" –Name "Fabrikam ACP"
Further suppose that Ken Myer has already been assigned an audio conferencing provider named Fabrikam ACP that has the same TollNumber and Domain as those specified in the command. (In other words, the only difference is the ParticipantPassCode,) In that case, Set-CsUserAcp will modify the existing Fabrikam ACP provider. If a match is not found, then a new provider will be added to Ken Myer’s user account.
Who can run this cmdlet: By default, members of the following groups are authorized to run the Set-CsUserAcp cmdlet locally: RTCUniversalUserAdmins. 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-CsUserAcp"}
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
Identity |
Required |
User Identity |
Indicates the Identity of the user account to be modified. You can specify a user's identity using one of four formats: 1) the user's SIP address; 2) the user's user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer); and, 4) the user's Active Directory Domain Services (AD DS) display name (for example, Ken Myer). User identities can also be referenced by using the user’s Active Directory distinguished name. You can use the asterisk (*) wildcard character when using the Display Name as the user Identity. For example, the Identity "* Smith" returns all the users with a display name that ends in the string value "Smith". |
Domain |
Required |
String |
Domain name of the audio conferencing provider. For example: -Domain "fabrikam.com". |
Name |
Required |
String |
Name of the audio conferencing provider. For example: -Name "Fabrikam Conference Services". |
ParticipantPasscode |
Required |
String |
Passcode required when connecting to a conference by using the audio conferencing provider. For example: -PassCode "0712". |
TollNumber |
Required |
String |
Non-toll-free phone number used for audio conferences. For example: -TollNumber "14255551298". |
IsDefault |
Optional |
Boolean |
Indicates whether or not this is the default audio conferencing provider for the user. Each user can only have one default provider. |
TollFreeNumbers |
Optional |
String |
Collection of toll-free phone number used for audio conferences. For example: -TollFreeNumbers "18005551298". To add multiple toll-free numbers, separate the individual numbers by using commas: -TollFreeNumber "18005551298", "18005559876". |
Url |
Optional |
String |
Web URL for the audio conferencing provider; for example: -Url "http://acp.fabrikam.com". The web URL enables audio conferencing providers to point users to a webpage containing additional dial-in phone numbers, as well as information about the services offered by the audio conferencing provider. |
PassThru |
Optional |
Switch Parameter |
Enables you to pass a user object through the pipeline that represents the user having the audio conferencing provider removed. By default, the Set-CsUserAcp 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
String or Microsoft.Rtc.Management.ADConnect.Schema.ADUser object. Set-CsUserAcp accepts a pipelined string value representing the Identity of a user account that has been enabled for Lync Server 2010. The cmdlet also accepts pipelined instances of the Active Directory user object.
Return Types
None.
Example
-------------------------- Example 1 ------------------------
Set-CsUserAcp -Identity "Ken Myer" -TollNumber "14255551298" -ParticipantPassCode 13761 -Domain "fabrikam.com" -Name "Fabrikam ACP"
In Example 1, Set-CsUserAcp is used to assign a new audio conferencing provider to the user Ken Myer. To do this, the Identity parameter is used to indicate the user account to be modified. In addition, the required parameters TollNumber, ParticipantPassCode, Domain, and Name are included, along with the appropriate parameter values.
-------------------------- Example 2 ------------------------
Get-CsUser -LdapFilter "Department=Finance" | Set-CsUserAcp -TollNumber "14255551298" -ParticipantPassCode 13761 -Domain "fabrikam.com" -Name "Fabrikam ACP"
The command shown in Example 2 assigns the same audio conferencing provider to all the users who work in the Finance department. To do this, the command first uses Get-CsUser and the LdapFilter (with the filter value "Department=Finance") to return a collection of all the users who work in the Finance department. This collection is then piped to the Set-CsUserAcp cmdlet, which assigns the same audio conferencing provider (Fabrikam ACP) to each user in the collection.
-------------------------- Example 3 ------------------------
Set-CsUserAcp -Identity "Ken Myer" -TollNumber "14255551298" -ParticipantPassCode 13761 -Domain "fabrikam.com" -Name "Fabrikam ACP" -TollFreeNumbers "18005551010", "18005551020"
The preceding command assigns the Fabrikam ACP audio conferencing provider to the user Ken Myer. In addition to specifying the TollNumber, ParticipantPassCode, Domain, and Name, this command also includes a pair of toll-free phone numbers. To assign these two values, include the TollFreeNumbers parameter followed by the two phone numbers, separated from one another by a comma.