clconfiguration describes the Documentation Type Definition (DTD) for the Sun Cluster configuration eXtensible Markup Language (XML) file. The Sun Cluster configuration file contains Sun Cluster configuration information tagged with XML elements. The file can contain configuration information for one or more clusters, or even for a portion of a cluster. This Sun Cluster configuration information can be used for many cluster functions, including cluster configuration backup and cluster duplication.
The DTD defines the elements, their relationships, and their attributes. The element names reflect the content that they provide. For example, the element <devicegroup> defines cluster device groups. Elements might have attributes that are used to modify or refine their properties or characteristics. Many of the object-oriented Sun Cluster commands include an export subcommand that exports cluster object information in the format described in the DTD. Many Sun Cluster commands have the option to add, create, and modify Sun Cluster objects through the use of cluster configuration XML data.
Unless otherwise specified, one or more is required.
Unless otherwise specified, there can be zero or one.
<propertyList> <property> <state> <allNodes> <-- Cluster --> <cluster> <-- Cluster Nodes --> <nodelist> <node> <-- Cluster Transport --> <clusterTransport> <transportNodeList> <transportNode> <transportAdapter> <transportType> <transportSwitchList> <transportSwitch> <transportCableList> <transportCable> <endpoint> <-- Cluster Global Devices --> <deviceList> <device> <devicePath> <-- Cluster Quorum --> <clusterQuorum> <quorumNodeList> <quorumNode> <quorumDeviceList> <quorumDevice> <quorumDevicePathList> <quorumDevicePath> <-- Cluster Device Groups --> <devicegroupList> <devicegroup> <memberDeviceList> <memberDevice> <devicegroupNodeList> <devicegroupNode> <-- Cluster Resource Types --> <resourcetypeList> <resourcetype> <resourcetypeRTRFile> <resourcetypeNodeList> <resourcetypeNode> <methodList> <method> <parameterList> <parameter> <-- Cluster Resources --> <resourceList> <resource> <resourceNodeList> <resourceNode) <monitoredState> <-- Cluster Resource Groups --> <resourcegroupList> <resourcegroup> <failoverMode> <managedState> <resourcegroupNodeList> <resourcegroupNode> <resourcegroupResourceList> <resourcegroupResource> <-- Cluster NAS Devices --> <nasdeviceList> <nasdevice> <nasdir> <-- Cluster SNMP --> <snmpmibList> <snmpmib> <snmphostList> <snmphost> <snmpuserList> <snmpuser> <-- Cluster Telemetrics --> <telemetrics> <telemetryObjectType> <telemetryAttribute>
This section lists and describes all of the elements that are defined in the cluster DTD. If an element has required children or attributes, the required default is one. Optional elements default to zero or one.
A list of all member nodes in the cluster. The <allNodes> element is a generic element.
The <allNodes> element is used to denote all nodes of the cluster.
The root element of a complete cluster configuration XML file. Every cluster configuration XML file must begin with this element as the root. The DTD can accept only one <cluster> element. Subsequent <cluster> elements in the cluster configuration XML file are ignored.
The root element of the cluster quorum configuration. All cluster quorum information is defined in the child elements of the <clusterQuorum> element.
The root element of the cluster transport configuration. All cluster transport information is displayed in a sublevel of the <clusterTransport> element.
A cluster device ID pseudo-driver (DID) device.
The root element of a cluster device-group instance. All aspects of an individual device group are defined in the child elements of the <devicegroup> element.
The name of the device group. The name attribute can be any valid sequence of characters.
The type of the device group. The type attribute can have a value of rawdisk, vxvm, svm, or sds.
A list of all the cluster device groups.
The node on which a device group is located.
A list of nodes on which a device group is located.
A list of cluster DID devices.
The node and disk device on which a particular <device> exists.
One of the transport endpoints.
The name of the adapter or switch.
The name of the node that hosts the specified adapter. The nodeRef attribute is required only if the type attribute is set to adapter.
The type attribute can be set to either adapter or switch.
If the type attribute is set to adapter, you must specify a nodeRef attribute.
If the type attribute is set to switch, you can specify a port attribute. However, the port attribute is not required.
The number of the port on the switch. Specify the port attribute only if the type attribute is set to switch.
The failover mode of a resource group.
Indicates whether a resource group is managed or unmanaged.
The member name of a particular device group. If the <devicegroup> is a set of type rawdisk, then you must specify one or more <member> elements, each with the name of the raw-disk path.
A list of device group members.
Mapping between a generic method type and the actual method name for a specific resource type.
A list of all of the <method> elements that are available for a specific <resourcetype>.
A Boolean value that indicates a portion of an element's state in the cluster. For example, the <monitoredState> of a resource specifies whether the resource is monitored, but does not specify whether the resource is available.
A single instance of a NAS device on the cluster.
A list of all NAS devices on the cluster.
One directory on a NAS device. Each NAS device can have multiple NAS directories.
A cluster node. Specify one <node> element for each node in the cluster.
Must be equal to the name of the node.
The path to the global mount directory.
The cluster node ID. If not specified, the cluster node ID attribute is provided a default value of an empty string.
A list of all nodes in the cluster.
A set of attributes that describes the <method> element timeout values and other parameters for a cluster resource type.
The extension attribute can be set to true or false.
The name of the parameter.
The value of the parameter's tunability. The tunability attribute can be set to one of the following values: atCreation, anyTime, or whenDisabled.
The type of the parameter. The type attribute can be set to one of the following values: boolean, enum, int , string, or stringArray.
The default value of this parameter if a value is not explicitly specified. For example, the default for the method element timeout is START.
A description of the parameter. If not defined, this attribute defaults to an empty string.
An enumerated list of objects. For example, the attribute might be a list of failover modes in order of preference.
The maximum length of a string or stringArray type parameter.
The minimum size of an stringArray type parameter.
The minimum length of a string or stringArray type parameter.
A list of <parameter> elements that describes a resource type.
A generic element that describes one property. The property is not specific to any subset of cluster related configuration.
A list of <property> elements. The <propertyList> element is a generic element.
<cluster>, <deviceGroup>, <node>, <quorumDevice>, <quorumNode>, <resource>, <resourceNode>, <resourcegroup>, <resourceType>, <transportAdapter>, <transportType>
This attribute can have one of the following values: true, false, mixed, or doesNotApply. If a value is not specified, the extension attribute has a default value of doesNotApply.
This attribute can have a value of true or false. If a value is not specified, the readonly attribute has a default value of false.
An individual cluster quorum device.
The <quorumDevice> element can have only one <propertyList> child.
The <quorumDevice> element can have only one <quorumDevicePathList> child.
The name of the quorum device.
The type of quorum device that is referenced by this element. The type attribute can be set to netapp_nas, scsi, or quorum_server.
A list of all quorum devices in the cluster.
The path to a cluster quorum device.
A list of all paths to a particular <quorumDevice>.
A node in the cluster that participates in the cluster quorum.
A list of all nodes that participate in the cluster quorum. In a functional cluster that is not in installmode, this list typically contains all nodes in the cluster. In a cluster that is still in installmode, this list might contain only one of the cluster nodes.
A cluster resource.
A list of the root node for the cluster resources that are defined in the configuration.
A cluster resource group.
The root node for the cluster resource groups that are defined in the configuration.
The node on which a resource group is defined.
The cluster nodes on which a particular resource group operates.
A cluster resource that belongs to a particular resource group.
A list of the resources that are defined in a resource group.
The node on which a resource is defined.
A cluster resource type that is available in the cluster.
The root node of the cluster resource types that are defined in the configuration.
A node on which a resource type is defined.
A list of the cluster nodes on which a particular resource type exists.
The name of a resource type registration (RTR) file that describes a particular resource type.
The SNMP host and community that are configured on a cluster node.
A list of the SNMP hosts and communities that are configured on a cluster node.
An SNMP MIB that is on a cluster node.
A list of the SNMP MIBs that are on a cluster node.
The SNMPv3 user that is configured on a cluster node.
The name of the user.
The node on which the SNMPv3 user exists.
The auth attribute can be set to MD5 or SHA.
The defaultUser attribute can be set to yes or no. If a value is not specified, the attribute defaults to whichever value is appropriate, based on the node configuration.
A list of the SNMPv3 users that are configured on a cluster node.
The state of various objects within the cluster configuration. The <state> element is a generic element.
Cluster monitoring thresholds
The attributes of system resources that you can monitor.
The types of objects you can monitor.
A network adapter that is used in the private cluster transport.
A network cable that is used in the private cluster transport. The cable does not necessarily imply a physical cable, but rather a path between two <endpoint> elements.
A list of the network cables that are used to connect two cluster <endpoint> elements.
One of the cluster nodes that is used in the private cluster transport. Specify one <transportNode> element for each node of the cluster.
A list of the nodes that are used in the private cluster transport. This list of nodes always contains the same set of nodes as the members of the cluster.
A cluster transport switch.
A list of the network switches that are used by the private cluster transport system.
The type of network transport that is used for a <transportAdapter> element.
The document type definition (DTD) file that defines the structure of the Sun Cluster configuration XML file.