iPlanet Directory Server Configuration, Command, and File Reference: Chapter 8 Command-Line Scripts

Previous Contents Index DocHome Next

iPlanet Directory Server Configuration, Command, and File Reference

Chapter 8 Command-Line Scripts

This chapter provides information on the scripts you can use to back up and restore your database. Scripts are a shortcut way of executing the ns-slapd interface commands which are documented in Appendix A "Using the ns-slapd and slapd.exe Command-Line Utilities."
This chapter is divided into the following sections:

Command-Line Scripts Quick Reference

Shell and Batch Scripts

Perl Scripts

Command-Line Scripts Quick Reference

All scripts and commands are available in the following ways:

Solaris 9 platform

Using the /usr/sbin/directoryserver name command

Other platforms

As the /usr/iplanet/servers/slapd-serverID/name script or .bat file

Refer to the tables below for the name and purpose of each script.
When scripts request either a directory name or a file name, always provide the absolute path. The scripts assume that you want to use the dse.ldif file located in:

Solaris 9 platform

/var/ds5/slapd-serverID/config

Other platforms

/usr/iplanet/servers/slapd-serverID/config

Caution
In order to execute the Perl Scripts, you must change to the directory where the command-line utilities are stored. Although it is possible to set command path and library-path variables to execute these scripts, this is not the recommended procedure. You run the risk of disrupting the correct execution of other scripts and utilities and of compromising the security of the system, particularly when you have more than one server version installed.
The same procedure also applies to the ldapsearch, ldapmodify, ldapdelete and ldif command-line utilities. For more information on these command-line utilities, see Chapter 7 "Command-Line Utilities."
Please also note that when you are running the Perl scripts on Windows machines, you must make sure that the path environment variable contains the Perl executable (perl.exe) file. You therefore need to run the scripts from the following directory on Windows:
\usr\iplanet\servers\bin\slapd\admin\bin

The following table lists command-line script names, which are also option names for the /usr/sbin/directoryserver command on the Solaris 9 platform.

Table 8-1 Commonly Used Command-Line Shell and Batch Scripts

Command name

Description

bak2db

Restores the database from the most recent archived backup.

db2bak

Creates a backup of the current database contents.

db2ldif

Exports the contents of the database to LDIF.

getpwenc

Prints the encrypted form of a password using one of the server's encryption algorithms. If a user cannot log in, you can use this script to compare the user's password to the password stored in the directory. This command name is not an option for the directoryserver command on the Solaris 9 platform.

ldif2db

Imports LDIF files to the database.
Runs the slapd (Windows NT) or ns-slapd (Unix) command-line utility with the ldif2db keyword. By default, the script first saves and then merges any existing configuration tree (o=NetscapeRoot) with any files to be imported.

ldif2ldap

Performs an import operation over LDAP to the Directory Server.

monitor

Retrieves performance monitoring information using the ldapsearch command-line utility.

restart-slapd

Restarts Directory Server. Use the following command on the Solaris 9 platform: /usr/sbin/directoryserver restart.

restoreconfig

Restores by default the most recently saved Admin Server configuration to NetscapeRoot partition.

saveconfig

Saves Admin Server configuration, stored in the NetscapeRoot suffix to installDir/slapd-serverID/confbak directory.

start-slapd

Starts Directory Server. Use the following command on the Solaris 9 platform: /usr/sbin/directoryserver start.

stop-slapd

Stops Directory Server. Use the following command on the Solaris 9 platform: /usr/sbin/directoryserver stop.

suffix2instance

Maps a suffix to a backend name.

vlvindex

Creates and generates virtual list view (VLV) indexes, also called browsing indexes.

The following table gives the names of perl scripts and their equivalent command on the Solaris 9 platform.

Table 8-2 Commonly Used Command-Line Perl Scripts

Command Line Perl script

Description

bak2db.pl
directoryserver bak2db-task

Restores the database from the most recent archived backup.

db2bak.pl
directoryserver db2bak-task

Creates a backup of the current database contents

db2index.pl
directoryserver db2index-task

Creates and regenerates indexes.

db2ldif.pl
directoryserver db2ldif-task

Exports the contents of the database to LDIF

ldif2db.pl
directoryserver ldif2db-task

Imports LDIF files to database.
Runs the slapd (Windows NT) or ns-slapd (Unix) command-line utility with the ldif2db keyword. By default, the script first saves and then merges any existing configuration tree (o=NetscapeRoot), with any files to be imported.

migrateInstance5
(not available on the Solaris 9 platform)

Migrates a 4.x or 5.0 version of the Directory Server to the 5.1 version, converting the configuration files to LDIF format.
Located in: /usr/iplanet/servers/bin/slapd/admin/bin

ns-accountstatus.pl
directoryserver account-status

Provides account status information to establish whether an entry or group of entries is locked or not.

ns-activate.pl
directoryserver account-activate

Activates an entry or a group of entries by unlocking it (them).

ns-inactivate.pl
directoryserver account-inactivate

Inactivates an entry or a group of entries.

Shell and Batch Scripts

Some of the Shell and Batch scripts can be executed while the server is running. For others, the server must be stopped. The description of each script below indicates whether the server must be stopped, or if it can continue to run while you execute the script.
When a Shell or Batch script has a Perl equivalent, there is a cross-reference to the section describing the equivalent Perl script.

bak2db (Restore database from backup)

Restores the database from the most recent archived backup. To run this script the server must be stopped.

Syntax

Command (Solaris 9)

directoryserver bak2db [backup_directory]

Script (Other UNIX)

