1 karl 1.1 <html>
2 <body bgcolor="#CCCCCC">
3 <table width="100%">
4 <tr>
|
5 karl 1.6 <td width="50%" align="bottom"><h1>Enumerate Instance Names CIM Operation</h1><td>
6 <td width="50%" align="right">
7 <img border=1 src="/pegasus/icons/OpenGroupLogo.gif">
|
8 karl 1.1 </td>
9 </tr>
10 </table>
|
11 karl 1.3 <hr>
|
12 karl 1.6 <form name="EnumerateInstanceNames" METHOD=GET ACTION="/pegasus/cgi-bin/CGIClient">
|
13 karl 1.1 <INPUT TYPE="hidden" NAME="Operation" VALUE="EnumerateInstanceNames">
|
14 karl 1.8 <INPUT TYPE="hidden" NAME="hostaddress" VALUE="localhost:5988">
15 <INPUT TYPE="hidden" NAME="debug" VALUE="">
|
16 karl 1.3 <p>
17
18 <a name="TOP"></a>
19
20 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.7 <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.3 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 karl 1.6 <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 karl 1.3 returned.
|
32 karl 1.6 <p><b>IncludeQualifiers</b> <INPUT TYPE="checkbox" NAME="IncludeQualifiers" VALUE="true">
33 If checked, show Qualifiers for class and returned Properties, Methods,
|
34 karl 1.3 and Method Parameters.
|
35 karl 1.6 <p><b>IncludeClassOrigins</b> <INPUT TYPE="checkbox" NAME="IncludeClassOrigins" VALUE="true">
36 If checked (TRUE), CLASSORIGIN attribute will be returned for all
|
37 karl 1.3 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 karl 1.1 </form>
|
43 karl 1.3
44 <hr>
|
45 karl 1.6 <h2>RETURN</h2>
|
46 karl 1.3 If successful, the method returns zero or more named
47 Instances that meet the required criteria.
48
49 If unsuccessful, one of the following status codes MUST be returned
50 by this method, where the first applicable error in the list (starting
51 with the first element of the list, and working down) is the error
52 returned. Any additional method-specific interpretation of the error in
53 is given in parentheses.
54
55 <UL>
56 <LI>CIM_ERR_ACCESS_DENIED
57 <LI>CIM_ERR_NOT_SUPPORTED
58 <LI>CIM_ERR_INVALID_NAMESPACE
59 <LI>CIM_ERR_INVALID_PARAMETER (including missing,
60 duplicate, unrecognized or otherwise incorrect parameters)
61 <LI>CIM_ERR_INVALID_CLASS (the CIM Class that is the
62 basis for this enumeration does not exist)
|
63 karl 1.5 <LI>CIM_ERR_FAILED (some other unspecified error occurred)</LI>
|
64 karl 1.3 </UL>
65 <hr>
66 <h2>Additional Information</h2>
67 <p><b><a name="NameSpace">NameSpace</a></b> The NameSpace parameter is a string that defines the target
68 namespace.
69 <p><b><a name="ClassName">
70
71 ClassName</a></b> The ClassName input parameter defines the Class that is the
72 basis for the enumeration. The ClassName input must be in the
73 repository
74 <p><a name="LocalOnly"><b>
|
75 karl 1.4
|
76 karl 1.3 LocalOnly</b></a> If the <TT>LocalOnly</TT> input parameter is
77 <TT>true</TT>, this specifies that, for each returned Instance,
78 only elements (properties and qualifiers) overridden within the
79 definition of that Instance are included. If <TT>false</TT>,
80 all elements are returned. This parameter therefore effects a CIM
81 Server-side mechanism to filter certain elements of the returned object
82 based on whether or not they have been propagated from the parent
83 Class (as defined by the <TT>PROPAGATED</TT> attribute).
|
84 karl 1.4
|
85 karl 1.3 <p><a name="DeepInheritance"><b>DeepInheritance</b></a> If the <TT>DeepInheritance</TT> input
86 parameter is <TT>true</TT>, this specifies that, for each
87 returned Instance of the Class, all properties of the Instance MUST
88 be present (subject to constraints imposed by the other
89 parameters), including any which were added by subclassing the specified
90 Class. If <TT>false</TT>, each returned Instance includes only
91 properties defined for the specified Class.
|
92 karl 1.4
|
93 karl 1.3 <p><a name="IncludeQualifiers"><b>IncludeQualifiers</b></a> If the <TT>IncludeQualifiers</TT> input
94 parameter is <TT>true</TT>, this specifies that all Qualifiers
95 for each Instance (including Qualifiers on the Instance
96 and on any returned Properties) MUST be included as
97 <TT>QUALIFIER</TT> elements in the response. If false no
98 <TT>QUALIFIER</TT> elements are present in each
99 returned Instance.
|
100 karl 1.4
|
101 karl 1.3 <p><b><a name="IncludeClassOrigin">IncludeClassOrigin</a></b> If the <TT>IncludeClassOrigin</TT> input
102 parameter is <TT>true</TT>, this specifies that the
103 <TT>CLASSORIGIN</TTT> attribute MUST be present on all appropriate
104 elements in each returned Instance. If false, no
105 <TT>CLASSORIGIN</TT> attributes are present in each returned
106 Instance.</tt>
|
107 karl 1.4
|
108 karl 1.3 <p>PropertyList If the <TT>PropertyList</TT> input parameter is not
109 <TT>NULL</TT>, the members of the array define one or more Property
110 names. Each returned Instance MUST NOT include elements
111 for any Properties missing from this list. Note that if
112 <TT>LocalOnly</TT> is specified as <TT>true</TT> (or
113 <TT>DeepInheritance</TT> is specified as <TT>false</TT>) this acts as an
114 additional filter on the set of Properties returned (for example,
115 if Property <TT>A</TT> is included in the
116 <TT>PropertyList</TT> but <TT>LocalOnly</TT> is set to true and
117 <TT>A</TT> is not local to a returned Instance, then it will not be
118 included in that Instance). If the <TT>PropertyList</TT> input parameter
119 is an empty array this signifies that no Properties are included in each
120 returned Instance. If the <TT>PropertyList</TT> input parameter is
121 NULL this specifies that all Properties (subject to the conditions
122 expressed by the other parameters) are included in each returned
123 Instance.
124
125 If the <TT>PropertyList</TT> contains duplicate elements,
126 the Server MUST ignore the duplicates but otherwise process the request
127 normally. If the <TT>PropertyList</TT> contains elements which are
128 invalid Property names for any target Instance, the Server MUST
129 karl 1.3 ignore such entries but otherwise process the request normally.
130
131
132
|
133 karl 1.4
134 <p><a href="#TOP">Go To Top</a>
|
135 karl 1.3 <hr>
136 <h2>C++ Call</h2>
|
137 karl 1.4
|
138 karl 1.3 <PRE>
139 virtual Array<InstanceDecl> enumerateInstances(
140 const String& nameSpace,
141 const String& className,
142 Boolean deepInheritance = true,
143 Boolean localOnly = true,
144 Boolean includeQualifiers = false,
145 Boolean includeClassOrigin = false,
|
146 karl 1.5 const Array<String>& propertyList = _getStringArray()) = 0;
147 </PRE>
148 <hr><p style="margin-top: 0; margin-bottom: 0"> <font size="2">Demonstration
149 Prepared by the OpenGroup Manageability Work Group Pegasus Development Team</font>
150
151 <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>)
152 for more information on Pegasus</font>
153
154 <p style="margin-top: 0; margin-bottom: 0"> <font size="1">Last Modified <!--webbot bot="Timestamp" S-Type="EDITED"
155 S-Format="%A, %B %d, %Y %I:%M:%S %p" startspan -->Monday, March 26, 2001 05:01:59 PM<!--webbot bot="Timestamp" i-CheckSum="50769" endspan -->
156 Copyright @ The Open Group 2001 </font>
|
157 karl 1.8 <script>
158 document.EnumerateInstanceNames.hostaddress.value = top.hostAddress;
159 document.EnumerateInstanceNames.debug.value = top.debug;
160 document.EnumerateInstanceNames.NameSpace.value = top.NameSpace;
161 window.focus();
162 </script>
|
163 karl 1.1 </body>
164 </html>
|
165 karl 1.3
|
Return to
EnumerateInstanceNames.html
CVS log
Up to [Pegasus] / pegasus / cgi / htdocs