Export (0) Print
Expand All
Expand Minimize

Remove-CsDeviceUpdateRule

 

Topic Last Modified: 2012-03-25

Removes a device update rule configured for use in your organization. Device update rules are used to associate firmware updates with devices that run Microsoft Lync 2010 Phone Edition.

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

Microsoft Lync Server 2010 uses device update rules as a way to provide 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 are then automatically downloaded and applied to the appropriate devices as those devices connect to the system. By default devices check for new update rules each time they turn on and connect to Lync Server. Devices also check for updates every 24 hours after that initial sign on.

Administrators cannot create their own device update rules; update rules can be created only by downloading and importing rule sets from the Microsoft website. This means that, over time, you are likely to collect rules that are outdated or are of no use in your organization. (For example, if your organization no longer uses LG-Nortel phones, then you no longer need the firmware updates for those devices.) Although these unneeded rules do not create any problems, they can complicate administration: it can be confusing to run the Get-CsDeviceUpdateRule cmdlet to return a collection of all your device update rules, only to discover that many of those rules are not applicable in your organization. To help lessen this confusion, Remove-CsDeviceUpdateRule can be used to remove any device update rule (or set of rules) that has been imported for use.

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

 

Parameter Required Type Description

Identity

Required

Xds Identity

Unique identifier for the device update rule. The Identity of a device update rule is composed of two parts: The service scope where the rule has been applied (for example, service:WebServer:atl-cs-001.litwareinc.com) and the globally unique identifier (GUID) that was pre-assigned to the rule (for example, d5ce3c10-2588-420a-82ac-dc2d9b1222ff9). Based on this, the Identity for a given device update rule will look something like this: "service:WebServer:atl-cs-001.litwareinc.com/d5ce3c10-2588-420a-82ac-dc2d9b1222ff9".

Wildcards are not allowed 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.

Microsoft.Rtc.Management.WritableConfig.Settings.DeviceUpdate.DeviceUpdate.Rule object. Remove-CsDeviceUpdateRule accepts pipelined instances of the device update rule object.

Remove-CsDeviceUpdateRule does not return a value or object. Instead, the cmdlet deletes instances of the Microsoft.Rtc.Management.WritableConfig.Settings.DeviceUpdate.Rule object.

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

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

The preceding command deletes the device update rule with the Identity service:WebServer:atl-cs-001.litwareinc.com/d5ce3c10-2588-420a-82ac-dc2d9b1222ff9. After the rule has been deleted, the corresponding firmware update will no longer be available for use.

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

Get-CsDeviceUpdateRule | Remove-CsDeviceUpdateRule

The command shown in Example 2 removes all the device update rules that have been configured for use in your organization. This is done by calling Get-CsDeviceUpdateRule (without any parameters) in order to return a collection of all the device update rules currently in use. That collection is then piped to Remove-CsDeviceUpdateRule, which, in turn, deletes each rule in the collection.

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

Get-CsDeviceUpdateRule -Filter service:WebServer:atl-cs-001.litwareinc.com* | Remove-CsDeviceUpdateRule

In Example 3, all the device update rules that have been imported to the service WebServer:atl-cs-001.litwareinc.com are removed. To do this, the command first uses Get-CsDeviceUpdateRule and the Filter parameter to retrieve all the device update rules that have an Identity that begins with the string value "service:WebServer:atl-cs-001.litwareinc.com". This collection is then piped to Remove-CsDeviceUpdateRule, which deletes each rule in that collection.

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

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

The preceding command deletes all the device update rules that have a Brand equal to "LG-Nortel". To do this, the cmdlet calls Get-CsDeviceUpdateRule without any parameters in order to retrieve a collection of all the device update rules in use in the organization. This collection is then piped to the Where-Object cmdlet, which selects only those rules where the Brand is equal to "LG-Nortel". The filtered collection is then piped to Remove-CsDeviceUpdateRule, which removes each rule in the collection.

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