1 tony 1.1 // ===================================================================
2 // Title: Database MOF Specification 2.8
3 // Filename: Database28_System.mof
4 // Version: 2.8
5 // Release: Final
6 // Date: Jan 26, 2004
7 // ===================================================================
8 // Copyright 1998-2004 Distributed Management Task Force, Inc. (DMTF).
9 // All rights reserved.
10 // DMTF is a not-for-profit association of industry members dedicated
11 // to promoting enterprise and systems management and interoperability.
12 // DMTF specifications and documents may be reproduced for uses
13 // consistent with this purpose by members and non-members,
14 // provided that correct attribution is given.
15 // As DMTF specifications may be revised from time to time,
16 // the particular version and release date should always be noted.
17 //
18 // Implementation of certain elements of this standard or proposed
19 // standard may be subject to third party patent rights, including
20 // provisional patent rights (herein "patent rights"). DMTF makes
21 // no representations to users of the standard as to the existence
22 tony 1.1 // of such rights, and is not responsible to recognize, disclose, or
23 // identify any or all such third party patent right, owners or
24 // claimants, nor for any incomplete or inaccurate identification or
25 // disclosure of such rights, owners or claimants. DMTF shall have no
26 // liability to any party, in any manner or circumstance, under any
27 // legal theory whatsoever, for failure to recognize, disclose, or
28 // identify any such third party patent rights, or for such party's
29 // reliance on the standard or incorporation thereof in its product,
30 // protocols or testing procedures. DMTF shall have no liability to
31 // any party implementing such standard, whether such implementation
32 // is foreseeable or not, nor to any patent owner or claimant, and shall
33 // have no liability or responsibility for costs or losses incurred if
34 // a standard is withdrawn or modified after publication, and shall be
35 // indemnified and held harmless by any party implementing the
36 // standard from any and all claims of infringement by a patent owner
37 // for such implementations.
38 //
39 // For information about patents held by third-parties which have
40 // notified the DMTF that, in their opinion, such patent may relate to
41 // or impact implementations of DMTF standards, visit
42 // http://www.dmtf.org/about/policies/disclosures.php.
43 tony 1.1 // ===================================================================
44 // Description:
45 // This file contains the classes and associations that are
46 // related to the database system, how it is deployed, and the
47 // runtime aspects of the database environment.
48 //
49 // ===================================================================
50 // Change Log for V2.8 Preliminary
51 // CR1087 - Update DatabaseAdministrator description to reference
52 // UserContact
53 //
54 // Change Log for V2.8 Final
55 // CR1150 - Deprecate LastStatusChangeTime
56 // CR1179 - Update CIM_DatabaseSystem Description
57 // ==================================================================
58
59 #pragma Locale ("en-US")
60
61 // ==================================================================
62 // DatabaseSystem
63 // ==================================================================
64 tony 1.1 [Version ( "2.7.0" ), Description (
65 "A database environment is composed of a database system (the "
66 "application system represented by this class), one or more "
67 "database services, and one or more databases. See the "
68 "descriptions of CIM_DatabaseService and CIM_CommonDatabase to "
69 "get more detailed information about database services and "
70 "databases. \n"
71 "Each separately manageable database system SHOULD have an "
72 "instance in this class. This class can be used: \n"
73 "- to determine the software that belongs to the database "
74 "system. \n"
75 "- to perform database system wide management operations, such "
76 "as stopping all the databases that were created by the "
77 "database system for maintenance purposes. \n"
78 "- to view runtime statistics in the context of a database "
79 "system. \n"
80 "Many of the management capabilities needed to represent a "
81 "database system as an application system have already been "
82 "modeled in the CIM_ApplicationSystem class from which "
83 "CIM_DatabaseSystem extends. CIM_DatabaseSystem provides a "
84 "logical entity to define the relationships that are specific "
85 tony 1.1 "to the database management domain.")]
86 class CIM_DatabaseSystem : CIM_ApplicationSystem {
87 };
88
89
90 // ==================================================================
91 // CommonDatabase
92 // ==================================================================
93 [Version ( "2.7.0" ), Description (
94 "A database is a collection of interrelated data, treated as a "
95 "unit, which is organized into one or more schemas. The "
96 "CIM_CommonDatabase class defines the properties that are "
97 "common across database model and vendor implementations for "
98 "the database entity that is represented by the unit of "
99 "interrelated data. \n"
100 "Databases are manipulated through one or more database "
101 "services. More detailed information on database services is "
102 "provided in the description of the CIM_DatabaseService class.")]
103 class CIM_CommonDatabase : CIM_EnabledLogicalElement {
104
105 [Key, Description (
106 tony 1.1 "Within the scope of the instantiating Namespace, InstanceID "
107 "opaquely and uniquely identifies an instance of this class. "
108 "In order to ensure uniqueness within the NameSpace, the "
109 "value of InstanceID SHOULD be constructed using the "
110 "following 'preferred' algorithm: \n"
111 "<OrgID>:<LocalID> \n"
112 "Where <OrgID> and <LocalID> are separated by a colon ':', "
113 "and where <OrgID> MUST include a copyrighted, trademarked "
114 "or otherwise unique name that is owned by the business "
115 "entity creating/defining the InstanceID, or is a registered "
116 "ID that is assigned to the business entity by a recognized "
117 "global authority. (This is similar to the <Schema "
118 "Name>_<Class Name> structure of Schema class names.) In "
119 "addition, to ensure uniqueness <OrgID> MUST NOT contain a "
120 "colon (':'). When using this algorithm, the first colon to "
121 "appear in InstanceID MUST appear between <OrgID> and "
122 "<LocalID>. \n"
123 "<LocalID> is chosen by the business entity and SHOULD not "
124 "be re-used to identify different underlying (real-world) "
125 "elements. If the above 'preferred' algorithm is not used, "
126 "the defining entity MUST assure that the resultant "
127 tony 1.1 "InstanceID is not re-used across any InstanceIDs produced "
128 "by this or other providers for this instance's NameSpace. \n"
129 "For DMTF defined instances, the 'preferred' algorithm MUST "
130 "be used with the <OrgID> set to 'CIM'.")]
131 string InstanceID;
132
133 [Description (
134 "The version number for the database. If the version is not "
135 "relevant, the value for this property must be set to NULL."),
136 MappingStrings { "MIB.IETF|RDBMS-MIB.rdbmsDbInfoVersion" }]
137 string DatabaseVersion;
138
139 [Description (
140 "The date and time when the latest complete or partial "
141 "backup of the database was performed. If the database has "
142 "never been backed up, then this property has no meaning. "
143 "The value of this property should be set to all zeros if "
144 "the database has never been backed up."),
145 MappingStrings { "MIB.IETF|RDBMS-MIB.rdbmsDbInfoLastBackup" }]
146 datetime LastBackup;
147
148 tony 1.1 [Description (
149 "The estimated amount of disk space (in units) that has been "
150 "reserved for database use."),
151 MappingStrings { "MIB.IETF|RDBMS-MIB.rdbmsDbInfoSizeAllocated" }]
152 uint32 SizeAllocated;
153
154 [Description (
155 "The units for the SizeAllocated property and the SizeUsed "
156 "property that is defined in the "
157 "CIM_CommonDatabaseStatistics class. Mapping is 1 - Bytes, 2 "
158 "- Kilobytes, 3 - Megabytes, 4 - Gigabytes and 5 - "
159 "Terabytes."),
160 ValueMap { "1", "2", "3", "4", "5" },
161 Values { "Bytes", "Kilobyes", "Megabytes", "Gigabytes",
162 "Terabytes" },
163 MappingStrings { "MIB.IETF|RDBMS-MIB.rdbmsDbInfoSizeUnits" }]
164 uint16 SizeUnits;
165 };
166
167
168 // ==================================================================
169 tony 1.1 // AssociatedDatabaseSystem
170 // ==================================================================
171 [Association, Version ( "2.7.0" ), Description (
172 "The CIM_AssociatedDatabaseSystem association identifies the "
173 "database system that is responsible for the database.")]
174 class CIM_AssociatedDatabaseSystem : CIM_Dependency {
175
176 [Override ( "Antecedent" ), Min ( 1 ), Description (
177 "The database system that is responsible for the database.")]
178 CIM_DatabaseSystem REF Antecedent;
179
180 [Override ( "Dependent" ), Description (
181 "The database.")]
182 CIM_CommonDatabase REF Dependent;
183 };
184
185
186 // ==================================================================
187 // DatabaseAdministrator
188 // ==================================================================
189 [Association, Version ( "2.7.0" ), Description (
190 tony 1.1 "The DatabaseAdministrator association identifies a UserEntity "
191 "as a database administrator of a CommonDatabase. \n"
192 "The current version of CIM includes a UserContact class that "
193 "is concrete and extends from UserEntity. UserContact contains "
194 "the information needed to contact a database administrator. "
195 "The DatabaseAdministrator association should be implemented "
196 "through the UserContact class in favor creating a vendor "
197 "specific concrete class to define database administrator "
198 "contact information.")]
199 class CIM_DatabaseAdministrator : CIM_Dependency {
200
201 [Override ( "Antecedent" ), Description (
202 "The database that is being administered.")]
203 CIM_CommonDatabase REF Antecedent;
204
205 [Override ( "Dependent" ), Description (
206 "The user entity who is responsible for the administration "
207 "of the database.")]
208 CIM_UserEntity REF Dependent;
209 };
210
211 tony 1.1
212 // ==================================================================
213 // DatabaseService
214 // ==================================================================
215 [Version ( "2.7.0" ), Description (
216 "Database services perform tasks for a database. Examples of "
217 "tasks that are performed by a database service include "
218 "providing user access to the database, performing data and "
219 "metadata manipulation, database administration, and "
220 "maintenance operations. \n"
221 "One or more database services can perform tasks for a "
222 "database. The database services can reside on the same "
223 "computer system as the database or on different computer "
224 "systems. Database services may be implemented as one or more "
225 "processes.")]
226 class CIM_DatabaseService : CIM_Service {
227
228 [Description (
229 "The date and time when the database service was last "
230 "started. If the database service has an OperationalStatus "
231 "of Stopped or Starting, then this value is not meaningful "
232 tony 1.1 "and the contents MUST be set to zeros."),
233 MappingStrings { "MIB.IETF|RDBMS-MIB.rdbmsSrvInfoStartupTime" }]
234 datetime StartupTime;
235
236 [Override ( "OperationalStatus" ), Description (
237 "This property contains the operational status of the "
238 "database service. OK means that the database service is "
239 "operational and available for general use. Stopped means "
240 "that the service is unavailable and cannot be used. Service "
241 "implies an administrative state of unavailability. Degraded "
242 "means that the database service is operating at a less than "
243 "optimal level. Starting means that the database service is "
244 "in the process of becoming operational. \n"
245 "These status values map to the RFC1697 OperStatus values as "
246 "follows: OK - UP, Stopped - DOWN, In Service - HALTED, "
247 "Stressed - CONGESTED, and Starting - RESTARTING. Any "
248 "additional status variables that are defined are CIM "
249 "specific."),
250 MappingStrings { "MIB.IETF|RDBMS-MIB.rdbmsSrvInfoOperStatus" }]
251 uint16 OperationalStatus[];
252
253 tony 1.1 [Deprecated { "CIM_EnabledLogicalElement.TimeOfLastStateChange" },
254 Description (
255 "The LastStatusChangeTime property is deprecated in lieu of "
256 "the TimeOfLastStateChange property that is inherited from "
257 "CIM_EnabledLogicalElement. The date and time when the "
258 "status of the database service last changed."),
259 MappingStrings { "MIB.IETF|RDBMS-MIB.rdbmsSrvInfoLastChange" }]
260 datetime LastStatusChangeTime;
261
262 [Override ( "TimeOfLastStateChange" ),
263 MappingStrings { "MIB.IETF|RDBMS-MIB.rdbmsSrvInfoLastChange" }]
264 datetime TimeOfLastStateChange;
265
266 [Description (
267 "The maximum number of active inbound connections that can "
268 "be concurrently opened on the service."),
269 MappingStrings {
270 "MIB.IETF|RDBMS-MIB.rdbmsSrvInfoMaxInboundAssociations" }]
271 uint32 ConnectionLimit;
272 };
273
274 tony 1.1
275 // ==================================================================
276 // ServiceAvailableToDatabase
277 // ==================================================================
278 [Association, Version ( "2.7.0" ), Description (
279 "The CIM_ServiceAvailableToDatabase association relates "
280 "databases to the database services that are available for "
281 "database use.")]
282 class CIM_ServiceAvailableToDatabase : CIM_ServiceAvailableToElement {
283
284 [Override ( "ServiceProvided" ), Description (
285 "The database service that is providing service.")]
286 CIM_DatabaseService REF ServiceProvided;
287
288 [Override ( "UserOfService" ), Description (
289 "The database that is being served.")]
290 CIM_CommonDatabase REF UserOfService;
291
292 [Description (
293 "The AvailableState property indicates the current state of "
294 "a database service regarding its ability to access a "
295 tony 1.1 "specific database. A service can be actively using a "
296 "database (ACTIVE), or it can be waiting for a task to "
297 "perform (AVAILABLE), or the service can be less than "
298 "completely available for use by the database (RESTRICTED), "
299 "or the database is not accessible from this service "
300 "(UNAVAILABLE). Any service states that do not match one of "
301 "these values should specify (OTHER)."),
302 ValueMap { "1", "2", "3", "4", "5" },
303 Values { "Other", "Active", "Available", "Restricted",
304 "Unavailable" },
305 MappingStrings { "MIB.IETF|RDBMS-MIB.rdbmsRelState" },
306 ModelCorrespondence {
307 "CIM_ServiceAvailableToDatabase.OtherAvailableState" }]
308 uint16 AvailableState;
309
310 [Description (
311 "A string describing the service's available state when the "
312 "AvailableState property is set to 1 (\"Other\"). This "
313 "property MUST be set to NULL when AvailableState is any "
314 "value other than 1."),
315 ModelCorrespondence {
316 tony 1.1 "CIM_ServiceAvailableToDatabase.AvailableState" }]
317 string OtherAvailableState;
318
319 [Description (
320 "The time that the database was made active by this service. "
321 "If the AvailableState property is not active, then the "
322 "value of this property MUST be set to zero."),
323 MappingStrings { "MIB.IETF|RDBMS-MIB.rdbmsRelActiveTime" }]
324 datetime ActiveTime;
325 };
326
327
328 // ==================================================================
329 // DatabaseParameter
330 // ==================================================================
331 [Abstract, Version ( "2.7.0" ), Description (
332 "The CIM_DatabaseParameter class extends from "
333 "CIM_ScopedSettingData. This is an abstract class that "
334 "specifies the database and service configuration parameters "
335 "that are common across database models and vendor "
336 "implementations. \n"
337 tony 1.1 "The SNMP RDBMS MIB defines database and service parameters as "
338 "name/value pair combinations rather than as specific named "
339 "properties of the class. In order to maintain a consistent "
340 "mapping between SNMP and CIM a CIM_SNMPDatabaseParameter class "
341 "extends from the abstract CIM_DatabaseParameter class which "
342 "defines parameters as a name value pair. \n"
343 "In a future release of the database MOF, the working group may "
344 "choose to create a new class that extends from "
345 "CIM_DatabaseParameter that specifies properties for common "
346 "configuration parameters. \n"
347 "The parameter context for a specific database or database "
348 "service is established by collecting the SettingData using the "
349 "CIM_ElementProfile association. \n"
350 "The SNMP RDBMS MIB defines generic tables that contain rows of "
351 "named database or service configuration entries. A parameter "
352 "entry contains a parameter name, description, and value. See "
353 "the description of the rdbmsDbParamTable or the "
354 "rdbmsSrvParamTable for more information on the SNMP "
355 "definitions.")]
356 class CIM_DatabaseParameter : CIM_ScopedSettingData {
357 };
358 tony 1.1
359
360 // ==================================================================
361 // SNMPDatabaseParameter
362 // ==================================================================
363 [Version ( "2.7.0" ), Description (
364 "The CIM_SNMPDatabaseParameter class extends from "
365 "CIM_DatabaseParameter. This class is included in the CIM "
366 "database schema to provide explicit mapping to the way that "
367 "the SNMP MIB defines database and service parameters. More "
368 "information on the SNMP MIB parameters can be found in RFC "
369 "1697. \n"
370 "The SNMP RDBMS MIB defines generic tables that contain rows of "
371 "named database or service configuration entries. A parameter "
372 "entry contains a parameter name, description, and value. See "
373 "the description of the rdbmsDbParamTable or the "
374 "rdbmsSrvParamTable for more information on the SNMP "
375 "definitions.")]
376 class CIM_SNMPDatabaseParameter : CIM_DatabaseParameter {
377
378 [Description (
379 tony 1.1 "The value of a database or service parameter represented as "
380 "a string."),
381 MappingStrings { "MIB.IETF|RDBMS-MIB.rdbmsDbParamCurrValue" }]
382 string ParameterValue;
383 };
384
385 // ===================================================================
386 // end of file
387 // ===================================================================
|
Return to
Database28_System.mof
CVS log
Up to [Pegasus] / pegasus / Schemas / CIM28