CLI Guide

The output of each CLI command is composed of valid XML data until the CLI prompt (typically #) is encountered. The output contains a
valid XML header followed by the XML elements described in the following table.
Table 1. XML API elements
Element Description and attributes
RESPONSE The RESPONSE element is the top-level element, which contains all data output for the CLI command
that was issued. The response includes:
• A number of OBJECT elements, which varies by command.
• A status object that provides a message and return code. A return code of 0 indicates that the
command succeeded. Any other return code is an error code.
There is only one RESPONSE element per issued command.
OBJECT In general, an OBJECT element describes a storage-system component such as a disk or a volume. An
object has these attributes:
• basetype: This attribute allows output in brief mode to be correlated with metadata to reduce
the overhead of each command, as described in XML API optimization. This is also a good field to
use to detect the type of the object (e.g., a disk, a volume, etc.).
• name: The name of the object.
• oid: The unique identifier for the object in the scope of the response.
The OBJECT element can contain PROPERTY elements.
PROPERTY A PROPERTY element provides detail about the attributes of an OBJECT. A property has these
attributes:
• name: The unique name for the property within the object.
• key: Indicates whether this property is a key value to identify this object.
• type: The type of data represented by the element data.
• size: Typically the maximum size of the output. Usually only important if the console output is
displayed in rows.
• draw: Whether to show or hide this data in console format.
• sort: The type of sorting that can be applied to this property.
• display-name: The label for this data to show in user interfaces.
COMP A COMP (composition) element associates nested objects, such as a task object within a schedule
object. A composition element has these attributes:
• P: The oid of the part component.
• G: The oid of the group component.
An alternative to using COMP elements is described in XML API optimization.
ASC The association element provides a simple association description between two objects in the
response.
• A: First object.
• B: Second object.
Using JSON API output
The simplest mechanism to handle JSON output is by using either a JavaScript or a Python parser to interpret the data.
The JSON output is organized according to the basetypes defined for the system. All basetype objects are returned in an array. The JSON
object uses the same name for the key as the XML API uses in the name attribute. Objects can also be embedded inside of other objects
are always presented as an array as well. This is different from the XML API where the default output uses associations. The JSON output
always uses a hierarchical presentation of objects to identify relationships between objects.
Each object also has an object-name property that may be used in some cases to identify the object uniquely. For example, the show
versions command uses the object-name property to identify the version for controller A and controller B:
{
"versions":[
{
14
Using the CLI