bak2db [backup_directory]

Batch file (Windows)

bak2db [backup_directory]

For information on the equivalent Perl script, see "bak2db.pl (Restore database from backup)".
For more information on restoring databases, see Chapter 3, "Populating Directory Databases" in the iPlanet Directory Server Administrator's Guide.

db2bak (Create backup of database)

Creates a backup of the current database contents. This script can be executed while the server is still running.

Syntax

Command (Solaris 9)

directoryserver db2bak [backup_directory]

Script (Other UNIX)

db2bak [backup_directory]

Batch file (NT)

db2bak [backup_directory]

For information on the equivalent Perl script, refer to "db2bak.pl (Create backup of database)".

db2ldif (Export database contents to LDIF)

Exports the contents of the database to LDIF. This script can be executed while the server is still running.
For information on the equivalent Perl script, refer to "db2ldif.pl (Export database contents to LDIF)".
For the shell and batch scripts, the script runs the slapd (Windows NT) or ns-slapd (UNIX) command-line utility with the ldif2db keyword.

Syntax

Command (Solaris 9)

directoryserver db2ldif options

Script (Other UNIX)

db2ldif options

Batch file (NT)

db2ldif options

options

{-n backend_instance}* |
{-s includesuffix}* [{-x excludesuffix}*]
[-r] [-C] [-u] [-U] [-m] [-M] [-a outfile] [-1] [-N]

Note You must specify either the -n or the -s option.

Options

-a

File name of the output LDIF file.

-n

Instance to be exported.

-s

Suffix(es) to be included or to specify the subtree(s) to be included if -n has been used.

-x

Suffix(es) to be excluded.

-m

Minimal base64 encoding.

-M

Use of several files for storing the output LDIF, with each instance stored in instance_outfile (where outfile is the file name specified for -a option).

-r

Export replica.

-u

Request that the unique id is not exported.

-C

Only the main db file is used.

-N

Specifies that entry IDs are not to be included in the LDIF output. The entry IDs are necessary only if the db2ldif output is to be used as input to db2index.

-U

Request that the output LDIF is not folded.

-1

For reasons of backward compatibility, delete the first line of the LDIF file which gives the version of the LDIF standard.

Note Please note that the output LDIF will be stored in one file by default. Should you want to specify the use of several files, then use the option -M.

getpwenc (Print encrypted password)

Prints the encrypted form of a password using one of the server's encryption algorithms. If a user cannot log in, you can use this script to compare the user's password to the password stored in the directory.

Syntax

Command (Solaris 9)

/var/ds5/slapd-serverID/getpwenc storagescheme clearpassword

Script (Other UNIX)

getpwenc storagescheme clearpassword

Batch file (NT)

getpwenc storagescheme clearpassword

Options
There are no options for this script.
For more information on the different storage schemes such as SSHA, SHA, CRYPT and CLEAR, see the iPlanet Directory Server Administrator's Guide.

ldif2db (Import)

Runs the slapd (Windows NT) or ns-slapd (Unix) command-line utility with the ldif2db keyword. To run this script the server must be stopped.
For information on the equivalent Perl script, see "ldif2db.pl (Import)".

Note Note that ldif2db supports LDIF version 1 specifications. You can load an attribute using the :< URL specifier notation. For example:
jpegphoto:< file:///tmp/myphoto.jpg
Although the official notation requires three ///, the use of one / is tolerated. For further information on the LDIF format, see the iPlanet Directory Server Administrator's Guide.

Syntax

Command (Solaris 9)

directoryserver ldif2db options

Script (Other UNIX)

ldif2db options

Batch file (NT)

ldif2db options

options

-n backend_instance |
{-s includesuffix}* [{-x excludesuffix}*]
{-i ldiffile}* [-O] [-g string] [-G namespace_id]

Options

-n

Instance to be imported. Ensure that you specify an instance that corresponds to the suffix contained by the LDIF file. Otherwise the data contained by the database is deleted and the import fails.

-i

File name of the input ldif file(s). When you import multiple files, they are imported in the order in which you specify them on the command line.

-s

Suffix(es) to be included or to specify the subtree(s) to be included if -n has been used.

-x

Suffix(es) to be included.

-O

Request that only the core db is created without attribute indexes.

-c

Merge chunk size.

-g string

Generation of a unique ID. Type none for no unique ID to be generated and deterministic for the generated unique ID to be name-based. By default, a time-based unique ID is generated.
If you use the deterministic generation to have a name-based unique ID, you can also specify the namespace you want the server to use as follows:
-g deterministic namespace_id
where namespace_id is a string of characters in the following format
00-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx
Use this option if you want to import the same LDIF file into two different directory servers, and if you want the contents of both directories to have the same set of unique IDs. If unique IDs already exist in the LDIF file you are importing, then the existing IDs are imported to the server regardless of the options you have specified.

-G namespace_id

Generates a namespace ID as a name-based unique ID. This is the same as specifying the -g deterministic option.

ldif2ldap (Perform import operation over LDAP)

Performs an import operation over LDAP to the Directory Server. To run this script the server must be running.

Syntax

Command (Solaris 9)

directoryserver ldif2ldap -D rootDN -w password -f filename

Script (Other UNIX)

ldif2ldap -D rootDN -w password -f filename

Batch file (NT)

ldif2ldap -D rootDN -w password -f filename

Options

-D

User DN with root permissions, such as Directory Manager.

-w

Password associated with the user DN.

-f

File name of the file to be imported. When you import multiple files, they are imported in the order in which you specify them on the command line.

