clconfiguration

- describes the cluster DTD for the Oracle Solaris Cluster configuration XML file

Description

clconfiguration describes the Documentation Type Definition (DTD) for the Oracle Solaris Cluster configuration eXtensible Markup Language (XML) file. The Oracle Solaris Cluster configuration file contains Oracle Solaris 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 Oracle Solaris 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 Oracle Solaris Cluster commands include an export subcommand that exports cluster object information in the format described in the DTD. Many Oracle Solaris Cluster commands have the option to add, create, and modify Oracle Solaris Cluster objects through the use of cluster configuration XML data.

Element Hierarchy

The following list provides the element hierarchy required by the DTD. This list uses the following defaults for children and attribute properties:

required

Unless otherwise specified, one or more is required.

optional

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>

ELEMENTS

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.

<allNodes>

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.

Parent:

<resourcetypeNodeList>

Children:

None

Attributes:

None

<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.

Parent:

None

Children:

Optional:

• <propertyList>

• <nodeList>

• <clusterTransport>

• <deviceList>

• <clusterQuorum>

• <deviceGroupList>

• <resourcetypeList>

• <resourcegroupList>

• <resourceList>

• <nasdeviceList>

• <snmpmibList>

• <snmphostList>

• <snmpuserList>

Attributes:

Required:

• name

  The name of the cluster.

<clusterQuorum>

The root element of the cluster quorum configuration. All cluster quorum information is defined in the child elements of the <clusterQuorum> element.

Parent:

<cluster>

Children:

Optional:

• <quorumDeviceList>

• <quorumNodeList>

Attributes:

None

<clusterTransport>

The root element of the cluster transport configuration. All cluster transport information is displayed in a sublevel of the <clusterTransport> element.

Parent:

<cluster>.

Children:

Optional:

• <transportNodeList>

• <transportSwitchList>

• <transportCableList>

Attributes:

None

<device>

A cluster device ID pseudo-driver (DID) device.

Parent:

<deviceList>

Children:

Optional:

• <devicePath> (zero or more)

Attributes:

Required:

• ctd

  The UNIX disk name.

• name

  The instance number of the device.

<devicegroup>

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.

Parent:

<devicegroupList>

Children:

Optional:

• <devicegroupNodeList>

• <memberDeviceList>

• <propertyList>

Attributes:

Required:

• name

  The name of the device group. The name attribute can be any valid sequence of characters.

• type

  The type of the device group. The type attribute can have a value of rawdisk, vxvm, svm, or sds.

<devicegroupList>

A list of all the cluster device groups.

Parent:

<cluster>

Children:

Optional:

• <devicegroup>

  One <devicegroup> element can be used for each device group in the cluster.

Attributes:

None

<devicegroupNode>

The node on which a device group is located.

Parent:

<devicegroupNodeList>

Children:

None

Attributes:

Required:

• nodeRef

  Specifies the name of a cluster node.

<devicegroupNodeList>

A list of nodes on which a device group is located.

Parent:

<devicegroup> (1 or more)

Children:

Required:

• <devicegroupNode> (1 or more)

Attributes:

None

<deviceList>

A list of cluster DID devices.

Parent:

<cluster>

Children:

Optional:

• <device>

Attributes:

Fixed:

• readonly

  The readonly attribute has a fixed value of true.

<deviceNode>

The node and disk device on which a particular <device> exists.

Parent:

<device>

Children:

None

Attributes:

Required:

• nodeRef

  The name of the node on which an instance exists.

<endpoint>

One of the transport endpoints.

Parent:

<transportCable>

Children:

None

Attributes:

Required:

• name

  The name of the adapter or switch.

• nodeRef

  The name of the node that hosts the specified adapter. The nodeRef attribute is required only if the type attribute is set to adapter.

• type

  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.

Optional:

• port

  The number of the port on the switch. Specify the port attribute only if the type attribute is set to switch.

<failoverMode>

The failover mode of a resource group.

Parent:

<resourcegroup>

Children:

None

Attributes:

Required:

• value

  The value attribute can be set to failover or scalable.

<managedState>

Indicates whether a resource group is managed or unmanaged.

Parent:

<resourcegroup>

Children:

None

Attributes:

Required:

• value

  The value attribute can be either true or false.

<memberDevice>

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.

Parent:

<memberDeviceList>

Children:

None

Attributes:

Required:

• name

  The name of the member.

<memberDeviceList>

A list of device group members.

Parent:

<devicegroup> (one or more)

Children:

Required:

