(file) Return to GetInstance.html CVS log (file) (dir) Up to [Pegasus] / pegasus / cgi / htdocs

File: [Pegasus] / pegasus / cgi / htdocs / Attic / GetInstance.html (download) / (as text)
Revision: 1.10, 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.9: +0 -0 lines
FILE REMOVED
BUG#: 7860
TITLE: pegasus/cgi directory is obsolete
DESCRIPTION: Remove unused files.

<html>
<head>
<script>
	function rTrim(tempStr){
                     while( tempStr.lastIndexOf(' ') == tempStr.length-1 && tempStr.length > 0 )
                     { 
                         tempStr = tempStr.substring(0,tempStr.length-1) 
                     }
                     document.GetInstance.InstanceName.value = tempStr;
	}
</script>
</head>
  <body bgcolor="#CCCCCC">
    <table width="100%">
      <tr>
	<td width="50%" align="bottom"><h1>Get Instance CIM Operation</h1><td>
	<td width="50%" align="right">
	  <img border=1 src="/pegasus/icons/OpenGroupLogo.gif
	  ">
        </td>
      </tr>
    </table>
    <hr>
    <form name="GetInstance" METHOD=GET ACTION="/pegasus/cgi-bin/CGIClient">
      <INPUT TYPE="hidden" NAME="Operation" VALUE="GetInstance">
      <INPUT TYPE="hidden" NAME="hostaddress" VALUE="localhost:5988">
      <INPUT TYPE="hidden" NAME="debug" VALUE="">
	  <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/cimv2">
      String that defines the target namespace. See <a href="enumeratenamespaces.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>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
      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">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
      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">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
      .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><INPUT TYPE="submit" VALUE="Submit Request" onClick="rTrim(document.GetInstance.InstanceName.value);"> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
      &nbsp;&nbsp;&nbsp;&nbsp; <INPUT TYPE="reset" VALUE="Reset Form">

	</form>

    <hr>

      <h2>REQUEST RETURN</h2>

      <p><b>&nbsp;</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
      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">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

      <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 CIMInstance getInstance(
	const String&amp; nameSpace,
	const CIMReference&amp; instanceName,
	Boolean localOnly = true,
	Boolean includeQualifiers = false,
	Boolean includeClassOrigin = false,
	const CIMPropertyList&amp; 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<!--webbot bot="Timestamp" i-CheckSum="19833" endspan -->&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
     Copyright @ The Open Group 2001&nbsp;</font>

      <p>
	</form>
   <script>
       document.GetInstance.hostaddress.value = top.hostAddress;
       document.GetInstance.debug.value = top.debug;
       document.GetInstance.NameSpace.value = top.NameSpace;

   window.focus();
   </script>
  </body>
</html>


No CVS admin address has been configured
Powered by
ViewCVS 0.9.2