Db2 High Availability Instance Configuration Utility (db2haicu) input file XML schema definition

The Db2® high availability instance configuration utility (db2haicu) input file XML schema definition (XSD) defines the cluster domain objects that you can specify in a db2haicu XML input file. This db2haicu XSD is located in the file called db2ha.xsd in the sqllib/samples/ha/xml directory.

DB2ClusterType

The root element of the db2haicu XML schema definition (XSD) is DB2Cluster, which is of type DB2ClusterType. A db2haicu XML input file must begin with a DB2Cluster element.

XML schema definition


<xs:complexType name='DB2ClusterType'> 
  <xs:sequence> 
    <xs:element name='DB2ClusterTemplate'
                type='DB2ClusterTemplateType'
                minOccurs='0'
                maxOccurs='unbounded'/> 
    <xs:element name='ClusterDomain'      
                type='ClusterDomainType'
                maxOccurs='unbounded'/> 
    <xs:element name='FailoverPolicy'
                type='FailoverPolicyType'
                minOccurs='0'/> 
    <xs:element name='DB2PartitionSet'
                type='DB2PartitionSetType'
                minOccurs='0'
                maxOccurs='unbounded'/> 
    <xs:element name='HADRDBSet'
                type='HADRDBType'
                minOccurs='0'
                maxOccurs='unbounded'/> 
    <xs:element name='HADBSet'
                type='HADBType'
                minOccurs='0'
                maxOccurs='unbounded'/> 
  </xs:sequence> 
  <xs:attribute name='clusterManagerName' type='xs:string' use='optional'/> 
</xs:complexType> 

Subelements

DB2ClusterTemplate
Type:
DB2ClusterTemplateType
Usage notes:
Do not include a DB2ClusterTemplateType element in your db2haicu XML input file. The DB2ClusterTemplateType element is currently reserved for future use.
ClusterDomain
Type:
ClusterDomainType

A ClusterDomainType element contains specifications about: the machines or computers in the cluster domain (also called cluster domain nodes); the network equivalencies (groups of networks that can fail over for one another); and the quorum device (tie-breaking mechanism).

Occurrence rules:
You must include one or more ClusterDomain element in your DB2ClusterType element.
FailoverPolicy
Type:
FailoverPolicyType

A FailoverPolicyType element specifies the failover policy that the cluster manager should use with the cluster domain.

Occurrence rules:
You can include zero or one FailoverPolicy element in your DB2ClusterType element.
DB2PartitionSet
Type:
DB2PartitionSetType

A DB2PartitionSetType element contains information about database partitions. The DB2PartitionSetType element is only applicable in a partitioned database environment.

Occurrence rules:
You can include zero or more DB2PartitionSet elements in your DB2ClusterType element, according to the db2haicu db2haicu XML schema definition.
HADRDBSet
Type:
HADRDBType

A HADRDBType element contains a list of High Availability Disaster Recovery (HADR) primary and standby database pairs.

Occurrence rules:
You can include zero or more HADRDBSet elements in your DB2ClusterType element, according to the db2haicu db2haicu XML schema definition.
Usage notes:
  • You must not include HADRDBSet in a partitioned database environment.
  • If you include HADRDBSet, then you must specify a failover policy of HADRFailover in the FailoverPolicy element.
HADBSet
Type:
HADBType

A HADBType element contains a list of databases to include in the cluster domain, and to make highly available.

Occurrence rules:
You can include zero or more HADBSet elements in your DB2ClusterType element, according to the db2haicu db2haicu XML schema definition.

Attributes

clusterManagerName (optional)
The clusterManagerName attribute specifies the cluster manager.

Valid values for this attribute are specified in the following table:

Table 1. Valid values for the clusterManager attribute
clusterManagerName value Cluster manager product
TSA IBM® Tivoli® System Automation for Multiplatforms (SA MP)

Usage notes

In a single partition database environment, you will usually only create a single cluster domain for each database manager instance.

One possible configuration for a multi-partition database environment is:
  • Set the FailoverPolicy element to Mutual
  • In the DB2Partition subelement of DB2PartitionSet, use the MutualPair element to specify two cluster domain nodes that are in a single cluster domain