Return to
GetClass.html
CVS log
Up to [Pegasus] / pegasus / cgi / htdocs
|
Return to
GetClass.html
CVS log
|
Up to [Pegasus] / pegasus / cgi / htdocs
|
|
File: [Pegasus] / pegasus / cgi / htdocs / Attic / GetClass.html
(download)
/
(as text)
Revision: 1.10.2.1, Wed Aug 1 10:37:38 2001 UTC (22 years, 11 months ago) by karl Branch: dev CVS Tags: version_1_01, dev_dead, SNAPSHOT_1_04 Changes since 1.10: +5 -2 lines add MOF display |
<html>
<body bgcolor="#CCCCCC">
<table width="100%">
<tr>
<td width="50%" align="bottom"><h1>GetClass CIM Operation</h1><td>
<td width="50%" align="right">
<img border=1 src="/pegasus/icons/OpenGroupLogo.gif">
</td>
</tr>
</table>
<hr>
<form name="GetClass" METHOD=GET ACTION="/pegasus/cgi-bin/CGIClient">
<INPUT TYPE="hidden" NAME="Operation" VALUE="GetClass">
<INPUT TYPE="hidden" NAME="hostaddress" VALUE="localhost:5988">
<INPUT TYPE="hidden" NAME="debug" VALUE="">
<p>The <TT>GetClass</TT> method returns a single CIM Class from the target Namespace
where the ClassName input parameter defines the name of the class to be retrieved.
<p><b>NameSpace</b> <INPUT TYPE="text" NAME="NameSpace" SIZE=30 VALUE="root/cimv2">
String that defines the target namespace. See <a href="getnamespaces.html">NameSpace
Operations</a> for more information<p><b>ClassName</b> <INPUT TYPE="text" NAME="ClassName" SIZE=30>
Defines the name of the Class to be retrieved. See <a href="EnumerateClassNames.html">Enumerate
Class Names</a> for a list of classes
<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>ShowMof
<input type="checkbox" name="ShowMof" value="ON">
If checked, the output shows the MOF reconstruction of the class also.<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>RETURN Results</h2>
<p>If successful, the return value is a single CIM Class.If unsuccessful, one of the
CIM status codes show below 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>
<LI>CIM_ERR_INVALID_NAMESPACE
<LI>CIM_ERR_INVALID_PARAMETER (including missing, duplicate,
unrecognized or otherwise incorrect parameters)
<LI>CIM_ERR_ACCESS_DENIED
<LI>CIM_ERR_INVALID_CLASS (the CIM Class does not exist in the
specified namespace)
<LI>CIM_ERR_NOT_FOUND (the CIM Class does exist, but the
requested CIM Instance does not exist in the specified namespace)
<LI>CIM_ERR_FAILED (some other unspecified error occurred)
</LI>
</UL>
<hr>
<h2>ADDITIONAL Description of Fields</h2>
<p><a name="LocalOnly"><b>LocalOnly</b></a> -
If the <TT>LocalOnly</TT> input parameter is true, this specifies that only CIM
Elements (properties, methods and qualifiers) overriden within the definition of
the Class are returned. If false, 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 PROPAGATED attribute).
<p><b><a name="IncludeQualifiers">IncludeQualifiers</a></b> -
If the <TT>IncludeQualifiers</TT> input parameter is true, this specifies that
all Qualifiers for that Class (including Qualifiers on the Class and on any
returned Properties, Methods or Method Parameters) MUST be included as <QUALIFIER>
elements in the response. If false no QUALIFIER elements are present in the
returned Class.<p><b><a name="IncludeClassOrigins">IncludeClassOrigin</a>s</b>
-
If the <TT>IncludeClassOrigin</TT> input parameter is true, this specifies that
the CLASSORIGIN attribute MUST be present on all appropriate elements in the returned
Class. If false, no CLASSORIGIN attributes are present in the returned Class.
<p><b><a name="PropertyList">PropertyList</a> - </b>If the <TT>PropertyList</TT> input parameter is not NULL, the members of the array
define one or more Property names. The returned Class MUST NOT include elements for any
Properties missing from this list. Note that if <TT>LocalOnly</TT> is specified as true this acts
as an additional filter on the set of Properties returned (for example, if Property A is
included in the <TT>PropertyList</TT> but <TT>LocalOnly</TT> is set to true and A is not local to the
requested Class, then it will not be included in the response). If the <TT>PropertyList</TT>
input parameter is an empty array this signifies that no Properties are included in
the response. If the PropertyList input parameter is NULL this specifies that all
Properties (subject to the conditions expressed by the other parameters) are included
in the response.
<p>If the <TT>PropertyList</TT> contains duplicate elements, the Server MUST ignore
the duplicates but otherwise process the request normally. If the PropertyList contains
elements which are invalid Property names for the target Class, the Server MUST ignore
such entries but otherwise process the request normally.
<hr>
<h2>C++ Pegasus API
</h2>
<pre>
virtual CIMClass getClass(
const String& nameSpace,
const String& className,
Boolean localOnly = true,
Boolean includeQualifiers = true,
Boolean includeClassOrigin = false,
const Array<String>& propertyList = StringArray()) = 0;
</pre>
<hr>
<p style="margin-top: 0; margin-bottom: 0"> <font size="2">Demonstration
Prepared by the OpenGroup Manageability Work Group Pegasus Development Team</font>
<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>)
for more information on Pegasus</font>
<p style="margin-top: 0; margin-bottom: 0"> <font size="1">Last Modified <!--webbot bot="Timestamp" S-Type="EDITED"
S-Format="%A, %B %d, %Y %I:%M:%S %p" startspan -->Friday, July 27, 2001 04:56:27 PM<!--webbot bot="Timestamp" i-CheckSum="54839" endspan -->
Copyright @ The Open Group 2001 </font>
<p>
</form>
<script>
document.GetClass.hostaddress.value = top.hostAddress;
document.GetClass.debug.value = top.debug;
document.GetClass.NameSpace.value = top.NameSpace;
window.focus();
</script>
</body>
</html>
| No CVS admin address has been configured |
Powered by ViewCVS 0.9.2 |