monitor (Retrieve monitoring information)

Retrieves performance monitoring information using the ldapsearch command-line utility.

Syntax

Command (Solaris 9)

directoryserver monitor

Script (Other UNIX)

monitor

Batch file (NT)

monitor

Options
There are no options for this script.
For more information on the ldapsearch command-line utility, see Chapter 7 "Command-Line Utilities".

restart-slapd (Restart the Directory Server)

Restarts the Directory Server.

Syntax

Command (Solaris 9)

directoryserver restart

Script (Other UNIX)

restart-slapd

Batch file (NT)

restart-slapd

Options
There are no options for this script.

Exit Status
0: Server restarted successfully.
1: Server could not be started.
2: Server restarted successfully but was already stopped.
3: Server could not be stopped.

restoreconfig (Restore Admin Server Configuration)

By default, restores the most recently saved Admin Server configuration information to the NetscapeRoot suffix under the following directory:

Solaris 9 platform

/var/ds5/slapd-serverID/config

Other platforms

/usr/iplanet/servers/slapd-serverID/config

To restore the Admin Server configuration:

Stop the Directory Server

Run the restoreconfig script

Restart the Directory Server

Restart the Admin Server for the changes to be taken into account

Syntax

Command (Solaris 9)

directoryserver restoreconfig

Script (Other UNIX)

restoreconfig

Batch file (NT)

restoreconfig

Options
There are no options for this script.

saveconfig (Save Admin Server Configuration)

Saves Admin Server configuration information to the following directory:

Solaris 9 platform

/var/ds5/slapd-serverID/confbak

Other platforms

/usr/iplanet/servers/slapd-serverID/confbak

Note This script will only run if the server is running.

Syntax

Command (Solaris 9)

directoryserver saveconfig

Script (Other UNIX)

saveconfig

Batch file (NT)

saveconfig

Options
There are no options for this script.

start-slapd (Start the Directory Server)

Starts the Directory Server.

Syntax

Command (Solaris 9)

directoryserver start

Script (Other UNIX)

start-slapd

Batch file (NT)

start-slapd

Options
There are no options for this script.

Exit Status
0: Server started successfully.
1: Server could not be started.
2: Server was already started.

stop-slapd (Stop the Directory Server)

Stops the Directory Server.

Syntax

Command (Solaris 9)

directoryserver stop

Script (Other UNIX)

stop-slapd

Batch file (NT)

stop-slapd

Options
There are no options for this script.

Exit Status
0: Server stopped successfully.
1: Server could not be stopped.
2: Server was already stopped.

suffix2instance (Map Suffix to Backend Name)

Maps a suffix to a backend name.

Syntax

Command (Solaris 9)

directoryserver suffix2instance {-s suffix}

Script (Other UNIX)

suffix2instance {-s suffix}

Batch file (NT)

suffix2instance {-s suffix}

Options

-s

The suffix to be mapped to the backend

vlvindex (Create virtual list view (VLV) indexes)

To run the vlvindex script, the server must be stopped. The vlvindex script creates virtual list view (VLV) indexes, known in the Directory Server Console as Browsing Indexes. VLV indexes introduce flexibility in the way you view search results. Using VLV indexes, you can organize search results alphabetically or in reverse alphabetical order, and you can scroll through the list of results. VLV index configuration must already exist prior to running this script.

Syntax

Command (Solaris 9)

directoryserver vlvindex options

Script (Other UNIX)

vlvindex options

Batch file (NT)

vlvindex options

options

[-d debug_level] [-n backend_instance] [-s suffix]
[-T VLVTag]

Options

-d

Specifies the debug level to use during index creation. Debug levels are defined in "nsslapd-errorlog-level (Error Log Level)".

-D

Specifies the server configuration directory that contains the configuration information for the index creation process. You must specify the full path to the slapd-serverID directory.

-n

Name of the database containing the entries to index.

-s

Name of the suffix containing the entries to index.

-T

VLV index identifier to use to create VLV indexes. You can use the console to specify VLV index identifier for each database supporting your directory tree, as described in the iPlanet Directory Server Administrator's Guide. You can define additional VLV tags by creating them in LDIF, and adding them to Directory Server's configuration, as described in the iPlanet Directory Server Administrator's Guide. In any case, we recommend you use the dn of the entry for which you want to accelerate the search sorting.

Note You must specify either the -n or the -s option.

Perl Scripts

bak2db.pl (Restore database from backup)

This perl script bak2db.pl creates an entry in the directory that launches this dynamic task. An entry is generated based upon the values you provide for each option.

Syntax

Command (Solaris 9)

directoryserver bak2db-task options

Perl script (All others)

bak2db.pl options

options

[-v] -D rootDN {-w password | -w - | -j filename }
[-a backup_directory] [-t databasetype]

Options

-D

User DN with root permissions, such as Directory Manager. The default is the DN of the directory manager which is read from the nsslapd-root attribute under cn=config.

-w

Password associated with the user DN. If you do not specify this option, anonymous access is used. If you specify -w -, the utility prompts for the password. If either -w option is specified, the -j option must not be specified. For example, -w diner892.

-j

Specifies the file from which the bind password is read. Used for simple authentication. If this option is specified, the -w option must not be specified.

-a

Directory of the backup files.

-v

Verbose mode.

-t

Database type. Currently, ldbm is the only possible type and the default value.

db2bak.pl (Create backup of database)

This perl script db2bak.pl creates an entry in the directory that launches this dynamic task. An entry is generated based upon the values you provide for each option.

Syntax

Command (Solaris 9)

