Removes a device update rule configured for use in your organization. Device update rules are used to associate firmware updates with devices (such as Tanjay telephones and the Roundtable conferencing station) that run Microsoft Communicator “14” Phone Edition.
Syntax
Remove-CsDeviceUpdateRule -Identity <XdsIdentity> [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-WhatIf [<SwitchParameter>]] |
Parameters
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 GUID (globally unique identifier) 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. See item 3 in the Examples section of this help topic for a way to work around this limitation. |
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
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 Microsoft Communications Server; 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 Microsoft Communications 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 Microsoft.com. 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 does not use LG-Nortel phones then you do not need the firmware updates for those devices.) Although these unneeded rules do not create any problems, they can complicate administration: it can be confusing run the Get-CsDeviceUpdateRule cmdlet to return a collection of all your device update rules, only to discover that the majority 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.
Return Types
Remove-CsDeviceUpdateRule does not return a value or object. Instead, the cmdlet deletes instances of the Microsoft.Rtc.Management.WriteableConfig.Settings.DeviceUpdate.Rule object.
Examples
-------------------------- Example 1 ------------------------
Copy Code | |
---|---|
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 ------------------------
Copy Code | |
---|---|
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 ------------------------
Copy Code | |
---|---|
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 piped to Remove-CsDeviceUpdateRule, which deletes each update rule in that collection.
-------------------------- Example 4 ------------------------
Copy Code | |
---|---|
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 (-eq) 'LG-Nortel". To carry out this task, 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". This filtered collection is then piped to Remove-CsDeviceUpdateRule, which removes each rule in the collection. Note that this command removes all rules with a Brand equal to "LG-Nortel", regardless of the service where those rules have been applied.