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

Removes the specified collection of Microsoft Communicator “14” Phone Edition settings. These settings include such things as the required security mode as well as whether the phone should automatically be locked after a specified period of inactivity.

Syntax

Remove-CsUCPhoneConfiguration -Identity <XdsIdentity> [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-WhatIf [<SwitchParameter>]]

Parameters

Parameter Required Type Description

Identity

Required

XdsIdentity

Unique identifier for the collection of UC phone configuration settings to be removed. To remove a site collection use syntax similar to this: -Identity site:Redmond.To remove (i.e., reset) the global collection, use the following syntax: -Identity global. Note that you cannot use wildcards when specifying a policy Identity.

Force

Optional

Switch Parameter

Suppresses the display of any non-fatal error message that might arise when running the command.

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

Communicator “14” Phone Edition represents the merging of two great ideas: the telephone and Communicator. Communicator “14” Phone Edition uses special hardware (that is, a Communicator-compatible telephone) that functions as a Voice over IP telephone. That’s good; even better is the fact that this hardware can also act as a Communicator-like endpoint: you can set your current status; check the status of your Communicator contacts; search for new contacts; and carry out many of the other activities you are used to doing with Communicator. Furthermore, you can do all this with or without a computer: all you need is a place to plug in your Communicator-enabled phone.

Obviously these are powerful and sophisticated devices. And that’s potentially a problem: many organizations are reluctant to distribute devices such as these unless they have a good way to manage and maintain the hardware and the way the hardware is used. Fortunately, that’s not a problem with Microsoft Communications Server 2010; in fact, Communications Server ships with a number of cmdlets that let you manage your Communicator-enabled phones. Among other things, you can use the UC (Unified Communications) phone configuration cmdlets to control such things as the minimum length of the PIN number used to log on to the phone and whether or not the phone will automatically lock itself after a specified period of inactivity.

UC phone configuration settings can be applied at either the global scope or at the site scope. (Settings applied at the site scope take precedence over settings applied at the global scope.) When you first install Communications Server, a single set of UC phone configuration settings is created and applied at the global scope. However, at any time after that you can use the New-CsUCPhoneConfiguration cmdlet to create a collection of settings that are applied at the site scope (with a limit of one set per site). This lets you tailor UC phone management to the unique needs of each individual site.

Settings created using New-CsUCPhoneConfiguration can later be removed using the Remove-CsUCPhoneConfiguration cmdlet. When you remove the settings from a site the Communicator phones in that site are not left unmanaged; instead, those phones will automatically come under the jurisdiction of the global settings.

You can also run Remove-CsUCPhoneConfiguration against the global settings. If you do that, however, the global settings will not actually be removed: you cannot remove the global UC phone settings. Instead, the properties in the global settings will be reset to their default values. For example, if you have changed the phone lock time interval to 30 minutes, "removing" the global settings will reset the interval to the default value of 10 minutes.

Return Types

Removes instances of the Microsoft.Rtc.Management.WriteableConfig.Policy.Voice.UcPhoneSettings object.

Examples

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

Copy Code
Remove-CsUCPhoneConfiguration -Identity site:Redmond

The command shown in Example 1 removes the Unified Communications phone configuration settings for the Redmond site (-Identity site:Redmond). When settings are removed from a site scope, users in that site will have their UC phones governed by the global phone configuration settings.

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

Copy Code
Get-CsUCPhoneConfiguration -Filter site:* | Remove-CsUCPhoneConfiguration

Example 2 removes all the Unified Communications phone settings that have been configured at the site scope. To do this, the command first uses Get-CsUCPhoneConfiguration and the -Filter parameter to return all the settings configured at the site scope; the filter value "site:*" limits the returned data to settings where the Identity property (the only property you can filter on) begins with the string value "site:". This filtered collection is then piped to Remove-CsUCPhoneConfiguration, which proceeds to remove each item (that is, each UC phone setting) in the collection.

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

Copy Code
Get-CsUCPhoneConfiguration | Where-Object {$_.EnforcePhoneLock -eq $False} | Remove-CsUCPhoneConfiguration

In Example 3, all the Unified Communications phone settings that do not enforce phone locking are removed. To carry out this task, the command first uses Get-CsUCPhoneConfiguration (without any parameters) in order to return a collection of all the UC phone settings currently in use in the organization. This collection is piped to the Where-Object cmdlet, which picks out only those settings where the EnforceLockProperty is equal to (-eq) False ($False). In turn, that filtered collection is piped to Remove-CsUCPhoneConfiguration, which removes each item in the collection.

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

Copy Code
Get-CsUCPhoneConfiguration | Where-Object {$_.SIPSecurityMode -ne "High"} | Remove-CsUCPhoneConfiguration

The preceding command deletes all the Unified Communications phone configuration settings where the SIP security mode is set to either Low or Medium. To do this, Get-CsUCPhoneConfiguration is first called in order to return a collection of all the UC phone settings configured for use in the organization. This collection is then piped to Where-Object, which selects only those settings where the SIPSecurityMode property is set to either Low or Medium; this is done by selecting those settings where the SIPSecurityMode is not equal to (-ne) High. (There are only three possible values for SIPSecurityMode: Low, Medium, and High.) The filtered collection is then piped to Remove-CsUCPhoneConfiguration, which deletes all the settings where SIPSecurityMode is not equal to High.