Returns information about the device update rules 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
Get-CsDeviceUpdateRule [-Identity <XdsIdentity>] [-LocalStore <SwitchParameter>] |
Get-CsDeviceUpdateRule [-Filter <String>] [-LocalStore <SwitchParameter>] |
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
Identity |
Optional |
XdsIdentity |
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 preassigned 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. Note that wildcards are not allowed when specifying an Identity. Use the -Filter parameter if you want to use wildcards when specifying a rule. |
|
Filter |
Optional |
String |
Enables you to use wildcards when specifying the Identity of a device update rule or set of rules. For example, to return all the device update rules for WebServer:atl-cs-001.litwareinc.com use this filter value: "service:WebServer:atl-cs-001.litwareinc.com*". |
|
LocalStore |
Optional |
Switch Parameter |
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 as those devices connect to the system. By default devices check for new update rules each time they turn on and connect to Communications Server; devices also check for updates every 24 hours after that initial sign-on.
The Get-CsDeviceUpdateRule cmdlet enables you to return information about the device update rules that have been imported for use in your organization.
Return Types
Get-CsDeviceUpdateRule returns instances of the Microsoft.Rtc.Management.WriteableConfig.Settings.DeviceUpdate.DeviceUpdate.Rule object.
Examples
-------------------------- Example 1 ------------------------
 Copy Code |
|
|---|---|
Get-CsDeviceUpdateRule |
|
The preceding command returns information about all the device update rules that have been applied in your organization. Calling Get-CsDeviceUpdateRule without any additional parameters always returns the complete collection of device update rules.
-------------------------- Example 2 ------------------------
| Copy Code |
|
|---|---|
Get-CsDeviceUpdateRule -Identity service:WebServer:atl-cs-001.litwareinc.com/ d5ce3c10-2588-420a-82ac-dc2d9b1222ff9 |
|
The command shown in Example 2 returns information about the device update rule with the Identity "WebServer:atl-cs-001.litwareinc.com/d5ce3c10-2588-420a-82ac-dc2d9b1222ff9".
-------------------------- Example 3 ------------------------
| Copy Code |
|
|---|---|
Get-CsDeviceUpdateRule -Filter service:WebServer:atl-cs-001.litwareinc.com* |
|
Example 3 returns information about all the device update rules configured for the service WebServer:atl-cs-001.litwareinc.com. To accomplish this task, the -Filter parameter is used along with the filter value "WebServer:atl-cs-001.litwareinc.com *". That filter limits the returned data to device update rules that have an Identity that begins with the string value "service:WebServer:atl-cs-001.litwareinc.com.
-------------------------- Example 4 ------------------------
| Copy Code |
|
|---|---|
Get-CsDeviceUpdateRule | Where-Object {$_.Brand -eq "LG-Nortel"}
|
|
The preceding command returns all the device update rules where the Brand property is equal to (-eq) "LG-Nortel". To do this, Get-CsDeviceUpdateRule is called in order to return a collection of all the device update rules in the organization. That collection is piped to the Where-Object cmdlet, which selects only those rules where the Brand is equal to "LG-Nortel".
-------------------------- Example 5 ------------------------
| Copy Code |
|
|---|---|
Get-CsDeviceUpdateRule | Where-Object {$_.Approved -eq $Null}
|
|
Example 5 returns a collection of all the device update rules that have not been approved. This is done by using Get-CsDeviceUpdateRules to return a collection of all the rules, then piping that collection to Where-Object. In turn, Where-Object selects only those rules where the Approved property is equal to (-eq) a null value ($Null). If the Approved property is null that means that these rules are not Approved.
-------------------------- Example 5 ------------------------
| Copy Code |
|
|---|---|
Get-CsDeviceUpdateRule | Where-Object {$_.Approved -ne $Null -and $_.Brand -eq "LG-Nortel"}
|
|
The command shown above returns a collection of all the device update rules that meet two criteria: the rule has been approved and the rule relates to LG-Nortel devices. To accomplish this task, Get-CsDeviceUpdateRule is called to return a collection of all the device update rules in the organization. That collection is then piped to Where-Object, which filters the collection on two criteria: the Approved property must not be null (that is, this property must have a value of some kind); and the Brand must be equal to "LG-Nortel".