dsidm8

Usage

Positional arguments

dsidm account

Manage generic accounts, with tasks like modify, locking and unlocking. To create an account, see "user" subcommand instead.

dsidm group

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"

dsidm initialise

Initialise a backend with domain information and sample entries

dsidm organizationalunit

Manage organizational units

dsidm posixgroup

Manage posix groups The organizationalUnit (by default ou=groups") needs to exist prior to managing posix groups.

dsidm user

Manage posix users. The organizationalUnit (by default "ou=people") needs to exist prior to managing users.

dsidm client_config

Display and generate client example configs for this LDAP server

dsidm role

Manage roles.

dsidm service

Manage service accounts. The organizationalUnit (by default "ou=Services") needs to exist prior to managing service accounts.

dsidm uniquegroup

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'

dsidm account list

list accounts that could login to the directory (returns the full DN of the entry)

dsidm account get-by-dn

get-by-dn <dn>

dsidm account modify-by-dn

modify-by-dn <dn> <add|delete|replace>:<attribute>:<value> ...

dsidm account rename-by-dn

rename the object

dsidm account delete

deletes the account

dsidm account lock

lock

dsidm account unlock

unlock

dsidm account entry-status

status of a single entry

dsidm account subtree-status

status of a subtree

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)

dsidm account bulk_update

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]

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

COMMAND 'dsidm account rename-by-dn'

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

OPTIONS 'dsidm account rename-by-dn'

--keep-old-rdn

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]

dn

The dn of the account to delete

COMMAND 'dsidm account lock'

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

dn

The dn to lock

COMMAND 'dsidm account unlock'

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

dn

The dn to unlock

COMMAND 'dsidm account entry-status'

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

dn

The single entry dn to check

OPTIONS 'dsidm account entry-status'

-V, --details

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

basedn

Search base for finding entries

OPTIONS 'dsidm account subtree-status'

-V, --details

Print more account policy details about the entries

-f FILTER, --filter FILTER

Search filter for finding entries

-s {one,sub}, --scope {one,sub}

Search scope (one, sub - default is sub

-i, --inactive-only

Only display inactivated entries

-o BECOME_INACTIVE_ON, --become-inactive-on BECOME_INACTIVE_ON

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]

COMMAND 'dsidm account change_password'

usage: dsidm [-v] [-j] instance account change_password [-h]
[dn] [new_password]
[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 ...]

OPTIONS 'dsidm account bulk_update'

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'

COMMAND 'dsidm group list'

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

OPTIONS 'dsidm group list'

--full-dn

Return the full DN of the entry instead of the RDN value

COMMAND 'dsidm group get'

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

selector

The term to search for

COMMAND 'dsidm group get_dn'

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

dn

The dn to get

COMMAND 'dsidm group create'

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

OPTIONS 'dsidm group create'

COMMAND 'dsidm group delete'

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

dn

The dn to delete

COMMAND 'dsidm group modify'

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

COMMAND 'dsidm group rename'

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

OPTIONS 'dsidm group rename'

--keep-old-rdn

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

cn of group to list members of

COMMAND 'dsidm group add_member'

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

COMMAND 'dsidm group remove_member'

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

COMMAND 'dsidm initialise'

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

OPTIONS 'dsidm initialise'

--version VERSION

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'

COMMAND 'dsidm organizationalunit list'

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

OPTIONS 'dsidm organizationalunit list'

--full-dn

Return the full DN of the entry instead of the RDN value

COMMAND 'dsidm organizationalunit get'

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

selector

The term to search for

COMMAND 'dsidm organizationalunit get_dn'

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

dn

The dn to get

COMMAND 'dsidm organizationalunit create'

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

OPTIONS 'dsidm organizationalunit create'

--ou [OU]

Value of ou

COMMAND 'dsidm organizationalunit delete'

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

dn

The dn to delete

COMMAND 'dsidm organizationalunit modify'

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

COMMAND 'dsidm organizationalunit rename'

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

OPTIONS 'dsidm organizationalunit rename'

--keep-old-rdn

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'

COMMAND 'dsidm posixgroup list'

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

OPTIONS 'dsidm posixgroup list'

--full-dn

Return the full DN of the entry instead of the RDN value

COMMAND 'dsidm posixgroup get'

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

selector

The term to search for

COMMAND 'dsidm posixgroup get_dn'

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

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'

COMMAND 'dsidm posixgroup delete'

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

dn

The dn to delete

COMMAND 'dsidm posixgroup modify'

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

COMMAND 'dsidm posixgroup rename'

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

OPTIONS 'dsidm posixgroup rename'

--keep-old-rdn

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]
[--user-type {basic,posix,service,traditional}]
{list,get,get-pwp,get_dn,create,modify,rename,delete} ...

