Oracle Internet Directory Administrator's Guide
Release 3.0.1

Part Number A90151-01
Go To Documentation Library
Go To Product List
Book List
Go To Table Of Contents
Go To Index

Master Index


Go to previous page Go to next page


Oracle Internet Directory Administrator's Guide describes the features, architecture, and administration of Oracle Internet Directory. For information about installation, see the installation documentation for your operating system.

This preface contains these topics:


Oracle Internet Directory Administrator's Guide is intended for anyone who performs administration tasks for the Oracle Internet Directory. You should be familiar with either the UNIX operating system or the Microsoft Windows NT operating system in order to understand the line-mode commands and examples. You can perform all of the tasks through the line-mode commands, and you can perform most of the tasks through Oracle Directory Manager, which is operating system-independent.

To use this document, you need some familiarity with the Lightweight Directory Access Protocol (LDAP).


This document contains the chapters and appendixes listed in this section. Oracle Corporation encourages you to read the conceptual and other introductory material presented in Part I before performing installation and maintenance.

Part I: Getting Started

Part I provides an overview of the product and its features, a conceptual foundation necessary to configure and manage a directory.

Chapter 1, "Introduction"

This chapter provides an introduction to directories, LDAP, and Oracle Internet Directory features.

Chapter 2, "Concepts and Architecture"

This chapter gives an overview of online directories and Lightweight Directory Access Protocol (LDAP). Provides conceptual descriptions of directory entries, attributes, object classes, naming contexts, schemas, distributed directories, security, and National Language Support. It also discusses Oracle Internet Directory architecture.

Chapter 3, "General Deployment Considerations"

This chapter discusses general issues to consider when deploying Oracle Internet Directory. This chapter helps you assess the requirements of a directory in an enterprise and make effective deployment choices.

Chapter 4, "Preliminary Tasks"

This chapter discusses how to prepare your directory for configuration and use. It tells you how to start and stop OID Monitor and instances of Oracle directory server and Oracle directory replication server. It discusses the need to reset the default security configuration, how to upgrade from earlier releases of Oracle Internet Directory, and how to migrate data from other LDAP-compliant directories.

Chapter 5, "Using the Administration Tools"

This chapter explains how to use the various administration tools: Oracle Directory Manager, command-line tools, bulk tools, Catalog Management tool, OID Database Password Utility, replication tools, and Database Statistics Collection tool

Part II: Basic Directory Administration

Part II guides you through the tasks required to configure and maintain Oracle Internet Directory.

Chapter 6, "Managing the Oracle Directory Server"

This chapter provides instructions for managing server configuration set entries; setting system operational attributes; managing naming contexts and password encryption; configuring searches; managing super, guest, and proxy users; setting debug logging levels; using audit log; viewing active server instance information; and changing the password to an Oracle database server.

Chapter 7, "Managing the Directory Schema"

This chapter explains what a directory schema is, what an object class is, and what an attribute is. It tells you how to manage the Oracle Internet Directory schema by using Oracle Directory Manager and the command-line tools.

Chapter 8, "Managing Directory Entries"

This chapter explains how to search, view, add, modify and manage entries by using Oracle Directory Manager and the command-line tools.

Chapter 9, "Managing Globalization Support in the Directory"

Discusses National Language Support (NLS) as used by Oracle Internet Directory.

Chapter 10, "Managing the Delegated Administration Service"

This chapter explains the Delegated Administration Service, which enables directory users to modify their own personal data--such as addresses, phone numbers, and photos--without the intervention of an administrator. It also enables users to search other parts of the directory to which they have access. This frees directory administrators for other tasks in the enterprise.

Part III Directory Security

Part III tells how to secure data within the directory itself and within an enterprise deployment of a directory.

Chapter 11, "About Security in Oracle Internet Directory"

This chapter describes the security features available with Oracle Internet Directory, and explains how to deploy the directory for administrative delegation.

Chapter 12, "Managing Secure Sockets Layer (SSL)"

This chapter introduces and explains how to configure the features of Secure Sockets Layer (SSL).

Chapter 13, "Managing Directory Access Control"

This chapter provides an overview of access control policies and describes how to administer directory access.

Part IV Directory Replication

Part IV provides a detailed discussion of replication and how to manage it.

Chapter 14, "About Directory Replication"

This chapter expands on the discussion about replication in Chapter 2, "Concepts and Architecture".

Chapter 15, "Managing Directory Replication"

This chapter explains how to install and initialize Oracle directory replication server software the first time, and how to install new nodes into an environment where that software is already installed.

Chapter 16, "Adding a Node to a DRG by Using the Database Copy Procedure"

This chapter describes an alternate method of adding a node to a replicated directory system if the directory is very large.

Part V: Directory Deployment

Part V discusses important deployment considerations, including capacity planning, high availability, and tuning.

Chapter 17, "Capacity Planning Considerations"

This chapter tells you how to assess applications' directory access requirements and ensure that the Oracle Internet Directory has adequate computer resources to service requests at an acceptable rate.

Chapter 18, "High Availability And Failover Considerations"