directoryserver db2bak-task options

Perl script (All others)

db2bak.pl options

options

[-v] -D rootDN {-w password | -w - | -j filename } [-a backup_directory] [-t databasetype]

Options

-D

User DN with root permissions, such as Directory Manager. The default is the DN of the directory manager which is read from the nsslapd-root attribute under cn=config.

-w

Password associated with the user DN. If you do not specify this option, anonymous access is used. If you specify -w -, the utility prompts for the password. If either -w option is specified, the -j option must not be specified. For example, -w diner892.

-j

Specifies the file from which the bind password is read. Used for simple authentication. If this option is specified, the -w option must not be specified.

-a

Directory where the backup files will be stored. By default it is under installDir/slapd-serverID/bak.
The backup file is named according to the year-month-day-hour format (YYYY_MM_DD_hh_mm_ss).

-v

Verbose mode.

-t

Database type. Currently, ldbm is the only possible type and the default value.

db2index.pl (Create and generate indexes)

Creates and generates the new set of indexes to be maintained following the modification of indexing entries in the cn=config configuration file.

Syntax

Command (Solaris 9)

directoryserver db2index-task options

Perl script (All others)

db2bindex.pl options

options

[-v] -D rootDN {-w password | -w - | -j filename }
-n backend_instance [-t attributeName]

Options

-D

User DN with root permissions, such as Directory Manager.

-w

Password associated with the user DN. If you do not specify this option, anonymous access is used. If you specify -w -, the utility prompts for the password. If either -w option is specified, the -j option must not be specified. For example, -w diner892.

-j

Specifies the file from which the bind password is read. Used for simple authentication. If this option is specified, the -w option must not be specified.

-n

Instance to be indexed.

-t

Name of the attribute to be indexed. If omitted, all indexes defined for that instance are generated.

-v

Verbose mode.

Note This perl script db2index.pl creates an entry in the directory that launches this dynamic task. An entry is generated based upon the values you provide for each option.

db2ldif.pl (Export database contents to LDIF)

Exports the contents of the database to LDIF. This Perl script creates an entry in the directory that launches this dynamic task. The entry is generated based upon the values you provide for each option. The * indicates that multiple occurrences are allowed.

Syntax

Command (Solaris 9)

directoryserver db2ldif-task options

Perl script (All others)

db2ldif.pl options

options

[-v] -D rootDN {-w password | -w - | -j filename }
{-n backend_instance}* |
{-s includesuffix}* [{-x excludesuffix}*]
[-a outfile] [-N] [-r] [-C] [-u] [-U] [-m] [-o] [-1] [M]

Caution
To run this script the server must be running and either -n backend_instance or -s includesuffix is required.
This perl script bak2db.pl creates an entry in the directory that launches this dynamic task. An entry is generated based upon the values you provide for each option.

Options

-D

User DN with root permissions, such as Directory Manager.

-w

Password associated with the user DN. If you do not specify this option, anonymous access is used. If you specify -w -, the utility prompts for the password. If either -w option is specified, the -j option must not be specified. For example, -w diner892.

-j

Specifies the file from which the bind password is read. Used for simple authentication. If this option is specified, the -w option must not be specified.

-n

Instance to be exported.

-a

File name of the output LDIF file.

-s

Suffix(es) to be included or to specify the subtree(s) to be included if -n has been used.

-x

Suffix(es) to be excluded.

-m

Minimal base64 encoding.

-o

Output LDIF to be stored in one file by default with each instance stored in instance_outfile.

-r

Export replica.

-u

Request that the unique id is not exported.

-C

Only the main db file is used.

-N

Suppress printing sequential number.

-U

Request that the output LDIF is not folded.

-v

Verbose mode.

-1

Delete, for reasons of backward compatibility the first line of the LDIF file that gives the version of the LDIF standard.

-M

Output LDIF is stored in multiple files.

ldif2db.pl (Import)

To run this Perl script, the server must be running. This script creates an entry in the directory that launches this dynamic task. The entry is generated based upon the values you provide for each option.

Syntax

Command (Solaris 9)

directoryserver ldif2db options

Perl script (All others)

ldif2db.pl options

options

[-v] -D rootDN {-w password | -w - | -j filename }
-n backend_instance |
{-s includesuffix}* [{-x excludesuffix}*]
[-O] [-c] [-g string] [-G namespace_id] {-i filename}*

Options

-D

User DN with root permissions, such as Directory Manager.

-w

Password associated with the user DN. If you do not specify this option, anonymous access is used. If you specify -w -, the utility prompts for the password. If either -w option is specified, the -j option must not be specified. For example, -w diner892.

-j

Specifies the file from which the bind password is read. Used for simple authentication. If this option is specified, the -w option must not be specified.

-n

Instance to be imported.

-i

File name of the input LDIF file(s). When you import multiple files, they are imported in the order in which you specify them on the command line.

-s

Suffix(es) to be included or to specify the subtree(s) to be included if -n has been used.

-x

Suffix(es) to be excluded.

-O

Request that only the core db is created without attribute indexes.

-c

Merge chunk size.

-g string

Generation of a unique ID. Type none for no unique ID to be generated and deterministic for the generated unique ID to be name-based. By default a time based unique ID is generated.
If you use the deterministic generation to have a name-based unique ID, you can also specify the namespace you want the server to use as follows:
-g deterministic namespace_id
where namespace_id is a string of characters in the following format
00-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx
Use this option if you want to import the same LDIF file into two different directory servers, and if you want the contents of both directories to have the same set of unique IDs. If unique IDs already exist in the LDIF file you are importing, then the existing IDs are imported to the server regardless of the options you have specified.

