MSFT_SIPDeviceUpdaterConfigSetting (New)
This content is no longer actively maintained. It is provided as is, for anyone who may still be using these technologies, with no warranties or claims of accuracy with regard to the most recent product version or service release.
Defines the logging settings used by the Device Update Service. Device Update Service stores device logs and update logs, which you can use to track updates and devices, and troubleshoot any problems.
MSFT_SIPDeviceUpdaterConfigSetting
The property values for the MSFT_SIPDeviceUpdaterConfigSetting class map to the Log Settings dialog box in the Device Update Service management console. You can access these values in the Office Communications Server 2007 R2 Administration Tool by right-clicking an Enterprise pool or a Standard Edition server name, clicking Device Updater. Then, in the Device Update Service management console, clicking the Tools menu, and then clicking Log Settings.
The mapping between the dialog box and the WMI properties is shown in the illustration below:
.jpg "Dd185811.MSFT_SIPDeviceUpdaterConfigSetting_LogSettingsDlg(en-us,office.13).jpg")
The following syntax is simplified from Managed Object Format (MOF) code and includes all inherited properties. Properties are listed in alphabetic order, not MOF order.
Syntax
class MSFT_SIPDeviceUpdaterConfigSetting
{
[key] string Backend;
[key] string InstanceID;
uint32 LogCleanUpDays;
string LogCleanUpTime;
uint32 LogFlushFrequency;
uint32 MaxLogCacheLimit;
uint32 Maxlogfilesize;
string[] ValidLogFileExtensions;
string[] ValidLogFileTypes;
};
Methods
This class does not define any methods.
Properties
The MSFT_SIPDeviceUpdaterConfigSetting class has the following properties.
Backend
Data type: [key] stringAccess type: Read-only
Required: When accessing data from any role that belongs to a pool. The Backend value does not appear in the Administration Tool.
This property must be empty when accessing data from the Edge Server or Proxy Server role.
This property identifies the instance of SQL Server that manages the back-end database for Office Communications Server.
The value for this property depends on the topology of Office Communications Server.
Topology
Value
Standard Edition
(local)\rtc
Enterprise Edition
(consolidated or expanded configuration)
computername\instancename
or
computername
For Enterprise Edition, computername identifies either the FQDN or the NetBIOS name of the host computer for SQL Server and instancename identifies a named instance of SQL Server on the host computer. The value computername by itself specifies the default instance of SQL Server on the host computer.
InstanceID
Data type: [key] stringAccess type: Read-only
Required. A GUID value that uniquely identifies an instance of this class. The InstanceID value does not appear in the Administration Tool.
The GUID must be encapsulated between the "{" and "}" braces; for example: "{01234567-0123-4567-89AB-CDEF01234567}".
LogCleanUpDays
Data type: uint32Access type: Read/Write
Required. Specifies how log files are retained on the server in days. The Device Update Service deletes log files that are older than the specified number of days. Maps to the Keep log files for/days box in the Device Update Service management console.
The minimum value for this property is 1 and the maximum value is 365.
LogCleanUpTime
Data type: stringAccess type: Read/Write
Optional. The time each day that the Device Update Service automatically checks for and discards log files older than the number of days specified by LogCleanUpDays. Maps to the Time of day/HH:MM box in the Device Update Service management console.
The value for this property is in 24-hour time in the form HH:MM, where HH (00 to 23) is the number of hours that have passed since midnight, and MM (00 to 59) is the number of full minutes that have passed since the last full hour.
The maximum length of the string is 5 characters. The value can be from 00:00 (for 12:00 Midnight) to 23:59 (for 11:59 PM). Setting this value to NULL turns off automatic cleanup of log files.
LogFlushFrequency
Data type: uint32Access type: Read/Write
Required. How often in minutes that the cache is flushed if it is smaller than the size specified by MaxLogCacheLimit. The LogFlushFrequency value does not appear in the Administration Tool.
The minimum value for this property is 1 and the maximum value is 60.
MaxLogCacheLimit
Data type: uint32Access type: Read/Write
Required. The maximum size in bytes to which the cache is allowed to grow before it is flushed regardless of how long since it was last flushed. The MaxLogCacheLimit value does not appear in the Administration Tool.
Maxlogfilesize
Data type: uint32Access type: Read/Write
Required. The maximum size in bytes for a log file. The Device Update Service starts writing log entries to a new log file when the current log file attains this size. The Maxlogfilesize value does not appear in the Administration Tool.
ValidLogFileExtensions
Data type: string[]Access type: Read/Write
Optional. An array of valid log file extensions. The ValidLogFileExtensions value does not appear in the Administration Tool.
The value of this property is not case-sensitive.
ValidLogFileTypes
Data type: string[]Access type: Read/Write
Optional. An array of valid log file types. The ValidLogFileTypes value does not appear in the Administration Tool.
The value of this property is not case-sensitive.
Remarks
This class gets and sets information at the following levels: SQL.
Only one instance of this class can be present in the forest.
Instances of this class support the following interface methods:
Provider::GetObject();
Provider::PutInstance();
Where PutInstance() supports the following flag:
- WBEM_FLAG_UPDATE_ONLY
Requirements
Server: Installed on computers serving the following roles: Administrative Tools Server and Front End Server.
Namespace: Defined in \root\cimv2.
See Also
Concepts
Office Communications Server WMI Reference