

                 XML Mode Symmetrix Command-line Interface

   With the goal of aiding automated processing of information from the SymCLI,
an alternate output mode has been added beginning with V4.3.  The aim is to 
ease parsing of the output--not by screen-scraping tools like awk or perl, but
by truly deterministic parsing tools.  To this end, Extensible Markup Language, 
or XML, has been chosen as the vehicle for this change.  XML is a fairly new 
standard based on the experience of SGML and is endorsed by the World Wide Web 
Consortium.  Full information on XML may be found at http://w3.org/XML/

Externally, XML will look familiar to users of HTML, as it employs the same 
tag-based syntax.  XML though, allows the document author to specify the tags 
which are most applicable to the given application. For the SymCLI, these tags 
represent physical or logical structures within the Symmetrix and its environs.
The returns from the XML mode of SymCLI are meant to expose exactly the same 
data as before, but marked up with tags so that individual pieces of data can 
be readily called upon by name.  The tags also provide a definitive way to 
express the relations between different objects, an advantage over the weak 
spatial relations the standard CLI employs.

Tools have been created to assist in the retrieval of information stored in XML.
Among these, eXtensible Stylesheet Language Transforms (XSLT) is a particularly 
useful and widely available technology.  Alongside this document is a directory 
(../examples) containing several examples of the types of queries which can be 
performed on XML data using XSLT.  They are meant as a brief introduction to the
power and usefulness of XSLT, and will hopefully make the change to using XML 
less difficult.

To use XML mode with SymCLI, both a command-line argument and an environment 
variable have been added.  The environment variable is 'SYMCLI_OUTPUT_MODE', and
the command-line variable is '-output'.  Both take only 'XML', and 'Standard' 
(or 'Std') as legal values, and are case-insensitive.  When both settings are 
used, the command-line overrides the environment.  It is important to note that
the -output flag will not be found in either the -help or man pages.  This is
because it is available nearly everywhere; any command which does not support 
XML output will clearly indicate so at runtime.

As this is a first release of broad functionality employing a new and evolving
set of standards, some areas and decisions are still subject to debate.  Though 
an effort has been made to make XML mode right the first time, some aspects of 
the presentation may change in a subsequent release.  At some time in the future
the XML mode of SymCLI will stabilize, but for now it is offered on an as-is 
basis, and comments and suggestions are welcome.
