Administration Guide

Extending the Directory Schema with DB2 Object Classes and Attributes

The LDAP Directory Schema defines object classes and attributes for the information stored in the LDAP directory entries. An object class consists of a set of mandatory and optional attributes. Every entry in the LDAP directory has an object class associated with it.

Before DB2 can store the information into LDAP, the Directory Schema for the LDAP server must include the object classes and attributes that DB2 uses. The process of adding new object classes and attributes to the base schema is called extending the Directory Schema.
Note:If you are using IBM SecureWay LDAP Directory v3.1, all the object classes and attributes that are required by DB2 are included in the base schema. You do not have to extend the base schema with DB2 object classes and attributes.

Extending the Directory Schema for IBM eNetwork Directory Version 2.1

When using the IBM eNetwork Directory Version 2.1, you must extend the base schema with the object classes and attributes that are used by DB2.

Use the following steps to extend the base schema for IBM eNetwork Directory Version 2.1:

  1. Copy the DB2 attribute definition file, db2.at, and object class definition file, db2.oc, to the same directory that contains the system attribute and object class definition files, slapd.at.conf and slapd.oc.conf. The DB2 attribute and object class definition files can be found in the cfg subdirectory of the sqllib subdirectory. The system attribute and object class definition files are located in the etc subdirectory of the %LDAPHome% subdirectory.
  2. Review the DB2 attribute and object class definition files. Comment out any object classes and attributes that have been defined in your current LDAP Directory Schema.
  3. Add a line at the end of the slapd.oc.conf file as follows:
       include db2.oc
    
  4. Add a line at the end of the slapd.at.conf file as follows:
       include db2.at
    
  5. Restart the LDAP server.

Extending the Directory Schema for Windows 2000 Active Directory

Before DB2 can store information in the Windows 2000 Active Directory, the directory schema needs to be extended to include the new DB2 object classes and attributes. The process of adding new object classes and attributes to the directory schema is called schema extension.

You must extend the schema for Active Directory by running the DB2 Schema Installation program, db2schex before the first installation of DB2 on any machine that is part of a Windows 2000 domain.

The db2schex program is found on the product CD-ROM. The location of this program on the CD-ROM is under the db2 directory and the common subdirectory. For example:

 x:\db2\common

where x: is the CD-ROM drive.

The command is used as shown:

   db2schex

There are other optional clauses associated with this command:

Notes:

  1. If no UserDN and password are specified, db2schex binds as the currently logged user.

  2. The userDN clause can be specified as a Windows NT username.

  3. To update the schema, you must be a member of the Schema Administrators group or have been delegated the rights to update the schema.

Examples:

The DB2 Schema Installation program for Active Directory carries out the following tasks:

Notes:

  1. Detects which server is the Schema Master

  2. Binds to the Domain Controller that is the Schema Master

  3. Ensures that the user has sufficient rights to add classes and attributes to the schema

  4. Ensures that the schema master is writable (that is, the safety interlock in the registry is removed)

  5. Creates all the new attributes

  6. Creates all the new object classes

  7. Detects errors, and if they occur, the program will roll back any changes to the schema.

DB2 Objects in the Windows 2000 Active Directory

DB2 creates objects in the Active Directory at two locations:

  1. The DB2 database and node objects are created under the computer object of the machine where the DB2 Server is installed. For the DB2 server machine that does not belong to the Windows NT domain, the DB2 database and node objects are created under the "System" container.
  2. The DB2 registry variables and CLI settings at the user level are store in the DB2 property objects under the User object. These objects contain information that is specific to that user.

Object Classes and Attributes Used by DB2

The following tables describe the object classes that are used by DB2:

Table 99. cimManagedElement
Class cimManagedElement
Active Directory LDAP Display Name Not applicable
Active Directory Common Name (cn) Not applicable
Description Provides a base class of many of the system management object classes in the IBM Schema
SubClassOf top
Required Attribute(s)  
Optional Attribute(s) description
Type abstract
OID (Object Identifier) 1.3.18.0.2.6.132
GUID (Global Unique Identifier) b3afd63f-5c5b-11d3-b818-002035559151

Table 100. cimSetting
Class cimSetting
Active Directory LDAP Display Name Not applicable
Active Directory Common Name (cn) Not applicable
Description Provides a base class for configuration and settings in the IBM Schema
SubClassOf cimManagedElement
Required Attribute(s)  
Optional Attribute(s) settingID
Type abstract
OID (object identifier) 1.3.18.0.2.6.131
GUID (Global Unique Identifier) b3afd64d-5c5b-11d3-b818-002035559151

Table 101. eProperty
Class eProperty
Active Directory LDAP Display Name ibm-eProperty
Active Directory Common Name (cn) ibm-eProperty
Description Used to specify any application specific settings for user preference properties
SubClassOf cimSetting
Required Attribute(s)  
Optional Attribute(s) propertyType

