• Article

Get-CsDeviceUpdateConfiguration

 

Topic Last Modified: 2012-03-23

Returns information about the device update configuration settings currently deployed in your organization. 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

Get-CsDeviceUpdateConfiguration [-Identity <XdsIdentity>] [-LocalStore <SwitchParameter>]

Get-CsDeviceUpdateConfiguration [-Filter <String>] [-LocalStore <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.

The Device Update Web service is managed by using device configuration settings; these settings can be applied at the global scope or at the site scope. You can use the Get-CsDeviceUpdateConfiguration cmdlet to return information about the device update configuration settings currently in use in your organization.

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

Parameters

Parameter Required Type Description

Identity

Optional

Xds Identity

Indicates the Identity of the device update configuration settings to be retrieved. 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. If you need to use wildcards, use the Filter parameter instead.

Filter

Optional

Xds Identity Filter

Provides a way for you to use wildcard characters when specifying device update configuration settings. For example, to return a collection of all the configuration settings that have been applied at the site scope, use this syntax: -Filter "site:*". To return all the settings that have the term "EMEA" in their Identity, use this syntax: -Filter "*EMEA*". Note that the Filter parameter acts only on the Identity of the settings; you cannot filter on other device update configuration properties.

LocalStore

Optional

Switch Parameter

Retrieves the device update configuration data from the local replica of the Central Management store rather than from the Central Management store itself.

Input Types

None. Get-CsDeviceUpdateConfiguration does not accept pipelined input.

Return Types

Get-CsDeviceUpdateConfiguration returns instances of the Microsoft.Rtc.Management.WritableConfig.Settings.DeviceUpdate.DeviceUpdateConfiguration object.

Example

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

Get-CsDeviceUpdateConfiguration

The command shown in Example 1 returns a collection of all the device update configuration settings currently in use in the organization. Calling Get-CsDeviceUpdateConfiguration without any additional parameters returns all the device update settings currently in use.

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

Get-CsDeviceUpdateConfiguration -Identity Global

In Example 2, information is returned for the global device update configuration settings.

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

Get-CsDeviceUpdateConfiguration -Filter site:*

Example 3 demonstrates the use of the Filter parameter. The filter value "site:*" returns a collection of all the device update configuration settings applied at the site scope; that’s because these settings all have an Identity that begins with the string value "site:".

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

Get-CsDeviceUpdateConfiguration | Where-Object {$_.MaxLogFileSize -gt 2048000}

The preceding command returns all the device update configuration settings where the MaxLogFileSize property is greater than 2048000 bytes. To do this, Get-CsDeviceUpdateConfiguration is used to return a collection of all the device update configuration settings currently in use. That collection is then piped to the Where-Object, which picks out only those settings where the MaxLogFileSize property is greater than 2048000.

-------------------------- Example 5 ------------------------

Get-CsDeviceUpdateConfiguration | Where-Object {$_.ValidLogFileTypes -like "*Watson*"}

The command shown in Example 5 returns all the device update configuration settings that include "Watson" as a valid log file type. To accomplish this task, Get-CsDeviceUpdateConfiguration is used to return a collection of all the device update configuration settings. That collection is then piped to the Where-Object, which picks out only the device settings that include "Watson" in their set of valid log file types.