Appendix A
Installed Product Layout
This appendix summarizes product software layout after a typical installation. Of the files installed, only those listed here and discussed in the product documentation belong to the supported public product interface.
Note
|
Examples shown here reflect a product installation for the Solaris Operating Environment. File names and extensions may differ for installations on other platforms.
After installing the Solaris packaged version of the product, you can also obtain a full list of installed path names for a particular package using the pkgchk(1M) utility, pkgchk -v package-name.
|
Some platforms such as the Solaris Operating Environment provide integrated tools for managing directory services. Sun ONE Directory Server also provides tools. Refer to the Sun ONE Directory Server Administration Guide and Sun ONE Directory Server Reference Manual for details on the tools listed here.
The ServerRoot Directory
The ServerRoot directory contains several system administration utilities. To determine the path corresponding to the ServerRoot directory for your platform, configuration, and installation, refer to "Default Paths and Filenames".
Table A-1    Utilities Under ServerRoot
Utility
|
Remarks
|
ServerRoot/restart-admin
|
Restart administration server
|
ServerRoot/start-admin
|
Start administration server
|
ServerRoot/startconsole
|
Start Sun ONE Server Console
|
ServerRoot/stop-admin
|
Stop administration server
|
ServerRoot/uninstall
|
Uninstall product software
|
The ServerRoot/bin directory contains product binaries and configuration templates used internally when creating a server instance.
Table A-2    Files Under ServerRoot/bin
File
|
Remarks
|
ServerRoot/bin/
|
Internal use, except for the following:
|
ServerRoot/bin/admin/admconfig
|
Configure administration server
|
ServerRoot/bin/https/bin/ns-httpd
|
Sun ONE Administration Server
|
ServerRoot/bin/https/bin/uxwdog
|
Administration server watchdog
|
ServerRoot/bin/slapd/server/ns-ldapagt
|
LDAP-based SNMP subagent
|
ServerRoot/bin/slapd/server/ns-slapd
|
Sun ONE Directory Server
|
The ServerRoot/lib directory contains product libraries, including plug-ins.
Table A-3    Libraries Under ServerRoot/lib
Library
|
Remarks
|
ServerRoot/lib/
|
Internal use and plug-ins
|
ServerRoot/lib/libnspr4.so
|
NSPR, version 4.x
|
The ServerRoot/manual directory contains support for console online help.
Table A-4    Support for Online Help Under ServerRoot/manual
Directory
|
Remarks
|
ServerRoot/manual/
|
Support for online help
|
The ServerRoot/plugins directory contains sample server plug-ins, header files for plug-in development, and plug-ins for SNMP support.
Table A-5    Support for Plug-Ins Under ServerRoot/plugins
Directory or File
|
Remarks
|
ServerRoot/plugins/
|
Samples, headers, SNMP support
|
ServerRoot/plugins/slapd/slapi/examples/
|
Sample plug-ins
|
ServerRoot/plugins/slapd/slapi/include/
|
Plug-in header files
|
ServerRoot/plugins/snmp/magt/magt
|
Configure management agent
|
ServerRoot/plugins/snmp/mibs/
|
SNMP MIBs
|
ServerRoot/plugins/snmp/sagt/sagt
|
Configure SNMP agent
|
The ServerRoot/shared/bin directory contains tools for managing the server.
Table A-6    Tools and Clients Under ServerRoot/shared/bin
Directory or File
|
Remarks
|
ServerRoot/shared/bin
|
Internal use, except for the following
|
ServerRoot/shared/bin/admin_ip.pl
|
Change IP address
|
ServerRoot/shared/bin/entrycmp
|
Compare entries for replication
|
ServerRoot/shared/bin/fildif
|
Dump filtered LDIF
|
ServerRoot/shared/bin/insync
|
Check replication synchronization
|
ServerRoot/shared/bin/ldapcompare
|
Compare attribute value
|
ServerRoot/shared/bin/ldapdelete
|
Delete directory entry
|
ServerRoot/shared/bin/ldapmodify
|
Modify directory entry
|
ServerRoot/shared/bin/ldapsearch
|
Find directory entries
|
ServerRoot/shared/bin/modutil
|
Manage PKCS #11 modules
|
ServerRoot/shared/bin/uconv
|
Convert from ISO to UTF-8
|
ServerRoot/shared/bin/repldisc
|
Discover replication topology
|
The ServerRoot/shared/config directory contains a configuration file for mapping certificates to directory entries.
Table A-7    Certificate Mapping Configuration File Under ServerRoot/shared/config
Directory or File
|
Remarks
|
ServerRoot/shared/config
|
Internal use, except for the following
|
ServerRoot/shared/config/certmap.conf
|
Map certificates to entries
|
The ServerRoot/setup5 directory contains sample templates for silent installation and uninstallation.
Table A-8    Silent Installation and Uninstallation Templates Under ServerRoot/setup5
Directory or File
|
Remarks
|
ServerRoot/setup5
|
Internal use, except for the following
|
ServerRoot/setup5/typical.ins
|
Silent installation template file
|
ServerRoot/setup5/uninstall.ins
|
Silent uninstallation template file
|
The Server Instance Directory
The slapd-ServerID directory contains files corresponding to the server instance ServerID. The ServerRoot/slapd-ServerID directory itself contains several scripts for command-line administration.
Table A-9    Server Instance Scripts
Scripts
|
Remarks
|
ServerRoot/slapd-ServerID/
|
Server instance
|
ServerRoot/slapd-ServerID/bak2db
|
Restore database (offline)
|
ServerRoot/slapd-ServerID/bak2db.pl
|
Restore database (online)
|
ServerRoot/slapd-ServerID/db2bak
|
Backup database (offline)
|
ServerRoot/slapd-ServerID/db2bak.pl
|
Backup database (online)
|
ServerRoot/slapd-ServerID/db2index.pl
|
Generate index (online)
|
ServerRoot/slapd-ServerID/db2ldif
|
Dump database to LDIF (offline)
|
ServerRoot/slapd-ServerID/db2ldif.pl
|
Dump database to LDIF (online)
|
ServerRoot/slapd-ServerID/getpwenc
|
Print encrypted password
|
ServerRoot/slapd-ServerID/ldif2db
|
Import LDIF (offline)
|
ServerRoot/slapd-ServerID/ldif2db.pl
|
Import LDIF (online)
|
ServerRoot/slapd-ServerID/ldif2ldap
|
Import LDIF over LDAP
|
ServerRoot/slapd-ServerID/monitor
|
Retrieve monitoring information
|
ServerRoot/slapd-ServerID/ns-accountstatus.pl
|
Establish account status
|
ServerRoot/slapd-ServerID/ns-activate.pl
|
Activate entries
|
ServerRoot/slapd-ServerID/ns-inactivate.pl
|
Inactivate entries
|
ServerRoot/slapd-ServerID/restart-slapd
|
Restart directory server
|
ServerRoot/slapd-ServerID/restoreconfig
|
Restore administration server configuration
|
ServerRoot/slapd-ServerID/saveconfig
|
Save administration server configuration
|
ServerRoot/slapd-ServerID/start-slapd
|
Start directory server
|
ServerRoot/slapd-ServerID/stop-slapd
|
Stop directory server
|
ServerRoot/slapd-ServerID/suffix2instance
|
Map suffix to backend
|
ServerRoot/slapd-ServerID/vlvindex
|
Create virtual list view index
|
Subdirectories of ServerRoot/slapd-ServerID contain configuration, log, and backup data.
Table A-10    Server Instance Subdirectories
Directory
|
Remarks
|
ServerRoot/slapd-ServerID/
|
Server instance
|
ServerRoot/slapd-ServerID/bak/
|
Directory database backup
|
ServerRoot/slapd-ServerID/confbak/
|
Administration server configuration backup
|
ServerRoot/slapd-ServerID/conf_bk/
|
Directory server configuration backup
|
ServerRoot/slapd-ServerID/config/
|
Directory server configuration
|
ServerRoot/slapd-ServerID/config/schema/
|
Directory schema configuration
|
ServerRoot/slapd-ServerID/db/
|
Directory databases
|
ServerRoot/slapd-ServerID/ldif/
|
Sample LDIF files
|
ServerRoot/slapd-ServerID/locks/
|
Run time process locks
|
ServerRoot/slapd-ServerID/logs/
|
Server log files
|
ServerRoot/slapd-ServerID/tmp/
|
Run time temporary files
|
Manage your server instance using the tools provided. Do not modify directory contents manually.
Internal Use Only
The content of the following are used internally by the Directory Server. These internal components do not belong to the supported public interface.
- ServerRoot/adminacl/
- ServerRoot/admin-serv/
- ServerRoot/admserv
- ServerRoot/alias/
- ServerRoot/dist/
- ServerRoot/httpacl/
- ServerRoot/include/
- ServerRoot/install/
- ServerRoot/java/
- ServerRoot/userdb/
Do not modify these directories or their contents.