Sun Java System Directory Server Enterprise Edition 6.0 Administration Guide

Chapter 16 Directory Proxy Server Tools

Sun JavaTM System Directory Proxy Server provides a browser interface and command-line tools to register and manage instances of Directory Proxy Server. The browser interface is called Directory Service Control Center (DSCC). This chapter describes basic tasks that are required to administer Directory Proxy Server by using DSCC or the command line.

To decide whether to use DSCC or the command line to perform a specific task, see Deciding When to Use DSCC and When to Use the Command Line.

For more information about the administration framework, see Directory Server Enterprise Edition Administration Model in Sun Java System Directory Server Enterprise Edition 6.0 Deployment Planning Guide.

This chapter covers the following topics:

Using DSCC for Directory Proxy Server

This section describes how to access DSCC for Directory Proxy Server.

ProcedureTo Access DSCC for Directory Proxy Server

  1. Access DSCC in the same way as you would for Directory Server.

    See To Access DSCC.

  2. Click on the Proxy Server tab to view and manage Directory Proxy Server.

    The following figure shows the initial window for Directory Proxy Server.

    Figure 16–1 Initial DSCC Window for Directory Proxy Server

    Screen capture shows a list of registered Directory Proxy Servers
in DSCC.

  3. Click a Directory Proxy Server instance to view or to manage that server.


    Note –

    For more information about using DSCC, see the online help.


Command-Line Tools for Directory Proxy Server

The commands-line tools that you use to work with Directory Proxy Server are called dpadm and dpconf. For information about how to use these commands, see the dpadm(1M) and dpconf(1M) man pages.

This section describes the location of the dpadm and dpconf commands. It also provides information on environment variables, comparisons between the commands, and where to find help for using the commands.

Location of Directory Proxy Server Commands

The Directory Proxy Server command-line tools are located in the following directory by default:


install-path/dps6/bin

Your installation path depends on your operating system. Installation paths for all operating systems are listed in Default Paths and Command Locations.

Setting Environment Variables for dpconf

The dpconf command requires some options that you can preset by using environment variables. If you do not specify an option when using the command, or do not set the environment variable, the default setting will be used. You can configure environment variables for the following options:

-D userDN

User bind DN. Environment variable: LDAP_ADMIN_USER. Default: cn=Proxy Manager.

-w password-file

Password file for the user bind DN. Environment variable: LDAP_ADMIN_PWF. Default: Prompt for password.

-h host

Host name or IP address. Environment variable: DIR_PROXY_HOST. Default: localhost.

-p LDAP-port

LDAP port number. Environment variable: DIR_PROXY_PORT. Default: 389 if the server instance is running as root, and 1389 if the server instance is running as a regular user.

For more details, see the dpconf(1M) man page.

Comparison of dpadm and dpconf

The following table shows a comparison of the dpadm and dpconf commands.

Table 16–1 Comparison of the dpadm and dpconf Commands

 

dpadm Command

dpconf Command

Purpose 

To manage the process or the files on a local instance of Directory Proxy Server 

To configure a local or remote instance of Directory Proxy Server 

User 

Operating system user 

LDAP user 

Local or remote 

The command must be local to the instance, that is, the command must be run on the host on which the server is running.

The command can be local to the instance but can also be run from anywhere on the network.

Example uses of the command 

Create an instance of Directory Proxy Server. 

Start and stop an instance of Directory Proxy Server. 

Manage the certificate database. 

Modify the configuration of an instance of Directory Proxy Server. 

Create a data view. 

Configure load balancing in a data source pool. 

Server state 

The server can be running or stopped. 

The server must be running.

How the command identifies the server instance 

By specifying the instance path. The instance path can be relative or absolute. 

By specifying the host name or IP address and the port number. 

The command uses the LDAP port (-p) or the LDAPS secure port (-P). If a port number is not specified on the command line, the environment variable PROXY_PORT is used. If the environment variable is not set, the default ports are used.

Setting Multi-Valued Properties With dpconf

Certain Directory Proxy Server properties can take multiple values. The syntax to specify these values is as follows:


$ dpconf set-container-prop -h host -p port container-name \
 property:value1 property:value2

For example, to set multiple writable attributes for an LDAP data view named my-view, use this command:


$ dpconf set-ldap-data-view-prop -h host1 -p 1389 my-view \
 writable-attr:uid writable-attr:cn writable-attr:userPassword

If you add or modify a value for a multi-valued property that already contains values, you must reset all the values. For example, in the scenario described previously, if you want to add sn as a writable attribute, you must include all the other writable attributes in the command:


$ dpconf set-ldap-data-view-prop -h host1 -p 1389 my-view \
 writable-attr:uid writable-attr:cn writable-attr:userPassword writable-attr:sn

The same rule applies if you want to remove a value. So, to remove userPassword from the list of writable attributes in the previous example, use this command:


$ dpconf set-ldap-data-view-prop -h host1 -p 1389 my-view \
 writable-attr:uid writable-attr:cn writable-attr:sn

Obtaining Help for Using dpadm and dpconf

For information about how to use the dpadm and dpconf commands, see the dpadm(1M) and dpconf(1M) man pages.