pegasus/cgi/htdocs/EnumerateInstanceNames.html - annotate

Return to EnumerateInstanceNames.html CVS log

Up to [Pegasus] / pegasus / cgi / htdocs

1 karl 1.1 <html> 2 <body bgcolor="#CCCCCC"> 3 <table width="100%"> 4 <tr>
5 karl 1.6 <td width="50%" align="bottom"><h1>Enumerate Instance Names CIM Operation</h1><td> 6 <td width="50%" align="right"> 7 <img border=1 src="/pegasus/icons/OpenGroupLogo.gif">
8 karl 1.1 </td> 9 </tr> 10 </table>
11 karl 1.3 <hr>
12 karl 1.6 <form name="EnumerateInstanceNames" METHOD=GET ACTION="/pegasus/cgi-bin/CGIClient">
13 karl 1.1 <INPUT TYPE="hidden" NAME="Operation" VALUE="EnumerateInstanceNames">
14 karl 1.6 <input type="hidden" name="hostip" value="localhost">
15 karl 1.7 <input type="hidden" name="portnum" value="5988">
16 karl 1.3 <p> 17 18 <a name="TOP"></a> 19 20 The <TT>enumerateInstances</TT> method enumerates instances of a CIM 21 Class in the target Namespace. 22 <p><b><a href="#NameSpace">NameSpace</a></b>
23 karl 1.7 <INPUT TYPE="text" NAME="NameSpace" SIZE=30 VALUE="root/cimv2">  String that defines the target namespace. See <a href="getnamespaces.html">NameSpace
24 karl 1.3 Operations</a> for more information. 25 <p><b><a href="#ClassName">ClassName</a></b> <INPUT TYPE="text" NAME="ClassName" SIZE=30>   Defines 26 name of the Class 27 for which instance names are to be retrieved.  This must be a legal 28 class in the repository
29 karl 1.6 <p><b>LocalOnly</b> <INPUT TYPE="checkbox" NAME="LocalOnly" VALUE="true" checked>                        30 If true only CIM Elements overridden within definition of class are
31 karl 1.3 returned.
32 karl 1.6 <p><b>IncludeQualifiers</b> <INPUT TYPE="checkbox" NAME="IncludeQualifiers" VALUE="true">             33 If checked, show Qualifiers for class and returned Properties, Methods,
34 karl 1.3 and Method Parameters.
35 karl 1.6 <p><b>IncludeClassOrigins</b> <INPUT TYPE="checkbox" NAME="IncludeClassOrigins" VALUE="true">        36 If checked (TRUE), CLASSORIGIN attribute will be returned for all
37 karl 1.3 appropriate elements<p><b>PropertyList </b> <INPUT TYPE="text" NAME="PropertyList" SIZE=30 VALUE="NULL"> 38 NOTE: <b> NOT IMPLEMENTED </b>Null or array of property names to filter 39 request. <a href="#PropertyList">See below</a>. 40 <p><INPUT TYPE="submit" VALUE="Submit Request">           41 <INPUT TYPE="reset" VALUE="Reset">
42 karl 1.1 </form>
43 karl 1.6 <script> 44 EnumerateInstanceNames.hostip.value = opener.top.hostip; 45 EnumerateInstanceNames.portnum.value = opener.top.portnum; 46 window.focus();
47 karl 1.7 </script>
48 karl 1.3 49 <hr>
50 karl 1.6 <h2>RETURN</h2>
51 karl 1.3 If successful, the method returns zero or more named 52 Instances that meet the required criteria. 53 54 If unsuccessful, one of the following status codes MUST be returned 55 by this method, where the first applicable error in the list (starting 56 with the first element of the list, and working down) is the error 57 returned. Any additional method-specific interpretation of the error in 58 is given in parentheses. 59 60 <UL> 61 <LI>CIM_ERR_ACCESS_DENIED 62 <LI>CIM_ERR_NOT_SUPPORTED 63 <LI>CIM_ERR_INVALID_NAMESPACE  64 <LI>CIM_ERR_INVALID_PARAMETER (including missing, 65 duplicate, unrecognized or otherwise incorrect parameters) 66 <LI>CIM_ERR_INVALID_CLASS (the CIM Class that is the 67 basis for this enumeration does not exist)
68 karl 1.5 <LI>CIM_ERR_FAILED (some other unspecified error occurred)</LI>
69 karl 1.3 </UL> 70 <hr> 71 <h2>Additional Information</h2> 72 <p><b><a name="NameSpace">NameSpace</a></b> The NameSpace parameter is a string that defines the target 73 namespace.  74 <p><b><a name="ClassName"> 75 76 ClassName</a></b> The ClassName input parameter defines the Class that is the 77 basis for the enumeration. The ClassName input must be in the 78 repository  79 <p><a name="LocalOnly"><b>
80 karl 1.4
81 karl 1.3 LocalOnly</b></a>  If the <TT>LocalOnly</TT> input parameter is 82 <TT>true</TT>, this specifies that, for each returned Instance, 83 only elements (properties and qualifiers) overridden within the 84 definition of that Instance are included. If <TT>false</TT>, 85 all elements are returned. This parameter therefore effects a CIM 86 Server-side mechanism to filter certain elements of the returned object 87 based on whether or not they have been propagated from the parent 88 Class (as defined by the <TT>PROPAGATED</TT> attribute).
89 karl 1.4
90 karl 1.3 <p><a name="DeepInheritance"><b>DeepInheritance</b></a> If the <TT>DeepInheritance</TT> input 91 parameter is <TT>true</TT>, this specifies that, for each 92 returned Instance of the Class, all properties of the Instance MUST 93 be present (subject to constraints imposed by the other 94 parameters), including any which were added by subclassing the specified 95 Class. If <TT>false</TT>, each returned Instance includes only 96 properties defined for the specified Class.
97 karl 1.4
98 karl 1.3 <p><a name="IncludeQualifiers"><b>IncludeQualifiers</b></a> If the <TT>IncludeQualifiers</TT> input 99 parameter is <TT>true</TT>, this specifies that all Qualifiers 100 for each Instance (including Qualifiers on the Instance 101 and on any returned Properties) MUST be included as 102 <TT>QUALIFIER</TT> elements in the response. If false no 103 <TT>QUALIFIER</TT> elements are present in each 104 returned Instance.
105 karl 1.4
106 karl 1.3 <p><b><a name="IncludeClassOrigin">IncludeClassOrigin</a></b>  If the <TT>IncludeClassOrigin</TT> input 107 parameter is <TT>true</TT>, this specifies that the 108 <TT>CLASSORIGIN</TTT> attribute MUST be present on all appropriate 109 elements in each returned Instance. If false, no 110 <TT>CLASSORIGIN</TT> attributes are present in each returned 111 Instance.</tt>
112 karl 1.4
113 karl 1.3 <p>PropertyList If the <TT>PropertyList</TT> input parameter is not 114 <TT>NULL</TT>, the members of the array define one or more Property 115 names.  Each returned Instance MUST NOT include elements 116 for any Properties missing from this list.  Note that if 117 <TT>LocalOnly</TT> is specified as <TT>true</TT> (or 118 <TT>DeepInheritance</TT> is specified as <TT>false</TT>) this acts as an 119 additional filter on the set of Properties returned (for example, 120 if Property <TT>A</TT> is included in the 121 <TT>PropertyList</TT> but <TT>LocalOnly</TT> is set to true and 122 <TT>A</TT> is not local to a returned Instance, then it will not be 123 included in that Instance). If the <TT>PropertyList</TT> input parameter 124 is an empty array this signifies that no Properties are included in each 125 returned Instance. If the <TT>PropertyList</TT> input parameter is 126 NULL this specifies that all Properties (subject to the conditions 127 expressed by the other parameters) are included in each returned 128 Instance. 129 130 If the <TT>PropertyList</TT> contains duplicate elements, 131 the Server MUST ignore the duplicates but otherwise process the request 132 normally.  If the <TT>PropertyList</TT> contains elements which are 133 invalid Property names for any target Instance, the Server MUST 134 karl 1.3 ignore such entries but otherwise process the request normally. 135 136 137
138 karl 1.4 139 <p><a href="#TOP">Go To Top</a>
140 karl 1.3 <hr> 141 <h2>C++ Call</h2>
142 karl 1.4
143 karl 1.3 <PRE> 144 virtual Array<InstanceDecl> enumerateInstances( 145 const String& nameSpace, 146 const String& className, 147 Boolean deepInheritance = true, 148 Boolean localOnly = true, 149 Boolean includeQualifiers = false, 150 Boolean includeClassOrigin = false,
151 karl 1.5 const Array<String>& propertyList = _getStringArray()) = 0; 152 </PRE> 153 <hr><p style="margin-top: 0; margin-bottom: 0"> <font size="2">Demonstration 154 Prepared by the OpenGroup Manageability Work Group Pegasus Development Team</font> 155 156 <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>) 157 for more information on Pegasus</font> 158 159 <p style="margin-top: 0; margin-bottom: 0"> <font size="1">Last Modified <!--webbot bot="Timestamp" S-Type="EDITED" 160 S-Format="%A, %B %d, %Y %I:%M:%S %p" startspan -->Monday, March 26, 2001 05:01:59 PM<!--webbot bot="Timestamp" i-CheckSum="50769" endspan -->      161 Copyright @ The Open Group 2001 </font>
162 karl 1.3
163 karl 1.5 <PRE> </PRE>
164 karl 1.1 </body> 165 </html>
166 karl 1.3

No CVS admin address has been configured