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