dsctl(1)

NAME
dsctl

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

OPTIONS

instance
    The name of the instance to act upon

  Sub-commands

dsctl restart
    Restart an instance of Directory Server, if it is running: else start it.

dsctl start
    Start an instance of Directory Server, if it is not currently running

dsctl stop
    Stop an instance of Directory Server, if it is currently running

dsctl status
    Check running status of an instance of Directory Server

dsctl remove
    Destroy an instance of Directory Server, and remove all data.

dsctl db2index
    Initialise a reindex of the server database. The server must be stopped for this to proceed.

dsctl db2bak
    Initialise a BDB backup of the database. The server must be stopped for this to proceed.

dsctl db2ldif
    Initialise an LDIF dump of the database. The server must be stopped for this to proceed.

dsctl dbverify
    Perform a db verification. You should only do this at direction of support

dsctl bak2db
    Restore a BDB backup of the database. The server must be stopped for this to proceed.

dsctl ldif2db
    Restore an LDIF dump of the database. The server must be stopped for this to proceed.

dsctl backups
    List backup's found in the server's default backup directory

dsctl ldifs
    List all the LDIF files located in the server's LDIF directory

OPTIONS 'dsctl restart'
usage: dsctl [instance] restart [-h]

OPTIONS 'dsctl start'
usage: dsctl [instance] start [-h]

OPTIONS 'dsctl stop'
usage: dsctl [instance] stop [-h]

OPTIONS 'dsctl status'
usage: dsctl [instance] status [-h]

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

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

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

backend
    The backend to reindex. IE userRoot

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

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

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

backend
    The backend to output as an LDIF. IE userRoot

ldif
    The path to the ldif output location.

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

--encrypted
    Export encrypted attributes

OPTIONS 'dsctl dbverify'
usage: dsctl [instance] dbverify [-h] backend

backend
    The backend to verify. IE userRoot

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

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

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

backend
    The backend to restore from an LDIF. IE userRoot

ldif
    The path to the ldif to import

--encrypted
    Import encrypted attributes

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

--delete DELETE
    Delete backup directory

OPTIONS 'dsctl ldifs'
usage: dsctl [instance] ldifs [-h] [--delete DELETE]

--delete DELETE
    Delete LDIF file

-v, --verbose
    Display verbose operation tracing during command execution

-j, --json
    Return result in JSON object

-l, --list
    List available Directory Server instances

--remove-all [REMOVE_ALL]
    Remove all instances of Directory Server (you can also provide an optional
    directory prefix for this argument)

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

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