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