POSITIONAL ARGUMENTS 'dsidm user'

COMMAND 'dsidm user list'

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

OPTIONS 'dsidm user list'

--full-dn

Return the full DN of the entry instead of the RDN value

COMMAND 'dsidm user get'

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

selector

The term to search for

COMMAND 'dsidm user get-pwp'

usage: dsidm [-v] [-j] instance user get-pwp [-h] [--parent-dn PARENT_DN] [selector]

Resolve and display the password policy (global, user local, or subtree local) that applies to the user, including all effective settings.

selector

The user identifier to look up (same as user get, typically uid)

OPTIONS 'dsidm user get-pwp'

--parent-dn PARENT_DN

A base DN to use for user lookups. Default is "ou=people,$SUFFIX" for users, or "ou=services,$SUFFIX" for service accounts

COMMAND 'dsidm user get_dn'

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

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'

COMMAND 'dsidm user modify'

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

COMMAND 'dsidm user rename'

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

OPTIONS 'dsidm user rename'

--keep-old-rdn

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]

dn

The dn to delete

OPTIONS 'dsidm user'

--user-type {basic,posix,service,traditional}

The type of user to manage. "basic" is an entry based off of objectclasses: nsPerson, nsAccount, and nsOrgPerson. "posix" is based off of objectclasses: nsPerson, nsAccount, nsOrgPerson, and posixAccount. "service" is based off of objectclasses: nsAccount and applicationProcess. "traditional", aka legacy, is based off of objectclasses: person, organizationalPerson, and inetOrgPerson. The default user type is "posix"

COMMAND 'dsidm client_config'

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

POSITIONAL ARGUMENTS 'dsidm client_config'

COMMAND 'dsidm client_config sssd.conf'

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

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'

COMMAND 'dsidm role list'

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

OPTIONS 'dsidm role list'

--full-dn

Return the full DN of the entry instead of the RDN value

COMMAND 'dsidm role get'

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

selector

The term to search for

COMMAND 'dsidm role get-by-dn'

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

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'

--cn [CN]

Value of cn

COMMAND 'dsidm role create-filtered'

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

OPTIONS 'dsidm role create-filtered'

--cn [CN]

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'

COMMAND 'dsidm role modify-by-dn'

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

COMMAND 'dsidm role rename-by-dn'

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

OPTIONS 'dsidm role rename-by-dn'

--keep-old-rdn

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]

dn

The dn of the role to delete

COMMAND 'dsidm role lock'

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

dn

The dn to lock

COMMAND 'dsidm role unlock'

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

dn

The dn to unlock

COMMAND 'dsidm role entry-status'

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

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

basedn

Search base for finding entries

OPTIONS 'dsidm role subtree-status'

COMMAND 'dsidm service'

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

POSITIONAL ARGUMENTS 'dsidm service'

COMMAND 'dsidm service list'

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

OPTIONS 'dsidm service list'

--full-dn

Return the full DN of the entry instead of the RDN value

COMMAND 'dsidm service get'

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

selector

The term to search for

COMMAND 'dsidm service get_dn'

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

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'

COMMAND 'dsidm service modify'

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

COMMAND 'dsidm service rename'

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

OPTIONS 'dsidm service rename'

--keep-old-rdn

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]

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'

COMMAND 'dsidm uniquegroup list'

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

OPTIONS 'dsidm uniquegroup list'

--full-dn

Return the full DN of the entry instead of the RDN value

COMMAND 'dsidm uniquegroup get'

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

selector

The term to search for

COMMAND 'dsidm uniquegroup get_dn'

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

dn

The dn to get

COMMAND 'dsidm uniquegroup create'

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

OPTIONS 'dsidm uniquegroup create'

--cn [CN]

Value of cn

COMMAND 'dsidm uniquegroup delete'

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

dn

The dn to delete

COMMAND 'dsidm uniquegroup modify'

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

COMMAND 'dsidm uniquegroup rename'

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

OPTIONS 'dsidm uniquegroup rename'

--keep-old-rdn

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

cn of group to list members of

COMMAND 'dsidm uniquegroup add_member'

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

COMMAND 'dsidm uniquegroup remove_member'

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

Options

-v, --verbose

Display verbose operation tracing during command execution

-j, --json

Return result in JSON object

-b BASEDN, --basedn BASEDN

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

-D BINDDN, --binddn BINDDN

The account to bind as for executing operations

-w BINDPW, --bindpw BINDPW

Password for the bind DN

-W, --prompt

Prompt for password of the bind DN

-y PWDFILE, --pwdfile PWDFILE

Specifies a file containing the password of the bind DN

-Z, --starttls

Connect with StartTLS