1dsctl(8) System Manager's Manual dsctl(8)
2
6 dsctl
7
9 dsctl [-h] [-v] [-j] [-l] [--remove-all [REMOVE_ALL]] [instance]
10 {restart,start,stop,sta‐
11 tus,remove,db2index,db2bak,db2ldif,bak2db,ldif2db,backups,ldifs} ...
12
14 instance
15 The name of the instance to act upon
16 Sub-commands
19 dsctl restart
20 Restart an instance of Directory Server, if it is running: else
21 start it.
22 dsctl start
24 Start an instance of Directory Server, if it is not currently
25 running
26 dsctl stop
28 Stop an instance of Directory Server, if it is currently running
29 dsctl status
31 Check running status of an instance of Directory Server
32 dsctl remove
34 Destroy an instance of Directory Server, and remove all data.
35 dsctl db2index
37 Initialise a reindex of the server database. The server must be
38 stopped for this to proceed.
39 dsctl db2bak
41 Initialise a BDB backup of the database. The server must be
42 stopped for this to proceed.
43 dsctl db2ldif
45 Initialise an LDIF dump of the database. The server must be
46 stopped for this to proceed.
47 dsctl bak2db
49 Restore a BDB backup of the database. The server must be stopped
50 for this to proceed.
51 dsctl ldif2db
53 Restore an LDIF dump of the database. The server must be stopped
54 for this to proceed.
55 dsctl backups
57 List backup's found in the server's default backup directory
58 dsctl ldifs
60 List all the DLIF files located in the server's LDIF directory
61
63 usage: dsctl [instance] restart [-h]
64
69 usage: dsctl [instance] start [-h]
70
75 usage: dsctl [instance] stop [-h]
76
81 usage: dsctl [instance] status [-h]
82
87 usage: dsctl [instance] remove [-h] [--do-it]
88 --do-it
92 By default we do a dry run. This actually initiates the removal
93 of the
94 instance.
95
98 usage: dsctl [instance] db2index [-h] backend
99 backend
102 The backend to reindex. IE userRoot
103
107 usage: dsctl [instance] db2bak [-h] [archive]
108 archive
111 The destination for the archive. This will be created during the
112 db2bak
113 process.
114
118 usage: dsctl [instance] db2ldif [-h] [--replication] [--encrypted]
119 backend [ldif]
120 backend
123 The backend to output as an LDIF. IE userRoot
124 ldif The path to the ldif output location.
127 --replication
130 Export replication information, suitable for importing on a new
131 consumer or
132 backups.
133 --encrypted
136 Export encrypted attributes
137
140 usage: dsctl [instance] bak2db [-h] archive
141 archive
144 The archive to restore. This will erase all current server data‐
145 bases.
146
150 usage: dsctl [instance] ldif2db [-h] [--encrypted] backend ldif
151 backend
154 The backend to restore from an LDIF. IE userRoot
155 ldif The path to the ldif to import
158 --encrypted
161 Import encrypted attributes
162
165 usage: dsctl [instance] backups [-h] [--delete DELETE]
166 --delete DELETE
170 Delete backup directory
171
174 usage: dsctl [instance] ldifs [-h] [--delete DELETE]
175 --delete DELETE
179 Delete LDIF file
180 -v, --verbose
183 Display verbose operation tracing during command execution
184 -j, --json
187 Return result in JSON object
188 -l, --list
191 List available Directory Server instances
192 --remove-all [REMOVE_ALL]
195 Remove all instances of Directory Server (you can also provide
196 an optional
197 directory prefix for this argument)
198
201 lib389 was written by Red Hat Inc. <389-devel@lists.fedoraproject.org>.
202
204 The latest version of lib389 may be downloaded from
205 ⟨http://www.port389.org/docs/389ds/FAQ/upstream-test-framework.html⟩
206 Manual dsctl(8)