Scroll to navigation

dsidm(1) General Commands Manual dsidm(1)

NAME

dsidm

SYNOPSIS

dsidm [-h] [-b BASEDN] [-v] [-D BINDDN] [-w BINDPW] [-W] [-y PWDFILE] [-Z] [-j] instance {account,group,initialise,organizationalunit,posixgroup,user} ...

OPTIONS

instance
The instance name OR the LDAP url to connect to, IE localhost,
ldap://mai.example.com:389

Sub-commands

dsidm account
Manage generic accounts IE account locking and unlocking.
dsidm group
Manage groups
dsidm initialise
Initialise a backend with domain information and sample entries
dsidm organizationalunit
Manage organizational units
dsidm posixgroup
Manage posix groups
dsidm user
Manage posix users

OPTIONS 'dsidm account'

usage: dsidm instance account [-h] {list,lock,status,unlock,reset_password,change_password} ...

Sub-commands

dsidm account list
list
dsidm account lock
lock
dsidm account status
status
dsidm account unlock
unlock
dsidm account reset_password
Reset the password of an account. This should be performed by a directory admin.
dsidm account change_password
Change the password of an account. This can be performed by any user (with correct rights)

OPTIONS 'dsidm account list'

usage: dsidm instance account list [-h]

OPTIONS 'dsidm account lock'

usage: dsidm instance account lock [-h] [dn]

dn
The dn to lock

OPTIONS 'dsidm account status'

usage: dsidm instance account status [-h] [dn]

dn
The dn to check

OPTIONS 'dsidm account unlock'

usage: dsidm instance account unlock [-h] [dn]

dn
The dn to unlock

OPTIONS 'dsidm account reset_password'

usage: dsidm instance account reset_password [-h] [dn] [new_password]

dn
The dn to reset the password for

new_password
The new password to set

OPTIONS 'dsidm account change_password'

usage: dsidm instance account change_password [-h] [dn] [new_password] [current_password]

dn
The dn to change the password for

new_password
The new password to set

current_password
The accounts current password

OPTIONS 'dsidm group'

usage: dsidm instance group [-h] {list,get,get_dn,create,delete,members,add_member,remove_member} ...

Sub-commands

dsidm group list
list
dsidm group get
get
dsidm group get_dn
get_dn
dsidm group create
create
dsidm group delete
deletes the object
dsidm group members
List member dns of a group
dsidm group add_member
Add a member to a group
dsidm group remove_member
Remove a member from a group

OPTIONS 'dsidm group list'

usage: dsidm instance group list [-h]

OPTIONS 'dsidm group get'

usage: dsidm instance group get [-h] [selector]

selector
The term to search for

OPTIONS 'dsidm group get_dn'

usage: dsidm instance group get_dn [-h] [dn]

dn
The dn to get

OPTIONS 'dsidm group create'

usage: dsidm instance group create [-h] [--cn [CN]]

--cn [CN]
Value of cn

OPTIONS 'dsidm group delete'

usage: dsidm instance group delete [-h] [dn]

dn
The dn to delete

OPTIONS 'dsidm group members'

usage: dsidm instance group members [-h] [cn]

cn
cn of group to list members of

OPTIONS 'dsidm group add_member'

usage: dsidm instance group add_member [-h] [cn] [dn]

cn
cn of group to add member to

dn
dn of object to add to group as member

OPTIONS 'dsidm group remove_member'

usage: dsidm instance group remove_member [-h] [cn] [dn]

cn
cn of group to remove member from

dn
dn of object to remove from group as member

OPTIONS 'dsidm initialise'

usage: dsidm instance initialise [-h] [--version VERSION]

--version VERSION
The version of entries to create.

OPTIONS 'dsidm organizationalunit'

usage: dsidm instance organizationalunit [-h] {list,get,get_dn,create,delete} ...

Sub-commands

dsidm organizationalunit list
list
dsidm organizationalunit get
get
dsidm organizationalunit get_dn
get_dn
dsidm organizationalunit create
create
dsidm organizationalunit delete
deletes the object

OPTIONS 'dsidm organizationalunit list'

