Remove-CsUserAcp
Topic Last Modified: 2012-03-25
Removes one or more audio conferencing providers assigned to a user or group of users.
Syntax
Remove-CsUserAcp -Identity <UserIdParameter> [-Confirm [<SwitchParameter>]] [-Name <String>] [-ParticipantPasscode <String>] [-PassThru <SwitchParameter>] [-TollNumber <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 provide 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 provide 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 do 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.
Any audio conferencing provider assigned to a user can later be removed by using the Remove-CsUserAcp cmdlet. Calling Remove-CsUserAcp without any parameters (other than the Identity parameter, which indicates the user account to be modified) removes all the audio conferencing providers assigned to a user. Alternatively, you can use the optional parameters included with Remove-CsUserAcp to remove selected providers from a user account. For example, this command finds the Ken Myer user account and removes all the audio conferencing providers that have a Name equal to “Fabrikam ACP”:
Remove-CsUserAcp –Identity "Ken Myer" –Name "Fabrikam ACP"
To provide finer-grained removal of audio conferencing providers, simply include additional parameters. For example this command removes any audio conferencing providers that have the Name “Fabrikam ACP” and also have a TollNumber equal to "14255551298" as follows:
Remove-CsUserAcp –Identity "Ken Myer" –Name "Fabrikam ACP" –TollNumber "14255551298"
Who can run this cmdlet: By default, members of the following groups are authorized to run the Remove-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 "Remove-CsUserAcp"}
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
Identity |
Required |
User Identity |
Indicates the Identity of the user account from which the audio conferencing provider is to be removed. 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 reference 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 with the string value " Smith". |
Name |
Optional |
String |
Name of the audio conferencing provider. For example: -Name "Fabrikam Conference Services". |
ParticipantPassCode |
Optional |
String |
Passcode required when connecting to a conference by using the audio conferencing provider. For example: -PassCode "0712". |
TollNumber |
Optional |
String |
Non-toll-free phone number used for audio conferences. For example: -TollNumber "14255551298". |
PassThru |
Optional |
Switch Parameter |
Enables you to pass a user object through the pipeline that represents the user who is having the audio conferencing provider removed. By default, the Remove-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. Remove-CsUserAcp accepts a pipelined string value representing the Identity of a user account that has been enabled for Microsoft Lync Server 2010. The cmdlet also accepts pipelined instances of the Active Directory user object.
Return Types
None.
Example
-------------------------- Example 1 ------------------------
Remove-CsUserAcp -Identity "Ken Myer"
The command shown in Example 1 removes all the audio conferencing providers that have been assigned to the user Ken Myer.
-------------------------- Example 2 ------------------------
Get-CsUser | Remove-CsUserAcp
Example 2 shows how you can remove all of the audio conferencing providers that have been assigned to all the users enabled for Lync Server 2010. To do this, the command first uses Get-CsUser to retrieve a collection of all the users who have been enabled for Lync Server. That collection is then piped to the Remove-CsUserAcp cmdlet, which removes all the audio conferencing providers that have been assigned to each user in the collection.
-------------------------- Example 3 ------------------------
Remove-CsUserAcp -Identity "Ken Myer" -Name "Fabrikam ACP"
In Example 3, all the audio conferencing providers that have the Name "Fabrikam ACP" are removed from Ken Myer’s user account.
-------------------------- Example 4 ------------------------
Get-CsUserAcp | Where-Object {$_.AcpInfo -match "14255551298"} | Remove-CsUserAcp
The preceding command removes the audio conferencing provider that has the toll number "14255551298" from all the user accounts that have been assigned an audio conferencing provider. To carry out this task, the command first uses Get-CsUserAcp to return information about all the audio conferencing providers assigned to all your users. This information is then piped to the Where-Object cmdlet, which selects only those accounts where the AcpInfo property includes (-match) the telephone number "14255551298". This filtered collection is then piped to the Remove-CsUserAcp cmdlet, which removes the corresponding audio conferencing provider from each account in the filtered collection.