1 karl 1.1 <html>
2 <body bgcolor="#CCCCCC">
3 <table width="100%">
4 <tr>
|
5 karl 1.5 <td width="50%" align="bottom"><h1>Get Instance CIM Operation</h1><td>
6 <td width="50%" align="right">
|
7 karl 1.2 <img border=1 src="/pegasus/icons/OpenGroupLogo.gif
|
8 karl 1.5 ">
|
9 karl 1.1 </td>
10 </tr>
11 </table>
|
12 karl 1.3 <hr>
|
13 karl 1.5 <form name="GetInstance" METHOD=GET ACTION="/pegasus/cgi-bin/CGIClient">
|
14 karl 1.2 <INPUT TYPE="hidden" NAME="Operation" VALUE="GetInstance">
|
15 karl 1.7 <INPUT TYPE="hidden" NAME="hostaddress" VALUE="localhost:5988">
|
16 karl 1.2 <P>The <TT>GetInstance</TT> method returns a single CIM Instance from the target
|
17 karl 1.1 Namespace based on the InstanceName parameter provided.
18
|
19 karl 1.6 <p><b>NameSpace</b> <INPUT TYPE="text" NAME="NameSpace" SIZE=30 VALUE="root/cimv2">
|
20 karl 1.3 String that defines the target namespace. See <a href="getnamespaces.html">NameSpace
21 Operations</a> for more information
|
22 karl 1.1
|
23 karl 1.3 <p><b><a href="#InstanceName">InstanceName</a></b> <INPUT TYPE="text" NAME="InstanceName" SIZE=30>
24 Defines the Name of instance to be retrieved. See <a href="EnumerateInstanceNames.html">Enumerate
25 Instance Names</a> for instance names for a class
|
26 karl 1.1
|
27 karl 1.3 <p><b><a href="#LocalOnly">LocalOnly</a></b> <INPUT TYPE="checkbox" NAME="LocalOnly" VALUE="true" checked>
28 If true only CIM Elements overridden within definition of class are
29 returned.
30
31 <p><b><a href="#IncludeQualifiers">IncludeQualifiers</a></b> <INPUT TYPE="checkbox" NAME="IncludeQualifiers" VALUE="true">
32 If checked, show Qualifiers for class and returned Properties, Methods,
33 and Method Parameters.
34
35 <p><b><a href="#IncludeQualifiers">IncludeClassOrigins</a></b> <INPUT TYPE="checkbox" NAME="IncludeClassOrigins" VALUE="true">
36 .If checked (TRUE), CLASSORIGIN attribute will be returned for all
37 appropriate elements
38
39 <p><b><a href="#PropertyList">PropertyList</a> </b> <INPUT TYPE="text" NAME="PropertyList" SIZE=30 VALUE="NULL">
40 NOTE: <b> NOT IMPLEMENTED</b>. Null or array of property names to filter
41 request. <a href="#PropertyList">See below</a>.
42
43 <p><INPUT TYPE="submit" VALUE="Submit Request">
44 <INPUT TYPE="reset" VALUE="Reset Form">
45
|
46 karl 1.7 </form>
|
47 karl 1.3
|
48 karl 1.7 <hr>
|
49 karl 1.4
50 <h2>REQUEST RETURN</h2>
51
52 <p><b> </b>If successful, the return value is a single CIM
|
53 karl 1.3 Class.If unsuccessful, one of the following status codes MUST be returned by this
54 method, where the first applicable error in the list (starting with the first element of
55 the list, and working down) is the error returned. Any additional method- specific
56 interpretation of the error in is given in parentheses
57 <UL>
58 <LI>CIM_ERR_ACCESS_DENIED
59 <LI>CIM_ERR_NOT_SUPPORTED
60 <LI>CIM_ERR_INVALID_NAMESPACE
61 <LI>CIM_ERR_INVALID_PARAMETER (including missing, duplicate,
62 unrecognized or otherwise incorrect parameters)
63 <LI>CIM_ERR_NOT_FOUND (the CIM Class to be deleted does not exist)
64 <LI>CIM_ERR_CLASS_HAS_CHILDREN (the CIM Class has one or more subclasses
65 which cannot be deleted)
66 <LI>CIM_ERR_CLASS_HAS_INSTANCES (the CIM Class has one or more instances
67 which cannot be deleted)
68 <LI>CIM_ERR_FAILED (some other unspecified error occurred)
69 </UL>
70 <hr>
71
72 <h2>Additional Field Description</h2>
73
74 karl 1.3 <p><a name="InstanceName"><b>InstanceName</b></a> - ATTN:(Define Instance
75 Name in Detail)
76
77 <p><b><a name="LocalOnly">LocalOnly</a></b> -
|
78 karl 1.1 If the <TT>LocalOnly</TT> input parameter is true, this specifies that only CIM
79 Elements (properties, methods and qualifiers) overriden within the definition of
80 the Class are returned. If false, all elements are returned. This parameter
81 therefore effects a CIM Server-side mechanism to filter certain elements of the
82 returned object based on whether or not they have been propagated from the parent
83 Class (as defined by the PROPAGATED attribute).
84
|
85 karl 1.3 <p><b><a name="IncludeQualifiers">IncludeQualifiers</a></b> -
|
86 karl 1.1 If the <TT>IncludeQualifiers</TT> input parameter is true, this specifies that
87 all Qualifiers for that Class (including Qualifiers on the Class and on any
88 returned Properties, Methods or Method Parameters) MUST be included as <QUALIFIER>
89 elements in the response. If false no QUALIFIER elements are present in the
90 returned Class.
91
|
92 karl 1.3 <p><b><a name="IncludeClassOrigins">IncludeClassOrigins</a></b> -
|
93 karl 1.1 If the <TT>IncludeClassOrigin</TT> input parameter is true, this specifies that
94 the CLASSORIGIN attribute MUST be present on all appropriate elements in the returned
|
95 karl 1.3 Class. If false, no CLASSORIGIN attributes are present in the returned
96 Class
|
97 karl 1.1
|
98 karl 1.3 <p><b><a name="PropertyList">PropertyList</a></b> -
|
99 karl 1.1 If the <TT>PropertyList</TT> input parameter is not NULL, the members of the array
100 define one or more Property names. The returned Class MUST NOT include elements for any
101 Properties missing from this list. Note that if <TT>LocalOnly</TT> is specified as true this acts
102 as an additional filter on the set of Properties returned (for example, if Property A is
103 included in the <TT>PropertyList</TT> but <TT>LocalOnly</TT> is set to true and A is not local to the
104 requested Class, then it will not be included in the response). If the <TT>PropertyList</TT>
105 input parameter is an empty array this signifies that no Properties are included in
106 the response. If the PropertyList input parameter is NULL this specifies that all
107 Properties (subject to the conditions expressed by the other parameters) are included
108 in the response.
109 <p>If the <TT>PropertyList</TT> contains duplicate elements, the Server MUST ignore
110 the duplicates but otherwise process the request normally. If the PropertyList contains
111 elements which are invalid Property names for the target Class, the Server MUST ignore
112 such entries but otherwise process the request normally.
|
113 karl 1.4 <hr>
114 <h2>C++ Pegasus API</h2>
|
115 karl 1.1
|
116 karl 1.4 <pre>
117 virtual CIMInstance getInstance(
118 const String& nameSpace,
119 const CIMReference& instanceName,
120 Boolean localOnly = true,
121 Boolean includeQualifiers = false,
122 Boolean includeClassOrigin = false,
123 const Array<String>& propertyList = StringArray()) = 0;
124 </pre>
125 <hr><p style="margin-top: 0; margin-bottom: 0"> <font size="2">Demonstration
126 Prepared by the OpenGroup Manageability Work Group Pegasus Development Team</font>
127
128 <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>)
129 for more information on Pegasus</font>
130
131 <p style="margin-top: 0; margin-bottom: 0"> <font size="1">Last Modified <!--webbot bot="Timestamp" S-Type="EDITED"
|
132 karl 1.7 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 -->
|
133 karl 1.4 Copyright @ The Open Group 2001 </font>
|
134 karl 1.1
|
135 karl 1.5 <p>
136 </form>
137 <script>
|
138 karl 1.7 document.GetInstance.hostaddress.value = top.hostAddress;
139 document.GetInstance.debug.value = top.debug;
140 document.GetInstance.NameSpace.value = top.NameSpace;
141
|
142 karl 1.5 window.focus();
|
143 karl 1.6 </script>
|
144 karl 1.1 </body>
145 </html>
146
|
Return to
GetInstance.html
CVS log
Up to [Pegasus] / pegasus / cgi / htdocs