Package pywbem :: Module cim_xml

[frames] | no frames]

# Module cim_xml

source code

Functions to create XML documens and elements conforming to the DMTF standard DSP0201, Representation of CIM in XML, v2.2.

> http://www.dmtf.org/standards/wbem/DSP201.html http://www.dmtf.org/standards/published_documents/DSP201.pdf

Elements generated by this module should conform to version 2.2 of the DTD:

> http://www.dmtf.org/standards/wbem/CIM_DTD_V22.dtd

There should be one class for each element described in the DTD. The constructors take builtin Python types, or other cim_xml classes where child elements are required.

Every class is a subclass of the Element class and so shares the same attributes and methods, and can be used with the built-in Python XML handling routines. In particular you can call the toxml() and toprettyxml() methods to generate XML.

Note that converting using toprettyxml() inserts whitespace which may corrupt the data in the XML (!!) so you should only do this when displaying to humans who can ignore it, and never for computers. XML always passes through all non-markup whitespace.

Classes
| CIMElement A base class that has a few bonus helper methods.
| CIM The CIM element is the root element of every XML Document that is valid with respect to this schema.
| DECLARATION The DECLARATION element defines a set of one or more declarations of CIM objects.
| DECLGROUP The DECLGROUP element defines a logical set of CIM Class, Instance and Qualifier declarations.
| DECLGROUP_WITHNAME The DECLGROUP.WITHNAME element defines a logical set of CIM Class, Instance and Qualifier declarations.
| DECLGROUP_WITHPATH The DECLGROUP.WITHPATH element defines a logical set of CIM Class and Instance declarations.
| QUALIFIER_DECLARATION The QUALIFIER.DECLARATION element defines a single CIM Qualifier declaration.
| SCOPE The SCOPE element defines the scope of a QUALIFIER.DECLARATION in the case that there are restrictions on the scope of the Qualifier declaration.
| VALUE The VALUE element is used to define a single (non-array and non-reference) CIM Property value, CIM Qualifier value, or a CIM Method Parameter value.
| VALUE_ARRAY The VALUE.ARRAY element is used to represent the value of a CIM Property or Qualifier that has an array type.
| VALUE_REFERENCE The VALUE.REFERENCE element is used to define a single CIM reference Property value.
| VALUE_REFARRAY The VALUE.REFARRAY element is used to represent the value of an array of CIM references.
| VALUE_OBJECT The VALUE.OBJECT element is used to define a value which is comprised of a single CIM Class or Instance definition.
| VALUE_NAMEDINSTANCE The VALUE.NAMEDINSTANCE element is used to define a value which is comprised of a single named CIM Instance definition.
| VALUE_NAMEDOBJECT The VALUE.NAMEDOBJECT element is used to define a value which is comprised of a single named CIM Class or Instance definition.
| VALUE_OBJECTWITHLOCALPATH The VALUE.OBJECTWITHLOCALPATH element is used to define a value which is comprised of a single CIM Object (Class or Instance) definition with additional information that defines the local path to that Object.
| VALUE_OBJECTWITHPATH The VALUE.OBJECTWITHPATH element is used to define a value which is comprised of a single CIM Object (Class or Instance) definition with additional information that defines the absolute path to that Object.
| VALUE_NULL The VALUE.NULL element is used to represent a TABLECELL that has no assigned value.
| NAMESPACEPATH The NAMESPACEPATH element is used to define a Namespace Path.
| LOCALNAMESPACEPATH The LOCALNAMESPACEPATH element is used to define a local Namespace path (one without a Host component).
| HOST The HOST element is used to define a single Host.
| NAMESPACE The NAMESPACE element is used to define a single Namespace component of a Namespace path.
| CLASSPATH The CLASSPATH element defines the absolute path to a CIM Class.
| LOCALCLASSPATH The LOCALCLASSPATH element defines the a local path to a CIM Class.
| CLASSNAME The CLASSNAME element defines the qualifying name of a CIM Class.
| INSTANCEPATH The INSTANCEPATH element defines the absolute path to a CIM Instance.
| LOCALINSTANCEPATH The LOCALINSTANCEPATH element defines the local path to a CIM Instance.
| INSTANCENAME The INSTANCENAME element defines the location of a CIM Instance within a Namespace (it is referred to in the CIM Specification as a Model Path).
| OBJECTPATH The OBJECTPATH element is used to define a full path to a single CIM Object (Class or Instance).
| KEYBINDING The KEYBINDING element defines a single key property value binding.
| KEYVALUE The KEYVALUE element defines a single property key value when the key property is a non-reference type.
| CLASS The CLASS element defines a single CIM Class.
| INSTANCE The INSTANCE element defines a single CIM Instance of a CIM Class.
| QUALIFIER The QUALIFIER element defines a single CIM Qualifier.
| PROPERTY The PROPERTY element defines a single (non-array) CIM Property that is not a reference.
| PROPERTY_ARRAY The PROPERTY.ARRAY element defines a single CIM Property with an array type.
| PROPERTY_REFERENCE The PROPERTY.REFERENCE element models a single CIM Property with reference semantics.
| METHOD The METHOD element defines a single CIM Method.
| PARAMETER The PARAMETER element defines a single (non-array, non-reference) Parameter to a CIM Method.
| PARAMETER_REFERENCE The PARAMETER.REFERENCE element defines a single reference Parameter to a CIM Method.
| PARAMETER_ARRAY The PARAMETER.ARRAY element defines a single Parameter to a CIM Method that has an array type.
| PARAMETER_REFARRAY The PARAMETER.REFARRAY element defines a single Parameter to a CIM Method that has an array of references type.
| TABLECELL_DECLARATION The TABLECELL.DECLARATION element describes a TABLECELL that is not a reference or an array of references.
| TABLECELL_REFERENCE The TABLECELL.REFERENCE element defines a TABLECELL that contains reference or reference array values.
| TABLEROW_DECLARATION The TABLEROW.DECLARATION element contains a definition for each TABLECELL in the TABLEROW.
| TABLE The TABLE element defines the result of a CIM Query.
| TABLEROW The TABLEROW element defines the values for a single row of a table.
| MESSAGE The MESSAGE element models a single CIM message.
| MULTIREQ The MULTIREQ element defines a Multiple CIM Operation request.
| MULTIEXPREQ The MULTIEXPREQ element defines a Multiple CIM Export request.
| SIMPLEREQ The SIMPLEREQ element defines a Simple CIM Operation request.
| SIMPLEEXPREQ The SIMPLEEXPREQ element defines a Simple CIM Export request.
| IMETHODCALL The IMETHODCALL element defines a single intrinsic method invocation.
| METHODCALL The METHODCALL element defines a single method invocation on a Class or Instance.
| EXPMETHODCALL The EXPMETHODCALL element defines a single export method invocation.
| PARAMVALUE The PARAMVALUE element defines a single extrinsic method named parameter value.
| IPARAMVALUE The IPARAMVALUE element defines a single intrinsic method named parameter value.
| EXPPARAMVALUE The EXPPARAMVALUE element defines a single export method named parameter value.
| MULTIRSP The MULTIRSP element defines a Multiple CIM Operation response.
| MULTIEXPRSP The MULTIEXPRSP element defines a Multiple CIM Export response.
| SIMPLERSP The SIMPLERSP element defines a Simple CIM Operation response.
| SIMPLEEXPRSP The SIMPLEEXPRSP element defines a Simple CIM Export response.
| METHODRESPONSE The METHODRESPONSE defines the response to a single CIM extrinsic method invocation.
| EXPMETHODRESPONSE The EXPMETHODRESPONSE defines the response to a single export method invocation.
| IMETHODRESPONSE The IMETHODRESPONSE defines the response to a single intrinsic CIM method invocation.
| ERROR The ERROR element is used to define a fundamental error which prevented a method from executing normally.
| RETURNVALUE The RETURNVALUE element specifies the value returned from an extrinsic method call.
| IRETURNVALUE The IRETURNVALUE element specifies the value returned from an intrinsic method call.
| RESPONSEDESTINATION The RESPONSEDESTINATION element contains an instance that describes the desired destination for the response.
| SIMPLEREQACK The SIMPLEREQACK defines the acknowledgement response to a Simple CIM Operation asynchronous request.