1 karl 1.1 <html>
2 <body bgcolor="#CCCCCC">
3 <table width="100%">
4 <tr>
|
5 karl 1.3 <td width="50%" align="bottom"><h1>Get Instance CIM Operation</h1><td>
|
6 karl 1.1 <td width="50%" align="right">
|
7 karl 1.2 <img border=1 src="/pegasus/icons/OpenGroupLogo.gif
|
8 karl 1.1 ">
9 </td>
10 </tr>
11 </table>
|
12 karl 1.3 <hr>
|
13 karl 1.1 <form METHOD=GET ACTION="/pegasus/cgi-bin/CGIClient">
|
14 karl 1.2 <INPUT TYPE="hidden" NAME="Operation" VALUE="GetInstance">
15 <P>The <TT>GetInstance</TT> method returns a single CIM Instance from the target
|
16 karl 1.1 Namespace based on the InstanceName parameter provided.
17
18 <p><b>NameSpace</b> <INPUT TYPE="text" NAME="NameSpace" SIZE=30 VALUE="root/cimv20">
|
19 karl 1.3 String that defines the target namespace. See <a href="getnamespaces.html">NameSpace
20 Operations</a> for more information
|
21 karl 1.1
|
22 karl 1.3 <p><b><a href="#InstanceName">InstanceName</a></b> <INPUT TYPE="text" NAME="InstanceName" SIZE=30>
23 Defines the Name of instance to be retrieved. See <a href="EnumerateInstanceNames.html">Enumerate
24 Instance Names</a> for instance names for a class
|
25 karl 1.1
|
26 karl 1.3 <p><b><a href="#LocalOnly">LocalOnly</a></b> <INPUT TYPE="checkbox" NAME="LocalOnly" VALUE="true" checked>
27 If true only CIM Elements overridden within definition of class are
28 returned.
29
30 <p><b><a href="#IncludeQualifiers">IncludeQualifiers</a></b> <INPUT TYPE="checkbox" NAME="IncludeQualifiers" VALUE="true">
31 If checked, show Qualifiers for class and returned Properties, Methods,
32 and Method Parameters.
33
34 <p><b><a href="#IncludeQualifiers">IncludeClassOrigins</a></b> <INPUT TYPE="checkbox" NAME="IncludeClassOrigins" VALUE="true">
35 .If checked (TRUE), CLASSORIGIN attribute will be returned for all
36 appropriate elements
37
38 <p><b><a href="#PropertyList">PropertyList</a> </b> <INPUT TYPE="text" NAME="PropertyList" SIZE=30 VALUE="NULL">
39 NOTE: <b> NOT IMPLEMENTED</b>. Null or array of property names to filter
40 request. <a href="#PropertyList">See below</a>.
41
42 <p><INPUT TYPE="submit" VALUE="Submit Request">
43 <INPUT TYPE="reset" VALUE="Reset Form">
44
45 <hr>
46
47 karl 1.3 <p><b>REQUEST RETURN - </b>If successful, the return value is a single CIM
48 Class.If unsuccessful, one of the following status codes MUST be returned by this
49 method, where the first applicable error in the list (starting with the first element of
50 the list, and working down) is the error returned. Any additional method- specific
51 interpretation of the error in is given in parentheses
52 <UL>
53 <LI>CIM_ERR_ACCESS_DENIED
54 <LI>CIM_ERR_NOT_SUPPORTED
55 <LI>CIM_ERR_INVALID_NAMESPACE
56 <LI>CIM_ERR_INVALID_PARAMETER (including missing, duplicate,
57 unrecognized or otherwise incorrect parameters)
58 <LI>CIM_ERR_NOT_FOUND (the CIM Class to be deleted does not exist)
59 <LI>CIM_ERR_CLASS_HAS_CHILDREN (the CIM Class has one or more subclasses
60 which cannot be deleted)
61 <LI>CIM_ERR_CLASS_HAS_INSTANCES (the CIM Class has one or more instances
62 which cannot be deleted)
63 <LI>CIM_ERR_FAILED (some other unspecified error occurred)
64 </UL>
65 <hr>
66
67 <h2>Additional Field Description</h2>
68 karl 1.3
69 <p><a name="InstanceName"><b>InstanceName</b></a> - ATTN:(Define Instance
70 Name in Detail)
71
72 <p><b><a name="LocalOnly">LocalOnly</a></b> -
|
73 karl 1.1 If the <TT>LocalOnly</TT> input parameter is true, this specifies that only CIM
74 Elements (properties, methods and qualifiers) overriden within the definition of
75 the Class are returned. If false, all elements are returned. This parameter
76 therefore effects a CIM Server-side mechanism to filter certain elements of the
77 returned object based on whether or not they have been propagated from the parent
78 Class (as defined by the PROPAGATED attribute).
79
|
80 karl 1.3 <p><b><a name="IncludeQualifiers">IncludeQualifiers</a></b> -
|
81 karl 1.1 If the <TT>IncludeQualifiers</TT> input parameter is true, this specifies that
82 all Qualifiers for that Class (including Qualifiers on the Class and on any
83 returned Properties, Methods or Method Parameters) MUST be included as <QUALIFIER>
84 elements in the response. If false no QUALIFIER elements are present in the
85 returned Class.
86
|
87 karl 1.3 <p><b><a name="IncludeClassOrigins">IncludeClassOrigins</a></b> -
|
88 karl 1.1 If the <TT>IncludeClassOrigin</TT> input parameter is true, this specifies that
89 the CLASSORIGIN attribute MUST be present on all appropriate elements in the returned
|
90 karl 1.3 Class. If false, no CLASSORIGIN attributes are present in the returned
91 Class
|
92 karl 1.1
|
93 karl 1.3 <p><b><a name="PropertyList">PropertyList</a></b> -
|
94 karl 1.1 If the <TT>PropertyList</TT> input parameter is not NULL, the members of the array
95 define one or more Property names. The returned Class MUST NOT include elements for any
96 Properties missing from this list. Note that if <TT>LocalOnly</TT> is specified as true this acts
97 as an additional filter on the set of Properties returned (for example, if Property A is
98 included in the <TT>PropertyList</TT> but <TT>LocalOnly</TT> is set to true and A is not local to the
99 requested Class, then it will not be included in the response). If the <TT>PropertyList</TT>
100 input parameter is an empty array this signifies that no Properties are included in
101 the response. If the PropertyList input parameter is NULL this specifies that all
102 Properties (subject to the conditions expressed by the other parameters) are included
103 in the response.
104 <p>If the <TT>PropertyList</TT> contains duplicate elements, the Server MUST ignore
105 the duplicates but otherwise process the request normally. If the PropertyList contains
106 elements which are invalid Property names for the target Class, the Server MUST ignore
107 such entries but otherwise process the request normally.
108
|
109 karl 1.3 <p>
|
110 karl 1.1 </form>
111
112 </body>
113 </html>
114
|