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

Enables you to "roll back" a device update rule that has been approved for use in the organization. When you restore a device update rule, the approved version of that rule is reset to reflect the update that was in use before the rule was approved. In turn, client devices that log on to the system will automatically uninstall the most recent update, then download and reinstall the prior version of that update.


Restore-CsDeviceUpdateRule [-Identity <XdsIdentity>] [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-WhatIf [<SwitchParameter>]]
Restore-CsDeviceUpdateRule [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-Instance <PSObject>] [-WhatIf [<SwitchParameter>]]


Parameter Required Type Description




Unique identifier for the device update rule being restored. The Identity for a device update rule consists of two parts: the service where the device update rule has been assigned (for example, service:WebServer:atl-cs-001.litwareinc.com) and a GUID (globally unique identifier). Consequently, a device update rule configured for the Redmond site will have an Identity similar to this: service:WebServer:atl-cs-001.litwareinc.com/d5ce3c10-2588-420a-82ac-dc2d9b1222ff9.



DeviceUpdate.Rule object

Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values.



Switch Parameter

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



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

Microsoft Communications Server 2010 uses "device update rules" as a way to provide firmware updates to devices (such as Tanjay telephones and the RoundTable conferencing station) that run Communicator “14” Phone Edition. Periodically, administrators upload a set of device update rules to Communications Server 2010; after those rules have been tested and approved, they are then automatically downloaded and applied to the appropriate devices the next time those devices connect to the system. By default devices check for new update rules each time they turn on and connect to Communications Server 2010; devices also check for updates every 24 hours after that initial sign-on.

Each new device update rule added to the system is marked as "Pending." That means that the update will be downloaded and installed by the appropriate test devices; however, it will not be downloaded and installed by client devices in general. This gives you an opportunity to test the updates and ensure that there are no adverse effects before they make the update widely available. As soon as you are convinced that the update is "safe," you can then use the Approve-CsDeviceUpdateRule to approve the update.

When you approve an update, the PendingVersion of the associated update rule is assigned to the ApprovedVersion, and the PendingVersion property is cleared. For example, suppose the PendingVersion of a new update rule is version After you run Approve-CsDeviceUpdateRule, the PendingVersion will be set to a null value, and the ApprovedVersion will be set to The next time a client device logs on, the device will automatically check to see if there are any newly-approved updates applicable for that device. If so, the update will automatically be downloaded and installed.

In addition to this, any previous version of the update (for example, version will be marked as the RestoreVersion. This version of the update will remain on the system and will be used if the new update needs to be rolled back. If problems begin to crop up, administrators can use the Restore-CsDeviceUpdateRule cmdlet to roll back the update. When that happens, client devices, at their next logon, will automatically uninstall the new update (version and reinstall the previous update (

Of course, this happens only if there is a previous update to be installed. If there is not, the update being rolled back when simply be uninstalled.

Return Types

Restore-CsDeviceUpdateRule restores instances of the Microsoft.Rtc.Management.WriteableConfig.Settings.DeviceUpdate.DeviceUpdate.Rule object.


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

Copy Code
Restore-CsDeviceUpdateRule -Identity service:WebServer:atl-cs-001.litwareinc.com/d5ce3c10-2588-420a-82ac-dc2d9b1222ff9

The command shown in Example 1 restores the device update rule d5ce3c10-2588-420a-82ac-dc2d9b1222ff9 found on the service WebServer:atl-cs-001.litwareinc.com.

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

Copy Code
Get-CsDeviceUpdateRule -Filter service:WebServer:atl-cs-001.litwareinc.com* | Restore-CsDeviceUpdateRule

The preceding command restores all the device update rules that have been configured for the service WebServer:atl-cs-001.litwareinc.com. To do this, the command first calls Get-CsDeviceUpdateRule along with the –Filter parameter; the filter value "WebServer:atl-cs-001.litwareinc.com*" ensures that only those rules that have an Identity that begins with the string value "WebServer:atl-cs-001.litwareinc.com" will be returned. (By definition, these are all the device update rules that have been assigned to the service WebServer:atl-cs-001.litwareinc.com.) This filtered collection is then piped to the Restore-CsDeviceUpdateRule cmdlet, which proceeds to restore each rule in the collection.

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

Copy Code
Get-CsDeviceUpdateRule | Where-Object {$_.Brand -eq "LG-Nortel"} | Restore-CsDeviceUpdateRule

Example 3 shows how you can restore all the device update rules for a specified brand (LG-Nortel). To carry out this task, the command first calls Get-CsDeviceUpdateRule (without any parameters) in order to return a collection of all the device update rules currently in use in the organization. This collection is then piped to the Where-Object cmdlet, which picks out only those rules where the Brand property is equal to (-eq) LG-Nortel. This filtered collection is then piped to Restore-CsDeviceUpdateRule, which proceeds to restore all the rules in the filtered collection.