.TH DSIDM "1" "2024\-04\-05" "lib389 3.0.1" "Generated Python Manual"
.SH NAME
dsidm
.SH SYNOPSIS
.B dsidm
[-h] [-b BASEDN] [-v] [-D BINDDN] [-w BINDPW] [-W] [-y PWDFILE] [-Z] [-j] instance {account,group,initialise,init,organizationalunit,ou,posixgroup,user,client_config,role,service,uniquegroup} ...

.SH
POSITIONAL ARGUMENTS
.TP
\fBdsidm\fR \fI\,account\/\fR
Manage generic accounts, with tasks
like modify, locking and unlocking. To create an account, see "user" subcommand instead.
.TP
\fBdsidm\fR \fI\,group\/\fR
Manage groups.  The organizationalUnit (by default "ou=groups") needs to exist prior to managing groups.  Groups uses the objectclass "groupOfNames" and the grouping attribute "member"
.TP
\fBdsidm\fR \fI\,initialise\/\fR
Initialise a backend with domain information and sample entries
.TP
\fBdsidm\fR \fI\,organizationalunit\/\fR
Manage organizational units
.TP
\fBdsidm\fR \fI\,posixgroup\/\fR
Manage posix groups  The organizationalUnit (by default ou=groups") needs to exist prior to managing posix groups.
.TP
\fBdsidm\fR \fI\,user\/\fR
Manage posix users.  The organizationalUnit (by default "ou=people") needs to exist prior to managing users.
.TP
\fBdsidm\fR \fI\,client_config\/\fR
Display and generate client example configs for this LDAP server
.TP
\fBdsidm\fR \fI\,role\/\fR
Manage roles.
.TP
\fBdsidm\fR \fI\,service\/\fR
Manage service accounts
.TP
\fBdsidm\fR \fI\,uniquegroup\/\fR
Manage groups.  The organizationalUnit (by default "ou=groups") needs to exist prior to managing groups.  Unique groups uses the objectclass "groupOfUniqueNames" and the grouping attribute "uniquemember"

.SH COMMAND \fI\,'dsidm account'\/\fR
usage: dsidm instance account [\-h]
                              {list,get\-by\-dn,modify\-by\-dn,rename\-by\-dn,delete,lock,unlock,entry\-status,subtree\-status,reset_password,change_password,bulk_update}
                              ...

.SH
POSITIONAL ARGUMENTS \fI\,'dsidm account'\/\fR
.TP
\fBdsidm account\fR \fI\,list\/\fR
list accounts that could login to the directory
.TP
\fBdsidm account\fR \fI\,get\-by\-dn\/\fR
get\-by\-dn <dn>
.TP
\fBdsidm account\fR \fI\,modify\-by\-dn\/\fR
modify\-by\-dn <dn> <add|delete|replace>:<attribute>:<value> ...
.TP
\fBdsidm account\fR \fI\,rename\-by\-dn\/\fR
rename the object
.TP
\fBdsidm account\fR \fI\,delete\/\fR
deletes the account
.TP
\fBdsidm account\fR \fI\,lock\/\fR
lock
.TP
\fBdsidm account\fR \fI\,unlock\/\fR
unlock
.TP
\fBdsidm account\fR \fI\,entry\-status\/\fR
status of a single entry
.TP
\fBdsidm account\fR \fI\,subtree\-status\/\fR
status of a subtree
.TP
\fBdsidm account\fR \fI\,reset_password\/\fR
Reset the password of an account. This should be performed by a directory admin.
.TP
\fBdsidm account\fR \fI\,change_password\/\fR
Change the password of an account. This can be performed by any user (with correct rights)
.TP
\fBdsidm account\fR \fI\,bulk_update\/\fR
Perform a common operation to a set of entries

.SH COMMAND \fI\,'dsidm account list'\/\fR
usage: dsidm instance account list [\-h]

.SH COMMAND \fI\,'dsidm account get\-by\-dn'\/\fR
usage: dsidm instance account get\-by\-dn [\-h] [dn]

.TP
\fBdn\fR
The dn to get and display

.SH COMMAND \fI\,'dsidm account modify\-by\-dn'\/\fR
usage: dsidm instance account modify\-by\-dn [\-h] dn changes [changes ...]

.TP
\fBdn\fR
The dn to get and display

.TP
\fBchanges\fR
A list of changes to apply in format: <add|delete|replace>:<attribute>:<value>

.SH COMMAND \fI\,'dsidm account rename\-by\-dn'\/\fR
usage: dsidm instance account rename\-by\-dn [\-h] [\-\-keep\-old\-rdn] dn new_dn

.TP
\fBdn\fR
The dn to rename

.TP
\fBnew_dn\fR
A new role dn

.SH OPTIONS \fI\,'dsidm account rename\-by\-dn'\/\fR
.TP
\fB\-\-keep\-old\-rdn\fR
Specify whether the old RDN (i.e. 'cn: old_role') should be kept as an
attribute of the entry or not

.SH COMMAND \fI\,'dsidm account delete'\/\fR
usage: dsidm instance account delete [\-h] [dn]

.TP
\fBdn\fR
The dn of the account to delete

.SH COMMAND \fI\,'dsidm account lock'\/\fR
usage: dsidm instance account lock [\-h] [dn]

.TP
\fBdn\fR
The dn to lock

.SH COMMAND \fI\,'dsidm account unlock'\/\fR
usage: dsidm instance account unlock [\-h] [dn]

.TP
\fBdn\fR
The dn to unlock

.SH COMMAND \fI\,'dsidm account entry\-status'\/\fR
usage: dsidm instance account entry\-status [\-h] [\-V] [dn]

.TP
\fBdn\fR
The single entry dn to check

.SH OPTIONS \fI\,'dsidm account entry\-status'\/\fR
.TP
\fB\-V\fR, \fB\-\-details\fR
Print more account policy details about the entry

.SH COMMAND \fI\,'dsidm account subtree\-status'\/\fR
usage: dsidm instance account subtree\-status [\-h] [\-V] [\-f FILTER]
                                             [\-s {one,sub}] [\-i]
                                             [\-o BECOME_INACTIVE_ON]
                                             basedn

.TP
\fBbasedn\fR
Search base for finding entries

.SH OPTIONS \fI\,'dsidm account subtree\-status'\/\fR
.TP
\fB\-V\fR, \fB\-\-details\fR
Print more account policy details about the entries

.TP
\fB\-f\fR \fI\,FILTER\/\fR, \fB\-\-filter\fR \fI\,FILTER\/\fR
Search filter for finding entries

.TP
\fB\-s\fR \fI\,{one,sub}\/\fR, \fB\-\-scope\fR \fI\,{one,sub}\/\fR
Search scope (one, sub \- default is sub

.TP
\fB\-i\fR, \fB\-\-inactive\-only\fR
Only display inactivated entries

.TP
\fB\-o\fR \fI\,BECOME_INACTIVE_ON\/\fR, \fB\-\-become\-inactive\-on\fR \fI\,BECOME_INACTIVE_ON\/\fR
Only display entries that will become inactive before specified date (in a
format 2007\-04\-25T14:30)

.SH COMMAND \fI\,'dsidm account reset_password'\/\fR
usage: dsidm instance account reset_password [\-h] [dn] [new_password]

.TP
\fBdn\fR
The dn to reset the password for

.TP
\fBnew_password\fR
The new password to set

.SH COMMAND \fI\,'dsidm account change_password'\/\fR
usage: dsidm instance account change_password [\-h]
                                              [dn] [new_password]
                                              [current_password]

.TP
\fBdn\fR
The dn to change the password for

.TP
\fBnew_password\fR
The new password to set

.TP
\fBcurrent_password\fR
The accounts current password

.SH COMMAND \fI\,'dsidm account bulk_update'\/\fR
usage: dsidm instance account bulk_update [\-h] [\-f FILTER] [\-s {one,sub}] [\-x]
                                          basedn changes [changes ...]

.TP
\fBbasedn\fR
Search base for finding entries, only the children of this DN are processed

.TP
\fBchanges\fR
A list of changes to apply in format: <add|delete|replace>:<attribute>:<value>

.SH OPTIONS \fI\,'dsidm account bulk_update'\/\fR
.TP
\fB\-f\fR \fI\,FILTER\/\fR, \fB\-\-filter\fR \fI\,FILTER\/\fR
Search filter for finding entries, default is '(objectclass=*)'

.TP
\fB\-s\fR \fI\,{one,sub}\/\fR, \fB\-\-scope\fR \fI\,{one,sub}\/\fR
Search scope (one, sub \- default is sub

.TP
\fB\-x\fR, \fB\-\-stop\fR
Stop processing updates when an error occurs. Default is False

.SH COMMAND \fI\,'dsidm group'\/\fR
usage: dsidm instance group [\-h]
                            {list,get,get_dn,create,delete,modify,rename,members,add_member,remove_member}
                            ...

.SH
POSITIONAL ARGUMENTS \fI\,'dsidm group'\/\fR
.TP
\fBdsidm group\fR \fI\,list\/\fR
list
.TP
\fBdsidm group\fR \fI\,get\/\fR
get
.TP
\fBdsidm group\fR \fI\,get_dn\/\fR
get_dn
.TP
\fBdsidm group\fR \fI\,create\/\fR
create
.TP
\fBdsidm group\fR \fI\,delete\/\fR
deletes the object
.TP
\fBdsidm group\fR \fI\,modify\/\fR
modify <add|delete|replace>:<attribute>:<value> ...
.TP
\fBdsidm group\fR \fI\,rename\/\fR
rename the object
.TP
\fBdsidm group\fR \fI\,members\/\fR
List member dns of a group
.TP
\fBdsidm group\fR \fI\,add_member\/\fR
Add a member to a group
.TP
\fBdsidm group\fR \fI\,remove_member\/\fR
Remove a member from a group

.SH COMMAND \fI\,'dsidm group list'\/\fR
usage: dsidm instance group list [\-h]

.SH COMMAND \fI\,'dsidm group get'\/\fR
usage: dsidm instance group get [\-h] [selector]

.TP
\fBselector\fR
The term to search for

.SH COMMAND \fI\,'dsidm group get_dn'\/\fR
usage: dsidm instance group get_dn [\-h] [dn]

.TP
\fBdn\fR
The dn to get

.SH COMMAND \fI\,'dsidm group create'\/\fR
usage: dsidm instance group create [\-h] [\-\-cn [CN]]

.SH OPTIONS \fI\,'dsidm group create'\/\fR
.TP
\fB\-\-cn\fR \fI\,[CN]\/\fR
Value of cn

.SH COMMAND \fI\,'dsidm group delete'\/\fR
usage: dsidm instance group delete [\-h] [dn]

.TP
\fBdn\fR
The dn to delete

.SH COMMAND \fI\,'dsidm group modify'\/\fR
usage: dsidm instance group modify [\-h] selector changes [changes ...]

.TP
\fBselector\fR
The cn to modify

.TP
\fBchanges\fR
A list of changes to apply in format: <add|delete|replace>:<attribute>:<value>

.SH COMMAND \fI\,'dsidm group rename'\/\fR
usage: dsidm instance group rename [\-h] [\-\-keep\-old\-rdn] selector new_name

.TP
\fBselector\fR
The cn to rename

.TP
\fBnew_name\fR
A new group name

.SH OPTIONS \fI\,'dsidm group rename'\/\fR
.TP
\fB\-\-keep\-old\-rdn\fR
Specify whether the old RDN (i.e. 'cn: old_group') should be kept as an
attribute of the entry or not

.SH COMMAND \fI\,'dsidm group members'\/\fR
usage: dsidm instance group members [\-h] [cn]

.TP
\fBcn\fR
cn of group to list members of

.SH COMMAND \fI\,'dsidm group add_member'\/\fR
usage: dsidm instance group add_member [\-h] [cn] [dn]

.TP
\fBcn\fR
cn of group to add member to

.TP
\fBdn\fR
dn of object to add to group as member

.SH COMMAND \fI\,'dsidm group remove_member'\/\fR
usage: dsidm instance group remove_member [\-h] [cn] [dn]

.TP
\fBcn\fR
cn of group to remove member from

.TP
\fBdn\fR
dn of object to remove from group as member

.SH COMMAND \fI\,'dsidm initialise'\/\fR
usage: dsidm instance initialise [\-h] [\-\-version VERSION]

.SH OPTIONS \fI\,'dsidm initialise'\/\fR
.TP
\fB\-\-version\fR \fI\,VERSION\/\fR
The version of entries to create.

.SH COMMAND \fI\,'dsidm organizationalunit'\/\fR
usage: dsidm instance organizationalunit [\-h]
                                         {list,get,get_dn,create,delete,modify,rename}
                                         ...

.SH
POSITIONAL ARGUMENTS \fI\,'dsidm organizationalunit'\/\fR
.TP
\fBdsidm organizationalunit\fR \fI\,list\/\fR
list
.TP
\fBdsidm organizationalunit\fR \fI\,get\/\fR
get
.TP
\fBdsidm organizationalunit\fR \fI\,get_dn\/\fR
get_dn
.TP
\fBdsidm organizationalunit\fR \fI\,create\/\fR
create
.TP
\fBdsidm organizationalunit\fR \fI\,delete\/\fR
deletes the object
.TP
\fBdsidm organizationalunit\fR \fI\,modify\/\fR
modify <add|delete|replace>:<attribute>:<value> ...
.TP
\fBdsidm organizationalunit\fR \fI\,rename\/\fR
rename the object

.SH COMMAND \fI\,'dsidm organizationalunit list'\/\fR
usage: dsidm instance organizationalunit list [\-h]

.SH COMMAND \fI\,'dsidm organizationalunit get'\/\fR
usage: dsidm instance organizationalunit get [\-h] [selector]

.TP
\fBselector\fR
The term to search for

.SH COMMAND \fI\,'dsidm organizationalunit get_dn'\/\fR
usage: dsidm instance organizationalunit get_dn [\-h] [dn]

.TP
\fBdn\fR
The dn to get

.SH COMMAND \fI\,'dsidm organizationalunit create'\/\fR
usage: dsidm instance organizationalunit create [\-h] [\-\-ou [OU]]

.SH OPTIONS \fI\,'dsidm organizationalunit create'\/\fR
.TP
\fB\-\-ou\fR \fI\,[OU]\/\fR
Value of ou

.SH COMMAND \fI\,'dsidm organizationalunit delete'\/\fR
usage: dsidm instance organizationalunit delete [\-h] [dn]

.TP
\fBdn\fR
The dn to delete

.SH COMMAND \fI\,'dsidm organizationalunit modify'\/\fR
usage: dsidm instance organizationalunit modify [\-h]
                                                selector changes [changes ...]

.TP
\fBselector\fR
The ou to modify

.TP
\fBchanges\fR
A list of changes to apply in format: <add|delete|replace>:<attribute>:<value>

.SH COMMAND \fI\,'dsidm organizationalunit rename'\/\fR
usage: dsidm instance organizationalunit rename [\-h] [\-\-keep\-old\-rdn]
                                                selector new_name

.TP
\fBselector\fR
The ou to rename

.TP
\fBnew_name\fR
A new organizational unit name

.SH OPTIONS \fI\,'dsidm organizationalunit rename'\/\fR
.TP
\fB\-\-keep\-old\-rdn\fR
Specify whether the old RDN (i.e. 'ou: old_ou') should be kept as an attribute
of the entry or not

.SH COMMAND \fI\,'dsidm posixgroup'\/\fR
usage: dsidm instance posixgroup [\-h]
                                 {list,get,get_dn,create,delete,modify,rename}
                                 ...

.SH
POSITIONAL ARGUMENTS \fI\,'dsidm posixgroup'\/\fR
.TP
\fBdsidm posixgroup\fR \fI\,list\/\fR
list
.TP
\fBdsidm posixgroup\fR \fI\,get\/\fR
get
.TP
\fBdsidm posixgroup\fR \fI\,get_dn\/\fR
get_dn
.TP
\fBdsidm posixgroup\fR \fI\,create\/\fR
create
.TP
\fBdsidm posixgroup\fR \fI\,delete\/\fR
deletes the object
.TP
\fBdsidm posixgroup\fR \fI\,modify\/\fR
modify <add|delete|replace>:<attribute>:<value> ...
.TP
\fBdsidm posixgroup\fR \fI\,rename\/\fR
rename the object

.SH COMMAND \fI\,'dsidm posixgroup list'\/\fR
usage: dsidm instance posixgroup list [\-h]

.SH COMMAND \fI\,'dsidm posixgroup get'\/\fR
usage: dsidm instance posixgroup get [\-h] [selector]

.TP
\fBselector\fR
The term to search for

.SH COMMAND \fI\,'dsidm posixgroup get_dn'\/\fR
usage: dsidm instance posixgroup get_dn [\-h] [dn]

.TP
\fBdn\fR
The dn to get

.SH COMMAND \fI\,'dsidm posixgroup create'\/\fR
usage: dsidm instance posixgroup create [\-h] [\-\-cn [CN]]
                                        [\-\-gidNumber [GIDNUMBER]]

.SH OPTIONS \fI\,'dsidm posixgroup create'\/\fR
.TP
\fB\-\-cn\fR \fI\,[CN]\/\fR
Value of cn

.TP
\fB\-\-gidNumber\fR \fI\,[GIDNUMBER]\/\fR
Value of gidNumber

.SH COMMAND \fI\,'dsidm posixgroup delete'\/\fR
usage: dsidm instance posixgroup delete [\-h] [dn]

.TP
\fBdn\fR
The dn to delete

.SH COMMAND \fI\,'dsidm posixgroup modify'\/\fR
usage: dsidm instance posixgroup modify [\-h] selector changes [changes ...]

.TP
\fBselector\fR
The cn to modify

.TP
\fBchanges\fR
A list of changes to apply in format: <add|delete|replace>:<attribute>:<value>

.SH COMMAND \fI\,'dsidm posixgroup rename'\/\fR
usage: dsidm instance posixgroup rename [\-h] [\-\-keep\-old\-rdn]
                                        selector new_name

.TP
\fBselector\fR
The cn to rename

.TP
\fBnew_name\fR
A new posix group name

.SH OPTIONS \fI\,'dsidm posixgroup rename'\/\fR
.TP
\fB\-\-keep\-old\-rdn\fR
Specify whether the old RDN (i.e. 'cn: old_group') should be kept as an
attribute of the entry or not

.SH COMMAND \fI\,'dsidm user'\/\fR
usage: dsidm instance user [\-h]
                           {list,get,get_dn,create,modify,rename,delete} ...

.SH
POSITIONAL ARGUMENTS \fI\,'dsidm user'\/\fR
.TP
\fBdsidm user\fR \fI\,list\/\fR
list
.TP
\fBdsidm user\fR \fI\,get\/\fR
get
.TP
\fBdsidm user\fR \fI\,get_dn\/\fR
get_dn
.TP
\fBdsidm user\fR \fI\,create\/\fR
create
.TP
\fBdsidm user\fR \fI\,modify\/\fR
modify <add|delete|replace>:<attribute>:<value> ...
.TP
\fBdsidm user\fR \fI\,rename\/\fR
rename the object
.TP
\fBdsidm user\fR \fI\,delete\/\fR
deletes the object

.SH COMMAND \fI\,'dsidm user list'\/\fR
usage: dsidm instance user list [\-h]

.SH COMMAND \fI\,'dsidm user get'\/\fR
usage: dsidm instance user get [\-h] [selector]

.TP
\fBselector\fR
The term to search for

.SH COMMAND \fI\,'dsidm user get_dn'\/\fR
usage: dsidm instance user get_dn [\-h] [dn]

.TP
\fBdn\fR
The dn to get

.SH COMMAND \fI\,'dsidm user create'\/\fR
usage: dsidm instance user create [\-h] [\-\-uid [UID]] [\-\-cn [CN]]
                                  [\-\-displayName [DISPLAYNAME]]
                                  [\-\-uidNumber [UIDNUMBER]]
                                  [\-\-gidNumber [GIDNUMBER]]
                                  [\-\-homeDirectory [HOMEDIRECTORY]]

.SH OPTIONS \fI\,'dsidm user create'\/\fR
.TP
\fB\-\-uid\fR \fI\,[UID]\/\fR
Value of uid

.TP
\fB\-\-cn\fR \fI\,[CN]\/\fR
Value of cn

.TP
\fB\-\-displayName\fR \fI\,[DISPLAYNAME]\/\fR
Value of displayName

.TP
\fB\-\-uidNumber\fR \fI\,[UIDNUMBER]\/\fR
Value of uidNumber

.TP
\fB\-\-gidNumber\fR \fI\,[GIDNUMBER]\/\fR
Value of gidNumber

.TP
\fB\-\-homeDirectory\fR \fI\,[HOMEDIRECTORY]\/\fR
Value of homeDirectory

.SH COMMAND \fI\,'dsidm user modify'\/\fR
usage: dsidm instance user modify [\-h] selector changes [changes ...]

.TP
\fBselector\fR
The uid to modify

.TP
\fBchanges\fR
A list of changes to apply in format: <add|delete|replace>:<attribute>:<value>

.SH COMMAND \fI\,'dsidm user rename'\/\fR
usage: dsidm instance user rename [\-h] [\-\-keep\-old\-rdn] selector new_name

.TP
\fBselector\fR
The uid to modify

.TP
\fBnew_name\fR
A new user name

.SH OPTIONS \fI\,'dsidm user rename'\/\fR
.TP
\fB\-\-keep\-old\-rdn\fR
Specify whether the old RDN (i.e. 'cn: old_user') should be kept as an
attribute of the entry or not

.SH COMMAND \fI\,'dsidm user delete'\/\fR
usage: dsidm instance user delete [\-h] [dn]

.TP
\fBdn\fR
The dn to delete

.SH COMMAND \fI\,'dsidm client_config'\/\fR
usage: dsidm instance client_config [\-h] {sssd.conf,ldap.conf,display} ...

.SH
POSITIONAL ARGUMENTS \fI\,'dsidm client_config'\/\fR
.TP
\fBdsidm client_config\fR \fI\,sssd.conf\/\fR
Generate a SSSD configuration for this LDAP server
.TP
\fBdsidm client_config\fR \fI\,ldap.conf\/\fR
Generate an OpenLDAP ldap.conf configuration for this LDAP server
.TP
\fBdsidm client_config\fR \fI\,display\/\fR
Display generic application parameters for LDAP connection

.SH COMMAND \fI\,'dsidm client_config sssd.conf'\/\fR
usage: dsidm instance client_config sssd.conf [\-h] [allowed_group]

.TP
\fBallowed_group\fR
The name of the group allowed access to this system

.SH COMMAND \fI\,'dsidm client_config ldap.conf'\/\fR
usage: dsidm instance client_config ldap.conf [\-h]

.SH COMMAND \fI\,'dsidm client_config display'\/\fR
usage: dsidm instance client_config display [\-h]

.SH COMMAND \fI\,'dsidm role'\/\fR
usage: dsidm instance role [\-h]
                           {list,get,get\-by\-dn,create\-managed,create\-filtered,create\-nested,modify\-by\-dn,rename\-by\-dn,delete,lock,unlock,entry\-status,subtree\-status}
                           ...

.SH
POSITIONAL ARGUMENTS \fI\,'dsidm role'\/\fR
.TP
\fBdsidm role\fR \fI\,list\/\fR
list roles that could login to the directory
.TP
\fBdsidm role\fR \fI\,get\/\fR
get
.TP
\fBdsidm role\fR \fI\,get\-by\-dn\/\fR
get\-by\-dn <dn>
.TP
\fBdsidm role\fR \fI\,create\-managed\/\fR
create
.TP
\fBdsidm role\fR \fI\,create\-filtered\/\fR
create
.TP
\fBdsidm role\fR \fI\,create\-nested\/\fR
create
.TP
\fBdsidm role\fR \fI\,modify\-by\-dn\/\fR
modify\-by\-dn <dn> <add|delete|replace>:<attribute>:<value> ...
.TP
\fBdsidm role\fR \fI\,rename\-by\-dn\/\fR
rename the object
.TP
\fBdsidm role\fR \fI\,delete\/\fR
deletes the role
.TP
\fBdsidm role\fR \fI\,lock\/\fR
lock
.TP
\fBdsidm role\fR \fI\,unlock\/\fR
unlock
.TP
\fBdsidm role\fR \fI\,entry\-status\/\fR
status of a single entry
.TP
\fBdsidm role\fR \fI\,subtree\-status\/\fR
status of a subtree

.SH COMMAND \fI\,'dsidm role list'\/\fR
usage: dsidm instance role list [\-h]

.SH COMMAND \fI\,'dsidm role get'\/\fR
usage: dsidm instance role get [\-h] [selector]

.TP
\fBselector\fR
The term to search for

.SH COMMAND \fI\,'dsidm role get\-by\-dn'\/\fR
usage: dsidm instance role get\-by\-dn [\-h] [dn]

.TP
\fBdn\fR
The dn to get and display

.SH COMMAND \fI\,'dsidm role create\-managed'\/\fR
usage: dsidm instance role create\-managed [\-h] [\-\-cn [CN]]

.SH OPTIONS \fI\,'dsidm role create\-managed'\/\fR
.TP
\fB\-\-cn\fR \fI\,[CN]\/\fR
Value of cn

.SH COMMAND \fI\,'dsidm role create\-filtered'\/\fR
usage: dsidm instance role create\-filtered [\-h] [\-\-cn [CN]]

.SH OPTIONS \fI\,'dsidm role create\-filtered'\/\fR
.TP
\fB\-\-cn\fR \fI\,[CN]\/\fR
Value of cn

.SH COMMAND \fI\,'dsidm role create\-nested'\/\fR
usage: dsidm instance role create\-nested [\-h] [\-\-cn [CN]]
                                         [\-\-nsRoleDN [NSROLEDN]]

.SH OPTIONS \fI\,'dsidm role create\-nested'\/\fR
.TP
\fB\-\-cn\fR \fI\,[CN]\/\fR
Value of cn

.TP
\fB\-\-nsRoleDN\fR \fI\,[NSROLEDN]\/\fR
Value of nsRoleDN

.SH COMMAND \fI\,'dsidm role modify\-by\-dn'\/\fR
usage: dsidm instance role modify\-by\-dn [\-h] dn changes [changes ...]

.TP
\fBdn\fR
The dn to modify

.TP
\fBchanges\fR
A list of changes to apply in format: <add|delete|replace>:<attribute>:<value>

.SH COMMAND \fI\,'dsidm role rename\-by\-dn'\/\fR
usage: dsidm instance role rename\-by\-dn [\-h] [\-\-keep\-old\-rdn] dn new_dn

.TP
\fBdn\fR
The dn to rename

.TP
\fBnew_dn\fR
A new account dn

.SH OPTIONS \fI\,'dsidm role rename\-by\-dn'\/\fR
.TP
\fB\-\-keep\-old\-rdn\fR
Specify whether the old RDN (i.e. 'cn: old_account') should be kept as an
attribute of the entry or not

.SH COMMAND \fI\,'dsidm role delete'\/\fR
usage: dsidm instance role delete [\-h] [dn]

.TP
\fBdn\fR
The dn of the role to delete

.SH COMMAND \fI\,'dsidm role lock'\/\fR
usage: dsidm instance role lock [\-h] [dn]

.TP
\fBdn\fR
The dn to lock

.SH COMMAND \fI\,'dsidm role unlock'\/\fR
usage: dsidm instance role unlock [\-h] [dn]

.TP
\fBdn\fR
The dn to unlock

.SH COMMAND \fI\,'dsidm role entry\-status'\/\fR
usage: dsidm instance role entry\-status [\-h] [dn]

.TP
\fBdn\fR
The single entry dn to check

.SH COMMAND \fI\,'dsidm role subtree\-status'\/\fR
usage: dsidm instance role subtree\-status [\-h] [\-f FILTER] [\-s {base,one,sub}]
                                          basedn

.TP
\fBbasedn\fR
Search base for finding entries

.SH OPTIONS \fI\,'dsidm role subtree\-status'\/\fR
.TP
\fB\-f\fR \fI\,FILTER\/\fR, \fB\-\-filter\fR \fI\,FILTER\/\fR
Search filter for finding entries

.TP
\fB\-s\fR \fI\,{base,one,sub}\/\fR, \fB\-\-scope\fR \fI\,{base,one,sub}\/\fR
Search scope (base, one, sub \- default is sub

.SH COMMAND \fI\,'dsidm service'\/\fR
usage: dsidm instance service [\-h]
                              {list,get,get_dn,create,modify,rename,delete}
                              ...

.SH
POSITIONAL ARGUMENTS \fI\,'dsidm service'\/\fR
.TP
\fBdsidm service\fR \fI\,list\/\fR
list
.TP
\fBdsidm service\fR \fI\,get\/\fR
get
.TP
\fBdsidm service\fR \fI\,get_dn\/\fR
get_dn
.TP
\fBdsidm service\fR \fI\,create\/\fR
create
.TP
\fBdsidm service\fR \fI\,modify\/\fR
modify <add|delete|replace>:<attribute>:<value> ...
.TP
\fBdsidm service\fR \fI\,rename\/\fR
rename the object
.TP
\fBdsidm service\fR \fI\,delete\/\fR
deletes the object

.SH COMMAND \fI\,'dsidm service list'\/\fR
usage: dsidm instance service list [\-h]

.SH COMMAND \fI\,'dsidm service get'\/\fR
usage: dsidm instance service get [\-h] [selector]

.TP
\fBselector\fR
The term to search for

.SH COMMAND \fI\,'dsidm service get_dn'\/\fR
usage: dsidm instance service get_dn [\-h] [dn]

.TP
\fBdn\fR
The dn to get

.SH COMMAND \fI\,'dsidm service create'\/\fR
usage: dsidm instance service create [\-h] [\-\-cn [CN]]
                                     [\-\-description [DESCRIPTION]]

.SH OPTIONS \fI\,'dsidm service create'\/\fR
.TP
\fB\-\-cn\fR \fI\,[CN]\/\fR
Value of cn

.TP
\fB\-\-description\fR \fI\,[DESCRIPTION]\/\fR
Value of description

.SH COMMAND \fI\,'dsidm service modify'\/\fR
usage: dsidm instance service modify [\-h] selector changes [changes ...]

.TP
\fBselector\fR
The cn to modify

.TP
\fBchanges\fR
A list of changes to apply in format: <add|delete|replace>:<attribute>:<value>

.SH COMMAND \fI\,'dsidm service rename'\/\fR
usage: dsidm instance service rename [\-h] [\-\-keep\-old\-rdn] selector new_name

.TP
\fBselector\fR
The cn to modify

.TP
\fBnew_name\fR
A new service name

.SH OPTIONS \fI\,'dsidm service rename'\/\fR
.TP
\fB\-\-keep\-old\-rdn\fR
Specify whether the old RDN (i.e. 'cn: old_service') should be kept as an
attribute of the entry or not

.SH COMMAND \fI\,'dsidm service delete'\/\fR
usage: dsidm instance service delete [\-h] [dn]

.TP
\fBdn\fR
The dn to delete

.SH COMMAND \fI\,'dsidm uniquegroup'\/\fR
usage: dsidm instance uniquegroup [\-h]
                                  {list,get,get_dn,create,delete,modify,rename,members,add_member,remove_member}
                                  ...

.SH
POSITIONAL ARGUMENTS \fI\,'dsidm uniquegroup'\/\fR
.TP
\fBdsidm uniquegroup\fR \fI\,list\/\fR
list
.TP
\fBdsidm uniquegroup\fR \fI\,get\/\fR
get
.TP
\fBdsidm uniquegroup\fR \fI\,get_dn\/\fR
get_dn
.TP
\fBdsidm uniquegroup\fR \fI\,create\/\fR
create
.TP
\fBdsidm uniquegroup\fR \fI\,delete\/\fR
deletes the object
.TP
\fBdsidm uniquegroup\fR \fI\,modify\/\fR
modify <add|delete|replace>:<attribute>:<value> ...
.TP
\fBdsidm uniquegroup\fR \fI\,rename\/\fR
rename the object
.TP
\fBdsidm uniquegroup\fR \fI\,members\/\fR
List member dns of a group
.TP
\fBdsidm uniquegroup\fR \fI\,add_member\/\fR
Add a member to a group
.TP
\fBdsidm uniquegroup\fR \fI\,remove_member\/\fR
Remove a member from a group

.SH COMMAND \fI\,'dsidm uniquegroup list'\/\fR
usage: dsidm instance uniquegroup list [\-h]

.SH COMMAND \fI\,'dsidm uniquegroup get'\/\fR
usage: dsidm instance uniquegroup get [\-h] [selector]

.TP
\fBselector\fR
The term to search for

.SH COMMAND \fI\,'dsidm uniquegroup get_dn'\/\fR
usage: dsidm instance uniquegroup get_dn [\-h] [dn]

.TP
\fBdn\fR
The dn to get

.SH COMMAND \fI\,'dsidm uniquegroup create'\/\fR
usage: dsidm instance uniquegroup create [\-h] [\-\-cn [CN]]

.SH OPTIONS \fI\,'dsidm uniquegroup create'\/\fR
.TP
\fB\-\-cn\fR \fI\,[CN]\/\fR
Value of cn

.SH COMMAND \fI\,'dsidm uniquegroup delete'\/\fR
usage: dsidm instance uniquegroup delete [\-h] [dn]

.TP
\fBdn\fR
The dn to delete

.SH COMMAND \fI\,'dsidm uniquegroup modify'\/\fR
usage: dsidm instance uniquegroup modify [\-h] selector changes [changes ...]

.TP
\fBselector\fR
The cn to modify

.TP
\fBchanges\fR
A list of changes to apply in format: <add|delete|replace>:<attribute>:<value>

.SH COMMAND \fI\,'dsidm uniquegroup rename'\/\fR
usage: dsidm instance uniquegroup rename [\-h] [\-\-keep\-old\-rdn]
                                         selector new_name

.TP
\fBselector\fR
The cn to rename

.TP
\fBnew_name\fR
A new group name

.SH OPTIONS \fI\,'dsidm uniquegroup rename'\/\fR
.TP
\fB\-\-keep\-old\-rdn\fR
Specify whether the old RDN (i.e. 'cn: old_group') should be kept as an
attribute of the entry or not

.SH COMMAND \fI\,'dsidm uniquegroup members'\/\fR
usage: dsidm instance uniquegroup members [\-h] [cn]

.TP
\fBcn\fR
cn of group to list members of

.SH COMMAND \fI\,'dsidm uniquegroup add_member'\/\fR
usage: dsidm instance uniquegroup add_member [\-h] [cn] [dn]

.TP
\fBcn\fR
cn of group to add member to

.TP
\fBdn\fR
dn of object to add to group as member

.SH COMMAND \fI\,'dsidm uniquegroup remove_member'\/\fR
usage: dsidm instance uniquegroup remove_member [\-h] [cn] [dn]

.TP
\fBcn\fR
cn of group to remove member from

.TP
\fBdn\fR
dn of object to remove from group as member

.SH OPTIONS
.TP
\fB\-b\fR \fI\,BASEDN\/\fR, \fB\-\-basedn\fR \fI\,BASEDN\/\fR
Base DN (root naming context) of the instance to manage

.TP
\fB\-v\fR, \fB\-\-verbose\fR
Display verbose operation tracing during command execution

.TP
\fB\-D\fR \fI\,BINDDN\/\fR, \fB\-\-binddn\fR \fI\,BINDDN\/\fR
The account to bind as for executing operations

.TP
\fB\-w\fR \fI\,BINDPW\/\fR, \fB\-\-bindpw\fR \fI\,BINDPW\/\fR
Password for the bind DN

.TP
\fB\-W\fR, \fB\-\-prompt\fR
Prompt for password of the bind DN

.TP
\fB\-y\fR \fI\,PWDFILE\/\fR, \fB\-\-pwdfile\fR \fI\,PWDFILE\/\fR
Specifies a file containing the password of the bind DN

.TP
\fB\-Z\fR, \fB\-\-starttls\fR
Connect with StartTLS

.TP
\fB\-j\fR, \fB\-\-json\fR
Return result in JSON object

.SH AUTHOR
.nf
Red Hat, Inc., and William Brown <389-devel@lists.fedoraproject.org>
.fi

.SH DISTRIBUTION
The latest version of lib389 may be downloaded from
.UR http://www.port389.org/docs/389ds/FAQ/upstream\-test\-framework.html
.UE