1dsidm(8)                    System Manager's Manual                   dsidm(8)
2
3
4

NAME

6       dsidm
7

SYNOPSIS

9       dsidm  [-h]  [-b BASEDN] [-v] [-D BINDDN] [-w BINDPW] [-W] [-y PWDFILE]
10       [-Z] [-j] instance  {account,group,initialise,organizationalunit,posix‐
11       group,user} ...
12

OPTIONS

14       instance
15              The instance name OR the LDAP url to connect to, IE localhost,
16              ldap://mai.example.com:389
17
18
19   Sub-commands
20       dsidm account
21              Manage generic accounts IE account locking and unlocking.
22
23       dsidm group
24              Manage groups
25
26       dsidm initialise
27              Initialise a backend with domain information and sample entries
28
29       dsidm organizationalunit
30              Manage organizational units
31
32       dsidm posixgroup
33              Manage posix groups
34
35       dsidm user
36              Manage posix users
37

OPTIONS 'dsidm account'

39       usage: dsidm instance account [-h]
40                                     {list,lock,status,unlock,reset_pass‐
41       word,change_password}
42                                     ...
43
44
45   Sub-commands
46       dsidm account list
47              list
48
49       dsidm account lock
50              lock
51
52       dsidm account status
53              status
54
55       dsidm account unlock
56              unlock
57
58       dsidm account reset_password
59              Reset the password of an account. This should be performed by  a
60              directory admin.
61
62       dsidm account change_password
63              Change  the password of an account. This can be performed by any
64              user (with correct rights)
65

OPTIONS 'dsidm account list'

67       usage: dsidm instance account list [-h]
68
69
70
71

OPTIONS 'dsidm account lock'

73       usage: dsidm instance account lock [-h] [dn]
74
75
76       dn     The dn to lock
77
78
79

OPTIONS 'dsidm account status'

81       usage: dsidm instance account status [-h] [dn]
82
83
84       dn     The dn to check
85
86
87

OPTIONS 'dsidm account unlock'

89       usage: dsidm instance account unlock [-h] [dn]
90
91
92       dn     The dn to unlock
93
94
95

OPTIONS 'dsidm account reset_password'

97       usage: dsidm instance account reset_password [-h] [dn] [new_password]
98
99
100       dn     The dn to reset the password for
101
102
103       new_password
104              The new password to set
105
106
107

OPTIONS 'dsidm account change_password'

109       usage: dsidm instance account change_password [-h]
110                                                     [dn] [new_password]
111                                                     [current_password]
112
113
114       dn     The dn to change the password for
115
116
117       new_password
118              The new password to set
119
120
121       current_password
122              The accounts current password
123
124
125
126

OPTIONS 'dsidm group'

128       usage: dsidm instance group [-h]
129                                   {list,get,get_dn,create,delete,mem‐
130       bers,add_member,remove_member}
131                                   ...
132
133
134   Sub-commands
135       dsidm group list
136              list
137
138       dsidm group get
139              get
140
141       dsidm group get_dn
142              get_dn
143
144       dsidm group create
145              create
146
147       dsidm group delete
148              deletes the object
149
150       dsidm group members
151              List member dns of a group
152
153       dsidm group add_member
154              Add a member to a group
155
156       dsidm group remove_member
157              Remove a member from a group
158

OPTIONS 'dsidm group list'

160       usage: dsidm instance group list [-h]
161
162
163
164

OPTIONS 'dsidm group get'

166       usage: dsidm instance group get [-h] [selector]
167
168
169       selector
170              The term to search for
171
172
173

OPTIONS 'dsidm group get_dn'

175       usage: dsidm instance group get_dn [-h] [dn]
176
177
178       dn     The dn to get
179
180
181

OPTIONS 'dsidm group create'

183       usage: dsidm instance group create [-h] [--cn [CN]]
184
185
186
187       --cn [CN]
188              Value of cn
189
190

OPTIONS 'dsidm group delete'

192       usage: dsidm instance group delete [-h] [dn]
193
194
195       dn     The dn to delete
196
197
198

OPTIONS 'dsidm group members'

200       usage: dsidm instance group members [-h] [cn]
201
202
203       cn     cn of group to list members of
204
205
206

OPTIONS 'dsidm group add_member'

208       usage: dsidm instance group add_member [-h] [cn] [dn]
209
210
211       cn     cn of group to add member to
212
213
214       dn     dn of object to add to group as member
215
216
217

OPTIONS 'dsidm group remove_member'

219       usage: dsidm instance group remove_member [-h] [cn] [dn]
220
221
222       cn     cn of group to remove member from
223
224
225       dn     dn of object to remove from group as member
226
227
228
229

OPTIONS 'dsidm initialise'

231       usage: dsidm instance initialise [-h] [--version VERSION]
232
233
234
235       --version VERSION
236              The version of entries to create.
237
238

OPTIONS 'dsidm organizationalunit'

240       usage: dsidm instance organizationalunit [-h]
241                                                {list,get,get_dn,cre‐
242       ate,delete} ...
243
244
245   Sub-commands
246       dsidm organizationalunit list
247              list
248
249       dsidm organizationalunit get
250              get
251
252       dsidm organizationalunit get_dn
253              get_dn
254
255       dsidm organizationalunit create
256              create
257
258       dsidm organizationalunit delete
259              deletes the object
260

OPTIONS 'dsidm organizationalunit list'

262       usage: dsidm instance organizationalunit list [-h]
263
264
265
266

OPTIONS 'dsidm organizationalunit get'

268       usage: dsidm instance organizationalunit get [-h] [selector]
269
270
271       selector
272              The term to search for
273
274
275

OPTIONS 'dsidm organizationalunit get_dn'

