Sun Java System Directory Server Enterprise Edition 6.2 Administration Guide

Chapter 17 Directory Proxy Server Instances

This chapter describes how to administer an instance of Directory Proxy Server. This chapter covers the following topics:

Creating and Deleting a Directory Proxy Server Instance

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.

ProcedureTo 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 Sun JavaTM Enterprise System installer or a native package installation, and your OS 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

    Linux, HP-UX 

    dpadm autostart instance-path

    Windows 

    dpadm enable-service --type WIN_SERVICE instance-path

  5. (Optional) Register the server instance, using one of these methods:

    • Access DSCC through the URL https://localhost:6789 and log in to the browser interface.

    • Use the command dsccreg add-server.

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

ProcedureTo 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

    Linux, HP-UX 

    dpadm autostart --off instance-path

    Windows 

    dpadm disable-service --type WIN_SERVICE instance-path

  4. Delete the instance.


    $ dpadm delete instance-path
    

Finding the Status of a Directory Proxy Server Instance

This procedure describes how to find the status of an instance of Directory Proxy Server.

ProcedureTo 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.

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


    $ dpadm info instance-path
    

Starting, Stopping, and Restarting a Directory Proxy Server Instance

This section provides information about starting, stopping, and restarting Directory Proxy Server from the command line.

ProcedureTo 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.

  1. 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

ProcedureTo 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.

  1. 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.

ProcedureTo 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.

  1. Restart Directory Proxy Server.


    $ dpadm restart instance-path
    

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


    $ dpadm restart /local/dps