1 karl 1.1.2.2 // Copyright (c) 2005 DMTF. All rights reserved.
2 [Version ( "2.10.0" ),
3 UMLPackagePath ( "CIM::Device::StorageStatistics" ),
4 Description (
5 "A subclass of StatisticsService that provides services for "
6 "filtering and retrieving statistics from a "
7 "StatisticsManifestCollection that contains instances of "
8 "BlockStatisticalData." )]
9 class CIM_BlockStatisticsService : CIM_StatisticsService {
10
11
12 [Description (
13 "Retrieves statistics in a well-defined bulk format. The "
14 "collection of statistics returned is determined by the "
15 "list of element types passed in to the method and the "
16 "manifests for those types contained in the supplied "
17 "BlockStatisticsManifestCollection. If both the Elements "
18 "and BlockStatisticsManifestCollection parameters are "
19 "supplied, then the types of elements returned is an "
20 "intersection of the element types listed in the Elements "
21 "parameter and the types for which "
22 karl 1.1.2.2 "BlockStatisticsManifest instances exist in the supplied "
23 "BlockStatisticsManifestCollection. The statistics are "
24 "returned through a well-defined array of strings, whose "
25 "format is specified by the StatisticsFormat parameter, "
26 "that can be parsed to retrieve the desired statistics as "
27 "well as limited information about the elements that "
28 "those metrics describe." ),
29 ValueMap { "0", "1", "2", "3", "4", "5", "..", "4096",
30 "4097", "4098", "4099..32767", "32768..65535" },
31 Values { "Job Completed with No Error", "Not Supported",
32 "Unknown", "Timeout", "Failed", "Invalid Parameter",
33 "Method Reserved",
34 "Method Parameters Checked - Job Started",
35 "Element Not Supported",
36 "Statistics Format Not Supported", "Method Reserved",
37 "Vendor Specific" }]
38 uint32 GetStatisticsCollection(
39 [IN ( false ), OUT, Description (
40 "Reference to the job (may be null if job completed)."
41 )]
42 CIM_ConcreteJob REF Job,
43 karl 1.1.2.2 [IN, Description (
44 "Element types for which statistics should be "
45 "returned. If not supplied (i.e. parameter is null) "
46 "this parameter is not considered when filtering "
47 "the instances of StatisticalData that will "
48 "populate the Statistics output parameter. If the "
49 "array is not null, but is empty, then no "
50 "statistics will be returned by this method. A "
51 "client SHOULD NOT specify this parameter if it is "
52 "not meaningful (i.e. the service only provides "
53 "statistics for a single type of element)." ),
54 ValueMap { "2", "3", "4", "5", "6", "7", "8", "9",
55 "10", "11", "12", "..", "0x8000.." },
56 Values { "Computer System",
57 "Front-end Computer System", "Peer Computer System",
58 "Back-end Computer System", "Front-end Port",
59 "Back-end Port", "Volume", "Extent", "Disk Drive",
60 "Arbitrary LUs", "Remote Replica Group",
61 "DMTF Reserved", "Vendor Specific" },
62 ModelCorrespondence {
63 "CIM_BlockStorageStatisticalData.ElementType" }]
64 karl 1.1.2.2 uint16 ElementTypes[],
65 [IN, Description (
66 "The BlockStatisticsManifestCollection that "
67 "contains the manifests that list the metrics to be "
68 "returned for each element type. If not supplied "
69 "(i.e. parameter is null), then all available "
70 "statistics will be returned unfiltered. Only "
71 "elements that match the element type properties "
72 "(if meaningful) of the BlockStatisticsManifest "
73 "instances contained within the "
74 "BlockStatisticsManifestCollection will have data "
75 "returned by this method. If the supplied "
76 "BlockStatisticsManifestCollection does not contain "
77 "any BlockStatisticsManifest instances, then no "
78 "statistics will be returned by this method." )]
79 CIM_BlockStatisticsManifestCollection REF ManifestCollection,
80 [IN, Description (
81 "Specifies the format of the Statistics output "
82 "parameter. \n"
83 "- CSV = Comma Separated Values." ),
84 ValueMap { "0", "1", "2", "..", "0x8000.." },
85 karl 1.1.2.2 Values { "Unknown", "Other", "CSV", "DMTF Reserved",
86 "Vendor Specific" }]
87 uint16 StatisticsFormat,
88 [OUT, Description (
89 "The statistics for all the elements as determined "
90 "by the Elements, ManifestCollection parameters, "
91 "and StatisticsFormat parameters." ),
92 ModelCorrespondence {
93 "CIM_BlockStatisticsService.GetStatisticsCollection(ElementTypes)",
94 "CIM_BlockStatisticsService.GetStatisticsCollection(ManifestCollection)",
95 "CIM_BlockStatisticsService.GetStatisticsCollection(StatisticsFormat)" }]
96 string Statistics[]);
97
98 [Description (
99 "Creates a new BlockStatisticsManifestCollection "
100 "instance, whose members can serve as a filter for "
101 "metrics retrieved through the GetStatisticsCollection "
102 "method." ),
103 ValueMap { "0", "1", "2", "3", "4", "5", "6..32767",
104 "32768..65535" },
105 Values { "Ok", "Not Supported", "Unknown", "Timeout",
106 karl 1.1.2.2 "Failed", "Invalid Parameter", "Method Reserved",
107 "Vendor Specific" }]
108 uint32 CreateManifestCollection(
109 [IN, Description (
110 "The collection of statistics that will be filtered "
111 "using the new BlockStatisticsManifestCollection." )]
112 CIM_StatisticsCollection REF Statistics,
113 [IN, Description (
114 "Client-defined name for the new "
115 "BlockStatisticsManifestCollection." )]
116 string ElementName,
117 [OUT, Description (
118 "Reference to the new BlockStatisticsManifestCollection."
119 )]
120 CIM_BlockStatisticsManifestCollection REF ManifestCollection);
121
122 [Description (
123 "Method that creates or modifies a "
124 "BlockStatisticsManifest for this statistics service. A "
125 "client supplies a BlockStatisticsManifestCollection in "
126 "which the new BlockStatisticsManifest will be placed or "
127 karl 1.1.2.2 "an existing BlockStatisticsManifest will be modified, "
128 "the element type of the statistics that the "
129 "BlockStatisticsManifest will filter, and a list of "
130 "metrics, which serves as a filter for statistical data "
131 "of that element type." ),
132 ValueMap { "0", "1", "2", "3", "4", "5", "..", "4096",
133 "4097", "4098", "4099..32767", "32768..65535" },
134 Values { "Success", "Not Supported", "Unknown", "Timeout",
135 "Failed", "Invalid Parameter", "Method Reserved",
136 "Element Not Supported", "Metric not supported",
137 "ElementType Parameter Missing", "Method Reserved",
138 "Vendor Specific" }]
139 uint32 AddOrModifyManifest(
140 [IN, Description (
141 "BlockStatisticsManifestCollection that the "
142 "BlockStatisticsManifest is or should be a member "
143 "of." )]
144 CIM_BlockStatisticsManifestCollection REF ManifestCollection,
145 [IN, Description (
146 "The type of elements whose statistics the "
147 "BlockStatisticsManifest will filter." ),
148 karl 1.1.2.2 ValueMap { "2", "3", "4", "5", "6", "7", "8", "9",
149 "10", "11", "12", "..", "0x8000.." },
150 Values { "Computer System",
151 "Front-end Computer System", "Peer Computer System",
152 "Back-end Computer System", "Front-end Port",
153 "Back-end Port", "Volume", "Extent", "Disk Drive",
154 "Arbitrary LUs", "Remote Replica Group",
155 "DMTF Reserved", "Vendor Specific" },
156 ModelCorrespondence {
157 "CIM_BlockStatisticsManifest.ElementType" }]
158 uint16 ElementType,
159 [IN, Description (
160 "A client-defined string that identifies the "
161 "BlockStatisticsManifest created or modified by "
162 "this method." )]
163 string ElementName,
164 [IN, Description (
165 "The metrics that will be included by the filter. "
166 "The metrics supplied here are the properties of "
167 "CIM_StatisticalData or one of its subclasses that "
168 "will remain after the BlockStatisticsManifest "
169 karl 1.1.2.2 "filter is applied." )]
170 string StatisticsList[],
171 [OUT, Description (
172 "The BlockStatisticsManifest that is created or "
173 "modified on successful execution of the method." )]
174 CIM_BlockStatisticsManifest REF Manifest);
175
176 [Description (
177 "Extrinsic method that removes manifests from a "
178 "BlockStatisticsManifestCollection." ),
179 ValueMap { "0", "1", "2", "3", "4", "5", "..", "4096",
180 "4097..32767", "32768..65535" },
181 Values { "Success", "Not Supported", "Unknown", "Timeout",
182 "Failed", "Invalid Parameter", "Method Reserved",
183 "Manifest not found", "Method Reserved", "Vendor Specific" }]
184 uint32 RemoveManifests(
185 [IN, Description (
186 "BlockStatisticsManifestCollection from which the "
187 "BlockStatisticsManifests will be removed." )]
188 CIM_BlockStatisticsManifestCollection REF ManifestCollection,
189 [IN, Description (
190 karl 1.1.2.2 "List of BlockStatisticsManifests to be removed "
191 "from the BlockStatisticsManifestCollection." )]
192 CIM_BlockStatisticsManifest REF Manifests[]);
193
194 };
|