Oracle Fusion Middleware Administration Guide for Oracle Directory Server Enterprise Edition

Preface

The Administration Guide, provides procedural information for configuring Directory Server and Directory Proxy Server features from the command line. Instructions for configuring these feature by using the web-based interface (Directory Service Control Center) are provided in the online help.

Who Should Use This Book

This Administration Guide is intended for administrators of Directory Server and Directory Proxy Server software.

Before You Read This Book

This book does not provide information on installing the software. For installation information, see the Oracle Fusion Middleware Installation Guide for Oracle Directory Server Enterprise Edition.

If you are migrating from an older version of Directory Server or Directory Proxy Server, see the Oracle Fusion Middleware Upgrade and Migration Guide for Oracle Directory Server Enterprise Edition for instructions on migrating servers. If you are unfamiliar with the new features in this version, it might be useful to read the Oracle Fusion Middleware Evaluation Guide for Oracle Directory Server Enterprise Edition for an overview of the new features.

How This Book Is Organized

Part I, Directory Server Administration, provides procedural information on administering Directory Server.

Part II, Directory Proxy Server Administration, provides procedural information on administering Directory Proxy Server

Examples Used in This Guide

For consistency reasons, the same example data is used throughout this guide. Replace these values with the appropriate values for your system.

Table P–1 Default Values Used in Examples

Variable 

Values used in examples 

Suffix (SUFFIX_DN) 

dc=example,dc=com 

Instance path (INSTANCE_PATH) 

For Directory Server: /local/dsInst/ 

For Directory Proxy Server: /local/dps/ 

Hostnames (HOST) 

host1, host2, host3 

Port (PORT) 

LDAP: Default for root: 389. Default for non-root: 1389 

SSL default: Default for root: 636. Default for non-root: 1636 

Oracle Directory Server Enterprise Edition Documentation Set

This documentation set explains how to use Oracle Directory Server Enterprise Edition to evaluate, design, deploy, and administer directory services. In addition, it shows how to develop client applications for Directory Server Enterprise Edition. The Directory Server Enterprise Edition documentation set is available at http://docs.sun.com/coll/1819.3.

The following table lists the documents that make up the Directory Server Enterprise Edition documentation set.

Table P–2 Directory Server Enterprise Edition Documentation

Document Title 

Contents 

Oracle Fusion Middleware Release Notes for Oracle Directory Server Enterprise Edition

Contains the latest information about Directory Server Enterprise Edition, including known problems. 

Oracle Fusion Middleware Documentation Center for Oracle Directory Server Enterprise Edition

Contains links to key areas of the documentation set that help you to quickly locate the key information. 

Oracle Fusion Middleware Evaluation Guide for Oracle Directory Server Enterprise Edition

Introduces the key features of this release. Demonstrates how these features work and what they offer in the context of a deployment that you can implement on a single system. 

Oracle Fusion Middleware Deployment Planning Guide for Oracle Directory Server Enterprise Edition

Explains how to plan and design highly available, highly scalable directory services based on Directory Server Enterprise Edition. Presents the basic concepts and principles of deployment planning and design. Discusses the solution life cycle, and provides high-level examples and strategies to use when planning solutions based on Directory Server Enterprise Edition. 

Oracle Fusion Middleware Installation Guide for Oracle Directory Server Enterprise Edition

Explains how to install the Directory Server Enterprise Edition software. Shows how to configure the installed software and verify the configured software. 

Oracle Fusion Middleware Upgrade and Migration Guide for Oracle Directory Server Enterprise Edition

Provides upgrade instructions to upgrade the version 6 installation and migration instructions to migrate version 5.2 installations. 

Oracle Fusion Middleware Administration Guide for Oracle Directory Server Enterprise Edition

Provides command-line instructions for administering Directory Server Enterprise Edition. 

For hints and instructions about using the Directory Service Control Center, DSCC, to administer Directory Server Enterprise Edition, see the online help provided in DSCC. 

Oracle Fusion Middleware Reference for Oracle Directory Server Enterprise Edition

Introduces technical and conceptual foundations of Directory Server Enterprise Edition. Describes its components, architecture, processes, and features.  

Oracle Fusion Middleware Man Page Reference for Oracle Directory Server Enterprise Edition

