NAME
mxnode - Systems Insight Manager system file format
SYNOPSIS
mxnode
DESCRIPTION
The mxnode command supports reading and writing node information in
the eXtensible Markup Language (XML) format. You may use this
capability to add, modify, remove or list multiple nodes in the
Systems Insight Manager environment. Each file may contain the
definitions of one or more nodes.
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 user
DTD file is named nodelist.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 mxnode(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
mxnode(4) man page to keep the documentation current.
-->
<!-- The node-list element consists of zero or more node elements.
-->
<!ELEMENT node-list ( node* ) >
<!-- The node element consists zero or more sw-attribute elements,
zero or more hw-attribute elements, or zero or more credentials or a
combination of all of these elements.
-->
<!ELEMENT node ( sw-attribute | hw-attribute | credential)* >
<!-- The node element has the following attributes:
The name attribute specifies the node name and is optional.
The host-name attribute specifies the host name and is optional.
The guid attribute specifies the node GUID and is optional.
-->
<!ATTLIST node name CDATA #IMPLIED
host-name CDATA #IMPLIED
guid NMTOKEN #IMPLIED >
<!-- The sw-attribute element specifies a list of software attributes
for a node. A software attribute is specified as a name/value
pair. In an sw-attribute element, the software attribute name
portion is specified using the element's attribute called "name",
and the software attribute value portion is specified as the
PCDATA of the element.
-->
<!ELEMENT sw-attribute (#PCDATA) >
<!ATTLIST sw-attribute name CDATA #REQUIRED >
<!-- The hw-attribute element specifies a list of hardware attributes
for a node. A hardware attribute is specified as a name/value
pair. In a hw-attribute element, the hardware attribute name
portion is specified using the element's attribute called "name",
and the hardware attribute value portion is specified as the
PCDATA of the element.
-->
<!ELEMENT hw-attribute (#PCDATA) >
<!ATTLIST hw-attribute name CDATA #REQUIRED >
<!-- The credential element specifies the credential for a specified protocol.
The credential element is empty and is specified with the defined attributes.
The protocol attribute is required and specifies the credentialed protocol,
such as wbem or snmp.
The user name attribute is optional and associates a user name with the protocol.
The password attribute is optional and is associated with the user name.
-->
<!ELEMENT credential EMPTY >
<!ATTLIST credential protocol CDATA #REQUIRED
username CDATA #IMPLIED
password CDATA #IMPLIED >
Elements
As defined in the DTD, the node XML file may contain the following
elements.
The first line of a node XML file should always be the following:
<?xml version="1.0" encoding="UTF-8" ?>
The "node-list" element must appear once in a node XML file and wraps
the list of node information. The "node-list" element may contain zero
or more "node" elements. Note that if the "node-list" element contains
no "node" elements, the associated mxnode command will have no
effect.
The "node" element has three attributes. The "name" attribute is
optional and specifies the node name. The "host-name" attribute is
optional and specifies the network hostname. The "guid" attribute is
optional and specifies the globally unique identifier of the node.
Because this value is assigned by the system, the system ignores this
attribute when adding a new node.
The "node" element may contain a number of optional elements. The
"sw-attribute", "hw-attribute" and "credential" elements may appear
zero or more times.
The "sw-attribute" element specifies a software-related node
attribute, such as the operating system type. The required "name"
specifies the attribute name. The text content of this element
specifies the attribute value.
The "hw-attribute" element specifies a hardware-related node
attribute, such as the device type. The required "name" specifies the
attribute name. The text content of this element specifies the
attribute value.
The "credential" element specifies the credential to use with a
specified protocol. The required "protocol" attribute specifies the
protocol, such as WBEM or SNMP. The optional "username" attribute
specifies a user name, and the optional "password" attribute specifies
a password. Note that the credential information is included only for
compatibility with mxnodesecurity. It is ignored by mxnode.
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.
Examples
This section contains some examples of node XML files.
This example shows a file containing nodes to be identified and added
to the repository:
<?xml version="1.0" encoding="UTF-8"?>
<node-list>
<node name="azul" host-name="azul.mycompany.com" />
<node>
<sw-attribute name="IPAddress">192.1.1.1</sw-attribute>
</node>
<node name="maple" />
</node-list>
This example shows what an identified node might look like:
<?xml version="1.0" encoding="UTF-8"?>
<node-list>
<node name="azul" guid="00000000868162fe0f07e31d86400000" host-name="azul.mycompany.com">
<hw-attribute name="DeviceType">Workstation</hw-attribute>
<hw-attribute name="DeviceSubType">HP9000</hw-attribute>
<hw-attribute name="Model">9000/785</hw-attribute>
<hw-attribute name="ProcessorFamily">pa-risc</hw-attribute>
<sw-attribute name="OSName">HPUX</sw-attribute>
<sw-attribute name="OSVendor">HP</sw-attribute>
<sw-attribute name="OSRevision">11.00</sw-attribute>
<sw-attribute name="IPAddress">192.1.2.3</sw-attribute>
<sw-attribute name="ProtocolSupport">SNMP:1.0</sw-attribute>
<sw-attribute name="Description">HP-UX phoenix B.11.00 A 9000/785 2004682655</sw-attribute>
<sw-attribute name="SystemName">azul.mycompany.com</sw-attribute>
</node>
</node-list>
LIMITATIONS
This command may only be run on the CMS.
AUTHOR
mxnode was developed by the Hewlett-Packard Company.
SEE ALSO for HP-UX
mxnode(1M)
SEE ALSO for Linux
mxnode(8)