-G namespace_id

Generates a namespace ID as a name-based unique ID. This is the same as specifying the -g deterministic option.

-v

Verbose mode.

Note This perl script ldif2db.pl creates an entry in the directory that launches this dynamic task. An entry is generated based upon the values you provide for each option.

migrateInstance5 (Migrate to Directory Server 5.0 or 5.1)

The migrateInstance5 Perl script (note that this is a Perl script despite the fact that it does not have the .pl extension) migrates a 4.x Directory Server to Directory Server 5.0 or 5.1. It can also be used to upgrade from Directory Server 5.0 to Directory Server 5.1.
When you run this script, it migrates the configuration files or configuration entries, database instances and schema with minimum manual intervention. The migrateInstance5 script calls on the migrateTo5 script which then executes the migration.
For complete information on the configuration parameters and attributes that are migrated, see Chapter 6 "Migration from Earlier Versions."
Before performing the migration, check that the user-defined variables contain the following associated values, where installDir is the path to where iPlanet Directory Server 5.1 is installed:

$PERL5LIB

installDir/bin/slapd/admin/bin

PATH

installDir/bin/slapd/admin/bin

Syntax

Perl script (All others)

migrateInstance5
-D rootDN {-w password | -w - | -j filename }
-n backend_instance -p port
-o 4.xInstancePath -n 5.0InstancePath [-t] [-L]

Options

-D

Directory Server 5.1 userDN with root permissions, such as Directory Manager.

-w

Password associated with the Directory Server 5.1 user DN. If you do not specify this option, anonymous access is used. If you specify -w -, the utility prompts for the password. If either -w option is specified, the -j option must not be specified. For example, -w diner892.

-j

Specifies the file from which the bind password is read. Used for simple authentication. If this option is specified, the -w option must not be specified.

-p

Directory Server 5.1 port.

-o 4.xInstancePath

Netscape Directory Server 4.x.

-n 5.0InstancePath

Path for the new Directory Server 5.0 instance.

-t

Trace level. The trace level is set to 0 by default with a valid range of 0 to 3.

-L

File in which to log the migration report. By default the migration report is stored under installDir/slapd-serverID/logs/Migration_ddmmyyy_hhmmss.log.
A sample log might contain:
/usr/iplanet/servers/slapd-serverID/logs/Migration_20022001_153604.log for a log created on 20 February 2001 at 15.36:04.

ns-accountstatus.pl (Establish account status)

Provides account status information to establish whether an entry or group of entries is inactivated or not.

Syntax

Command (Solaris 9)

directoryserver account-status options

Perl script (All others)
ns-accountstatus.pl options

options

[-D rootDN] {-w password | -w - | -j filename }
[-h host] [-p port] -I DN

Options

-D

Directory Server 5.1 userDN with root permissions, such as Directory Manager.

-w

Password associated with the user DN. If you do not specify this option, anonymous access is used. If you specify -w -, the utility prompts for the password. If either -w option is specified, the -j option must not be specified. For example, -w diner892.

-j

Specifies the file from which the bind password is read. Used for simple authentication. If this option is specified, the -w option must not be specified.

-p

Directory Server 5.1 port. The default value is the LDAP port of Directory Server 5.1 specified at installation time.

-h

Host name of Directory Server 5.1. The default value is the full host name of the machine where Directory Server 5.1. is installed.

-I DN

Entry DN or role DN whose status is required.

ns-activate.pl (Activate an entry or group of entries)

Activates an entry or group of entries.

Syntax

Command (Solaris 9)

directoryserver account-activate options

Perl script (All others)

ns-activate.pl options

options

[-D rootDN] {-w password | -w - | -j filename }
[-h host] [-p port] -I DN

Options

-D

Directory Server 5.1 userDN with root permissions, such as Directory Manager.

-w

Password associated with the user DN. If you do not specify this option, anonymous access is used. If you specify -w -, the utility prompts for the password. If either -w option is specified, the -j option must not be specified. For example, -w diner892.

-j

Specifies the file from which the bind password is read. Used for simple authentication. If this option is specified, the -w option must not be specified.

-p

Directory Server 5.1 port. The default value is the LDAP port of Directory Server 5.1 specified at installation time.

-h

Host name of Directory Server 5.1. The default value is the full hostname of the machine where Directory Server 5.1. is installed.

-I DN

Entry DN or role DN to activate.

ns-inactivate.pl (Inactivate an entry or group of entries)

Inactivates, and thus locks, an entry or group of entries.

Syntax

Command (Solaris 9)

directoryserver account-inactivate options

Perl script (All others)

ns-inactivate.pl options

options

[-D rootDN] {-w password | -w - | -j filename }
[-h host] [-p port] -I DN

Options

-D

Directory Server 5.1 userDN with root permissions, such as Directory Manager.

-w

Password associated with the user DN. If you do not specify this option, anonymous access is used. If you specify -w -, the utility prompts for the password. If either -w option is specified, the -j option must not be specified. For example, -w diner892.

-j

Specifies the file from which the bind password is read. Used for simple authentication. If this option is specified, the -w option must not be specified.

-p

Directory Server 5.1 port. The default value is the LDAP port of Directory Server 5.1 specified at installation time.

-h

Host name of Directory Server 5.1. The default value is the full hostname of the machine where Directory Server 5.1. is installed.

-I DN

Entry DN or role DN to inactivate.

Command name	Description
bak2db	Restores the database from the most recent archived backup.
db2bak	Creates a backup of the current database contents.
db2ldif	Exports the contents of the database to LDIF.
getpwenc	Prints the encrypted form of a password using one of the server's encryption algorithms. If a user cannot log in, you can use this script to compare the user's password to the password stored in the directory. This command name is not an option for the directoryserver command on the Solaris 9 platform.
ldif2db	Imports LDIF files to the database. Runs the slapd (Windows NT) or ns-slapd (Unix) command-line utility with the ldif2db keyword. By default, the script first saves and then merges any existing configuration tree (o=NetscapeRoot) with any files to be imported.
ldif2ldap	Performs an import operation over LDAP to the Directory Server.
monitor	Retrieves performance monitoring information using the ldapsearch command-line utility.
restart-slapd	Restarts Directory Server. Use the following command on the Solaris 9 platform: /usr/sbin/directoryserver restart.
restoreconfig	Restores by default the most recently saved Admin Server configuration to NetscapeRoot partition.
saveconfig	Saves Admin Server configuration, stored in the NetscapeRoot suffix to installDir/slapd-serverID/confbak directory.
start-slapd	Starts Directory Server. Use the following command on the Solaris 9 platform: /usr/sbin/directoryserver start.
stop-slapd	Stops Directory Server. Use the following command on the Solaris 9 platform: /usr/sbin/directoryserver stop.
suffix2instance	Maps a suffix to a backend name.
vlvindex	Creates and generates virtual list view (VLV) indexes, also called browsing indexes.

Command Line Perl script	Description
bak2db.pl directoryserver bak2db-task	Restores the database from the most recent archived backup.
db2bak.pl directoryserver db2bak-task	Creates a backup of the current database contents
db2index.pl directoryserver db2index-task	Creates and regenerates indexes.
db2ldif.pl directoryserver db2ldif-task	Exports the contents of the database to LDIF
ldif2db.pl directoryserver ldif2db-task	Imports LDIF files to database. Runs the slapd (Windows NT) or ns-slapd (Unix) command-line utility with the ldif2db keyword. By default, the script first saves and then merges any existing configuration tree (o=NetscapeRoot), with any files to be imported.
migrateInstance5 (not available on the Solaris 9 platform)	Migrates a 4.x or 5.0 version of the Directory Server to the 5.1 version, converting the configuration files to LDIF format. Located in: /usr/iplanet/servers/bin/slapd/admin/bin
ns-accountstatus.pl directoryserver account-status	Provides account status information to establish whether an entry or group of entries is locked or not.
ns-activate.pl directoryserver account-activate	Activates an entry or a group of entries by unlocking it (them).
ns-inactivate.pl directoryserver account-inactivate	Inactivates an entry or a group of entries.

-a	File name of the output LDIF file.
-n	Instance to be exported.
-s	Suffix(es) to be included or to specify the subtree(s) to be included if -n has been used.
-x	Suffix(es) to be excluded.
-m	Minimal base64 encoding.
-M	Use of several files for storing the output LDIF, with each instance stored in instance_outfile (where outfile is the file name specified for -a option).
-r	Export replica.
-u	Request that the unique id is not exported.
-C	Only the main db file is used.
-N	Specifies that entry IDs are not to be included in the LDIF output. The entry IDs are necessary only if the db2ldif output is to be used as input to db2index.
-U	Request that the output LDIF is not folded.
-1	For reasons of backward compatibility, delete the first line of the LDIF file which gives the version of the LDIF standard.

-n	Instance to be imported. Ensure that you specify an instance that corresponds to the suffix contained by the LDIF file. Otherwise the data contained by the database is deleted and the import fails.
-i	File name of the input ldif file(s). When you import multiple files, they are imported in the order in which you specify them on the command line.
-s	Suffix(es) to be included or to specify the subtree(s) to be included if -n has been used.
-x	Suffix(es) to be included.
-O	Request that only the core db is created without attribute indexes.
-c	Merge chunk size.
-g string	Generation of a unique ID. Type none for no unique ID to be generated and deterministic for the generated unique ID to be name-based. By default, a time-based unique ID is generated. If you use the deterministic generation to have a name-based unique ID, you can also specify the namespace you want the server to use as follows: -g deterministic namespace_id where namespace_id is a string of characters in the following format 00-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx Use this option if you want to import the same LDIF file into two different directory servers, and if you want the contents of both directories to have the same set of unique IDs. If unique IDs already exist in the LDIF file you are importing, then the existing IDs are imported to the server regardless of the options you have specified.
-G namespace_id	Generates a namespace ID as a name-based unique ID. This is the same as specifying the -g deterministic option.

-D	User DN with root permissions, such as Directory Manager.
-w	Password associated with the user DN.
-f	File name of the file to be imported. When you import multiple files, they are imported in the order in which you specify them on the command line.

-s	The suffix to be mapped to the backend

-d	Specifies the debug level to use during index creation. Debug levels are defined in "nsslapd-errorlog-level (Error Log Level)".
-D	Specifies the server configuration directory that contains the configuration information for the index creation process. You must specify the full path to the slapd-serverID directory.
-n	Name of the database containing the entries to index.
-s	Name of the suffix containing the entries to index.
-T	VLV index identifier to use to create VLV indexes. You can use the console to specify VLV index identifier for each database supporting your directory tree, as described in the iPlanet Directory Server Administrator's Guide. You can define additional VLV tags by creating them in LDIF, and adding them to Directory Server's configuration, as described in the iPlanet Directory Server Administrator's Guide. In any case, we recommend you use the dn of the entry for which you want to accelerate the search sorting.

-D	User DN with root permissions, such as Directory Manager. The default is the DN of the directory manager which is read from the nsslapd-root attribute under cn=config.
-w	Password associated with the user DN. If you do not specify this option, anonymous access is used. If you specify -w -, the utility prompts for the password. If either -w option is specified, the -j option must not be specified. For example, -w diner892.
-j	Specifies the file from which the bind password is read. Used for simple authentication. If this option is specified, the -w option must not be specified.
-a	Directory of the backup files.
-v	Verbose mode.
-t	Database type. Currently, ldbm is the only possible type and the default value.

-D	User DN with root permissions, such as Directory Manager. The default is the DN of the directory manager which is read from the nsslapd-root attribute under cn=config.
-w	Password associated with the user DN. If you do not specify this option, anonymous access is used. If you specify -w -, the utility prompts for the password. If either -w option is specified, the -j option must not be specified. For example, -w diner892.
-j	Specifies the file from which the bind password is read. Used for simple authentication. If this option is specified, the -w option must not be specified.
-a	Directory where the backup files will be stored. By default it is under installDir/slapd-serverID/bak. The backup file is named according to the year-month-day-hour format (YYYY_MM_DD_hh_mm_ss).
-v	Verbose mode.
-t	Database type. Currently, ldbm is the only possible type and the default value.

-D	User DN with root permissions, such as Directory Manager.
-w	Password associated with the user DN. If you do not specify this option, anonymous access is used. If you specify -w -, the utility prompts for the password. If either -w option is specified, the -j option must not be specified. For example, -w diner892.
-j	Specifies the file from which the bind password is read. Used for simple authentication. If this option is specified, the -w option must not be specified.
-n	Instance to be indexed.
-t	Name of the attribute to be indexed. If omitted, all indexes defined for that instance are generated.
-v	Verbose mode.

-D	User DN with root permissions, such as Directory Manager.
-w	Password associated with the user DN. If you do not specify this option, anonymous access is used. If you specify -w -, the utility prompts for the password. If either -w option is specified, the -j option must not be specified. For example, -w diner892.
-j	Specifies the file from which the bind password is read. Used for simple authentication. If this option is specified, the -w option must not be specified.
-n	Instance to be exported.
-a	File name of the output LDIF file.
-s	Suffix(es) to be included or to specify the subtree(s) to be included if -n has been used.
-x	Suffix(es) to be excluded.
-m	Minimal base64 encoding.
-o	Output LDIF to be stored in one file by default with each instance stored in instance_outfile.
-r	Export replica.
-u	Request that the unique id is not exported.
-C	Only the main db file is used.
-N	Suppress printing sequential number.
-U	Request that the output LDIF is not folded.
-v	Verbose mode.
-1	Delete, for reasons of backward compatibility the first line of the LDIF file that gives the version of the LDIF standard.
-M	Output LDIF is stored in multiple files.

-D	User DN with root permissions, such as Directory Manager.
-w	Password associated with the user DN. If you do not specify this option, anonymous access is used. If you specify -w -, the utility prompts for the password. If either -w option is specified, the -j option must not be specified. For example, -w diner892.
-j	Specifies the file from which the bind password is read. Used for simple authentication. If this option is specified, the -w option must not be specified.
-n	Instance to be imported.
-i	File name of the input LDIF file(s). When you import multiple files, they are imported in the order in which you specify them on the command line.
-s	Suffix(es) to be included or to specify the subtree(s) to be included if -n has been used.
-x	Suffix(es) to be excluded.
-O	Request that only the core db is created without attribute indexes.
-c	Merge chunk size.
-g string	Generation of a unique ID. Type none for no unique ID to be generated and deterministic for the generated unique ID to be name-based. By default a time based unique ID is generated. If you use the deterministic generation to have a name-based unique ID, you can also specify the namespace you want the server to use as follows: -g deterministic namespace_id where namespace_id is a string of characters in the following format 00-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx Use this option if you want to import the same LDIF file into two different directory servers, and if you want the contents of both directories to have the same set of unique IDs. If unique IDs already exist in the LDIF file you are importing, then the existing IDs are imported to the server regardless of the options you have specified.
-G namespace_id	Generates a namespace ID as a name-based unique ID. This is the same as specifying the -g deterministic option.
-v	Verbose mode.

-D	Directory Server 5.1 userDN with root permissions, such as Directory Manager.
-w	Password associated with the Directory Server 5.1 user DN. If you do not specify this option, anonymous access is used. If you specify -w -, the utility prompts for the password. If either -w option is specified, the -j option must not be specified. For example, -w diner892.
-j	Specifies the file from which the bind password is read. Used for simple authentication. If this option is specified, the -w option must not be specified.
-p	Directory Server 5.1 port.
-o 4.xInstancePath	Netscape Directory Server 4.x.
-n 5.0InstancePath	Path for the new Directory Server 5.0 instance.
-t	Trace level. The trace level is set to 0 by default with a valid range of 0 to 3.
-L	File in which to log the migration report. By default the migration report is stored under installDir/slapd-serverID/logs/Migration_ddmmyyy_hhmmss.log. A sample log might contain: /usr/iplanet/servers/slapd-serverID/logs/Migration_20022001_153604.log for a log created on 20 February 2001 at 15.36:04.

