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

Creates a new instance of device update configuration settings. These settings are used to manage the device update service, a Microsoft Communications Server 2010 component that enables administrators to distribute firmware updates to telephones and other devices running Microsoft Communicator “14” Phone Edition.


New-CsDeviceUpdateConfiguration -Identity <XdsIdentity> [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-InMemory <SwitchParameter>] [-LogCleanUpInterval <TimeSpan>] [-LogCleanUpTimeOfDay <Nullable>] [-LogFlushInterval <TimeSpan>] [-MaxLogCacheLimit <UInt32>] [-MaxLogFileSize <UInt32>] [-ValidLogFileExtensions <PSListModifier>] [-ValidLogFileTypes <PSListModifier>] [-WhatIf [<SwitchParameter>]]


Parameter Required Type Description



Xds Identity

Indicates the Identity of the new device update configuration settings. Because new settings can only be created at the site scope the Identity will look something to this: -Identity site:Redmond.




Specifies the amount of time a device update log file is kept before it is deleted by the system.

The value must be entered in the format dd.hh:mm:ss where d is days, h is hours, m is minutes, and s is seconds. To enter only days, you must follow the value with a period (.).

Minimum Value: 1.00:00:00 (1 Day)

Maximum Value: 365.00:00:00 (1 Year)

Default: 10.00:00:00 (10 Days)




Indicates the time of day when the system checks to see if there are any expired log files that should be deleted. ("Expired" log files are any files older than the value specified in by the LogCleanupInterval property.)

The value passed to the -LogCleanupTimeOfDay parameter should be in the 24-hour time format hh:mm, where hh represents the hours and mm represents the minutes. In this format, midnight is represented as 00:00; 8:30 AM is represented as 08:30; and 11:52 PM is represented as 23:52.




Indicates how often information stored in the log file cache is written to the actual log file. By default, device update information is not immediately written to the log file; instead, that information is cached until memory until: 1) the log flush time interval has expired; or, 2) the cache has reached its maximum size. If this value is set to 10 minutes (00:10:00) then information in the cache will be written to the log file every 10 minutes. After the data has been logged the cache will be cleared.

The value must be entered in the format hh:mm:ss where h is hours, m is minutes, and s is seconds.

Minimum Value: 00:01:00 (1 minute)

Maximum Value: 1:00:00 (1 hour)

Default: 00:05:00




Indicates the maximum amount of information (in bytes) that can held in the log file cache before that cache must be cleared and the data written to a log file. By default, log files are "flushed" every X number of minutes. (See the description of the parameter -LogFlushInterval for more information.) However, if the cache reaches its maximum size the information in it will automatically be written to a log file (and the cache cleared) even if the log flush interval has not yet expired.

Default: 512000




Indicates the maximum size, in bytes, for an individual log file. When a file reaches the maximum size the next batch of data is automatically written to a new log file. The old log file will be retained until the log cleanup interval has expired.

Default: 1024000



Switch Parameter

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




Indicates the valid log file extensions that can be used with the device update service. This list can be modified; however, there is no reason to modify the list unless you have a Microsoft Communicator Phone Edition device that creates log files that use a different file extension.

Default: .dmp, .clg, .clg2, .bak, .kdmp, .dat, .bin, .cat, .xml, .txt, .hex




Indicates the log file types retained by the device update system. The default file types include the following:

Watson. Log files automatically generated by a device in the event of a system crash.

Config. RoundTable device profiles that are created any time you configure a RoundTable conferencing station.

DiagLog. Self-diagnostic data for RoundTable conferencing stations.

CELog. Communicator Phone logs that contain the results of functional tests as well as a record of critical system events.

Additional file types can be added if you have a Microsoft Communicator Phone Edition device that creates a different kind of log file. You can also remove file. For example, if you do not want to store CELog files then you can remove the CELog file type.



Switch Parameter

Creates an object reference without actually committing the object as a permanent change. If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet’s matching Set- cmdlet.



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

The device update service provides a way for administrators to distribute firmware updates to devices (such as Tanjay phones and Roundtable conference stations) 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. The device update system itself is managed by using the CsDeviceUpdateConfiguration cmdlets.

Device update configuration settings can be assigned to the global level or to the site scope. To create a new collection of settings for a site, use the New-CsDeviceUpdateConfiguration cmdlet. Note that you can only create new settings at the site scope; your command will fail if you try to create a new collection of settings at the global scope. In addition, your command will fail if you try to create a new collection of settings for, say, the Redmond site, and that site already hosts a collection of device update configuration settings. That’s because you can only have one collection of device update configuration settings per site.

Return Types

The New-CsDeviceUpdate Configuration cmdlet creates instances of the Microsoft.Rtc.Management.WriteableConfig.Settings.DeviceUpdate.DeviceUpdateConfiguration object.


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

Copy Code
New-CsDeviceUpdateConfiguration -Identity site:Redmond

The command shown in Example 1 creates a new set of device update configuration settings with the Identity site:Redmond. Because no other parameters are included in the command this new collection of configuration settings will use the default values for each property.

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

Copy Code
New-CsDeviceUpdateConfiguration -Identity site:Redmond -MaxLogFileSize 204800 -LogCleanUpInterval 7.00:00:00

The preceding command also creates a new set of device update configuration settings with the Identity site:Redmond. In this case, two additional parameters are used in order to customize a pair of property values: -MaxLogFileSize is used to set the maximum log file size to 2048000 bytes, while -LogCleanUpInterval is included in order to set the log cleanup interval time to 7 days (7 days : 00 hours : 00 minutes : 00 seconds).