This chapter describes the availability and failover features of various components in the Oracle Internet Directory technology stack, and provides guidelines for exploiting them optimally for typical directory deployment.

Chapter 19, "Tuning Considerations"

This chapter gives guidelines for ensuring that the combined hardware and software are yielding the desired levels of performance.

Part VI: Oracle Internet Directory and Clusters

Part VI discusses cluster support in Oracle Internet Directory.

Chapter 20, "Managing Failover in Cluster Configurations"

This chapter explains how to increase high availability by using logical hosts--as opposed to physical hosts--in clustered environments.

Chapter 21, "Managing Directory Failover in an Oracle9i Real Application Clusters Environment"

This chapter discusses the ways you can run Oracle Internet Directory in an Oracle Real Application Clusters system.

Part VII: The Oracle Directory Integration Platform

Part VII explains the concepts, architecture, and components of the Oracle Directory Integration platform, and tells you how to configure and use it to synchronize multiple directories with Oracle Internet Directory.

Chapter 22, "About the Oracle Directory Integration Platform"

This chapter introduces the Oracle Directory Integration platform, its components, architecture, and administration tools.

Chapter 23, "Managing Directory Integration Agents and Profiles"

This chapter discusses directory integration agents and the operations they perform in the Oracle Directory Integration platform. It explains how to manage partner agents by using either Oracle Directory Manager of command-line tools.

Chapter 24, "Managing the Oracle Directory Integration Server"

This chapter discusses the Oracle directory integration server and tells you how to configure and manage it.

Chapter 25, "Managing Security in the Oracle Directory Integration Platform"

This chapter discusses the most important aspects of security in the Oracle Directory Integration platform.

Chapter 26, "Bootstrapping a Directory in the Oracle Directory Integration Platform"

This chapter explains some of the initial setup tasks you may need to perform as you begin using the Oracle Directory Integration platform.

Chapter 27, "Synchronizing with Oracle Human Resources"

If you store employee data in Oracle Internet Directory, and if you use Oracle Human Resources to create, modify, and delete that data, then you must ensure that the data is synchronized between the two. This chapter explains the Oracle Human Resources agent, which enables you to do this.

Part VIII: Appendixes

Appendix A, "Syntax for LDIF and Command-Line Tools"

This appendix provides syntax, usage notes, and examples for LDAP Data Interchange Format and LDAP command-line tools.

Appendix B, "Using Access Control Directive Format"

This appendix describes the format (syntax) of Access Control Information Items(ACIs).

Appendix C, "Schema Elements"

This appendix lists schema elements supported in Oracle Internet Directory.

Appendix D, "Using Oracle Wallet Manager"

This appendix describes and explains how to use Oracle Wallet Manager to create and manage wallets and certificates.

Appendix E, "Upgrading from Oracle Internet Directory Release 2.1.1"

This appendix tells you how to upgrade to Oracle Internet Directory release 3.0.1 from Oracle Internet Directory release 2.1.1.

Appendix F, "Migrating Data from Other LDAP-Compliant Directories"

This appendix explains the steps to migrate data from LDAP v3-compatible directories into Oracle Internet Directory.

Appendix G, "Troubleshooting"

This appendix lists possible failures and error codes and their probable causes.

Related Documentation

For more information, see:

In North America, printed documentation is available for sale in the Oracle Store at

Customers in Europe, the Middle East, and Africa (EMEA) can purchase documentation from

Other customers can contact their Oracle representative to purchase printed documentation.

To download free release notes, installation documentation, white papers, or other collateral, please visit the Oracle Technology Network (OTN). You must register online before using OTN; registration is free and can be done at

If you already have a username and password for OTN, then you can go directly to the documentation section of the OTN Web site at

For additional information, see:


This section describes the conventions used in the text and code examples of this documentation set. It describes:

Conventions in Text

We use various conventions in text to help you more quickly identify special terms. The following table describes those conventions and provides examples of their use.

Convention  Meaning  Example 


Bold typeface indicates terms that are defined in the text or terms that appear in a glossary, or both. 

When you specify this clause, you create an index-organized table.  


Italic typeface indicates book titles or emphasis. 

Oracle9i Database Concepts

Ensure that the recovery catalog and target database do not reside on the same disk. 

UPPERCASE monospace (fixed-width font) 

Uppercase monospace typeface indicates elements supplied by the system. Such elements include parameters, privileges, datatypes, RMAN keywords, SQL keywords, SQL*Plus or utility commands, packages and methods, as well as system-supplied column names, database objects and structures, user names, and roles. 

You can specify this clause only for a NUMBER column.

You can back up the database by using the BACKUP command.

Query the TABLE_NAME column in the USER_TABLES data dictionary view.


lowercase monospace (fixed-width font) 

Lowercase monospace typeface indicates executables, filenames, directory names, and sample user-supplied elements. Such elements include computer and database names, net service names, and connect identifiers, as well as user-supplied database objects and structures, column names, packages and classes, user names and roles, program units, and parameter values.

Note: Some programmatic elements use a mixture of UPPERCASE and lowercase. Enter these elements as shown. 

Enter sqlplus to open SQL*Plus.

The password is specified in the orapwd file.