-D	Directory Server 5.1 userDN with root permissions, such as Directory Manager.
-w	Password associated with the user DN. If you do not specify this option, anonymous access is used. If you specify -w -, the utility prompts for the password. If either -w option is specified, the -j option must not be specified. For example, -w diner892.
-j	Specifies the file from which the bind password is read. Used for simple authentication. If this option is specified, the -w option must not be specified.
-p	Directory Server 5.1 port. The default value is the LDAP port of Directory Server 5.1 specified at installation time.
-h	Host name of Directory Server 5.1. The default value is the full host name of the machine where Directory Server 5.1. is installed.
-I DN	Entry DN or role DN whose status is required.

Previous Contents Index DocHome Next
Copyright © 2001 Sun Microsystems, Inc. Some preexisting portions Copyright © 2001 Netscape Communications Corp. All rights reserved.

Last Updated October 29, 2001

Solaris 9 platform	Using the /usr/sbin/directoryserver name command
Other platforms	As the /usr/iplanet/servers/slapd-serverID/name script or .bat file

Solaris 9 platform	/var/ds5/slapd-serverID/config
Other platforms	/usr/iplanet/servers/slapd-serverID/config

Command (Solaris 9)	directoryserver bak2db [backup_directory]
Script (Other UNIX)	bak2db [backup_directory]
Batch file (Windows)	bak2db [backup_directory]

Command (Solaris 9)	directoryserver db2bak [backup_directory]
Script (Other UNIX)	db2bak [backup_directory]
Batch file (NT)	db2bak [backup_directory]

Command (Solaris 9)	directoryserver db2ldif options
Script (Other UNIX)	db2ldif options
Batch file (NT)	db2ldif options
options	{-n backend_instance}* \| {-s includesuffix}* [{-x excludesuffix}] [-r] [-C] [-u] [-U] [-m] [-M] [-a outfile*] [-1] [-N]

Command (Solaris 9)	/var/ds5/slapd-serverID/getpwenc storagescheme clearpassword
Script (Other UNIX)	getpwenc storagescheme clearpassword
Batch file (NT)	getpwenc storagescheme clearpassword

Command (Solaris 9)	directoryserver ldif2db options
Script (Other UNIX)	ldif2db options
Batch file (NT)	ldif2db options
options	-n backend_instance \| {-s includesuffix}* [{-x excludesuffix}] {-i ldiffile} [-O] [-g string] [-G namespace_id]

Command (Solaris 9)	directoryserver ldif2ldap -D rootDN -w password -f filename
Script (Other UNIX)	ldif2ldap -D rootDN -w password -f filename
Batch file (NT)	ldif2ldap -D rootDN -w password -f filename

Command (Solaris 9)	directoryserver monitor
Script (Other UNIX)	monitor
Batch file (NT)	monitor

Command (Solaris 9)	directoryserver restart
Script (Other UNIX)	restart-slapd
Batch file (NT)	restart-slapd

Command (Solaris 9)	directoryserver restoreconfig
Script (Other UNIX)	restoreconfig
Batch file (NT)	restoreconfig

Solaris 9 platform	/var/ds5/slapd-serverID/confbak
Other platforms	/usr/iplanet/servers/slapd-serverID/confbak

Command (Solaris 9)	directoryserver saveconfig
Script (Other UNIX)	saveconfig
Batch file (NT)	saveconfig

Command (Solaris 9)	directoryserver start
Script (Other UNIX)	start-slapd
Batch file (NT)	start-slapd

Command (Solaris 9)	directoryserver stop
Script (Other UNIX)	stop-slapd
Batch file (NT)	stop-slapd

Command (Solaris 9)	directoryserver suffix2instance {-s suffix}
Script (Other UNIX)	suffix2instance {-s suffix}
Batch file (NT)	suffix2instance {-s suffix}

Command (Solaris 9)	directoryserver vlvindex options
Script (Other UNIX)	vlvindex options
Batch file (NT)	vlvindex options
options	[-d debug_level] [-n backend_instance] [-s suffix] [-T VLVTag]

Command (Solaris 9)	directoryserver bak2db-task options
Perl script (All others)	bak2db.pl options
options	[-v] -D rootDN {-w password \| -w - \| -j filename } [-a backup_directory] [-t databasetype]

Command (Solaris 9)	directoryserver db2bak-task options
Perl script (All others)	db2bak.pl options
options	[-v] -D rootDN {-w password \| -w - \| -j filename } [-a backup_directory] [-t databasetype]

Command (Solaris 9)	directoryserver db2index-task options
Perl script (All others)	db2bindex.pl options
options	[-v] -D rootDN {-w password \| -w - \| -j filename } -n backend_instance [-t attributeName]

Command (Solaris 9)	directoryserver db2ldif-task options
Perl script (All others)	db2ldif.pl options
options	[-v] -D rootDN {-w password \| -w - \| -j filename } {-n backend_instance}* \| {-s includesuffix}* [{-x excludesuffix}] [-a outfile*] [-N] [-r] [-C] [-u] [-U] [-m] [-o] [-1] [M]

$PERL5LIB	installDir/bin/slapd/admin/bin
PATH	installDir/bin/slapd/admin/bin

Command (Solaris 9)	directoryserver account-status options
Perl script (All others)	ns-accountstatus.pl options
options	[-D rootDN] {-w password \| -w - \| -j filename } [-h host] [-p port] -I DN

Command (Solaris 9)	directoryserver account-activate options
Perl script (All others)	ns-activate.pl options
options	[-D rootDN] {-w password \| -w - \| -j filename } [-h host] [-p port] -I DN

Command (Solaris 9)	directoryserver account-inactivate options
Perl script (All others)	ns-inactivate.pl options
options	[-D rootDN] {-w password \| -w - \| -j filename } [-h host] [-p port] -I DN