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