• <memberDevice>

Attributes:

None

<method>

Mapping between a generic method type and the actual method name for a specific resource type.

Parent:

<methodList>

Children:

None

Attributes:

Required:

• name

  The actual name of the method for the resource type.

• type

  The type of method for the resource type. You can specify the following types:

  • MONITOR_CHECK

  • MONITOR_START

  • MONITOR_STOP

  • PRENET_START

  • START

  • STOP

  • VALIDATE

  • UPDATE

<methodList>

A list of all of the <method> elements that are available for a specific <resourcetype>.

Parent:

<resourcetype>

Children:

Optional:

• <method>

Attributes:

Fixed:

• readonly

  The readonly attribute has a fixed value of true.

<monitoredState>

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.

Parent:

<resource>

Children:

None

Attributes:

Required:

• value

  The value attribute can be set to true or false.

<nasdevice>

A single instance of a NAS device on the cluster.

Parent:

<nasdeviceList>

Children:

Optional:

• <nasdir>

Attributes:

Required:

• name

  The hostname of the NAS device.

• type

  The type of NAS device. You must specify sun or sun_uss .

Optional:

• userid

  The user name that is required to access the NAS device.

<nasdeviceList>

A list of all NAS devices on the cluster.

Parent:

<cluster>

Children:

Optional:

• <nasdevice>

Attributes:

None

<nasdir>

One directory on a NAS device. Each NAS device can have multiple NAS directories.

Parent:

<nasdevice>

Children:

None

Attributes:

Required:

• path

  The path to the NAS directory.

<node>

A cluster node. Specify one <node> element for each node in the cluster.

Parent:

<nodeList>

Children:

Optional:

• <propertyList>

Attributes:

Required:

• name

  Must be equal to the name of the node.

Optional:

• globaldevfs

  The path to the global mount directory.

• id

  The cluster node ID. If not specified, the cluster node ID attribute is provided a default value of an empty string.

<nodeList>

A list of all nodes in the cluster.

Parent:

<cluster>

Children:

Optional:

• <node>

  At least one node attribute must be supplied for each node on the cluster.

Attributes:

None

<parameter>

A set of attributes that describes the <method> element timeout values and other parameters for a cluster resource type.

Parent:

<parameterList>

Children:

None

Attributes:

Required:

• extension

  The extension attribute can be set to true or false.

• name

  The name of the parameter.

• tunability

  The value of the parameter's tunability. The tunability attribute can be set to one of the following values: atCreation, anyTime, or whenDisabled.

• type

  The type of the parameter. The type attribute can be set to one of the following values: boolean, enum, int , string, or stringArray.

Optional:

• default

  The default value of this parameter if a value is not explicitly specified. For example, the default for the method element timeout is START.

• description

  A description of the parameter. If not defined, this attribute defaults to an empty string.

• enumList

  An enumerated list of objects. For example, the attribute might be a list of failover modes in order of preference.

• maxLength

  The maximum length of a string or stringArray type parameter.

• minArrayLength

  The minimum size of an stringArray type parameter.

• minLength

  The minimum length of a string or stringArray type parameter.

<parameterList>

A list of <parameter> elements that describes a resource type.

Parent:

<resourcetype>

Children:

Optional:

• <parameter>

Attributes:

Fixed:

• readonly

  The readonly attribute has a fixed value of true.

<property>

A generic element that describes one property. The property is not specific to any subset of cluster related configuration.

Parent:

<propertyList>

Children:

None

Attributes:

Required:

• name

  The name of the property.

• value

  The value of the property.

Optional:

• readonly

  The readonly attribute can be set to true or false. If this value is not specified, the attribute defaults to the value false.

• type

  The property type.

<propertyList>

A list of <property> elements. The <propertyList> element is a generic element.

Parents:

<cluster>, <deviceGroup>, <node>, <quorumDevice>, <quorumNode>, <resource>, <resourceNode>, <resourcegroup>, <resourceType>, <transportAdapter>, <transportType>

Children:

Optional:

• <property>

Attributes:

Optional:

• extension

  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.

• readonly

  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.

<quorumDevice>

An individual cluster quorum device.

Parent:

<quorumDeviceList>

Children:

Optional:

• <propertyList>

  The <quorumDevice> element can have only one <propertyList> child.

• <quorumDevicePathList>

  The <quorumDevice> element can have only one <quorumDevicePathList> child.

Attributes:

Required:

• name

  The name of the quorum device.

• type

  The type of quorum device that is referenced by this element. The type attribute can be set to scsi or quorum_server.

