1 karl 1.1 <html>
2 <body bgcolor="#CCCCCC">
3 <table width="100%">
4 <tr>
5 <td width="50%" align="bottom"><h1>Enumerate Instances CIM Operation</h1><td>
6 <td width="50%" align="right">
|
7 karl 1.3 <img border=1 src="/pegasus/icons/OpenGroupLogo.gif">
|
8 karl 1.1 </td>
9 </tr>
10 </table>
11 <hr>
|
12 karl 1.4 <form name="EnumerateInstances" METHOD=GET ACTION="/pegasus/cgi-bin/CGIClient">
|
13 karl 1.2 <INPUT TYPE="hidden" NAME="Operation" VALUE="EnumerateInstances">
|
14 karl 1.6 <INPUT TYPE="hidden" NAME="hostaddress" VALUE="localhost:5988">
15 <INPUT TYPE="hidden" NAME="debug" VALUE="">
|
16 karl 1.1 <p>
17
18 <a name="TOP"></a>
19
|
20 karl 1.2 The <TT>enumerateInstances</TT> method enumerates instances of a CIM
21 Class in the target Namespace.
22 <p><b><a href="#NameSpace">NameSpace</a></b>
|
23 karl 1.5 <INPUT TYPE="text" NAME="NameSpace" SIZE=30 VALUE="root/cimv2"> String that defines the target namespace. See <a href="getnamespaces.html">NameSpace
|
24 karl 1.2 Operations</a> for more information.
25 <p><b><a href="#ClassName">ClassName</a></b> <INPUT TYPE="text" NAME="ClassName" SIZE=30> Defines
26 name of the Class
27 for which instance names are to be retrieved. This must be a legal
28 class in the repository
29 <p><b>LocalOnly</b> <INPUT TYPE="checkbox" NAME="LocalOnly" VALUE="true" checked>
30 If true only CIM Elements overridden within definition of class are
31 returned.
32 <p><b>IncludeQualifiers</b> <INPUT TYPE="checkbox" NAME="IncludeQualifiers" VALUE="true">
33 If checked, show Qualifiers for class and returned Properties, Methods,
34 and Method Parameters.
35 <p><b>IncludeClassOrigins</b> <INPUT TYPE="checkbox" NAME="IncludeClassOrigins" VALUE="true">
36 If checked (TRUE), CLASSORIGIN attribute will be returned for all
37 appropriate elements<p><b>PropertyList </b> <INPUT TYPE="text" NAME="PropertyList" SIZE=30 VALUE="NULL">
38 NOTE: <b> NOT IMPLEMENTED </b>Null or array of property names to filter
39 request. <a href="#PropertyList">See below</a>.
40 <p><INPUT TYPE="submit" VALUE="Submit Request">
41 <INPUT TYPE="reset" VALUE="Reset">
42 </form>
43 <hr>
|
44 karl 1.6 <h2>Additional Information</h2>
|
45 karl 1.2
46 <P>The <TT>enumerateInstances</TT> method enumerates instances of a CIM
47 Class in the target Namespace.
48
49 NameSpace The NameSpace parameter is a string that defines the
|
50 karl 1.6 target namespace. The <TT>ClassName</TT> input parameter defines the
51 Class that is the basis for the enumeration. </P>
|
52 karl 1.2
|
53 karl 1.6 <b>
|
54 karl 1.2
|
55 karl 1.6 LocalOnly</b> If the <TT>LocalOnly</TT> input parameter is
|
56 karl 1.2 <TT>true</TT>, this specifies that, for each returned Instance,
57 only elements (properties and qualifiers) overriden within the
58 definition of that Instance are included. If <TT>false</TT>,
59 all elements are returned. This parameter therefore effects a CIM
60 Server-side mechanism to filter certain elements of the returned object
61 based on whether or not they have been propagated from the parent
|
62 karl 1.6 Class (as defined by the <TT>PROPAGATED</TT> attribute).
63 <p><b>DeepInheritance</b> If the <TT>DeepInheritance</TT> input
|
64 karl 1.2 parameter is <TT>true</TT>, this specifies that, for each
65 returned Instance of the Class, all properties of the Instance MUST
66 be present (subject to constraints imposed by the other
67 parameters), including any which were added by subclassing the specified
68 Class. If <TT>false</TT>, each returned Instance includes only
|
69 karl 1.6 properties defined for the specified Class. </p>
70 <p><b>IncludeQualifiers</b> If the <TT>IncludeQualifiers</TT> input
|
71 karl 1.2 parameter is <TT>true</TT>, this specifies that all Qualifiers
72 for each Instance (including Qualifiers on the Instance
73 and on any returned Properties) MUST be included as
74 <TT><QUALIFIER></TT> elements in the response. If false no
75 <TT><QUALIFIER></TT> elements are present in each
|
76 karl 1.6 returned Instance. </p>
77 <p><b>IncludeClassOrigin</b> If the <TT>IncludeClassOrigin</TT> input
|
78 karl 1.2 parameter is <TT>true</TT>, this specifies that the
79 <TT>CLASSORIGIN</TT> attribute MUST be present on all appropriate
80 elements in each returned Instance. If false, no
81 <TT>CLASSORIGIN</TT> attributes are present in each returned
|
82 karl 1.6 Instance. </p>
83 <p><b>PropertyList</b> If the <TT>PropertyList</TT> input parameter is not
|
84 karl 1.2 <TT>NULL</TT>, the members of the array define one or more Property
85 names. Each returned Instance MUST NOT include elements
86 for any Properties missing from this list. Note that if
87 <TT>LocalOnly</TT> is specified as <TT>true</TT> (or
88 <TT>DeepInheritance</TT> is specified as <TT>false</TT>) this acts as an
89 additional filter on the set of Properties returned (for example,
90 if Property <TT>A</TT> is included in the
91 <TT>PropertyList</TT> but <TT>LocalOnly</TT> is set to true and
92 <TT>A</TT> is not local to a returned Instance, then it will not be
93 included in that Instance). If the <TT>PropertyList</TT> input parameter
94 is an empty array this signifies that no Properties are included in each
95 returned Instance. If the <TT>PropertyList</TT> input parameter is
96 NULL this specifies that all Properties (subject to the conditions
97 expressed by the other parameters) are included in each returned
98 Instance.
99
100 If the <TT>PropertyList</TT> contains duplicate elements,
101 the Server MUST ignore the duplicates but otherwise process the request
102 normally. If the <TT>PropertyList</TT> contains elements which are
103 invalid Property names for any target Instance, the Server MUST
|
104 karl 1.6 ignore such entries but otherwise process the request normally. </p>
105 <hr>
106 <h2>Return</h2>
107 <p>If successful, the method returns zero or more named
|
108 karl 1.2 Instances that meet the required criteria.
109
110 If unsuccessful, one of the following status codes MUST be returned
111 by this method, where the first applicable error in the list (starting
112 with the first element of the list, and working down) is the error
113 returned. Any additional method-specific interpretation of the error in
|
114 karl 1.6 is given in parentheses.</p>
|
115 karl 1.2
116 <UL>
117 <LI>CIM_ERR_ACCESS_DENIED
118 <LI>CIM_ERR_NOT_SUPPORTED
119 <LI>CIM_ERR_INVALID_NAMESPACE
120 <LI>CIM_ERR_INVALID_PARAMETER (including missing,
121 duplicate, unrecognized or otherwise incorrect parameters)
122 <LI>CIM_ERR_INVALID_CLASS (the CIM Class that is the
123 basis for this enumeration does not exist)
124 <LI>CIM_ERR_FAILED (some other unspecified erroroccurred)</LI>
125 </UL>
|
126 karl 1.6 <hr>
127 <h2>C++ APIs as defined in CIMOperations.h</h2>
|
128 karl 1.1 <PRE>
|
129 karl 1.2 virtual Array<InstanceDecl> enumerateInstances(
|
130 karl 1.6 const String& nameSpace,
131 const String& className,
|
132 karl 1.2 Boolean deepInheritance = true,
133 Boolean localOnly = true,
134 Boolean includeQualifiers = false,
135 Boolean includeClassOrigin = false,
|
136 karl 1.6 const Array<String>& propertyList = _getStringArray()) = 0;
|
137 karl 1.2 </PRE>
|
138 karl 1.6 <script>
139 document.EnumerateInstances.hostaddress.value = top.hostAddress;
140 document.EnumerateInstances.debug.value = top.debug;
141 document.EnumerateInstances.NameSpace.value = top.NameSpace;
142 window.focus();
143 </script>
144 </body>
145 </html>
|
146 karl 1.1
|
Return to
EnumerateInstances.html
CVS log
Up to [Pegasus] / pegasus / cgi / htdocs