Return to
EnumerateInstances.html
CVS log
Up to [Pegasus] / pegasus / cgi / htdocs
|
Return to
EnumerateInstances.html
CVS log
|
Up to [Pegasus] / pegasus / cgi / htdocs
|
|
File: [Pegasus] / pegasus / cgi / htdocs / Attic / EnumerateInstances.html
(download)
/
(as text)
Revision: 1.9, Thu Aug 28 17:10:40 2008 UTC (15 years, 9 months ago) by kumpf Branch: MAIN CVS Tags: TASK-PEP362_RestfulService-merged_out_from_trunk, TASK-PEP348_SCMO-merged_out_from_trunk, TASK-PEP317_pullop-merged_out_from_trunk, TASK-PEP317_pullop-merged_in_to_trunk, HPUX_TEST, HEAD Changes since 1.8: +0 -0 lines FILE REMOVED BUG#: 7860 TITLE: pegasus/cgi directory is obsolete DESCRIPTION: Remove unused files. |
<html>
<body bgcolor="#CCCCCC">
<table width="100%">
<tr>
<td width="50%" align="bottom"><h1>Enumerate Instances CIM Operation</h1><td>
<td width="50%" align="right">
<img border=1 src="/pegasus/icons/OpenGroupLogo.gif">
</td>
</tr>
</table>
<hr>
<form name="EnumerateInstances" METHOD=GET ACTION="/pegasus/cgi-bin/CGIClient">
<INPUT TYPE="hidden" NAME="Operation" VALUE="EnumerateInstances">
<INPUT TYPE="hidden" NAME="hostaddress" VALUE="localhost:5988">
<INPUT TYPE="hidden" NAME="debug" VALUE="">
<p>
<a name="TOP"></a>
The <TT>enumerateInstances</TT> method enumerates instances of a CIM
Class in the target Namespace.
<p><b><a href="#NameSpace">NameSpace</a></b>
<INPUT TYPE="text" NAME="NameSpace" SIZE=30 VALUE="root/cimv2"> String that defines the target namespace. See <a href="enumeratenamespaces.html">NameSpace
Operations</a> for more information.
<p><b><a href="#ClassName">ClassName</a></b> <INPUT TYPE="text" NAME="ClassName" SIZE=30> Defines
name of the Class
for which instance names are to be retrieved. This must be a legal
class in the repository
<p><b>LocalOnly</b>
<INPUT TYPE="checkbox" NAME="LocalOnly" VALUE="true" checked>
If checked (true) only CIM Elements overridden within definition of class are
returned. Default is true
<p><b>IncludeQualifiers</b> <INPUT TYPE="checkbox" NAME="IncludeQualifiers" VALUE="true"> If
checked (true), show Qualifiers for class and returned Properties, Methods,
and Method Parameters.
<p><b>IncludeClassOrigins</b> <INPUT TYPE="checkbox" NAME="IncludeClassOrigin" 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 Form">
</form>
<hr>
<h2>Additional Information</h2>
<P>The <TT>enumerateInstances</TT> method enumerates instances of a CIM
Class in the target Namespace.
NameSpace The NameSpace parameter is a string that defines the
target namespace. The <TT>ClassName</TT> input parameter defines the
Class that is the basis for the enumeration. </P>
<b>
LocalOnly</b> 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).
<p><b>IncludeQualifiers</b> If 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. </p>
<p><b>IncludeClassOrigin</b> 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. </p>
<p><b>PropertyList</b> 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. </p>
<hr>
<h2>Return</h2>
<p>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.</p>
<UL>
<LI>CIM_ERR_ACCESS_DENIED
<LI>CIM_ERR_NOT_SUPPORTED
<LI>CIM_ERR_INVALID_NAMESPACE
<LI>CIM_ERR_INVALID_PARAMETER (including missing,
duplicate, unrecognized or otherwise incorrect parameters)
<LI>CIM_ERR_INVALID_CLASS (the CIM Class that is the
basis for this enumeration does not exist)
<LI>CIM_ERR_FAILED (some other unspecified erroroccurred)</LI>
</UL>
<hr>
<h2>C++ APIs as defined in CIMOperations.h</h2>
<PRE>
virtual Array<InstanceDecl> enumerateInstances(
const String& nameSpace,
const String& className,
Boolean localOnly = true,
Boolean includeQualifiers = false,
Boolean includeClassOrigin = false,
const Array<String>& propertyList = _getStringArray()) = 0;
</PRE>
<script>
document.EnumerateInstances.hostaddress.value = top.hostAddress;
document.EnumerateInstances.debug.value = top.debug;
document.EnumerateInstances.NameSpace.value = top.NameSpace;
window.focus();
</script>
</body>
</html>
| No CVS admin address has been configured |
Powered by ViewCVS 0.9.2 |