version 1.1, 2001/02/05 14:16:44
|
version 1.3, 2001/02/06 22:20:01
|
|
|
<tr> | <tr> |
<td width="50%" align="bottom"><h1>Enumerate Instances CIM Operation</h1><td> | <td width="50%" align="bottom"><h1>Enumerate Instances CIM Operation</h1><td> |
<td width="50%" align="right"> | <td width="50%" align="right"> |
<img border=1 src="pegasus/icons/OpenGroupLogo.gif"> |
<img border=1 src="/pegasus/icons/OpenGroupLogo.gif"> |
</td> | </td> |
</tr> | </tr> |
</table> | </table> |
<hr> | <hr> |
<form METHOD=GET ACTION="/pegasus/cgi-bin/CGIClient"> | <form METHOD=GET ACTION="/pegasus/cgi-bin/CGIClient"> |
<INPUT TYPE="hidden" NAME="Operation" VALUE="EnumerateInstanceNames"> |
<INPUT TYPE="hidden" NAME="Operation" VALUE="EnumerateInstances"> |
<p> | <p> |
| |
<a name="TOP"></a> | <a name="TOP"></a> |
| |
The <TT>enumerateInstanceNames</TT> operation enumerates the |
The <TT>enumerateInstances</TT> method enumerates instances of a CIM |
names (model paths) of the instances of a CIM Class in the target Namespace. |
Class in the target Namespace. |
<p><b><a href="#NameSpace">NameSpace</a></b> | <p><b><a href="#NameSpace">NameSpace</a></b> |
<INPUT TYPE="text" NAME="NameSpace" SIZE=30 VALUE="root/cimv20"> String that defines the target namespace. See <a href="getnamespaces.html">NameSpace | <INPUT TYPE="text" NAME="NameSpace" SIZE=30 VALUE="root/cimv20"> String that defines the target namespace. See <a href="getnamespaces.html">NameSpace |
Operations</a> for more information. | Operations</a> for more information. |
<p><b><a href="#ClassName">ClassName</a></b> <INPUT TYPE="text" NAME="ClassName" SIZE=30> Defines | <p><b><a href="#ClassName">ClassName</a></b> <INPUT TYPE="text" NAME="ClassName" SIZE=30> Defines |
name of the Class | name of the Class |
for which instance names are to be retrieved. This must be a legal | for which instance names are to be retrieved. This must be a legal |
class in the repository<p><INPUT TYPE="submit" VALUE="Submit Request"> |
class in the repository |
|
<p><b>LocalOnly</b> <INPUT TYPE="checkbox" NAME="LocalOnly" VALUE="true" checked> |
|
If true only CIM Elements overridden within definition of class are |
|
returned. |
|
<p><b>IncludeQualifiers</b> <INPUT TYPE="checkbox" NAME="IncludeQualifiers" VALUE="true"> |
|
If checked, show Qualifiers for class and returned Properties, Methods, |
|
and Method Parameters. |
|
<p><b>IncludeClassOrigins</b> <INPUT TYPE="checkbox" NAME="IncludeClassOrigins" VALUE="true"> |
|
If checked (TRUE), CLASSORIGIN attribute will be returned for all |
|
appropriate elements<p><b>PropertyList </b> <INPUT TYPE="text" NAME="PropertyList" SIZE=30 VALUE="NULL"> |
|
NOTE: <b> NOT IMPLEMENTED </b>Null or array of property names to filter |
|
request. <a href="#PropertyList">See below</a>. |
|
<p><INPUT TYPE="submit" VALUE="Submit Request"> |
<INPUT TYPE="reset" VALUE="Reset"> | <INPUT TYPE="reset" VALUE="Reset"> |
</form> | </form> |
| |
<hr> | <hr> |
<h2>RETURN</h2> | <h2>RETURN</h2> |
If successful, the method returns zero or more names of Instances |
|
(model paths) that meet the requested criteria. |
|
| |
If unsuccessful, one of the following status codes MUST be returned by this |
<P>The <TT>enumerateInstances</TT> method enumerates instances of a CIM |
method, where the first applicable error in the list (starting with the |
Class in the target Namespace. |
first element of the list, and working down) is the error returned. Any |
|
additional method-specific interpretation of the error in is given in |
NameSpace The NameSpace parameter is a string that defines the |
parentheses. |
target namespace \Ref{NAMESPACE} |
|
|
|
ClassName The <TT>ClassName</TT> input parameter defines the |
|
Class that is the basis for the enumeration. </P> |
|
|
|
LocalOnly If the <TT>LocalOnly</TT> input parameter is |
|
<TT>true</TT>, this specifies that, for each returned Instance, |
|
only elements (properties and qualifiers) overriden within the |
|
definition of that Instance are included. If <TT>false</TT>, |
|
all elements are returned. This parameter therefore effects a CIM |
|
Server-side mechanism to filter certain elements of the returned object |
|
based on whether or not they have been propagated from the parent |
|
Class (as defined by the <TT>PROPAGATED</TT> attribute). |
|
|
|
@param DeepInheritance If the <TT>DeepInheritance</TT> input |
|
parameter is <TT>true</TT>, this specifies that, for each |
|
returned Instance of the Class, all properties of the Instance MUST |
|
be present (subject to constraints imposed by the other |
|
parameters), including any which were added by subclassing the specified |
|
Class. If <TT>false</TT>, each returned Instance includes only |
|
properties defined for the specified Class. |
|
|
|
@param IncludeQualifiersIf the <TT>IncludeQualifiers</TT> input |
|
parameter is <TT>true</TT>, this specifies that all Qualifiers |
|
for each Instance (including Qualifiers on the Instance |
|
and on any returned Properties) MUST be included as |
|
<TT><QUALIFIER></TT> elements in the response. If false no |
|
<TT><QUALIFIER></TT> elements are present in each |
|
returned Instance. |
|
|
|
@param IncludeClassOrigin If the <TT>IncludeClassOrigin</TT> input |
|
parameter is <TT>true</TT>, this specifies that the |
|
<TT>CLASSORIGIN</TT> attribute MUST be present on all appropriate |
|
elements in each returned Instance. If false, no |
|
<TT>CLASSORIGIN</TT> attributes are present in each returned |
|
Instance. |
|
|
|
@param PropertyList If the <TT>PropertyList</TT> input parameter is not |
|
<TT>NULL</TT>, the members of the array define one or more Property |
|
names. Each returned Instance MUST NOT include elements |
|
for any Properties missing from this list. Note that if |
|
<TT>LocalOnly</TT> is specified as <TT>true</TT> (or |
|
<TT>DeepInheritance</TT> is specified as <TT>false</TT>) this acts as an |
|
additional filter on the set of Properties returned (for example, |
|
if Property <TT>A</TT> is included in the |
|
<TT>PropertyList</TT> but <TT>LocalOnly</TT> is set to true and |
|
<TT>A</TT> is not local to a returned Instance, then it will not be |
|
included in that Instance). If the <TT>PropertyList</TT> input parameter |
|
is an empty array this signifies that no Properties are included in each |
|
returned Instance. If the <TT>PropertyList</TT> input parameter is |
|
NULL this specifies that all Properties (subject to the conditions |
|
expressed by the other parameters) are included in each returned |
|
Instance. |
|
|
|
If the <TT>PropertyList</TT> contains duplicate elements, |
|
the Server MUST ignore the duplicates but otherwise process the request |
|
normally. If the <TT>PropertyList</TT> contains elements which are |
|
invalid Property names for any target Instance, the Server MUST |
|
ignore such entries but otherwise process the request normally. |
|
|
|
@return If successful, the method returns zero or more named |
|
Instances that meet the required criteria. |
|
|
|
If unsuccessful, one of the following status codes MUST be returned |
|
by this method, where the first applicable error in the list (starting |
|
with the first element of the list, and working down) is the error |
|
returned. Any additional method-specific interpretation of the error in |
|
is given in parentheses. |
| |
<UL> | <UL> |
<LI>CIM_ERR_ACCESS_DENIED | <LI>CIM_ERR_ACCESS_DENIED |
<LI>CIM_ERR_NOT_SUPPORTED | <LI>CIM_ERR_NOT_SUPPORTED |
<LI>CIM_ERR_INVALID_NAMESPACE |
<LI>CIM_ERR_INVALID_NAMESPACE |
<LI>CIM_ERR_INVALID_PARAMETER (including missing, | <LI>CIM_ERR_INVALID_PARAMETER (including missing, |
duplicate, unrecognized or otherwise incorrect parameters) |
duplicate, unrecognized or otherwise incorrect parameters) |
<LI>CIM_ERR_INVALID_CLASS (the CIM Class that is the | <LI>CIM_ERR_INVALID_CLASS (the CIM Class that is the |
basis for this enumeration does not exist) | basis for this enumeration does not exist) |
<LI>CIM_ERR_FAILED (some other unspecified error occurred)</LI> | <LI>CIM_ERR_FAILED (some other unspecified error occurred)</LI> |
</UL> | </UL> |
|
|
<hr> |
|
<h2>Additional Information</h2> |
|
<p><b><a name="NameSpace">NameSpace</a></b> The NameSpace parameter is a string that defines the target |
|
namespace. |
|
<p><a name="ClassName"><b> |
|
|
|
ClassName</b></a> The ClassName input parameter defines the Class that is the |
|
basis for the enumeration. The ClassName input must be in the |
|
repository |
|
<p><a href="#TOP">Go To Top</a> |
|
<hr> |
|
<h2>C++ Call</h2> |
|
<p> |
|
| |
<PRE> | <PRE> |
virtual Array<Reference> enumerateInstanceNames( |
virtual Array<InstanceDecl> enumerateInstances( |
const String& nameSpace, |
const String& nameSpace, |
const String& className) = 0; |
const String& className, |
|
Boolean deepInheritance = true, |
|
Boolean localOnly = true, |
|
Boolean includeQualifiers = false, |
|
Boolean includeClassOrigin = false, |
|
const Array<String>& propertyList = _getStringArray()) = 0; |
</PRE> | </PRE> |
</body> | </body> |
</html> | </html> |