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