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