1 tony 1.1 // ===================================================================
2 // Title: Database MOF Specification 2.8
3 // Filename: Database28_System.mof
4 // Version: 2.8
5 // Release: Preliminary
6 // Date: 05/21/03
7 // ===================================================================
8 // Copyright 1998-2003 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
51 // CR1087 - Update DatabaseAdministrator description to reference
52 // UserContact
53 // ==================================================================
54
55 #pragma Locale ("en-US")
56
57 // ==================================================================
58 // DatabaseSystem
59 // ==================================================================
60 [Version ("2.7.0"), Description (
61 "The CIM_DatabaseSystem class is used to represent the "
62 "application software portion of a database environment.\n"
63 "A database environment is composed of a database system (the "
64 tony 1.1 "application software represented by this class), one or more "
65 "database services, and one or more databases. See the "
66 "descriptions of CIM_DatabaseService and CIM_CommonDatabase to "
67 "get more detailed information about database services and databases.\n"
68 "Many of the management capabilities needed to represent the "
69 "software aspects of a database system have already been "
70 "modeled in the CIM_ApplicationSystem class from which "
71 "CIM_DatabaseSystem extends. This class provides a logical "
72 "entity to define the relationships that are specific to the "
73 "database management domain.") ]
74 class CIM_DatabaseSystem : CIM_ApplicationSystem {
75 };
76
77
78 // ==================================================================
79 // CommonDatabase
80 // ==================================================================
81 [Version ("2.7.0"), Description (
82 "A database is a collection of interrelated data, treated as a "
83 "unit, which is organized into one or more schemas. The "
84 "CIM_CommonDatabase class defines the properties that are "
85 tony 1.1 "common across database model and vendor implementations for "
86 "the database entity that is represented by the unit of "
87 "interrelated data.\n"
88 "Databases are manipulated through one or more database "
89 "services. More detailed information on database services is "
90 "provided in the description of the CIM_DatabaseService class.") ]
91 class CIM_CommonDatabase : CIM_EnabledLogicalElement {
92
93 [Key, Description (
94 "Within the scope of the instantiating Namespace, InstanceID "
95 "opaquely and uniquely identifies an instance of this "
96 "class. In order to ensure uniqueness within the NameSpace, "
97 "the value of InstanceID SHOULD be constructed using the "
98 "following 'preferred' algorithm:\n"
99 " <OrgID>:<LocalID>\n"
100 "Where <OrgID> and <LocalID> are separated by a colon ':', "
101 "and where <OrgID> MUST include a copyrighted, trademarked "
102 "or otherwise unique name that is owned by the business "
103 "entity creating/defining the InstanceID, or is a registered "
104 "ID that is assigned to the business entity by a recognized "
105 "global authority. (This is similar to the <Schema "
106 tony 1.1 "Name>_<Class Name> structure of Schema class names.) In "
107 "addition, to ensure uniqueness <OrgID> MUST NOT contain a "
108 "colon (':'). When using this algorithm, the first colon to "
109 "appear in InstanceID MUST appear between <OrgID> and <LocalID>.\n"
110 "<LocalID> is chosen by the business entity and SHOULD not "
111 "be re-used to identify different underlying (real-world) "
112 "elements. If the above 'preferred' algorithm is not used, "
113 "the defining entity MUST assure that the resultant "
114 "InstanceID is not re-used across any InstanceIDs produced "
115 "by this or other providers for this instance's NameSpace.\n"
116 "For DMTF defined instances, the 'preferred' algorithm MUST "
117 "be used with the <OrgID> set to 'CIM'.") ]
118 string InstanceID;
119
120 [Description (
121 "The version number for the database. If the version is not "
122 "relevant, the value for this property must be set to NULL."),
123 MappingStrings {"MIB.IETF|RDBMS-MIB.rdbmsDbInfoVersion"} ]
124 string DatabaseVersion;
125
126 [Description (
127 tony 1.1 "The date and time when the latest complete or partial "
128 "backup of the database was performed. If the database has "
129 "never been backed up, then this property has no meaning. "
130 "The value of this property should be set to all zeros if "
131 "the database has never been backed up."),
132 MappingStrings {"MIB.IETF|RDBMS-MIB.rdbmsDbInfoLastBackup"} ]
133 datetime LastBackup;
134
135 [Description (
136 "The estimated amount of disk space (in units) that has been "
137 "reserved for database use."),
138 MappingStrings {"MIB.IETF|RDBMS-MIB.rdbmsDbInfoSizeAllocated"} ]
139 uint32 SizeAllocated;
140
141 [Description (
142 "The units for the SizeAllocated property and the SizeUsed "
143 "property that is defined in the "
144 "CIM_CommonDatabaseStatistics class. Mapping is 1 - Bytes, "
145 "2 - Kilobytes, 3 - Megabytes, 4 - Gigabytes and 5 - "
146 "Terabytes."),
147 ValueMap {"1", "2", "3", "4", "5"},
148 tony 1.1 Values {"Bytes", "Kilobyes", "Megabytes", "Gigabytes",
149 "Terabytes"},
150 MappingStrings {"MIB.IETF|RDBMS-MIB.rdbmsDbInfoSizeUnits"} ]
151 uint16 SizeUnits;
152 };
153
154
155 // ==================================================================
156 // AssociatedDatabaseSystem
157 // ==================================================================
158 [Association, Version ("2.7.0"), Description (
159 "The CIM_AssociatedDatabaseSystem association identifies the "
160 "database system that is responsible for the database.") ]
161 class CIM_AssociatedDatabaseSystem : CIM_Dependency {
162
163 [Override ("Antecedent"), Min (1), Description (
164 "The database system that is responsible for the database.") ]
165 CIM_DatabaseSystem REF Antecedent;
166
167 [Override ("Dependent"), Description (
168 "The database.") ]
169 tony 1.1 CIM_CommonDatabase REF Dependent;
170 };
171
172
173 // ==================================================================
174 // DatabaseAdministrator
175 // ==================================================================
176 [Association, Version ("2.7.0"), Description (
177 "The DatabaseAdministrator association identifies a UserEntity "
178 "as a database administrator of a CommonDatabase.\n"
179 "The current version of CIM includes a UserContact class that "
180 "is concrete and extends from UserEntity. UserContact contains "
181 "the information needed to contact a database administrator. "
182 "The DatabaseAdministrator association should be implemented "
183 "through the UserContact class in favor creating a vendor "
184 "specific concrete class to define database administrator "
185 "contact information.") ]
186 class CIM_DatabaseAdministrator : CIM_Dependency {
187
188 [Override ("Antecedent"), Description (
189 "The database that is being administered.") ]
190 tony 1.1 CIM_CommonDatabase REF Antecedent;
191
192 [Override ("Dependent"), Description (
193 "The user entity who is responsible for the administration "
194 "of the database.") ]
195 CIM_UserEntity REF Dependent;
196 };
197
198
199 // ==================================================================
200 // DatabaseService
201 // ==================================================================
202 [Version ("2.7.0"), Description (
203 "Database services perform tasks for a database. Examples of "
204 "tasks that are performed by a database service include "
205 "providing user access to the database, performing data and "
206 "metadata manipulation, database administration, and "
207 "maintenance operations.\n"
208 "One or more database services can perform tasks for a "
209 "database. The database services can reside on the same "
210 "computer system as the database or on different computer "
211 tony 1.1 "systems. Database services may be implemented as one or more "
212 "processes.") ]
213 class CIM_DatabaseService : CIM_Service {
214
215 [Description (
216 "The date and time when the database service was last "
217 "started. If the database service has an OperationalStatus "
218 "of Stopped or Starting, then this value is not meaningful "
219 "and the contents MUST be set to zeros."),
220 MappingStrings {"MIB.IETF|RDBMS-MIB.rdbmsSrvInfoStartupTime"} ]
221 datetime StartupTime;
222
223 [Override ("OperationalStatus"), Description (
224 "This property contains the operational status of the "
225 "database service. OK means that the database service is "
226 "operational and available for general use. Stopped means "
227 "that the service is unavailable and cannot be used. "
228 "Service implies an administrative state of unavailability. "
229 "Degraded means that the database service is operating at a "
230 "less than optimal level. Starting means that the database "
231 "service is in the process of becoming operational.\n"
232 tony 1.1 "These status values map to the RFC1697 OperStatus values as "
233 "follows: OK - UP, Stopped - DOWN, In Service - HALTED, "
234 "Stressed - CONGESTED, and Starting - RESTARTING. Any "
235 "additional status variables that are defined are CIM "
236 "specific."),
237 MappingStrings {"MIB.IETF|RDBMS-MIB.rdbmsSrvInfoOperStatus"} ]
238 uint16 OperationalStatus[];
239
240 [Description (
241 "The date and time when the status of the database service "
242 "last changed."),
243 MappingStrings {"MIB.IETF|RDBMS-MIB.rdbmsSrvInfoLastChange"} ]
244 datetime LastStatusChangeTime;
245
246 [Description (
247 "The maximum number of active inbound connections that can "
248 "be concurrently opened on the service."),
249 MappingStrings
250 {"MIB.IETF|RDBMS-MIB.rdbmsSrvInfoMaxInboundAssociations"} ]
251 uint32 ConnectionLimit;
252 };
253 tony 1.1
254
255 // ==================================================================
256 // ServiceAvailableToDatabase
257 // ==================================================================
258 [Association, Version ("2.7.0"), Description (
259 "The CIM_ServiceAvailableToDatabase association relates "
260 "databases to the database services that are available for "
261 "database use.") ]
262 class CIM_ServiceAvailableToDatabase : CIM_ServiceAvailableToElement {
263
264 [Override ("ServiceProvided"), Description (
265 "The database service that is providing service.") ]
266 CIM_DatabaseService REF ServiceProvided;
267
268 [Override ("UserOfService"), Description (
269 "The database that is being served.") ]
270 CIM_CommonDatabase REF UserOfService;
271
272 [Description (
273 "The AvailableState property indicates the current state of "
274 tony 1.1 "a database service regarding its ability to access a "
275 "specific database. A service can be actively using a "
276 "database (ACTIVE), or it can be waiting for a task to "
277 "perform (AVAILABLE), or the service can be less than "
278 "completely available for use by the database (RESTRICTED), "
279 "or the database is not accessible from this service "
280 "(UNAVAILABLE). Any service states that do not match one of "
281 "these values should specify (OTHER)."),
282 ValueMap {"1", "2", "3", "4", "5"},
283 Values {"Other", "Active", "Available", "Restricted",
284 "Unavailable"},
285 MappingStrings {"MIB.IETF|RDBMS-MIB.rdbmsRelState"},
286 ModelCorrespondence
287 {"CIM_ServiceAvailableToDatabase.OtherAvailableState"} ]
288 uint16 AvailableState;
289
290 [Description (
291 "A string describing the service's available state when the "
292 "AvailableState property is set to 1 (\"Other\"). This "
293 "property MUST be set to NULL when AvailableState is any "
294 "value other than 1."),
295 tony 1.1 ModelCorrespondence
296 {"CIM_ServiceAvailableToDatabase.AvailableState"} ]
297 string OtherAvailableState;
298
299 [Description (
300 "The time that the database was made active by this "
301 "service. If the AvailableState property is not active, "
302 "then the value of this property MUST be set to zero."),
303 MappingStrings {"MIB.IETF|RDBMS-MIB.rdbmsRelActiveTime"} ]
304 datetime ActiveTime;
305 };
306
307
308 // ==================================================================
309 // DatabaseParameter
310 // ==================================================================
311 [Abstract, Version ("2.7.0"), Description (
312 "The CIM_DatabaseParameter class extends from "
313 "CIM_ScopedSettingData. This is an abstract class that "
314 "specifies the database and service configuration parameters "
315 "that are common across database models and vendor implementations.\n"
316 tony 1.1 "The SNMP RDBMS MIB defines database and service parameters as "
317 "name/value pair combinations rather than as specific named "
318 "properties of the class. In order to maintain a consistent "
319 "mapping between SNMP and CIM a CIM_SNMPDatabaseParameter class "
320 "extends from the abstract CIM_DatabaseParameter class which "
321 "defines parameters as a name value pair.\n"
322 "In a future release of the database MOF, the working group may "
323 "choose to create a new class that extends from "
324 "CIM_DatabaseParameter that specifies properties for common "
325 "configuration parameters.\n"
326 "The parameter context for a specific database or database "
327 "service is established by collecting the SettingData using the "
328 "CIM_ElementProfile association.\n"
329 "The SNMP RDBMS MIB defines generic tables that contain rows of "
330 "named database or service configuration entries. A parameter "
331 "entry contains a parameter name, description, and value. See "
332 "the description of the rdbmsDbParamTable or the "
333 "rdbmsSrvParamTable for more information on the SNMP "
334 "definitions.") ]
335 class CIM_DatabaseParameter : CIM_ScopedSettingData {
336 };
337 tony 1.1
338
339 // ==================================================================
340 // SNMPDatabaseParameter
341 // ==================================================================
342 [Version ("2.7.0"), Description (
343 "The CIM_SNMPDatabaseParameter class extends from "
344 "CIM_DatabaseParameter. This class is included in the CIM "
345 "database schema to provide explicit mapping to the way that "
346 "the SNMP MIB defines database and service parameters. More "
347 "information on the SNMP MIB parameters can be found in RFC 1697.\n"
348 "The SNMP RDBMS MIB defines generic tables that contain rows of "
349 "named database or service configuration entries. A parameter "
350 "entry contains a parameter name, description, and value. See "
351 "the description of the rdbmsDbParamTable or the "
352 "rdbmsSrvParamTable for more information on the SNMP "
353 "definitions.") ]
354 class CIM_SNMPDatabaseParameter : CIM_DatabaseParameter {
355
356 [Description (
357 "The value of a database or service parameter represented as "
358 tony 1.1 "a string."),
359 MappingStrings {"MIB.IETF|RDBMS-MIB.rdbmsDbParamCurrValue"} ]
360 string ParameterValue;
361 };
362
363 // ===================================================================
364 // end of file
365 // ===================================================================
|
Return to
Database28_System.mof
CVS log
Up to [Pegasus] / pegasus / Schemas / CIMPrelim28