Skip Headers
Oracle® Traffic Director Configuration File Reference
11g Release 1 (

Part Number E21038-03
Go to Documentation Home
Go to Book List
Book List
Go to Table of Contents
Go to Index
Go to Feedback page
Contact Us

Go to previous page
Go to next page
PDF · Mobi · ePub

1 Overview of Configuration Files and Directories

The configuration and behavior of Oracle Traffic Director is determined by a set of configuration files. You can use the Oracle Traffic Director (OTD) Administrator Console and the command-line interface (CLI) to change the configuration file settings. You can also manually edit these files.

This chapter includes the following topics:

1.1 Configuration Files

Each server instance has its own directory, called INSTANCE_HOME in this document. The INSTANCE_HOME/config directory contains configuration files for the Oracle® Traffic Director components. The exact number and names of the configuration files depend on the components that were enabled or loaded into the server. For the default location of the INSTANCE_HOME, see Section 1.1.4, "Default Paths".

The following sections describe the configuration files and related information pertaining to the Oracle Traffic Director:

1.1.1 The server.xml File

The server.xml file contains the Oracle® Traffic Director configuration. For more information about the server.xml file, see Chapter 2, "Syntax and Use of server.xml".

1.1.2 The obj.conf File

The obj.conf file contains directives for HTTP request processing. For more information about the obj.conf file, see Chapter 4, "Syntax and Use of obj.conf."

1.1.3 The certmap.conf File

The certmap.conf file describes how a certificate is mapped to an LDAP entry designated by issuerDN. Syntax

certmap name issuerDN

name:property1 [value1]
name:property2 [value2]

The default certificate is named default, and the default issuerDN is also named default. Therefore, the first line defined in the certmap.conf file must be as follows:

certmap default default

Use # at the beginning of a line to indicate a comment. Properties

Table 1-1 describes the properties of certmap.conf file.

Table 1-1 certmap.conf properties

Attribute Allowed Values Default Value Description


See description

Commented out

Used to form the base DN for performing an LDAP search while mapping the certificate to a user entry. Values are as follows:

  • Commented out - Takes the user's DN from the certificate as is

  • Empty - Searches the entire LDAP tree (DN == suffix)

  • Comma-separated attributes - Forms the DN


See description

Commented out

Used to form the filter for performing an LDAP search while mapping the certificate to a user entry. Values are as follows:

  • Commented out or empty - Sets the filter to "objectclass=*"

  • Comma-separated attributes - Forms the filter


on or off

off (commented out)

Specifies whether certificates are verified.


Name of the LDAP attribute

certSubjectDN (commented out)

Specifies the name of the attribute in the LDAP database that contains the DN of the certificate.


Path to shared lib or dll


Specifies the library path for custom certificate mapping code.


Name of initialization function


Specifies the initialization function in the certificate mapping code referenced by library.

1.1.4 Default Paths

The default paths that are used in Oracle® Traffic Director are listed below. Table 1-2 describes the default paths and file names.

Table 1-2 Default Paths

Placeholder Description


The directory in which Oracle® Traffic Director is installed.


The directory that contains the files pertaining to the Oracle® Traffic Director administration server and Oracle® Traffic Director instances.

1.2 Directory Structure

This section describes the directory structures that are created when you first install Oracle® Traffic Director and setup the installation. In a typical OTD installation, except for the admin-server directory and net-server-id instance subdirectory, all other directories are located in the ORACLE_HOME directory. The admin-server directory and the net-server-id subdirectory are located in the INSTANCE_HOME directory. Creating an administration server or an administration node requires you to execute the configure-server command. To create an administration node in OTD, you must make sure that the administration server is up and running. The newly created administration node will be registered with the administration server. Before creating any instances, create an administration server by running the configure-server command. Later, execute the create-instance command to create instances in OTD. For more information about the CLI commands, see Oracle Traffic Director Command-line Reference. For more information about the default locations for these directories, see Section 1.1.4, "Default Paths".

The following are the directories under the Oracle® Traffic Director installation directory, ORACLE_HOME:

1.2.1 bin

The bin directory contains the commands to administer Oracle Traffic Director, including the command-line interface (tadm).

1.2.2 Legal

The Legal directory contains the third party information pertaining to the Oracle® Traffic Director software.

1.2.3 lib

The lib directory contains internal binaries, scripts, libraries, and bundled plug-ins. These files are private files, for internal use only.

Information pertaining to the admin-server directory and net-server-id subdirectory are listed below.

1.2.4 admin-server

The admin-server directory contains the following subdirectories:

  • bin - Contains the binary files that are required to start, stop, and restart Oracle® Traffic Director. On UNIX systems, this directory also contains the file required for rotating logs.

  • config - Contains the private configuration files for the administration server. These files are for internal use.

  • config-store - Contains files used by the administration server to track server configuration information.


The files in this directory are created by Oracle® Traffic Director for internal use. Do not edit, run scripts on, or otherwise access any files in the config-store directory.

  • generated - Contains files generated by the instance, such as Java class files corresponding to JavaServer Pages (JSP).

  • logs - Contains any error messages or access log files that are generated by a server instance.

1.2.5 net-server-id

An net-server-id directory is created for every instance you create in OTD. This directory has the following subdirectories and files:

  • bin - Contains the commands for starting, stopping, restarting, and reconfiguring the server. It also contains the command for rotating the log files.

  • config - Contains the following instance-specific configuration files:

    • cert9.db - NSS certificate database.

    • <C1>-obj.conf - Virtual server specific directory.

    • key4.db - NSS private key database.

    • obj.conf - Instructions for Oracle® Traffic Director for handling HTTP requests from clients.

    • pkcs11.txt - NSS PKCS #11 module database.

    • server.xml - Most of the server configuration settings.

  • logs - Contains log files generated by this server instance.

1.3 Dynamic Reconfiguration

Dynamic reconfiguration enables you to make configuration changes to a runtime Oracle Traffic Director. You do not have to stop or restart the Oracle Traffic Director for the changes to take effect.

Dynamic configuration happens in one of the following ways:

You can dynamically change the configuration settings in the obj.conf file without restarting the server. In addition, most settings in the server.xml file can be changed without restarting the server. If you must restart the server, a warning message appears in the server log when you deploy the configuration or run the reconfig command.

You cannot dynamically reconfigure the following server.xml configuration parameters:

When you run the reconfig command, a new configuration object is created, and all new incoming requests are processed based on this new configuration object. The current configuration object gets removed when no HTTP requests are using the object.

In case a wrong configuration occurs during dynamic reconfiguration, the server displays an error message. The server logs the error message to a log file specified by the last configuration that worked.

Certain wrong configurations result in warning messages but do not cause the server to reject the configuration. Other wrong configurations result in error messages and cause the server to reject the configuration. If the server rejects a configuration during startup, the server does not start. If the server rejects a configuration during a dynamic reconfiguration, the server reverts to the last configuration that worked.