Describes the command-line tools, schema objects, and other public interfaces that are available through Directory Server Enterprise Edition. Individual sections of this document can be installed as online manual pages. 

Oracle Fusion Middleware Troubleshooting Guide for Oracle Directory Server Enterprise Edition

Provides information for defining the scope of the problem, gathering data, and troubleshooting the problem areas by using various tools. 

Sun Java System Identity Synchronization for Windows 6.0 Deployment Planning Guide

Provides general guidelines and best practices for planning and deploying Identity Synchronization for Windows. 

Sun Java System Identity Synchronization for Windows 6.0 Installation and Configuration Guide

Describes how to install and configure Identity Synchronization for Windows. 

Installation Instructions for Identity Synchronization for Windows 6.0 Service Pack 1

Provides installation instructions for Identity Synchronization for Windows 6.0 SP1. 

Oracle Fusion Middleware Developer’s Guide for Oracle Directory Server Enterprise Edition 11 g Release 1 (11.1.1)

Shows how to develop directory client applications with the tools and APIs that are provided as part of Directory Server Enterprise Edition. This guide is not provided as part of the documentation set, but is bundled, with all sample code files, in an example.zip file, available at .

For an introduction to Directory Server Enterprise Edition, review the following documents in the order in which they are listed.

DSEE documentation map

Related Reading

The SLAMD Distributed Load Generation Engine is a Java application that is designed to stress test and analyze the performance of network-based applications. This application was originally developed by Sun Microsystems, Inc. to benchmark and analyze the performance of LDAP directory servers. SLAMD is available as an open source application under the Sun Public License, an OSI-approved open source license. To obtain information about SLAMD, go to http://www.slamd.com/. SLAMD is also available as a java.net project. See https://slamd.dev.java.net/.

Java Naming and Directory Interface (JNDI) supports accessing the Directory Server using LDAP and DSML v2 from Java applications. For information about JNDI, see http://java.sun.com/products/jndi/. The JNDI Tutorial contains detailed descriptions and examples of how to use JNDI. This tutorial is at http://java.sun.com/products/jndi/tutorial/.

Identity Synchronization for Windows uses Message Queue with a restricted license. Message Queue documentation is available at http://docs.sun.com/coll/1307.6.

Identity Synchronization for Windows works with Microsoft Windows password policies.

Redistributable Files

Directory Server Enterprise Edition does not provide any files that you can redistribute.

Default Paths and Command Locations

This section explains the default paths used in documentation, and provides locations of commands on different operating systems and deployment types.

Default Paths

The table in this section describes the default paths that are used in this document. For complete descriptions of the files installed, see Chapter 1, Directory Server Enterprise Edition File Reference, in Oracle Fusion Middleware Reference for Oracle Directory Server Enterprise Edition.

Table P–3 Default Paths

Placeholder 

Description 

Default Value 

install-path

Represents the base installation directory for Directory Server Enterprise Edition software.

When you install from a zip distribution using unzip, the install-path is the current-directory/dsee7.

When you install from a native package distribution, the default install-path is /opt/SUNWdsee7.

instance-path

Represents the full path to an instance of Directory Server or Directory Proxy Server.

Documentation uses /local/dsInst/ for Directory Server and /local/dps/ for Directory Proxy Server.

No default path exists. Instance paths must nevertheless always be found on a local file system.

On Solaris systems, the /var directory is recommended:

serverroot

Represents the parent directory of the Identity Synchronization for Windows installation location

Depends on your installation. Note that the concept of a serverroot no longer exists for Directory Server and Directory Proxy Server.

isw-hostname

Represents the Identity Synchronization for Windows instance directory

Depends on your installation 

/path/to/cert8.db

Represents the default path and file name of the client’s certificate database for Identity Synchronization for Windows

current-working-dir/cert8.db

serverroot/isw-hostname/logs/

Represents the default path to the Identity Synchronization for Windows local log files for the System Manager, each connector, and the Central Logger

Depends on your installation 

serverroot/isw-hostname/logs/central/

Represents the default path to the Identity Synchronization for Windows central log files

Depends on your installation 

Command Locations

The table in this section provides locations for commands that are used in Directory Server Enterprise Edition documentation. To learn more about each of the commands, see the relevant man pages.

