pegasus/cgi/htdocs/Attic/GetInstance.html - diff

Return to GetInstance.html CVS log

Up to [Pegasus] / pegasus / cgi / htdocs / Attic

Diff for /pegasus/cgi/htdocs/Attic/GetInstance.html between version 1.1 and 1.8

version 1.1, 2001/01/29 09:35:36

version 1.8, 2002/01/30 21:56:39

Line 2

<tr>

<td width="50%" align="bottom"><h1>GetClass Operation</h1><td>

<td width="50%" align="bottom"><h1>Get Instance CIM Operation</h1><td>

<img border=1 src="http://localhost/pegasus/icons/OpenGroupLogo.gif

<img border=1 src="/pegasus/icons/OpenGroupLogo.gif

</td>

</tr>

</table>

<hr>

<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.

<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 NameSpace 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">

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>

The InstanceName input parameter defines the name of the Class to be

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

Elements (properties, methods and qualifiers) overriden within the definition of

the Class are returned. If false, all elements are returned. This parameter

Line 30

Line 82

returned object based on whether or not they have been propagated from the parent

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

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>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

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

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

Line 58

Line 110

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 CIMInstance getInstance(

const String& nameSpace,

const CIMReference& instanceName,

Boolean localOnly = true,

Boolean includeQualifiers = false,

Boolean includeClassOrigin = false,

const CIMPropertyList& propertyList = CIMPropertyList());

</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 -->Wednesday, January 30, 2002 12:57:05 PM

<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>

document.GetInstance.hostaddress.value = top.hostAddress;

document.GetInstance.debug.value = top.debug;

document.GetInstance.NameSpace.value = top.NameSpace;

window.focus();

</script>

</body>

</html>

Legend:

Removed from v.1.1
changed lines
	Added in v.1.8

No CVS admin address has been configured