• Article

Remove-CsDeviceUpdateConfiguration

 

Topic Last Modified: 2012-03-27

Removes the specified device update configuration settings. These settings help manage the Device Update Web service, a Microsoft Lync Server 2010 component that enables administrators to distribute firmware updates to telephones and other devices running Microsoft Lync 2010 Phone Edition.

Syntax

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

Detailed Description

The Device Update Web service provides a way for administrators to distribute firmware updates to devices that run Lync 2010 Phone Edition. Periodically, administrators upload a set of device update rules to Lync Server 2010. After those rules have been tested and approved, they can then be applied to the appropriate devices as those devices connect to the system. Devices check for updates when they are first powered on, then check again when a user logs on. After that, devices check for updates every 24 hours.

Lync Server uses device update configuration settings to manage the Device Update Web service; these configuration settings can be applied at the global scope or at the site scope. By default, settings are found only at the global scope; however, you can use the New-CsDeviceUpdateConfiguration cmdlet to assign customized settings at the site scope as well.

In addition, you can use the Remove-CsDeviceUpdateConfiguration cmdlet to delete settings that have been assigned at the site scope. When you run this cmdlet against a site, the device update configuration settings assigned to that site are removed. You can also run Remove-CsDeviceUpdateConfiguration against the global settings. In that case, however, the global settings will not be removed; that’s because you cannot remove the global device update configuration settings. Instead, the global properties will be reset to their default values. For example, suppose you have changed the global property MaxLogCacheLimit to 1,024,000 bytes. If you run Remove-CsDeviceUpdateConfiguration against the global settings, the global settings will not be removed; however, any properties that have been modified will be reset to their default values. That means that MaxLogCacheLimit will be reset to 512,000 bytes.

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

Parameters

Parameter Required Type Description

Identity

Required

Xds Identity

Indicates the Identity of the device update configuration settings to be removed. To refer to the global settings, use this syntax: -Identity global. To refer to site settings, use syntax similar to this: -Identity site:Redmond. Note that you cannot use wildcards when specifying an 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.

Input Types

Microsoft.Rtc.Management.WritableConfig.Settings.DeviceUpdate.DeviceUpdateConfiguration object. Remove-CsDeviceUpdateConfiguration accepts pipelined instances of the device update configuration object.

Return Types

None. Instead, the Remove-CsDeviceUpdateConfiguration cmdlet deletes instances of the Microsoft.Rtc.Management.WritableConfig.Settings.DeviceUpdate.DeviceUpdateConfiguration object.

Example

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

Remove-CsDeviceUpdateConfiguration -Identity global

In Example 1, Remove-CsDeviceUpdateConfiguration is used to "remove" the global device update configuration settings. Because the global settings cannot actually be removed, the command will not delete anything; however, all the properties in the global device update configuration settings will be reset to their default values.

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

Remove-CsDeviceUpdateConfiguration -Identity site:Redmond

The preceding commands removes the device update configuration settings with the Identity site:Redmond. Because these settings were configured at the site scope, they will be deleted, and the Redmond site will no longer have its own set of device update configuration settings.

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

Get-CsDeviceUpdateConfiguration -Filter "site:*" | Remove-CsDeviceUpdateConfiguration

In Example 3, all the device update configuration settings that have been configured at the site scope are removed. To do this, the Get-CsDeviceUpdateConfiguration cmdlet and the Filter parameter are used to return all the settings that have an Identity that begins with the string value "site:"; by definition, these will all be settings that were configured at the site scope. That collection is then piped to the Remove-CsDeviceUpdateConfiguration cmdlet, which removes each of the items in the collection.

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

Get-CsDeviceUpdateConfiguration | Where-Object {$_.MaxLogFileSize -lt 1024000} | Remove-CsDeviceUpdateConfiguration

In Example 4, all the device update configuration settings that have a MaxLogFileSize property greater than 1024000 bytes are deleted. To accomplish this task, Get-CsDeviceUpdateConfiguration is first called in order to return a collection of all the device update configuration settings. This collection is piped to the Where-Object cmdlet, which selects only those configuration settings where the MaxLogFileSize property is greater than 1024000 bytes. That filtered collection is then piped to Remove-CsDeviceUpdateConfiguration, which deletes each item in the collection.