Remove-CsCommonAreaPhone
Removes an existing common area phone from the collection of phones managed by using Skype for Business Server. 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 uses. This cmdlet was introduced in Lync Server 2010.
Syntax
Remove-CsCommonAreaPhone
[-Identity] <UserIdParameter>
[-WhatIf]
[-Confirm]
[<CommonParameters>] 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 gather. This presents administrators with a management challenge; that's because phone use in Skype for Business Server is typically maintained by using voice policies and dial plans that are assigned to individual users. Common area phones do not have individual users assigned to them.
One solution to this challenge is to create Active Directory contact objects for all your common area phones.
(These contact objects can be created by 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, you can create a voice policy that prohibits call transfers and call parking, and 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 the Get-CsCommonAreaPhone cmdlet.
In addition, the contact object associated with that phone will be deleted from Active Directory Domain Services.
Examples
-------------------------- Example 1 ------------------------
Get-CsCommonAreaPhone -Filter {DisplayName -eq "Building 14 Lobby"} | Remove-CsCommonAreaPhoneThe command shown in Example 1 deletes the common area phone that has the display name "Building 14 Lobby".
To do this, the command first calls the Get-CsCommonAreaPhone cmdlet 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 ------------------------
Get-CsCommonAreaPhone -Filter {DialPlan -eq $Null} | Remove-CsCommonAreaPhoneIn Example 2, the command deletes all the common area phones that have not been assigned a dial plan.
This task is carried out by first using the Get-CsCommonAreaPhone cmdlet and the Filter parameter to return the specified items; the filter value {DialPlan -eq $Null} limits the returned data to common area phones that have not been assigned a dial plan.
This filtered collection is then piped to the Remove-CsCommonAreaPhone cmdlet, which deletes each phone in the collection.
-------------------------- Example 3 ------------------------
Get-CsCommonAreaPhone -OU "ou=Redmond,dc=litwareinc,dc=com" | Remove-CsCommonAreaPhoneExample 3 deletes all the common area phones that have contact objects located in the Redmond OU in Active Directory.
To carry out this task, the Get-CsCommonAreaPhone cmdlet 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 collection is then piped to the Remove-CsCommonAreaPhone cmdlet, which deletes each phone in that collection.
Parameters
-Confirm
Prompts you for confirmation before executing the command.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 |
-Identity
Unique identifier for the common area phone.
Common area phones are identified using the Active Directory distinguished name of the associated contact object.
By default, common area phones use a globally unique identifier (GUID) as their common name, which 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, and then piping the returned objects to the Remove-CsCommonAreaPhone cmdlet.
| Type: | UserIdParameter |
| Position: | 1 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 |
-WhatIf
Describes what would happen if you executed the command without actually executing the command.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 |
Inputs
Microsoft.Rtc.Management.ADConnect.Schema.OCSADCommonAreaPhoneContact object.
The Remove-CsCommonAreaPhone cmdlet accepts pipelined instances of the common area phone object.
Outputs
The Remove-CsCommonAreaPhone cmdlet deletes existing instances of the Microsoft.Rtc.Management.ADConnect.Schema.OCSADCommonAreaPhoneContact object.