1dsidm(8) System Manager's Manual dsidm(8)
2
6 dsidm
7
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,client_config} ...
12
14 instance
15 The instance name OR the LDAP url to connect to, IE localhost,
16 ldap://mai.example.com:389
17 Sub-commands
20 dsidm account
21 Manage generic accounts, with tasks like modify, locking and
22 unlocking. To create an account, see "user" subcommand instead.
23 dsidm group
25 Manage groups
26 dsidm initialise
28 Initialise a backend with domain information and sample entries
29 dsidm organizationalunit
31 Manage organizational units
32 dsidm posixgroup
34 Manage posix groups
35 dsidm user
37 Manage posix users
38 dsidm client_config
40 Display and generate client example configs for this LDAP server
41
43 usage: dsidm instance account [-h]
44 {list,get-by-dn,modify-by-
45 dn,delete,lock,status,unlock,reset_password,change_password}
46 ...
47 Sub-commands
50 dsidm account list
51 list accounts that could login to the directory
52 dsidm account get-by-dn
54 get-by-dn <dn>
55 dsidm account modify-by-dn
57 modify-by-dn <dn> <add|delete|replace>:<attribute>:<value> ...
58 dsidm account delete
60 deletes the account
61 dsidm account lock
63 lock
64 dsidm account status
66 status
67 dsidm account unlock
69 unlock
70 dsidm account reset_password
72 Reset the password of an account. This should be performed by a
73 directory admin.
74 dsidm account change_password
76 Change the password of an account. This can be performed by any
77 user (with correct rights)
78
80 usage: dsidm instance account list [-h]
81
86 usage: dsidm instance account get-by-dn [-h] [dn]
87 dn The dn to get and display
90
94 usage: dsidm instance account modify-by-dn [-h] dn changes [changes
95 ...]
96 dn The dn to get and display
99 changes
102 A list of changes to apply in format:
103 <add|delete|replace>:<attribute>:<value>
104
108 usage: dsidm instance account delete [-h] [dn]
109 dn The dn of the account to delete
112
116 usage: dsidm instance account lock [-h] [dn]
117 dn The dn to lock
120
124 usage: dsidm instance account status [-h] [dn]
125 dn The dn to check
128
132 usage: dsidm instance account unlock [-h] [dn]
133 dn The dn to unlock
136
140 usage: dsidm instance account reset_password [-h] [dn] [new_password]
141 dn The dn to reset the password for
144 new_password
147 The new password to set
148
152 usage: dsidm instance account change_password [-h]
153 [dn] [new_password]
154 [current_password]
155 dn The dn to change the password for
158 new_password
161 The new password to set
162 current_password
165 The accounts current password
166
171 usage: dsidm instance group [-h]
172 {list,get,get_dn,create,delete,mem‐
173 bers,add_member,remove_member}
174 ...
175 Sub-commands
178 dsidm group list
179 list
180 dsidm group get
182 get
183 dsidm group get_dn
185 get_dn
186 dsidm group create
188 create
189 dsidm group delete
191 deletes the object
192 dsidm group members
194 List member dns of a group
195 dsidm group add_member
197 Add a member to a group
198 dsidm group remove_member
200 Remove a member from a group
201
203 usage: dsidm instance group list [-h]
204
209 usage: dsidm instance group get [-h] [selector]
210 selector
213 The term to search for
214
218 usage: dsidm instance group get_dn [-h] [dn]
219 dn The dn to get
222
226 usage: dsidm instance group create [-h] [--cn [CN]]
227 --cn [CN]
231 Value of cn
232
235 usage: dsidm instance group delete [-h] [dn]
236 dn The dn to delete
239
243 usage: dsidm instance group members [-h] [cn]
244 cn cn of group to list members of
247
251 usage: dsidm instance group add_member [-h] [cn] [dn]
252 cn cn of group to add member to
255 dn dn of object to add to group as member
258
262 usage: dsidm instance group remove_member [-h] [cn] [dn]
263 cn cn of group to remove member from
266 dn dn of object to remove from group as member
269
274 usage: dsidm instance initialise [-h] [--version VERSION]
275 --version VERSION
279 The version of entries to create.
280
283 usage: dsidm instance organizationalunit [-h]
284 {list,get,get_dn,cre‐
285 ate,delete} ...
286 Sub-commands
289 dsidm organizationalunit list
290 list
291 dsidm organizationalunit get
293 get
294 dsidm organizationalunit get_dn
296 get_dn
297 dsidm organizationalunit create
299 create
300 dsidm organizationalunit delete
302 deletes the object
303
305 usage: dsidm instance organizationalunit list [-h]
306
311 usage: dsidm instance organizationalunit get [-h] [selector]
312 selector
315 The term to search for
316
320 usage: dsidm instance organizationalunit get_dn [-h] [dn]
321 dn The dn to get
324
328 usage: dsidm instance organizationalunit create [-h] [--ou [OU]]
329 --ou [OU]
333 Value of ou
334
337 usage: dsidm instance organizationalunit delete [-h] [dn]
338 dn The dn to delete
341
346 usage: dsidm instance posixgroup [-h] {list,get,get_dn,create,delete}
347 ...
348 Sub-commands
351 dsidm posixgroup list
352 list
353 dsidm posixgroup get
355 get
356 dsidm posixgroup get_dn
358 get_dn
359 dsidm posixgroup create
361 create
362 dsidm posixgroup delete
364 deletes the object
365
367 usage: dsidm instance posixgroup list [-h]
368
373 usage: dsidm instance posixgroup get [-h] [selector]
374 selector
377 The term to search for
378
382 usage: dsidm instance posixgroup get_dn [-h] [dn]
383 dn The dn to get
386
390 usage: dsidm instance posixgroup create [-h] [--cn [CN]]
391 [--gidNumber [GIDNUMBER]]
392 --cn [CN]
396 Value of cn
397 --gidNumber [GIDNUMBER]
400 Value of gidNumber
401
404 usage: dsidm instance posixgroup delete [-h] [dn]
405 dn The dn to delete
408
413 usage: dsidm instance user [-h]
414 {list,get,get_dn,create,mod‐
415 ify,delete,lock,status,unlock}
416 ...
417 Sub-commands
420 dsidm user list
421 list
422 dsidm user get
424 get
425 dsidm user get_dn
427 get_dn
428 dsidm user create
430 create
431 dsidm user modify
433 modify <add|delete|replace>:<attribute>:<value> ...
434 dsidm user delete
436 deletes the object
437 dsidm user lock
439 lock
440 dsidm user status
442 status
443 dsidm user unlock
445 unlock
446
448 usage: dsidm instance user list [-h]
449
454 usage: dsidm instance user get [-h] [selector]
455 selector
458 The term to search for
459
463 usage: dsidm instance user get_dn [-h] [dn]
464 dn The dn to get
467
471 usage: dsidm instance user create [-h] [--uid [UID]] [--cn [CN]]
472 [--displayName [DISPLAYNAME]]
473 [--uidNumber [UIDNUMBER]]
474 [--gidNumber [GIDNUMBER]]
475 [--homeDirectory [HOMEDIRECTORY]]
476 --uid [UID]
480 Value of uid
481 --cn [CN]
484 Value of cn
485 --displayName [DISPLAYNAME]
488 Value of displayName
489 --uidNumber [UIDNUMBER]
492 Value of uidNumber
493 --gidNumber [GIDNUMBER]
496 Value of gidNumber
497 --homeDirectory [HOMEDIRECTORY]
500 Value of homeDirectory
501
504 usage: dsidm instance user modify [-h] selector changes [changes ...]
505 selector
508 The uid to modify
509 changes
512 A list of changes to apply in format:
513 <add|delete|replace>:<attribute>:<value>
514
518 usage: dsidm instance user delete [-h] [dn]
519 dn The dn to delete
522
526 usage: dsidm instance user lock [-h] [uid]
527 uid The uid to lock
530
534 usage: dsidm instance user status [-h] [uid]
535 uid The uid to check
538
542 usage: dsidm instance user unlock [-h] [uid]
543 uid The uid to unlock
546
551 usage: dsidm instance client_config [-h] {sssd.conf,ldap.conf,display}
552 ...
553 Sub-commands
556 dsidm client_config sssd.conf
557 Generate a SSSD configuration for this LDAP server
558 dsidm client_config ldap.conf
560 Generate an OpenLDAP ldap.conf configuration for this LDAP
561 server
562 dsidm client_config display
564 Display generic application parameters for LDAP connection
565
567 usage: dsidm instance client_config sssd.conf [-h] [allowed_group]
568 allowed_group
571 The name of the group allowed access to this system
572
576 usage: dsidm instance client_config ldap.conf [-h]
577
582 usage: dsidm instance client_config display [-h]
583 -b BASEDN, --basedn BASEDN
589 Basedn (root naming context) of the instance to manage
590 -v, --verbose
593 Display verbose operation tracing during command execution
594 -D BINDDN, --binddn BINDDN
597 The account to bind as for executing operations
598 -w BINDPW, --bindpw BINDPW
601 Password for binddn
602 -W, --prompt
605 Prompt for password for binddn
606 -y PWDFILE, --pwdfile PWDFILE
609 Specifies a file containing the password for the bind DN
610 -Z, --starttls
613 Connect with StartTLS
614 -j, --json
617 Return result in JSON object
618
621 lib389 was written by Red Hat Inc. <389-devel@lists.fedoraproject.org>.
622
624 The latest version of lib389 may be downloaded from
625 ⟨http://www.port389.org/docs/389ds/FAQ/upstream-test-framework.html⟩
626 Manual dsidm(8)