<quorumDeviceList>

A list of all quorum devices in the cluster.

Parent:

<clusterQuorum>

Children:

Optional:

• <quorumDevice>

Attributes:

None

<quorumDevicePath>

The path to a cluster quorum device.

Parent:

<quorumDevicePathList>

Children:

Optional:

• <state>

  The <quorumDevicePath> element can have only one <state> child.

Attributes:

Required:

• nodeRef

  The name of the node that the quorum device resides on.

<quorumDevicePathList>

A list of all paths to a particular <quorumDevice>.

Parent:

<quorumDevice>

Children:

Required:

• <quorumDevicePath>

Attributes:

Fixed:

• readonly

  The readonly attribute is set to true.

<quorumNode>

A node in the cluster that participates in the cluster quorum.

Parent:

<quorumNodeList>

Children:

Optional:

• <propertyList>

Attributes:

Required:

• <nodeRef>

  The name of the node.

<quorumNodeList>

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.

Parent:

<clusterQuorum>

Children:

Required:

• <quorumNode>

Attributes:

Fixed:

• readonly

  The readonly attribute is set to true.

<resource>

A cluster resource.

Parent:

<resourceList>

Children:

Optional:

• <resourceNodeList>

• <propertyList>

Attributes:

Required:

• name

  The name of the resource.

• resourcegroupRef

  The resource group to which the resource belongs.

• resourcetypeRef

  The type of resource that is described by this element.

<resourceList>

A list of the root node for the cluster resources that are defined in the configuration.

Parent:

<cluster>

Children:

Optional:

• <resource>

Attributes:

None

<resourcegroup>

A cluster resource group.

Parent:

<resourcegroupList>

Children:

Required:

• <failoverMode>

• <managedState>

• <resourcegroupNodeList>

• <resourcegroupResourceList>

• <propertyList>

Attributes:

Required:

• name

  The name of the resource.

<resourcegroupList>

The root node for the cluster resource groups that are defined in the configuration.

Parent:

<cluster>

Children:

Optional:

• <resourcegroup>

Attributes:

None

<resourcegroupNode>

The node on which a resource group is defined.

Parent:

<resourcegroupNodeList>

Children:

None

Attributes:

Required:

• nodeRef

  The name of the cluster node.

Optional:

• Zone

  The name of the zone.

<resourcegroupNodeList>

The cluster nodes on which a particular resource group operates.

Parent:

<resourcegroup>

Children:

Required:

• <resourcegroupNode>

Attributes:

None

<resourcegroupResource>

A cluster resource that belongs to a particular resource group.

Parent:

<resourcegroupResourceList>

Children:

None

Attributes:

Required:

• resourceRef

  The name of the resource.

<resourcegroupResourceList>

A list of the resources that are defined in a resource group.

Parent:

<resourcegroup>

Children:

Optional:

• <resourcegroupResource>

Attributes:

None

<resourceNode>

The node on which a resource is defined.

Parent:

<resourceNodeList>

Children:

Required:

• <state>

• <monitoredState>

Optional:

• <propertyList>

Attributes:

Required:

• nodeRef

  The name of the resource type.

Optional:

• zone

  The name of the zone.

<resourcetype>

A cluster resource type that is available in the cluster.

Parent:

<resourcetypeList>

Children:

Optional:

• <resourcetypeRTRFile>

• <resourcetypeNodeList>

• <methodList>

• <parameterList>

• <propertyList>

Attributes:

Required:

• name

  The name of the resource type.

<resourcetypeList>

The root node of the cluster resource types that are defined in the configuration.

Parent:

<cluster>

Children:

Optional:

• <resourcetype>

Attributes:

None

<resourcetypeNode>

A node on which a resource type is defined.

Parent:

<resourcetypeNodeList>

Children:

None

Attributes:

Required:

• nodeRef

  The name of the cluster node.

<resourcetypeNodeList>

A list of the cluster nodes on which a particular resource type exists.

Parent:

<resourcetype>

Children:

Required : The <resourcetypeNodeList> element must contain either one or more <resourcetypeNode> elements or exactly one <allNodes> element.

• <resourcetypeNode>

• <allNodes>

Attributes:

None

<resourcetypeRTRFile>

The name of a resource type registration (RTR) file that describes a particular resource type.

Parent:

<resourcetype>

Children:

None

Attributes:

Required:

• name

  The name of the RTR file.

<snmphost>

The SNMP host and community that are configured on a cluster node.

Parent:

<snmphostList>