usage: dsidm instance organizationalunit list [-h]

OPTIONS 'dsidm organizationalunit get'

usage: dsidm instance organizationalunit get [-h] [selector]

selector
The term to search for

OPTIONS 'dsidm organizationalunit get_dn'

usage: dsidm instance organizationalunit get_dn [-h] [dn]

dn
The dn to get

OPTIONS 'dsidm organizationalunit create'

usage: dsidm instance organizationalunit create [-h] [--ou [OU]]

--ou [OU]
Value of ou

OPTIONS 'dsidm organizationalunit delete'

usage: dsidm instance organizationalunit delete [-h] [dn]

dn
The dn to delete

OPTIONS 'dsidm posixgroup'

usage: dsidm instance posixgroup [-h] {list,get,get_dn,create,delete} ...

Sub-commands

dsidm posixgroup list
list
dsidm posixgroup get
get
dsidm posixgroup get_dn
get_dn
dsidm posixgroup create
create
dsidm posixgroup delete
deletes the object

OPTIONS 'dsidm posixgroup list'

usage: dsidm instance posixgroup list [-h]

OPTIONS 'dsidm posixgroup get'

usage: dsidm instance posixgroup get [-h] [selector]

selector
The term to search for

OPTIONS 'dsidm posixgroup get_dn'

usage: dsidm instance posixgroup get_dn [-h] [dn]

dn
The dn to get

OPTIONS 'dsidm posixgroup create'

usage: dsidm instance posixgroup create [-h] [--cn [CN]] [--gidNumber [GIDNUMBER]]

--cn [CN]
Value of cn

--gidNumber [GIDNUMBER]
Value of gidNumber

OPTIONS 'dsidm posixgroup delete'

usage: dsidm instance posixgroup delete [-h] [dn]

dn
The dn to delete

OPTIONS 'dsidm user'

usage: dsidm instance user [-h] {list,get,get_dn,create,delete,lock,status,unlock} ...

Sub-commands

dsidm user list
list
dsidm user get
get
dsidm user get_dn
get_dn
dsidm user create
create
dsidm user delete
deletes the object
dsidm user lock
lock
dsidm user status
status
dsidm user unlock
unlock

OPTIONS 'dsidm user list'

usage: dsidm instance user list [-h]

OPTIONS 'dsidm user get'

usage: dsidm instance user get [-h] [selector]

selector
The term to search for

OPTIONS 'dsidm user get_dn'

usage: dsidm instance user get_dn [-h] [dn]

dn
The dn to get

OPTIONS 'dsidm user create'

usage: dsidm instance user create [-h] [--uid [UID]] [--cn [CN]] [--displayName [DISPLAYNAME]] [--uidNumber [UIDNUMBER]] [--gidNumber [GIDNUMBER]] [--homeDirectory [HOMEDIRECTORY]]

--uid [UID]
Value of uid

--cn [CN]
Value of cn

--displayName [DISPLAYNAME]
Value of displayName

--uidNumber [UIDNUMBER]
Value of uidNumber

--gidNumber [GIDNUMBER]
Value of gidNumber

--homeDirectory [HOMEDIRECTORY]
Value of homeDirectory

OPTIONS 'dsidm user delete'

usage: dsidm instance user delete [-h] [dn]

dn
The dn to delete

OPTIONS 'dsidm user lock'

usage: dsidm instance user lock [-h] [uid]

uid
The uid to lock

OPTIONS 'dsidm user status'

usage: dsidm instance user status [-h] [uid]

uid
The uid to check

OPTIONS 'dsidm user unlock'

usage: dsidm instance user unlock [-h] [uid]

uid
The uid to unlock

-b BASEDN, --basedn BASEDN
Basedn (root naming context) of the instance to manage

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

-D BINDDN, --binddn BINDDN
The account to bind as for executing operations

-w BINDPW, --bindpw BINDPW
Password for binddn

-W, --prompt
Prompt for password for binddn

-y PWDFILE, --pwdfile PWDFILE
Specifies a file containing the password for the bind DN

-Z, --starttls
Connect with StartTLS

-j, --json
Return result in JSON object

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
Manual