Table P–4 Command Locations

Command 

Native Package Distribution 

Zip Distribution 

cacaoadm

/usr/sbin/cacaoadm

Solaris, Linux, HP—UX —  

install-path/bin/cacaoadm

Windows - 

install-path\bin\cacaoadm.bat

certutil

/usr/sfw/bin/certutil

install-path/bin/certutil

dpadm(1M)

install-path/bin/dpadm

install-path/bin/dpadm

dpconf(1M)

install-path/bin/dpconf

install-path/bin/dpconf

dsadm(1M)

install-path/bin/dsadm

install-path/bin/dsadm

dsccmon(1M)

install-path/bin/dsccmon

install-path/bin/dsccmon

dsccreg(1M)

install-path/bin/dsccreg

install-path/bin/dsccreg

dsccsetup(1M)

install-path/bin/dsccsetup

install-path/bin/dsccsetup

dsconf(1M)

install-path/bin/dsconf

install-path/bin/dsconf

dsmig(1M)

install-path/bin/dsmig

install-path/bin/dsmig

dsutil(1M)

install-path/bin/dsutil

install-path/bin/dsutil

entrycmp(1)

install-path/bin/entrycmp

install-path/bin/entrycmp

fildif(1)

install-path/bin/fildif

install-path/bin/fildif

idsktune(1M)

Not provided 

At the root of the unzipped zip distribution 

insync(1)

install-path/bin/insync

install-path/bin/insync

ldapsearch(1)

install-path/dsrk/bin/ldapsearch

install-path/dsrk/bin/ldapsearch

repldisc(1)

install-path/bin/repldisc

install-path/bin/repldisc

Typographic Conventions

The following table describes the typographic conventions that are used in this book.

Table P–5 Typographic Conventions

Typeface 

Meaning 

Example 

AaBbCc123

The names of commands, files, and directories, and onscreen computer output 

Edit your .login file.

Use ls -a to list all files.

machine_name% you have mail.

AaBbCc123

What you type, contrasted with onscreen computer output 

machine_name% su

Password:

aabbcc123

Placeholder: replace with a real name or value 

The command to remove a file is rm filename.

AaBbCc123

Book titles, new terms, and terms to be emphasized 

Read Chapter 6 in the User's Guide.

A cache is a copy that is stored locally.

Do not save the file.

Note: Some emphasized items appear bold online.

Shell Prompts in Command Examples

The following table shows the default UNIX system prompt and superuser prompt for shells that are included in the Solaris OS. Note that the default system prompt that is displayed in command examples varies, depending on the Solaris release.

Table P–6 Shell Prompts

Shell 

Prompt 

Bash shell, Korn shell, and Bourne shell 

$

Bash shell, Korn shell, and Bourne shell for superuser 

#

C shell 

machine_name%

C shell for superuser 

machine_name#

Symbol Conventions

The following table explains symbols that might be used in this book.

Table P–7 Symbol Conventions

Symbol 

Description 

Example 

Meaning 

[ ]

Contains optional arguments and command options. 

ls [-l]

The -l option is not required.

{ | }

Contains a set of choices for a required command option. 

-d {y|n}

The -d option requires that you use either the y argument or the n argument.

${ }

Indicates a variable reference. 

${com.sun.javaRoot}

References the value of the com.sun.javaRoot variable.

Joins simultaneous multiple keystrokes. 

Control-A 

Press the Control key while you press the A key. 

Joins consecutive multiple keystrokes. 

Ctrl+A+N 

Press the Control key, release it, and then press the subsequent keys. 

-> 

Indicates menu item selection in a graphical user interface. 

File -> New -> Templates 

From the File menu, choose New. From the New submenu, choose Templates. 

Documentation, Support, and Training

The following additional resources are provided:

Contact Us

Oracle welcomes your comments and suggestions on the quality and usefulness of its documentation. Your comments are an important part of our revision process.

If you find any errors or have any other suggestions for improvement, please mail appserverdocs_us@oracle.com and indicate the title and part number of the documentation along with the chapter, section, and page number, if available. Please let us know if you want a reply.

Oracle Technology Network offers a huge range of resources on Oracle software.

You can also get further help and information with Oracle software from: