DOKK / manpages / debian 10 / python3-lib389 / dsctl.8.en
dsctl(1) General Commands Manual dsctl(1)

dsctl

dsctl [-h] [-v] [-j] [-l] [--remove-all [REMOVE_ALL]] [instance] {restart,start,stop,status,remove,db2index,db2bak,db2ldif,bak2db,ldif2db,backups} ...

The name of the instance to act upon

Sub-commands

Restart an instance of Directory Server, if it is running: else start it.
Start an instance of Directory Server, if it is not currently running
Stop an instance of Directory Server, if it is currently running
Check running status of an instance of Directory Server
Destroy an instance of Directory Server, and remove all data.
Initialise a reindex of the server database. The server must be stopped for this to proceed.
Initialise a BDB backup of the database. The server must be stopped for this to proceed.
Initialise an LDIF dump of the database. The server must be stopped for this to proceed.
Restore a BDB backup of the database. The server must be stopped for this to proceed.
Restore an LDIF dump of the database. The server must be stopped for this to proceed.
List backup's found in the server's default backup directory

usage: dsctl [instance] restart [-h]

usage: dsctl [instance] start [-h]

usage: dsctl [instance] stop [-h]

usage: dsctl [instance] status [-h]

usage: dsctl [instance] remove [-h] [--do-it]

By default we do a dry run. This actually initiates the removal of the
instance.

usage: dsctl [instance] db2index [-h] backend

The backend to reindex. IE userRoot

usage: dsctl [instance] db2bak [-h] [archive]

The destination for the archive. This will be created during the db2bak
process.

usage: dsctl [instance] db2ldif [-h] [--replication] [--encrypted]
backend [ldif]

The backend to output as an LDIF. IE userRoot

The path to the ldif output location.

Export replication information, suitable for importing on a new consumer or
backups.

Export encrypted attributes

usage: dsctl [instance] bak2db [-h] archive

The archive to restore. This will erase all current server databases.

usage: dsctl [instance] ldif2db [-h] [--encrypted] backend ldif

The backend to restore from an LDIF. IE userRoot

The path to the ldif to import

Import encrypted attributes

usage: dsctl [instance] backups [-h] [--delete DELETE]

Delete backup directory

Display verbose operation tracing during command execution

Return result in JSON object

List available Directory Server instances

Remove all instances of Directory Server (you can also provide an optional
directory prefix for this argument)

lib389 was written by Red Hat Inc. <389-devel@lists.fedoraproject.org>.

The latest version of lib389 may be downloaded from http://www.port389.org/docs/389ds/FAQ/upstream-test-framework.html

Manual