1. Manuals
  2. Tumbleweed
  3. lib389
  4. dsidm(8)

Scroll to navigation

DSIDM(1) Generated Python Manual DSIDM(1)

NAME

dsidm

SYNOPSIS

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

POSITIONAL ARGUMENTS

Manage generic accounts, with tasks like modify, locking and unlocking. To create an account, see "user" subcommand instead.
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"
Initialise a backend with domain information and sample entries
Manage organizational units
Manage posix groups The organizationalUnit (by default ou=groups") needs to exist prior to managing posix groups.
Manage posix users. The organizationalUnit (by default "ou=people") needs to exist prior to managing users.
Display and generate client example configs for this LDAP server
Manage roles.
Manage service accounts. The organizationalUnit (by default "ou=Services") needs to exist prior to managing service accounts.
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"

COMMAND 'dsidm account'

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}
...

POSITIONAL ARGUMENTS 'dsidm account'

list accounts that could login to the directory
get-by-dn <dn>
modify-by-dn <dn> <add|delete|replace>:<attribute>:<value> ...
rename the object
deletes the account
lock
unlock
status of a single entry
status of a subtree
Reset the password of an account. This should be performed by a directory admin.
Change the password of an account. This can be performed by any user (with correct rights)
Perform a common operation to a set of entries

COMMAND 'dsidm account list'

usage: dsidm [-v] [-j] instance account list [-h]

COMMAND 'dsidm account get-by-dn'

usage: dsidm [-v] [-j] instance account get-by-dn [-h] [dn]

The dn to get and display

COMMAND 'dsidm account modify-by-dn'

usage: dsidm [-v] [-j] instance account modify-by-dn [-h] dn changes [changes ...]

The dn to get and display

A list of changes to apply in format: <add|delete|replace>:<attribute>:<value>

COMMAND 'dsidm account rename-by-dn'

usage: dsidm [-v] [-j] instance account rename-by-dn [-h] [--keep-old-rdn] dn new_dn

The dn to rename

A new role dn

OPTIONS 'dsidm account rename-by-dn'

Specify whether the old RDN (i.e. 'cn: old_role') should be kept as an attribute of the entry or not

COMMAND 'dsidm account delete'

usage: dsidm [-v] [-j] instance account delete [-h] [dn]

The dn of the account to delete

COMMAND 'dsidm account lock'

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

The dn to lock

COMMAND 'dsidm account unlock'

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

The dn to unlock

COMMAND 'dsidm account entry-status'

usage: dsidm [-v] [-j] instance account entry-status [-h] [-V] [dn]

The single entry dn to check

OPTIONS 'dsidm account entry-status'

Print more account policy details about the entry

COMMAND 'dsidm account subtree-status'

usage: dsidm [-v] [-j] instance account subtree-status [-h] [-V] [-f FILTER]
[-s {one,sub}] [-i]
[-o BECOME_INACTIVE_ON]
basedn

Search base for finding entries

OPTIONS 'dsidm account subtree-status'

Print more account policy details about the entries

Search filter for finding entries

