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