cisPropertyType

cisProperty

cesPropertyType

cesProperty

binPropertyType

binProperty

Type structural
OID (object identifier) 1.3.18.0.2.6.90
GUID (Global Unique Identifier) b3afd69c-5c5b-11d3-b818-002035559151

Table 102. DB2Node
Class DB2Node
Active Directory LDAP Display Name ibm-db2Node
Active Directory Common Name (cn) ibm-db2Node
Description Represents a DB2 Server
SubClassOf eSap / ServiceConnectionPoint
Required Attribute(s) db2nodeName
Optional Attribute(s) db2nodeAlias

db2instanceName

db2Type

host / dNSHostName (see Note 2)

protocolInformation/ServiceBindingInformation

Type structural
OID (object identifier) 1.3.18.0.2.6.116
GUID (Global Unique Identifier) b3afd65a-5c5b-11d3-b818-002035559151
Special Notes
  1. The DB2Node class is derived from eSap object class under IBM SecureWay directory and from ServiceConnectionPoint object class under Microsoft Active Directory.
  2. The host is used under IBM SecureWay environment. The dNSHostName attribute is used under Microsoft Active Directory.
  3. The protocolInformation is only used under IBM SecureWay environment. For Microsoft Active Directory, the attribute ServiceBindingInformation, inherited from the ServiceConnectionPoint class, is used to contain the protocol information.

The protocolInformation (in IBM SecureWay Directory) or ServiceBindingInformation (in Microsoft Active Directory) attribute in the DB2Node object contains the communication protocol information to bind the DB2 database server. It consists of tokens that describe the network protocol supported. Each token is separated by a semicolon. There is no space between the tokens. An asterisk (*) may be used to specify an optional parameter.

The tokens for TCP/IP are:

The tokens for APPN are:

Note:On a DB2 for Windows NT client (or for Windows 95 or Windows 98), if the APPN information is not configured on the local SNA stack; and, if the LAN adapter address and optional change password LU are found in LDAP, then the DB2 client tries to use this information to configure the SNA stack if it knows how to configure the stack. This support is not available on DB2 for AIX, or DB2 for Solaris, clients.

The tokens for IPX/SPX are:

The IPX/SPX listener is available on the DB2 server (not on the client) for AIX and Solaris. NetBIOS and NPIPE are not supported on AIX and Solaris.

The tokens for NetBIOS are:

The tokens for Named Pipe are:


Table 103. DB2Database
Class DB2Database
Active Directory LDAP Display Name ibm-db2Database
Active Directory Common Name (cn) ibm-db2Database
Description Represents a DB2 database
SubClassOf top
Required Attribute(s) db2databaseName

db2nodePtr

Optional Attribute(s) db2databaseAlias

db2additionalParameter

db2ARLibrary

db2authenticationLocation

db2gwPtr

db2databaseRelease

DCEPrincipalName

Type structural
OID (object identifier) 1.3.18.0.2.6.117
GUID (Global Unique Identifier) b3afd659-5c5b-11d3-b818-002035559151

Table 104. db2additionalParameters
Attribute db2additionalParameters
Active Directory LDAP Display Name ibm-db2AdditionalParameters
Active Directory Common Name (cn) ibm-db2AdditionalParameters
Description Contains any additional parameters used when connecting to the host database server
Syntax Case Ignore String
Maximum Length 1024
Multi-Valued Single-valued
OID (object identifier) 1.3.18.0.2.4.426
GUID (Global Unique Identifier) b3afd315-5c5b-11d3-b818-002035559151

Table 105. db2authenticationLocation
Attribute db2authenticationLocation
Active Directory LDAP Display Name ibm-db2AuthenticationLocation
Active Directory Common Name (cn) ibm-db2AuthenticationLocation
Description Specifies where authentication takes place
Syntax Case Ignore String
Maximum Length 64
Multi-Valued Single-valued
OID (object identifier) 1.3.18.0.2.4.425
GUID (Global Unique Identifier) b3afd317-5c5b-11d3-b818-002035559151
Notes Valid values are: CLIENT, SERVER, DCS, DCE, KERBEROS, SVRENCRYPT, or DCSENCRYPT

Table 106. db2ARLibrary
Attribute db2ARLibrary
Active Directory LDAP Display Name ibm-db2ARLibrary
Active Directory Common Name (cn) ibm-db2ARLibrary
Description Name of the Application Requestor library
Syntax Case Ignore String
Maximum Length 256
Multi-Valued Single-valued
OID (object identifier) 1.3.18.0.2.4.427
GUID (Global Unique Identifier) b3afd316-5c5b-11d3-b818-002035559151

