2.3.2.11. EnumerateInstances

2.3.2.11. EnumerateInstances

This operation is used to enumerate instances of a CIM Class (this includes instances in the class and any subclasses in accordance with the polymorphic nature of CIM objects) in the target Namespace.

この操作はターゲット名前空間でCIMクラス(これはCIMクラスの多系性質に従ってサブクラスを含みます。)のインスタンスを列挙するために使用します。

EnumerateInstances
<namedInstance>*EnumerateInstances ( 
        [IN] <className> ClassName, 
        [IN,OPTIONAL] boolean LocalOnly = true,  (DEPRECATED)
        [IN,OPTIONAL] boolean DeepInheritance = true, 
        [IN,OPTIONAL] boolean IncludeQualifiers = false,  (DEPRECATED)
        [IN,OPTIONAL] boolean IncludeClassOrigin = false, 
        [IN,OPTIONAL,NULL] string PropertyList [] = NULL 
)

The ClassName input parameter defines the Class that is the basis for the enumeration.

入力パラメータのClassNameは列挙の基礎のクラスを定義します。

DEPRECATION NOTE: With the 1.2 release of this specification, the LocalOnly parameter is DEPRECATED. LocalOnly filtering, as defined in 1.1, will not be supported in the next major revision of this specification. In the 1.1 version of this specification, the definition of the LocalOnly parameter was incorrectly modified. This change introduced a number of interoperability and backward compatibility problems for CIM Clients using the LocalOnly parameter to filter the set of Properties returned. The DMTF strongly recommends that CIM Clients set LocalOnly = false and do not rely on the use of this parameter to filter the set of Properties returned. To minimize the impact of implementing this recommendation on CIM Clients, a CIM Server MAY choose to treat the value of the LocalOnly parameter as FALSE for all requests. A CIM Server MUST consistently support a single interpretation of the LocalOnly parameter. Refer to Appendix C for additional details.

非難注:この仕様の1.2の発散で、LocalOnlyパラメータは、DEPRECATEDです。1.1で定められるように、LocalOnlyろ過はこの仕様の次の大きな改訂において支持されません。この仕様の1.1のバージョンにおいて、LocalOnlyパラメータの定義は、誤って修正されました。この変化はいくつかのインターオペラビリティを導入しました、そして、PropertiesのセットにフィルターをかけるためにLocalOnlyパラメータを使っているCIM Clientsのための旧版互換性問題は戻りました。DMTFは、CIM ClientsがLocalOnly =を間違ったように設定して、返されるPropertiesのセットにフィルターをかけるためにこのパラメータの使用に頼らないよう強く勧めます。CIM Clients(Server MAYがLocalOnlyパラメータの価値を全ての要請のためのFALSEとみなすために選ぶCIM)の上でこの推薦を実行することの影響を最小にすること。A CIM Server MUSTは、一貫してLocalOnlyパラメータの一回の解釈を支持します。さらなる詳細のために付録Cを参照してください。

If the DeepInheritance input parameter is true, this specifies that, for each returned Instance of the Class, all properties of the Instance MUST be present (subject to constraints imposed by the other parameters), including any which were added by subclassing the specified Class. If false, each returned Instance includes only properties defined for the specified Class.

DEPRECATION NOTE: The use of the IncludeQualifiers parameter is DEPRECATED and it may be removed in a future version of this specification. The IncludeQualifiers parameter definition is ambiguous and when set to true CIM Clients can not be assured of any qualifiers being returned. A CIM Client SHOULD always set this parameter to false. To minimize the impact of implementing this recommendation on CIM Clients, a CIM Server MAY choose to treat the value of the IncludeQualifiers parameter as FALSE for all requests. The preferred behavior is to use the class operations to receive qualifier information and not depend on any qualifiers existing in this response. If the IncludeQualifiers input parameter is true, this specifies that all Qualifiers for that Instance (including Qualifiers on the Instance and on any returned Properties) MUST be included as <QUALIFIER> elements in the response. If false no <QUALIFIER> elements are present in the returned Instance.

If the IncludeClassOrigin input parameter is true, this specifies that the CLASSORIGIN attribute MUST be present on all appropriate elements in each returned Instance. If false, no CLASSORIGIN attributes are present in each returned Instance.

If the PropertyList input parameter is not NULL, the members of the array define one or more Property names of the designated class. This may include inherited Property names or Property names explicitly defined in the designated class, but MAY NOT include Property names defined in subclasses of the designated class. Each returned Instance MUST NOT include elements for any Properties missing from this list. Note that the PropertyList parameter acts as an additional filter on the Properties defined by the LocalOnly and DeepInheritance input parameters; if the PropertyList includes a Property that is not in the set defined by the LocalOnly and DeepInheritance combination, the element for the Property MUST NOT be returned. If the PropertyList input parameter is an empty array this signifies that no elements for Properties are included in the returned Instances. If the PropertyList input parameter is NULL, no additional filtering is defined by this parameter.

If the PropertyList contains duplicate elements, the Server MUST ignore the duplicates but otherwise process the request normally. If the PropertyList contains elements which are invalid Property names for any target Instance, the Server MUST ignore such entries but otherwise process the request normally.

If successful, the method returns zero or more named Instances that meet the required criteria.

If unsuccessful, one of the following status codes MUST be returned by this method, where the first applicable error in the list (starting with the first element of the list, and working down) is the error returned. Any additional method-specific interpretation of the error in is given in parentheses.

  • CIM_ERR_ACCESS_DENIED
  • CIM_ERR_NOT_SUPPORTED
  • CIM_ERR_INVALID_NAMESPACE
  • CIM_ERR_INVALID_PARAMETER (including missing, duplicate, unrecognized or otherwise incorrect parameters)
  • CIM_ERR_INVALID_CLASS (the CIM Class that is the basis for this enumeration does not exist)
  • CIM_ERR_FAILED (some other unspecified error occurred)

タグ:

+ タグ編集
  • タグ:
最終更新:2007年06月03日 17:07