NAME
mxngroup - Systems Insight Manager Node Group file format
SYNOPSIS
mxngroup
DESCRIPTION
The mxngroup command supports reading and writing node group
information in the eXtensible Markup Language (XML) format. You may
use this capability to add, modify, or remove multiple node groups in
the Systems Insight Manager environment. Each file may contain the
definitions of one or more node groups.
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 userlist.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 mxngroup(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
mxngroup(4) man page to keep the documentation current. -->
<!-- The node-group-list element consists of 0 or more node group
elements. -->
<!ELEMENT node-group-list ( node-group )* >
<!-- The node-group element has the following attributes: -->
<!-- The name attribute specifies the nodegroup name and is required.
-->
<!-- The guid attribute specifies the nodegroup GUID and is optional.
-->
<!-- The node-group element is composed of the following elements: -->
<!-- The description element may optionally appear once and specifies
the node group description. -->
<!-- The member-node element may appear zero or more times and
specifies the node group's member nodes. -->
<!-- The attribute element may appear zero or more times and specifies
the node group's client attributes. -->
<!ELEMENT node-group ( description?, member-node*, attribute* ) >
<!ATTLIST node-group name CDATA #REQUIRED
guid NMTOKEN #IMPLIED >
<!ELEMENT description ( #PCDATA ) >
<!-- The member-node element is an empty element with one attribute.
The value attribute specifies the node name and is required. -->
<!ELEMENT member-node EMPTY >
<!ATTLIST member-node value CDATA #REQUIRED >
<!-- The attribute element specifies the name value pairs that
comprise client attributes. The client attribute name is
specified using the name attribute and the client attribute value
is specified as the PCDATA of the element. -->
<!ELEMENT attribute ( #PCDATA ) >
<!ATTLIST attribute name CDATA #REQUIRED >
Elements
As defined in the DTD, the user XML file may contain the following
elements.
The first line of a node group XML file should always be the
following:
<?xml version="1.0" encoding="UTF-8" ?>
The "node-group-list" element must appear once in a user XML file and
wraps the list of node group information. The "node-group-list"
element may contain zero or more "node-group" elements. Note that if
the "node-group-list" element contains no "node-group" elements, the
associated mxngroup command will have no effect.
The "node-group" element must appear one or more times in a node-group
XML file. The "node-group" element has three attributes.
The "node-group" attribute is mandatory and specifies the node group
name.
The "guid" attribute is optional and specifies the globally unique
identifier of the node group. Because this value is assigned by the
system, the system ignores this attribute when adding a new node-
group.
The "node" element may contain a number of optional elements. The
"description" element may only appear once in each "node" element. The
"member-node" and the "attribute" element which may appear zero or
more times. Each element must appear in the order they are defined in
the DTD.
The "description" element specifies a description of the node group.
The "member-node" element is an empty element with a required "value"
attribute. The "value" attribute specifies the node name of a member
of the node group.
The "attribute" element specifies a set of client attributes to be
associated with the node group. 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.
Examples
This section contains some examples of node group XML files.
This example shows a file containing a node group with a description,
but no members.
<?xml version="1.0" encoding="UTF-8"?>
<node-group-list>
<node-group name="group1">
<description>An empty node group.</description>
</node-group>
</node-group-list>
This example shows a file containing 2 node groups. The first node
group contains a description with no members. The second node group
contains a description with one member.
<?xml version="1.0" encoding="UTF-8"?>
<node-group-list>
<node-group name="group1">
<description>An empty node group.</description>
</node-group>
<node-group name="group2">
<description>A group with one node.</description>
<member-node value="node.dom1.corp.com" />
</node-group>
</node-group-list>
LIMITATIONS
This command may only be run on the CMS.
AUTHOR
mxngroup was developed by the Hewlett-Packard Company.
SEE ALSO for HP-UX
mxngroup(1M)
SEE ALSO for Linux
mxngroup(8)