Table 107. db2databaseAlias
Attribute db2databaseAlias
Active Directory LDAP Display Name ibm-db2DatabaseAlias
Active Directory Common Name (cn) ibm-db2DatabaseAlias
Description Database alias name(s)
Syntax Case Ignore String
Maximum Length 1024
Multi-Valued Multi-valued
OID (object identifier) 1.3.18.0.2.4.422
GUID (Global Unique Identifier) b3afd318-5c5b-11d3-b818-002035559151

Table 108. db2databaseName
Attribute db2databaseName
Active Directory LDAP Display Name ibm-db2DatabaseName
Active Directory Common Name (cn) ibm-db2DatabaseName
Description Database name
Syntax Case Ignore String
Maximum Length 1024
Multi-Valued Single-valued
OID (object identifier) 1.3.18.0.2.4.421
GUID (Global Unique Identifier) b3afd319-5c5b-11d3-b818-002035559151

Table 109. db2databaseRelease
Attribute db2databaseRelease
Active Directory LDAP Display Name ibm-db2DatabaseRelease
Active Directory Common Name (cn) ibm-db2DatabaseRelease
Description Database release number
Syntax Case Ignore String
Maximum Length 64
Multi-Valued Single-valued
OID (object identifier) 1.3.18.0.2.4.429
GUID (Global Unique Identifier) b3afd31a-5c5b-11d3-b818-002035559151

Table 110. db2nodeAlias
Attribute db2nodeAlias
Active Directory LDAP Display Name ibm-db2NodeAlias
Active Directory Common Name (cn) ibm-db2NodeAlias
Description Node alias name(s)
Syntax Case Ignore String
Maximum Length 1024
Multi-Valued Multi-valued
OID (object identifier) 1.3.18.0.2.4.420
GUID (Global Unique Identifier) b3afd31d-5c5b-11d3-b818-002035559151

Table 111. db2nodeName
Attribute db2nodeName
Active Directory LDAP Display Name ibm-db2NodeName
Active Directory Common Name (cn) ibm-db2NodeName
Description Node name
Syntax Case Ignore String
Maximum Length 64
Multi-Valued Single-valued
OID (object identifier) 1.3.18.0.2.4.419
GUID (Global Unique Identifier) b3afd31e-5c5b-11d3-b818-002035559151

Table 112. db2nodePtr
Attribute db2nodePtr
Active Directory LDAP Display Name ibm-db2NodePtr
Active Directory Common Name (cn) ibm-db2NodePtr
Description Pointer to the Node (DB2Node) object that represents the database server which owns the database
Syntax Distinguished Name
Maximum Length 1000
Multi-Valued Single-valued
OID (object identifier) 1.3.18.0.2.4.423
GUID (Global Unique Identifier) b3afd31f-5c5b-11d3-b818-002035559151
Special Notes This relationship allows the client to retrieve protocol communication information to connect to the database

Table 113. db2gwPtr
Attribute db2gwPtr
Active Directory LDAP Display Name ibm-db2GwPtr
Active Directory Common Name (cn) ibm-db2GwPtr
Description Pointer to the Node object that represents the gateway server and from which the database can be accessed
Syntax Distinguished Name
Maximum Length 1000
Multi-Valued Single-valued
OID (object identifier) 1.3.18.0.2.4.424
GUID (Global Unique Identifier) b3afd31b-5c5b-11d3-b818-002035559151

Table 114. db2instanceName
Attribute db2instanceName
Active Directory LDAP Display Name ibm-db2InstanceName
Active Directory Common Name (cn) ibm-db2InstanceName
Description The name of the database server instance
Syntax Case Ignore String
Maximum Length 256
Multi-Valued Single-valued
OID (object identifier) 1.3.18.0.2.4.428
GUID (Global Unique Identifier) b3afd31c-5c5b-11d3-b818-002035559151

Table 115. db2Type
Attribute db2Type
Active Directory LDAP Display Name ibm-db2Type
Active Directory Common Name (cn) ibm-db2Type
Description Type of the database server
Syntax Case Ignore String
Maximum Length 64
Multi-Valued Single-valued
OID (object identifier) 1.3.18.0.2.4.418
GUID (Global Unique Identifier) b3afd320-5c5b-11d3-b818-002035559151
Notes Valid types for database server are: SERVER, MPP, and DCS

Table 116. DCEPrincipalName
Attribute DCEPrincipalName
Active Directory LDAP Display Name ibm-DCEPrincipalName
Active Directory Common Name (cn) ibm-DCEPrincipalName
Description DCE principal name
Syntax Case Ignore String
Maximum Length 2048
Multi-Valued Single-valued
OID (object identifier) 1.3.18.0.2.4.443
GUID (Global Unique Identifier) b3afd32d-5c5b-11d3-b818-002035559151

