Removes one or more audio conference 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>]] |
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
Identity |
Required |
User Identity |
Indicates the Identity of the user account where the audio conference provider is to be removed from. User Identities can be specified using one of four formats: 1) the user's SIP address; 2) the user's Universal Principal Name; 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 display name (for example, Ken Myer). Note that the SamAccountName cannot be used as an identity because it is not necessarily unique in a forest. You can use the asterisk (*) wildcard character when using the Display Name as the user Identity. For example, the Identity "* Smith" would return all the users with a display name that ends with the string value " Smith". |
|
TollNumber |
Optional |
String |
Non-toll-free phone number used for audio conferences. For example: -TollNumber "14255551298". |
|
ParticipantPassCode |
Optional |
String |
Passcode required when connecting to a conference via the audio conference provider. For example: -PassCode "0712". |
|
Name |
Optional |
String |
Name of the audio conference provider. For example: -Name "Fabrikam Conference Services". |
|
PassThru |
Optional |
Switch Parameter |
Enables you to pass a user object through the pipeline that represents the user having the audio conference 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. |
Detailed Description
An audio conference provider is a third-party company that provides organizations with conferencing services. Among other things, audio conference 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 online meeting. Audio conference providers often provide high-end services such as live translation, transcription, and live per-conference operator-assistance.
Any audio conference 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 conference 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 conference providers that have a Name equal to “Fabrikam ACP”:
Remove-CsUserAcp –Identity "Ken Myer" –Name "Fabrikam ACP"
To provide finer-grained removal of audio conference providers, simply include additional parameters. For example this command removes any audio conference providers that have the Name “Fabrikam ACP” and that also have a TollNumber equal to "14255551298":
Remove-CsUserAcp –Identity "Ken Myer" –Name "Fabrikam ACP" –TollNumber "14255551298""14255551298"
Return Types
Examples
-------------------------- Example 1 ------------------------
 Copy Code |
|
|---|---|
Remove-CsUserAcp -Identity "Ken Myer" |
|
The command shown in Example 1 removes all the audio conference providers that have been assigned to the user Ken Myer.
-------------------------- Example 2 ------------------------
| Copy Code |
|
|---|---|
Get-CsUser | Remove-CsUserAcp |
|
Example 2 shows how you can remove all the audio conference providers that have been assigned to all your Communications Server-enabled users. To do this, the command first uses Get-CsUser to retrieve a collection of all the users who have been enabled for Communications Server. That collection is then piped to the Remove-CsUserAcp cmdlet, which removes all the audio conference providers that have been assigned to each user in the collection.
-------------------------- Example 3 ------------------------
| Copy Code |
|
|---|---|
Remove-CsUserAcp -Identity "Ken Myer" -Name "Fabrikam ACP" |
|
In Example 3, all the audio conference providers that have the Name "Fabrikam ACP" are removed from Ken Myer’s user account.
-------------------------- Example 4 ------------------------
| Copy Code |
|
|---|---|
Get-CsUserAcp | Where-Object {$_.AcpInfo -match "14255551298"} | Remove-CsUserAcp
|
|
The preceding command removes the audio conference provider that has the toll number "14255551298" from all the user accounts that have been assigned an audio conference provider provider. To carry out this task, the command first uses Get-CsUserAcp to return information about all the audio conference 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 ACP provider from each account in the filtered collection,