277       usage: dsidm instance organizationalunit get_dn [-h] [dn]
278
279
280       dn     The dn to get
281
282
283

OPTIONS 'dsidm organizationalunit create'

285       usage: dsidm instance organizationalunit create [-h] [--ou [OU]]
286
287
288
289       --ou [OU]
290              Value of ou
291
292

OPTIONS 'dsidm organizationalunit delete'

294       usage: dsidm instance organizationalunit delete [-h] [dn]
295
296
297       dn     The dn to delete
298
299
300
301

OPTIONS 'dsidm posixgroup'

303       usage: dsidm instance posixgroup  [-h]  {list,get,get_dn,create,delete}
304       ...
305
306
307   Sub-commands
308       dsidm posixgroup list
309              list
310
311       dsidm posixgroup get
312              get
313
314       dsidm posixgroup get_dn
315              get_dn
316
317       dsidm posixgroup create
318              create
319
320       dsidm posixgroup delete
321              deletes the object
322

OPTIONS 'dsidm posixgroup list'

324       usage: dsidm instance posixgroup list [-h]
325
326
327
328

OPTIONS 'dsidm posixgroup get'

330       usage: dsidm instance posixgroup get [-h] [selector]
331
332
333       selector
334              The term to search for
335
336
337

OPTIONS 'dsidm posixgroup get_dn'

339       usage: dsidm instance posixgroup get_dn [-h] [dn]
340
341
342       dn     The dn to get
343
344
345

OPTIONS 'dsidm posixgroup create'

347       usage: dsidm instance posixgroup create [-h] [--cn [CN]]
348                                               [--gidNumber [GIDNUMBER]]
349
350
351
352       --cn [CN]
353              Value of cn
354
355
356       --gidNumber [GIDNUMBER]
357              Value of gidNumber
358
359

OPTIONS 'dsidm posixgroup delete'

361       usage: dsidm instance posixgroup delete [-h] [dn]
362
363
364       dn     The dn to delete
365
366
367
368

OPTIONS 'dsidm user'

370       usage: dsidm instance user [-h]
371                                  {list,get,get_dn,create,mod‐
372       ify,delete,lock,status,unlock}
373                                  ...
374
375
376   Sub-commands
377       dsidm user list
378              list
379
380       dsidm user get
381              get
382
383       dsidm user get_dn
384              get_dn
385
386       dsidm user create
387              create
388
389       dsidm user modify
390              modify <add|delete|replace>:<attribute>:<value> ...
391
392       dsidm user delete
393              deletes the object
394
395       dsidm user lock
396              lock
397
398       dsidm user status
399              status
400
401       dsidm user unlock
402              unlock
403

OPTIONS 'dsidm user list'

405       usage: dsidm instance user list [-h]
406
407
408
409

OPTIONS 'dsidm user get'

411       usage: dsidm instance user get [-h] [selector]
412
413
414       selector
415              The term to search for
416
417
418

OPTIONS 'dsidm user get_dn'

420       usage: dsidm instance user get_dn [-h] [dn]
421
422
423       dn     The dn to get
424
425
426

OPTIONS 'dsidm user create'

428       usage: dsidm instance user create [-h] [--uid [UID]] [--cn [CN]]
429                                         [--displayName [DISPLAYNAME]]
430                                         [--uidNumber [UIDNUMBER]]
431                                         [--gidNumber [GIDNUMBER]]
432                                         [--homeDirectory [HOMEDIRECTORY]]
433
434
435
436       --uid [UID]
437              Value of uid
438
439
440       --cn [CN]
441              Value of cn
442
443
444       --displayName [DISPLAYNAME]
445              Value of displayName
446
447
448       --uidNumber [UIDNUMBER]
449              Value of uidNumber
450
451
452       --gidNumber [GIDNUMBER]
453              Value of gidNumber
454
455
456       --homeDirectory [HOMEDIRECTORY]
457              Value of homeDirectory
458
459

OPTIONS 'dsidm user modify'

461       usage: dsidm instance user modify [-h] selector changes [changes ...]
462
463
464       selector
465              The uid to modify
466
467
468       changes
469              A    list     of     changes     to     apply     in     format:
470              <add|delete|replace>:<attribute>:<value>
471
472
473

OPTIONS 'dsidm user delete'

475       usage: dsidm instance user delete [-h] [dn]
476
477
478       dn     The dn to delete
479
480
481

OPTIONS 'dsidm user lock'

483       usage: dsidm instance user lock [-h] [uid]
484
485
486       uid    The uid to lock
487
488
489

OPTIONS 'dsidm user status'

491       usage: dsidm instance user status [-h] [uid]
492
493
494       uid    The uid to check
495
496
497

OPTIONS 'dsidm user unlock'

499       usage: dsidm instance user unlock [-h] [uid]
500
501
502       uid    The uid to unlock
503
504
505
506
507       -b BASEDN, --basedn BASEDN
508              Basedn (root naming context) of the instance to manage
509
510
511       -v, --verbose
512              Display verbose operation tracing during command execution
513
514
515       -D BINDDN, --binddn BINDDN
516              The account to bind as for executing operations
517
518
519       -w BINDPW, --bindpw BINDPW
520              Password for binddn
521
522
523       -W, --prompt
524              Prompt for password for binddn
525
526
527       -y PWDFILE, --pwdfile PWDFILE
528              Specifies a file containing the password for the bind DN
529
530
531       -Z, --starttls
532              Connect with StartTLS
533
534
535       -j, --json
536              Return result in JSON object
537
538

AUTHORS

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

DISTRIBUTION

543       The    latest    version    of    lib389   may   be   downloaded   from
544http://www.port389.org/docs/389ds/FAQ/upstream-test-framework.html
545
546
547
548                                    Manual                            dsidm(8)
Impressum