Hp StorageWorks 2000 Family Modular Smart Array CLI reference guide (481600-002, May 2008)

Chapter 1 Using the CLI 21
Elements and attributes of the DTD are described in the following table.
Element Description and Attributes
RESPONSE The RESPONSE is the top level XML object. The request attributes
contain the details of the request that was sent. The RESPONSE is a
container for objects that are returned as part of the request.
All commands have a status object as part of the RESPONSE which
provides a message and return code. A return code of 0 indicates that the
command was successful. Any other return code is an error code.
OBJECT The OBJECT element is a container for properties. Each OBJECT also
has attributes which describe the OBJECT characteristics.
• oid (Object Identifier) - A unique number per request which identifies
the OBJECT within a response. This number is used as a reference in
associations that the response may contain.
• name - The class name of the object.
• basetype - The generic class name of the object. This is used to
distinguish between differing types of objects within a response. A
response can contain a number of volumes all of which may be of
different classes (standard volumes, snap-pools, snapshots, etc.). The
response also contains a status object. The basetype indicates which
object is a volume and which object is a status object.
PROPERTY The PROPERTY element provides the detailed information for each
OBJECT. The element value is the actual data content to be used. The
attributes provide further details on how to interpret the data.
• display-name - The suggested label to use in a user interface for
the data value.
• raw - Indicates whether or not a value should be displayed to a user. If
this value is false, the value might apply only to a programmatic
interface which can use the value for calculations.
• size - The number of columns to use to display the value.
• type - The type that the data should be interpreted as.
• key - Indicates whether or not this values can be used as a key to other
commands.
• name - The name of the property. The name attribute is used for
unique identification within an object.
COMP The composition element gives the association between a grouping object
and a part of object. This provides a description of the hierarchy of the
objects that are part of the response.
• P - The part component oid.
• G - The grouping component oid.