Table 117. cesProperty
Attribute cesProperty
Active Directory LDAP Display Name ibm-cesProperty
Active Directory Common Name (cn) ibm-cesProperty
Description Values of this attribute may be used to provide application-specific preference configuration parameters. For example, a value may contain XML-formatted data. All values of this attribute must be homogeneous in the cesPropertyType attribute value.
Syntax Case Exact String
Maximum Length 32700
Multi-Valued Multi-valued
OID (object identifier) 1.3.18.0.2.4.307
GUID (Global Unique Identifier) b3afd2d5-5c5b-11d3-b818-002035559151

Table 118. cesPropertyType
Attribute cesPropertyType
Active Directory LDAP Display Name ibm-cesPropertyType
Active Directory Common Name (cn) ibm-cesPropertyType
Description Values of this attribute may be used to describe the syntax, semantics, or other characteristics of all of the values of the cesProperty attribute. For example, a value of "XML" might be used to indicate that all the values of the cesProperty attribute are encoded as XML syntax.
Syntax Case Ignore String
Maximum Length 128
Multi-Valued Multi-valued
OID (object identifier) 1.3.18.0.2.4.308
GUID (Global Unique Identifier) b3afd2d6-5c5b-11d3-b818-002035559151

Table 119. cisProperty
Attribute cisProperty
Active Directory LDAP Display Name ibm-cisProperty
Active Directory Common Name (cn) ibm-cisProperty
Description Values of this attribute may be used to provide application-specific preference configuration parameters. For example, a value may contain an INI file. All values of this attribute must be homogeneous in their cisPropertyType attribute value.
Syntax Case Ignore String
Maximum Length 32700
Multi-Valued Multi-valued
OID (object identifier) 1.3.18.0.2.4.309
GUID (Global Unique Identifier) b3afd2e0-5c5b-11d3-b818-002035559151

Table 120. cisPropertyType
Attribute cisPropertyType
Active Directory LDAP Display Name ibm-cisPropertyType
Active Directory Common Name (cn) ibm-cisPropertyType
Description Values of this attribute may be used to describe the syntax, semantics, or other characteristics of all of the values of the cisProperty attribute. For example, a value of "INI File" might be used to indicate that all the values of the cisProperty attribute are INI files.
Syntax Case Ignore String
Maximum Length 128
Multi-Valued Multi-valued
OID (object identifier) 1.3.18.0.2.4.310
GUID (Global Unique Identifier) b3afd2e1-5c5b-11d3-b818-002035559151

Table 121. binProperty
Attribute binProperty
Active Directory LDAP Display Name ibm-binProperty
Active Directory Common Name (cn) ibm-binProperty
Description Values of this attribute may be used to provide application-specific preference configuration parameters. For example, a value may contain a set of binary-encoded Lotus 123 properties. All values of this attribute must be homogeneous in their binPropertyType attribute values.
Syntax binary
Maximum Length 250000
Multi-Valued Multi-valued
OID (object identifier) 1.3.18.0.2.4.305
GUID (Global Unique Identifier) b3afd2ba-5c5b-11d3-b818-002035559151

Table 122. binPropertyType
Attribute binPropertyType
Active Directory LDAP Display Name ibm-binPropertyType
Active Directory Common Name (cn) ibm-binPropertyType
Description Values of this attribute may be used to describe the syntax, semantics, or other characteristics of all of the values of the binProperty attribute. For example, a value of "Lotus 123" might be used to indicate that all the values of the binProperty attribute are binary-encoded Lotus 123 properties.
Syntax Case Ignore String
Maximum Length 128
Multi-Valued Multi-valued
OID (object identifier) 1.3.18.0.2.4.306
GUID (Global Unique Identifier) b3afd2bb-5c5b-11d3-b818-002035559151

Table 123. PropertyType
Attribute PropertyType
Active Directory LDAP Display Name ibm-propertyType
Active Directory Common Name (cn) ibm-propertyType
Description Values of this attribute describe the semantic characteristics of the eProperty object
Syntax Case Ignore String
Maximum Length 128
Multi-Valued Multi-valued
OID (object identifier) 1.3.18.0.2.4.320
GUID (Global Unique Identifier) b3afd4ed-5c5b-11d3-b818-002035559151

Table 124. settingID
Attribute settingID
Active Directory LDAP Display Name Not applicable
Active Directory Common Name (cn) Not applicable
Description A naming attribute that may be used to identify the cimSetting derived object entries such as eProperty
Syntax Case Ignore String
Maximum Length 256
Multi-Valued Single-valued
OID (object identifier) 1.3.18.0.2.4.325
GUID (Global Unique Identifier) b3afd596-5c5b-11d3-b818-002035559151


[ Top of Page | Previous Page | Next Page ]