version 1.2, 2001/01/30 07:40:22
|
version 1.7, 2001/06/30 15:28:09
|
|
|
<body bgcolor="#CCCCCC"> | <body bgcolor="#CCCCCC"> |
<table width="100%"> | <table width="100%"> |
<tr> | <tr> |
<td width="50%" align="bottom"><h1>Get Instance Operation</h1><td> |
<td width="50%" align="bottom"><h1>Get Instance 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> |
<hr> |
<form METHOD=GET ACTION="/pegasus/cgi-bin/CGIClient"> |
<form name="GetInstance" METHOD=GET ACTION="/pegasus/cgi-bin/CGIClient"> |
<INPUT TYPE="hidden" NAME="Operation" VALUE="GetInstance"> | <INPUT TYPE="hidden" NAME="Operation" VALUE="GetInstance"> |
|
<INPUT TYPE="hidden" NAME="hostaddress" VALUE="localhost:5988"> |
<P>The <TT>GetInstance</TT> method returns a single CIM Instance from the target | <P>The <TT>GetInstance</TT> method returns a single CIM Instance from the target |
Namespace based on the InstanceName parameter provided. | Namespace based on the InstanceName parameter provided. |
| |
<p><b>NameSpace</b> <INPUT TYPE="text" NAME="NameSpace" SIZE=30 VALUE="root/cimv20"> |
<p><b>NameSpace</b> <INPUT TYPE="text" NAME="NameSpace" SIZE=30 VALUE="root/cimv2"> |
The <TT>NameSpace</TT> parameter is a string that defines the target namespace. |
String that defines the target namespace. See <a href="getnamespaces.html">NameSpace |
|
Operations</a> for more information |
|
|
|
<p><b><a href="#InstanceName">InstanceName</a></b> <INPUT TYPE="text" NAME="InstanceName" SIZE=30> |
|
Defines the Name of instance to be retrieved. See <a href="EnumerateInstanceNames.html">Enumerate |
|
Instance Names</a> for instance names for a class |
|
|
|
<p><b><a href="#LocalOnly">LocalOnly</a></b> <INPUT TYPE="checkbox" NAME="LocalOnly" VALUE="true" checked> |
|
If true only CIM Elements overridden within definition of class are |
|
returned. |
|
|
|
<p><b><a href="#IncludeQualifiers">IncludeQualifiers</a></b> <INPUT TYPE="checkbox" NAME="IncludeQualifiers" VALUE="true"> |
|
If checked, show Qualifiers for class and returned Properties, Methods, |
|
and Method Parameters. |
|
|
|
<p><b><a href="#IncludeQualifiers">IncludeClassOrigins</a></b> <INPUT TYPE="checkbox" NAME="IncludeClassOrigins" VALUE="true"> |
|
.If checked (TRUE), CLASSORIGIN attribute will be returned for all |
|
appropriate elements |
|
|
|
<p><b><a href="#PropertyList">PropertyList</a> </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><b>InstanceName</b> <INPUT TYPE="text" NAME="InstanceName" SIZE=30> |
<p><INPUT TYPE="submit" VALUE="Submit Request"> |
The <TT>InstanceName</TT> input parameter defines the name of the Class to be |
<INPUT TYPE="reset" VALUE="Reset Form"> |
retrieved. |
|
| |
<p><b>LocalOnly</b> <INPUT TYPE="checkbox" NAME="LocalOnly" VALUE="true" checked> |
</form> |
|
|
|
<hr> |
|
|
|
<h2>REQUEST RETURN</h2> |
|
|
|
<p><b> </b>If successful, the return value is a single CIM |
|
Class.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> |
|
<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_NOT_FOUND (the CIM Class to be deleted does not exist) |
|
<LI>CIM_ERR_CLASS_HAS_CHILDREN (the CIM Class has one or more subclasses |
|
which cannot be deleted) |
|
<LI>CIM_ERR_CLASS_HAS_INSTANCES (the CIM Class has one or more instances |
|
which cannot be deleted) |
|
<LI>CIM_ERR_FAILED (some other unspecified error occurred) |
|
</UL> |
|
<hr> |
|
|
|
<h2>Additional Field Description</h2> |
|
|
|
<p><a name="InstanceName"><b>InstanceName</b></a> - ATTN:(Define Instance |
|
Name in Detail) |
|
|
|
<p><b><a name="LocalOnly">LocalOnly</a></b> - |
If the <TT>LocalOnly</TT> input parameter is true, this specifies that only CIM | If the <TT>LocalOnly</TT> input parameter is true, this specifies that only CIM |
Elements (properties, methods and qualifiers) overriden within the definition of | Elements (properties, methods and qualifiers) overriden within the definition of |
the Class are returned. If false, all elements are returned. This parameter | the Class are returned. If false, all elements are returned. This parameter |
|
|
returned object based on whether or not they have been propagated from the parent | returned object based on whether or not they have been propagated from the parent |
Class (as defined by the PROPAGATED attribute). | Class (as defined by the PROPAGATED attribute). |
| |
<p><b>IncludeQualifiers</b> <INPUT TYPE="checkbox" NAME="IncludeQualifiers" VALUE="true"> |
<p><b><a name="IncludeQualifiers">IncludeQualifiers</a></b> - |
If the <TT>IncludeQualifiers</TT> input parameter is true, this specifies that | 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 | all Qualifiers for that Class (including Qualifiers on the Class and on any |
returned Properties, Methods or Method Parameters) MUST be included as <QUALIFIER> | returned Properties, Methods or Method Parameters) MUST be included as <QUALIFIER> |
elements in the response. If false no QUALIFIER elements are present in the | elements in the response. If false no QUALIFIER elements are present in the |
returned Class. | returned Class. |
| |
<p><b>IncludeClassOrigins</b> <INPUT TYPE="checkbox" NAME="IncludeClassOrigins" VALUE="true"> |
<p><b><a name="IncludeClassOrigins">IncludeClassOrigins</a></b> - |
If the <TT>IncludeClassOrigin</TT> input parameter is true, this specifies that | 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 | 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. |
Class. If false, no CLASSORIGIN attributes are present in the returned |
|
Class |
| |
<p><b>PropertyList </b> <INPUT TYPE="text" NAME="PropertyList" SIZE=30 VALUE="NULL"> |
<p><b><a name="PropertyList">PropertyList</a></b> - |
NOTE: <b> NOT IMPLEMENTED</b>. |
|
If the <TT>PropertyList</TT> input parameter is not NULL, the members of the array | 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 | 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 | Properties missing from this list. Note that if <TT>LocalOnly</TT> is specified as true this acts |
|
|
the duplicates but otherwise process the request normally. If the PropertyList contains | 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 | elements which are invalid Property names for the target Class, the Server MUST ignore |
such entries but otherwise process the request normally. | such entries but otherwise process the request normally. |
|
<hr> |
|
<h2>C++ Pegasus API</h2> |
| |
<p><INPUT TYPE="submit" VALUE="Submit Request"> |
<pre> |
|
virtual CIMInstance getInstance( |
|
const String& nameSpace, |
<INPUT TYPE="reset" VALUE="Reset Form"> |
const CIMReference& instanceName, |
|
Boolean localOnly = true, |
|
Boolean includeQualifiers = false, |
|
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, June 29, 2001 06:42:17 PM<!--webbot bot="Timestamp" i-CheckSum="55037" endspan --> |
|
Copyright @ The Open Group 2001 </font> |
| |
<p><b>RETURN - </b>If successful, the return value is a single CIM |
<p> |
Class.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> |
|
</form> | </form> |
|
<script> |
|
document.GetInstance.hostaddress.value = top.hostAddress; |
|
document.GetInstance.debug.value = top.debug; |
|
document.GetInstance.NameSpace.value = top.NameSpace; |
| |
|
window.focus(); |
|
</script> |
</body> | </body> |
</html> | </html> |
| |