[This is preliminary documentation and is subject to change. Blank topics are included as placeholders.]

Removes an existing common area phone from the collection of phones managed using Microsoft Communications Server 2010. Common area phones are phones that are located in building lobbies, employee lounges, or other areas where they are likely to be used by a number of different people, and for a number of different users.


add-attachmentfilterentry -Name <String> -Type <ContentType | FileName> [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-WhatIf [<SwitchParameter>]]


Parameter Required Type Description



User ID Parameter

Unique identifier for the common area phone. Common area phones are identified using the Active Directory distinguished name of the associated contact object. Common area phones, by default, use a GUID (globally unique identifier) as their common name; that means phones will typically have an Identity similar to this: CN={ce84964a-c4da-4622-ad34-c54ff3ed361f},OU=Redmond,DC=Litwareinc,DC=com. Because of that you might find it easier to retrieve common area phones by using the Get-CsCommonAreaPhone cmdlet, then piping the returned objects to Remove-CsCommonAreaPhone.

Note. By using the –DN parameter when calling New-CsCommonAreaPhone, administrators can give common area phones a more user-friendly common name (e.g., Building 14 Lobby as opposed to {ce84964a-c4da-4622-ad34-c54ff3ed361f}).



Switch Parameter

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



Switch Parameter

Prompts you for confirmation before executing the command.

Detailed Description

Common area phones are IP telephones that are not associated with an individual user; instead of being located in someone’s office, common area phones are typically located in building lobbies, cafeterias, employee lounges, meeting rooms and other locations where a large number of people are likely to congregate (and might need to use the phone). This presents administrators with a management challenge. After all, phone use in Microsoft Communications Server is typically maintained by using various voice policies and dial plans, policies and plans that are assigned to individual users. How can you manage a device that isn’t associated with an individual user?

One solution is to create Active Directory contact objects for all your common area phones. (These contact objects can be created using the New-CsCommonAreaPhone cmdlet.) Like user accounts, these contact objects can be assigned policies and voice plans. As a result, you will be able to maintain control over common area phones even though those phones are not associated with an individual user. For example, if you do not want people to have the ability to transfer or park calls from a common area phone, all you have to do is create a voice policy that prohibits call transfers and call parking, then assign that policy to the common area phone. (Or, more correctly, to the contact object that represents the common area phone.) For example, this command assigns the voice policy CommonAreaPhoneVoicePolicy to all your common area phones:

Get-CsCommonAreaPhone | Grant-CsVoicePolicy –PolicyName "CommonAreaPhoneVoicePolicy"

From time-to-time you might need to delete the contact object associated with a common area phone. For example, if you remove the phone from an employee lounge then there is no need to have a contact object associated with that phone. The Remove-CsCommonAreaPhone cmdlet provides a way for you to delete common area phones. When you run this cmdlet, the phone will be deleted from the list of common area phones returned by Get-CsCommonAreaPhone. In addition, the contact object associated with that phone will be deleted from Active Directory.

Return Types

Remove-CsCommonAreaPhone deletes existing instances of the Microsoft.Rtc.Management.ADConnect.Schema.OCSADCommonAreaPhoneContact object.


-------------------------- Example 1 ------------------------

Copy Code
Get-CsCommonAreaPhone -Filter {DisplayName -eq "Building 14 Lobby"} | Remove-CsCommonAreaPhone

The command shown in Example 1 deletes the common area phone that has the DisplayName "Building 14 Lobby". To do this, the command first calls Get-CsCommonAreaPhone along with the -Filter parameter and the filter value "{DisplayName -eq "Building 14 Lobby"}". The returned object is then piped to, and deleted by, the Remove-CsCommonAreaPhone cmdlet.

-------------------------- Example 2 ------------------------

Copy Code
Get-CsCommonAreaPhone -Filter {DialPlan -eq "RedmondDialPlan"} | Remove-CsCommonAreaPhone

In Example 2, the command deletes all the common area phones that have been assigned the dial plan RedmondDialPlan. This task is carried out by first using Get-CsCommonAreaPhone and the -Filter parameter to return the specified items; the filter value {DialPlan -eq "RedmondDialPlan"} limits the returned data to common area phones that have been assigned the RedmondDialPlan dial plan. This filtered collection is then piped to the Remove-CsCommonAreaPhone, which deletes each phone in the collection.

-------------------------- Example 3 ------------------------

Copy Code
Get-CsCommonAreaPhone -Filter {EnterpriseVoiceEnabled -eq $False} | Remove-CsCommonAreaPhone

The preceding command deletes all the common area phones that have not been enabled for Enterprise Voice. To do this, Get-CsCommonAreaPhone and the -Filter parameter are called in order to return the phones that have not been enabled for Enterprise Voice; those phones can be identified by using the filter value {EnterpriseVoiceEnabled -eq $False}. The filtered collection is then piped to Remove-CsCommonAreaPhone, which deletes any common area phone that has been enabled for Enterprise Voice.

-------------------------- Example 4 ------------------------

Copy Code
Get-CsCommonAreaPhone -OU "ou=Redmond,dc=litwareinc,dc=com" | Remove-CsCommonAreaPhone

Example 4 deletes all the common area phones that have their contact objects located in the Redmond OU in Active Directory. To carry out this task, Get-CsCommonAreaPhone is first called in order to return all the common area phones with contact objects in the Redmond OU; the –OU parameter and the parameter value "ou=Redmond,dc=litwareinc,dc=com” is used to limit the returned data to the specified organizational unit. The returned collected is then piped to Remove-CsCommonAreaPhone, which proceeds to delete each phone in that collection.