Back up the datafiles and control files in the /disk1/oracle/dbs directory.

The department_id, department_name, and location_id columns are in the hr.departments table.

Set the QUERY_REWRITE_ENABLED initialization parameter to true.

Connect as oe user.

The JRepUtil class implements these methods. 

lowercase monospace (fixed-width font) italic 

Lowercase monospace italic font represents placeholders or variables. 

You can specify the parallel_clause.

Run Uold_release.SQL where old_release refers to the release you installed prior to upgrading. 

Conventions in Code Examples

Code examples illustrate SQL, PL/SQL, SQL*Plus, or other command-line statements. They are displayed in a monospace (fixed-width) font and separated from normal text as shown in this example:

SELECT username FROM dba_users WHERE username = 'MIGRATE';

The following table describes typographic conventions used in code examples and provides examples of their use.

Convention  Meaning  Example 

[ ] 

Brackets enclose one or more optional items. Do not enter the brackets. 

DECIMAL (digits [ , precision ]) 

{ } 

Braces enclose two or more items, one of which is required. Do not enter the braces. 


A vertical bar represents a choice of two or more options within brackets or braces. Enter one of the options. Do not enter the vertical bar. 




Horizontal ellipsis points indicate either:

  • That we have omitted parts of the code that are not directly related to the example

  • That you can repeat a portion of the code


CREATE TABLE ... AS subquery;

SELECT col1, col2, ... , coln FROM employees; 



Vertical ellipsis points indicate that we have omitted several lines of code not directly related to the example. 


Other notation 

You must enter symbols other than brackets, braces, vertical bars, and ellipsis points as shown. 

acctbal NUMBER(11,2);

acct CONSTANT NUMBER(4) := 3; 


Italicized text indicates placeholders or variables for which you must supply particular values. 

CONNECT SYSTEM/system_password

DB_NAME = database_name 


Uppercase typeface indicates elements supplied by the system. We show these terms in uppercase in order to distinguish them from terms you define. Unless terms appear in brackets, enter them in the order and with the spelling shown. However, because these terms are not case sensitive, you can enter them in lowercase. 

SELECT last_name, employee_id FROM employees;


DROP TABLE hr.employees; 


Lowercase typeface indicates programmatic elements that you supply. For example, lowercase indicates names of tables, columns, or files.

Note: Some programmatic elements use a mixture of UPPERCASE and lowercase. Enter these elements as shown. 

SELECT last_name, employee_id FROM employees;

sqlplus hr/hr


Conventions for Windows Operating Systems

The following table describes conventions for Windows operating systems and provides examples of their use.

Convention  Meaning  Example 

Choose Start > 

How to start a program. For example, to start Oracle Database Configuration Assistant, you must click the Start button on the taskbar and then choose Programs > Oracle - HOME_NAME > Database Administration > Database Configuration Assistant.  

Choose Start > Programs > Oracle - HOME_NAME > Database Administration > Database Configuration Assistant 


Represents the Windows command prompt of the current hard disk drive. Your prompt reflects the subdirectory in which you are working. Referred to as the command prompt in this guide. 



Represents the Oracle home name.

The home name can be up to 16 alphanumeric characters. The only special character allowed in the home name is the underscore.  

C:\> net start OracleHOME_NAMETNSListener 


In releases prior to 8.1, when you installed Oracle components, all subdirectories were located under a top level ORACLE_HOME directory that by default was:

  • C:\orant for Windows NT

  • C:\orawin95 for Windows 95

  • C:\orawin98 for Windows 98

or whatever you called your Oracle home.

In this Optimal Flexible Architecture (OFA)-compliant release, all subdirectories are not under a top level ORACLE_HOME directory. There is a top level directory called ORACLE_BASE that by default is C:\oracle. If you install release 9.0 on a computer with no other Oracle software installed, the default setting for the first Oracle home directory is C:\oracle\ora90. The Oracle home directory is located directly under ORACLE_BASE.

All directory path examples in this guide follow OFA conventions.

See Oracle9i Database Getting Starting for Windows for additional information on OFA compliances and for information on installing Oracle products in non-OFA compliant directories. 

Go to the ORACLE_BASE\ORACLE_HOME\rdbms\admin directory.


Documentation Accessibility

Oracle's goal is to make our products, services, and supporting documentation accessible to the disabled community with good usability. To that end, our documentation includes features that make information available to users of assistive technology. This documentation is available in HTML format, and contains markup to facilitate access by the disabled community. Standards will continue to evolve over time, and Oracle is actively engaged with other market-leading technology vendors to address technical obstacles so that our documentation can be accessible to all of our customers. For additional information, visit the Oracle Accessibility Program Web site at

JAWS, a Windows screen reader, may not always correctly read the code examples in this document. The conventions for writing code require that closing braces should appear on an otherwise empty line; however, JAWS may not always read a line of text that consists solely of a bracket or brace.

Go to previous page Go to next page
Copyright © 1996-2001, Oracle Corporation.

All Rights Reserved.
Go To Documentation Library
Go To Product List
Book List
Go To Table Of Contents
Go To Index

Master Index