Working With Directory Proxy Server Instances

When you create an instance of Directory Proxy Server, the files and directories required for the instance are created in the path that you specify.

In this procedure, you create a server instance on the local host using the dpadm command. You then configure the instance using the dpconf command.

Non-root users can create server instances.

A Directory Proxy Server instance must be configured to proxy directory client application requests to data sources through data views. When you start or stop an instance, you start or stop the server process that proxies directory client application requests.

The dpadm command enables you to manage a Directory Proxy Server instance and the files belonging to that instance on the local host. The command does not allow you to administer servers over the network, but only directly on the local host. The dpadm command has subcommands for each key management task. For a complete description, see dpadm(1M).

The dpconf command is an LDAP client. The command enables you to configure nearly all server settings on a running Directory Proxy Server instance from the command line. You can configure settings whether the server is on the local host or another host that is accessible across the network. The dpconf command has subcommands for each key configuration task. For a complete description, see dpconf(1M).

To Create a Directory Proxy Server Instance

You can use DSCC to perform this task. For information, see Directory Service Control Center Interface and the DSCC online help.

If you use DSCC to create a new server instance, you can choose to copy some or all of the server configuration settings from an existing server.

1. Create the instance of Directory Proxy Server.

   $ dpadm create -p port instance-path

   For example, to create a new instance in the directory /local/dps, use this command:

   $ dpadm create -p 2389 /local/dps

   To specify any other parameter of the instance, see the dpadm(1M) man page.

2. Type a password if required.
3. Confirm that the instance has been created by verifying the status of the instance.

   $ dpadm info instance-path

4. (Optional) If you installed Directory Proxy Server using the native packages, and your operating provides a service management solution, you can enable the server to be managed as a service, as shown in this table.
   

   Operating System Command Solaris 10 dpadm enable-service --type SMF instance-path Solaris 9 dpadm autostart instance-path Windows dpadm enable-service --type WIN_SERVICE instance-path

5. (Optional) Register the server instance with Directory Service Control Center by using either of the following methods.
   • Login to DSCC, and then use the Register Existing Server action on the Proxy Servers tab.

     Access DSCC using http://hostname:8080/dscc7 or https://hostname:8181/dscc7 as per your application server configuration.

   • Use the command dsccreg add-server.

     $ dsccreg add-server -h hostname --description "My Proxy" /local/dps
     Enter DSCC administrator's password:
     /local/dps is an instance of DPS
     Enter password of "cn=Proxy Manager" for /local/dps:
     Connecting to /local/dps
     Enabling DSCC access to /local/dps
     Registering /local/dps in DSCC on hostname.

     See dsccreg(1M) for more information about the command.

To Find the Status of a Directory Proxy Server Instance

You can use DSCC to perform this task. For information, see Directory Service Control Center Interface and the DSCC online help.

• Find the status of an instance of Directory Proxy Server.

  $ dpadm info instance-path

To Start and Stop Directory Proxy Server

You can use DSCC to perform this task. For information, see Directory Service Control Center Interface and the DSCC online help.

• To start or stop Directory Proxy Server, do one of the following.

  • To start Directory Proxy Server, type:

    $ dpadm start instance-path

    For example, to start an instance at /local/dps, use this command:

    $ dpadm start /local/dps

  • To stop Directory Proxy Server, type:

    $ dpadm stop instance-path

    For example:

    $ dpadm stop /local/dps

To List All the Running Instances

• List the running instances on a host using the following command:

  dpadm list-running-instances [--all]

  The -–all option lists the running instances from any installation path.

To Stop the Running Instances

• Stop the running instances on a host using the following command:

  dpadm stop-running-instances [-i] [--force]

  For more information, see dpadm(1M).

To View Whether It Is Necessary to Restart a Directory Proxy Server Instance

Sometimes, a configuration change requires the server to be restarted before the change takes effect. Use this procedure to check whether it is necessary to restart a Directory Proxy Server instance after a configuration change.

• View whether it is necessary to restart the server.

  $ dpconf get-server-prop -h host -p port is-restart-required

  • If the command returns true, you must restart the instance of Directory Proxy Server.

  • If the command returns false, it is not necessary to restart the instance of Directory Proxy Server.

To Restart Directory Proxy Server

You can use DSCC to perform this task. For information, see Directory Service Control Center Interface and the DSCC online help.

• Restart Directory Proxy Server.

  $ dpadm restart instance-path

  For example, to restart an instance at /local/dps, use this command:

  $ dpadm restart /local/dps

To Delete a Directory Proxy Server Instance

You can use DSCC to perform this task. For information, see Directory Service Control Center Interface and the DSCC online help.

1. (Optional) Stop the Directory Proxy Server instance.

   $ dpadm stop instance-path

   If you do not stop the instance, the delete command will stop it automatically. However, if you have enabled the instance in a service management solution, you must stop it manually.

2. (Optional) If you have previously used DSCC to manage the server, use the command line to unregister the server.

   $ dsccreg remove-server /local/dps
   Enter DSCC administrator's password:
   /local/dps is an instance of DPS
   Enter password of "cn=Proxy Manager" for /local/dps:
   Unregistering /local/dps from DSCC on localhost.
   Connecting to /local/dps
   Disabling DSCC access to /local/dps

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

3. (Optional) If you previously enabled the server instance in a service management solution, then disable the server from being managed as a service.
   

   Operating System Command Solaris 10 dpadm disable-service --type SMF instance-path Solaris 9 dpadm autostart --off instance-path Windows dpadm disable-service --type WIN_SERVICE instance-path

4. Delete the instance.

   $ dpadm delete instance-path