Children:

None

Attributes:

Required:

• community

  The SNMP community name.

• name

  The name of the instance.

• nodeRef

  The node on which the SNMP host and community exist.

<snmphostList>

A list of the SNMP hosts and communities that are configured on a cluster node.

Parent:

<cluster>

Children:

Optional:

• <snmphost>

Attributes:

None

<snmpmib>

An SNMP MIB that is on a cluster node.

Parent:

<snmpmibList>

Children:

Optional:

• state

Attributes:

Required:

• name

  The name of the MIB.

• nodeRef

  The node on which the SNMP MIB exists.

Optional:

• protocol

  The SNMP protocol that the MIB will use. This attribute defaults to SNMPv2.

• value

  SNMPv3 or SNMPv2

snmpmibList

A list of the SNMP MIBs that are on a cluster node.

Parent:

<cluster>

Children:

Optional:

• <snmpmib>

Attributes:

None

<snmpuser>

The SNMPv3 user that is configured on a cluster node.

Parent:

<snmpuserList>

Children:

None

Attributes:

Required:

• name

  The name of the user.

• nodeRef

  The node on which the SNMPv3 user exists.

• auth

  The auth attribute can be set to MD5 or SHA.

Optional:

• defaultUser

  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.

• defaultSecurityLevel

  The security level of the user. The security attribute can be set to one of the following values:

  • authPriv

  • authNoPriv

  • noAuthNoPriv

<snmpuserList>

A list of the SNMPv3 users that are configured on a cluster node.

Parent:

<cluster>

Children:

<snmpuser>

Attributes:

None

<state>

The state of various objects within the cluster configuration. The <state> element is a generic element.

Parent:

<quorumDevicePath>, <resourceNode>, <snmpmib>, <telemetryAttribute>, <transportAdapter>, <transportCable>, <transportSwitch>

Children:

None

Attributes:

Required:

• value

  The value attribute can be set to enabled or disabled.

<telemetrics>

Cluster monitoring thresholds

Parent:

<cluster>

Children:

Optional:

• <telemetryObjectType>

Attributes:

None

<telemetryAttribute>

The attributes of system resources that you can monitor.

Parent:

<telemetryObjectType>

Children:

Required:

• <state> (1 or more)

Attributes:

Required:

• name

  The name of the attribute.

<telemetryObjectType>

The types of objects you can monitor.

Parent:

<telemetrics>

Children:

Required:

• <telemetryAttibute>

Attributes:

Required:

• name

  The name of the attribute.

<transportAdapter>

A network adapter that is used in the private cluster transport.

Parent:

<transportNode>

Children:

Optional:

• <state>

• <transportType>

• <propertyList>

Attributes:

Required:

• name

  The name of the network adapter.

<transportCable>

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.

Parent:

<transportCableList>

Children:

Required:

• <endpoint>

  The <transportCable> element must have two <endpoint> elements. Each endpoint element must describe one of the cable endpoints.

Optional:

• <state>

  The <transportCable> element can have one <state> element.

Attributes:

None

<transportCableList>

A list of the network cables that are used to connect two cluster <endpoint> elements.

Parent:

<clusterTransport>

Children:

Optional:

• <transportCable>

Attributes:

None

<transportNode>

One of the cluster nodes that is used in the private cluster transport. Specify one <transportNode> element for each node of the cluster.

Parent:

<transportNodeList>

Children:

Optional:

• <nodeRef>

Attributes:

Required:

• transportAdapterList

  The name of the cluster node.

<transportNodeList>

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.

Parent:

<clusterTransport>

Children:

Optional:

• <transportNode>

Attributes:

None

<transportSwitch>

A cluster transport switch.

Parent:

<transportSwitchList>

Children:

Optional:

• <state>

Attributes:

Required:

• name

  The name of the transport switch.

Optional:

• port

  The number of the port on the switch.

<transportSwitchList>

A list of the network switches that are used by the private cluster transport system.

Parent:

<clusterTransport>

Children:

Optional:

• <transportSwitch>

Attributes:

None

<transportType>

The type of network transport that is used for a <transportAdapter> element.

Parent:

<transportAdapter>

Children:

Optional:

• <propertyList>

Attributes:

Required:

• value

  The value attribute can be set to dlpi or rsm.

Files

/usr/cluster/lib/xml/cluster.dtd

The document type definition (DTD) file that defines the structure of the Oracle Solaris Cluster configuration XML file.

See Also

Intro(1CL), cluster(1CL)

http://www.w3.org/XML/