1 mike 1.1 <html>
|
2 karl 1.2 <body bgcolor="#CCCCCC">
|
3 mike 1.1 <table width="100%">
4 <tr>
|
5 karl 1.5 <td width="50%" align="bottom"><h1>GetClass CIM Operation</h1><td>
|
6 mike 1.1 <td width="50%" align="right">
|
7 karl 1.4 <img border=1 src="/pegasus/icons/OpenGroupLogo.gif">
|
8 mike 1.1 </td>
9 </tr>
10 </table>
|
11 karl 1.2 <hr>
|
12 karl 1.8 <form name="GetClass" METHOD=GET ACTION="/pegasus/cgi-bin/CGIClient">
|
13 mike 1.1 <INPUT TYPE="hidden" NAME="Operation" VALUE="GetClass">
|
14 karl 1.10 <INPUT TYPE="hidden" NAME="hostaddress" VALUE="localhost:5988">
15 <INPUT TYPE="hidden" NAME="debug" VALUE="">
16
|
17 karl 1.2 <p>The <TT>GetClass</TT> method returns a single CIM Class from the target Namespace
18 where the ClassName input parameter defines the name of the class to be retrieved.
|
19 karl 1.9 <p><b>NameSpace</b> <INPUT TYPE="text" NAME="NameSpace" SIZE=30 VALUE="root/cimv2">
|
20 karl 1.5 String that defines the target namespace. See <a href="getnamespaces.html">NameSpace
21 Operations</a> for more information<p><b>ClassName</b> <INPUT TYPE="text" NAME="ClassName" SIZE=30>
22 Defines the name of the Class to be retrieved. See <a href="EnumerateClassNames.html">Enumerate
23 Class Names</a> for a list of classes
24 <p><b>LocalOnly</b> <INPUT TYPE="checkbox" NAME="LocalOnly" VALUE="true" checked>
25 If true only CIM Elements overridden within definition of class are
26 returned.
27 <p><b>IncludeQualifiers</b> <INPUT TYPE="checkbox" NAME="IncludeQualifiers" VALUE="true">
28 If checked, show Qualifiers for class and returned Properties, Methods,
29 and Method Parameters.
30 <p><b>IncludeClassOrigins</b> <INPUT TYPE="checkbox" NAME="IncludeClassOrigins" VALUE="true">
31 If checked (TRUE), CLASSORIGIN attribute will be returned for all
32 appropriate elements<p><b>PropertyList </b> <INPUT TYPE="text" NAME="PropertyList" SIZE=30 VALUE="NULL">
33 NOTE: <b> NOT IMPLEMENTED </b>Null or array of property names to filter
34 request. <a href="#PropertyList">See below</a>.
35 <p><INPUT TYPE="submit" VALUE="Submit Request">
36 <INPUT TYPE="reset" VALUE="Reset Form">
|
37 karl 1.7 </form>
38 <hr>
39 <h2>RETURN Results</h2>
40 <p>If successful, the return value is a single CIM Class.If unsuccessful, one of the
|
41 karl 1.5 CIM status codes show below MUST be returned by this method,
42 where the first applicable error in the list (starting with the first element of the list,
43 and working down) is the error returned. Any additional method-specific interpretation of
44 the error in is given in parentheses.
45 <UL>
46 <LI>CIM_ERR_INVALID_NAMESPACE
47 <LI>CIM_ERR_INVALID_PARAMETER (including missing, duplicate,
48 unrecognized or otherwise incorrect parameters)
49 <LI>CIM_ERR_ACCESS_DENIED
50 <LI>CIM_ERR_INVALID_CLASS (the CIM Class does not exist in the
51 specified namespace)
52 <LI>CIM_ERR_NOT_FOUND (the CIM Class does exist, but the
53 requested CIM Instance does not exist in the specified namespace)
54 <LI>CIM_ERR_FAILED (some other unspecified error occurred)
55 </LI>
56 </UL>
57
|
58 karl 1.7 <hr>
59
60 <h2>ADDITIONAL Description of Fields</h2>
|
61 karl 1.5 <p><a name="LocalOnly"><b>LocalOnly</b></a> -
|
62 karl 1.2 If the <TT>LocalOnly</TT> input parameter is true, this specifies that only CIM
63 Elements (properties, methods and qualifiers) overriden within the definition of
64 the Class are returned. If false, all elements are returned. This parameter
65 therefore effects a CIM Server-side mechanism to filter certain elements of the
66 returned object based on whether or not they have been propagated from the parent
67 Class (as defined by the PROPAGATED attribute).
|
68 karl 1.5 <p><b><a name="IncludeQualifiers">IncludeQualifiers</a></b> -
|
69 karl 1.2 If the <TT>IncludeQualifiers</TT> input parameter is true, this specifies that
70 all Qualifiers for that Class (including Qualifiers on the Class and on any
71 returned Properties, Methods or Method Parameters) MUST be included as <QUALIFIER>
72 elements in the response. If false no QUALIFIER elements are present in the
|
73 karl 1.5 returned Class.<p><b><a name="IncludeClassOrigins">IncludeClassOrigin</a>s</b>
74 -
|
75 karl 1.2 If the <TT>IncludeClassOrigin</TT> input parameter is true, this specifies that
76 the CLASSORIGIN attribute MUST be present on all appropriate elements in the returned
77 Class. If false, no CLASSORIGIN attributes are present in the returned Class.
|
78 karl 1.5 <p><b><a name="PropertyList">PropertyList</a> - </b>If the <TT>PropertyList</TT> input parameter is not NULL, the members of the array
|
79 karl 1.2 define one or more Property names. The returned Class MUST NOT include elements for any
80 Properties missing from this list. Note that if <TT>LocalOnly</TT> is specified as true this acts
81 as an additional filter on the set of Properties returned (for example, if Property A is
82 included in the <TT>PropertyList</TT> but <TT>LocalOnly</TT> is set to true and A is not local to the
83 requested Class, then it will not be included in the response). If the <TT>PropertyList</TT>
84 input parameter is an empty array this signifies that no Properties are included in
85 the response. If the PropertyList input parameter is NULL this specifies that all
86 Properties (subject to the conditions expressed by the other parameters) are included
87 in the response.
88 <p>If the <TT>PropertyList</TT> contains duplicate elements, the Server MUST ignore
89 the duplicates but otherwise process the request normally. If the PropertyList contains
90 elements which are invalid Property names for the target Class, the Server MUST ignore
91 such entries but otherwise process the request normally.
|
92 karl 1.7 <hr>
93 <h2>C++ Pegasus API
94 </h2>
95 <pre>
96 virtual CIMClass getClass(
97 const String& nameSpace,
98 const String& className,
99 Boolean localOnly = true,
100 Boolean includeQualifiers = true,
101 Boolean includeClassOrigin = false,
102 const Array<String>& propertyList = StringArray()) = 0;
103 </pre>
104 <hr>
105
106 <p style="margin-top: 0; margin-bottom: 0"> <font size="2">Demonstration
107 Prepared by the OpenGroup Manageability Work Group Pegasus Development Team</font>
108
109 <p style="margin-top: 0; margin-bottom: 0"> <font size="2">See (<a href="http://www.opengroup.org/management">http://www.opengroup.org/management</a>)
110 for more information on Pegasus</font>
111
112 <p style="margin-top: 0; margin-bottom: 0"> <font size="1">Last Modified <!--webbot bot="Timestamp" S-Type="EDITED"
|
113 karl 1.10 S-Format="%A, %B %d, %Y %I:%M:%S %p" startspan -->Friday, June 29, 2001 06:41:52 PM<!--webbot bot="Timestamp" i-CheckSum="54937" endspan -->
|
114 karl 1.7 Copyright @ The Open Group 2001 </font>
|
115 karl 1.8 <p>
116 </form>
117 <script>
|
118 karl 1.10 document.GetClass.hostaddress.value = top.hostAddress;
119 document.GetClass.debug.value = top.debug;
120 document.GetClass.NameSpace.value = top.NameSpace;
121 window.focus();
|
122 karl 1.9 </script>
|
123 mike 1.1 </body>
124 </html>
|
Return to
GetClass.html
CVS log
Up to [Pegasus] / pegasus / cgi / htdocs