Search scope (one, sub - default is sub

Only display inactivated entries

Only display entries that will become inactive before specified date (in a format 2007-04-25T14:30)

COMMAND 'dsidm account reset_password'

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

The dn to reset the password for

The new password to set

COMMAND 'dsidm account change_password'

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

The dn to change the password for

The new password to set

The accounts current password

COMMAND 'dsidm account bulk_update'

usage: dsidm [-v] [-j] instance account bulk_update [-h] [-f FILTER] [-s {one,sub}] [-x]
basedn changes [changes ...]

Search base for finding entries, only the children of this DN are processed

A list of changes to apply in format: <add|delete|replace>:<attribute>:<value>

OPTIONS 'dsidm account bulk_update'

Search filter for finding entries, default is '(objectclass=*)'

Search scope (one, sub - default is sub

Stop processing updates when an error occurs. Default is False

COMMAND 'dsidm group'

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

POSITIONAL ARGUMENTS 'dsidm group'

list
get
get_dn
create
deletes the object
modify <add|delete|replace>:<attribute>:<value> ...
rename the object
List member dns of a group
Add a member to a group
Remove a member from a group

COMMAND 'dsidm group list'

usage: dsidm [-v] [-j] instance group list [-h]

COMMAND 'dsidm group get'

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

The term to search for

COMMAND 'dsidm group get_dn'

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

The dn to get

COMMAND 'dsidm group create'

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

OPTIONS 'dsidm group create'

Value of cn

COMMAND 'dsidm group delete'

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

The dn to delete

COMMAND 'dsidm group modify'

usage: dsidm [-v] [-j] instance group modify [-h] selector changes [changes ...]

The cn to modify

A list of changes to apply in format: <add|delete|replace>:<attribute>:<value>

COMMAND 'dsidm group rename'

usage: dsidm [-v] [-j] instance group rename [-h] [--keep-old-rdn] selector new_name

The cn to rename

A new group name

OPTIONS 'dsidm group rename'

Specify whether the old RDN (i.e. 'cn: old_group') should be kept as an attribute of the entry or not

COMMAND 'dsidm group members'

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

cn of group to list members of

COMMAND 'dsidm group add_member'

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

cn of group to add member to

dn of object to add to group as member

COMMAND 'dsidm group remove_member'

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

cn of group to remove member from

dn of object to remove from group as member

COMMAND 'dsidm initialise'

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

OPTIONS 'dsidm initialise'

The version of entries to create.

COMMAND 'dsidm organizationalunit'

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

POSITIONAL ARGUMENTS 'dsidm organizationalunit'

list
get
get_dn
create
deletes the object
modify <add|delete|replace>:<attribute>:<value> ...
rename the object

COMMAND 'dsidm organizationalunit list'

usage: dsidm [-v] [-j] instance organizationalunit list [-h]

COMMAND 'dsidm organizationalunit get'

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

The term to search for

COMMAND 'dsidm organizationalunit get_dn'

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

The dn to get

COMMAND 'dsidm organizationalunit create'

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

OPTIONS 'dsidm organizationalunit create'

Value of ou

COMMAND 'dsidm organizationalunit delete'

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

The dn to delete

COMMAND 'dsidm organizationalunit modify'

usage: dsidm [-v] [-j] instance organizationalunit modify [-h]
selector changes
[changes ...]

The ou to modify

A list of changes to apply in format: <add|delete|replace>:<attribute>:<value>

COMMAND 'dsidm organizationalunit rename'

usage: dsidm [-v] [-j] instance organizationalunit rename [-h]
[--keep-old-rdn]
selector new_name

The ou to rename

A new organizational unit name

OPTIONS 'dsidm organizationalunit rename'

Specify whether the old RDN (i.e. 'ou: old_ou') should be kept as an attribute of the entry or not

COMMAND 'dsidm posixgroup'

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

POSITIONAL ARGUMENTS 'dsidm posixgroup'

list
get
get_dn
create
deletes the object
modify <add|delete|replace>:<attribute>:<value> ...
rename the object

COMMAND 'dsidm posixgroup list'

usage: dsidm [-v] [-j] instance posixgroup list [-h]

COMMAND 'dsidm posixgroup get'

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

The term to search for

COMMAND 'dsidm posixgroup get_dn'

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

The dn to get

COMMAND 'dsidm posixgroup create'

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

OPTIONS 'dsidm posixgroup create'

Value of cn

Value of gidNumber

COMMAND 'dsidm posixgroup delete'

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

The dn to delete

COMMAND 'dsidm posixgroup modify'

usage: dsidm [-v] [-j] instance posixgroup modify [-h] selector changes [changes ...]

The cn to modify

A list of changes to apply in format: <add|delete|replace>:<attribute>:<value>

COMMAND 'dsidm posixgroup rename'

usage: dsidm [-v] [-j] instance posixgroup rename [-h] [--keep-old-rdn]
selector new_name

The cn to rename

A new posix group name

OPTIONS 'dsidm posixgroup rename'

Specify whether the old RDN (i.e. 'cn: old_group') should be kept as an attribute of the entry or not

COMMAND 'dsidm user'

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

POSITIONAL ARGUMENTS 'dsidm user'

list
get
get_dn
create
modify <add|delete|replace>:<attribute>:<value> ...
rename the object
deletes the object

COMMAND 'dsidm user list'

usage: dsidm [-v] [-j] instance user list [-h]

COMMAND 'dsidm user get'

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

The term to search for

COMMAND 'dsidm user get_dn'

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

The dn to get

COMMAND 'dsidm user create'

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

OPTIONS 'dsidm user create'

Value of uid

Value of cn

Value of displayName

Value of uidNumber

Value of gidNumber

Value of homeDirectory

COMMAND 'dsidm user modify'

usage: dsidm [-v] [-j] instance user modify [-h] selector changes [changes ...]

The uid to modify

A list of changes to apply in format: <add|delete|replace>:<attribute>:<value>

COMMAND 'dsidm user rename'

usage: dsidm [-v] [-j] instance user rename [-h] [--keep-old-rdn] selector new_name

The uid to modify

A new user name

OPTIONS 'dsidm user rename'

Specify whether the old RDN (i.e. 'cn: old_user') should be kept as an attribute of the entry or not

COMMAND 'dsidm user delete'

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

The dn to delete

COMMAND 'dsidm client_config'

usage: dsidm instance client_config [-h] {sssd.conf,ldap.conf,display} ...

POSITIONAL ARGUMENTS 'dsidm client_config'

Generate a SSSD configuration for this LDAP server
Generate an OpenLDAP ldap.conf configuration for this LDAP server
Display generic application parameters for LDAP connection

COMMAND 'dsidm client_config sssd.conf'

usage: dsidm instance client_config sssd.conf [-h] [allowed_group]

The name of the group allowed access to this system

COMMAND 'dsidm client_config ldap.conf'

usage: dsidm instance client_config ldap.conf [-h]

COMMAND 'dsidm client_config display'

usage: dsidm instance client_config display [-h]

COMMAND 'dsidm role'

usage: dsidm [-v] [-j] 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}
...

POSITIONAL ARGUMENTS 'dsidm role'

list roles that could login to the directory
get
get-by-dn <dn>
create
create
create
modify-by-dn <dn> <add|delete|replace>:<attribute>:<value> ...
rename the object
deletes the role
lock
unlock
status of a single entry
status of a subtree

COMMAND 'dsidm role list'

usage: dsidm [-v] [-j] instance role list [-h]

COMMAND 'dsidm role get'

usage: dsidm [-v] [-j] instance role get [-h] [selector]

The term to search for

COMMAND 'dsidm role get-by-dn'

usage: dsidm [-v] [-j] instance role get-by-dn [-h] [dn]

The dn to get and display

COMMAND 'dsidm role create-managed'

usage: dsidm [-v] [-j] instance role create-managed [-h] [--cn [CN]]

OPTIONS 'dsidm role create-managed'

Value of cn

COMMAND 'dsidm role create-filtered'

usage: dsidm [-v] [-j] instance role create-filtered [-h] [--cn [CN]]

OPTIONS 'dsidm role create-filtered'

Value of cn

COMMAND 'dsidm role create-nested'

usage: dsidm [-v] [-j] instance role create-nested [-h] [--cn [CN]]
[--nsRoleDN [NSROLEDN]]

OPTIONS 'dsidm role create-nested'

Value of cn

Value of nsRoleDN

COMMAND 'dsidm role modify-by-dn'

usage: dsidm [-v] [-j] instance role modify-by-dn [-h]
dn changes [changes ...]

The dn to modify

A list of changes to apply in format: <add|delete|replace>:<attribute>:<value>

COMMAND 'dsidm role rename-by-dn'

usage: dsidm [-v] [-j] instance role rename-by-dn [-h] [--keep-old-rdn]
dn new_dn

The dn to rename

A new account dn

OPTIONS 'dsidm role rename-by-dn'

Specify whether the old RDN (i.e. 'cn: old_account') should be kept as an attribute of the entry or not

COMMAND 'dsidm role delete'

usage: dsidm [-v] [-j] instance role delete [-h] [dn]

The dn of the role to delete

COMMAND 'dsidm role lock'

usage: dsidm [-v] [-j] instance role lock [-h] [dn]

The dn to lock

COMMAND 'dsidm role unlock'

usage: dsidm [-v] [-j] instance role unlock [-h] [dn]

The dn to unlock

COMMAND 'dsidm role entry-status'

usage: dsidm [-v] [-j] instance role entry-status [-h] [dn]

The single entry dn to check

COMMAND 'dsidm role subtree-status'

usage: dsidm [-v] [-j] instance role subtree-status [-h] [-f FILTER]
[-s {base,one,sub}]
basedn

Search base for finding entries

OPTIONS 'dsidm role subtree-status'

Search filter for finding entries

Search scope (base, one, sub - default is sub

COMMAND 'dsidm service'

usage: dsidm [-v] [-j] instance service [-h]
{list,get,get_dn,create,modify,rename,delete}
...

POSITIONAL ARGUMENTS 'dsidm service'

list
get
get_dn
create
modify <add|delete|replace>:<attribute>:<value> ...
rename the object
deletes the object

COMMAND 'dsidm service list'

usage: dsidm [-v] [-j] instance service list [-h]

COMMAND 'dsidm service get'

usage: dsidm [-v] [-j] instance service get [-h] [selector]

The term to search for

COMMAND 'dsidm service get_dn'

usage: dsidm [-v] [-j] instance service get_dn [-h] [dn]

The dn to get

COMMAND 'dsidm service create'

usage: dsidm [-v] [-j] instance service create [-h] [--cn [CN]]
[--description [DESCRIPTION]]

OPTIONS 'dsidm service create'

Value of cn

Value of description

COMMAND 'dsidm service modify'

usage: dsidm [-v] [-j] instance service modify [-h]
selector changes [changes ...]

The cn to modify

A list of changes to apply in format: <add|delete|replace>:<attribute>:<value>

COMMAND 'dsidm service rename'

usage: dsidm [-v] [-j] instance service rename [-h] [--keep-old-rdn]
selector new_name

The cn to modify

A new service name

OPTIONS 'dsidm service rename'

Specify whether the old RDN (i.e. 'cn: old_service') should be kept as an attribute of the entry or not

COMMAND 'dsidm service delete'

usage: dsidm [-v] [-j] instance service delete [-h] [dn]

The dn to delete

COMMAND 'dsidm uniquegroup'

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

POSITIONAL ARGUMENTS 'dsidm uniquegroup'

list
get
get_dn
create
deletes the object
modify <add|delete|replace>:<attribute>:<value> ...
rename the object
List member dns of a group
Add a member to a group
Remove a member from a group

COMMAND 'dsidm uniquegroup list'

usage: dsidm [-v] [-j] instance uniquegroup list [-h]

COMMAND 'dsidm uniquegroup get'

usage: dsidm [-v] [-j] instance uniquegroup get [-h] [selector]

The term to search for

COMMAND 'dsidm uniquegroup get_dn'

usage: dsidm [-v] [-j] instance uniquegroup get_dn [-h] [dn]

The dn to get

COMMAND 'dsidm uniquegroup create'

usage: dsidm [-v] [-j] instance uniquegroup create [-h] [--cn [CN]]

OPTIONS 'dsidm uniquegroup create'

Value of cn

COMMAND 'dsidm uniquegroup delete'

usage: dsidm [-v] [-j] instance uniquegroup delete [-h] [dn]

The dn to delete

COMMAND 'dsidm uniquegroup modify'

usage: dsidm [-v] [-j] instance uniquegroup modify [-h] selector changes [changes ...]

The cn to modify

A list of changes to apply in format: <add|delete|replace>:<attribute>:<value>

COMMAND 'dsidm uniquegroup rename'

usage: dsidm [-v] [-j] instance uniquegroup rename [-h] [--keep-old-rdn]
selector new_name

The cn to rename

A new group name

OPTIONS 'dsidm uniquegroup rename'

Specify whether the old RDN (i.e. 'cn: old_group') should be kept as an attribute of the entry or not

COMMAND 'dsidm uniquegroup members'

usage: dsidm [-v] [-j] instance uniquegroup members [-h] [cn]

cn of group to list members of

COMMAND 'dsidm uniquegroup add_member'

usage: dsidm [-v] [-j] instance uniquegroup add_member [-h] [cn] [dn]

cn of group to add member to

dn of object to add to group as member

COMMAND 'dsidm uniquegroup remove_member'

usage: dsidm [-v] [-j] instance uniquegroup remove_member [-h] [cn] [dn]

cn of group to remove member from

dn of object to remove from group as member

OPTIONS

Display verbose operation tracing during command execution

Return result in JSON object

Base DN (root naming context) of the instance to manage

The account to bind as for executing operations

Password for the bind DN

Prompt for password of the bind DN

Specifies a file containing the password of the bind DN

Connect with StartTLS

AUTHOR

Red Hat, Inc., and William Brown <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

2024-05-14 lib389 3.0.1