NAME

      mxtoolbox - Systems Insight Manager ToolBox file format


SYNOPSIS

      mxtoolbox


DESCRIPTION

      The mxtoolbox command supports reading and writing toolbox information
      in the eXtensible Markup Language (XML) format. You may use this
      capability to add, modify, or remove multiple toolboxes in the Systems
      Insight Manager environment.  Each file may contain the definitions of
      one or more toolboxes.

    Document Type Definition
      The Document Type Definition (DTD) file defines the constraints for an
      XML file. These constraints include the valid element tags,
      attributes, and the cardinality of elements in an XML file. The
      toolbox DTD file is named toolboxlist.dtd and is included in the
      following paragraph. Note that due to man page formatting, the DTD
      contents may not appear the same as in the file.

      <?xml version="1.0" encoding="UTF-8" ?>

      <!-- READ THIS FIRST! This file is intentionally formatted with a
	   right margin set at 70. This allows the DTD file to be pasted
	   directly into the mxtoolbox(4) man page file. Please respect this
	   constraint when editing this file. After edits are final for
	   a given release, please paste the final DTD version in the
	   mxtoolbox(4) man page to keep the documentation current. -->

      <!-- The toolbox-list consists of 0 or more toolbox elements -->
      <!ELEMENT toolbox-list ( toolbox )* >

      <!-- The toolbox element has the following attributes: -->
      <!-- The name attribute specifies the toolbox name and is required. -->
      <!-- The guid attribute specifies the toolbox GUID and is optional. -->
      <!-- The toolbox element has the following elements: -->
      <!-- The enabled element specifies if the toolbox is enabled and may
	   optionally appear once in a toolbox element. -->
      <!-- The description element provides a toolbox description and may
	   optionally appear once in a toolbox element. -->
      <!-- The attribute element specifies a list of client attributes for a
	   toolbox and may appear zero or more times in a toolbox element -->
      <!ELEMENT toolbox ( enabled?, description?, attribute* ) >
      <!ATTLIST toolbox name CDATA #REQUIRED >
      <!ATTLIST toolbox guid NMTOKEN #IMPLIED >

      <!-- The enabled element has a value attribute which may be set to
	   true or false. "true" indicates the toolbox is enabled. "false"
	   indicates the toolbox is disabled. The default value is "true". -->
      <!ELEMENT enabled EMPTY >
      <!ATTLIST enabled value (true | false) "true" >

      <!ELEMENT description ( #PCDATA ) >

      <!ELEMENT attribute ( #PCDATA ) >
      <!ATTLIST attribute name CDATA #REQUIRED >

    Elements
      As defined in the DTD, the toolbox XML file may contain the following
      elements.

      The first line of a toolbox XML file should be in the following
      format:

      <?xml version="1.0" encoding="encoding-value" ?>

      where the user substitutes a recognized encoding value for the
      encoding-value parameter.	 The recognized encoding values may be found
      at the following web site:

      http://www.iana.org/assignments/character-sets

      If no XML header line is specified, the system defaults encoding to
      "UTF-8".

      The "toolbox-list" element must appear once in a toolbox XML file and
      wraps the list of toolbox information. The "toolbox-list" element may
      contain zero or more "toolbox" elements. Note that if the "toolbox-
      list" element contains no "toolbox" elements, the associated mxtoolbox
      command will have no effect.

      The "toolbox" element may appear zero or more times in a toolbox XML
      file. The "toolbox" element has two attributes.
      The "name" attributes is mandatory and specifies the toolbox name.
      The "guid" attribute is optional and specifies the globally unique
      identifier of the toolbox. Because this value is assigned by the
      system, the system ignores this attribute when adding a new toolbox.

      The "toolbox" element may contain a number of optional elements. Each
      of these elements may only appear once in each "toolbox" element with
      the exception of the "attribute" element which may appear zero or more
      times. Each element must appear in the order they are defined in the
      DTD.

      The "enabled" element specifies whether the toolbox is enabled. The
      "enabled" element contains an attribute named "value" with which the
      user specifies if the toolbox is enabled. The user specifies "true" to
      enable the toolbox and "false" to disable a toolbox. The default value
      is "false".


      The "description" element specifies a description of the user.

      The "attribute" element specifies a set of client attributes to be
      associated with the toolbox. Each "attribute" element contains a
      "name" attribute which identifies the client attribute and a "value"
      element which specifies the client attribute value.

    Commenting
      Comments may be included in XML files.  The comment must begin with
      the characters "<!--" and end with the characters "-->". Comments may
      span multiple lines within the beginning and ending character tags.

    Example
      This section contains an example of a toolbox XML file.  This example
      shows a file containing a set of toolboxes with the toolbox names,
      enabled elements and description elements.

      <?xml version="1.0" encoding="UTF-8"?>
      <toolbox-list>
	<toolbox name="webadmin" >
	  <enabled value="true" />
	  <description>WEB Server Administrators</description>
	</toolbox>
	<toolbox name="Master ToolBox" >
	  <enabled value="true" />
	  <description>Master ToolBox</description>
	</toolbox>
	<toolbox name="dbadmin" >
	  <enabled value="true" />
	  <description>Database Administrators</description>
	</toolbox>
	<toolbox name="lvmadmin" >
	  <enabled value="true" />
	  <description>LVM Administrators</description>
	</toolbox>
	<toolbox name="operator" >
	  <enabled value="true" />
	  <description>read-only operators</description>
	</toolbox>
      </toolbox-list>


LIMITATIONS

      This command may only be run on the CMS.


AUTHOR

      mxtoolbox was developed by the Hewlett-Packard Company.


SEE ALSO for HP-UX

      mxtoolbox(1M)



SEE ALSO for Linux

      mxtoolbox(8)