Export (0) Print
Expand All
Expand Minimize

Remove-CsUCPhoneConfiguration

 

Topic Last Modified: 2012-03-26

Removes the specified collection of Microsoft Lync 2010 Phone Edition configuration settings. These settings include such things as the required security mode and whether the phone should automatically be locked after a specified period of inactivity.

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

Lync 2010 Phone Edition represents the merging of the telephone and Microsoft Lync 2010. Lync 2010 Phone Edition uses special hardware (that is, a Lync 2010-compatible telephone) that can function as a Voice over Internet Protocol (VoIP) telephone. In addition, this hardware can also act as a Lync 2010-like endpoint: you can set your current status; check the status of your Lync 2010 contacts; search for new contacts; and carry out many of the other activities you are used to doing with Lync.

Microsoft Lync Server 2010 ships with a number of cmdlets that enable you to manage phones running Lync 2010; for example, you can control such things as the minimum length of the personal identification number (PIN) used to log on to the phone and whether or not the phone will automatically lock itself after a specified period of inactivity.

Unified communications (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 Lync Server 2010, 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 applied at the site scope. This lets you tailor UC phone management to the unique needs of each individual site.

Settings created by using New-CsUCPhoneConfiguration can later be removed by using the Remove-CsUCPhoneConfiguration cmdlet. When you remove settings from a site the phones running Lync 2010 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.

Who can run this cmdlet: By default, members of the following groups are authorized to run the Remove-CsUCPhoneConfiguration cmdlet locally: RTCUniversalServerAdmins. 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-CsUCPhoneConfiguration"}

 

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 (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 occur 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.

Microsoft.Rtc.Management.WritableConfig.Policy.Voice.UcPhoneSettings object. Remove-CsUCPhoneConfiguration accepts pipelined instances of the UC phone settings object.

None. Instead, the cmdlet removes instances of the Microsoft.Rtc.Management.WritableConfig.Policy.Voice.UcPhoneSettings object.

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

Remove-CsUCPhoneConfiguration -Identity site:Redmond

The command shown in Example 1 removes the UC 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 ------------------------

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

Example 2 removes all the UC 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 removes each item in the collection.

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

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

In Example 3, all the UC 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 False. In turn, that filtered collection is piped to Remove-CsUCPhoneConfiguration, which removes each item in the collection.

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

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

The preceding command deletes all the UC 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 High. (There are 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.

 
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft