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,status,remove,db2index,db2bak,db2ldif,dbver‐
11 ify,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 dbverify
49 Perform a db verification. You should only do this at direction
50 of support
51 dsctl bak2db
53 Restore a BDB backup of the database. The server must be stopped
54 for this to proceed.
55 dsctl ldif2db
57 Restore an LDIF dump of the database. The server must be stopped
58 for this to proceed.
59 dsctl backups
61 List backup's found in the server's default backup directory
62 dsctl ldifs
64 List all the DLIF files located in the server's LDIF directory
65
67 usage: dsctl [instance] restart [-h]
68
73 usage: dsctl [instance] start [-h]
74
79 usage: dsctl [instance] stop [-h]
80
85 usage: dsctl [instance] status [-h]
86
91 usage: dsctl [instance] remove [-h] [--do-it]
92 --do-it
96 By default we do a dry run. This actually initiates the removal
97 of the
98 instance.
99
102 usage: dsctl [instance] db2index [-h] backend
103 backend
106 The backend to reindex. IE userRoot
107
111 usage: dsctl [instance] db2bak [-h] [archive]
112 archive
115 The destination for the archive. This will be created during the
116 db2bak
117 process.
118
122 usage: dsctl [instance] db2ldif [-h] [--replication] [--encrypted]
123 backend [ldif]
124 backend
127 The backend to output as an LDIF. IE userRoot
128 ldif The path to the ldif output location.
131 --replication
134 Export replication information, suitable for importing on a new
135 consumer or
136 backups.
137 --encrypted
140 Export encrypted attributes
141
144 usage: dsctl [instance] dbverify [-h] backend
145 backend
148 The backend to verify. IE userRoot
149
153 usage: dsctl [instance] bak2db [-h] archive
154 archive
157 The archive to restore. This will erase all current server data‐
158 bases.
159
163 usage: dsctl [instance] ldif2db [-h] [--encrypted] backend ldif
164 backend
167 The backend to restore from an LDIF. IE userRoot
168 ldif The path to the ldif to import
171 --encrypted
174 Import encrypted attributes
175
178 usage: dsctl [instance] backups [-h] [--delete DELETE]
179 --delete DELETE
183 Delete backup directory
184
187 usage: dsctl [instance] ldifs [-h] [--delete DELETE]
188 --delete DELETE
192 Delete LDIF file
193 -v, --verbose
196 Display verbose operation tracing during command execution
197 -j, --json
200 Return result in JSON object
201 -l, --list
204 List available Directory Server instances
205 --remove-all [REMOVE_ALL]
208 Remove all instances of Directory Server (you can also provide
209 an optional
210 directory prefix for this argument)
211
214 lib389 was written by Red Hat Inc. <389-devel@lists.fedoraproject.org>.
215
217 The latest version of lib389 may be downloaded from
218 ⟨http://www.port389.org/docs/389ds/FAQ/upstream-test-framework.html⟩
219 Manual dsctl(8)