DSCONF(8)

๐Ÿ’– DSCONF(8) โ€” Generated Python Manual ๐Ÿ’–

okay bestie, welcome to the dsconf man page, but make it fashion. this is part 1 of 33, so buckle up. ๐Ÿ’…

โœจ NAME โœจ

dsconf โ€” the whole entire vibe. that's the name. she's the command-line bestie for your 389 Directory Server instance. periodt.

โœจ SYNOPSIS โœจ

dsconf [-h] [-v] [-j] [-D BINDDN] [-w BINDPW] [-W] [-y PWDFILE] [-b
BASEDN] [-Z] instance
{backend,backup,chaining,config,directory_manager,logging,monitor,plugin,pwpolicy,localpwp,replication,repl,repl-
agmt,repl-winsync-agmt,repl-tasks,repl-conflict,sasl,security,schema}
...

๐ŸŒˆ POSITIONAL ARGUMENTS ๐ŸŒˆ

  • dsconf backend โ€” Manage database suffixes and backends. the whole backend situation, slay.
  • dsconf backup โ€” Manage online backups. protect the bag. ๐Ÿ’ฐ
  • dsconf chaining โ€” Manage database chaining and database links. linking databases like it's a group chat.
  • dsconf config โ€” Manage the server configuration. the settings page but make it CLI.
  • dsconf directory_manager โ€” Manage the Directory Manager account. the VIP account, no cap.
  • dsconf logging โ€” Manage the server logs. receipts, but forever.
  • dsconf monitor โ€” Monitor the state of the instance. vibe check on your server.
  • dsconf plugin โ€” Manage plug-ins available on the server. add-ons, but UNIX.
  • dsconf pwpolicy โ€” Manage the global password policy settings. rules for the passwords, periodt.
  • dsconf localpwp โ€” Manage the local user and subtree password policies. more password rules, but local.
  • dsconf replication โ€” Manage replication for a suffix. copy and paste but for databases.
  • dsconf repl-agmt โ€” Manage replication agreements. the contracts between replicas.
  • dsconf repl-winsync-agmt โ€” Manage Winsync agreements. syncing with Windows, iconic.
  • dsconf repl-tasks โ€” Manage replication tasks. chores but for replication.
  • dsconf repl-conflict โ€” Manage replication conflicts. when replicas argue, you mediate.
  • dsconf sasl โ€” Manage SASL mappings. authentication glow-up.
  • dsconf security โ€” Manage security settings. lock it down, bestie.
  • dsconf schema โ€” Manage the directory schema. the blueprint of the whole thing.

๐Ÿฆ‹ COMMAND 'dsconf backend' ๐Ÿฆ‹

usage: dsconf [-v] [-j] instance backend [-h]
                                      {suffix,index,vlv-index,attr-encrypt,config,monitor,import,export,create,delete,get-tree,compact-db}
       ...

๐ŸŒธ POSITIONAL ARGUMENTS 'dsconf backend' ๐ŸŒธ

  • dsconf backend suffix โ€” Manage backend suffixes. the endings, but for databases.
  • dsconf backend index โ€” Manage backend indexes. speed up your searches, lowkey essential.
  • dsconf backend vlv-index โ€” Manage VLV searches and indexes. virtual list view, very fancy.
  • dsconf backend attr-encrypt โ€” Manage encrypted attribute settings. secrets stay secret. ๐Ÿคซ
  • dsconf backend config โ€” Manage the global database configuration settings. the big settings.
  • dsconf backend monitor โ€” Displays global database or suffix monitoring information. see how your database is doing, emotionally.
  • dsconf backend import โ€” Online import of a suffix. bring data in while the server is up.
  • dsconf backend export โ€” Online export of a suffix. yeet data out while the server is up.
  • dsconf backend create โ€” Create a backend database. build-a-bear but for databases.
  • dsconf backend delete โ€” Delete a backend database. bye bye, bestie. ๐Ÿ˜ญ
  • dsconf backend get-tree โ€” Display the suffix tree. family tree but for suffixes.
  • dsconf backend compact-db โ€” Compact the database and the replication changelog. tidy up, clean girl aesthetic.

๐ŸŽ€ COMMAND 'dsconf backend suffix' ๐ŸŽ€

usage: dsconf [-v] [-j] instance backend suffix [-h]
                                                       {list,get,get-dn,get-sub-suffixes,set}
       ...

๐Ÿ’… POSITIONAL ARGUMENTS 'dsconf backend suffix' ๐Ÿ’…

  • dsconf backend suffix list โ€” List active backends and suffixes. show me the menu.
  • dsconf backend suffix get โ€” Display the suffix entry. one suffix, all the tea.
  • dsconf backend suffix get-dn โ€” Display the DN of a backend. the full distinguished name, okay.
  • dsconf backend suffix get-sub-suffixes โ€” Display sub-suffixes. the children of suffixes.
  • dsconf backend suffix set โ€” Set configuration settings for a specific backend. customize your backend, main character energy.

โญ COMMAND 'dsconf backend suffix list' โญ

usage: dsconf [-v] [-j] instance backend suffix list [-h] [--suffix]
                                                            [--skip-subsuffixes]

๐Ÿ”ฅ OPTIONS 'dsconf backend suffix list' ๐Ÿ”ฅ

  • --suffix โ€” Displays the suffixes without backend name. just the suffix, no last name.
  • --skip-subsuffixes โ€” Displays the list of suffixes without sub-suffixes. no kids allowed on this list.

๐Ÿ“ COMMAND 'dsconf backend suffix get' ๐Ÿ“

usage: dsconf [-v] [-j] instance backend suffix get [-h] [selector]
  • selector โ€” The backend database name to search for. tell me who you're looking for.

๐Ÿงš COMMAND 'dsconf backend suffix get-dn' ๐Ÿงš

usage: dsconf [-v] [-j] instance backend suffix get-dn [-h] [dn]
  • dn โ€” The DN to the database entry in cn=ldbm database,cn=plugins,cn=config. the whole address, periodt.

๐Ÿ’œ COMMAND 'dsconf backend suffix get-sub-suffixes' ๐Ÿ’œ

usage: dsconf [-v] [-j] instance backend suffix get-sub-suffixes
              [-h] [--suffix] be_name
  • be_name โ€” The backend name or suffix. which backend are we talking about, bestie?

โœจ OPTIONS 'dsconf backend suffix get-sub-suffixes' โœจ

  • --suffix โ€” Displays the list of suffixes without backend name. again, just the suffix.

๐Ÿ‘‘ COMMAND 'dsconf backend suffix set' ๐Ÿ‘‘

usage: dsconf [-v] [-j] instance backend suffix set [-h]
       [--enable-readonly]
                                                           [--disable-readonly]
                                                           [--enable-orphan]
                                                           [--disable-orphan]
                                                           [--require-index]
                                                           [--ignore-index]
                                                           [--add-referral
       ADD_REFERRAL]
                                                           [--del-referral
       DEL_REFERRAL]
                                                           [--enable]
       [--disable]
                                                           [--cache-size
       CACHE_SIZE]
                                                           [--cache-memsize
       CACHE_MEMSIZE]
                                                           [--cache-preserved-entries
       CACHE_PRESERVED_ENTRIES]
                                                           [--dncache-memsize
       DNCACHE_MEMSIZE]
                                                           [--state STATE]
                                                           be_name
  • be_name โ€” The backend name or suffix. which one are we setting up?

๐Ÿ’š OPTIONS 'dsconf backend suffix set' ๐Ÿ’š

  • --enable-readonly โ€” Enables read-only mode for the backend database. no writing, just reading. it's giving library.
  • --disable-readonly โ€” Disables read-only mode for the backend database. writing is back on the menu.
  • --enable-orphan โ€” Disconnect a subsuffix from its parent suffix. free the subsuffix, it's an orphan now.
  • --disable-orphan โ€” Let the subsuffix be connected to its parent suffix. family reunion, we love to see it.
  • --require-index โ€” Allows only indexed searches. if it's not indexed, it's not invited.
  • --ignore-index โ€” Allows all searches even if they are unindexed. chaos, but make it searchable.
  • --add-referral ADD_REFERRAL โ€” Adds an LDAP referral to the backend. sending people elsewhere, politely.
  • --del-referral DEL_REFERRAL โ€” Removes an LDAP referral from the backend. no more forwarding address.
  • --enable โ€” Enables the backend database. turn it on, bestie.
  • --disable โ€” Disables the backend database. turn it off, bye.
  • --cache-size CACHE_SIZE โ€” Sets the maximum number of entries to keep in the entry cache. how many entries can crash on your couch.
  • --cache-memsize CACHE_MEMSIZE โ€” Sets the maximum size in bytes that the entry cache can grow to. memory limit, but for cache.
  • --cache-preserved-entries CACHE_PRESERVED_ENTRIES โ€” Sets the maximum number of entries that are not evicted from the cache when trying to make space. This is typically used to keep very large groups in the cache. VIP entries that never get kicked out.
  • --dncache-memsize DNCACHE_MEMSIZE โ€” Sets the maximum size in bytes that the DN cache can grow to. same, but for the DN cache.
  • --state STATE โ€” Changes the backend state to: "backend", "disabled", "referral", or "referral on update". pick a state, any state.

๐Ÿฆ‹ COMMAND 'dsconf backend index' ๐Ÿฆ‹

usage: dsconf [-v] [-j] instance backend index [-h]
                                                      {add,set,get,list,delete,reindex}
       ...

๐ŸŒธ POSITIONAL ARGUMENTS 'dsconf backend index' ๐ŸŒธ

  • dsconf backend index add โ€” Add an index. new index, who dis?
  • dsconf backend index set โ€” Update an index. glow-up for your index.
  • dsconf backend index get โ€” Display an index entry. show me the index.
  • dsconf backend index list โ€” Display the index. the whole index list, periodt.
  • dsconf backend index delete โ€” Delete an index. cancel that index.
  • dsconf backend index reindex โ€” Re-index the database for a single index or all indexes. rebuild the index, it's a reset.

๐ŸŽ€ COMMAND 'dsconf backend index add' ๐ŸŽ€

usage: dsconf [-v] [-j] instance backend index add [-h]
                                                          --index-type
       INDEX_TYPE
                                                          [--matching-rule
       MATCHING_RULE]
                                                          [--reindex] --attr
       ATTR
                                                          be_name
  • be_name โ€” The backend name or suffix. which backend gets the new index?

๐Ÿ’… OPTIONS 'dsconf backend index add' ๐Ÿ’…

  • --index-type INDEX_TYPE โ€” Sets the indexing type (eq, sub, pres, or approx). choose your fighter.
  • --matching-rule MATCHING_RULE โ€” Sets the matching rule for the index. the rule of matching, obviously.
  • --reindex โ€” Re-indexes the database after adding a new index. rebuild after adding, no cap.
  • --attr ATTR โ€” Sets the attribute name to index. which attribute? tell me.

โญ COMMAND 'dsconf backend index set' โญ

usage: dsconf [-v] [-j] instance backend index set [-h] --attr ATTR
                                                          [--add-type ADD_TYPE]
                                                          [--del-type DEL_TYPE]
                                                          [--add-mr ADD_MR]
                                                          [--del-mr DEL_MR]
                                                          [--reindex]
                                                          be_name
  • be_name โ€” The backend name or suffix. which backend are we editing?

๐Ÿ”ฅ OPTIONS 'dsconf backend index set' ๐Ÿ”ฅ

  • --attr ATTR โ€” Sets the indexed attribute to update. which attribute gets the update?
  • --add-type ADD_TYPE โ€” Adds an index type to the index (eq, sub, pres, or approx). add a type, slay.
  • --del-type DEL_TYPE โ€” Removes an index type from the index: (eq, sub, pres, or approx). remove a type, bye.
  • --add-mr ADD_MR โ€” Adds a matching-rule to the index. more rules, more power.
  • --del-mr DEL_MR โ€” Removes a matching-rule from the index. rule removed, periodt.
  • --reindex โ€” Re-indexes the database after editing the index. rebuild after edit.

๐Ÿงš COMMAND 'dsconf backend index get' ๐Ÿงš

usage: dsconf [-v] [-j] instance backend index get [-h] --attr ATTR
       be_name
  • be_name โ€” The backend name or suffix. which backend?

๐Ÿ’œ OPTIONS 'dsconf backend index get' ๐Ÿ’œ

  • --attr ATTR โ€” Sets the index name to display. show me that index.

โœจ COMMAND 'dsconf backend index list' โœจ

usage: dsconf [-v] [-j] instance backend index list [-h] [--just-names]
                                                           be_name
  • be_name โ€” The backend name or suffix. which backend's index list?

๐Ÿ‘‘ OPTIONS 'dsconf backend index list' ๐Ÿ‘‘

  • --just-names โ€” Displays only the names of indexed attributes. no extra details, just names.

๐Ÿ’š COMMAND 'dsconf backend index delete' ๐Ÿ’š

usage: dsconf [-v] [-j] instance backend index delete [-h] [--attr ATTR]
                                                             be_name
  • be_name โ€” The backend name or suffix. which backend loses an index?

๐Ÿ’ง OPTIONS 'dsconf backend index delete' ๐Ÿ’ง

  • --attr ATTR โ€” Sets the name of the attribute to delete from the index. which attribute gets deleted?

๐Ÿฆ‹ COMMAND 'dsconf backend index reindex' ๐Ÿฆ‹

usage: dsconf [-v] [-j] instance backend index reindex [-h] [--attr
       ATTR]
                                                              [--wait]
       [--watch]
                                                              be_name
  • be_name โ€” The backend name or suffix. which backend gets reindexed?
  • --attr _ATTR_ โ€” names the attribute you wanna re-index. Leave it out and it re-indexes every attribute, no cap. โœจ
  • --wait โ€” waits for the index task to finish and then tells you the status
  • --watch โ€” peeks at the reindexing task's status while it's running ๐Ÿ‘€

๐Ÿฆ‹ COMMAND dsconf backend vlv-index ๐Ÿฆ‹

usage: dsconf [-v] [-j] instance backend vlv-index [-h]
                                                          {list,get,add-search,edit-search,del-search,add-index,del-index,reindex}
       ...

VLV is the "virtual list view" situation โ€” basically sorted, pre-built views so big result sets don't have to suffer. ๐Ÿ’…

๐ŸŒธ POSITIONAL ARGUMENTS dsconf backend vlv-index ๐ŸŒธ

  • dsconf backend vlv-index list โ€” lists your VLV search and index entries
  • dsconf backend vlv-index get โ€” displays a VLV search and its indexes
  • dsconf backend vlv-index add-search โ€” adds a VLV search entry. Bestie, the search entry is the parent of the VLV index entries, and it's the thing that specifies the search parameters used to match entries for those indexes.
  • dsconf backend vlv-index edit-search โ€” updates a VLV search and index
  • dsconf backend vlv-index del-search โ€” deletes a VLV search & index
  • dsconf backend vlv-index add-index โ€” creates a VLV index under a VLV search entry (that's the parent entry, formatter_class=CustomHelpFormatter). The VLV index is what specifies the attributes to sort
  • dsconf backend vlv-index del-index โ€” deletes a VLV index under a VLV search entry (the parent entry)
  • dsconf backend vlv-index reindex โ€” indexes/re-indexes the VLV database index

โญ COMMAND dsconf backend vlv-index list โญ

usage: dsconf [-v] [-j] instance backend vlv-index list [-h]
       [--just-names]
                                                               be_name
  • be_name โ€” the backend name of the VLV index

๐ŸŽ€ OPTIONS dsconf backend vlv-index list ๐ŸŽ€

  • --just-names โ€” shows you only the names of the VLV search entries, nothing else

๐Ÿฆ„ COMMAND dsconf backend vlv-index get ๐Ÿฆ„

usage: dsconf [-v] [-j] instance backend vlv-index get [-h] [--name
       NAME]
                                                              be_name
  • be_name โ€” the backend name of the VLV index

๐Ÿ’– OPTIONS dsconf backend vlv-index get ๐Ÿ’–

  • --name _NAME_ โ€” displays the VLV search entry and its index entries

usage: dsconf instance [-v] [-j] backend vlv-index add-search
       [-h] --name NAME --search-base SEARCH_BASE --search-scope
SEARCH_SCOPE
       --search-filter SEARCH_FILTER
       be_name
  • be_name โ€” the backend name of the VLV index
  • --name _NAME_ โ€” sets the name of the VLV search entry
  • --search-base _SEARCH_BASE_ โ€” sets the VLV search base
  • --search-scope _SEARCH_SCOPE_ โ€” sets the VLV search scope, and the vibes are strictly: 0 (base search), 1 (one-level search), or 2 (subtree search)
  • --search-filter _SEARCH_FILTER_ โ€” sets the VLV search filter

usage: dsconf [-v] [-j] instance backend vlv-index edit-search
       [-h] --name NAME [--search-base SEARCH_BASE]
       [--search-scope SEARCH_SCOPE] [--search-filter SEARCH_FILTER]
       [--reindex]
       be_name
  • be_name โ€” the backend name of the VLV index to update
  • --name _NAME_ โ€” sets the name of the VLV index
  • --search-base _SEARCH_BASE_ โ€” sets the VLV search base
  • --search-scope _SEARCH_SCOPE_ โ€” sets the VLV search scope: 0 (base search), 1 (one-level search), or 2 (subtree search)
  • --search-filter _SEARCH_FILTER_ โ€” sets the VLV search filter
  • --reindex โ€” re-indexes all the VLV database indexes. all of them. no survivors. ๐Ÿ”ฅ

usage: dsconf [-v] [-j] instance backend vlv-index del-search
       [-h] --name NAME be_name
  • be_name โ€” the backend name of the VLV index
  • --name _NAME_ โ€” sets the name of the VLV search index

๐Ÿ’€ COMMAND dsconf backend vlv-index add-index ๐Ÿ’€

usage: dsconf instance [-v] [-j] backend vlv-index add-index
       [-h] --parent-name PARENT_NAME --index-name INDEX_NAME --sort
SORT
       [--index-it]
       be_name
  • be_name โ€” the backend name of the VLV index

๐ŸŽ€ OPTIONS dsconf backend vlv-index add-index ๐ŸŽ€

  • --parent-name _PARENT_NAME_ โ€” sets the name, or the "cn" attribute, of the parent VLV search entry
  • --index-name _INDEX_NAME_ โ€” sets the name of the brand new VLV index
  • --sort _SORT_ โ€” sets a space-separated list of attributes to sort for this VLV index
  • --index-it โ€” actually creates the database index for this VLV index definition

โญ COMMAND dsconf backend vlv-index del-index โญ

usage: dsconf [-v] [-j] instance backend vlv-index del-index
       [-h] --parent-name PARENT_NAME [--index-name INDEX_NAME] [--sort
SORT]
       be_name
  • be_name โ€” the backend name of the VLV index

๐Ÿฆ‹ OPTIONS dsconf backend vlv-index del-index ๐Ÿฆ‹

  • --parent-name _PARENT_NAME_ โ€” sets the name, or the "cn" attribute value, of the parent VLV search entry
  • --index-name _INDEX_NAME_ โ€” sets the name of the VLV index to delete
  • --sort _SORT_ โ€” deletes a VLV index that has this vlvsort value

๐ŸŒŸ COMMAND dsconf backend vlv-index reindex ๐ŸŒŸ

usage: dsconf [-v] [-j] instance backend vlv-index reindex [-h]
                                                                  [--index-name
       INDEX_NAME]
                                                                  --parent-name
       PARENT_NAME
                                                                  be_name
  • be_name โ€” the backend name of the VLV index

๐Ÿ’– OPTIONS dsconf backend vlv-index reindex ๐Ÿ’–

  • --index-name _INDEX_NAME_ โ€” sets the name of the VLV index entry to re-index. If you don't set it, every index gets re-indexed
  • --parent-name _PARENT_NAME_ โ€” sets the name, or the "cn" attribute value, of the parent VLV search entry

๐Ÿ” COMMAND dsconf backend attr-encrypt ๐Ÿ”

usage: dsconf [-v] [-j] instance backend attr-encrypt [-h] [--list]
                                                             [--just-names]
                                                             [--add-attr
       ADD_ATTR]
                                                             [--del-attr
       DEL_ATTR]
                                                             be_name
  • be_name โ€” the backend name or suffix

๐Ÿ’… OPTIONS dsconf backend attr-encrypt ๐Ÿ’…

  • --list โ€” lists every encrypted attribute in the backend
  • --just-names โ€” when you use it with --list, it lists only the names of the encrypted attributes
  • --add-attr _ADD_ATTR_ โ€” turns on encryption for the attribute you specify
  • --del-attr _DEL_ATTR_ โ€” turns off encryption for the attribute you specify

๐Ÿ‘‘ COMMAND dsconf backend config ๐Ÿ‘‘

usage: dsconf [-v] [-j] instance backend config [-h] {get,set} ...

๐ŸŒธ POSITIONAL ARGUMENTS dsconf backend config ๐ŸŒธ

  • dsconf backend config get โ€” displays the global database configuration
  • dsconf backend config set โ€” sets the global database configuration

๐Ÿ“ COMMAND dsconf backend config get ๐Ÿ“

usage: dsconf [-v] [-j] instance backend config get [-h]

๐ŸŽ€ COMMAND dsconf backend config set ๐ŸŽ€

usage: dsconf [-v] [-j] instance backend config set [-h]
                                                           [--lookthroughlimit
       LOOKTHROUGHLIMIT]
                                                           [--mode MODE]
                                                           [--idlistscanlimit
       IDLISTSCANLIMIT]
                                                           [--directory
       DIRECTORY]
                                                           [--dbcachesize
       DBCACHESIZE]
                                                           [--logdirectory
       LOGDIRECTORY]
                                                           [--txn-wait
       TXN_WAIT]
                                                           [--checkpoint-interval
       CHECKPOINT_INTERVAL]
                                                           [--compactdb-interval
       COMPACTDB_INTERVAL]
                                                           [--compactdb-time
       COMPACTDB_TIME]
                                                           [--txn-batch-val
       TXN_BATCH_VAL]
                                                           [--txn-batch-min
       TXN_BATCH_MIN]
                                                           [--txn-batch-max
       TXN_BATCH_MAX]
                                                           [--logbufsize
       LOGBUFSIZE]
                                                           [--locks LOCKS]
                                                           [--locks-monitoring-enabled
       LOCKS_MONITORING_ENABLED]
                                                           [--locks-monitoring-threshold
       LOCKS_MONITORING_THRESHOLD]
                                                           [--locks-monitoring-pause
       LOCKS_MONITORING_PAUSE]
                                                           [--import-cache-autosize
       IMPORT_CACHE_AUTOSIZE]
                                                           [--cache-autosize
       CACHE_AUTOSIZE]
                                                           [--cache-autosize-split
       CACHE_AUTOSIZE_SPLIT]
                                                           [--import-cachesize
       IMPORT_CACHESIZE]
                                                           [--exclude-from-export
       EXCLUDE_FROM_EXPORT]
                                                           [--pagedlookthroughlimit
       PAGEDLOOKTHROUGHLIMIT]
                                                           [--pagedidlistscanlimit
       PAGEDIDLISTSCANLIMIT]
                                                           [--rangelookthroughlimit
       RANGELOOKTHROUGHLIMIT]
                                                           [--backend-opt-level
       BACKEND_OPT_LEVEL]
                                                           [--deadlock-policy
       DEADLOCK_POLICY]
                                                           [--db-home-directory
       DB_HOME_DIRECTORY]
                                                           [--db-lib DB_LIB]
                                                           [--mdb-max-size
       MDB_MAX_SIZE]
                                                           [--mdb-max-readers
       MDB_MAX_READERS]
                                                           [--mdb-max-dbs
       MDB_MAX_DBS]
                                                           [--enable-dynamic-lists]
                                                           [--disable-dynamic-lists]
                                                           [--dynamic-oc
       DYNAMIC_OC]
                                                           [--dynamic-url-attr
       DYNAMIC_URL_ATTR]
                                                           [--dynamic-list-attr
       DYNAMIC_LIST_ATTR]

Alright bestie, we're still in the config set menu and this is where the real database knobs live. Buckle up. ๐Ÿ’…

  • --lookthroughlimit LOOKTHROUGHLIMIT โ€” the max number of entries the server will actually check when it's out here examining candidate entries in response to a search request. It's giving "how hard am I allowed to look for you" energy.
  • --mode MODE โ€” the permissions that get slapped onto newly created index files.
  • --idlistscanlimit IDLISTSCANLIMIT โ€” how many entry IDs get searched during a search operation.
  • --directory DIRECTORY โ€” absolute path to the database instance. Absolute, bestie, not vibes-based relative nonsense.
  • --dbcachesize DBCACHESIZE โ€” the database index cache size, in bytes.
  • --logdirectory LOGDIRECTORY โ€” the path to the directory holding the database transaction logs.
  • --txn-wait TXN_WAIT โ€” sets whether the server should wait when there are no db locks available.
  • --checkpoint-interval CHECKPOINT_INTERVAL โ€” how much time, in seconds, before the server sends a checkpoint entry to the database transaction log.
  • --compactdb-interval COMPACTDB_INTERVAL โ€” the interval in seconds when the database gets compacted.
  • --compactdb-time COMPACTDB_TIME โ€” the actual time of day (HH:MM format) when the database should be compacted, but only after the "compactdb interval" has been reached.
  • --txn-batch-val TXN_BATCH_VAL โ€” how many transactions will be batched up before being committed.
  • --txn-batch-min TXN_BATCH_MIN โ€” controls when transactions should be flushed earliest, independent of the batch count. Requires that txn-batch-val is set. No txn-batch-val, no party.
  • --txn-batch-max TXN_BATCH_MAX โ€” controls when transactions should be flushed latest, independent of the batch count. Also requires that txn-batch-val is set.
  • --logbufsize LOGBUFSIZE โ€” the transaction log information buffer size.
  • --locks LOCKS โ€” the maximum number of database locks.
  • --locks-monitoring-enabled LOCKS_MONITORING_ENABLED โ€” turns monitoring of DB locks on or off, triggered when the value crosses the percentage set with "--locks-monitoring-threshold".
  • --locks-monitoring-threshold LOCKS_MONITORING_THRESHOLD โ€” the DB lock exhaustion threshold as a percentage (valid range is 70-90 ๐Ÿซฃ). Once that threshold is hit, all searches get aborted until the number of active locks drops below the configured threshold and/or the administrator increases the number of database locks (nsslapd-db-locks). This threshold is literally a safeguard against DB corruption that locks exhaustion could cause. Respect it.
  • --locks-monitoring-pause LOCKS_MONITORING_PAUSE โ€” the DB lock monitoring value in milliseconds for how long the monitoring thread sits there waiting between checks.
  • --import-cache-autosize IMPORT_CACHE_AUTOSIZE โ€” enables or disables automatically setting the size of the import cache used during the import process of LDIF files.
  • --cache-autosize CACHE_AUTOSIZE โ€” the percentage of free memory used in total for the database and entry cache.
  • --cache-autosize-split CACHE_AUTOSIZE_SPLIT โ€” the percentage of RAM used for the database cache. Whatever's left over goes to the entry cache. Splitting the bag, basically.
  • --import-cachesize IMPORT_CACHESIZE โ€” the size in bytes of the database cache used in the import process.
  • --exclude-from-export EXCLUDE_FROM_EXPORT โ€” a list of attributes to not include during database export operations. Bye ๐Ÿ‘‹
  • --pagedlookthroughlimit PAGEDLOOKTHROUGHLIMIT โ€” the max number of entries the server will check when examining candidate entries for a search that uses the simple paged results control.
  • --pagedidlistscanlimit PAGEDIDLISTSCANLIMIT โ€” the number of entry IDs that get searched, specifically for a search operation using the simple paged results control.
  • --rangelookthroughlimit RANGELOOKTHROUGHLIMIT โ€” the max number of entries the server will check when examining candidate entries in response to a range search request.
  • --backend-opt-level BACKEND_OPT_LEVEL โ€” sets the backend optimization level for write performance (0, 1, 2, or 4).
โš ๏ธ WARNING: This parameter can trigger experimental code. Fr fr, tread carefully.
  • --deadlock-policy DEADLOCK_POLICY โ€” adjusts the backend database deadlock policy. (Advanced setting ๐Ÿ‘‘)
  • --db-home-directory DB_HOME_DIRECTORY โ€” the directory for the database mmapped files. (Advanced setting ๐Ÿ‘‘)
  • --db-lib DB_LIB โ€” which db lib is used. Valid values are: bdb or mdb.
  • --mdb-max-size MDB_MAX_SIZE โ€” the lmdb database maximum size (accepts bytes, or with a unit suffix: k, m, g, t).
  • --mdb-max-readers MDB_MAX_READERS โ€” the lmdb database maximum number of readers. (Advanced setting ๐Ÿ‘‘)
  • --mdb-max-dbs MDB_MAX_DBS โ€” the lmdb database maximum number of sub databases. (Advanced setting ๐Ÿ‘‘)
  • --enable-dynamic-lists โ€” enables dynamic lists โœจ
  • --disable-dynamic-lists โ€” disables dynamic lists ๐Ÿ’€
  • --dynamic-oc DYNAMIC_OC โ€” sets the objectclass for dynamic lists.
  • --dynamic-url-attr DYNAMIC_URL_ATTR โ€” sets the url attribute for dynamic lists.
  • --dynamic-list-attr DYNAMIC_LIST_ATTR โ€” sets the list attribute for dynamic lists.

๐Ÿฆ‹ COMMAND 'dsconf backend monitor'

usage: dsconf [-v] [-j] instance backend monitor [-h] [--suffix SUFFIX]

๐ŸŒธ OPTIONS 'dsconf backend monitor'

  • --suffix SUFFIX โ€” displays monitoring information only for the suffix you name. One suffix, no chaos.

๐ŸŽ€ COMMAND 'dsconf backend import'

usage: dsconf [-v] [-j] instance backend import [-h] [-c CHUNKS_SIZE] [-E]
                                              [-g GEN_UNIQ_ID] [-O]
                                              [-s INCLUDE_SUFFIXES [INCLUDE_SUFFIXES ...]]
                                              [-x EXCLUDE_SUFFIXES [EXCLUDE_SUFFIXES ...]]
                                              [--timeout TIMEOUT] [-w]
                                              [be_name] [ldifs ...]

๐Ÿ’– POSITIONAL ARGUMENTS 'dsconf backend import'

  • be_name โ€” the backend name or the root suffix.
  • ldifs โ€” the filename(s) of the input LDIF files. Multiple files get imported in the order you specified them, so order matters bestie.

โœจ OPTIONS 'dsconf backend import'

  • -c CHUNKS_SIZE, --chunks-size CHUNKS_SIZE โ€” the number of chunks to have during the import operation.
  • -E, --encrypted โ€” encrypt attributes configured in the database for encryption.
  • -g GEN_UNIQ_ID, --gen-uniq-id GEN_UNIQ_ID โ€” generate a unique id. Set "none" for no unique ID to be generated, and "deterministic" for the generated unique ID to be name-based. By default, a time-based unique ID is generated. When you use the deterministic generation to get a name-based unique ID, you can also specify the namespace for the server to use. namespaceId is a string of characters in the format 00-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx.
  • -O, --only-core โ€” creates only the core database attribute indexes.
  • -s INCLUDE_SUFFIXES [INCLUDE_SUFFIXES ...], --include-suffixes INCLUDE_SUFFIXES [INCLUDE_SUFFIXES ...] โ€” the suffixes or the subtrees to be included.
  • -x EXCLUDE_SUFFIXES [EXCLUDE_SUFFIXES ...], --exclude-suffixes EXCLUDE_SUFFIXES [EXCLUDE_SUFFIXES ...] โ€” the suffixes to be excluded.
  • --timeout TIMEOUT โ€” set a timeout to wait for the export task. Default is 0 (no timeout).
  • -w, --watch โ€” watch the status of the import. Live updates, main character energy ๐Ÿ”ฅ

๐ŸŒˆ COMMAND 'dsconf backend export'

usage: dsconf [-v] [-j] instance backend export [-h] [-l LDIF] [-C] [-E] [-m]
                                              [-N] [-r] [-u] [-U]
                                              [-s INCLUDE_SUFFIXES [INCLUDE_SUFFIXES ...]]
                                              [-x EXCLUDE_SUFFIXES [EXCLUDE_SUFFIXES ...]]
                                              [--timeout TIMEOUT] [-w]
                                              be_names [be_names ...]

๐Ÿซถ POSITIONAL ARGUMENTS 'dsconf backend export'

  • be_names โ€” the backend names or the root suffixes. Yes, plural, you can pile them on.

๐Ÿ“ OPTIONS 'dsconf backend export'

  • -l LDIF, --ldif LDIF โ€” the filename of the output LDIF file. Separate multiple file names with spaces.
  • -C, --use-id2entry โ€” uses only the main database file.
  • -E, --encrypted โ€” decrypts encrypted data during export. This option is used only if database encryption is enabled.
  • -m, --min-base64 โ€” sets minimal base-64 encoding.
  • -N, --no-seq-num โ€” suppresses printing the sequence numbers.
  • -r, --replication โ€” exports the data with the information required to initialize a replica.
  • -u, --no-dump-uniq-id โ€” omits exporting the unique ID.
  • -U, --not-folded โ€” disables folding the output.
  • -s INCLUDE_SUFFIXES [INCLUDE_SUFFIXES ...], --include-suffixes INCLUDE_SUFFIXES [INCLUDE_SUFFIXES ...] โ€” the suffixes or the subtrees to be included.
  • -x EXCLUDE_SUFFIXES [EXCLUDE_SUFFIXES ...], --exclude-suffixes EXCLUDE_SUFFIXES [EXCLUDE_SUFFIXES ...] โ€” the suffixes to be excluded.
  • --timeout TIMEOUT โ€” set a timeout to wait for the export task. Default is 0 (no timeout).
  • -w, --watch โ€” watch the status of the export ๐Ÿ‘€

๐Ÿ’œ COMMAND 'dsconf backend create'

usage: dsconf [-v] [-j] instance backend create [-h]
                                              [--parent-suffix PARENT_SUFFIX]
                                              --suffix SUFFIX
                                              --be-name BE_NAME
                                              [--create-entries]
                                              [--create-suffix]

๐Ÿ‘‘ OPTIONS 'dsconf backend create'

  • --parent-suffix PARENT_SUFFIX โ€” sets the parent suffix, but only if this backend is a sub-suffix.
  • --suffix SUFFIX โ€” sets the database suffix DN.
  • --be-name BE_NAME โ€” sets the database backend name.
  • --create-entries โ€” adds sample entries to the database.
  • --create-suffix โ€” creates the suffix object entry in the database. Only suffixes using the 'dc',

๐Ÿ’€ COMMAND 'dsconf backend delete'

usage: dsconf [-v] [-j] instance backend delete [-h] [--do-it] be_name

๐ŸŒŸ POSITIONAL ARGUMENTS 'dsconf backend delete'

  • be_name โ€” the backend name or suffix.

๐Ÿ˜ญ OPTIONS 'dsconf backend delete'

  • --do-it โ€” remove backend and its subsuffixes. Yeah it's really happening, no take-backs.

โญ COMMAND 'dsconf backend get-tree'

usage: dsconf [-v] [-j] instance backend get-tree [-h]

๐Ÿ’… COMMAND 'dsconf backend compact-db' ๐Ÿ’…

okay so you wanna squash that database into a lil compact lil guy, no cap. Here's the vibe:

usage: dsconf [-v] [-j] instance backend compact-db [-h]
              [--only-changelog]
              [--timeout TIMEOUT]

โœจ OPTIONS 'dsconf backend compact-db' โœจ

  • --only-changelog โ€” bestie this one compacts only the replication change log. That's it, that's the whole job ๐Ÿ’–
  • --timeout TIMEOUT โ€” sets a timeout to wait for the compaction task. Default is 0 aka no timeout โ€” she'll wait forever, devoted gf energy ๐Ÿซถ

๐ŸŒˆ COMMAND 'dsconf backup' ๐ŸŒˆ

the backup mothership. She doesn't do anything herself, she just has two iconic children:

usage: dsconf [-v] [-j] instance backup [-h] {create,restore} ...

๐ŸŽ€ POSITIONAL ARGUMENTS 'dsconf backup' ๐ŸŽ€

  • dsconf backup create โ€” creates a backup of the database ๐Ÿ“ฆโœจ
  • dsconf backup restore โ€” restores a database from a backup ๐Ÿช„ back from the dead, literally

๐Ÿ”ฅ COMMAND 'dsconf backup create' ๐Ÿ”ฅ

usage: dsconf [-v] [-j] instance backup create [-h] [-t DB_TYPE]
              [--timeout TIMEOUT] [--watch]
              [archive]
  • archive โ€” sets the directory where to store the backup files. The format for these is instance_name-year_month_date_hour_minutes_seconds. Default: /var/lib/dirsrv/slapd-instance/bak/ โ€” classic, timeless, we stan ๐ŸŽ€

โœจ OPTIONS 'dsconf backup create' โœจ

  • -t DB_TYPE, --db-type DB_TYPE โ€” sets the database type. Default: ldbm database ๐Ÿ’…
  • --timeout TIMEOUT โ€” sets the task timeout. Default is 120 seconds ๐Ÿ’€
  • --watch โ€” watch the status of the backup task like it's your comfort show ๐Ÿ‘€๐Ÿฟ

๐Ÿฆ‹ COMMAND 'dsconf backup restore' ๐Ÿฆ‹

usage: dsconf [-v] [-j] instance backup restore [-h] [-t DB_TYPE]
              [--timeout TIMEOUT] [--watch]
              archive
  • archive โ€” set the directory that contains the backup files (note: this one is required bestie, no skipping it ๐Ÿ™ˆ)

โœจ OPTIONS 'dsconf backup restore' โœจ

  • -t DB_TYPE, --db-type DB_TYPE โ€” sets the database type. Default: ldbm database ๐Ÿ’…
  • --timeout TIMEOUT โ€” sets the task timeout. Default is 120 seconds ๐Ÿ’€
  • --watch โ€” watch the status of the restore task, live, in real time, main character energy ๐Ÿ‘‘

๐ŸŒธ COMMAND 'dsconf chaining' ๐ŸŒธ

chaining!! this is where one server goes "hey bestie can u handle this for me" and forwards the request along. iconic behaviour, very group-chat of it honestly ๐Ÿ’ฌโœจ

usage: dsconf [-v] [-j] instance chaining [-h]
              {config-get,config-set,config-get-def,config-set-def,link-create,
              link-get,link-set,link-delete,monitor,link-list}
              ...

๐ŸŽ€ POSITIONAL ARGUMENTS 'dsconf chaining' ๐ŸŽ€

  • dsconf chaining config-get โ€” display the chaining controls and server component lists ๐Ÿ‘€
  • dsconf chaining config-set โ€” set the chaining controls and server component lists โœ๏ธ
  • dsconf chaining config-get-def โ€” display the default creation parameters for new database links ๐ŸŒฑ
  • dsconf chaining config-set-def โ€” set the default creation parameters for new database links ๐Ÿ”ง
  • dsconf chaining link-create โ€” create a database link to a remote server ๐Ÿ”—
  • dsconf chaining link-get โ€” displays chaining database links ๐Ÿ‘๏ธ
  • dsconf chaining link-set โ€” edit a database link to a remote server ๐Ÿ“
  • dsconf chaining link-delete โ€” delete a database link ๐Ÿ—‘๏ธ (so long, farewell)
  • dsconf chaining monitor โ€” display monitor information for a database chaining link ๐Ÿ“Š
  • dsconf chaining link-list โ€” list database links ๐Ÿ“‹

๐Ÿ’œ COMMAND 'dsconf chaining config-get' ๐Ÿ’œ

usage: dsconf [-v] [-j] instance chaining config-get [-h]
              [--avail-controls]
              [--avail-comps]

โœจ OPTIONS 'dsconf chaining config-get' โœจ

  • --avail-controls โ€” lists available chaining controls ๐ŸŽ›๏ธ
  • --avail-comps โ€” lists available chaining plugin components ๐Ÿงฉ

โญ COMMAND 'dsconf chaining config-set' โญ

usage: dsconf [-v] [-j] instance chaining config-set [-h]
              [--add-control ADD_CONTROL]
              [--del-control DEL_CONTROL]
              [--add-comp ADD_COMP]
              [--del-comp DEL_COMP]

โœจ OPTIONS 'dsconf chaining config-set' โœจ

  • --add-control ADD_CONTROL โ€” adds a transmitted control OID โž•
  • --del-control DEL_CONTROL โ€” deletes a transmitted control OID โž–
  • --add-comp ADD_COMP โ€” adds a chaining component ๐Ÿงฉโž•
  • --del-comp DEL_COMP โ€” deletes a chaining component ๐Ÿงฉโž–

๐Ÿ“ COMMAND 'dsconf chaining config-get-def' ๐Ÿ“

usage: dsconf [-v] [-j] instance chaining config-get-def [-h]

that's it. no options. she just tells u the defaults, slay, unproblematic queen ๐Ÿ’–


๐ŸŒˆ COMMAND 'dsconf chaining config-set-def' ๐ŸŒˆ

okay so THIS one is the big one. Eighteen options. Eighteen. She said "let me cook" and then cooked a whole five-course meal ๐Ÿ”ฅ๐Ÿ‘‘

usage: dsconf [-v] [-j] instance chaining config-set-def [-h]
              [--conn-bind-limit CONN_BIND_LIMIT]
              [--conn-op-limit CONN_OP_LIMIT]
              [--abandon-check-interval ABANDON_CHECK_INTERVAL]
              [--bind-limit BIND_LIMIT]
              [--op-limit OP_LIMIT]
              [--proxied-auth PROXIED_AUTH]
              [--conn-lifetime CONN_LIFETIME]
              [--bind-timeout BIND_TIMEOUT]
              [--return-ref RETURN_REF]
              [--check-aci CHECK_ACI]
              [--bind-attempts BIND_ATTEMPTS]
              [--size-limit SIZE_LIMIT]
              [--time-limit TIME_LIMIT]
              [--hop-limit HOP_LIMIT]
              [--response-delay RESPONSE_DELAY]
              [--test-response-delay TEST_RESPONSE_DELAY]
              [--use-starttls USE_STARTTLS]

โœจ OPTIONS 'dsconf chaining config-set-def' โœจ

  • --conn-bind-limit CONN_BIND_LIMIT โ€” sets the max number of BIND connections the database link establishes with the remote server ๐Ÿค
  • --conn-op-limit CONN_OP_LIMIT โ€” sets the max number of LDAP connections the database link establishes with the remote server ๐Ÿ”Œ
  • --abandon-check-interval ABANDON_CHECK_INTERVAL โ€” sets the number of seconds that pass before the server checks for abandoned operations โฑ๏ธ (checking on the ops that ghosted u, so real)
  • --bind-limit BIND_LIMIT โ€” sets the max number of concurrent bind operations per TCP connection ๐Ÿšฆ
  • --op-limit OP_LIMIT โ€” sets the max number of concurrent operations allowed ๐Ÿšง
  • --proxied-auth PROXIED_AUTH โ€” enables or disables proxied authorization. If it's set to "off", the server executes bind for chained operations as the user set in the nsMultiplexorBindDn attribute ๐ŸŽญ
  • --conn-lifetime CONN_LIFETIME โ€” specifies connection lifetime in seconds. "0" keeps the connection open forever โ€” committed, ride or die ๐Ÿ’ž
  • --bind-timeout BIND_TIMEOUT โ€” sets the amount of time in seconds before a bind attempt times out โณ
  • --return-ref RETURN_REF โ€” enables or disables whether referrals are returned by scoped searches โ†ฉ๏ธ
  • --check-aci CHECK_ACI โ€” enables or disables whether the server evaluates ACIs on the database link as well as the remote data server ๐Ÿ”
  • --bind-attempts BIND_ATTEMPTS โ€” sets the number of times the server tries to bind to the remote server ๐Ÿ” (persistence!!)
  • --size-limit SIZE_LIMIT โ€” sets the max number of entries to return from a search operation ๐Ÿ“
  • --time-limit TIME_LIMIT โ€” sets the max number of seconds allowed for an operation โŒ›
  • --hop-limit HOP_LIMIT โ€” sets the max number of times a database is allowed to chain. That is the number of times a request can be forwarded from one database link to another ๐Ÿ‡๐Ÿ‡ (hop hop hop, then stop)
  • --response-delay RESPONSE_DELAY โ€” sets the max amount of time it can take a remote server to respond to an LDAP operation request made by a database link before an error is suspected ๐Ÿ˜ฌ
  • --test-response-delay TEST_RESPONSE_DELAY โ€” sets the duration of the test issued by the database link to check whether the remote server is responding ๐Ÿฉบ ("u up?")
  • --use-starttls USE_STARTTLS โ€” configured that database links use StartTLS if set to "on" ๐Ÿ”’โœจ

making a brand new database link to a remote server. It's giving long-distance relationship but make it LDAP ๐Ÿ’Œ

usage: dsconf instance [-v] [-j] chaining link-create [-h]
                       [--conn-bind-limit CONN_BIND_LIMIT]
                       [--conn-op-limit CONN_OP_LIMIT]
                       [--abandon-check-interval ABANDON_CHECK_INTERVAL]
                       [--bind-limit BIND_LIMIT]
                       [--op-limit OP_LIMIT]
                       [--proxied-auth PROXIED_AUTH]
                       [--conn-lifetime CONN_LIFETIME]
                       [--bind-timeout BIND_TIMEOUT]
                       [--return-ref RETURN_REF]
                       [--check-aci CHECK_ACI]
                       [--bind-attempts BIND_ATTEMPTS]
                       [--size-limit SIZE_LIMIT]
                       [--time-limit TIME_LIMIT]
                       [--hop-limit HOP_LIMIT]
                       [--response-delay RESPONSE_DELAY]
                       [--test-response-delay TEST_RESPONSE_DELAY]
                       [--use-starttls USE_STARTTLS]
                       --suffix SUFFIX
                       --server-url SERVER_URL
                       --bind-mech BIND_MECH
                       --bind-dn BIND_DN
                       [--bind-pw BIND_PW]
                       [--bind-pw-file BIND_PW_FILE]
                       [--bind-pw-prompt]
                       CHAIN_NAME
  • CHAIN_NAME โ€” the name of the database link ๐Ÿท๏ธโœจ

bestie we are SO deep in the chaining rabbit hole rn and honestly? iconic. here's every dial you can turn when you're creating a link ๐Ÿ’…

  • --conn-bind-limit CONN_BIND_LIMIT โ€” caps how many BIND connections the database link is allowed to open up with the remote server. it's giving "know your limits" ๐ŸŽ€
  • --conn-op-limit CONN_OP_LIMIT โ€” same energy but for LDAP connections: the max number the database link establishes with the remote server.
  • --abandon-check-interval ABANDON_CHECK_INTERVAL โ€” how many seconds go by before the server peeks around for abandoned operations. like checking the group chat for messages nobody replied to ๐Ÿ™ˆ
  • --bind-limit BIND_LIMIT โ€” the max number of concurrent bind operations allowed per TCP connection. concurrency queen ๐Ÿ‘‘
  • --op-limit OP_LIMIT โ€” the max number of concurrent operations allowed, periodt.
  • --proxied-auth PROXIED_AUTH โ€” turns proxied authorization on or off. if you set it to "off", the server runs the bind for chained operations as the user set in the nsMultiplexorBindDn attribute. iykyk โœจ
  • --conn-lifetime CONN_LIFETIME โ€” connection lifetime in seconds. set it to "0" and the connection stays open forever, no cap, main character energy fr fr.
  • --bind-timeout BIND_TIMEOUT โ€” how many seconds the server waits before a bind attempt times out. we do not wait around here โฐ
  • --return-ref RETURN_REF โ€” toggles whether referrals get returned by scoped searches.
  • --check-aci CHECK_ACI โ€” toggles whether the server evaluates ACIs on the database link and on the remote data server. double the checks, double the slay ๐Ÿฆ‹
  • --bind-attempts BIND_ATTEMPTS โ€” how many times the server tries to bind to the remote server. resilience bestie ๐Ÿ’–
  • --size-limit SIZE_LIMIT โ€” the max number of entries a search operation hands back.
  • --time-limit TIME_LIMIT โ€” the max number of seconds an operation is allowed to take.
  • --hop-limit HOP_LIMIT โ€” the max number of times a database is allowed to chain. as in, how many times a request can get forwarded from one database link to another. hops on hops on hops ๐Ÿ‡
  • --response-delay RESPONSE_DELAY โ€” the max amount of time a remote server can take to respond to an LDAP operation request made by a database link before the server starts suspecting an error. ghosting is not tolerated ๐Ÿ’€
  • --test-response-delay TEST_RESPONSE_DELAY โ€” how long the test the database link sends out lasts, the one checking whether the remote server is even responding. are you there?? ๐Ÿ‘€
  • --use-starttls USE_STARTTLS โ€” configures the database links to use StartTLS when set to "on".
  • --suffix SUFFIX โ€” sets the suffix the database link manages.
  • --server-url SERVER_URL โ€” the LDAP/LDAPS URL pointing at the remote server.
  • --bind-mech BIND_MECH โ€” which authentication method to use against the remote server. valid values: "SIMPLE" (default), "EXTERNAL", "DIGEST-MD5", or "GSSAPI". pick your fighter ๐Ÿ”ฅ
  • --bind-dn BIND_DN โ€” the DN of the administrative entry used to talk to the remote server.
  • --bind-pw BIND_PW โ€” the password of that administrative user. keep it secret, keep it safe ๐Ÿซถ
  • --bind-pw-file BIND_PW_FILE โ€” file containing the password.
  • --bind-pw-prompt โ€” prompt for the password instead.

usage: dsconf [-v] [-j] instance chaining link-get [-h] CHAIN_NAME

CHAIN_NAME the chaining link name or suffix you want to retrieve. yes, either one works, we love options ๐Ÿ’–


this one is a long synopsis bestie, brace yourself, every flag from link-create shows up again because it's the setter:

usage: dsconf instance [-v] [-j] chaining link-set [-h]
                                                          [--conn-bind-limit
       CONN_BIND_LIMIT]
                                                          [--conn-op-limit
       CONN_OP_LIMIT]
                                                          [--abandon-check-interval
       ABANDON_CHECK_INTERVAL]
                                                          [--bind-limit
       BIND_LIMIT]
                                                          [--op-limit OP_LIMIT]
                                                          [--proxied-auth
       PROXIED_AUTH]
                                                          [--conn-lifetime
       CONN_LIFETIME]
                                                          [--bind-timeout
       BIND_TIMEOUT]
                                                          [--return-ref
       RETURN_REF]
                                                          [--check-aci
       CHECK_ACI]
                                                          [--bind-attempts
       BIND_ATTEMPTS]
                                                          [--size-limit
       SIZE_LIMIT]
                                                          [--time-limit
       TIME_LIMIT]
                                                          [--hop-limit
       HOP_LIMIT]
                                                          [--response-delay
       RESPONSE_DELAY]
                                                          [--test-response-delay
       TEST_RESPONSE_DELAY]
                                                          [--use-starttls
       USE_STARTTLS]
                                                          [--suffix SUFFIX]
                                                          [--server-url
       SERVER_URL]
                                                          [--bind-mech
       BIND_MECH]
                                                          [--bind-dn BIND_DN]
                                                          [--bind-pw BIND_PW]
                                                          [--bind-pw-file
       BIND_PW_FILE]
                                                          [--bind-pw-prompt]
                                                          CHAIN_NAME

CHAIN_NAME the name of the database link. that's it, that's the whole thing ๐ŸŽ€


same squad as link-create, but now we're editing an existing link. glow-up time ๐Ÿ’…

  • --conn-bind-limit CONN_BIND_LIMIT โ€” the max number of BIND connections the database link establishes with the remote server.
  • --conn-op-limit CONN_OP_LIMIT โ€” the max number of LDAP connections the database link establishes with the remote server.
  • --abandon-check-interval ABANDON_CHECK_INTERVAL โ€” how many seconds pass before the server checks for abandoned operations.
  • --bind-limit BIND_LIMIT โ€” the max number of concurrent bind operations per TCP connection.
  • --op-limit OP_LIMIT โ€” the max number of concurrent operations allowed.
  • --proxied-auth PROXIED_AUTH โ€” enables or disables proxied authorization. if it's set to "off", the server executes bind for chained operations as the user set in the nsMultiplexorBindDn attribute.
  • --conn-lifetime CONN_LIFETIME โ€” connection lifetime in seconds. "0" keeps the connection open forever.
  • --bind-timeout BIND_TIMEOUT โ€” the amount of time in seconds before a bind attempt times out.
  • --return-ref RETURN_REF โ€” enables or disables whether referrals are returned by scoped searches.
  • --check-aci CHECK_ACI โ€” enables or disables whether the server evaluates ACIs on the database link as well as the remote data server.
  • --bind-attempts BIND_ATTEMPTS โ€” the number of times the server tries to bind to the remote server.
  • --size-limit SIZE_LIMIT โ€” the max number of entries to return from a search operation.
  • --time-limit TIME_LIMIT โ€” the max number of seconds allowed for an operation.
  • --hop-limit HOP_LIMIT โ€” the max number of times a database is allowed to chain. that is, the number of times a request can be forwarded from one database link to another.
  • --response-delay RESPONSE_DELAY โ€” the max amount of time it can take a remote server to respond to an LDAP operation request made by a database link before an error is suspected.
  • --test-response-delay TEST_RESPONSE_DELAY โ€” the duration of the test issued by the database link to check whether the remote server is responding.
  • --use-starttls USE_STARTTLS โ€” configured that database links use StartTLS if set to "on".
  • --suffix SUFFIX โ€” sets the suffix managed by the database link.
  • --server-url SERVER_URL โ€” sets the LDAP/LDAPS URL to the remote server.
  • --bind-mech BIND_MECH โ€” sets the authentication method to use to authenticate to the remote server: valid values: "SIMPLE" (default), "EXTERNAL", "DIGEST-MD5", or "GSSAPI".
  • --bind-dn BIND_DN โ€” sets the DN of the administrative entry used to communicate with the remote server.
  • --bind-pw BIND_PW โ€” sets the password of the administrative user.
  • --bind-pw-file BIND_PW_FILE โ€” file containing the password.
  • --bind-pw-prompt โ€” prompt for password.

usage: dsconf [-v] [-j] instance chaining link-delete [-h] CHAIN_NAME

CHAIN_NAME the name of the database link. bye bestie ๐Ÿ‘‹


COMMAND โ€” dsconf chaining monitor ๐Ÿ‘€

usage: dsconf [-v] [-j] instance chaining monitor [-h] CHAIN_NAME

CHAIN_NAME the name of the database link. we're just watching it live its life ๐Ÿฆ‹


usage: dsconf [-v] [-j] instance chaining link-list [-h]

no args, no drama, just the list. we love a low-effort icon ๐Ÿ’–


COMMAND โ€” dsconf config โš™๏ธ

usage: dsconf [-v] [-j] instance config [-h] {get,add,replace,delete}
       ...

POSITIONAL ARGUMENTS โ€” dsconf config ๐ŸŽ€

  • dsconf config get โ€” get
  • dsconf config add โ€” Add attribute value to configuration
  • dsconf config replace โ€” Replace attribute value in configuration
  • dsconf config delete โ€” Delete attribute value in configuration

COMMAND โ€” dsconf config get ๐Ÿ”

usage: dsconf [-v] [-j] instance config get [-h] [attrs ...]

attrs Configuration attribute(s) to get. plural friendly, bring as many as you want โœจ


COMMAND โ€” dsconf config add โž•

usage: dsconf [-v] [-j] instance config add [-h] [attr ...]

attr Configuration attribute to add.


COMMAND โ€” dsconf config replace ๐Ÿ”

usage: dsconf [-v] [-j] instance config replace [-h] [attr ...]

attr Configuration attribute to replace.


COMMAND โ€” dsconf config delete ๐Ÿšฎ

usage: dsconf [-v] [-j] instance config delete [-h] [attr ...]

attr Configuration attribute to delete.


COMMAND โ€” dsconf directory_manager ๐Ÿ‘‘

usage: dsconf [-v] [-j] instance directory_manager [-h]
{password_change} ...

POSITIONAL ARGUMENTS โ€” dsconf directory_manager ๐Ÿ’œ

  • dsconf directory_manager password_change โ€” Changes the password of the Directory Manager account

COMMAND โ€” dsconf directory_manager password_change ๐Ÿ”

usage: dsconf [-v] [-j] instance directory_manager password_change [-h]

that's the whole synopsis, no extra args. short and powerful, like all the best people ๐Ÿ’…


COMMAND โ€” dsconf logging ๐Ÿ“

usage: dsconf [-v] [-j] instance logging [-h]
                                      {access,audit,auditfail,error,security}
       ...

๐Ÿ’… POSITIONAL ARGUMENTS 'dsconf logging'

Bestie, dsconf logging is the โœจumbrellaโœจ and under it you've got five whole flavor options. Pick your fighter:

  • dsconf logging access โ€” Manage access log settings ๐Ÿ”ฅ
  • dsconf logging audit โ€” Manage audit log settings ๐Ÿ“
  • dsconf logging auditfail โ€” Manage auditfail log settings ๐Ÿ’€
  • dsconf logging error โ€” Manage error log settings ๐Ÿšจ
  • dsconf logging security โ€” Manage security log settings ๐Ÿ”

๐ŸŒธ COMMAND 'dsconf logging access'

Okay so this is the access log. Every time somebody touches your directory, this is the log that's like "noted ๐Ÿ“ธ". Here's the shape of it:

usage: dsconf [-v] [-j] instance logging access [-h] {get,set,list-levels} ...

So you get three moves: get, set, list-levels.


๐ŸŽ€ POSITIONAL ARGUMENTS 'dsconf logging access'

Pick one, bestie:

  • dsconf logging access get โ€” Get access log configuration ๐Ÿ‘€
  • dsconf logging access set โ€” Set access log configuration โœ๏ธ
  • dsconf logging access list-levels โ€” List all the log levels ๐Ÿ“‹

๐Ÿ’– COMMAND 'dsconf logging access get'

Reading the config, no notes, just vibes:

usage: dsconf [-v] [-j] instance logging access get [-h]

๐Ÿฆ‹ COMMAND 'dsconf logging access set'

This is the main character right here. Look at ALL these options โ€” she's giving menu, she's giving buffet, she's giving infinite scroll:

usage: dsconf [-v] [-j] instance logging access set [-h]
                                                   {level,logging-enabled,logging-disabled,mode,location,compress-enabled,compress-disabled,buffering-enabled,buffering-disabled,max-logs,max-logsize,rotation-interval,rotation-interval-unit,rotation-tod-enabled,rotation-tod-disabled,rotation-tod-hour,rotation-tod-minute,deletion-interval,deletion-interval-unit,max-disk-space,free-disk-space,log-format,time-format}
       ...

๐ŸŒˆ POSITIONAL ARGUMENTS 'dsconf logging access set'

Take your pick, queen:

  • dsconf logging access set level โ€” Set the log level ๐ŸŽš๏ธ
  • dsconf logging access set logging-enabled โ€” Enable access logging โœ…
  • dsconf logging access set logging-disabled โ€” Disable access logging ๐Ÿšซ
  • dsconf logging access set mode โ€” Set the log file permissions. Default is 600 ๐Ÿ”’
  • dsconf logging access set location โ€” Set the log name and location ๐Ÿ“
  • dsconf logging access set compress-enabled โ€” Enable log compression for rotated logs ๐Ÿ—œ๏ธ
  • dsconf logging access set compress-disabled โ€” Disable log compression for rotated logs ๐Ÿ“‚
  • dsconf logging access set buffering-enabled โ€” Enable log buffering ๐Ÿงบ
  • dsconf logging access set buffering-disabled โ€” Disable log buffering ๐Ÿชฃ
  • dsconf logging access set max-logs โ€” Set the maximum number of rotated logs the server will maintain ๐Ÿ”ข
  • dsconf logging access set max-logsize โ€” Set the maximum size for a log in MB ๐Ÿ“
  • dsconf logging access set rotation-interval โ€” Set the interval for when a log is rotated. This works with the interval unit โฐ
  • dsconf logging access set rotation-interval-unit โ€” Set the time unit for the rotation interval for when a log is rotated. Choose between: "minute", "hour", "day", "week", and "month" ๐Ÿ•ฐ๏ธ
  • dsconf logging access set rotation-tod-enabled โ€” Enable "time of day" rotation for expired logs ๐ŸŒ…
  • dsconf logging access set rotation-tod-disabled โ€” Disable "time of day" rotation for expired logs ๐ŸŒ™
  • dsconf logging access set rotation-tod-hour โ€” Set the hour when an expired log should be rotated ๐Ÿ•
  • dsconf logging access set rotation-tod-minute โ€” Set the minute when an expired log should be rotated ๐Ÿ•‘
  • dsconf logging access set deletion-interval โ€” Set the interval a rotated log should be deleted. This works with the deletion internal unit setting ๐Ÿ—‘๏ธ
  • dsconf logging access set deletion-interval-unit โ€” Set the interval unit a rotated log should be deleted. Choose from: "day", "week", or "month" ๐Ÿ“…
  • dsconf logging access set max-disk-space โ€” Set the maximum amount of disk space in MB rotated logs can consume before rotated logs are deleted. ๐Ÿ’พ
  • dsconf logging access set free-disk-space โ€” The server deletes the oldest rotated log file when the available disk space in MB is less than this amount. ๐Ÿ†“
  • dsconf logging access set log-format โ€” Choose between "default", "json", or "json-pretty" ๐ŸŽจ
  • dsconf logging access set time-format โ€” Time format for JSON logging (strftime) โŒš

โญ COMMAND 'dsconf logging access set level'

usage: dsconf [-v] [-j] instance logging access set level [-h] levels [levels ...]
  • levels โ€” log level ๐ŸŽš๏ธ

๐Ÿ’œ COMMAND 'dsconf logging access set logging-enabled'

usage: dsconf [-v] [-j] instance logging access set logging-enabled [-h]

๐Ÿ“ COMMAND 'dsconf logging access set logging-disabled'

usage: dsconf [-v] [-j] instance logging access set logging-disabled [-h]

๐Ÿงš COMMAND 'dsconf logging access set mode'

usage: dsconf [-v] [-j] instance logging access set mode [-h] values
  • values โ€” File permissions. Default is 600 ๐Ÿ”

๐ŸŒธ COMMAND 'dsconf logging access set location'

usage: dsconf [-v] [-j] instance logging access set location [-h] values
  • values โ€” Log name and location ๐Ÿ“

๐ŸŽ€ COMMAND 'dsconf logging access set compress-enabled'

usage: dsconf [-v] [-j] instance logging access set compress-enabled [-h]

โœจ COMMAND 'dsconf logging access set compress-disabled'

usage: dsconf [-v] [-j] instance logging access set compress-disabled [-h]

๐Ÿฆ‹ COMMAND 'dsconf logging access set buffering-enabled'

usage: dsconf [-v] [-j] instance logging access set buffering-enabled [-h]

๐Ÿซถ COMMAND 'dsconf logging access set buffering-disabled'

usage: dsconf [-v] [-j] instance logging access set buffering-disabled [-h]

๐Ÿ”ข COMMAND 'dsconf logging access set max-logs'

usage: dsconf [-v] [-j] instance logging access set max-logs [-h] values
  • values โ€” Set the maximum number of rotated logs the server will maintain ๐Ÿ”ข

๐Ÿ“ COMMAND 'dsconf logging access set max-logsize'

usage: dsconf [-v] [-j] instance logging access set max-logsize [-h] values
  • values โ€” Set the maximum size for a log in MB ๐Ÿ“

โฐ COMMAND 'dsconf logging access set rotation-interval'

usage: dsconf [-v] [-j] instance logging access set rotation-interval [-h] values
  • values โ€” Set the interval for when a log is rotated. This works with the interval unit โฐ

๐Ÿ•ฐ๏ธ COMMAND 'dsconf logging access set rotation-interval-unit'

usage: dsconf [-v] [-j] instance logging access set rotation-interval-unit [-h] values
  • values โ€” Set the time unit for the rotation interval for when a log is rotated. Choose between: "minute", "hour", "day", "week", and "month" ๐Ÿ•ฐ๏ธ

๐ŸŒ… COMMAND 'dsconf logging access set rotation-tod-enabled'

usage: dsconf [-v] [-j] instance logging access set rotation-tod-enabled [-h]

๐ŸŒ™ COMMAND 'dsconf logging access set rotation-tod-disabled'

usage: dsconf [-v] [-j] instance logging access set rotation-tod-disabled [-h]

๐Ÿ• COMMAND 'dsconf logging access set rotation-tod-hour'

usage: dsconf [-v] [-j] instance logging access set rotation-tod-hour [-h] values
  • values โ€” Set the hour when an expired log should be rotated ๐Ÿ•

๐Ÿ•‘ COMMAND 'dsconf logging access set rotation-tod-minute'

usage: dsconf [-v] [-j] instance logging access set rotation-tod-minute [-h] values
  • values โ€” Set the minute when an expired log should be rotated ๐Ÿ•‘

๐Ÿ—‘๏ธ COMMAND 'dsconf logging access set deletion-interval'

usage: dsconf [-v] [-j] instance logging access set deletion-interval [-h] values
  • values โ€” Set the interval a rotated log should be deleted. This works with the deletion internal unit setting ๐Ÿ—‘๏ธ

๐Ÿ“… COMMAND 'dsconf logging access set deletion-interval-unit'

usage: dsconf [-v] [-j] instance logging access set deletion-interval-unit [-h] values
  • values โ€” Set the interval unit a rotated log should be deleted. Choose from: "day", "week", or "month" ๐Ÿ“…

๐Ÿ’พ COMMAND 'dsconf logging access set max-disk-space'

usage: dsconf [-v] [-j] instance logging access set max-disk-space [-h] values
  • values โ€” Set the maximum amount of disk space in MB rotated logs can consume before rotated logs are deleted. ๐Ÿ’พ

๐Ÿ†“ COMMAND 'dsconf logging access set free-disk-space'

usage: dsconf [-v] [-j] instance logging access set free-disk-space [-h] values
  • values โ€” Set the minimum available disk space in MB that triggers the server to delete rotated log files. ๐Ÿ†“

๐ŸŽจ COMMAND 'dsconf logging access set log-format'

usage: dsconf [-v] [-j] instance logging access set log-format [-h] values
  • values โ€” Choose between "default", "json", or "json-pretty" ๐ŸŽจ

โŒš COMMAND 'dsconf logging access set time-format'

usage: dsconf [-v] [-j] instance logging access set time-format [-h] values
  • values โ€” Time format for JSON logging (strftime) โŒš

๐Ÿ“‹ COMMAND 'dsconf logging access list-levels'

All the levels, laid out like a little mood board:

usage: dsconf [-v] [-j] instance logging access list-levels [-h]

๐Ÿ“ COMMAND 'dsconf logging audit'

The audit log โ€” she's the one who writes EVERYTHING down and remembers it forever, iconic behavior honestly. Only two moves here:

usage: dsconf [-v] [-j] instance logging audit [-h] {get,set} ...

๐Ÿ” POSITIONAL ARGUMENTS 'dsconf logging audit'

  • dsconf logging audit get โ€” Get audit log configuration ๐Ÿ‘€
  • dsconf logging audit set โ€” Set audit log configuration โœ๏ธ

๐Ÿ’Œ COMMAND 'dsconf logging audit get'

usage: dsconf [-v] [-j] instance logging audit get [-h]

๐Ÿ—‚๏ธ COMMAND 'dsconf logging audit set'

Look at this lineup, bestie โ€” she brought nearly the whole access-log menu AND display-attrs as a little treat:

usage: dsconf [-v] [-j] instance logging audit set [-h]
                                                  {logging-enabled,logging-disabled,mode,location,compress-enabled,compress-disabled,buffering-enabled,buffering-disabled,max-logs,max-logsize,rotation-interval,rotation-interval-unit,rotation-tod-enabled,rotation-tod-disabled,rotation-tod-hour,rotation-tod-minute,deletion-interval,deletion-interval-unit,max-disk-space,free-disk-space,log-format,time-format,display-attrs}
       ...

โ€ฆand that's exactly where we're picking up next, so don't go anywhere ๐Ÿ’–

POSITIONAL ARGUMENTS 'dsconf logging audit set' ๐Ÿ’…

okay so all the little levers you can pull on the audit log config live here, bestie. every single one:

  • dsconf logging audit set logging-enabled โ€” turn access logging ON โœจ
  • dsconf logging audit set logging-disabled โ€” turn audit logging OFF ๐Ÿ’€
  • dsconf logging audit set mode โ€” sets the log file permissions. default is 600 ๐Ÿ”’
  • dsconf logging audit set location โ€” sets the log name and where it lives ๐Ÿ“
  • dsconf logging audit set compress-enabled โ€” turn on log compression for rotated logs ๐Ÿ—œ๏ธ
  • dsconf logging audit set compress-disabled โ€” turn off log compression for rotated logs
  • dsconf logging audit set buffering-enabled โ€” turn log buffering ON ๐Ÿซง
  • dsconf logging audit set buffering-disabled โ€” turn log buffering OFF
  • dsconf logging audit set max-logs โ€” the max number of rotated logs the server will keep around
  • dsconf logging audit set max-logsize โ€” the max size for a log, in MB
  • dsconf logging audit set rotation-interval โ€” how often a log gets rotated. this works with the interval unit ๐ŸŒ€
  • dsconf logging audit set rotation-interval-unit โ€” the time unit for that rotation interval, for when a log gets rotated. pick from: "minute", "hour", "day", "week", and "month" โฐ
  • dsconf logging audit set rotation-tod-enabled โ€” enable "time of day" rotation for expired logs ๐ŸŒ…
  • dsconf logging audit set rotation-tod-disabled โ€” disable "time of day" rotation for expired logs
  • dsconf logging audit set rotation-tod-hour โ€” sets the hour when an expired log should get rotated ๐Ÿ•
  • dsconf logging audit set rotation-tod-minute โ€” sets the minute when an expired log should get rotated
  • dsconf logging audit set deletion-interval โ€” the interval at which a rotated log should be deleted. this works with the deletion internal unit setting ๐Ÿ—‘๏ธ
  • dsconf logging audit set deletion-interval-unit โ€” the interval unit at which a rotated log should be deleted. choose from: "day", "week", or "month"
  • dsconf logging audit set max-disk-space โ€” the max amount of disk space in MB rotated logs can eat before rotated logs get deleted ๐Ÿ’พ
  • dsconf logging audit set free-disk-space โ€” the server deletes the oldest rotated log file when the available disk space in MB drops below this amount
  • dsconf logging audit set log-format โ€” choose between "default", "json", or "json-pretty" ๐ŸŽ€
  • dsconf logging audit set time-format โ€” time format for JSON logging (strftime)
  • dsconf logging audit set display-attrs โ€” sets additional identifying attrs to display ๐Ÿ‘€

COMMAND 'dsconf logging audit set logging-enabled' โœจ

usage:

dsconf [-v] [-j] instance logging audit set logging-enabled [-h]

no values needed, she's just a vibe flip. ๐Ÿ’–

COMMAND 'dsconf logging audit set logging-disabled' ๐Ÿ’ค

usage:

dsconf [-v] [-j] instance logging audit set logging-disabled [-h]

COMMAND 'dsconf logging audit set mode' ๐Ÿ”

usage:

dsconf [-v] [-j] instance logging audit set mode [-h] values
  • values โ€” file permissions. default is 600

COMMAND 'dsconf logging audit set location' ๐Ÿ“

usage:

dsconf [-v] [-j] instance logging audit set location [-h] values
  • values โ€” log name and location

COMMAND 'dsconf logging audit set compress-enabled' ๐Ÿ—œ๏ธ

usage:

dsconf [-v] [-j] instance logging audit set compress-enabled [-h]

COMMAND 'dsconf logging audit set compress-disabled' ๐Ÿšซ

usage:

dsconf [-v] [-j] instance logging audit set compress-disabled [-h]

COMMAND 'dsconf logging audit set buffering-enabled' ๐Ÿซง

usage:

dsconf [-v] [-j] instance logging audit set buffering-enabled [-h]

COMMAND 'dsconf logging audit set buffering-disabled' ๐Ÿ™ˆ

usage:

dsconf [-v] [-j] instance logging audit set buffering-disabled [-h]

COMMAND 'dsconf logging audit set max-logs' ๐Ÿ—‚๏ธ

usage:

dsconf [-v] [-j] instance logging audit set max-logs [-h] values
  • values โ€” set the maximum number of rotated logs the server will maintain

COMMAND 'dsconf logging audit set max-logsize' ๐Ÿ“

usage:

dsconf [-v] [-j] instance logging audit set max-logsize [-h] values
  • values โ€” set the maximum size for a log in MB

COMMAND 'dsconf logging audit set rotation-interval' ๐ŸŒ€

usage:

dsconf [-v] [-j] instance logging audit set rotation-interval [-h] values
  • values โ€” set the interval for when a log is rotated.This works with the interval unit

COMMAND 'dsconf logging audit set rotation-interval-unit' โฐ

usage:

dsconf [-v] [-j] instance logging audit set rotation-interval-unit [-h] values
  • values โ€” set the time unit for the rotation interval for whena log is rotated. choose between: "minute", "hour", "day", "week", and "month"

COMMAND 'dsconf logging audit set rotation-tod-enabled' ๐ŸŒ…

usage:

dsconf [-v] [-j] instance logging audit set rotation-tod-enabled [-h]

COMMAND 'dsconf logging audit set rotation-tod-disabled' ๐ŸŒ™

usage:

dsconf [-v] [-j] instance logging audit set rotation-tod-disabled [-h]

COMMAND 'dsconf logging audit set rotation-tod-hour' ๐Ÿ•

usage:

dsconf [-v] [-j] instance logging audit set rotation-tod-hour [-h] values
  • values โ€” set the hour when an expired log should be rotated

COMMAND 'dsconf logging audit set rotation-tod-minute' โŒš

usage:

dsconf [-v] [-j] instance logging audit set rotation-tod-minute [-h] values
  • values โ€” set the minute when an expired log should be rotated

COMMAND 'dsconf logging audit set deletion-interval' ๐Ÿ—‘๏ธ

usage:

dsconf [-v] [-j] instance logging audit set deletion-interval [-h] values
  • values โ€” set the interval a rotated log should be deleted. this works with the deletion internal unit setting

COMMAND 'dsconf logging audit set deletion-interval-unit' ๐Ÿ“†

usage:

dsconf [-v] [-j] instance logging audit set deletion-interval-unit [-h] values
  • values โ€” set the interval unit a rotated log should be deleted. choose from: "day", "week", or "month"

COMMAND 'dsconf logging audit set max-disk-space' ๐Ÿ’พ

usage:

dsconf [-v] [-j] instance logging audit set max-disk-space [-h] values
  • values โ€” set the maximum amount of disk space in MB rotated logs can consume before rotated logs are deleted.

COMMAND 'dsconf logging audit set free-disk-space' ๐Ÿงน

usage:

dsconf [-v] [-j] instance logging audit set free-disk-space [-h] values
  • values โ€” set the minimum available disk space in MB that triggers the server to delete rotated log files.

COMMAND 'dsconf logging audit set log-format' ๐ŸŽ€

usage:

dsconf [-v] [-j] instance logging audit set log-format [-h] values
  • values โ€” choose between "default", "json", or "json-pretty"

COMMAND 'dsconf logging audit set time-format' ๐Ÿ•ฐ๏ธ

usage:

dsconf [-v] [-j] instance logging audit set time-format [-h] values
  • values โ€” time format for JSON logging (strftime)

COMMAND 'dsconf logging audit set display-attrs' ๐Ÿ‘€

usage:

dsconf [-v] [-j] instance logging audit set display-attrs [-h] values [values ...]
  • values โ€” sets additional identifying attrs to display

COMMAND 'dsconf logging auditfail' ๐Ÿšจ

usage:

dsconf [-v] [-j] instance logging auditfail [-h] {get,set} ...

this is the auditfail log, aka the place where failed-audit receipts go. she has two moves: get and set. ๐Ÿ’…

POSITIONAL ARGUMENTS 'dsconf logging auditfail' ๐Ÿซถ

  • dsconf logging auditfail get โ€” get auditfail log configuration
  • dsconf logging auditfail set โ€” set auditfail log configuration

COMMAND 'dsconf logging auditfail get' ๐Ÿ“–

usage:

dsconf [-v] [-j] instance logging auditfail get [-h]

COMMAND 'dsconf logging auditfail set' โœ๏ธ

usage:

dsconf [-v] [-j] instance logging auditfail set [-h]
                                                              {logging-enabled,logging-disabled,mode,location,compress-enabled,compress-disabled,max-logs,max-logsize,rotation-interval,rotation-interval-unit,rotation-tod-enabled,rotation-tod-disabled,rotation-tod-hour,rotation-tod-minute,deletion-interval,deletion-interval-unit,max-disk-space,free-disk-space}
       ...

look at that giant menu, bestie. pick your fighter from the brace list. ๐Ÿ‘‘

POSITIONAL ARGUMENTS 'dsconf logging auditfail set' ๐ŸŒˆ

  • dsconf logging auditfail set logging-enabled โ€” enable access logging โœจ
  • dsconf logging auditfail set logging-disabled โ€” disable auditfail logging ๐Ÿ’€
  • dsconf logging auditfail set mode โ€” sets the log file permissions. default is 600 ๐Ÿ”’
  • dsconf logging auditfail set location โ€” sets the log name and location ๐Ÿ“
  • dsconf logging auditfail set compress-enabled โ€” turn on log compression for rotated logs ๐Ÿ—œ๏ธ
  • dsconf logging auditfail set compress-disabled โ€” turn off log compression for rotated logs
  • dsconf logging auditfail set max-logs โ€” the max number of rotated logs the server will keep around
  • dsconf logging auditfail set max-logsize โ€” the max size for a log, in MB
  • dsconf logging auditfail set rotation-interval โ€” how often a log gets rotated. this works with the interval unit ๐ŸŒ€
  • dsconf logging auditfail set rotation-interval-unit โ€” the time unit for the rotation interval, for when a log gets rotated. pick from: "minute", "hour", "day", "week", and "month" โฐ
  • dsconf logging auditfail set rotation-tod-enabled โ€” enable "time of day" rotation for expired logs ๐ŸŒ…
  • dsconf logging auditfail set rotation-tod-disabled โ€” disable "time of day" rotation for expired logs
  • dsconf logging auditfail set rotation-tod-hour โ€” sets the hour when an expired log should get rotated ๐Ÿ•
  • dsconf logging auditfail set rotation-tod-minute โ€” sets the minute when an expired log should get rotated
  • dsconf logging auditfail set deletion-interval โ€” the interval at which a rotated log should be deleted. this works with the deletion internal unit setting ๐Ÿ—‘๏ธ
  • dsconf logging auditfail set deletion-interval-unit โ€” the interval unit at which a rotated log should be deleted. choose from: "day", "week", or "month"
  • dsconf logging auditfail set max-disk-space โ€” the max amount of disk space in MB rotated logs can consume before rotated logs get deleted ๐Ÿ’พ
  • dsconf logging auditfail set free-disk-space โ€” the server deletes the oldest rotated log file when the available disk space in MB drops below this amount

COMMAND 'dsconf logging auditfail set logging-enabled' ๐Ÿ’–

usage:

dsconf [-v] [-j] instance logging auditfail set logging-enabled [-h]

COMMAND 'dsconf logging auditfail set logging-disabled' ๐Ÿ˜ด

usage:

dsconf [-v] [-j] instance logging auditfail set logging-disabled [-h]

COMMAND 'dsconf logging auditfail set mode' ๐Ÿ”

usage:

dsconf [-v] [-j] instance logging auditfail set mode [-h] values
  • values โ€” file permissions. default is 600

COMMAND 'dsconf logging auditfail set location' ๐Ÿ“

usage:

dsconf [-v] [-j] instance logging auditfail set location [-h] values
  • values โ€” log name and location

COMMAND 'dsconf logging auditfail set compress-enabled' ๐Ÿงš

usage:

dsconf [-v] [-j] instance logging auditfail set compress-enabled [-h]

COMMAND 'dsconf logging auditfail set compress-disabled' ๐Ÿ™…

usage:

dsconf [-v] [-j] instance logging auditfail set compress-disabled [-h]

๐ŸŽ€ COMMAND 'dsconf logging auditfail set max-logs'

okay so the usage is literally:

dsconf [-v] [-j] instance logging auditfail set max-logs [-h] values
  • values โ€” set the max number of rotated logs your server is gonna keep around. girl, after that many, they're gone bestie ๐Ÿ’…

๐ŸŽ€ COMMAND 'dsconf logging auditfail set max-logsize'

dsconf [-v] [-j] instance logging auditfail set max-logsize [-h] values
  • values โ€” the biggest a log can get, in MB, before it's giving rotated ๐ŸŒ€

๐ŸŽ€ COMMAND 'dsconf logging auditfail set rotation-interval'

dsconf [-v] [-j] instance logging auditfail set rotation-interval
       [-h] values
  • values โ€” sets the interval for when a log gets rotated. lowkey important: this works together with the interval unit, so don't set one and ghost the other ๐Ÿซถ

๐ŸŽ€ COMMAND 'dsconf logging auditfail set rotation-interval-unit'

dsconf [-v] [-j] instance logging auditfail set
       rotation-interval-unit
       [-h] values
  • values โ€” the time unit for that rotation interval, aka when a log gets rotated. you pick from exactly: "minute", "hour", "day", "week", and "month" โœจ

๐ŸŽ€ COMMAND 'dsconf logging auditfail set rotation-tod-enabled'

dsconf [-v] [-j] instance logging auditfail set
       rotation-tod-enabled
       [-h]

no args, no values, no drama โ€” it just turns it on, periodt ๐Ÿ’…


๐ŸŽ€ COMMAND 'dsconf logging auditfail set rotation-tod-disabled'

dsconf [-v] [-j] instance logging auditfail set
       rotation-tod-disabled
       [-h]

and this one turns it off. that's the whole post ๐Ÿฆ‹


๐ŸŽ€ COMMAND 'dsconf logging auditfail set rotation-tod-hour'

dsconf [-v] [-j] instance logging auditfail set rotation-tod-hour
       [-h] values
  • values โ€” the hour when an expired log should get rotated ๐Ÿ•

๐ŸŽ€ COMMAND 'dsconf logging auditfail set rotation-tod-minute'

dsconf [-v] [-j] instance logging auditfail set
       rotation-tod-minute
       [-h] values
  • values โ€” the minute when an expired log should get rotated โฑ๏ธ

๐ŸŽ€ COMMAND 'dsconf logging auditfail set deletion-interval'

dsconf [-v] [-j] instance logging auditfail set deletion-interval
       [-h] values
  • values โ€” the interval after which a rotated log gets deleted. and yes, this works with the deletion internal unit setting, they're a package deal fr fr ๐Ÿ“ฆ

๐ŸŽ€ COMMAND 'dsconf logging auditfail set deletion-interval-unit'

dsconf [-v] [-j] instance logging auditfail set
       deletion-interval-unit
       [-h] values
  • values โ€” the interval unit for when a rotated log gets deleted. choose from: "day", "week", or "month" ๐ŸŒˆ

๐ŸŽ€ COMMAND 'dsconf logging auditfail set max-disk-space'

dsconf [-v] [-j] instance logging auditfail set max-disk-space
       [-h] values
  • values โ€” the max amount of disk space, in MB, that rotated logs are allowed to consume before the rotated logs get deleted. it's giving "you've had enough bestie" ๐Ÿ’€

๐ŸŽ€ COMMAND 'dsconf logging auditfail set free-disk-space'

dsconf [-v] [-j] instance logging auditfail set free-disk-space
       [-h] values
  • values โ€” the minimum available disk space, in MB, that triggers the server to delete rotated log files ๐Ÿ—‘๏ธโœจ

๐Ÿ’œ COMMAND 'dsconf logging error'

dsconf [-v] [-j] instance logging error [-h]
       {get,set,list-levels} ...

this is the error log's whole world, and it's super manageable:

POSITIONAL ARGUMENTS 'dsconf logging error'

  • dsconf logging error get โ€” get the error log configuration ๐Ÿ‘€
  • dsconf logging error set โ€” set the error log configuration โœ๏ธ
  • dsconf logging error list-levels โ€” list all the log levels ๐Ÿ“‹

๐ŸŽ€ COMMAND 'dsconf logging error get'

dsconf [-v] [-j] instance logging error get [-h]

just go get it, no extra args needed bestie ๐Ÿซถ


๐ŸŽ€ COMMAND 'dsconf logging error set'

dsconf [-v] [-j] instance logging error set [-h]
                                                          {level,logging-enabled,logging-disabled,mode,location,compress-enabled,compress-disabled,buffering-enabled,buffering-disabled,max-logs,max-logsize,rotation-interval,rotation-interval-unit,rotation-tod-enabled,rotation-tod-disabled,rotation-tod-hour,rotation-tod-minute,deletion-interval,deletion-interval-unit,max-disk-space,free-disk-space,log-format,time-format}
       ...

look at that menu of options, she ate ๐Ÿ’…

POSITIONAL ARGUMENTS 'dsconf logging error set'

  • dsconf logging error set level โ€” set the log level
  • dsconf logging error set logging-enabled โ€” enable access logging
  • dsconf logging error set logging-disabled โ€” disable error logging
  • dsconf logging error set mode โ€” set the log file permissions. default is 600
  • dsconf logging error set location โ€” set the log name and location
  • dsconf logging error set compress-enabled โ€” enable log compression for rotated logs
  • dsconf logging error set compress-disabled โ€” disable log compression for rotated logs
  • dsconf logging error set buffering-enabled โ€” enable log buffering
  • dsconf logging error set buffering-disabled โ€” disable log buffering
  • dsconf logging error set max-logs โ€” set the maximum number of rotated logs the server will maintain
  • dsconf logging error set max-logsize โ€” set the maximum size for a log in MB
  • dsconf logging error set rotation-interval โ€” set the interval for when a log is rotated. this works with the interval unit
  • dsconf logging error set rotation-interval-unit โ€” set the time unit for the rotation interval for when a log is rotated. choose between: "minute", "hour", "day", "week", and "month"
  • dsconf logging error set rotation-tod-enabled โ€” enable "time of day" rotation for expired logs
  • dsconf logging error set rotation-tod-disabled โ€” disable "time of day" rotation for expired logs
  • dsconf logging error set rotation-tod-hour โ€” set the hour when an expired log should be rotated
  • dsconf logging error set rotation-tod-minute โ€” set the minute when an expired log should be rotated
  • dsconf logging error set deletion-interval โ€” set the interval a rotated log should be deleted. this works with the deletion internal unit setting
  • dsconf logging error set deletion-interval-unit โ€” set the interval unit a rotated log should be deleted. choose from: "day", "week", or "month"
  • dsconf logging error set max-disk-space โ€” set the maximum amount of disk space in MB rotated logs can consume before rotated logs are deleted.
  • dsconf logging error set free-disk-space โ€” the server deletes the oldest rotated log file when the available disk space in MB is less than this amount.
  • dsconf logging error set log-format โ€” choose between "default", "json", or "json-pretty"
  • dsconf logging error set time-format โ€” time format for JSON logging (strftime)

๐ŸŽ€ COMMAND 'dsconf logging error set level'

dsconf [-v] [-j] instance logging error set level [-h]
                                                                levels [levels
       ...]
  • levels โ€” log level. yes you can pass more than one, she's flexible like that ๐Ÿ’…

๐ŸŽ€ COMMAND 'dsconf logging error set logging-enabled'

dsconf [-v] [-j] instance logging error set logging-enabled [-h]

๐ŸŽ€ COMMAND 'dsconf logging error set logging-disabled'

dsconf [-v] [-j] instance logging error set logging-disabled [-h]

๐ŸŽ€ COMMAND 'dsconf logging error set mode'

dsconf [-v] [-j] instance logging error set mode [-h] values
  • values โ€” file permissions. default is 600 ๐Ÿ”

๐ŸŽ€ COMMAND 'dsconf logging error set location'

dsconf [-v] [-j] instance logging error set location [-h] values
  • values โ€” log name and location ๐Ÿ“

๐ŸŽ€ COMMAND 'dsconf logging error set compress-enabled'

dsconf [-v] [-j] instance logging error set compress-enabled [-h]

๐ŸŽ€ COMMAND 'dsconf logging error set compress-disabled'

dsconf [-v] [-j] instance logging error set compress-disabled
       [-h]

๐ŸŽ€ COMMAND 'dsconf logging error set buffering-enabled'

dsconf [-v] [-j] instance logging error set buffering-enabled
       [-h]

๐ŸŽ€ COMMAND 'dsconf logging error set buffering-disabled'

dsconf [-v] [-j] instance logging error set buffering-disabled
       [-h]

๐ŸŽ€ COMMAND 'dsconf logging error set max-logs'

dsconf [-v] [-j] instance logging error set max-logs [-h] values
  • values โ€” set the maximum number of rotated logs the server will maintain ๐Ÿ“š

๐ŸŽ€ COMMAND 'dsconf logging error set max-logsize'

dsconf [-v] [-j] instance logging error set max-logsize [-h]
       values
  • values โ€” set the maximum size for a log in MB ๐Ÿ“

๐ŸŽ€ COMMAND 'dsconf logging error set rotation-interval'

dsconf [-v] [-j] instance logging error set rotation-interval
       [-h] values
  • values โ€” set the interval for when a log is rotated. this works with the interval unit, they're besties ๐Ÿซ‚

๐ŸŽ€ COMMAND 'dsconf logging error set rotation-interval-unit'

dsconf [-v] [-j] instance logging error set
       rotation-interval-unit
       [-h] values
  • values โ€” set the time unit for the rotation interval for when a log is rotated. choose between: "minute", "hour", "day", "week", and "month" โณ

๐ŸŽ€ COMMAND 'dsconf logging error set rotation-tod-enabled'

dsconf [-v] [-j] instance logging error set rotation-tod-enabled
       [-h]

๐ŸŽ€ COMMAND 'dsconf logging error set rotation-tod-disabled'

dsconf [-v] [-j] instance logging error set rotation-tod-disabled
       [-h]

๐ŸŽ€ COMMAND 'dsconf logging error set rotation-tod-hour'

dsconf [-v] [-j] instance logging error set rotation-tod-hour
       [-h] values
  • values โ€” set the hour when an expired log should be rotated ๐Ÿ•›

๐ŸŽ€ COMMAND 'dsconf logging error set rotation-tod-minute'

dsconf [-v] [-j] instance logging error set rotation-tod-minute
       [-h] values
  • values โ€” set the minute when an expired log should be rotated ๐Ÿ•œ

๐ŸŽ€ COMMAND 'dsconf logging error set deletion-interval'

dsconf [-v] [-j] instance logging error set deletion-interval
       [-h] values
  • values โ€” set the interval a rotated log should be deleted. this works with the deletion internal unit setting โœ‚๏ธ

๐ŸŽ€ COMMAND 'dsconf logging error set deletion-interval-unit'

dsconf [-v] [-j] instance logging error set
       deletion-interval-unit
       [-h] values
  • values โ€” set the interval unit a rotated log should be deleted. choose from: "day", "week", or "month" ๐Ÿ—“๏ธ

๐ŸŽ€ COMMAND 'dsconf logging error set max-disk-space'

dsconf [-v] [-j] instance logging error set max-disk-space [-h]
       values
  • values โ€” set the maximum amount of disk space in MB rotated logs can consume before rotated logs are deleted. ๐Ÿ’พ

๐ŸŽ€ COMMAND 'dsconf logging error set free-disk-space'

dsconf [-v] [-j] instance logging error set free-disk-space [-h]
       values
  • values โ€” set the minimum available disk space in MB that triggers the server to delete rotated log files. ๐Ÿงน

๐ŸŽ€ COMMAND 'dsconf logging error set log-format'

dsconf [-v] [-j] instance logging error set log-format [-h]
       values
  • values โ€” choose between "default", "json", or "json-pretty" โœจ

๐ŸŽ€ COMMAND 'dsconf logging error set time-format'

dsconf [-v] [-j] instance logging error set time-format [-h]
       values
  • values โ€” time format for JSON logging (strftime) ๐Ÿ•ฐ๏ธ

๐ŸŽ€ COMMAND 'dsconf logging error list-levels'

dsconf [-v] [-j] instance logging error list-levels [-h]

show me every single level, no gatekeeping ๐Ÿ’…


๐Ÿฆ‹ COMMAND 'dsconf logging security'

dsconf [-v] [-j] instance logging security [-h] {get,set} ...

security log time, and it's a whole vibe:

POSITIONAL ARGUMENTS 'dsconf logging security'

  • dsconf logging security get โ€” get security log configuration ๐Ÿ”
  • dsconf logging security set โ€” set security log configuration ๐Ÿ”ง

๐Ÿซถ COMMAND 'dsconf logging security get' ๐Ÿซถ

usage: dsconf [-v] [-j] instance logging security get [-h]

That's it bestie, that's the whole thing. No flags, no args, she just gets. ๐Ÿ’…


โœจ COMMAND 'dsconf logging security set' โœจ

usage: dsconf [-v] [-j] instance logging security set [-h]
                                                      {logging-enabled,logging-disabled,mode,location,compress-enabled,compress-disabled,buffering-enabled,buffering-disabled,max-logs,max-logsize,rotation-interval,rotation-interval-unit,rotation-tod-enabled,rotation-tod-disabled,rotation-tod-hour,rotation-tod-minute,deletion-interval,deletion-interval-unit,max-disk-space,free-disk-space}
...

Look at that menu of choices, it's giving โœจ options โœจ. Every single one is a positional argument you can pick, and we're about to run through all twenty of them, one by one, no skips. ๐ŸŒธ

๐Ÿ’– POSITIONAL ARGUMENTS 'dsconf logging security set' ๐Ÿ’–

  • dsconf logging security set logging-enabled โ€” Enable access logging ๐Ÿ‘‘
  • dsconf logging security set logging-disabled โ€” Disable security logging ๐Ÿ™ˆ
  • dsconf logging security set mode โ€” Set the log file permissions. Default is 600 ๐Ÿ”
  • dsconf logging security set location โ€” Set the log name and location ๐Ÿ“
  • dsconf logging security set compress-enabled โ€” Enable log compression for rotated logs ๐Ÿ—œ๏ธ
  • dsconf logging security set compress-disabled โ€” Disable log compression for rotated logs
  • dsconf logging security set buffering-enabled โ€” Enable log buffering ๐Ÿซง
  • dsconf logging security set buffering-disabled โ€” Disable log buffering
  • dsconf logging security set max-logs โ€” Set the maximum number of rotated logs the server will maintain ๐Ÿ—‚๏ธ
  • dsconf logging security set max-logsize โ€” Set the maximum size for a log in MB
  • dsconf logging security set rotation-interval โ€” Set the interval for when a log is rotated.This works with the interval unit โฐ (yes the missing space is canon, I don't make the rules)
  • dsconf logging security set rotation-interval-unit โ€” Set the time unit for the rotation interval for whena log is rotated. Choose between: "minute", "hour", "day", "week", and "month" ๐Ÿ•ฐ๏ธ
  • dsconf logging security set rotation-tod-enabled โ€” Enable "time of day" rotation for expired logs ๐ŸŒ…
  • dsconf logging security set rotation-tod-disabled โ€” Disable "time of day" rotation for expired logs
  • dsconf logging security set rotation-tod-hour โ€” Set the hour when an expired log should be rotated ๐Ÿ•
  • dsconf logging security set rotation-tod-minute โ€” Set the minute when an expired log should be rotated โฑ๏ธ
  • dsconf logging security set deletion-interval โ€” Set the interval a rotated log should be deleted. This works with the deletion internal unit setting ๐Ÿ—‘๏ธ
  • dsconf logging security set deletion-interval-unit โ€” Set the interval unit a rotated log should be deleted. Choose from: "day", "week", or "month"
  • dsconf logging security set max-disk-space โ€” Set the maximum amount of disk space in MB rotated logs can consume before rotated logs are deleted. ๐Ÿ’พ
  • dsconf logging security set free-disk-space โ€” The server deletes the oldest rotated log file when the available disk space in MB is less than this amount. ๐Ÿงน

๐ŸŒˆ COMMAND 'dsconf logging security set logging-enabled' ๐ŸŒˆ

usage: dsconf [-v] [-j] instance logging security set logging-enabled
[-h]

No values, no nothing. You just say the word and it's on. โœจ


๐Ÿฆ‹ COMMAND 'dsconf logging security set logging-disabled' ๐Ÿฆ‹

usage: dsconf [-v] [-j] instance logging security set logging-disabled
[-h]

The opposite vibe check. Off it goes.


๐ŸŽ€ COMMAND 'dsconf logging security set mode' ๐ŸŽ€

usage: dsconf [-v] [-j] instance logging security set mode [-h] values
  • values โ€” File permissions. Default is 600 ๐Ÿ”
Default is 600, bestie. Remember that number, it's the whole personality of this option. ๐Ÿ’…

๐Ÿ“ COMMAND 'dsconf logging security set location' ๐Ÿ“

usage: dsconf [-v] [-j] instance logging security set location [-h]
values
  • values โ€” Log name and location ๐Ÿ—บ๏ธ

๐Ÿ—œ๏ธ COMMAND 'dsconf logging security set compress-enabled' ๐Ÿ—œ๏ธ

usage: dsconf [-v] [-j] instance logging security set compress-enabled
[-h]

Squish those rotated logs down to size. ๐Ÿซธโœจ


COMMAND 'dsconf logging security set compress-disabled'

usage: dsconf [-v] [-j] instance logging security set compress-disabled
[-h]

No squishing. Full size files, full size feelings.


๐Ÿซง COMMAND 'dsconf logging security set buffering-enabled' ๐Ÿซง

usage: dsconf [-v] [-j] instance logging security set buffering-enabled
[-h]

COMMAND 'dsconf logging security set buffering-disabled'

usage: dsconf [-v] [-j] instance logging security set buffering-disabled
[-h]

๐Ÿ—‚๏ธ COMMAND 'dsconf logging security set max-logs' ๐Ÿ—‚๏ธ

usage: dsconf [-v] [-j] instance logging security set max-logs [-h]
values
  • values โ€” Set the maximum number of rotated logs the server will maintain ๐Ÿ“š

COMMAND 'dsconf logging security set max-logsize'

usage: dsconf [-v] [-j] instance logging security set max-logsize [-h]
values
  • values โ€” Set the maximum size for a log in MB ๐Ÿ“

โฐ COMMAND 'dsconf logging security set rotation-interval' โฐ

usage: dsconf [-v] [-j] instance logging security set rotation-interval
       [-h] values
  • values โ€” Set the interval for when a log is rotated.This works with the interval unit ๐ŸŒ€

๐Ÿ•ฐ๏ธ COMMAND 'dsconf logging security set rotation-interval-unit' ๐Ÿ•ฐ๏ธ

usage: dsconf [-v] [-j] instance logging security set
rotation-interval-unit
       [-h] values
  • values โ€” Set the time unit for the rotation interval for whena log is rotated. Choose between: "minute", "hour", "day", "week", and "month" ๐Ÿ“…

๐ŸŒ… COMMAND 'dsconf logging security set rotation-tod-enabled' ๐ŸŒ…

usage: dsconf [-v] [-j] instance logging security set
rotation-tod-enabled
       [-h]

COMMAND 'dsconf logging security set rotation-tod-disabled'

usage: dsconf [-v] [-j] instance logging security set
rotation-tod-disabled
       [-h]

๐Ÿ• COMMAND 'dsconf logging security set rotation-tod-hour' ๐Ÿ•

usage: dsconf [-v] [-j] instance logging security set rotation-tod-hour
       [-h] values
  • values โ€” Set the hour when an expired log should be rotated โณ

โฑ๏ธ COMMAND 'dsconf logging security set rotation-tod-minute' โฑ๏ธ

usage: dsconf [-v] [-j] instance logging security set
rotation-tod-minute
       [-h] values
  • values โ€” Set the minute when an expired log should be rotated ๐Ÿซถ

๐Ÿ—‘๏ธ COMMAND 'dsconf logging security set deletion-interval' ๐Ÿ—‘๏ธ

usage: dsconf [-v] [-j] instance logging security set deletion-interval
       [-h] values
  • values โ€” Set the interval a rotated log should be deleted. This works with the deletion internal unit setting โœ‚๏ธ

COMMAND 'dsconf logging security set deletion-interval-unit'

usage: dsconf [-v] [-j] instance logging security set
deletion-interval-unit
       [-h] values
  • values โ€” Set the interval unit a rotated log should be deleted. Choose from: "day", "week", or "month" ๐Ÿ—“๏ธ

๐Ÿ’พ COMMAND 'dsconf logging security set max-disk-space' ๐Ÿ’พ

usage: dsconf [-v] [-j] instance logging security set max-disk-space
       [-h] values
  • values โ€” Set the maximum amount of disk space in MB rotated logs can consume before rotated logs are deleted. ๐Ÿšจ

๐Ÿงน COMMAND 'dsconf logging security set free-disk-space' ๐Ÿงน

usage: dsconf [-v] [-j] instance logging security set free-disk-space
       [-h] values
  • values โ€” Set the minimum available disk space in MB that triggers the server to delete rotated log files. ๐Ÿซง

๐Ÿ‘‘ COMMAND 'dsconf monitor' ๐Ÿ‘‘

usage: dsconf [-v] [-j] instance monitor [-h]
                               {server,dbmon,ldbm,backend,snmp,chaining,disk,memberof}
...

The watch-it-all command. Eight ways to stare lovingly at your server and see what it's actually doing. ๐Ÿ“Š

โœจ POSITIONAL ARGUMENTS 'dsconf monitor' โœจ

  • dsconf monitor server โ€” Displays the server statistics, connections, and operations ๐Ÿ–ฅ๏ธ
  • dsconf monitor dbmon โ€” Monitor all database statistics in a single report ๐Ÿ“‹
  • dsconf monitor ldbm โ€” Monitor the LDBM statistics, such as dbcache ๐Ÿง 
  • dsconf monitor backend โ€” Monitor the behavior of a backend database ๐Ÿ—„๏ธ
  • dsconf monitor snmp โ€” Displays the SNMP statistics ๐Ÿ“ก
  • dsconf monitor chaining โ€” Monitor database chaining statistics โ›“๏ธ
  • dsconf monitor disk โ€” Displays the disk space statistics. All values are in bytes. ๐Ÿ’ฝ
  • dsconf monitor memberof โ€” Displays deferred memberof plugin stats. ๐Ÿ‘ฏ

๐Ÿ–ฅ๏ธ COMMAND 'dsconf monitor server' ๐Ÿ–ฅ๏ธ

usage: dsconf [-v] [-j] instance monitor server [-h] [-r]

OPTIONS 'dsconf monitor server'

  • -r, --just-resources โ€” Just display the server resources being consumed โšก

๐Ÿ“‹ COMMAND 'dsconf monitor dbmon' ๐Ÿ“‹

usage: dsconf [-v] [-j] instance monitor dbmon [-h] [-b BACKENDS] [-x]

OPTIONS 'dsconf monitor dbmon'

  • -b BACKENDS, --backends BACKENDS โ€” Specifies a list of space-separated backends to monitor. Default is all backends. ๐ŸŽฏ
  • -x, --indexes โ€” Shows index stats for each backend ๐Ÿ”

๐Ÿง  COMMAND 'dsconf monitor ldbm' ๐Ÿง 

usage: dsconf [-v] [-j] instance monitor ldbm [-h]

๐Ÿ—„๏ธ COMMAND 'dsconf monitor backend' ๐Ÿ—„๏ธ

usage: dsconf [-v] [-j] instance monitor backend [-h] [backend]
  • backend โ€” The optional name of the backend to monitor ๐Ÿ‘€

๐Ÿ“ก COMMAND 'dsconf monitor snmp' ๐Ÿ“ก

usage: dsconf [-v] [-j] instance monitor snmp [-h]

โ›“๏ธ COMMAND 'dsconf monitor chaining' โ›“๏ธ

usage: dsconf [-v] [-j] instance monitor chaining [-h] [backend]
  • backend โ€” The optional name of the chaining backend to monitor ๐Ÿ”—

๐Ÿ’ฝ COMMAND 'dsconf monitor disk' ๐Ÿ’ฝ

usage: dsconf [-v] [-j] instance monitor disk [-h]
Heads up bestie: for this one, all values are in bytes. ๐Ÿซถ

๐Ÿ‘ฏ COMMAND 'dsconf monitor memberof' ๐Ÿ‘ฏ

usage: dsconf [-v] [-j] instance monitor memberof [-h]

๐ŸŒธ COMMAND 'dsconf plugin' ๐ŸŒธ

usage: dsconf [-v] [-j] instance plugin [-h]
                              {memberof,automember,referential-integrity,root-dn,usn,account-policy,attr-uniq,dna,ldap-pass-through-auth,linked-attr,managed-entries,pam-pass-through-auth,retro-changelog,posix-winsync,contentsync,entryuuid,pwstorage-scheme,list,show,set}
...

Okay so this is the big one โ€” eighteen plugin pipelines plus list, show, and set to round it out. A whole roster of little side-characters each with main character energy. ๐ŸŽญ We're gonna get into all of them, don't you worry. ๐Ÿ’œ

๐Ÿ“‹ POSITIONAL ARGUMENTS dsconf plugin

Okay bestie, the plugin command has a whole roster of sub-commands and honestly each one is a little icon in its own right ๐Ÿ’… here's the full guest list:

  • dsconf plugin memberof โ€” manage and configure the MemberOf plugin โœจ
  • dsconf plugin automember โ€” manage and configure the Automembership plugin ๐ŸŽ€
  • dsconf plugin referential-integrity โ€” manage and configure the Referential Integrity Postoperation plugin
  • dsconf plugin root-dn โ€” manage and configure the RootDN Access Control plugin ๐Ÿ‘‘
  • dsconf plugin usn โ€” manage and configure the USN plugin
  • dsconf plugin account-policy โ€” manage and configure the Account Policy plugin
  • dsconf plugin attr-uniq โ€” manage and configure the Attribute Uniqueness plugin
  • dsconf plugin dna โ€” manage and configure the DNA plugin ๐Ÿงฌ
  • dsconf plugin ldap-pass-through-auth โ€” manage and configure LDAP Pass-Through Authentication Plugin
  • dsconf plugin linked-attr โ€” manage and configure the Linked Attributes plugin
  • dsconf plugin managed-entries โ€” manage and configure the Managed Entries Plugin
  • dsconf plugin pam-pass-through-auth โ€” manage and configure Pass-Through Authentication plugins (LDAP URLs and PAM) ๐Ÿ”
  • dsconf plugin retro-changelog โ€” manage and configure the Retro Changelog plugin
  • dsconf plugin posix-winsync โ€” manage and configure the Posix Winsync API plugin
  • dsconf plugin contentsync โ€” manage and configure Content Sync Plugin (aka syncrepl) ๐Ÿฆ‹
  • dsconf plugin entryuuid โ€” manage and configure EntryUUID plugin
  • dsconf plugin pwstorage-scheme โ€” manage password storage scheme plugins
  • dsconf plugin list โ€” list current configured (enabled and disabled) plugins ๐Ÿ“
  • dsconf plugin show โ€” show the plugin data
  • dsconf plugin set โ€” edit the plugin settings

๐Ÿ› ๏ธ COMMAND dsconf plugin memberof

So you wanna vibe with the MemberOf plugin? Say less. Here's the shape of it:

usage: dsconf [-v] [-j] instance plugin memberof [-h]
                                                 {show,enable,disable,status,set,add-attr,del-attr,config-entry,fixup,fixup-status}
...

๐Ÿ“‹ POSITIONAL ARGUMENTS dsconf plugin memberof

All the little moves you can pull:

  • dsconf plugin memberof show โ€” displays the plugin configuration ๐Ÿ‘€
  • dsconf plugin memberof enable โ€” enables the plugin โœ…
  • dsconf plugin memberof disable โ€” disables the plugin ๐Ÿšซ
  • dsconf plugin memberof status โ€” displays the plugin status ๐Ÿ“Š
  • dsconf plugin memberof set โ€” edit the plugin settings
  • dsconf plugin memberof add-attr โ€” add attributes to the plugin โž•
  • dsconf plugin memberof del-attr โ€” delete attributes from the plugin โž–
  • dsconf plugin memberof config-entry โ€” manage the config entry
  • dsconf plugin memberof fixup โ€” run the fix-up task for memberOf plugin ๐Ÿ”ง
  • dsconf plugin memberof fixup-status โ€” check the status of a fix-up task

๐Ÿ› ๏ธ COMMAND dsconf plugin memberof show

usage: dsconf [-v] [-j] instance plugin memberof show [-h]

๐Ÿ› ๏ธ COMMAND dsconf plugin memberof enable

usage: dsconf [-v] [-j] instance plugin memberof enable [-h]

๐Ÿ› ๏ธ COMMAND dsconf plugin memberof disable

usage: dsconf [-v] [-j] instance plugin memberof disable [-h]

๐Ÿ› ๏ธ COMMAND dsconf plugin memberof status

usage: dsconf [-v] [-j] instance plugin memberof status [-h]

๐Ÿ› ๏ธ COMMAND dsconf plugin memberof set

usage: dsconf [-v] [-j] instance plugin memberof set [-h] [--attr ATTR]
                                                     [--groupattr
GROUPATTR [GROUPATTR ...]]
                                                     [--allbackends
{on,off}]
                                                     [--skipnested
{on,off}]
                                                     [--scope SCOPE
[SCOPE ...]]
                                                     [--exclude EXCLUDE
[EXCLUDE ...]]
                                                     [--autoaddoc
AUTOADDOC]
                                                     [--deferredupdate
{on,off}]
                                                     [--launchfixup
{on,off}]
                                                     [--specific-group-oc
SPECIFIC_GROUP_OC [SPECIFIC_GROUP_OC ...]]
                                                     [--specific-group-filter
SPECIFIC_GROUP_FILTER [SPECIFIC_GROUP_FILTER ...]]
                                                     [--exclude-specific-group-filter
EXCLUDE_SPECIFIC_GROUP_FILTER [EXCLUDE_SPECIFIC_GROUP_FILTER ...]]
                                                     [--config-entry
CONFIG_ENTRY]

โš™๏ธ OPTIONS dsconf plugin memberof set

The full menu of knobs, no gatekeeping ๐ŸŒธ:

  • --attr ATTR โ€” says which attribute in the user entry the Directory Server should manage so it reflects group membership, aka the memberOfAttr โœจ
  • --groupattr GROUPATTR [GROUPATTR ...] โ€” says which attribute in the group entry is used to identify the DNs of group members, aka memberOfGroupAttr
  • --allbackends {on,off} โ€” toggles whether to search the local suffix for user entries across all available suffixes, aka memberOfAllBackends
  • --skipnested {on,off} โ€” toggles whether to skip nested groups or not, aka memberOfSkipNested ๐Ÿช†
  • --scope SCOPE [SCOPE ...] โ€” names the backends or multiple-nested suffixes the MemberOf plug-in should work on, aka memberOfEntryScope
  • --exclude EXCLUDE [EXCLUDE ...] โ€” names the backends or multiple-nested suffixes the MemberOf plug-in should exclude, aka memberOfEntryScopeExcludeSubtree ๐Ÿ™…
  • --autoaddoc AUTOADDOC โ€” if an entry doesn't have an object class that allows the memberOf attribute, the memberOf plugin will automatically add the object class listed in the memberOfAutoAddOC parameter ๐ŸŽ€
  • --deferredupdate {on,off} โ€” says the updates of the members happen after the update of the target group is done. On top of that, each update (group/members) uses its own transaction โณ
  • --launchfixup {on,off} โ€” says that if the server shuts down disorderly (crash, kill, ..) then on restart the memberof fixup task gets launched automatically ๐Ÿ”ง
  • --specific-group-oc SPECIFIC_GROUP_OC [SPECIFIC_GROUP_OC ...] โ€” sets objectclasses for the specific groups to include/exclude. Otherwise all other groups get excluded. Heads up: this replaces all existing values. If you just want to add a new value, use the add-attr command instead, aka memberOfSpecificGroupOC โš ๏ธ
  • --specific-group-filter SPECIFIC_GROUP_FILTER [SPECIFIC_GROUP_FILTER ...] โ€” gives a filter for groups to include. Otherwise all other groups get excluded, aka memberOfSpecificGroupFilter
  • --exclude-specific-group-filter EXCLUDE_SPECIFIC_GROUP_FILTER [EXCLUDE_SPECIFIC_GROUP_FILTER ...] โ€” gives a filter for groups to exclude. Otherwise all other groups get included, aka memberOfExcludeSpecificGroupFilter
  • --config-entry CONFIG_ENTRY โ€” the value to set as nsslapd-pluginConfigArea ๐Ÿ’…

๐Ÿ› ๏ธ COMMAND dsconf plugin memberof add-attr

usage: dsconf [-v] [-j] instance plugin memberof add-attr [-h]
                                                          [--specific-group-filter
SPECIFIC_GROUP_FILTER [SPECIFIC_GROUP_FILTER ...]]
                                                          [--exclude-specific-group-filter
EXCLUDE_SPECIFIC_GROUP_FILTER [EXCLUDE_SPECIFIC_GROUP_FILTER ...]]

โš™๏ธ OPTIONS dsconf plugin memberof add-attr

  • --specific-group-filter SPECIFIC_GROUP_FILTER [SPECIFIC_GROUP_FILTER ...] โ€” gives a filter for groups to include. This adds to the existing values. Otherwise all other groups get excluded, aka memberOfSpecificGroupFilter โž•
  • --exclude-specific-group-filter EXCLUDE_SPECIFIC_GROUP_FILTER [EXCLUDE_SPECIFIC_GROUP_FILTER ...] โ€” gives a filter for groups to exclude. This adds to the existing values. Otherwise all other groups get included, aka memberOfExcludeSpecificGroupFilter โž•

๐Ÿ› ๏ธ COMMAND dsconf plugin memberof del-attr

usage: dsconf [-v] [-j] instance plugin memberof del-attr [-h]
                                                          [--specific-group-filter
SPECIFIC_GROUP_FILTER [SPECIFIC_GROUP_FILTER ...]]
                                                          [--exclude-specific-group-filter
EXCLUDE_SPECIFIC_GROUP_FILTER [EXCLUDE_SPECIFIC_GROUP_FILTER ...]]

โš™๏ธ OPTIONS dsconf plugin memberof del-attr

  • --specific-group-filter SPECIFIC_GROUP_FILTER [SPECIFIC_GROUP_FILTER ...] โ€” removes a filter for groups to include. This removes the value from the existing values, aka memberOfSpecificGroupFilter โž–
  • --exclude-specific-group-filter EXCLUDE_SPECIFIC_GROUP_FILTER [EXCLUDE_SPECIFIC_GROUP_FILTER ...] โ€” removes a filter for groups to exclude. This removes the value from the existing values, aka memberOfExcludeSpecificGroupFilter โž–

๐Ÿ› ๏ธ COMMAND dsconf plugin memberof config-entry

usage: dsconf [-v] [-j] instance plugin memberof config-entry
       [-h] {add,set,add-attr,del-attr,show,delete} ...

๐Ÿ“‹ POSITIONAL ARGUMENTS dsconf plugin memberof config-entry

  • dsconf plugin memberof config-entry add โ€” add the config entry โž•
  • dsconf plugin memberof config-entry set โ€” edit the config entry โœ๏ธ
  • dsconf plugin memberof config-entry add-attr โ€” add attributes to the config entry
  • dsconf plugin memberof config-entry del-attr โ€” delete attributes from the config entry
  • dsconf plugin memberof config-entry show โ€” display the config entry ๐Ÿ‘€
  • dsconf plugin memberof config-entry delete โ€” delete the config entry and remove the reference in the plugin ๐Ÿ—‘๏ธ

๐Ÿ› ๏ธ COMMAND dsconf plugin memberof config-entry add

usage: dsconf [-v] [-j] instance plugin memberof config-entry add
       [-h] [--attr ATTR] [--groupattr GROUPATTR [GROUPATTR ...]]
       [--allbackends {on,off}] [--skipnested {on,off}]
       [--scope SCOPE [SCOPE ...]] [--exclude EXCLUDE [EXCLUDE ...]]
       [--autoaddoc AUTOADDOC] [--deferredupdate {on,off}]
       [--launchfixup {on,off}]
       [--specific-group-oc SPECIFIC_GROUP_OC [SPECIFIC_GROUP_OC ...]]
       [--specific-group-filter SPECIFIC_GROUP_FILTER
[SPECIFIC_GROUP_FILTER ...]]
       [--exclude-specific-group-filter EXCLUDE_SPECIFIC_GROUP_FILTER
[EXCLUDE_SPECIFIC_GROUP_FILTER ...]]
       DN
  • DN โ€” the config entry full DN ๐Ÿ’–

OPTIONS of dsconf plugin memberof config-entry add ๐Ÿ’…

okay bestie, these are the dials you can turn when you're creating a config entry. every single one, no skips:

  • --attr ATTR โ€” the attribute in the user entry that the Directory Server is gonna keep updated so it shows off group membership. in DS speak this is memberOfAttr. ๐ŸŽ€
  • --groupattr GROUPATTR [GROUPATTR ...] โ€” the attribute over in the group entry that holds the DNs of who's in the group. give it one or give it a whole list. its real name is memberOfGroupAttr. โœจ
  • --allbackends {on,off} โ€” flip this and the server will search the local suffix for user entries across all the suffixes that exist. maps to memberOfAllBackends. ๐ŸŒธ
  • --allbackends vibes but nested groups edition: --skipnested {on,off} โ€” tells it whether to skip nested groups or not. it's memberOfSkipNested. ๐Ÿฆ‹
  • --scope SCOPE [SCOPE ...] โ€” picks the backends or multiple-nested suffixes the MemberOf plug-in is allowed to work on. one value or a bunch. memberOfEntryScope. ๐Ÿ’–
  • --exclude EXCLUDE [EXCLUDE ...] โ€” same energy but the opposite direction: the backends / multiple-nested suffixes the MemberOf plug-in should not touch. this one is memberOfEntryScopeExcludeSubtree. ๐Ÿ™ˆ
  • --autoaddoc AUTOADDOC โ€” if an entry is missing an object class that would let the memberOf attribute exist, the plug-in just goes ahead and adds the object class you name here automatically. it lives in memberOfAutoAddOC. โœจ
  • --deferredupdate {on,off} โ€” the members get updated after the target group's update finishes. and btw each update (group / members) gets its own transaction. no sharing. ๐Ÿ’€
  • --launchfixup {on,off} โ€” if the server went out sad and disorderly (crash, kill, โ€ฆ) then on restart the memberof fixup task launches all by itself. main character energy. ๐Ÿ”ฅ
  • --specific-group-oc SPECIFIC_GROUP_OC [SPECIFIC_GROUP_OC ...] โ€” set object classes for the specific groups you want to include/exclude. otherwise every other group gets excluded. heads up: this replaces all existing values. to add a new one instead, use the "add-attr" command. memberOfSpecificGroupOC. ๐ŸŽ€
  • --specific-group-filter SPECIFIC_GROUP_FILTER [SPECIFIC_GROUP_FILTER ...] โ€” a filter for the groups to include. otherwise, yep, all other groups get excluded. memberOfSpecificGroupFilter. ๐ŸŒˆ
  • --exclude-specific-group-filter EXCLUDE_SPECIFIC_GROUP_FILTER [EXCLUDE_SPECIFIC_GROUP_FILTER ...] โ€” a filter for the groups to exclude. otherwise all other groups get included (opposite logic, same drama). memberOfExcludeSpecificGroupFilter. โญ

COMMAND dsconf plugin memberof config-entry set โœ๏ธ

usage: dsconf [-v] [-j] instance plugin memberof config-entry set
       [-h] [--attr ATTR] [--groupattr GROUPATTR [GROUPATTR ...]]
       [--allbackends {on,off}] [--skipnested {on,off}]
       [--scope SCOPE [SCOPE ...]] [--exclude EXCLUDE [EXCLUDE ...]]
       [--autoaddoc AUTOADDOC] [--deferredupdate {on,off}]
       [--launchfixup {on,off}]
       [--specific-group-oc SPECIFIC_GROUP_OC [SPECIFIC_GROUP_OC ...]]
       [--specific-group-filter SPECIFIC_GROUP_FILTER
[SPECIFIC_GROUP_FILTER ...]]
       [--exclude-specific-group-filter EXCLUDE_SPECIFIC_GROUP_FILTER
[EXCLUDE_SPECIFIC_GROUP_FILTER ...]]
       DN
  • DN โ€” the config entry full DN. ๐Ÿซถ

OPTIONS of dsconf plugin memberof config-entry set ๐Ÿ’–

same flags, same meanings, so you already know the lore โ€” but here they are again because we don't gatekeep:

  • --attr ATTR โ€” the attribute in the user entry for the Directory Server to manage so it reflects group membership (memberOfAttr). โœจ
  • --groupattr GROUPATTR [GROUPATTR ...] โ€” the attribute in the group entry used to identify the DNs of group members (memberOfGroupAttr). ๐ŸŽ€
  • --allbackends {on,off} โ€” whether to search the local suffix for user entries on all available suffixes (memberOfAllBackends). ๐ŸŒธ
  • --skipnested {on,off} โ€” whether to skip nested groups or not (memberOfSkipNested). ๐Ÿฆ‹
  • --scope SCOPE [SCOPE ...] โ€” backends or multiple-nested suffixes for the MemberOf plug-in to work on (memberOfEntryScope). ๐Ÿ’…
  • --exclude EXCLUDE [EXCLUDE ...] โ€” backends or multiple-nested suffixes for the MemberOf plug-in to exclude (memberOfEntryScopeExcludeSubtree). ๐Ÿ™ˆ
  • --autoaddoc AUTOADDOC โ€” if an entry doesn't have an object class that allows the memberOf attribute, the plug-in auto-adds the object class named in the memberOfAutoAddOC parameter. โญ
  • --deferredupdate {on,off} โ€” member updates happen after the target group's update completes, and each update (group / members) uses its own transaction. ๐Ÿ’€
  • --launchfixup {on,off} โ€” if the server had a disorderly shutdown (crash, kill, ..) then at restart the memberof fixup task launches automatically. ๐Ÿ”ฅ
  • --specific-group-oc SPECIFIC_GROUP_OC [SPECIFIC_GROUP_OC ...] โ€” object classes for the specific groups to include/exclude, otherwise all other groups get excluded. note: this replaces all existing values; to add a new value use the "add-attr" command. (memberOfSpecificGroupOC) ๐ŸŽ€
  • --specific-group-filter SPECIFIC_GROUP_FILTER [SPECIFIC_GROUP_FILTER ...] โ€” a filter for groups to include; otherwise all other groups are excluded (memberOfSpecificGroupFilter). ๐ŸŒˆ
  • --exclude-specific-group-filter EXCLUDE_SPECIFIC_GROUP_FILTER [EXCLUDE_SPECIFIC_GROUP_FILTER ...] โ€” a filter for groups to exclude; otherwise all other groups are included (memberOfExcludeSpecificGroupFilter). ๐Ÿ’œ

COMMAND dsconf plugin memberof config-entry add-attr โž•

usage: dsconf [-v] [-j] instance plugin memberof config-entry add-attr
       [-h]
       [--specific-group-filter SPECIFIC_GROUP_FILTER
[SPECIFIC_GROUP_FILTER ...]]
       [--exclude-specific-group-filter EXCLUDE_SPECIFIC_GROUP_FILTER
[EXCLUDE_SPECIFIC_GROUP_FILTER ...]]
       DN
  • DN โ€” the config entry full DN. ๐Ÿซถ

OPTIONS of dsconf plugin memberof config-entry add-attr ๐ŸŽ€

  • --specific-group-filter SPECIFIC_GROUP_FILTER [SPECIFIC_GROUP_FILTER ...] โ€” a filter for groups to include. this one adds to the existing values (it doesn't nuke them, bestie ๐Ÿซถ). otherwise all other groups get excluded (memberOfSpecificGroupFilter). โœจ
  • --exclude-specific-group-filter EXCLUDE_SPECIFIC_GROUP_FILTER [EXCLUDE_SPECIFIC_GROUP_FILTER ...] โ€” a filter for groups to exclude, and again it adds to the existing values. otherwise all other groups get included (memberOfExcludeSpecificGroupFilter). ๐ŸŒธ

COMMAND dsconf plugin memberof config-entry del-attr โž–

usage: dsconf [-v] [-j] instance plugin memberof config-entry del-attr
       [-h]
       [--specific-group-filter SPECIFIC_GROUP_FILTER
[SPECIFIC_GROUP_FILTER ...]]
       [--exclude-specific-group-filter EXCLUDE_SPECIFIC_GROUP_FILTER
[EXCLUDE_SPECIFIC_GROUP_FILTER ...]]
       DN
  • DN โ€” the config entry full DN. ๐Ÿ’–

OPTIONS of dsconf plugin memberof config-entry del-attr ๐Ÿฆ‹

  • --specific-group-filter SPECIFIC_GROUP_FILTER [SPECIFIC_GROUP_FILTER ...] โ€” removes a filter for groups to include. it takes the value out of the existing values (memberOfSpecificGroupFilter). ๐Ÿ”ฅ
  • --exclude-specific-group-filter EXCLUDE_SPECIFIC_GROUP_FILTER [EXCLUDE_SPECIFIC_GROUP_FILTER ...] โ€” removes a filter for groups to exclude, also pulling the value out of the existing values (memberOfExcludeSpecificGroupFilter). ๐Ÿ’€

COMMAND dsconf plugin memberof config-entry show ๐Ÿ‘€

usage: dsconf [-v] [-j] instance plugin memberof config-entry show [-h]
DN
  • DN โ€” the config entry full DN. ๐ŸŒˆ

COMMAND dsconf plugin memberof config-entry delete ๐Ÿ—‘๏ธ

usage: dsconf [-v] [-j] instance plugin memberof config-entry delete
[-h] DN
  • DN โ€” the config entry full DN. โญ

COMMAND dsconf plugin memberof fixup ๐Ÿ› ๏ธ

usage: dsconf [-v] [-j] instance plugin memberof fixup [-h] [-f FILTER]
                                                       [--wait]
                                                       [--timeout
TIMEOUT]
                                                       DN
  • DN โ€” Base DN that contains entries to fix up. ๐Ÿซถ

OPTIONS of dsconf plugin memberof fixup ๐Ÿ’…

  • -f FILTER, --filter FILTER โ€” a filter for the entries to fix up. if you omit it, then all entries with objectclass inetuser/inetadmin/nsmemberof under the base you specified get their memberOf attribute regenerated. all of them. ๐Ÿ˜ญ
  • --wait โ€” wait for the task to finish. heads up: this could take a long time. ๐Ÿ•
  • --timeout TIMEOUT โ€” sets the task timeout. default is 0 (no timeout). โœจ

COMMAND dsconf plugin memberof fixup-status ๐Ÿ“Š

usage: dsconf [-v] [-j] instance plugin memberof fixup-status
       [-h] [--dn DN] [--show-log] [--watch]

OPTIONS of dsconf plugin memberof fixup-status ๐Ÿ”

  • --dn DN โ€” the task entry's DN. ๐ŸŽ€
  • --show-log โ€” display the task log. ๐Ÿ“œ
  • --watch โ€” watch the task's status and wait for it to finish. ๐Ÿ‘‘

COMMAND dsconf plugin automember ๐ŸŒŸ

usage: dsconf [-v] [-j] instance plugin automember [-h]
                                                       {show,enable,disable,status,list,definition,fixup,fixup-status,abort-fixup}
       ...

POSITIONAL ARGUMENTS of dsconf plugin automember ๐Ÿงš

  • dsconf plugin automember show โ€” displays the plugin configuration. โœจ
  • dsconf plugin automember enable โ€” enables the plugin. ๐Ÿ”ฅ
  • dsconf plugin automember disable โ€” disables the plugin. ๐Ÿ’ค
  • dsconf plugin automember status โ€” displays the plugin status. ๐Ÿ“ˆ
  • dsconf plugin automember list โ€” list Automembership definitions or regex rules. ๐ŸŒธ
  • dsconf plugin automember definition โ€” manage Automembership definition. ๐ŸŽ€
  • dsconf plugin automember fixup โ€” run a rebuild membership task. ๐Ÿ› ๏ธ
  • dsconf plugin automember fixup-status โ€” check the status of a fix-up task. ๐Ÿ“Š
  • dsconf plugin automember abort-fixup โ€” abort the rebuild membership task. ๐Ÿ›‘ not me aborting but okay!

COMMAND dsconf plugin automember show ๐Ÿ‘€

usage: dsconf [-v] [-j] instance plugin automember show [-h]

COMMAND dsconf plugin automember enable ๐Ÿ”ฅ

usage: dsconf [-v] [-j] instance plugin automember enable [-h]

COMMAND dsconf plugin automember disable ๐Ÿ’ค

usage: dsconf [-v] [-j] instance plugin automember disable [-h]

COMMAND dsconf plugin automember status ๐Ÿ“ˆ

usage: dsconf [-v] [-j] instance plugin automember status [-h]

COMMAND dsconf plugin automember list ๐Ÿ“‹

usage: dsconf [-v] [-j] instance plugin automember list [-h]
                                                          {definitions,regexes}
       ...

POSITIONAL ARGUMENTS of dsconf plugin automember list ๐Ÿฆ‹

  • dsconf plugin automember list definitions โ€” lists Automembership definitions. ๐Ÿ’–
  • dsconf plugin automember list regexes โ€” list Automembership regex rules. ๐ŸŒˆ

COMMAND dsconf plugin automember list definitions ๐Ÿ“

usage: dsconf [-v] [-j] instance plugin automember list definitions [-h]

COMMAND dsconf plugin automember list regexes ๐Ÿงต

usage: dsconf [-v] [-j] instance plugin automember list regexes [-h]
DEFNAME
  • DEFNAME โ€” the definition entry CN. ๐ŸŽ€

it's giving very precise, and honestly? obsessed. ๐Ÿ’œ

๐Ÿฆ‹ COMMAND 'dsconf plugin automember definition'

usage: dsconf [-v] [-j] instance plugin automember definition
       [-h] DEFNAME {add,set,delete,show,regex} ...

Okay bestie, this is the definition layer of automember โ€” the part where you actually tell the plugin the rules of the game. ๐Ÿ’–

POSITIONAL ARGUMENTS 'dsconf plugin automember definition'

  • dsconf plugin automember definition add โ€” Creates Automembership definition. โœจ
  • dsconf plugin automember definition set โ€” Edits Automembership definition. ๐ŸŽ€
  • dsconf plugin automember definition delete โ€” Removes Automembership definition. ๐Ÿ’€
  • dsconf plugin automember definition show โ€” Displays Automembership definition. ๐Ÿ‘€
  • dsconf plugin automember definition regex โ€” Manage Automembership regex rules. ๐Ÿงš

๐ŸŒธ COMMAND 'dsconf plugin automember definition add'

usage: dsconf [-v] [-j] instance plugin automember definition DEFNAME
       add
              [-h] --grouping-attr GROUPING_ATTR [--default-group
       DEFAULT_GROUP]
              --scope SCOPE --filter FILTER

OPTIONS 'dsconf plugin automember definition add'

  • --grouping-attr GROUPING_ATTR โ€” Specifies the name of the member attribute in the group entry and the attribute in the object entry that supplies the member attribute value, in the format group_member_attr:entry_attr (autoMemberGroupingAttr). so like, the two halves of the handshake fr fr ๐Ÿซถ
  • --default-group DEFAULT_GROUP โ€” Sets default or fallback group to add the entry to as a member attribute in group entry (autoMemberDefaultGroup). the backup plan bestie ๐Ÿ’…
  • --scope SCOPE โ€” Sets the subtree DN to search for entries (autoMemberScope). ๐Ÿ”
  • --filter FILTER โ€” Sets a standard LDAP search filter to use to search for matching entries (autoMemberFilter). โœจ

๐ŸŽ€ COMMAND 'dsconf plugin automember definition set'

usage: dsconf [-v] [-j] instance plugin automember definition DEFNAME
       set
              [-h] --grouping-attr GROUPING_ATTR [--default-group
       DEFAULT_GROUP]
              --scope SCOPE --filter FILTER

OPTIONS 'dsconf plugin automember definition set'

  • --grouping-attr GROUPING_ATTR โ€” Specifies the name of the member attribute in the group entry and the attribute in the object entry that supplies the member attribute value, in the format group_member_attr:entry_attr (autoMemberGroupingAttr). ๐Ÿซถ
  • --default-group DEFAULT_GROUP โ€” Sets default or fallback group to add the entry to as a member attribute in group entry (autoMemberDefaultGroup). ๐Ÿ’…
  • --scope SCOPE โ€” Sets the subtree DN to search for entries (autoMemberScope). ๐Ÿ”
  • --filter FILTER โ€” Sets a standard LDAP search filter to use to search for matching entries (autoMemberFilter). โœจ

๐Ÿ’€ COMMAND 'dsconf plugin automember definition delete'

usage: dsconf [-v] [-j] instance plugin automember definition DEFNAME
       delete
              [-h]

no options, it just yeets the definition into the void. say bye ๐Ÿ‘‹


๐Ÿ‘€ COMMAND 'dsconf plugin automember definition show'

usage: dsconf [-v] [-j] instance plugin automember definition DEFNAME
       show
              [-h]

just shows you what the definition is. no options. peek at your own handiwork, main character energy. ๐ŸŒˆ


๐Ÿงš COMMAND 'dsconf plugin automember definition regex'

usage: dsconf [-v] [-j] instance plugin automember definition DEFNAME
       regex
              [-h] REGEXNAME {add,set,delete,show} ...

this is where the regex sorcery lives, bestie. ๐Ÿช„

POSITIONAL ARGUMENTS 'dsconf plugin automember definition regex'

  • dsconf plugin automember definition regex add โ€” Creates Automembership regex. โœจ
  • dsconf plugin automember definition regex set โ€” Edits Automembership regex. ๐ŸŽ€
  • dsconf plugin automember definition regex delete โ€” Removes Automembership regex. ๐Ÿ’€
  • dsconf plugin automember definition regex show โ€” Displays Automembership regex. ๐Ÿ‘€

โœจ COMMAND 'dsconf plugin automember definition regex add'

usage: dsconf [-v] [-j] instance plugin automember definition DEFNAME
       regex REGEXNAME add
              [-h] [--exclusive EXCLUSIVE [EXCLUSIVE ...]]
              [--inclusive INCLUSIVE [INCLUSIVE ...]] --target-group
       TARGET_GROUP

OPTIONS 'dsconf plugin automember definition regex add'

  • --exclusive EXCLUSIVE [EXCLUSIVE ...] โ€” Sets a single regular expression to use to identify entries to exclude (autoMemberExclusiveRegex). not you, not you, absolutely not you ๐Ÿ™ˆ
  • --inclusive INCLUSIVE [INCLUSIVE ...] โ€” Sets a single regular expression to use to identify entries to include (autoMemberInclusiveRegex). come in bestie, you're on the list ๐Ÿ’–
  • --target-group TARGET_GROUP โ€” Sets which group to add the entry to as a member, if it meets the regular expression conditions (autoMemberTargetGroup). the destination, periodt ๐ŸŽฏ

๐ŸŽ€ COMMAND 'dsconf plugin automember definition regex set'

usage: dsconf [-v] [-j] instance plugin automember definition DEFNAME
       regex REGEXNAME set
              [-h] [--exclusive EXCLUSIVE [EXCLUSIVE ...]]
              [--inclusive INCLUSIVE [INCLUSIVE ...]] --target-group
       TARGET_GROUP

OPTIONS 'dsconf plugin automember definition regex set'

  • --exclusive EXCLUSIVE [EXCLUSIVE ...] โ€” Sets a single regular expression to use to identify entries to exclude (autoMemberExclusiveRegex). ๐Ÿ™ˆ
  • --inclusive INCLUSIVE [INCLUSIVE ...] โ€” Sets a single regular expression to use to identify entries to include (autoMemberInclusiveRegex). ๐Ÿ’–
  • --target-group TARGET_GROUP โ€” Sets which group to add the entry to as a member, if it meets the regular expression conditions (autoMemberTargetGroup). ๐ŸŽฏ

๐Ÿ’€ COMMAND 'dsconf plugin automember definition regex delete'

usage: dsconf [-v] [-j] instance plugin automember definition DEFNAME
       regex REGEXNAME delete
              [-h]

no options. gone. reduced to atoms. โœจ


๐Ÿ‘€ COMMAND 'dsconf plugin automember definition regex show'

usage: dsconf [-v] [-j] instance plugin automember definition DEFNAME
       regex REGEXNAME show
              [-h]

no options, just vibes and output. ๐Ÿฆ‹


๐Ÿ”ฅ COMMAND 'dsconf plugin automember fixup'

usage: dsconf [-v] [-j] instance plugin automember fixup [-h] -f FILTER
                                                                -s
       {sub,base,one}
                                                                [--cleanup]
       [--wait]
                                                                [--timeout
       TIMEOUT]
                                                                DN

       DN     Base DN that contains entries to fix up

DN โ€” Base DN that contains entries to fix up ๐Ÿซถ

OPTIONS 'dsconf plugin automember fixup'

  • -f FILTER, --filter FILTER โ€” Sets the LDAP filter for entries to fix up. ๐Ÿ”
  • -s {sub,base,one}, --scope {sub,base,one} โ€” Sets the LDAP search scope for entries to fix up. ๐Ÿ“
  • --cleanup โ€” Clean up previous group memberships before rebuilding. ๐Ÿงน
  • --wait โ€” Wait for the task to finish, this could take a long time. โณ (fr fr, be patient bestie)
  • --timeout TIMEOUT โ€” Set a timeout to wait for the fixup task. Default is 0 (no timeout). โŒ›

๐Ÿฆ‹ COMMAND 'dsconf plugin automember fixup-status'

usage: dsconf [-v] [-j] instance plugin automember fixup-status
       [-h] [--dn DN] [--show-log] [--watch]

OPTIONS 'dsconf plugin automember fixup-status'

  • --dn DN โ€” The task entry's DN. ๐Ÿ“Œ
  • --show-log โ€” Display the task log. ๐Ÿ“œ
  • --watch โ€” Watch the task's status and wait for it to finish. ๐Ÿ‘€

๐Ÿ˜ญ COMMAND 'dsconf plugin automember abort-fixup'

usage: dsconf [-v] [-j] instance plugin automember abort-fixup
       [-h] [--timeout TIMEOUT]

OPTIONS 'dsconf plugin automember abort-fixup'

  • --timeout TIMEOUT โ€” Set a timeout to wait for the abort task. Default is 0 (no timeout). โŒ›

๐Ÿ’œ COMMAND 'dsconf plugin referential-integrity'

usage: dsconf instance [-v] [-j] plugin referential-integrity
       [-h] {show,enable,disable,status,set,config-entry} ...

Referential integrity, aka the plugin that keeps your groups from ghosting deleted users. iconic behaviour, honestly. ๐Ÿ‘‘

POSITIONAL ARGUMENTS 'dsconf plugin referential-integrity'

  • dsconf plugin referential-integrity show โ€” Displays the plugin configuration. ๐Ÿ‘€
  • dsconf plugin referential-integrity enable โ€” Enables the plugin. โœ…
  • dsconf plugin referential-integrity disable โ€” Disables the plugin. ๐Ÿšซ
  • dsconf plugin referential-integrity status โ€” Displays the plugin status. ๐Ÿ“Š
  • dsconf plugin referential-integrity set โ€” Edit the plugin settings. โœ๏ธ
  • dsconf plugin referential-integrity config-entry โ€” Manage the config entry. ๐Ÿ—‚๏ธ

๐Ÿ‘€ COMMAND 'dsconf plugin referential-integrity show'

usage: dsconf [-v] [-j] instance plugin referential-integrity show [-h]

no options. just look at it. ๐Ÿ’…


โœ… COMMAND 'dsconf plugin referential-integrity enable'

usage: dsconf [-v] [-j] instance plugin referential-integrity enable
       [-h]

no options, just turn it on. slay. โœจ


๐Ÿšซ COMMAND 'dsconf plugin referential-integrity disable'

usage: dsconf [-v] [-j] instance plugin referential-integrity disable
       [-h]

no options, turn it off. ๐Ÿ˜ด


๐Ÿ“Š COMMAND 'dsconf plugin referential-integrity status'

usage: dsconf [-v] [-j] instance plugin referential-integrity status
       [-h]

no options, pure status check energy. ๐Ÿ”


โœ๏ธ COMMAND 'dsconf plugin referential-integrity set'

usage: dsconf [-v] [-j] instance plugin referential-integrity set
       [-h] [--update-delay UPDATE_DELAY]
       [--membership-attr MEMBERSHIP_ATTR [MEMBERSHIP_ATTR ...]]
       [--entry-scope ENTRY_SCOPE] [--exclude-entry-scope
       EXCLUDE_ENTRY_SCOPE]
       [--container-scope CONTAINER_SCOPE] [--log-file LOG_FILE]
       [--config-entry CONFIG_ENTRY]

OPTIONS 'dsconf plugin referential-integrity set'

  • --update-delay UPDATE_DELAY โ€” Sets the update interval. Special values: 0 โ€” The check is performed immediately, -1 โ€” No check is performed (referint-update-delay). โฐ two very different vibes, pick wisely
  • --membership-attr MEMBERSHIP_ATTR [MEMBERSHIP_ATTR ...] โ€” Specifies attributes to check for and update (referint-membership-attr). ๐Ÿซถ
  • --entry-scope ENTRY_SCOPE โ€” Defines the subtree in which the plug-in looks for the delete or rename operations of a user entry (nsslapd-pluginEntryScope). ๐Ÿ“
  • --exclude-entry-scope EXCLUDE_ENTRY_SCOPE โ€” Defines the subtree in which the plug-in ignores any operations for deleting or renaming a user (nsslapd-pluginExcludeEntryScope). ๐Ÿ™ˆ
  • --container-scope CONTAINER_SCOPE โ€” Specifies which branch the plug-in searches for the groups to which the user belongs. It only updates groups that are under the specified container branch, and leaves all other groups not updated (nsslapd-pluginContainerScope). ๐Ÿ—‚๏ธ
  • --log-file LOG_FILE โ€” Specifies a path to the Referential integrity logfile.For example: /var/log/dirsrv/slapd-YOUR_INSTANCE/referint ๐Ÿ“œ
  • --config-entry CONFIG_ENTRY โ€” The value to set as nsslapd-pluginConfigArea. ๐ŸŽ€

๐Ÿ—‚๏ธ COMMAND 'dsconf plugin referential-integrity config-entry'

usage: dsconf [-v] [-j] instance plugin referential-integrity
       config-entry
       [-h] {add,set,show,delete} ...

POSITIONAL ARGUMENTS 'dsconf plugin referential-integrity config-entry'

  • dsconf plugin referential-integrity config-entry add โ€” Add the config entry. โœจ
  • dsconf plugin referential-integrity config-entry set โ€” Edit the config entry. โœ๏ธ
  • dsconf plugin referential-integrity config-entry show โ€” Display the config entry. ๐Ÿ‘€
  • dsconf plugin referential-integrity config-entry delete โ€” Delete the config entry and remove the reference in the plugin entry. ๐Ÿ’€

๐ŸŽ€ COMMAND 'dsconf plugin referential-integrity config-entry add'

okay bestie, this one creates a fresh referential-integrity config entry and you get to dial in all the little knobs while you do it. here's the shape of it:

usage: dsconf [-v] [-j] instance plugin referential-integrity
config-entry add
       [-h] [--update-delay UPDATE_DELAY]
       [--membership-attr MEMBERSHIP_ATTR [MEMBERSHIP_ATTR ...]]
       [--entry-scope ENTRY_SCOPE] [--exclude-entry-scope
EXCLUDE_ENTRY_SCOPE]
       [--container-scope CONTAINER_SCOPE] [--log-file LOG_FILE]
       DN

POSITIONAL ARGUMENTS 'dsconf plugin referential-integrity config-entry add'

  • DN โ€” the config entry's full DN, bestie. that's it, that's the whole job. ๐Ÿ’…

OPTIONS 'dsconf plugin referential-integrity config-entry add'

  • --update-delay UPDATE_DELAY โ€” sets how often the check runs. โœจ special little values: 0 means the check happens immediately, and -1 means no check at all. (this maps to referint-update-delay)
  • --membership-attr MEMBERSHIP_ATTR [MEMBERSHIP_ATTR ...] โ€” tells it which attrs to check and update. you can list more than one, go off. (this is referint-membership-attr)
  • --entry-scope ENTRY_SCOPE โ€” defines the subtree where the plug-in goes looking for delete or rename operations on a user entry. (that's nsslapd-pluginEntryScope)
  • --exclude-entry-scope EXCLUDE_ENTRY_SCOPE โ€” defines the subtree where the plug-in straight up ignores any delete-or-rename operations on a user. it's giving boundaries. (that's nsslapd-pluginExcludeEntryScope)
  • --container-scope CONTAINER_SCOPE โ€” says which branch the plug-in should search for the groups the user belongs to. it will only update groups under that container branch and leaves every other group untouched, no cap. (that's nsslapd-pluginContainerScope)
  • --log-file LOG_FILE โ€” gives you a path for the Referential integrity logfile.For example: /var/log/dirsrv/slapd-YOUR_INSTANCE/referint ๐Ÿซถ

๐Ÿฆ‹ COMMAND 'dsconf plugin referential-integrity config-entry set'

same energy, but this one edits the config entry you already have. it's the glow-up command:

usage: dsconf [-v] [-j] instance plugin referential-integrity
config-entry set
       [-h] [--update-delay UPDATE_DELAY]
       [--membership-attr MEMBERSHIP_ATTR [MEMBERSHIP_ATTR ...]]
       [--entry-scope ENTRY_SCOPE] [--exclude-entry-scope
EXCLUDE_ENTRY_SCOPE]
       [--container-scope CONTAINER_SCOPE] [--log-file LOG_FILE]
       DN

POSITIONAL ARGUMENTS 'dsconf plugin referential-integrity config-entry set'

  • DN โ€” the config entry's full DN. you're pointing at the one you wanna change. โœจ

OPTIONS 'dsconf plugin referential-integrity config-entry set'

  • --update-delay UPDATE_DELAY โ€” sets the update interval. the special values again, bestie: 0 = the check is performed immediately, -1 = no check is performed. (this is referint-update-delay)
  • --membership-attr MEMBERSHIP_ATTR [MEMBERSHIP_ATTR ...] โ€” specifies which attributes to check for and update. (this is referint-membership-attr)
  • --entry-scope ENTRY_SCOPE โ€” defines the subtree where the plug-in looks for delete or rename operations of a user entry. (that's nsslapd-pluginEntryScope)
  • --exclude-entry-scope EXCLUDE_ENTRY_SCOPE โ€” defines the subtree where the plug-in ignores any operations for deleting or renaming a user. not today, delete operation. ๐Ÿ™ˆ (that's nsslapd-pluginExcludeEntryScope)
  • --container-scope CONTAINER_SCOPE โ€” specifies which branch the plug-in searches for the groups the user belongs to. it only updates groups that are under the specified container branch, and leaves all other groups not updated. (that's nsslapd-pluginContainerScope)
  • --log-file LOG_FILE โ€” specifies a path to the Referential integrity logfile.For example: /var/log/dirsrv/slapd-YOUR_INSTANCE/referint ๐ŸŒธ

โญ COMMAND 'dsconf plugin referential-integrity config-entry show'

just look at it. that's the vibe. ๐Ÿ’–

usage: dsconf [-v] [-j] instance plugin referential-integrity
config-entry show
       [-h] DN
  • DN โ€” the config entry's full DN. โœจ

๐Ÿ’€ COMMAND 'dsconf plugin referential-integrity config-entry delete'

and this one removes it. bye bestie, no notes. ๐Ÿซถ

usage: dsconf [-v] [-j] instance plugin referential-integrity
config-entry delete
       [-h] DN
  • DN โ€” the config entry's full DN. โœจ

๐Ÿ‘‘ COMMAND 'dsconf plugin root-dn'

the root-dn plug-in, aka the bouncer at the club door deciding who gets root access. it's got a whole lil family of subcommands:

usage: dsconf [-v] [-j] instance plugin root-dn [-h]
                                                    {show,enable,disable,status,set}
       ...

POSITIONAL ARGUMENTS 'dsconf plugin root-dn'

  • dsconf plugin root-dn show โ€” displays the plugin configuration
  • dsconf plugin root-dn enable โ€” enables the plugin
  • dsconf plugin root-dn disable โ€” disables the plugin
  • dsconf plugin root-dn status โ€” displays the plugin status
  • dsconf plugin root-dn set โ€” edit the plugin settings

COMMAND 'dsconf plugin root-dn show'

usage: dsconf [-v] [-j] instance plugin root-dn show [-h]

COMMAND 'dsconf plugin root-dn enable'

usage: dsconf [-v] [-j] instance plugin root-dn enable [-h]

COMMAND 'dsconf plugin root-dn disable'

usage: dsconf [-v] [-j] instance plugin root-dn disable [-h]

COMMAND 'dsconf plugin root-dn status'

usage: dsconf [-v] [-j] instance plugin root-dn status [-h]

๐Ÿ”ฅ COMMAND 'dsconf plugin root-dn set'

this is the big one where you actually write the guest list. so many options, so much power, main character energy fr fr:

usage: dsconf [-v] [-j] instance plugin root-dn set [-h]
                                                    [--allow-host
ALLOW_HOST [ALLOW_HOST ...]]
                                                    [--deny-host
DENY_HOST [DENY_HOST ...]]
                                                    [--allow-ip ALLOW_IP
[ALLOW_IP ...]]
                                                    [--deny-ip DENY_IP
[DENY_IP ...]]
                                                    [--open-time
OPEN_TIME]
                                                    [--close-time
CLOSE_TIME]
                                                    [--days-allowed
DAYS_ALLOWED]

OPTIONS 'dsconf plugin root-dn set'

  • --allow-host ALLOW_HOST [ALLOW_HOST ...] โ€” sets which hosts, by fully-qualified domain name, the root user is allowed to use to access Directory Server. any hosts not listed are implicitly denied. ๐Ÿ’… (that's rootdn-allow-host)
  • --deny-host DENY_HOST [DENY_HOST ...] โ€” sets which hosts, by fully-qualified domain name, the root user is not allowed to use to access Directory Server. any hosts not listed are implicitly allowed. (that's rootdn-deny-host) โš ๏ธ and listen: if a host address shows up in both rootdn-allow-host and rootdn-deny-host, it gets denied access. deny wins, periodt.
  • --allow-ip ALLOW_IP [ALLOW_IP ...] โ€” sets which IP addresses, either IPv4 or IPv6, for machines the root user is allowed to use to access Directory Server. any IP addresses not listed are implicitly denied. (that's rootdn-allow-ip)
  • --deny-ip DENY_IP [DENY_IP ...] โ€” sets which IP addresses, either IPv4 or IPv6, for machines the root user is not allowed to use to access Directory Server. any IP addresses not listed are implicitly allowed. (that's rootdn-deny-ip) โš ๏ธ same rule as the host one: if an IP address is listed in both rootdn-allow-ip and rootdn-deny-ip, it is denied access.
  • --open-time OPEN_TIME โ€” sets part of a time period or range when the root user is allowed to access Directory Server. this one sets when the time-based access begins. (that's rootdn-open- time)
  • --close-time CLOSE_TIME โ€” sets part of a time period or range when the root user is allowed to access Directory Server. this one sets when the time-based access ends. (that's rootdn-close- time)
  • --days-allowed DAYS_ALLOWED โ€” sets a comma-separated list of what days the root user is allowed to use to access Directory Server. any days listed are implicitly denied. (that's rootdn-days- allowed)

๐ŸŒˆ COMMAND 'dsconf plugin usn'

the USN plug-in! unique sequence numbers, living their best life. here's the whole roster:

usage: dsconf [-v] [-j] instance plugin usn [-h]
                                            {show,enable,disable,status,global,cleanup}
       ...

POSITIONAL ARGUMENTS 'dsconf plugin usn'

  • dsconf plugin usn show โ€” displays the plugin configuration
  • dsconf plugin usn enable โ€” enables the plugin
  • dsconf plugin usn disable โ€” disables the plugin
  • dsconf plugin usn status โ€” displays the plugin status
  • dsconf plugin usn global โ€” get or manage global USN mode (nsslapd-entryusn-global)
  • dsconf plugin usn cleanup โ€” runs the USN tombstone cleanup task

COMMAND 'dsconf plugin usn show'

usage: dsconf [-v] [-j] instance plugin usn show [-h]

COMMAND 'dsconf plugin usn enable'

usage: dsconf [-v] [-j] instance plugin usn enable [-h]

COMMAND 'dsconf plugin usn disable'

usage: dsconf [-v] [-j] instance plugin usn disable [-h]

COMMAND 'dsconf plugin usn status'

usage: dsconf [-v] [-j] instance plugin usn status [-h]

๐Ÿงš COMMAND 'dsconf plugin usn global'

global mode moment. it's on or it's off, no in-between:

usage: dsconf [-v] [-j] instance plugin usn global [-h] {on,off} ...

POSITIONAL ARGUMENTS 'dsconf plugin usn global'

  • dsconf plugin usn global on โ€” enables USN global mode
  • dsconf plugin usn global off โ€” disables USN global mode

COMMAND 'dsconf plugin usn global on'

usage: dsconf [-v] [-j] instance plugin usn global on [-h]

COMMAND 'dsconf plugin usn global off'

usage: dsconf [-v] [-j] instance plugin usn global off [-h]

๐Ÿ’œ COMMAND 'dsconf plugin usn cleanup'

sweeping up those tombstones ๐Ÿชฆโœจ โ€” and bestie, heads up, you must give it either a suffix or a backend:

usage: dsconf [-v] [-j] instance plugin usn cleanup [-h] (-s SUFFIX |
                                                    -n BACKEND) [-m
MAX_USN]
                                                    [--timeout TIMEOUT]

OPTIONS 'dsconf plugin usn cleanup'

  • -s SUFFIX, --suffix SUFFIX โ€” sets the suffix or subtree in Directory Server to run the cleanup operation against. if the suffix is not specified, then the back end must be specified. (that's suffix)
  • -n BACKEND, --backend BACKEND โ€” sets the Directory Server instance back end, or database, to run the cleanup operation against. if the back end is not specified, then the suffix must be specified. Backend instance in which USN tombstone entries (that's backend)
  • -m MAX_USN, --max-usn MAX_USN โ€” sets the highest USN value to delete when removing tombstone entries. (that's max_usn_to_delete)
  • --timeout TIMEOUT โ€” sets the cleanup task timeout. Default is 120 seconds,

๐Ÿ“ COMMAND 'dsconf plugin account-policy'

account policy time! rules for accounts, the responsible icon behavior. look at this subcommand lineup:

usage: dsconf [-v] [-j] instance plugin account-policy [-h]
                                                           {show,enable,disable,status,set,config-entry}
       ...

POSITIONAL ARGUMENTS 'dsconf plugin account-policy'

  • dsconf plugin account-policy show โ€” displays the plugin configuration
  • dsconf plugin account-policy enable โ€” enables the plugin
  • dsconf plugin account-policy disable โ€” disables the plugin
  • dsconf plugin account-policy status โ€” displays the plugin status
  • dsconf plugin account-policy set โ€” edit the plugin settings
  • dsconf plugin account-policy config-entry โ€” manage the config entry

COMMAND 'dsconf plugin account-policy show'

usage: dsconf [-v] [-j] instance plugin account-policy show [-h]

COMMAND 'dsconf plugin account-policy enable'

usage: dsconf [-v] [-j] instance plugin account-policy enable [-h]

COMMAND 'dsconf plugin account-policy disable'

usage: dsconf [-v] [-j] instance plugin account-policy disable [-h]

and that's where we pause, bestie โ€” there's more coming, don't you dare close the tab ๐Ÿ’–

โœจ COMMAND 'dsconf plugin account-policy status' โœจ

okay bestie, vibe check on the account policy plugin โ€” is it alive, is it dead, what's the tea? This one just peeks at it. ๐Ÿซถ

usage: dsconf [-v] [-j] instance plugin account-policy status [-h]

๐ŸŒธ COMMAND 'dsconf plugin account-policy set' ๐ŸŒธ

Customizing the plugin's setup. It takes exactly one knob, and that knob is about which entry holds the config. ๐ŸŽ€

usage: dsconf [-v] [-j] instance plugin account-policy set [-h]
                                                           [--config-entry
       CONFIG_ENTRY]

โญ OPTIONS 'dsconf plugin account-policy set' โญ

  • --config-entry CONFIG_ENTRY โ€” sets the nsslapd-pluginarg0 attribute. That's the one. That's the whole job. ๐Ÿ’…

๐Ÿฆ‹ COMMAND 'dsconf plugin account-policy config-entry' ๐Ÿฆ‹

The big one โ€” this is where you actually manage the config entry itself, and it's got a whole little command family under it: {add,set,show,delete}. Main character energy fr fr. ๐Ÿ‘‘

usage: dsconf [-v] [-j] instance plugin account-policy config-entry
       [-h] {add,set,show,delete} ...

๐ŸŒˆ POSITIONAL ARGUMENTS 'dsconf plugin account-policy config-entry' ๐ŸŒˆ

  • dsconf plugin account-policy config-entry add โ€” add the config entry โœจ
  • dsconf plugin account-policy config-entry set โ€” edit the config entry โœ๏ธ
  • dsconf plugin account-policy config-entry show โ€” display the config entry ๐Ÿ‘€
  • dsconf plugin account-policy config-entry delete โ€” delete the config entry and remove the reference in the plugin entry. So it cleans up after itself, we love a tidy icon. ๐Ÿงน

๐Ÿ’œ COMMAND 'dsconf plugin account-policy config-entry add' ๐Ÿ’œ

Brand new config entry, freshly made, no cap. You give it a DN and it takes a whole pile of settings. ๐Ÿ“

usage: dsconf [-v] [-j] instance plugin account-policy config-entry add
       [-h] [--always-record-login {yes,no}] [--alt-state-attr
       ALT_STATE_ATTR]
       [--always-record-login-attr ALWAYS_RECORD_LOGIN_ATTR]
       [--limit-attr LIMIT_ATTR] [--spec-attr SPEC_ATTR]
       [--state-attr STATE_ATTR] [--login-history-size
       LOGIN_HISTORY_SIZE]
       [--check-all-state-attrs {yes,no}]
       DN
  • DN โ€” the full DN of the config entry. Literally what it says, the whole thing, not a vibe, an actual DN. ๐Ÿ’–

โœจ OPTIONS 'dsconf plugin account-policy config-entry add' โœจ

  • --always-record-login {yes,no} โ€” sets that every entry records its last login time (alwaysRecordLogin). Yes = everybody's timestamped, no = we move mysterious. ๐Ÿ™ˆ
  • --alt-state-attr ALT_STATE_ATTR โ€” provides a backup attribute for the server to reference to evaluate the expiration time (altStateAttrName). Backup plan, always prepared. ๐Ÿซถ
  • --always-record-login-attr ALWAYS_RECORD_LOGIN_ATTR โ€” specifies the attribute to store the time of the last successful login in this attribute in the users directory entry (alwaysRecordLoginAttr). That's where the login time gets written, iykyk. โญ
  • --limit-attr LIMIT_ATTR โ€” specifies the attribute within the policy to use for the account inactivation limit (limitAttrName). When the account gets the little sleep, this is the att r that says so. ๐Ÿ˜ญ
  • --spec-attr SPEC_ATTR โ€” specifies the attribute to identify which entries are account policy configuration entries (specAttrName). It's the "I'm a config entry" name tag. ๐Ÿท๏ธ
  • --state-attr STATE_ATTR โ€” specifies the primary time attribute used to evaluate an account policy (stateAttrName). The main clock, the one that matters. ๐Ÿ”ฅ
  • --login-history-size LOGIN_HISTORY_SIZE โ€” specifies the number of login timestamps to store (lastLoginHistorySize). How deep the receipts go. ๐Ÿ’€
  • --check-all-state-attrs {yes,no} โ€” check both state and alternate state attributes for account state. Two attrs, one check. ๐Ÿ’…

๐ŸŽ€ COMMAND 'dsconf plugin account-policy config-entry set' ๐ŸŽ€

Same energy as add, but you're editing something that already exists. Glow up for your config entry. ๐ŸŒธ

usage: dsconf [-v] [-j] instance plugin account-policy config-entry set
       [-h] [--always-record-login {yes,no}] [--alt-state-attr
       ALT_STATE_ATTR]
       [--always-record-login-attr ALWAYS_RECORD_LOGIN_ATTR]
       [--limit-attr LIMIT_ATTR] [--spec-attr SPEC_ATTR]
       [--state-attr STATE_ATTR] [--login-history-size
       LOGIN_HISTORY_SIZE]
       [--check-all-state-attrs {yes,no}]
       DN
  • DN โ€” the full DN of the config entry. Yes, again. It's the address, bestie. ๐Ÿ“

๐Ÿ’– OPTIONS 'dsconf plugin account-policy config-entry set' ๐Ÿ’–

  • --always-record-login {yes,no} โ€” sets that every entry records its last login time (alwaysRecordLogin). โฐ
  • --alt-state-attr ALT_STATE_ATTR โ€” provides a backup attribute for the server to reference to evaluate the expiration time (altStateAttrName). ๐Ÿ›Ÿ
  • --always-record-login-attr ALWAYS_RECORD_LOGIN_ATTR โ€” specifies the attribute to store the time of the last successful login in this attribute in the users directory entry (alwaysRecordLoginAttr). โœ๏ธ
  • --limit-attr LIMIT_ATTR โ€” specifies the attribute within the policy to use for the account inactivation limit (limitAttrName). โ›”
  • --spec-attr SPEC_ATTR โ€” specifies the attribute to identify which entries are account policy configuration entries (specAttrName). ๐Ÿท๏ธ
  • --state-attr STATE_ATTR โ€” specifies the primary time attribute used to evaluate an account policy (stateAttrName). ๐Ÿ•ฐ๏ธ
  • --login-history-size LOGIN_HISTORY_SIZE โ€” specifies the number of login timestamps to store (lastLoginHistorySize). ๐Ÿ“š
  • --check-all-state-attrs {yes,no} โ€” check both state and alternate state attributes for account state. โœ…

๐Ÿ” COMMAND 'dsconf plugin account-policy config-entry show' ๐Ÿ”

Just show me the config entry. That's it. That's the whole command. She's lowkey simple and we respect her for it. ๐Ÿ’œ

usage: dsconf [-v] [-j] instance plugin account-policy config-entry show
       [-h] DN
  • DN โ€” the full DN of the config entry. ๐Ÿ’ซ

๐Ÿ—‘๏ธ COMMAND 'dsconf plugin account-policy config-entry delete' ๐Ÿ—‘๏ธ

Gone. Deleted. Not coming back. And remember, this one also yanks out the reference in the plugin entry, so nothing's left dangling. Clean exit, iconic behavior. ๐Ÿ”ฅ

usage: dsconf [-v] [-j] instance plugin account-policy config-entry
       delete
       [-h] DN
  • DN โ€” the full DN of the config entry. ๐Ÿ’€

๐Ÿฆ„ COMMAND 'dsconf plugin attr-uniq' ๐Ÿฆ„

attribute uniqueness time!! This plugin's whole deal is making sure a value shows up exactly once and nowhere else. It's got a whole command tree so you can poke at individual configs. ๐ŸŒˆ

usage: dsconf [-v] [-j] instance plugin attr-uniq [-h]
                                                         {list,add,set,show,delete,enable,disable,status}
       ...

๐ŸŒŸ POSITIONAL ARGUMENTS 'dsconf plugin attr-uniq' ๐ŸŒŸ

  • dsconf plugin attr-uniq list โ€” lists available plugin configs ๐Ÿ“‹
  • dsconf plugin attr-uniq add โ€” add the config entry โž•
  • dsconf plugin attr-uniq set โ€” edit the config entry โœ๏ธ
  • dsconf plugin attr-uniq show โ€” display the config entry ๐Ÿ‘€
  • dsconf plugin attr-uniq delete โ€” delete the config entry ๐Ÿ—‘๏ธ
  • dsconf plugin attr-uniq enable โ€” enable plugin ๐ŸŸข
  • dsconf plugin attr-uniq disable โ€” disable plugin ๐Ÿ”ด
  • dsconf plugin attr-uniq status โ€” display plugin status ๐Ÿ“Š

๐Ÿ’… COMMAND 'dsconf plugin attr-uniq list' ๐Ÿ’…

Shows you all the available plugin configs. No arguments, no drama, just a list. ๐ŸŽ€

usage: dsconf [-v] [-j] instance plugin attr-uniq list [-h]

๐Ÿ“ COMMAND 'dsconf plugin attr-uniq add' ๐Ÿ“

Making a fresh uniqueness config. It's got so many options and honestly every single one of them is doing something real. ๐Ÿซถ

usage: dsconf [-v] [-j] instance plugin attr-uniq add [-h]
                                                             [--enabled
       {on,off}]
                                                             [--attr-name
       ATTR_NAME [ATTR_NAME ...]]
                                                             [--subtree SUBTREE
       [SUBTREE ...]]
                                                             [--exclude-subtree
       EXCLUDE_SUBTREE [EXCLUDE_SUBTREE ...]]
                                                             [--across-all-subtrees
       {on,off}]
                                                             [--top-entry-oc
       TOP_ENTRY_OC]
                                                             [--subtree-entries-oc
       SUBTREE_ENTRIES_OC]
                                                             NAME
  • NAME โ€” the name of the plug-in configuration record. (cn) You can use any string, but "attribute_name Attribute Uniqueness" is recommended. Like, literally any string works, but that format is the moment. โญ

โœจ OPTIONS 'dsconf plugin attr-uniq add' โœจ

  • --enabled {on,off} โ€” identifies whether or not the config is enabled. ๐ŸŸข
  • --attr-name ATTR_NAME [ATTR_NAME ...] โ€” sets the name of the attribute whose values must be unique. This attribute is multi-valued. (uniqueness-attribute-name) โ€” and yes, it's multi-valued, so you can stack them. ๐Ÿ“š
  • --subtree SUBTREE [SUBTREE ...] โ€” sets the DN under which the plug-in checks for uniqueness of the attributes value. This attribute is multi-valued (uniqueness-subtrees). Multi-valued again, we love options. ๐ŸŒณ
  • --exclude-subtree EXCLUDE_SUBTREE [EXCLUDE_SUBTREE ...] โ€” sets subtrees that should be excluded from attribute uniqueness checks. This attribute is multi-valued (uniqueness-exclude-subtrees). The "not these ones" list. ๐Ÿšซ
  • --across-all-subtrees {on,off} โ€” if enabled (on), the plug-in checks that the attribute is unique across all subtrees set. If you set the attribute to off, uniqueness is only enforced within the subtree of the updated entry (uniqueness-across-all-subtrees). So: one big check, or one small check. Big difference. ๐Ÿ”
  • --top-entry-oc TOP_ENTRY_OC โ€” verifies that the value of the attribute set in uniqueness-attribute-name is unique in this subtree (uniqueness-top-entry-oc). ๐ŸŽฏ
  • --subtree-entries-oc SUBTREE_ENTRIES_OC โ€” verifies if an attribute is unique, if the entry contains the object class set in this parameter (uniqueness-subtree-entries-oc). Conditional uniqueness, fancy. ๐Ÿ’…

๐ŸŒธ COMMAND 'dsconf plugin attr-uniq set' ๐ŸŒธ

Editing an existing uniqueness config instead of making a new one. Same option set, same energy, just applied to something that already exists. ๐Ÿฆ‹

usage: dsconf [-v] [-j] instance plugin attr-uniq set [-h]
                                                             [--enabled
       {on,off}]
                                                             [--attr-name
       ATTR_NAME [ATTR_NAME ...]]
                                                             [--subtree SUBTREE
       [SUBTREE ...]]
                                                             [--exclude-subtree
       EXCLUDE_SUBTREE [EXCLUDE_SUBTREE ...]]
                                                             [--across-all-subtrees
       {on,off}]
                                                             [--top-entry-oc
       TOP_ENTRY_OC]
                                                             [--subtree-entries-oc
       SUBTREE_ENTRIES_OC]
                                                             NAME
  • NAME โ€” the name of the plug-in configuration record. (cn) You can use any string, but "attribute_name Attribute Uniqueness" is recommended. ๐ŸŽ€

๐Ÿ’– OPTIONS 'dsconf plugin attr-uniq set' ๐Ÿ’–

  • --enabled {on,off} โ€” identifies whether or not the config is enabled. โšก
  • --attr-name ATTR_NAME [ATTR_NAME ...] โ€” sets the name of the attribute whose values must be unique. This attribute is multi-valued. (uniqueness-attribute-name) ๐ŸŒŸ
  • --subtree SUBTREE [SUBTREE ...] โ€” sets the DN under which the plug-in checks for uniqueness of the attributes value. This attribute is multi-valued (uniqueness-subtrees). ๐ŸŒฒ
  • --exclude-subtree EXCLUDE_SUBTREE [EXCLUDE_SUBTREE ...] โ€” sets subtrees that should be excluded from attribute uniqueness checks. This attribute is multi-valued (uniqueness-exclude-subtrees). ๐Ÿ™…
  • --across-all-subtrees {on,off} โ€” if enabled (on), the plug-in checks that the attribute is unique across all subtrees set. If you set the attribute to off, uniqueness is only enforced within the subtree of the updated entry (uniqueness-across-all-subtrees). ๐ŸŽช
  • --top-entry-oc TOP_ENTRY_OC โ€” verifies that the value of the attribute set in uniqueness-attribute-name is unique in this subtree (uniqueness-top-entry-oc). ๐Ÿ“Œ
  • --subtree-entries-oc SUBTREE_ENTRIES_OC โ€” verifies if an attribute is unique, if the entry contains the object class set in this parameter (uniqueness-subtree-entries-oc). ๐Ÿงš

๐Ÿ‘€ COMMAND 'dsconf plugin attr-uniq show' ๐Ÿ‘€

Pulls up one config record so you can look at it. Just the name, nothing else. ๐Ÿ’œ

usage: dsconf [-v] [-j] instance plugin attr-uniq show [-h] NAME
  • NAME โ€” the name of the plug-in configuration record. ๐Ÿท๏ธ

๐Ÿ’€ COMMAND 'dsconf plugin attr-uniq delete' ๐Ÿ’€

Deleting a plug-in configuration record. Give it the name, it's out. Periodt. ๐Ÿ”ฅ

usage: dsconf [-v] [-j] instance plugin attr-uniq delete [-h] NAME
  • NAME โ€” the name of the plug-in configuration record. โœจ

COMMAND dsconf plugin attr-uniq enable

usage: dsconf [-v] [-j] instance plugin attr-uniq enable [-h] NAME
  • NAME โ€” the name of the plug-in configuration record ๐Ÿ’–

COMMAND dsconf plugin attr-uniq disable

usage: dsconf [-v] [-j] instance plugin attr-uniq disable [-h] NAME
  • NAME โ€” the name of the plug-in configuration record ๐ŸŽ€

COMMAND dsconf plugin attr-uniq status

usage: dsconf [-v] [-j] instance plugin attr-uniq status [-h] NAME
  • NAME โ€” the name of the plug-in configuration record โœจ

COMMAND dsconf plugin dna

okay bestie, and now we get to the DNA plugin โ€” yes, distributed numeric assignment, the plug-in that hands out numbers so no two servers ever fight over the same one. ๐Ÿงฌ๐Ÿ’…

usage: dsconf [-v] [-j] instance plugin dna [-h]
                                            {show,enable,disable,status,list,config}
...

POSITIONAL ARGUMENTS dsconf plugin dna

  • dsconf plugin dna show โ€” displays the plugin configuration ๐Ÿ‘€
  • dsconf plugin dna enable โ€” enables the plugin ๐Ÿ”ฅ
  • dsconf plugin dna disable โ€” disables the plugin ๐Ÿ’€
  • dsconf plugin dna status โ€” displays the plugin status ๐ŸŒก๏ธ
  • dsconf plugin dna list โ€” list available plugin configs ๐Ÿ“‹
  • dsconf plugin dna config โ€” manage plugin configs โš™๏ธ

COMMAND dsconf plugin dna show

usage: dsconf [-v] [-j] instance plugin dna show [-h]

COMMAND dsconf plugin dna enable

usage: dsconf [-v] [-j] instance plugin dna enable [-h]

COMMAND dsconf plugin dna disable

usage: dsconf [-v] [-j] instance plugin dna disable [-h]

COMMAND dsconf plugin dna status

usage: dsconf [-v] [-j] instance plugin dna status [-h]

COMMAND dsconf plugin dna list

usage: dsconf [-v] [-j] instance plugin dna list [-h]
                                                 {configs,shared-configs}
...

POSITIONAL ARGUMENTS dsconf plugin dna list

  • dsconf plugin dna list configs โ€” list main DNA plugin config entries ๐Ÿ—‚๏ธ
  • dsconf plugin dna list shared-configs โ€” list DNA plugin shared config entries ๐Ÿค

COMMAND dsconf plugin dna list configs

usage: dsconf [-v] [-j] instance plugin dna list configs [-h]

COMMAND dsconf plugin dna list shared-configs

usage: dsconf [-v] [-j] instance plugin dna list shared-configs [-h]
BASEDN
  • BASEDN โ€” the search DN ๐Ÿ”Ž

COMMAND dsconf plugin dna config

usage: dsconf [-v] [-j] instance plugin dna config [-h]
                                                     NAME
                                                     {add,set,show,delete,shared-config-entry}
...

POSITIONAL ARGUMENTS dsconf plugin dna config

  • dsconf plugin dna config add โ€” add the config entry โž•
  • dsconf plugin dna config set โ€” edit the config entry ๐Ÿ“
  • dsconf plugin dna config show โ€” display the config entry ๐Ÿ‘€
  • dsconf plugin dna config delete โ€” delete the config entry ๐Ÿ—‘๏ธ
  • dsconf plugin dna config shared-config-entry โ€” manage the shared config entry ๐Ÿค

COMMAND dsconf plugin dna config add

usage: dsconf [-v] [-j] instance plugin dna config NAME add
       [-h] [--type TYPE [TYPE ...]] [--prefix PREFIX]
       [--next-value NEXT_VALUE] [--max-value MAX_VALUE] [--interval
INTERVAL]
       [--magic-regen MAGIC_REGEN] [--filter FILTER] [--scope SCOPE]
       [--remote-bind-dn REMOTE_BIND_DN] [--remote-bind-cred
REMOTE_BIND_CRED]
       [--shared-config-entry SHARED_CONFIG_ENTRY] [--threshold
THRESHOLD]
       [--next-range NEXT_RANGE]
       [--range-request-timeout RANGE_REQUEST_TIMEOUT]

OPTIONS dsconf plugin dna config add

  • --type TYPE [TYPE ...] โ€” sets which attributes have unique numbers being generated for them (dnaType) ๐Ÿ”ข
  • --prefix PREFIX โ€” defines a prefix that can be prepended to the generated number values for the attribute (dnaPrefix) ๐Ÿท๏ธ
  • --next-value NEXT_VALUE โ€” sets the next available number which can be assigned (dnaNextValue) โญ๏ธ
  • --max-value MAX_VALUE โ€” sets the maximum value that can be assigned for the range (dnaMaxValue) ๐Ÿ”
  • --interval INTERVAL โ€” sets an interval to use to increment through numbers in a range (dnaInterval) ๐Ÿ“ˆ
  • --magic-regen MAGIC_REGEN โ€” sets a user-defined value that instructs the plug-in to assign a new value for the entry (dnaMagicRegen) ๐Ÿช„
  • --filter FILTER โ€” sets an LDAP filter to use to search for and identify the entries to which to apply the distributed numeric assignment range (dnaFilter) ๐Ÿ”
  • --scope SCOPE โ€” sets the base DN to search for entries to which to apply the distributed numeric assignment (dnaScope) ๐ŸŒณ
  • --remote-bind-dn REMOTE_BIND_DN โ€” specifies the Replication Manager DN (dnaRemoteBindDN) ๐Ÿ”‘
  • --remote-bind-cred REMOTE_BIND_CRED โ€” specifies the Replication Manager's password (dnaRemoteBindCred) ๐Ÿคซ
  • --shared-config-entry SHARED_CONFIG_ENTRY โ€” defines a shared identity that the servers can use to transfer ranges to one another (dnaSharedCfgDN) ๐Ÿค
  • --threshold THRESHOLD โ€” sets a threshold of remaining available numbers in the range. When the server hits the threshold, it sends a request for a new range (dnaThreshold) ๐Ÿšจ
  • --next-range NEXT_RANGE โ€” defines the next range to use when the current range is exhausted (dnaNextRange) โญ๏ธ
  • --range-request-timeout RANGE_REQUEST_TIMEOUT โ€” sets a timeout period, in seconds, for range requests so that the server does not stall waiting on a new range from one server and can request a range from a new server (dnaRangeRequestTimeout) โฑ๏ธ

COMMAND dsconf plugin dna config set

usage: dsconf [-v] [-j] instance plugin dna config NAME set
       [-h] [--type TYPE [TYPE ...]] [--prefix PREFIX]
       [--next-value NEXT_VALUE] [--max-value MAX_VALUE] [--interval
INTERVAL]
       [--magic-regen MAGIC_REGEN] [--filter FILTER] [--scope SCOPE]
       [--remote-bind-dn REMOTE_BIND_DN] [--remote-bind-cred
REMOTE_BIND_CRED]
       [--shared-config-entry SHARED_CONFIG_ENTRY] [--threshold
THRESHOLD]
       [--next-range NEXT_RANGE]
       [--range-request-timeout RANGE_REQUEST_TIMEOUT]

OPTIONS dsconf plugin dna config set

same flags, same energy, but now you're editing instead of creating:

  • --type TYPE [TYPE ...] โ€” sets which attributes have unique numbers being generated for them (dnaType) ๐Ÿ”ข
  • --prefix PREFIX โ€” defines a prefix that can be prepended to the generated number values for the attribute (dnaPrefix) ๐Ÿท๏ธ
  • --next-value NEXT_VALUE โ€” sets the next available number which can be assigned (dnaNextValue) โญ๏ธ
  • --max-value MAX_VALUE โ€” sets the maximum value that can be assigned for the range (dnaMaxValue) ๐Ÿ”
  • --interval INTERVAL โ€” sets an interval to use to increment through numbers in a range (dnaInterval) ๐Ÿ“ˆ
  • --magic-regen MAGIC_REGEN โ€” sets a user-defined value that instructs the plug-in to assign a new value for the entry (dnaMagicRegen) ๐Ÿช„
  • --filter FILTER โ€” sets an LDAP filter to use to search for and identify the entries to which to apply the distributed numeric assignment range (dnaFilter) ๐Ÿ”
  • --scope SCOPE โ€” sets the base DN to search for entries to which to apply the distributed numeric assignment (dnaScope) ๐ŸŒณ
  • --remote-bind-dn REMOTE_BIND_DN โ€” specifies the Replication Manager DN (dnaRemoteBindDN) ๐Ÿ”‘
  • --remote-bind-cred REMOTE_BIND_CRED โ€” specifies the Replication Manager's password (dnaRemoteBindCred) ๐Ÿคซ
  • --shared-config-entry SHARED_CONFIG_ENTRY โ€” defines a shared identity that the servers can use to transfer ranges to one another (dnaSharedCfgDN) ๐Ÿค
  • --threshold THRESHOLD โ€” sets a threshold of remaining available numbers in the range. When the server hits the threshold, it sends a request for a new range (dnaThreshold) ๐Ÿšจ
  • --next-range NEXT_RANGE โ€” defines the next range to use when the current range is exhausted (dnaNextRange) โญ๏ธ
  • --range-request-timeout RANGE_REQUEST_TIMEOUT โ€” sets a timeout period, in seconds, for range requests so that the server does not stall waiting on a new range from one server and can request a range from a new server (dnaRangeRequestTimeout) โฑ๏ธ

COMMAND dsconf plugin dna config show

usage: dsconf [-v] [-j] instance plugin dna config NAME show [-h]

COMMAND dsconf plugin dna config delete

usage: dsconf [-v] [-j] instance plugin dna config NAME delete [-h]

COMMAND dsconf plugin dna config shared-config-entry

usage: dsconf [-v] [-j] instance plugin dna config NAME
shared-config-entry
       [-h] SHARED_CFG {set,show,delete} ...

POSITIONAL ARGUMENTS dsconf plugin dna config shared-config-entry

  • dsconf plugin dna config shared-config-entry set โ€” edit the shared config entry ๐Ÿ“
  • dsconf plugin dna config shared-config-entry show โ€” display the shared config entry ๐Ÿ‘€
  • dsconf plugin dna config shared-config-entry delete โ€” delete the shared config entry ๐Ÿ—‘๏ธ

COMMAND dsconf plugin dna config shared-config-entry set

usage: dsconf [-v] [-j] instance plugin dna config NAME
shared-config-entry SHARED_CFG set
       [-h] [--remote-bind-method REMOTE_BIND_METHOD]
       [--remote-conn-protocol REMOTE_CONN_PROTOCOL]

OPTIONS dsconf plugin dna config shared-config-entry set

  • --remote-bind-method REMOTE_BIND_METHOD โ€” specifies the remote bind method "SIMPLE", "SSL" (for SSL client auth), "SASL/GSSAPI", or "SASL/DIGEST-MD5" (dnaRemoteBindMethod) ๐Ÿ”
  • --remote-conn-protocol REMOTE_CONN_PROTOCOL โ€” specifies the remote connection protocol "LDAP", or "TLS" (dnaRemoteConnProtocol) ๐ŸŒ

COMMAND dsconf plugin dna config shared-config-entry show

usage: dsconf [-v] [-j] instance plugin dna config NAME
shared-config-entry SHARED_CFG show
       [-h]

COMMAND dsconf plugin dna config shared-config-entry delete

usage: dsconf [-v] [-j] instance plugin dna config NAME
shared-config-entry SHARED_CFG delete
       [-h]

COMMAND dsconf plugin ldap-pass-through-auth

next up, bestie, it's the LDAP pass-through auth plug-in โ€” the one that lets your directory go "hmm, not my credentials, let me go ask someone else" ๐Ÿ˜ญโœจ

usage: dsconf instance [-v] [-j] plugin ldap-pass-through-auth
       [-h] {show,enable,disable,status,list,add,modify,delete} ...

POSITIONAL ARGUMENTS dsconf plugin ldap-pass-through-auth

  • dsconf plugin ldap-pass-through-auth show โ€” displays the plugin configuration ๐Ÿ‘€
  • dsconf plugin ldap-pass-through-auth enable โ€” enables the plugin ๐Ÿ”ฅ
  • dsconf plugin ldap-pass-through-auth disable โ€” disables the plugin ๐Ÿ’€
  • dsconf plugin ldap-pass-through-auth status โ€” displays the plugin status ๐ŸŒก๏ธ
  • dsconf plugin ldap-pass-through-auth list โ€” lists LDAP URLs ๐Ÿ“‹
  • dsconf plugin ldap-pass-through-auth add โ€” add an LDAP url to the config entry โž•
  • dsconf plugin ldap-pass-through-auth modify โ€” edit the LDAP pass through config entry โœ๏ธ
  • dsconf plugin ldap-pass-through-auth delete โ€” delete a URL from the config entry ๐Ÿ—‘๏ธ

COMMAND dsconf plugin ldap-pass-through-auth show

usage: dsconf [-v] [-j] instance plugin ldap-pass-through-auth show [-h]

COMMAND 'dsconf plugin ldap-pass-through-auth enable'

usage: dsconf [-v] [-j] instance plugin ldap-pass-through-auth enable
[-h]

COMMAND 'dsconf plugin ldap-pass-through-auth disable'

usage: dsconf [-v] [-j] instance plugin ldap-pass-through-auth disable
[-h]

COMMAND 'dsconf plugin ldap-pass-through-auth status'

usage: dsconf [-v] [-j] instance plugin ldap-pass-through-auth status
[-h]

COMMAND 'dsconf plugin ldap-pass-through-auth list'

usage: dsconf [-v] [-j] instance plugin ldap-pass-through-auth list [-h]

COMMAND 'dsconf plugin ldap-pass-through-auth add'

usage: dsconf [-v] [-j] instance plugin ldap-pass-through-auth add [-h]
URL
  • URL โ€” bestie this is the full LDAP URL, and the format is LOCKED IN: "ldap|ldaps://authDS/subtree maxconns,maxops,timeout,ldver,connlifetime,startTLS". And listen ๐Ÿ’€ if you specify even ONE of those optional parameters, you have to specify the rest too. All or nothing, no in-between. Periodt.

COMMAND 'dsconf plugin ldap-pass-through-auth modify'

usage: dsconf [-v] [-j] instance plugin ldap-pass-through-auth modify
       [-h] OLD_URL NEW_URL
  • OLD_URL โ€” the full LDAP URL you grab from the "list" command ๐Ÿ‘‘
  • NEW_URL โ€” sets the full LDAP URL in the format "ldap|ldaps://authDS/subtree maxconns,maxops,timeout,ldver,connlifetime,startTLS". And yeah, same rule as before: if one optional parameter is specified the rest should be specified too ๐Ÿซถ

COMMAND 'dsconf plugin ldap-pass-through-auth delete'

usage: dsconf [-v] [-j] instance plugin ldap-pass-through-auth delete
[-h] URL
  • URL โ€” the full LDAP URL you get from the "list" command, bestie.

COMMAND 'dsconf plugin linked-attr'

usage: dsconf [-v] [-j] instance plugin linked-attr [-h]
                                                    {show,enable,disable,status,fixup,fixup-status,list,config}
...

POSITIONAL ARGUMENTS 'dsconf plugin linked-attr'

  • dsconf plugin linked-attr show โ€” shows you the plugin config, the whole vibe โœจ
  • dsconf plugin linked-attr enable โ€” turns the plugin ON ๐Ÿ’…
  • dsconf plugin linked-attr disable โ€” turns the plugin OFF ๐Ÿ™ˆ
  • dsconf plugin linked-attr status โ€” tells you the plugin's status, the vibe check ๐ŸŒธ
  • dsconf plugin linked-attr fixup โ€” runs the fix-up task for the linked attributes plugin ๐Ÿ”ฅ
  • dsconf plugin linked-attr fixup-status โ€” checks how that fix-up task is doing
  • dsconf plugin linked-attr list โ€” lists the available plugin configs
  • dsconf plugin linked-attr config โ€” manages the plugin configs, main character energy

COMMAND 'dsconf plugin linked-attr show'

usage: dsconf [-v] [-j] instance plugin linked-attr show [-h]

COMMAND 'dsconf plugin linked-attr enable'

usage: dsconf [-v] [-j] instance plugin linked-attr enable [-h]

COMMAND 'dsconf plugin linked-attr disable'

usage: dsconf [-v] [-j] instance plugin linked-attr disable [-h]

COMMAND 'dsconf plugin linked-attr status'

usage: dsconf [-v] [-j] instance plugin linked-attr status [-h]

COMMAND 'dsconf plugin linked-attr fixup'

usage: dsconf [-v] [-j] instance plugin linked-attr fixup [-h] [-l
LINKDN]
                                                          [--wait]

OPTIONS 'dsconf plugin linked-attr fixup'

  • -l LINKDN, --linkdn LINKDN โ€” sets the base DN that contains entries to fix up ๐ŸŽ€
  • --wait โ€” waits for the task to finish. ngl this could take a long time, so maybe go get a snack first ๐Ÿ“

COMMAND 'dsconf plugin linked-attr fixup-status'

usage: dsconf [-v] [-j] instance plugin linked-attr fixup-status
       [-h] [--dn DN] [--show-log] [--watch]

OPTIONS 'dsconf plugin linked-attr fixup-status'

  • --dn DN โ€” the task entry's DN
  • --show-log โ€” displays the task log, receipts and all ๐Ÿงš
  • --watch โ€” watches the task's status and waits for it to finish, like you're refreshing the group chat ๐Ÿ‘€

COMMAND 'dsconf plugin linked-attr list'

usage: dsconf [-v] [-j] instance plugin linked-attr list [-h]

COMMAND 'dsconf plugin linked-attr config'

usage: dsconf [-v] [-j] instance plugin linked-attr config [-h]
                                                           NAME
                                                           {add,set,show,delete}
...

POSITIONAL ARGUMENTS 'dsconf plugin linked-attr config'

  • dsconf plugin linked-attr config add โ€” adds the config entry ๐Ÿ’–
  • dsconf plugin linked-attr config set โ€” edits the config entry
  • dsconf plugin linked-attr config show โ€” displays the config entry
  • dsconf plugin linked-attr config delete โ€” deletes the config entry, bye bestie ๐Ÿ‘‹

COMMAND 'dsconf plugin linked-attr config add'

usage: dsconf [-v] [-j] instance plugin linked-attr config NAME add
       [-h] [--link-type LINK_TYPE] [--managed-type MANAGED_TYPE]
       [--link-scope LINK_SCOPE]

OPTIONS 'dsconf plugin linked-attr config add'

  • --link-type LINK_TYPE โ€” sets the attribute that is managed manually by administrators (linkType)
  • --managed-type MANAGED_TYPE โ€” sets the attribute that is created dynamically by the plugin (managedType) โœจ
  • --link-scope LINK_SCOPE โ€” sets the scope that restricts the plugin to a specific part of the directory tree (linkScope)

COMMAND 'dsconf plugin linked-attr config set'

usage: dsconf [-v] [-j] instance plugin linked-attr config NAME set
       [-h] [--link-type LINK_TYPE] [--managed-type MANAGED_TYPE]
       [--link-scope LINK_SCOPE]

OPTIONS 'dsconf plugin linked-attr config set'

  • --link-type LINK_TYPE โ€” sets the attribute that is managed manually by administrators (linkType)
  • --managed-type MANAGED_TYPE โ€” sets the attribute that is created dynamically by the plugin (managedType) โœจ
  • --link-scope LINK_SCOPE โ€” sets the scope that restricts the plugin to a specific part of the directory tree (linkScope)

COMMAND 'dsconf plugin linked-attr config show'

usage: dsconf [-v] [-j] instance plugin linked-attr config NAME show
[-h]

COMMAND 'dsconf plugin linked-attr config delete'

usage: dsconf [-v] [-j] instance plugin linked-attr config NAME delete
[-h]

COMMAND 'dsconf plugin managed-entries'

usage: dsconf [-v] [-j] instance plugin managed-entries [-h]
                                                            {show,enable,disable,status,set,list,config,template}
...

POSITIONAL ARGUMENTS 'dsconf plugin managed-entries'

  • dsconf plugin managed-entries show โ€” displays the plugin configuration ๐Ÿ’œ
  • dsconf plugin managed-entries enable โ€” enables the plugin
  • dsconf plugin managed-entries disable โ€” disables the plugin
  • dsconf plugin managed-entries status โ€” displays the plugin status
  • dsconf plugin managed-entries set โ€” edits the plugin settings
  • dsconf plugin managed-entries list โ€” lists Managed Entries Plugin configs and templates
  • dsconf plugin managed-entries config โ€” handles Managed Entries Plugin configs
  • dsconf plugin managed-entries template โ€” handles Managed Entries Plugin templates ๐ŸŒˆ

COMMAND 'dsconf plugin managed-entries show'

usage: dsconf [-v] [-j] instance plugin managed-entries show [-h]

COMMAND 'dsconf plugin managed-entries enable'

usage: dsconf [-v] [-j] instance plugin managed-entries enable [-h]

COMMAND 'dsconf plugin managed-entries disable'

usage: dsconf [-v] [-j] instance plugin managed-entries disable [-h]

COMMAND 'dsconf plugin managed-entries status'

usage: dsconf [-v] [-j] instance plugin managed-entries status [-h]

COMMAND 'dsconf plugin managed-entries set'

usage: dsconf [-v] [-j] instance plugin managed-entries set
       [-h] [--config-area CONFIG_AREA]

OPTIONS 'dsconf plugin managed-entries set'

  • --config-area CONFIG_AREA โ€” sets the value of the nsslapd-pluginConfigArea attribute ๐ŸŽ€

COMMAND 'dsconf plugin managed-entries list'

usage: dsconf [-v] [-j] instance plugin managed-entries list
       [-h] {configs,templates} ...

POSITIONAL ARGUMENTS 'dsconf plugin managed-entries list'

  • dsconf plugin managed-entries list configs โ€” lists Managed Entries Plugin configs (list config-area if specified in the main plugin entry)
  • dsconf plugin managed-entries list templates โ€” lists Managed Entries Plugin templates in the directory ๐Ÿ’…

COMMAND 'dsconf plugin managed-entries list configs'

usage: dsconf instance [-v] [-j] plugin managed-entries list configs
[-h]

COMMAND 'dsconf plugin managed-entries list templates'

usage: dsconf instance [-v] [-j] plugin managed-entries list templates
       [-h] [BASEDN]
  • BASEDN โ€” the base DN where to search the templates ๐Ÿ”

COMMAND 'dsconf plugin managed-entries config'

usage: dsconf [-v] [-j] instance plugin managed-entries config
       [-h] NAME {add,set,show,delete} ...

POSITIONAL ARGUMENTS 'dsconf plugin managed-entries config'

  • dsconf plugin managed-entries config add โ€” adds the config entry ๐Ÿ’–
  • dsconf plugin managed-entries config set โ€” edits the config entry
  • dsconf plugin managed-entries config show โ€” displays the config entry
  • dsconf plugin managed-entries config delete โ€” deletes the config entry ๐Ÿฆ‹

COMMAND 'dsconf plugin managed-entries config add'

usage: dsconf [-v] [-j] instance plugin managed-entries config NAME add
       [-h] [--scope SCOPE] [--filter FILTER] [--managed-base
MANAGED_BASE]
       [--managed-template MANAGED_TEMPLATE]

OPTIONS 'dsconf plugin managed-entries config add'

  • --scope SCOPE โ€” sets the scope of the search to use to see which entries the plug-in monitors (originScope)
  • --filter FILTER โ€” sets the search filter to use to search for and identify the entries within the subtree which require a managed entry (originFilter)
  • --managed-base MANAGED_BASE โ€” sets the subtree under which to create the managed entries (managedBase)
  • --managed-template MANAGED_TEMPLATE โ€” identifies the template entry to use to create the managed entry (managedTemplate) โœจ

COMMAND 'dsconf plugin managed-entries config set'

usage: dsconf [-v] [-j] instance plugin managed-entries config NAME set
       [-h] [--scope SCOPE] [--filter FILTER] [--managed-base
MANAGED_BASE]
       [--managed-template MANAGED_TEMPLATE]

OPTIONS 'dsconf plugin managed-entries config set'

  • --scope SCOPE โ€” sets the scope of the search to use to see which entries the plug-in monitors (originScope)
  • --filter FILTER โ€” sets the search filter to use to search for and identify the entries within the subtree which require a managed entry (originFilter)
  • --managed-base MANAGED_BASE โ€” sets the subtree under which to create the managed entries (managedBase)
  • --managed-template MANAGED_TEMPLATE โ€” identifies the template entry to use to create the managed entry (managedTemplate) โœจ

COMMAND 'dsconf plugin managed-entries config show'

usage: dsconf [-v] [-j] instance plugin managed-entries config NAME show
[-h]

COMMAND 'dsconf plugin managed-entries config delete'

usage: dsconf [-v] [-j] instance plugin managed-entries config NAME
delete
       [-h]

โœจ COMMAND 'dsconf plugin managed-entries template' โœจ

okay bestie, we're in template town now ๐Ÿ’… this is the command that lets you poke at the managed-entries plugin's template entry โ€” the blueprint the server copies from when it auto-generates new managed entries. here's the shape of it:

usage: dsconf [-v] [-j] instance plugin managed-entries template
       [-h] DN {add,set,show,delete} ...

๐ŸŒธ POSITIONAL ARGUMENTS 'dsconf plugin managed-entries template' ๐ŸŒธ

  • dsconf plugin managed-entries template add โ€” Add the template entry โœจ
  • dsconf plugin managed-entries template set โ€” Edit the template entry โœ๏ธ
  • dsconf plugin managed-entries template show โ€” Display the template entry ๐Ÿ‘€
  • dsconf plugin managed-entries template delete โ€” Delete the template entry ๐Ÿ—‘๏ธ

๐Ÿ’– COMMAND 'dsconf plugin managed-entries template add' ๐Ÿ’–

so you wanna build a brand new template entry from scratch? iconic. here's the invocation:

usage: dsconf [-v] [-j] instance plugin managed-entries template DN add
       [-h] [--rdn-attr RDN_ATTR]
       [--static-attr STATIC_ATTR [STATIC_ATTR ...]]
       [--mapped-attr MAPPED_ATTR [MAPPED_ATTR ...]]

๐ŸŽ€ OPTIONS 'dsconf plugin managed-entries template add' ๐ŸŽ€

  • --rdn-attr RDN_ATTR โ€” Sets which attribute to use as the naming attribute in the automatically- generated entry (mepRDNAttr) ๐Ÿ’ซ
  • --static-attr STATIC_ATTR [STATIC_ATTR ...] โ€” Sets an attribute with a defined value that must be added to the automatically-generated entry (mepStaticAttr) ๐Ÿ”’
  • --mapped-attr MAPPED_ATTR [MAPPED_ATTR ...] โ€” Sets attributes in the Managed Entries template entry which must exist in the generated entry (mepMappedAttr) ๐Ÿ—บ๏ธ

๐ŸŒˆ COMMAND 'dsconf plugin managed-entries template set' ๐ŸŒˆ

already got a template and just need to tweak it? say less. same flags, different verb:

usage: dsconf [-v] [-j] instance plugin managed-entries template DN set
       [-h] [--rdn-attr RDN_ATTR]
       [--static-attr STATIC_ATTR [STATIC_ATTR ...]]
       [--mapped-attr MAPPED_ATTR [MAPPED_ATTR ...]]

๐Ÿฆ‹ OPTIONS 'dsconf plugin managed-entries template set' ๐Ÿฆ‹

  • --rdn-attr RDN_ATTR โ€” Sets which attribute to use as the naming attribute in the automatically- generated entry (mepRDNAttr) ๐Ÿ’ซ
  • --static-attr STATIC_ATTR [STATIC_ATTR ...] โ€” Sets an attribute with a defined value that must be added to the automatically-generated entry (mepStaticAttr) ๐Ÿ”’
  • --mapped-attr MAPPED_ATTR [MAPPED_ATTR ...] โ€” Sets attributes in the Managed Entries template entry which must exist in the generated entry (mepMappedAttr) ๐Ÿ—บ๏ธ

๐Ÿ‘€ COMMAND 'dsconf plugin managed-entries template show' ๐Ÿ‘€

peek at your template, no notes, just vibes:

usage: dsconf [-v] [-j] instance plugin managed-entries template DN show
[-h]

๐Ÿ—‘๏ธ COMMAND 'dsconf plugin managed-entries template delete' ๐Ÿ—‘๏ธ

yeet the template. it's giving gone girl:

usage: dsconf [-v] [-j] instance plugin managed-entries template DN
delete
       [-h]

๐Ÿ”ฅ COMMAND 'dsconf plugin pam-pass-through-auth' ๐Ÿ”ฅ

okay new plugin era โ€” PAM pass-through auth, aka letting PAM handle the auth moment while LDAP stays the directory โœจ here's the top-level shape:

usage: dsconf instance [-v] [-j] plugin pam-pass-through-auth
       [-h] {show,enable,disable,status,list,config} ...

๐Ÿ’œ POSITIONAL ARGUMENTS 'dsconf plugin pam-pass-through-auth' ๐Ÿ’œ

  • dsconf plugin pam-pass-through-auth show โ€” Displays the plugin configuration ๐Ÿ‘€
  • dsconf plugin pam-pass-through-auth enable โ€” Enables the plugin โœ…
  • dsconf plugin pam-pass-through-auth disable โ€” Disables the plugin ๐Ÿšซ
  • dsconf plugin pam-pass-through-auth status โ€” Displays the plugin status ๐Ÿ“Š
  • dsconf plugin pam-pass-through-auth list โ€” Lists PAM configurations ๐Ÿ“
  • dsconf plugin pam-pass-through-auth config โ€” Manage PAM PTA configurations. ๐Ÿ› ๏ธ

๐Ÿ‘‘ COMMAND 'dsconf plugin pam-pass-through-auth show' ๐Ÿ‘‘

usage: dsconf [-v] [-j] instance plugin pam-pass-through-auth show [-h]

โœ… COMMAND 'dsconf plugin pam-pass-through-auth enable' โœ…

usage: dsconf [-v] [-j] instance plugin pam-pass-through-auth enable
[-h]

๐Ÿšซ COMMAND 'dsconf plugin pam-pass-through-auth disable' ๐Ÿšซ

usage: dsconf [-v] [-j] instance plugin pam-pass-through-auth disable
[-h]

๐Ÿ“Š COMMAND 'dsconf plugin pam-pass-through-auth status' ๐Ÿ“Š

usage: dsconf [-v] [-j] instance plugin pam-pass-through-auth status
[-h]

๐Ÿ“ COMMAND 'dsconf plugin pam-pass-through-auth list' ๐Ÿ“

usage: dsconf [-v] [-j] instance plugin pam-pass-through-auth list [-h]

๐Ÿ› ๏ธ COMMAND 'dsconf plugin pam-pass-through-auth config' ๐Ÿ› ๏ธ

this is where the actual per-config settings live, bestie. you give it a NAME and then pick a verb:

usage: dsconf [-v] [-j] instance plugin pam-pass-through-auth config
       [-h] NAME {add,set,show,delete} ...

๐Ÿงš POSITIONAL ARGUMENTS 'dsconf plugin pam-pass-through-auth config' ๐Ÿงš

  • dsconf plugin pam-pass-through-auth config add โ€” Add the config entry โœจ
  • dsconf plugin pam-pass-through-auth config set โ€” Edit the config entry โœ๏ธ
  • dsconf plugin pam-pass-through-auth config show โ€” Display the config entry ๐Ÿ‘€
  • dsconf plugin pam-pass-through-auth config delete โ€” Delete the config entry ๐Ÿ—‘๏ธ

๐Ÿ’ซ COMMAND 'dsconf plugin pam-pass-through-auth config add' ๐Ÿ’ซ

usage: dsconf [-v] [-j] instance plugin pam-pass-through-auth config
NAME add
       [-h] [--exclude-suffix EXCLUDE_SUFFIX [EXCLUDE_SUFFIX ...]]
       [--include-suffix INCLUDE_SUFFIX [INCLUDE_SUFFIX ...]]
       [--missing-suffix {ERROR,ALLOW,IGNORE,delete,}] [--filter FILTER]
       [--id-attr ID_ATTR] [--id_map_method ID_MAP_METHOD]
       [--fallback {TRUE,FALSE}] [--secure {TRUE,FALSE}] [--service
SERVICE]

๐Ÿ“ OPTIONS 'dsconf plugin pam-pass-through-auth config add' ๐Ÿ“

  • --exclude-suffix EXCLUDE_SUFFIX [EXCLUDE_SUFFIX ...] โ€” Specifies a suffix to exclude from PAM authentication (pamExcludeSuffix) ๐Ÿšซ
  • --include-suffix INCLUDE_SUFFIX [INCLUDE_SUFFIX ...] โ€” Sets a suffix to include for PAM authentication (pamIncludeSuffix) โœ…
  • --missing-suffix {ERROR,ALLOW,IGNORE,delete,} โ€” Identifies how to handle missing include or exclude suffixes (pamMissingSuffix) ๐Ÿค”
  • --filter FILTER โ€” Sets an LDAP filter to use to identify specific entries within the included suffixes for which to use PAM pass-through authentication (pamFilter) ๐Ÿ”
  • --id-attr ID_ATTR โ€” Contains the attribute name which is used to hold the PAM user ID (pamIDAttr) ๐Ÿ†”
  • --id_map_method ID_MAP_METHOD โ€” Sets the method to use to map the LDAP bind DN to a PAM identity (pamIDMapMethod) ๐Ÿ—บ๏ธ
  • --fallback {TRUE,FALSE} โ€” Sets whether to fallback to regular LDAP authentication if PAM authentication fails (pamFallback) โ†ฉ๏ธ
  • --secure {TRUE,FALSE} โ€” Requires secure TLS connection for PAM authentication (pamSecure) ๐Ÿ”
  • --service SERVICE โ€” Contains the service name to pass to PAM (pamService) ๐Ÿ›Ž๏ธ

โœ๏ธ COMMAND 'dsconf plugin pam-pass-through-auth config set' โœ๏ธ

usage: dsconf [-v] [-j] instance plugin pam-pass-through-auth config
NAME set
       [-h] [--exclude-suffix EXCLUDE_SUFFIX [EXCLUDE_SUFFIX ...]]
       [--include-suffix INCLUDE_SUFFIX [INCLUDE_SUFFIX ...]]
       [--missing-suffix {ERROR,ALLOW,IGNORE,delete,}] [--filter FILTER]
       [--id-attr ID_ATTR] [--id_map_method ID_MAP_METHOD]
       [--fallback {TRUE,FALSE}] [--secure {TRUE,FALSE}] [--service
SERVICE]

๐ŸŒŸ OPTIONS 'dsconf plugin pam-pass-through-auth config set' ๐ŸŒŸ

  • --exclude-suffix EXCLUDE_SUFFIX [EXCLUDE_SUFFIX ...] โ€” Specifies a suffix to exclude from PAM authentication (pamExcludeSuffix) ๐Ÿšซ
  • --include-suffix INCLUDE_SUFFIX [INCLUDE_SUFFIX ...] โ€” Sets a suffix to include for PAM authentication (pamIncludeSuffix) โœ…
  • --missing-suffix {ERROR,ALLOW,IGNORE,delete,} โ€” Identifies how to handle missing include or exclude suffixes (pamMissingSuffix) ๐Ÿค”
  • --filter FILTER โ€” Sets an LDAP filter to use to identify specific entries within the included suffixes for which to use PAM pass-through authentication (pamFilter) ๐Ÿ”
  • --id-attr ID_ATTR โ€” Contains the attribute name which is used to hold the PAM user ID (pamIDAttr) ๐Ÿ†”
  • --id_map_method ID_MAP_METHOD โ€” Sets the method to use to map the LDAP bind DN to a PAM identity (pamIDMapMethod) ๐Ÿ—บ๏ธ
  • --fallback {TRUE,FALSE} โ€” Sets whether to fallback to regular LDAP authentication if PAM authentication fails (pamFallback) โ†ฉ๏ธ
  • --secure {TRUE,FALSE} โ€” Requires secure TLS connection for PAM authentication (pamSecure) ๐Ÿ”
  • --service SERVICE โ€” Contains the service name to pass to PAM (pamService) ๐Ÿ›Ž๏ธ

๐Ÿ‘€ COMMAND 'dsconf plugin pam-pass-through-auth config show' ๐Ÿ‘€

usage: dsconf [-v] [-j] instance plugin pam-pass-through-auth config
NAME show
       [-h]

๐Ÿ—‘๏ธ COMMAND 'dsconf plugin pam-pass-through-auth config delete' ๐Ÿ—‘๏ธ

usage: dsconf [-v] [-j] instance plugin pam-pass-through-auth config
NAME delete
       [-h]

โญ COMMAND 'dsconf plugin retro-changelog' โญ

and now for the retro changelog plugin โ€” the one that keeps a little historical record of changes, no cap. here's the layout:

usage: dsconf [-v] [-j] instance plugin retro-changelog [-h]
                                                            {show,enable,disable,status,set,add,del}
...

๐Ÿ’ซ POSITIONAL ARGUMENTS 'dsconf plugin retro-changelog' ๐Ÿ’ซ

  • dsconf plugin retro-changelog show โ€” Displays the plugin configuration ๐Ÿ‘€
  • dsconf plugin retro-changelog enable โ€” Enables the plugin โœ…
  • dsconf plugin retro-changelog disable โ€” Disables the plugin ๐Ÿšซ
  • dsconf plugin retro-changelog status โ€” Displays the plugin status ๐Ÿ“Š
  • dsconf plugin retro-changelog set โ€” Edit the plugin โœ๏ธ
  • dsconf plugin retro-changelog add โ€” Add attributes to the plugin โž•
  • dsconf plugin retro-changelog del โ€” Delete an attribute from plugin scope โž–

๐Ÿ‘€ COMMAND 'dsconf plugin retro-changelog show' ๐Ÿ‘€

usage: dsconf [-v] [-j] instance plugin retro-changelog show [-h]

โœ… COMMAND 'dsconf plugin retro-changelog enable' โœ…

usage: dsconf [-v] [-j] instance plugin retro-changelog enable [-h]

๐Ÿšซ COMMAND 'dsconf plugin retro-changelog disable' ๐Ÿšซ

usage: dsconf [-v] [-j] instance plugin retro-changelog disable [-h]

๐Ÿ“Š COMMAND 'dsconf plugin retro-changelog status' ๐Ÿ“Š

usage: dsconf [-v] [-j] instance plugin retro-changelog status [-h]

โœ๏ธ COMMAND 'dsconf plugin retro-changelog set' โœ๏ธ

usage: dsconf [-v] [-j] instance plugin retro-changelog set
       [-h] [--is-replicated {TRUE,FALSE}] [--attribute ATTRIBUTE]
       [--directory DIRECTORY] [--max-age MAX_AGE]
       [--trim-interval TRIM_INTERVAL] [--exclude-suffix [EXCLUDE_SUFFIX
...]]
       [--exclude-attrs [EXCLUDE_ATTRS ...]]

๐Ÿ’– OPTIONS 'dsconf plugin retro-changelog set' ๐Ÿ’–

  • --is-replicated {TRUE,FALSE} โ€” Sets a flag to indicate on a change in the changelog whether the change is newly made on that server or whether it was replicated over from another server (isReplicated) ๐Ÿ”
  • --attribute ATTRIBUTE โ€” Specifies another Directory Server attribute which must be included in the retro changelog entries (nsslapd-attribute) ๐Ÿ“Œ
  • --directory DIRECTORY โ€” Specifies the name of the directory in which the changelog database is created the first time the plug-in is run ๐Ÿ“
  • --max-age MAX_AGE โ€” Specifies the maximum age of any entry in the changelog. The value must be a number followed by a duration unit [sSmMhHdDwW]. Used to trim the changelog (nsslapd-changelogmaxage) โณ
  • --trim-interval TRIM_INTERVAL โ€” (the original page gives this flag no description text at all, bestie โ€” it's just sitting there being mysterious ๐Ÿซฅ)
  • --exclude-suffix [EXCLUDE_SUFFIX ...] โ€” Specifies the suffix which will be excluded from the scope of the plugin (nsslapd-exclude-suffix) ๐Ÿšซ
  • --exclude-attrs [EXCLUDE_ATTRS ...] โ€” Specifies the attributes which will be excluded from the scope of the plugin (nsslapd-exclude-attrs) ๐Ÿšซ

heads up: --missing-suffix takes the literal choices {ERROR,ALLOW,IGNORE,delete,} โ€” yes, with that trailing comma, exactly like the original wrote it. don't come for me, i'm just the messenger ๐Ÿ’€ and --id_map_method is spelled with the underscores, --id_map_method ID_MAP_METHOD, not --id-map-method. copy it exactly, iykyk ๐Ÿซถ

COMMAND dsconf plugin retro-changelog add ๐Ÿ’–

usage: dsconf [-v] [-j] instance plugin retro-changelog add
       [-h] [--is-replicated {TRUE,FALSE}] [--attribute ATTRIBUTE]
       [--directory DIRECTORY] [--max-age MAX_AGE]
       [--trim-interval TRIM_INTERVAL] [--exclude-suffix [EXCLUDE_SUFFIX ...]]
       [--exclude-attrs [EXCLUDE_ATTRS ...]]

OPTIONS dsconf plugin retro-changelog add

  • --is-replicated {TRUE,FALSE} โ€” flips the flag that tells the changelog whether a change was freshly made right here on this server or whether it got replicated over from another one โœจ (aka isReplicated, iconic)
  • --attribute ATTRIBUTE โ€” names another Directory Server attribute that absolutely must be in the retro changelog entries, no skipping (that's nsslapd-attribute bestie)
  • --directory DIRECTORY โ€” the name of the directory where the changelog database gets created the very first time the plug-in runs ๐ŸŽ€
  • --max-age MAX_AGE โ€” the max age of any entry chillin' in the changelog. Value has to be a number followed by a duration unit [sSmMhHdDwW] โณ and yeah it's what trims the changelog (nsslapd-changelogmaxage)
  • --trim-interval TRIM_INTERVAL โ€” no description given in the original, she's mysterious ๐Ÿ™ˆ literally just sitting there with no explanation (the manpage says nothing, so I say nothing โ€” we don't invent)
  • --exclude-suffix [EXCLUDE_SUFFIX ...] โ€” the suffix (or suffixes) being excluded from the plugin's scope (nsslapd-exclude-suffix)
  • --exclude-attrs [EXCLUDE_ATTRS ...] โ€” the attributes getting excluded from the plugin's scope (nsslapd-exclude-attrs)

COMMAND dsconf plugin retro-changelog del ๐Ÿฆ‹

usage: dsconf [-v] [-j] instance plugin retro-changelog del
       [-h] [--is-replicated {TRUE,FALSE}] [--attribute ATTRIBUTE]
       [--directory DIRECTORY] [--max-age MAX_AGE]
       [--trim-interval TRIM_INTERVAL] [--exclude-suffix [EXCLUDE_SUFFIX ...]]
       [--exclude-attrs [EXCLUDE_ATTRS ...]]

OPTIONS dsconf plugin retro-changelog del

  • --is-replicated {TRUE,FALSE} โ€” sets the flag saying whether a change in the changelog is brand-new on this server or got replicated in from somewhere else (isReplicated) ๐Ÿ’ซ
  • --attribute ATTRIBUTE โ€” specifies another Directory Server attribute that has to be included in the retro changelog entries (nsslapd-attribute)
  • --directory DIRECTORY โ€” the name of the directory where the changelog database is created the first time the plug-in runs ๐Ÿ“
  • --max-age MAX_AGE โ€” max age of any changelog entry; it's a number plus a duration unit [sSmMhHdDwW], and it's the thing that trims the changelog (nsslapd-changelogmaxage)
  • --trim-interval TRIM_INTERVAL โ€” again, no description in the source, we simply do not know, and we do not make things up ๐Ÿ™ˆ
  • --exclude-suffix [EXCLUDE_SUFFIX ...] โ€” the suffix excluded from the plugin's scope (nsslapd-exclude-suffix)
  • --exclude-attrs [EXCLUDE_ATTRS ...] โ€” the attributes excluded from the plugin's scope (nsslapd-exclude-attrs)

๐ŸŒˆ COMMAND dsconf plugin posix-winsync ๐ŸŒˆ

usage: dsconf [-v] [-j] instance plugin posix-winsync [-h]
                                                      {show,enable,disable,status,set,fixup}
       ...

POSITIONAL ARGUMENTS dsconf plugin posix-winsync

  • dsconf plugin posix-winsync show โ€” shows you the plugin configuration, the whole vibe check ๐Ÿ’…
  • dsconf plugin posix-winsync enable โ€” turns the plugin ON, we love to see it โœจ
  • dsconf plugin posix-winsync disable โ€” turns it OFF, rip ๐Ÿซถ
  • dsconf plugin posix-winsync status โ€” tells you the plugin status, like are we up or are we not
  • dsconf plugin posix-winsync set โ€” edits the plugin settings, the makeover command ๐Ÿ’–
  • dsconf plugin posix-winsync fixup โ€” runs the memberOf fix-up task to correct mismatched member and uniquemember values for synced users โ€” it's giving cleanup era ๐Ÿงน

COMMAND dsconf plugin posix-winsync show

usage: dsconf [-v] [-j] instance plugin posix-winsync show [-h]

COMMAND dsconf plugin posix-winsync enable

usage: dsconf [-v] [-j] instance plugin posix-winsync enable [-h]

COMMAND dsconf plugin posix-winsync disable

usage: dsconf [-v] [-j] instance plugin posix-winsync disable [-h]

COMMAND dsconf plugin posix-winsync status

usage: dsconf [-v] [-j] instance plugin posix-winsync status [-h]

COMMAND dsconf plugin posix-winsync set ๐ŸŽ€

usage: dsconf [-v] [-j] instance plugin posix-winsync set [-h]
                                                          [--create-memberof-task {true,false}]
                                                          [--lower-case-uid {true,false}]
                                                          [--map-member-uid {true,false}]
                                                          [--map-nested-grouping {true,false}]
                                                          [--ms-sfu-schema {true,false}]

OPTIONS dsconf plugin posix-winsync set

  • --create-memberof-task {true,false} โ€” decides whether to run the memberUID fix-up task, like, immediately after a sync run, so that group memberships for synced users get updated (posixWinsyncCreateMemberOfTask) ๐Ÿ”ฅ
  • --lower-case-uid {true,false} โ€” whether to store (and, if needed, convert) the UID value in the memberUID attribute in lower case, periodt (posixWinsyncLowerCaseUID) ๐Ÿ’…
  • --map-member-uid {true,false} โ€” whether to map the memberUID attribute in an Active Directory group over to the uniqueMember attribute in a Directory Server group (posixWinsyncMapMemberUID) ๐Ÿ”
  • --map-nested-grouping {true,false} โ€” manages whether nested groups get updated when memberUID attributes in an Active Directory POSIX group change, the whole ripple effect (posixWinsyncMapNestedGrouping) ๐Ÿช†
  • --ms-sfu-schema {true,false} โ€” sets whether to use the older Microsoft System Services for Unix 3.0 (msSFU30) schema when syncing Posix attributes from Active Directory (posixWinsyncMsSFUSchema) โ€” vintage Microsoft, ngl ๐Ÿซ 

COMMAND dsconf plugin posix-winsync fixup ๐Ÿงš

usage: dsconf [-v] [-j] instance plugin posix-winsync fixup
       [-h] [-f FILTER] [--timeout TIMEOUT] DN
  • DN โ€” set the base DN that contains entries to fix up, that's the target zone bestie ๐ŸŽฏ

OPTIONS dsconf plugin posix-winsync fixup

  • -f FILTER, --filter FILTER โ€” the filter for which entries to fix up. If you justโ€ฆ don't give one, then all entries with objectclass inetuser/inetadmin/nsmemberof under the specified base get their memberOf attribute regenerated. No filter, no problem ๐Ÿ’ซ
  • --timeout TIMEOUT โ€” set a timeout for waiting on the fixup task. Default is 120 seconds โฑ๏ธ

๐ŸŒธ COMMAND dsconf plugin contentsync ๐ŸŒธ

usage: dsconf [-v] [-j] instance plugin contentsync [-h]
                                                      {show,enable,disable,status,set,add}
       ...

POSITIONAL ARGUMENTS dsconf plugin contentsync

  • dsconf plugin contentsync show โ€” displays the plugin configuration โœจ
  • dsconf plugin contentsync enable โ€” enables the plugin ๐Ÿ‘‘
  • dsconf plugin contentsync disable โ€” disables the plugin ๐Ÿ˜ญ
  • dsconf plugin contentsync status โ€” displays the plugin status ๐Ÿฆ‹
  • dsconf plugin contentsync set โ€” edit the plugin settings ๐Ÿ’…
  • dsconf plugin contentsync add โ€” add attributes to the plugin, like adding sprinkles ๐Ÿ“

COMMAND dsconf plugin contentsync show

usage: dsconf [-v] [-j] instance plugin contentsync show [-h]

COMMAND dsconf plugin contentsync enable

usage: dsconf [-v] [-j] instance plugin contentsync enable [-h]

COMMAND dsconf plugin contentsync disable

usage: dsconf [-v] [-j] instance plugin contentsync disable [-h]

COMMAND dsconf plugin contentsync status

usage: dsconf [-v] [-j] instance plugin contentsync status [-h]

COMMAND dsconf plugin contentsync set ๐Ÿ’–

usage: dsconf [-v] [-j] instance plugin contentsync set [-h]
                                                         [--allow-openldap {on,off}]
                                                         [--queue-max-size QUEUE_MAX_SIZE]
                                                         [--max-concurrent MAX_CONCURRENT]

OPTIONS dsconf plugin contentsync set

  • --allow-openldap {on,off} โ€” lets openldap servers act as read-only consumers of this server via syncrepl, sharing is caring ๐Ÿซถ
  • --queue-max-size QUEUE_MAX_SIZE โ€” limits how many entries are still sitting there not-yet-processed (range [100, 100000]) ๐Ÿ“ฆ
  • --max-concurrent MAX_CONCURRENT โ€” limits how many persistent searches can be running at the same time, we're capping the chaos ๐Ÿ”ฅ

COMMAND dsconf plugin contentsync add ๐ŸŽ€

usage: dsconf [-v] [-j] instance plugin contentsync add [-h]
                                                         [--allow-openldap {on,off}]
                                                         [--queue-max-size QUEUE_MAX_SIZE]
                                                         [--max-concurrent MAX_CONCURRENT]

OPTIONS dsconf plugin contentsync add

  • --allow-openldap {on,off} โ€” allows openldap servers to act as read-only consumers of this server via syncrepl โœจ
  • --queue-max-size QUEUE_MAX_SIZE โ€” limits the number of entries not yet processed (range [100, 100000]) ๐ŸŒˆ
  • --max-concurrent MAX_CONCURRENT โ€” limits the number of persistent searches running at the same time โญ

๐Ÿ’œ COMMAND dsconf plugin entryuuid ๐Ÿ’œ

usage: dsconf [-v] [-j] instance plugin entryuuid [-h]
                                                      {show,enable,disable,status,fixup,fixup-status}
       ...

POSITIONAL ARGUMENTS dsconf plugin entryuuid

  • dsconf plugin entryuuid show โ€” displays the plugin configuration ๐Ÿ’…
  • dsconf plugin entryuuid enable โ€” enables the plugin โœจ
  • dsconf plugin entryuuid disable โ€” disables the plugin ๐Ÿ™ˆ
  • dsconf plugin entryuuid status โ€” displays the plugin status
  • dsconf plugin entryuuid fixup โ€” run the fix-up task for the EntryUUID plugin ๐Ÿ› ๏ธ
  • dsconf plugin entryuuid fixup-status โ€” check the status of a fix-up task, like stalking your own progress ๐Ÿ‘€

COMMAND dsconf plugin entryuuid show

usage: dsconf [-v] [-j] instance plugin entryuuid show [-h]

COMMAND dsconf plugin entryuuid enable

usage: dsconf [-v] [-j] instance plugin entryuuid enable [-h]

COMMAND dsconf plugin entryuuid disable

usage: dsconf [-v] [-j] instance plugin entryuuid disable [-h]

COMMAND dsconf plugin entryuuid status

usage: dsconf [-v] [-j] instance plugin entryuuid status [-h]

COMMAND dsconf plugin entryuuid fixup ๐Ÿ”ฅ

usage: dsconf [-v] [-j] instance plugin entryuuid fixup [-h] [-f FILTER]
                                                         [--wait]
                                                         [--timeout TIMEOUT]
                                                         DN
  • DN โ€” base DN that contains entries to fix up, the home base of the whole operation ๐ŸŽฏ

โœจ OPTIONS 'dsconf plugin entryuuid fixup' โœจ

  • -f FILTER, --filter FILTER โ€” this is your filter for which entries get the โœจglow upโœจ. Skip it and every single entry under the base DN gets its EntryUUID attribute regenerated if it isn't already there. no filter = the whole roster, bestie ๐Ÿ’–
  • --wait โ€” wait for the task to actually finish before you go anywhere. fair warning: this could take a long time ๐Ÿ˜ญ like, go make a snack, text your group chat, come back kind of long.
  • --timeout TIMEOUT โ€” sets the task timeout. Default is 0, and 0 means no timeout. iconic, honestly ๐Ÿซถ

๐Ÿฆ‹ COMMAND 'dsconf plugin entryuuid fixup-status' ๐Ÿฆ‹

usage: dsconf [-v] [-j] instance plugin entryuuid fixup-status
       [-h] [--dn DN] [--show-log] [--watch]

OPTIONS 'dsconf plugin entryuuid fixup-status'

  • --dn DN โ€” the DN of the task entry. that's the one you're asking about ๐Ÿ’…
  • --show-log โ€” display the task log ๐Ÿ“œ spill it.
  • --watch โ€” watch the task's status and justโ€ฆ wait for it to finish. main character energy, sitting there watching the progress bar ๐Ÿ“

๐ŸŒธ COMMAND 'dsconf plugin pwstorage-scheme' ๐ŸŒธ

usage: dsconf [-v] [-j] instance plugin pwstorage-scheme [-h]
                                                                {pbkdf2,pbkdf2-sha1,pbkdf2-sha256,pbkdf2-sha256-legacy,pbkdf2-sha512}
       ...

so basically: this is your password storage scheme corner of the shop, and you've got five flavors to pick from. pick wisely ๐Ÿ’œ

POSITIONAL ARGUMENTS 'dsconf plugin pwstorage-scheme'

  • dsconf plugin pwstorage-scheme pbkdf2 โ€” manage the legacy PBKDF2 scheme ({PBKDF2}). heads up: its settings are independent of pbkdf2-sha1, even though both of them use SHA-1. don't mix them up fr fr.
  • dsconf plugin pwstorage-scheme pbkdf2-sha1 โ€” manage the PBKDF2-SHA1 scheme ({PBKDF2-SHA1}). same deal but from the other direction: its settings are independent of the legacy pbkdf2, even though both use SHA-1. yes it's confusing, no it's not my fault ๐Ÿ˜ญ
  • dsconf plugin pwstorage-scheme pbkdf2-sha256 โ€” manage the PBKDF2-SHA256 scheme. the classic, the reliable, the queen ๐Ÿ‘‘
  • dsconf plugin pwstorage-scheme pbkdf2-sha256-legacy โ€” manage the PBKDF2-SHA256-LEGACY scheme. vintage, but in a museum way ๐ŸŽ€
  • dsconf plugin pwstorage-scheme pbkdf2-sha512 โ€” manage the PBKDF2-SHA512 scheme. bigger hash, bigger vibes ๐ŸŒˆ

๐ŸŽ€ COMMAND 'dsconf plugin pwstorage-scheme pbkdf2' ๐ŸŽ€

usage: dsconf [-v] [-j] instance plugin pwstorage-scheme pbkdf2
       [-h]
       {get-num-iterations,set-num-iterations,get-accept-max-iterations,set-accept-max-iterations,delete-accept-max-iterations}
       ...

steady, bestie, this is the legacy PBKDF2 one specifically ๐Ÿ’…

POSITIONAL ARGUMENTS 'dsconf plugin pwstorage-scheme pbkdf2'

  • dsconf plugin pwstorage-scheme pbkdf2 get-num-iterations โ€” get the number of iterations ๐Ÿ”ข
  • dsconf plugin pwstorage-scheme pbkdf2 set-num-iterations โ€” set the number of iterations โœจ
  • dsconf plugin pwstorage-scheme pbkdf2 get-accept-max-iterations โ€” get the maximum iterations accepted from stored hashes on bind ๐Ÿ”
  • dsconf plugin pwstorage-scheme pbkdf2 set-accept-max-iterations โ€” set the maximum iterations accepted from stored hashes on bind ๐Ÿ› ๏ธ
  • dsconf plugin pwstorage-scheme pbkdf2 delete-accept-max-iterations โ€” remove the accept max iterations override and revert back to the default ๐Ÿงน

COMMAND 'dsconf plugin pwstorage-scheme pbkdf2 get-num-iterations'

usage: dsconf [-v] [-j] instance plugin pwstorage-scheme pbkdf2
get-num-iterations
       [-h]

COMMAND 'dsconf plugin pwstorage-scheme pbkdf2 set-num-iterations'

usage: dsconf [-v] [-j] instance plugin pwstorage-scheme pbkdf2
set-num-iterations
       [-h] iterations
  • iterations โ€” number of iterations, and the range is (10,000-10,000,000). keep it in the lines, babes ๐Ÿซถ

COMMAND 'dsconf plugin pwstorage-scheme pbkdf2 get-accept-max-iterations'

usage: dsconf [-v] [-j] instance plugin pwstorage-scheme pbkdf2
get-accept-max-iterations
       [-h]

COMMAND 'dsconf plugin pwstorage-scheme pbkdf2 set-accept-max-iterations'

usage: dsconf [-v] [-j] instance plugin pwstorage-scheme pbkdf2
set-accept-max-iterations
       [-h] iterations
  • iterations โ€” maximum iterations accepted on bind, range (10,000-10,000,000) ๐Ÿ’–

COMMAND 'dsconf plugin pwstorage-scheme pbkdf2 delete-accept-max-iterations'

usage: dsconf [-v] [-j] instance plugin pwstorage-scheme pbkdf2
delete-accept-max-iterations
       [-h]

๐Ÿฆ‹ COMMAND 'dsconf plugin pwstorage-scheme pbkdf2-sha1' ๐Ÿฆ‹

usage: dsconf [-v] [-j] instance plugin pwstorage-scheme pbkdf2-sha1
       [-h]
       {get-num-iterations,set-num-iterations,get-accept-max-iterations,set-accept-max-iterations,delete-accept-max-iterations}
       ...

okay so this one is the non-legacy SHA-1 one. remember: independent settings from legacy pbkdf2. told you. ๐Ÿ’œ

POSITIONAL ARGUMENTS 'dsconf plugin pwstorage-scheme pbkdf2-sha1'

  • dsconf plugin pwstorage-scheme pbkdf2-sha1 get-num-iterations โ€” get number of iterations ๐Ÿ”ข
  • dsconf plugin pwstorage-scheme pbkdf2-sha1 set-num-iterations โ€” set number of iterations โœจ
  • dsconf plugin pwstorage-scheme pbkdf2-sha1 get-accept-max-iterations โ€” get the maximum iterations accepted from stored hashes on bind ๐Ÿ”
  • dsconf plugin pwstorage-scheme pbkdf2-sha1 set-accept-max-iterations โ€” set the maximum iterations accepted from stored hashes on bind ๐Ÿ› ๏ธ
  • dsconf plugin pwstorage-scheme pbkdf2-sha1 delete-accept-max-iterations โ€” remove the accept max iterations override, revert to default ๐Ÿงน

COMMAND 'dsconf plugin pwstorage-scheme pbkdf2-sha1 get-num-iterations'

usage: dsconf [-v] [-j] instance plugin pwstorage-scheme pbkdf2-sha1
get-num-iterations
       [-h]

COMMAND 'dsconf plugin pwstorage-scheme pbkdf2-sha1 set-num-iterations'

usage: dsconf [-v] [-j] instance plugin pwstorage-scheme pbkdf2-sha1
set-num-iterations
       [-h] iterations
  • iterations โ€” number of iterations (10,000-10,000,000) ๐Ÿ“

COMMAND 'dsconf plugin pwstorage-scheme pbkdf2-sha1 get-accept-max-iterations'

usage: dsconf [-v] [-j] instance plugin pwstorage-scheme pbkdf2-sha1
get-accept-max-iterations
       [-h]

COMMAND 'dsconf plugin pwstorage-scheme pbkdf2-sha1 set-accept-max-iterations'

usage: dsconf [-v] [-j] instance plugin pwstorage-scheme pbkdf2-sha1
set-accept-max-iterations
       [-h] iterations
  • iterations โ€” maximum iterations accepted on bind (10,000-10,000,000) ๐ŸŒธ

COMMAND 'dsconf plugin pwstorage-scheme pbkdf2-sha1 delete-accept-max-iterations'

usage: dsconf [-v] [-j] instance plugin pwstorage-scheme pbkdf2-sha1
delete-accept-max-iterations
       [-h]

๐Ÿ’œ COMMAND 'dsconf plugin pwstorage-scheme pbkdf2-sha256' ๐Ÿ’œ

usage: dsconf [-v] [-j] instance plugin pwstorage-scheme pbkdf2-sha256
       [-h]
       {get-num-iterations,set-num-iterations,get-accept-max-iterations,set-accept-max-iterations,delete-accept-max-iterations}
       ...

POSITIONAL ARGUMENTS 'dsconf plugin pwstorage-scheme pbkdf2-sha256'

  • dsconf plugin pwstorage-scheme pbkdf2-sha256 get-num-iterations โ€” get number of iterations ๐Ÿ”ข
  • dsconf plugin pwstorage-scheme pbkdf2-sha256 set-num-iterations โ€” set number of iterations โœจ
  • dsconf plugin pwstorage-scheme pbkdf2-sha256 get-accept-max-iterations โ€” get the maximum iterations accepted from stored hashes on bind ๐Ÿ”
  • dsconf plugin pwstorage-scheme pbkdf2-sha256 set-accept-max-iterations โ€” set the maximum iterations accepted from stored hashes on bind ๐Ÿ› ๏ธ
  • dsconf plugin pwstorage-scheme pbkdf2-sha256 delete-accept-max-iterations โ€” remove the accept max iterations override, revert to default ๐Ÿงน

COMMAND 'dsconf plugin pwstorage-scheme pbkdf2-sha256 get-num-iterations'

usage: dsconf [-v] [-j] instance plugin pwstorage-scheme pbkdf2-sha256
get-num-iterations
       [-h]

COMMAND 'dsconf plugin pwstorage-scheme pbkdf2-sha256 set-num-iterations'

usage: dsconf [-v] [-j] instance plugin pwstorage-scheme pbkdf2-sha256
set-num-iterations
       [-h] iterations
  • iterations โ€” number of iterations (10,000-10,000,000) ๐Ÿ’…

COMMAND 'dsconf plugin pwstorage-scheme pbkdf2-sha256 get-accept-max-iterations'

usage: dsconf [-v] [-j] instance plugin pwstorage-scheme pbkdf2-sha256
get-accept-max-iterations
       [-h]

COMMAND 'dsconf plugin pwstorage-scheme pbkdf2-sha256 set-accept-max-iterations'

usage: dsconf [-v] [-j] instance plugin pwstorage-scheme pbkdf2-sha256
set-accept-max-iterations
       [-h] iterations
  • iterations โ€” maximum iterations accepted on bind (10,000-10,000,000) ๐ŸŒˆ

COMMAND 'dsconf plugin pwstorage-scheme pbkdf2-sha256 delete-accept-max-iterations'

usage: dsconf [-v] [-j] instance plugin pwstorage-scheme pbkdf2-sha256
delete-accept-max-iterations
       [-h]

๐Ÿงš COMMAND 'dsconf plugin pwstorage-scheme pbkdf2-sha256-legacy' ๐Ÿงš

usage: dsconf [-v] [-j] instance plugin pwstorage-scheme
pbkdf2-sha256-legacy
       [-h] {get-accept-max-iterations,set-accept-max-iterations} ...

not me noticing this one only has two sub-commands instead of fiveโ€ฆ the legacy scheme keeps it simple, periodt ๐Ÿ’…

POSITIONAL ARGUMENTS 'dsconf plugin pwstorage-scheme pbkdf2-sha256-legacy'

  • dsconf plugin pwstorage-scheme pbkdf2-sha256-legacy get-accept-max-iterations โ€” get maximum accepted iterations ๐Ÿ”
  • dsconf plugin pwstorage-scheme pbkdf2-sha256-legacy set-accept-max-iterations โ€” set maximum accepted iterations ๐Ÿ› ๏ธ

COMMAND 'dsconf plugin pwstorage-scheme pbkdf2-sha256-legacy get-accept-max-iterations'

usage: dsconf [-v] [-j] instance plugin pwstorage-scheme
pbkdf2-sha256-legacy get-accept-max-iterations
       [-h]

COMMAND 'dsconf plugin pwstorage-scheme pbkdf2-sha256-legacy set-accept-max-iterations'

usage: dsconf [-v] [-j] instance plugin pwstorage-scheme
pbkdf2-sha256-legacy set-accept-max-iterations
       [-h] iterations
  • iterations โ€” maximum accepted iterations, and look at this range bestie: (2,048-2,147,483,647). that's a big range. no cap ๐Ÿ˜ญ

โญ COMMAND 'dsconf plugin pwstorage-scheme pbkdf2-sha512' โญ

usage: dsconf [-v] [-j] instance plugin pwstorage-scheme pbkdf2-sha512
       [-h]
       {get-num-iterations,set-num-iterations,get-accept-max-iterations,set-accept-max-iterations,delete-accept-max-iterations}
       ...

last scheme, and she's the big one ๐Ÿซถ

POSITIONAL ARGUMENTS 'dsconf plugin pwstorage-scheme pbkdf2-sha512'

  • dsconf plugin pwstorage-scheme pbkdf2-sha512 get-num-iterations โ€” get number of iterations ๐Ÿ”ข
  • dsconf plugin pwstorage-scheme pbkdf2-sha512 set-num-iterations โ€” set number of iterations โœจ
  • dsconf plugin pwstorage-scheme pbkdf2-sha512 get-accept-max-iterations โ€” get the maximum iterations accepted from stored hashes on bind ๐Ÿ”
  • dsconf plugin pwstorage-scheme pbkdf2-sha512 set-accept-max-iterations โ€” set the maximum iterations accepted from stored hashes on bind ๐Ÿ› ๏ธ
  • dsconf plugin pwstorage-scheme pbkdf2-sha512 delete-accept-max-iterations โ€” remove the accept max iterations override, revert to default ๐Ÿงน

COMMAND 'dsconf plugin pwstorage-scheme pbkdf2-sha512 get-num-iterations'

usage: dsconf [-v] [-j] instance plugin pwstorage-scheme pbkdf2-sha512
get-num-iterations
       [-h]

COMMAND 'dsconf plugin pwstorage-scheme pbkdf2-sha512 set-num-iterations'

usage: dsconf [-v] [-j] instance plugin pwstorage-scheme pbkdf2-sha512
set-num-iterations
       [-h] iterations
  • iterations โ€” number of iterations (10,000-10,000,000) ๐Ÿ’–

COMMAND 'dsconf plugin pwstorage-scheme pbkdf2-sha512 get-accept-max-iterations'

usage: dsconf [-v] [-j] instance plugin pwstorage-scheme pbkdf2-sha512
get-accept-max-iterations
       [-h]

COMMAND 'dsconf plugin pwstorage-scheme pbkdf2-sha512 set-accept-max-iterations'

usage: dsconf [-v] [-j] instance plugin pwstorage-scheme pbkdf2-sha512
set-accept-max-iterations
       [-h] iterations
  • iterations โ€” maximum iterations accepted on bind (10,000-10,000,000) ๐ŸŒธ

COMMAND 'dsconf plugin pwstorage-scheme pbkdf2-sha512 delete-accept-max-iterations'

usage: dsconf [-v] [-j] instance plugin pwstorage-scheme pbkdf2-sha512
delete-accept-max-iterations
       [-h]

๐Ÿ‘‘ COMMAND 'dsconf plugin list' ๐Ÿ‘‘

usage: dsconf [-v] [-j] instance plugin list [-h]

and there she is โ€” the "just show me everything" command ๐ŸŒˆ no options, no drama, just the list of plugins. we love a low-maintenance icon ๐Ÿ‘‘

COMMAND 'dsconf plugin show' ๐Ÿ”๐Ÿ’–

Okay bestie, this one is lowkey a โ€œwhere my plugin at?โ€ vibe check. It searches for a plugin, periodt.

usage: dsconf [-v] [-j] instance plugin show [-h] [selector]
  • selector โ€” the plugin you're searching for, no cap ๐Ÿฆ‹

COMMAND 'dsconf plugin set' โœจ๐Ÿ’…

This command edits a plugin, so it's giving main character energy. Peep the usage:

usage: dsconf [-v] [-j] instance plugin set [-h] [--type TYPE]
                                            [--enabled {on,off}] [--path
       PATH]
                                            [--initfunc INITFUNC] [--id
       ID]
                                            [--vendor VENDOR]
                                            [--version VERSION]
                                            [--description DESCRIPTION]
                                            [--depends-on-type
       DEPENDS_ON_TYPE]
                                            [--depends-on-named
       DEPENDS_ON_NAMED]
                                            [--precedence PRECEDENCE]
                                            [selector]
  • selector โ€” the plugin you're editing, bestie ๐ŸŽ€

OPTIONS 'dsconf plugin set' ๐Ÿ’…

  • --type TYPE โ€” the type of plugin.
  • --enabled {on,off} โ€” identifies whether or not the plugin is enabled.
  • --path PATH โ€” the plugin library name, without the library suffix.
  • --initfunc INITFUNC โ€” an initialization function of the plugin.
  • --id ID โ€” the plugin ID.
  • --vendor VENDOR โ€” the vendor of the plugin.
  • --version VERSION โ€” the version of the plugin.
  • --description DESCRIPTION โ€” the description of the plugin.
  • --depends-on-type DEPENDS_ON_TYPE โ€” all plug-ins with a type value that matches one of the values in the following valid range will be started by the server prior to this plug-in.
  • --depends-on-named DEPENDS_ON_NAMED โ€” the plug-in name matching one of the following values will be started by the server prior to this plug-in.
  • --precedence PRECEDENCE โ€” the priority it has in the execution order of plug-ins.

COMMAND 'dsconf pwpolicy' ๐ŸŽ€๐ŸŒˆ

Password policy central, bestie. The vibe is very โ€œget, set, list, fix up,โ€ iykyk.

usage: dsconf [-v] [-j] instance pwpolicy [-h]
       {get,set,list-schemes,fixup-shadow} ...

POSITIONAL ARGUMENTS 'dsconf pwpolicy' ๐Ÿซถ

  • dsconf pwpolicy get โ€” get the global password policy entry.
  • dsconf pwpolicy set โ€” set an attribute in a global password policy.
  • dsconf pwpolicy list-schemes โ€” get a list of the current password storage schemes.
  • dsconf pwpolicy fixup-shadow โ€” create a task to set shadowLastChange on ShadowAccount entries.

COMMAND 'dsconf pwpolicy get' ๐Ÿ’–

Simple, iconic, no notes. It just gets the global password policy entry.

usage: dsconf [-v] [-j] instance pwpolicy get [-h]

COMMAND 'dsconf pwpolicy set' โœจ๐Ÿ‘‘

This usage is a whole mood โ€” every flag is here, so don't skip a single one:

usage: dsconf instance [-v] [-j] pwpolicy set [-h] [--pwdscheme
       PWDSCHEME]
                                                     [--pwdchange PWDCHANGE]
                                                     [--pwdmustchange
       PWDMUSTCHANGE]
                                                     [--pwdhistory PWDHISTORY]
                                                     [--pwdhistorycount
       PWDHISTORYCOUNT]
                                                     [--pwdadmin PWDADMIN]
                                                     [--pwdadminskipupdates
       PWDADMINSKIPUPDATES]
                                                     [--pwdtrack PWDTRACK]
                                                     [--pwdwarning PWDWARNING]
                                                     [--pwdexpire PWDEXPIRE]
                                                     [--pwdmaxage PWDMAXAGE]
                                                     [--pwdminage PWDMINAGE]
                                                     [--pwdgracelimit
       PWDGRACELIMIT]
                                                     [--pwdsendexpiring
       PWDSENDEXPIRING]
                                                     [--pwdlockout PWDLOCKOUT]
                                                     [--pwdunlock PWDUNLOCK]
                                                     [--pwdlockoutduration
       PWDLOCKOUTDURATION]
                                                     [--pwdmaxfailures
       PWDMAXFAILURES]
                                                     [--pwdresetfailcount
       PWDRESETFAILCOUNT]
                                                     [--pwdchecksyntax
       PWDCHECKSYNTAX]
                                                     [--pwdminlen PWDMINLEN]
                                                     [--pwdmindigits
       PWDMINDIGITS]
                                                     [--pwdminalphas
       PWDMINALPHAS]
                                                     [--pwdminuppers
       PWDMINUPPERS]
                                                     [--pwdminlowers
       PWDMINLOWERS]
                                                     [--pwdminspecials
       PWDMINSPECIALS]
                                                     [--pwdmin8bits
       PWDMIN8BITS]
                                                     [--pwdmaxrepeats
       PWDMAXREPEATS]
                                                     [--pwdpalindrome
       PWDPALINDROME]
                                                     [--pwdmaxseq PWDMAXSEQ]
                                                     [--pwdmaxseqsets
       PWDMAXSEQSETS]
                                                     [--pwdmaxclasschars
       PWDMAXCLASSCHARS]
                                                     [--pwdmincatagories
       PWDMINCATAGORIES]
                                                     [--pwdmintokenlen
       PWDMINTOKENLEN]
                                                     [--pwdbadwords
       PWDBADWORDS]
                                                     [--pwduserattrs
       PWDUSERATTRS]
                                                     [--pwddictcheck
       PWDDICTCHECK]
                                                     [--pwddictpath
       PWDDICTPATH]
                                                     [--pwptprmaxuse
       PWPTPRMAXUSE]
                                                     [--pwptprdelayexpireat
       PWPTPRDELAYEXPIREAT]
                                                     [--pwptprdelayvalidfrom
       PWPTPRDELAYVALIDFROM]
                                                     [--pwdlocal PWDLOCAL]
                                                     [--pwdisglobal
       PWDISGLOBAL]
                                                     [--pwdallowhash
       PWDALLOWHASH]
                                                     [--pwpinheritglobal
       PWPINHERITGLOBAL]

โœจ OPTIONS for dsconf pwpolicy set โœจ

Okay bestie, buckle up, this is the big one โ€” every knob you can twist on a password policy, all in one place. Nothing scary, just a LOT of them. ๐ŸŽ€

  • --pwdscheme PWDSCHEME โ€” the password storage scheme, aka how your password gets scrambled before it hits the disk. ๐Ÿ”
  • --pwdchange PWDCHANGE โ€” lets users change their own passwords. Yes, this is a permission. Yes, it matters.
  • --pwdmustchange PWDMUSTCHANGE โ€” the classic: after an admin resets your password, you gotta change it before you do anything else. No skipping. ๐Ÿ’…
  • --pwdhistory PWDHISTORY โ€” turn password history on, or off. That's the whole vibe.
  • --pwdhistorycount PWDHISTORYCOUNT โ€” how many old passwords get kept in the history stash. ๐Ÿ—‚๏ธ
  • --pwdadmin PWDADMIN โ€” the DN of an entry (or a whole group of accounts) that gets to bypass password policy constraints. Big power, handle with care. ๐Ÿ‘‘
  • --pwdadminskipupdates PWDADMINSKIPUPDATES โ€” set this to on if the Password Admin's own password update should not trigger updates to the password state attributes (passwordExpirationtime, passwordHistory, etc). So their reset stays quiet.
  • --pwdtrack PWDTRACK โ€” set to on to actually track the time the password was last changed. โฐ
  • --pwdwarning PWDWARNING โ€” sends an expiring warning if the password expires within this window (the value is in seconds).
  • --pwdexpire PWDEXPIRE โ€” set to on to enable password expiration at all.
  • --pwdmaxage PWDMAXAGE โ€” the password expiration time, in seconds. โณ
  • --pwdminage PWDMINAGE โ€” how many seconds must pass before a user is even allowed to change their password again. Anti-chaos measure fr.
  • --pwdgracelimit PWDGRACELIMIT โ€” how many logins you still get after your password has already expired. Grace period, iconic behavior.
  • --pwdsendexpiring PWDSENDEXPIRING โ€” set to on to always send the expiring control, no matter what the warning period says.
  • --pwdlockout PWDLOCKOUT โ€” set to on to enable account lockout. ๐Ÿ”’
  • --pwdunlock PWDUNLOCK โ€” set to on and an account can become unlocked again after the lockout duration runs out. Self-healing era.
  • --pwdlockoutduration PWDLOCKOUTDURATION โ€” the number of seconds an account stays locked out. Sit in time-out bestie. ๐Ÿ˜ญ
  • --pwdmaxfailures PWDMAXFAILURES โ€” the max number of failed password attempts allowed before the account gets locked.
  • --pwdresetfailcount PWDRESETFAILCOUNT โ€” how many seconds to wait before reducing the failed login count on an account.
  • --pwdchecksyntax PWDCHECKSYNTAX โ€” set to on to enable password syntax checking. This is the quality control era. โœจ
  • --pwdminlen PWDMINLEN โ€” minimum number of characters required in a password.
  • --pwdmindigits PWDMINDIGITS โ€” minimum number of digit/number characters in a password.
  • --pwdminalphas PWDMINALPHAS โ€” minimum number of alpha characters required in a password.
  • --pwdminuppers PWDMINUPPERS โ€” minimum number of uppercase characters required in a password.
  • --pwdminlowers PWDMINLOWERS โ€” minimum number of lowercase characters required in a password.
  • --pwdminspecials PWDMINSPECIALS โ€” minimum number of special characters required in a password. !@#$%^&* stans rise up. ๐ŸŽ‰
  • --pwdmin8bits PWDMIN8BITS โ€” minimum number of 8-bit characters required in a password.
  • --pwdmaxrepeats PWDMAXREPEATS โ€” the max number of times the same character can appear sequentially in the password. aaa? Not on her watch.
  • --pwdpalindrome PWDPALINDROME โ€” set to on to reject passwords that are palindromes. Sorry to racecar. ๐ŸŽ๏ธ
  • --pwdmaxseq PWDMAXSEQ โ€” the max number of allowed monotonic character sequences in a password (abc, 123, that whole situation).
  • --pwdmaxseqsets PWDMAXSEQSETS โ€” the max number of allowed monotonic character sequences that can be duplicated in a password.
  • --pwdmaxclasschars PWDMAXCLASSCHARS โ€” the max number of sequential characters from the same character class allowed in a password.
  • --pwdmincatagories PWDMINCATAGORIES โ€” the minimum number of syntax category checks. (Yes, the spelling is catagories, we keep it exactly as-is, no cap. ๐Ÿ™ˆ)
  • --pwdmintokenlen PWDMINTOKENLEN โ€” sets the smallest attribute value length used for trivial/user-words checking. This also impacts --pwduserattrs.
  • --pwdbadwords PWDBADWORDS โ€” a space-separated list of words that can not be in a password. ๐Ÿ’€
  • --pwduserattrs PWDUSERATTRS โ€” a space-separated list of attributes whose values can not appear in the password (peep --pwdmintokenlen).
  • --pwddictcheck PWDDICTCHECK โ€” set to on to enforce CrackLib dictionary checking.
  • --pwddictpath PWDDICTPATH โ€” filesystem path to specific/custom CrackLib dictionary files.
  • --pwptprmaxuse PWPTPRMAXUSE โ€” number of times a reset password can be used for authentication.
  • --pwptprdelayexpireat PWPTPRDELAYEXPIREAT โ€” number of seconds after which a reset password expires.
  • --pwptprdelayvalidfrom PWPTPRDELAYVALIDFROM โ€” number of seconds to wait before using a reset password to authenticate.
  • --pwdlocal PWDLOCAL โ€” set to on to enable fine-grained (subtree/user-level) password policies.
  • --pwdisglobal PWDISGLOBAL โ€” set to on to enable password policy state attributes to be replicated.
  • --pwdallowhash PWDALLOWHASH โ€” set to on to allow adding prehashed passwords.
  • --pwpinheritglobal PWPINHERITGLOBAL โ€” set to on to let local policies inherit the global policy. Generational wealth but for password rules. ๐Ÿซถ

๐ŸŒˆ COMMAND dsconf pwpolicy list-schemes ๐ŸŒˆ

Just wants to show you all the schemes available. Low effort, high reward.

usage: dsconf [-v] [-j] instance pwpolicy list-schemes [-h]

๐Ÿ”ฅ COMMAND dsconf pwpolicy fixup-shadow ๐Ÿ”ฅ

The "hey, go back and sync up all those shadow accounts" command.

usage: dsconf [-v] [-j] instance pwpolicy fixup-shadow [-h] [--force]
                                                              [--watch]
                                                              suffix
  • suffix โ€” the LDAP suffix to search (subtree) for objectClass ShadowAccount.

๐Ÿงš OPTIONS for dsconf pwpolicy fixup-shadow ๐Ÿงš

  • --force โ€” updates all users under the suffix regardless of whether shadowLastChange is set. No skipping anyone. ๐Ÿ’…
  • --watch โ€” watches the task's status and waits for it to finish. Patience era. โณ

๐Ÿ’– COMMAND dsconf localpwp ๐Ÿ’–

Local password policies!! The fine-grained era. Here's the shape of it:

usage: dsconf [-v] [-j] instance localpwp [-h]
                                       {list,get,set,remove,adduser,addsubtree}
       ...

๐ŸŽ€ POSITIONAL ARGUMENTS for dsconf localpwp ๐ŸŽ€

  • dsconf localpwp list โ€” list all the local password policies. Shopping-cart energy. ๐Ÿ›’
  • dsconf localpwp get โ€” get one local password policy entry.
  • dsconf localpwp set โ€” set an attribute in a local password policy.
  • dsconf localpwp remove โ€” remove a local password policy. Bye bestie. ๐Ÿ‘‹
  • dsconf localpwp adduser โ€” add a new user password policy.
  • dsconf localpwp addsubtree โ€” add a new subtree password policy.

๐Ÿฆ‹ COMMAND dsconf localpwp list ๐Ÿฆ‹

usage: dsconf [-v] [-j] instance localpwp list [-h] [DN]
  • DN โ€” the suffix to search for local password policies.

๐ŸŒธ COMMAND dsconf localpwp get ๐ŸŒธ

usage: dsconf [-v] [-j] instance localpwp get [-h] DN
  • DN โ€” get the local policy for this entry DN.

๐Ÿ’œ COMMAND dsconf localpwp set ๐Ÿ’œ

Okay so this one takes the ENTIRE option list from dsconf pwpolicy set and points it at a specific DN. Same flags, local scope. Here's the usage in all its glory:

usage: dsconf [-v] [-j] instance localpwp set [-h] [--pwdscheme
PWDSCHEME]
                                                     [--pwdchange PWDCHANGE]
                                                     [--pwdmustchange
PWDMUSTCHANGE]
                                                     [--pwdhistory PWDHISTORY]
                                                     [--pwdhistorycount
PWDHISTORYCOUNT]
                                                     [--pwdadmin PWDADMIN]
                                                     [--pwdadminskipupdates
PWDADMINSKIPUPDATES]
                                                     [--pwdtrack PWDTRACK]
                                                     [--pwdwarning PWDWARNING]
                                                     [--pwdexpire PWDEXPIRE]
                                                     [--pwdmaxage PWDMAXAGE]
                                                     [--pwdminage PWDMINAGE]
                                                     [--pwdgracelimit
PWDGRACELIMIT]
                                                     [--pwdsendexpiring
PWDSENDEXPIRING]
                                                     [--pwdlockout PWDLOCKOUT]
                                                     [--pwdunlock PWDUNLOCK]
                                                     [--pwdlockoutduration
PWDLOCKOUTDURATION]
                                                     [--pwdmaxfailures
PWDMAXFAILURES]
                                                     [--pwdresetfailcount
PWDRESETFAILCOUNT]
                                                     [--pwdchecksyntax
PWDCHECKSYNTAX]
                                                     [--pwdminlen PWDMINLEN]
                                                     [--pwdmindigits
PWDMINDIGITS]
                                                     [--pwdminalphas
PWDMINALPHAS]
                                                     [--pwdminuppers
PWDMINUPPERS]
                                                     [--pwdminlowers
PWDMINLOWERS]
                                                     [--pwdminspecials
PWDMINSPECIALS]
                                                     [--pwdmin8bits
PWDMIN8BITS]
                                                     [--pwdmaxrepeats
PWDMAXREPEATS]
                                                     [--pwdpalindrome
PWDPALINDROME]
                                                     [--pwdmaxseq PWDMAXSEQ]
                                                     [--pwdmaxseqsets
PWDMAXSEQSETS]
                                                     [--pwdmaxclasschars
PWDMAXCLASSCHARS]
                                                     [--pwdmincatagories
PWDMINCATAGORIES]
                                                     [--pwdmintokenlen
PWDMINTOKENLEN]
                                                     [--pwdbadwords
PWDBADWORDS]
                                                     [--pwduserattrs
PWDUSERATTRS]
                                                     [--pwddictcheck
PWDDICTCHECK]
                                                     [--pwddictpath
PWDDICTPATH]
                                                     [--pwptprmaxuse
PWPTPRMAXUSE]
                                                     [--pwptprdelayexpireat
PWPTPRDELAYEXPIREAT]
                                                     [--pwptprdelayvalidfrom
PWPTPRDELAYVALIDFROM]
                                                     DN
  • DN โ€” set the local policy for this entry DN.
Yeah, it's a wall of text. That's just what happens when your password policy has โœจrangeโœจ. Every single flag above means exactly what it means in dsconf pwpolicy set, only applied right here at this DN instead of globally. ๐Ÿ’…

OPTIONS for dsconf localpwp set ๐Ÿ’…

okay bestie, this is the big one โ€” literally every knob for the local password policy. same flags as the main pwpolicy fam, but scoped to one lil entry. let's go ๐Ÿซถ

  • --pwdscheme PWDSCHEME โ€” the password storage scheme, aka how the password actually gets scrambled before it's stored ๐Ÿ”
  • --pwdchange PWDCHANGE โ€” lets users change their own passwords, yes ma'am ๐Ÿ’…
  • --pwdmustchange PWDMUSTCHANGE โ€” forces users to change their password after an admin resets it. no sneaky reuse of the temp one ๐Ÿ’€
  • --pwdhistory PWDHISTORY โ€” to turn password history on, set this to "on", otherwise "off". that's it, that's the whole vibe โœจ
  • --pwdhistorycount PWDHISTORYCOUNT โ€” how many old passwords get kept in the history. the more the merrier (and the safer) ๐ŸŽ€
  • --pwdadmin PWDADMIN โ€” the DN of an entry or a group of accounts that can bypass password policy constraints. main character exemption energy ๐Ÿ‘‘
  • --pwdadminskipupdates PWDADMINSKIPUPDATES โ€” set to "on" if the Password Admin's password update should not trigger updates to the password state attributes (passwordExpirationtime, passwordHistory, etc.). lowkey a big deal, don't skip past this one ๐Ÿ™ˆ
  • --pwdtrack PWDTRACK โ€” set to "on" to track the time the password was last changed โฐ
  • --pwdwarning PWDWARNING โ€” send an expiring warning if the password expires within this time (in seconds). a lil heads up before disaster ๐Ÿšจ
  • --pwdexpire PWDeXPIRE โ€” wait no, it's --pwdexpire PWDeXPIRE โ€” set to "on" to enable password expiration. yes, passwords die eventually, it's giving mortality ๐Ÿ˜ญ
  • --pwdmaxage PWDMAXAGE โ€” the password expiration time, in seconds โณ
  • --pwdminage PWDMINAGE โ€” how many seconds must pass before a user can change their password again. no rapid-fire swapping, bestie ๐Ÿšซ
  • --pwdgracelimit PWDGRACELIMIT โ€” the number of allowed logins after the password has already expired. a lil grace period, we love a forgiving queen ๐ŸŒธ
  • --pwdsendexpiring PWDSENDEXPIRING โ€” set to "on" to always send the expiring control regardless of the warning period ๐Ÿ“ฌ
  • --pwdlockout PWDLOCKOUT โ€” set to "on" to enable account lockout ๐Ÿ”’
  • --pwdunlock PWDUNLOCK โ€” set to "on" to allow an account to become unlocked after the lockout duration. the comeback arc โœจ
  • --pwdlockoutduration PWDLOCKOUTDURATION โ€” the number of seconds an account stays locked out โฑ๏ธ
  • --pwdmaxfailures PWDMAXFAILURES โ€” the max number of allowed failed password attempts before the account gets locked. try again... and again... and boom, locked ๐Ÿ’€
  • --pwdresetfailcount PWDRESETFAILCOUNT โ€” the number of seconds to wait before reducing the failed login count on an account ๐Ÿงฎ
  • --pwdchecksyntax PWDCHECKSYNTAX โ€” set to "on" to enable password syntax checking. the grammar police but for your password ๐Ÿ•ต๏ธ
  • --pwdminlen PWDMINLEN โ€” the minimum number of characters required in a password ๐Ÿ“
  • --pwdmindigits PWDMINDIGITS โ€” the minimum number of digit/number characters in a password. 1234 girlies, your time is now ๐Ÿ”ข
  • --pwdminalphas PWDMINALPHAS โ€” the minimum number of alpha characters required in a password ๐Ÿ”ค
  • --pwdminuppers PWDMINUPPERS โ€” the minimum number of uppercase characters required in a password. SCREAM IT ๐Ÿ“ฃ
  • --pwdminlowers PWDMINLOWERS โ€” the minimum number of lowercase characters required in a password. soft launch, quiet luxury ๐ŸŒ™
  • --pwdminspecials PWDMINSPECIALS โ€” the minimum number of special characters required in a password. !@#$% icons only ๐Ÿ’…
  • --pwdmin8bits PWDMIN8BITS โ€” the minimum number of 8-bit characters required in a password ๐ŸŒ
  • --pwdmaxrepeats PWDMAXREPEATS โ€” the maximum number of times the same character can appear sequentially in the password. aaaaa bestie, no ๐Ÿ”
  • --pwdpalindrome PWDPALINDROME โ€” set to "on" to reject passwords that are palindromes. sorry racecar, you're out ๐ŸŽ๏ธ
  • --pwdmaxseq PWDMAXSEQ โ€” the maximum number of allowed monotonic character sequences in a password (you know, like abcd or 4321) ๐Ÿ“‰
  • --pwdmaxseqsets PWDMAXSEQSETS โ€” the maximum number of allowed monotonic character sequences that can be duplicated in a password ๐Ÿ”‚
  • --pwdmaxclasschars PWDMAXCLASSCHARS โ€” the maximum number of sequential characters from the same character class that is allowed in a password ๐Ÿงฉ
  • --pwdmincatagories PWDMINCATAGORIES โ€” the minimum number of syntax category checks โœ…
  • --pwdmintokenlen PWDMINTOKENLEN โ€” sets the smallest attribute value length used for trivial/user word checking. this also impacts "--pwduserattrs" โš ๏ธ
  • --pwdbadwords PWDBADWORDS โ€” a space-separated list of words that can not be in a password. the banned list, no cap ๐Ÿšซ
  • --pwduserattrs PWDUSERATTRS โ€” a space-separated list of attributes whose values can not appear in the password (see "--pwdmintokenlen") ๐Ÿงฌ
  • --pwddictcheck PWDDICTCHECK โ€” set to "on" to enforce CrackLib dictionary checking ๐Ÿ“–
  • --pwddictpath PWDDICTPATH โ€” filesystem path to specific/custom CrackLib dictionary files ๐Ÿ“‚
  • --pwptprmaxuse PWPTPRMAXUSE โ€” the number of times a reset password can be used for authentication ๐Ÿ”„
  • --pwptprdelayexpireat PWPTPRDELAYEXPIREAT โ€” number of seconds after which a reset password expires ๐Ÿ•
  • --pwptprdelayvalidfrom PWPTPRDELAYVALIDFROM โ€” number of seconds to wait before using a reset password to authenticate. patience, bestie ๐Ÿง˜

COMMAND dsconf localpwp remove ๐Ÿ—‘๏ธ

usage:

dsconf [-v] [-j] instance localpwp remove [-h] DN
  • DN โ€” remove the local policy for this entry DN. bye bye, policy ๐Ÿซถ

COMMAND dsconf localpwp adduser ๐Ÿ‘ค

usage:

dsconf [-v] [-j] instance localpwp adduser [-h] [--pwdscheme PWDSCHEME]
                                                  [--pwdchange PWDCHANGE]
                                                  [--pwdmustchange PWDMUSTCHANGE]
                                                  [--pwdhistory PWDHISTORY]
                                                  [--pwdhistorycount PWDHISTORYCOUNT]
                                                  [--pwdadmin PWDADMIN]
                                                  [--pwdadminskipupdates PWDADMINSKIPUPDATES]
                                                  [--pwdtrack PWDTRACK]
                                                  [--pwdwarning PWDWARNING]
                                                  [--pwdexpire PWDEXPIRE]
                                                  [--pwdmaxage PWDMAXAGE]
                                                  [--pwdminage PWDMINAGE]
                                                  [--pwdgracelimit PWDGRACELIMIT]
                                                  [--pwdsendexpiring PWDSENDEXPIRING]
                                                  [--pwdlockout PWDLOCKOUT]
                                                  [--pwdunlock PWDUNLOCK]
                                                  [--pwdlockoutduration PWDLOCKOUTDURATION]
                                                  [--pwdmaxfailures PWDMAXFAILURES]
                                                  [--pwdresetfailcount PWDRESETFAILCOUNT]
                                                  [--pwdchecksyntax PWDCHECKSYNTAX]
                                                  [--pwdminlen PWDMINLEN]
                                                  [--pwdmindigits PWDMINDIGITS]
                                                  [--pwdminalphas PWDMINALPHAS]
                                                  [--pwdminuppers PWDMINUPPERS]
                                                  [--pwdminlowers PWDMINLOWERS]
                                                  [--pwdminspecials PWDMINSPECIALS]
                                                  [--pwdmin8bits PWDMIN8BITS]
                                                  [--pwdmaxrepeats PWDMAXREPEATS]
                                                  [--pwdpalindrome PWDPALINDROME]
                                                  [--pwdmaxseq PWDMAXSEQ]
                                                  [--pwdmaxseqsets PWDMAXSEQSETS]
                                                  [--pwdmaxclasschars PWDMAXCLASSCHARS]
                                                  [--pwdmincatagories PWDMINCATAGORIES]
                                                  [--pwdmintokenlen PWDMINTOKENLEN]
                                                  [--pwdbadwords PWDBADWORDS]
                                                  [--pwduserattrs PWDUSERATTRS]
                                                  [--pwddictcheck PWDDICTCHECK]
                                                  [--pwddictpath PWDDICTPATH]
                                                  [--pwptprmaxuse PWPTPRMAXUSE]
                                                  [--pwptprdelayexpireat PWPTPRDELAYEXPIREAT]
                                                  [--pwptprdelayvalidfrom PWPTPRDELAYVALIDFROM]
                                                  DN
  • DN โ€” add/replace the local password policy for this entry DN. new policy, who dis ๐Ÿ’–

OPTIONS dsconf localpwp adduser ๐Ÿ’…

okay so this is a LOT of knobs, bestie, but every single one of them is here, no skips, no shortcuts. this is you building a whole password policy from scratch, so buckle up ๐ŸŽ€

  • --pwdscheme PWDSCHEME โ€” the password storage scheme, aka how the password gets hashed and kept.
  • --pwdchange PWDCHANGE โ€” lets users change their own passwords. cute, democratic, slay.
  • --pwdmustchange PWDMUSTCHANGE โ€” users HAVE to change their password after an admin resets it. no lurking with the temp one.
  • --pwdhistory PWDHISTORY โ€” turns password history on or off. set it to "on" to enable, otherwise "off".
  • --pwdhistorycount PWDHISTORYCOUNT โ€” how many old passwords get kept in the history.
  • --pwdadmin PWDADMIN โ€” the DN of an entry or a group of accounts that gets to bypass password policy constraints. main character privileges fr.
  • --pwdadminskipupdates PWDADMINSKIPUPDATES โ€” set to "on" if the Password Admin's password update should not trigger updates to the password state attributes (passwordExpirationtime, passwordHistory, etc).
  • --pwdtrack PWDTRACK โ€” set to "on" to track the time the password was last changed.
  • --pwdwarning PWDWARNING โ€” send an expiring warning if the password expires within this time, in seconds.
  • --pwdexpire PWDEXPIRE โ€” set to "on" to enable password expiration. the clock starts ticking bestie.
  • --pwdmaxage PWDMAXAGE โ€” the password expiration time, in seconds.
  • --pwdminage PWDMINAGE โ€” how many seconds have to pass before a user is even allowed to change their password again.
  • --pwdgracelimit PWDGRACELIMIT โ€” how many logins you get after the password has already expired. the grace era ๐ŸŒธ
  • --pwdsendexpiring PWDSENDEXPIRING โ€” set to "on" to always send the expiring control, no matter what the warning period says.
  • --pwdlockout PWDLOCKOUT โ€” set to "on" to enable account lockout.
  • --pwdunlock PWDUNLOCK โ€” set to "on" to allow an account to become unlocked again once the lockout duration is up.
  • --pwdlockoutduration PWDLOCKOUTDURATION โ€” the number of seconds an account stays locked out.
  • --pwdmaxfailures PWDMAXFAILURES โ€” the max number of failed password attempts allowed before the account gets locked ๐Ÿ’€
  • --pwdresetfailcount PWDRESETFAILCOUNT โ€” the number of seconds to wait before reducing the failed login count on an account.
  • --pwdchecksyntax PWDCHECKSYNTAX โ€” set to "on" to enable password syntax checking.
  • --pwdminlen PWDMINLEN โ€” the minimum number of characters required in a password.
  • --pwdmindigits PWDMINDIGITS โ€” the minimum number of digit/number characters in a password.
  • --pwdminalphas PWDMINALPHAS โ€” the minimum number of alpha characters required in a password.
  • --pwdminuppers PWDMINUPPERS โ€” the minimum number of uppercase characters required in a password.
  • --pwdminlowers PWDMINLOWERS โ€” the minimum number of lowercase characters required in a password.
  • --pwdminspecials PWDMINSPECIALS โ€” the minimum number of special characters required in a password.
  • --pwdmin8bits PWDMIN8BITS โ€” the minimum number of 8-bit characters required in a password.
  • --pwdmaxrepeats PWDMAXREPEATS โ€” the maximum number of times the same character can appear sequentially in the password. aaaaa is not the vibe ๐Ÿ™ˆ
  • --pwdpalindrome PWDPALINDROME โ€” set to "on" to reject passwords that are palindromes.
  • --pwdmaxseq PWDMAXSEQ โ€” the maximum number of allowed monotonic character sequences in a password.
  • --pwdmaxseqsets PWDMAXSEQSETS โ€” the maximum number of allowed monotonic character sequences that can be duplicated in a password.
  • --pwdmaxclasschars PWDMAXCLASSCHARS โ€” the maximum number of sequential characters from the same character class that is allowed in a password.
  • --pwdmincatagories PWDMINCATAGORIES โ€” the minimum number of syntax category checks. (yes, that's how it's spelled in the flag, we keep it exactly โœจ)
  • --pwdmintokenlen PWDMINTOKENLEN โ€” sets the smallest attribute value length that is used for trivial/user words checking. this also impacts "--pwduserattrs".
  • --pwdbadwords PWDBADWORDS โ€” a space-separated list of words that can not be in a password. villain-word blocklist ๐Ÿšซ
  • --pwduserattrs PWDUSERATTRS โ€” a space-separated list of attributes whose values can not appear in the password. (See "--pwdmintokenlen".)
  • --pwddictcheck PWDDICTCHECK โ€” set to "on" to enforce CrackLib dictionary checking.
  • --pwddictpath PWDDICTPATH โ€” filesystem path to specific/custom CrackLib dictionary files.
  • --pwptprmaxuse PWPTPRMAXUSE โ€” number of times a reset password can be used for authentication.
  • --pwptprdelayexpireat PWPTPRDELAYEXPIREAT โ€” number of seconds after which a reset password expires.
  • --pwptprdelayvalidfrom PWPTPRDELAYVALIDFROM โ€” number of seconds to wait before using a reset password to authenticated.

COMMAND dsconf localpwp addsubtree ๐ŸŒˆ

okay so same energy as adduser, but this one is scoped to a whole subtree instead of a single user. the flag list is identical, so everything you just read above still applies ๐Ÿ’–

usage: dsconf [-v] [-j] instance localpwp addsubtree [-h]
                                                     [--pwdscheme
       PWDSCHEME]
                                                     [--pwdchange
       PWDCHANGE]
                                                     [--pwdmustchange
       PWDMUSTCHANGE]
                                                     [--pwdhistory
       PWDHISTORY]
                                                     [--pwdhistorycount
       PWDHISTORYCOUNT]
                                                     [--pwdadmin
       PWDADMIN]
                                                     [--pwdadminskipupdates
       PWDADMINSKIPUPDATES]
                                                     [--pwdtrack
       PWDTRACK]
                                                     [--pwdwarning
       PWDWARNING]
                                                     [--pwdexpire
       PWDEXPIRE]
                                                     [--pwdmaxage
       PWDMAXAGE]
                                                     [--pwdminage
       PWDMINAGE]
                                                     [--pwdgracelimit
       PWDGRACELIMIT]
                                                     [--pwdsendexpiring
       PWDSENDEXPIRING]
                                                     [--pwdlockout
       PWDLOCKOUT]
                                                     [--pwdunlock
       PWDUNLOCK]
                                                     [--pwdlockoutduration
       PWDLOCKOUTDURATION]
                                                     [--pwdmaxfailures
       PWDMAXFAILURES]
                                                     [--pwdresetfailcount
       PWDRESETFAILCOUNT]
                                                     [--pwdchecksyntax
       PWDCHECKSYNTAX]
                                                     [--pwdminlen
       PWDMINLEN]
                                                     [--pwdmindigits
       PWDMINDIGITS]
                                                     [--pwdminalphas
       PWDMINALPHAS]
                                                     [--pwdminuppers
       PWDMINUPPERS]
                                                     [--pwdminlowers
       PWDMINLOWERS]
                                                     [--pwdminspecials
       PWDMINSPECIALS]
                                                     [--pwdmin8bits
       PWDMIN8BITS]
                                                     [--pwdmaxrepeats
       PWDMAXREPEATS]
                                                     [--pwdpalindrome
       PWDPALINDROME]
                                                     [--pwdmaxseq
       PWDMAXSEQ]
                                                     [--pwdmaxseqsets
       PWDMAXSEQSETS]
                                                     [--pwdmaxclasschars
       PWDMAXCLASSCHARS]
                                                     [--pwdmincatagories
       PWDMINCATAGORIES]
                                                     [--pwdmintokenlen
       PWDMINTOKENLEN]
                                                     [--pwdbadwords
       PWDBADWORDS]
                                                     [--pwduserattrs
       PWDUSERATTRS]
                                                     [--pwddictcheck
       PWDDICTCHECK]
                                                     [--pwddictpath
       PWDDICTPATH]
                                                     [--pwptprmaxuse
       PWPTPRMAXUSE]
                                                     [--pwptprdelayexpireat
       PWPTPRDELAYEXPIREAT]
                                                     [--pwptprdelayvalidfrom
       PWPTPRDELAYVALIDFROM]
                                                     DN
  • DN โ€” add/replace the subtree policy for this entry DN. drop it in and the whole subtree is covered, periodt ๐Ÿ‘‘

โœจ OPTIONS 'dsconf localpwp addsubtree' โœจ

  • --pwdscheme PWDSCHEME โ€” bestie, this sets the password storage scheme ๐Ÿ’…
  • --pwdchange PWDCHANGE โ€” lets users change their own passwords ๐ŸŽ€
  • --pwdmustchange PWDMUSTCHANGE โ€” users gotta change their password after an administrator resets it ๐Ÿ”
  • --pwdhistory PWDHISTORY โ€” to enable password history, set this to "on", otherwise "off" โœจ
  • --pwdhistorycount PWDHISTORYCOUNT โ€” the number of passwords to keep in history ๐Ÿงš
  • --pwdadmin PWDADMIN โ€” the DN of an entry or a group of accounts that can bypass password policy constraints ๐Ÿ‘‘
  • --pwdadminskipupdates PWDADMINSKIPUPDATES โ€” set to "on" if the Password Admin's password update should not trigger updates to the password state attributes (passwordExpirationtime, passwordHistory, etc.) ๐Ÿ’€
  • --pwdtrack PWDTRACK โ€” set to "on" to track the time the password was last changed โฐ
  • --pwdwarning PWDWARNING โ€” send an expiring warning if password expires within this time (in seconds) โš ๏ธ
  • --pwdexpire PWDEXPIRE โ€” set to "on" to enable password expiration ๐Ÿ“…
  • --pwdmaxage PWDMAXAGE โ€” the password expiration time in seconds โณ
  • --pwdminage PWDMINAGE โ€” the number of seconds that must pass before a user can change their password ๐Ÿ•ฐ๏ธ
  • --pwdgracelimit PWDGRACELIMIT โ€” the number of allowed logins after the password has expired ๐Ÿšช
  • --pwdsendexpiring PWDSENDEXPIRING โ€” set to "on" to always send the expiring control regardless of the warning period ๐Ÿ“จ
  • --pwdlockout PWDLOCKOUT โ€” set to "on" to enable account lockout ๐Ÿ”’
  • --pwdunlock PWDUNLOCK โ€” set to "on" to allow an account to become unlocked after the lockout duration ๐Ÿ”“
  • --pwdlockoutduration PWDLOCKOUTDURATION โ€” the number of seconds an account stays locked out โฒ๏ธ
  • --pwdmaxfailures PWDMAXFAILURES โ€” the maximum number of allowed failed password attempts before the account gets locked ๐Ÿ’ฅ
  • --pwdresetfailcount PWDRESETFAILCOUNT โ€” the number of seconds to wait before reducing the failed login count on an account โ™ป๏ธ
  • --pwdchecksyntax PWDCHECKSYNTAX โ€” set to "on" to enable password syntax checking โœ…
  • --pwdminlen PWDMINLEN โ€” the minimum number of characters required in a password ๐Ÿ”ก
  • --pwdmindigits PWDMINDIGITS โ€” the minimum number of digit/number characters in a password ๐Ÿ”ข
  • --pwdminalphas PWDMINALPHAS โ€” the minimum number of alpha characters required in a password ๐Ÿ”ค
  • --pwdminuppers PWDMINUPPERS โ€” the minimum number of uppercase characters required in a password ๐Ÿ” 
  • --pwdminlowers PWDMINLOWERS โ€” the minimum number of lowercase characters required in a password ๐Ÿ”ก
  • --pwdminspecials PWDMINSPECIALS โ€” the minimum number of special characters required in a password โœจ
  • --pwdmin8bits PWDMIN8BITS โ€” the minimum number of 8-bit characters required in a password ๐ŸŒˆ
  • --pwdmaxrepeats PWDMAXREPEATS โ€” the maximum number of times the same character can appear sequentially in the password ๐Ÿ”
  • --pwdpalindrome PWDPALINDROME โ€” set to "on" to reject passwords that are palindromes ๐Ÿ™ƒ
  • --pwdmaxseq PWDMAXSEQ โ€” the maximum number of allowed monotonic character sequences in a password ๐Ÿ“ˆ
  • --pwdmaxseqsets PWDMAXSEQSETS โ€” the maximum number of allowed monotonic character sequences that can be duplicated in a password ๐Ÿ“Š
  • --pwdmaxclasschars PWDMAXCLASSCHARS โ€” the maximum number of sequential characters from the same character class that is allowed in a password ๐ŸŽฏ
  • --pwdmincatagories PWDMINCATAGORIES โ€” the minimum number of syntax category checks ๐Ÿ—‚๏ธ
  • --pwdmintokenlen PWDMINTOKENLEN โ€” sets the smallest attribute value length that is used for trivial/user words checking. This also impacts "--pwduserattrs" ๐Ÿ“
  • --pwdbadwords PWDBADWORDS โ€” a space-separated list of words that can not be in a password ๐Ÿšซ
  • --pwduserattrs PWDUSERATTRS โ€” a space-separated list of attributes whose values can not appear in the password (see "--pwdmintokenlen") ๐Ÿง
  • --pwddictcheck PWDDICTCHECK โ€” set to "on" to enforce CrackLib dictionary checking ๐Ÿ“–
  • --pwddictpath PWDDICTPATH โ€” filesystem path to specific/custom CrackLib dictionary files ๐Ÿ“
  • --pwptprmaxuse PWPTPRMAXUSE โ€” number of times a reset password can be used for authentication ๐Ÿ”
  • --pwptprdelayexpireat PWPTPRDELAYEXPIREAT โ€” number of seconds after which a reset password expires โŒ›
  • --pwptprdelayvalidfrom PWPTPRDELAYVALIDFROM โ€” number of seconds to wait before using a reset password to authenticated ๐Ÿ™ˆ

๐Ÿ’œ COMMAND 'dsconf replication' ๐Ÿ’œ

usage: dsconf [-v] [-j] instance replication [-h]
                                          {enable,disable,get-ruv,list,status,winsync-status,promote,create-manager,delete-manager,demote,get,set-changelog,get-changelog,export-changelog,import-changelog,set,monitor,lag-report}
       ...

๐ŸŒธ POSITIONAL ARGUMENTS 'dsconf replication' ๐ŸŒธ

  • dsconf replication enable โ€” enable replication for a suffix ๐Ÿ’–
  • dsconf replication disable โ€” disable replication for a suffix ๐Ÿšซ
  • dsconf replication get-ruv โ€” display the database RUV entry for a suffix ๐Ÿ”
  • dsconf replication list โ€” lists all the replicated suffixes ๐Ÿ“
  • dsconf replication status โ€” display the current status of all the replication agreements ๐Ÿ“Š
  • dsconf replication winsync-status โ€” display the current status of all the replication agreements ๐ŸชŸ
  • dsconf replication promote โ€” promote a replica to a hub or supplier ๐Ÿ‘‘
  • dsconf replication create-manager โ€” create a replication manager entry ๐Ÿ› ๏ธ
  • dsconf replication delete-manager โ€” delete a replication manager entry ๐Ÿ—‘๏ธ
  • dsconf replication demote โ€” demote replica to a hub or consumer ๐Ÿ“‰
  • dsconf replication get โ€” display the replication configuration โš™๏ธ
  • dsconf replication set-changelog โ€” set replication changelog attributes ๐Ÿ“
  • dsconf replication get-changelog โ€” display replication changelog attributes ๐Ÿ‘€
  • dsconf replication export-changelog โ€” export the Directory Server replication changelog to an LDIF file ๐Ÿ“ค
  • dsconf replication import-changelog โ€” restore/import Directory Server replication change log from an LDIF file. This is typically used when managing changelog encryption ๐Ÿ“ฅ
  • dsconf replication set โ€” set an attribute in the replication configuration ๐ŸŽ›๏ธ
  • dsconf replication monitor โ€” display the full replication topology report ๐Ÿ—บ๏ธ
  • dsconf replication lag-report โ€” generate detailed replication lag monitoring report โฑ๏ธ

โœจ COMMAND 'dsconf replication enable' โœจ

usage: dsconf [-v] [-j] instance replication enable [-h] --suffix SUFFIX
                                                           --role ROLE
                                                           [--replica-id
       REPLICA_ID]
                                                           [--bind-group-dn
       BIND_GROUP_DN]
                                                           [--bind-dn BIND_DN]
                                                           [--bind-passwd
       BIND_PASSWD]
                                                           [--bind-passwd-file
       BIND_PASSWD_FILE]
                                                           [--bind-passwd-prompt]

๐ŸŽ€ OPTIONS 'dsconf replication enable' ๐ŸŽ€

  • --suffix SUFFIX โ€” sets the DN of the suffix to be enabled for replication ๐ŸŒŸ
  • --role ROLE โ€” sets the replication role: "supplier", "hub", or "consumer" ๐Ÿ‘‘
  • --replica-id REPLICA_ID โ€” sets the replication identifier for a "supplier". Values range from 1 - 65534 ๐Ÿ”ข
  • --bind-group-dn BIND_GROUP_DN โ€” sets a group entry DN containing members that are "bind/supplier" DNs ๐Ÿซถ
  • --bind-dn BIND_DN โ€” sets the bind or supplier DN that can make replication updates ๐Ÿ’Œ
  • --bind-passwd BIND_PASSWD โ€” sets the password for replication manager (--bind-dn). This will create the manager entry if a value is set ๐Ÿ”‘
  • --bind-passwd-file BIND_PASSWD_FILE โ€” file containing the password ๐Ÿ“
  • --bind-passwd-prompt โ€” prompt for password ๐Ÿ™ˆ

๐Ÿ’… COMMAND 'dsconf replication disable' ๐Ÿ’…

usage: dsconf [-v] [-j] instance replication disable [-h] --suffix
       SUFFIX

๐ŸŒธ OPTIONS 'dsconf replication disable' ๐ŸŒธ

  • --suffix SUFFIX โ€” sets the DN of the suffix to have replication disabled ๐Ÿšซ

๐ŸŒˆ COMMAND 'dsconf replication get-ruv' ๐ŸŒˆ

usage: dsconf [-v] [-j] instance replication get-ruv [-h] --suffix
       SUFFIX

๐Ÿฆ‹ OPTIONS 'dsconf replication get-ruv' ๐Ÿฆ‹

  • --suffix SUFFIX โ€” sets the DN of the replicated suffix ๐Ÿ”

โญ COMMAND 'dsconf replication list' โญ

usage: dsconf [-v] [-j] instance replication list [-h]

๐ŸŽ€ COMMAND 'dsconf replication status' ๐ŸŽ€

usage: dsconf [-v] [-j] instance replication status [-h] --suffix SUFFIX
                                                           [--bind-dn BIND_DN]
                                                           [--bind-passwd
       BIND_PASSWD]
                                                           [--bind-passwd-file
       BIND_PASSWD_FILE]
                                                           [--bind-passwd-prompt]

โœจ OPTIONS 'dsconf replication status' โœจ

  • --suffix SUFFIX โ€” sets the DN of the replication suffix ๐Ÿ’–
  • --bind-dn BIND_DN โ€” sets the DN to use to authenticate to the consumer. If not set, current instance's root DN will be used. It will be used for all agreements ๐Ÿ”
  • --bind-passwd BIND_PASSWD โ€” sets the password for the bind DN. It will be used for all agreements ๐Ÿ”‘
  • --bind-passwd-file BIND_PASSWD_FILE โ€” file containing the password. It will be used for all agreements ๐Ÿ“
  • --bind-passwd-prompt โ€” prompt for passwords for each agreement's instance separately ๐Ÿ™ˆ

๐Ÿฆ‹ COMMAND 'dsconf replication winsync-status' ๐Ÿฆ‹

usage: dsconf instance [-v] [-j] replication winsync-status
              [-h] --suffix SUFFIX [--bind-dn BIND_DN] [--bind-passwd
       BIND_PASSWD]
              [--bind-passwd-file BIND_PASSWD_FILE] [--bind-passwd-prompt]

๐Ÿ’œ OPTIONS 'dsconf replication winsync-status' ๐Ÿ’œ

  • --suffix SUFFIX โ€” sets the DN of the replication suffix ๐ŸŒŸ
  • --bind-dn BIND_DN โ€” sets the DN to use to authenticate to the consumer. Currectly not used ๐Ÿ˜ญ
  • --bind-passwd BIND_PASSWD โ€” sets the password of the bind DN. Currectly not used ๐Ÿ˜ญ
  • --bind-passwd-file BIND_PASSWD_FILE โ€” file containing the password. Currectly not used ๐Ÿ˜ญ
  • --bind-passwd-prompt โ€” prompt for password. Currectly not used ๐Ÿ˜ญ

๐Ÿ’– COMMAND 'dsconf replication promote' ๐Ÿ’–

okay bestie, this one's for giving a replica a โœจglow upโœจ โ€” like, you're literally letting a consumer ascend to something with actual power. main character energy fr fr.

usage: dsconf [-v] [-j] instance replication promote [-h] --suffix SUFFIX
                                                     --newrole NEWROLE
                                                     [--replica-id REPLICA_ID]
                                                     [--bind-group-dn BIND_GROUP_DN]
                                                     [--bind-dn BIND_DN]

๐ŸŒˆ OPTIONS 'dsconf replication promote' ๐ŸŒˆ

  • --suffix SUFFIX โ€” sets the DN of the replication suffix you wanna promote. like, which subtree is getting the promotion letter ๐Ÿ’…
  • --newrole NEWROLE โ€” sets the new replica role to "hub" or "supplier". that's it, that's the glow up.
  • --replica-id REPLICA_ID โ€” sets the replication identifier for a "supplier". values range from 1 - 65534. no cap, that's the whole range ๐Ÿซถ
  • --bind-group-dn BIND_GROUP_DN โ€” sets a group entry DN containing members that are "bind/supplier" DNs
  • --bind-dn BIND_DN โ€” sets the bind or supplier DN that can make replication updates

๐Ÿฆ‹ COMMAND 'dsconf replication create-manager' ๐Ÿฆ‹

new manager just dropped ๐ŸŽ€ this is how you spawn a fresh replication manager entry, and honestly? she's iconic.

usage: dsconf [-v] [-j] instance replication create-manager
       [-h] [--name NAME] [--passwd PASSWD] [--passwd-file PASSWD_FILE]
       [--bind-passwd-file BIND_PASSWD_FILE] [--suffix SUFFIX]

๐ŸŒธ OPTIONS 'dsconf replication create-manager' ๐ŸŒธ

  • --name NAME โ€” sets the name of the new replication manager entry. For example, if the name is "replication manager" then the new manager entry's DN would be "cn=replication manager,cn=config". periodt.
  • --passwd PASSWD โ€” sets the password for replication manager. If not provided, you will be prompted for the password. no stress, she'll ask ๐Ÿ’…
  • --passwd-file PASSWD_FILE โ€” file containing the password for back compatibility
  • --bind-passwd-file BIND_PASSWD_FILE โ€” file containing the password
  • --suffix SUFFIX โ€” the DN of the replication suffix whose replication configuration you want to add this new manager to (OPTIONAL)

๐Ÿ’€ COMMAND 'dsconf replication delete-manager' ๐Ÿ’€

and now the opposite vibe โ€” she's leaving the group chat ๐Ÿ˜ญ

usage: dsconf [-v] [-j] instance replication delete-manager
       [-h] [--name NAME] [--suffix SUFFIX]

๐Ÿฅ€ OPTIONS 'dsconf replication delete-manager' ๐Ÿฅ€

  • --name NAME โ€” sets the name of the replication manager entry under cn=config: "cn=NAME,cn=config"
  • --suffix SUFFIX โ€” sets the DN of the replication suffix whose replication configuration you want to remove this manager from (OPTIONAL)

๐Ÿ’œ COMMAND 'dsconf replication demote' ๐Ÿ’œ

noooo not the demotion ๐Ÿ˜ญ everyone has a downfall arc i guess. this drops a replica down a peg.

usage: dsconf [-v] [-j] instance replication demote [-h] --suffix SUFFIX
                                                     --newrole NEWROLE

โœจ OPTIONS 'dsconf replication demote' โœจ

  • --suffix SUFFIX โ€” sets the DN of the replication suffix
  • --newrole NEWROLE โ€” sets the new replication role to "hub", or "consumer". yeah. she's a consumer now. humble era ๐Ÿ™ˆ

๐Ÿ”ฅ COMMAND 'dsconf replication get' ๐Ÿ”ฅ

vibe check on your replication config โ€” just show me everything, no filter.

usage: dsconf [-v] [-j] instance replication get [-h] --suffix SUFFIX

๐Ÿ“ OPTIONS 'dsconf replication get' ๐Ÿ“

  • --suffix SUFFIX โ€” sets the suffix DN for the replication configuration to display

๐ŸŽ€ COMMAND 'dsconf replication set-changelog' ๐ŸŽ€

the changelog is like the group chat history of your replication โ€” and here's where you set how much of it gets kept around, and whether it's locked down with encryption ๐Ÿ”

usage: dsconf [-v] [-j] instance replication set-changelog [-h]
                                                          --suffix SUFFIX
                                                          [--max-entries MAX_ENTRIES]
                                                          [--max-age MAX_AGE]
                                                          [--trim-interval TRIM_INTERVAL]
                                                          [--encrypt]
                                                          [--disable-encrypt]

๐Ÿงš OPTIONS 'dsconf replication set-changelog' ๐Ÿงš

  • --suffix SUFFIX โ€” sets the suffix that uses the changelog
  • --max-entries MAX_ENTRIES โ€” sets the maximum number of entries to get in the replication changelog
  • --max-age MAX_AGE โ€” specifies the maximum age of any entry in the changelog. The value must be a number followed by a duration unit [sSmMhHdDwW]. like 7d, bestie โ€” number first, unit after, don't freestyle it ๐Ÿ’…
  • --trim-interval TRIM_INTERVAL โ€” sets the interval to check if the replication changelog can be trimmed
  • --encrypt โ€” sets the replication changelog to use encryption. You must export and import the changelog after setting this. listen โ€” must. not "should", not "maybe later". export + import or it's not happening ๐Ÿซถ
  • --disable-encrypt โ€” sets the replication changelog to not use encryption. You must export and import the changelog after setting this. same deal, same rule โœจ

๐ŸŒˆ COMMAND 'dsconf replication get-changelog' ๐ŸŒˆ

peek at the changelog settings, no editing, just looking respectfully ๐Ÿ‘€

usage: dsconf [-v] [-j] instance replication get-changelog [-h]
                                                          --suffix SUFFIX

๐Ÿ’– OPTIONS 'dsconf replication get-changelog' ๐Ÿ’–

  • --suffix SUFFIX โ€” sets the suffix that uses the changelog

๐Ÿฆ‹ COMMAND 'dsconf replication export-changelog' ๐Ÿฆ‹

time to get that changelog out of the building ๐Ÿšชโœจ

usage: dsconf [-v] [-j] instance replication export-changelog
       [-h] {to-ldif,default} ...

๐ŸŒธ POSITIONAL ARGUMENTS 'dsconf replication export-changelog' ๐ŸŒธ

  • dsconf replication export-changelog to-ldif โ€” sets the LDIF file name. This is typically used for setting up changelog encryption
  • dsconf replication export-changelog default โ€” export the replication changelog to the server's default LDIF directory

๐Ÿ’… COMMAND 'dsconf replication export-changelog to-ldif' ๐Ÿ’…

the full-control version, with all the little switches ๐ŸŽ›๏ธ

usage: dsconf instance [-v] [-j] replication export-changelog to-ldif
       [-h] [-c] [-d] [-l] [-i CHANGELOG_LDIF] -o OUTPUT_FILE -r REPLICA_ROOT

๐ŸŒŸ OPTIONS 'dsconf replication export-changelog to-ldif' ๐ŸŒŸ

  • -c, --csn-only โ€” enables to export and interpret CSN only. This option can be used with or without -i option. The LDIF file that is generated can not be imported and is only used for debugging purposes. so like, debug snack, not a meal ๐Ÿ“
  • -d, --decode โ€” decodes the base64 values in each changelog entry. The LDIF file that is generated can not be imported and is only used for debugging purposes. again: debug only, bestie ๐Ÿ’€
  • -l, --preserve-ldif-done โ€” preserves generated LDIF "files.done" files in changelog directory.
  • -i CHANGELOG_LDIF, --changelog-ldif CHANGELOG_LDIF โ€” decodes changes in an LDIF file. Use this option if you already have a changelog LDIF file, but the changes in that file are encoded.
  • -o OUTPUT_FILE, --output-file OUTPUT_FILE โ€” sets the path name for the final result
  • -r REPLICA_ROOT, --replica-root REPLICA_ROOT โ€” specifies the replica root whose changelog you want to export

๐ŸŽ€ COMMAND 'dsconf replication export-changelog default' ๐ŸŽ€

the low-effort version โ€” she just does the thing to the default spot ๐Ÿซถ

usage: dsconf [-v] [-j] instance replication export-changelog default
       [-h] -r REPLICA_ROOT

โœจ OPTIONS 'dsconf replication export-changelog default' โœจ

  • -r REPLICA_ROOT, --replica-root REPLICA_ROOT โ€” specifies the replica root whose changelog you want to export

๐ŸŒˆ COMMAND 'dsconf replication import-changelog' ๐ŸŒˆ

and we're bringing it back in, reverse uno card ๐Ÿ”„

usage: dsconf instance [-v] [-j] replication import-changelog
       [-h] {from-ldif,default} ...

๐Ÿ’œ POSITIONAL ARGUMENTS 'dsconf replication import-changelog' ๐Ÿ’œ

  • dsconf replication import-changelog from-ldif โ€” restore/import a specific single LDIF file
  • dsconf replication import-changelog default โ€” import the default changelog LDIF file created by the server

๐Ÿฆ‹ COMMAND 'dsconf replication import-changelog from-ldif' ๐Ÿฆ‹

one specific file, one specific mission ๐ŸŽฏ

usage: dsconf [-v] [-j] instance replication import-changelog from-ldif
       [-h] -r REPLICA_ROOT LDIF_PATH

LDIF_PATH โ€” the path of the changelog LDIF file

๐ŸŒธ OPTIONS 'dsconf replication import-changelog from-ldif' ๐ŸŒธ

  • -r REPLICA_ROOT, --replica-root REPLICA_ROOT โ€” specifies the replica root whose changelog you want to import

๐Ÿ’– COMMAND 'dsconf replication import-changelog default' ๐Ÿ’–

the server already made you a default changelog LDIF, so let's just slurp that one back in ๐Ÿ“

usage: dsconf instance [-v] [-j] replication import-changelog default
       [-h] -r REPLICA_ROOT

โœจ OPTIONS 'dsconf replication import-changelog default' โœจ

  • -r REPLICA_ROOT, --replica-root REPLICA_ROOT โ€” specifies the replica root whose changelog you want to import

๐Ÿ‘‘ COMMAND 'dsconf replication set' ๐Ÿ‘‘

the big one โ€” a whole buffet of replication settings, and she is serving ๐Ÿฝ๏ธโœจ

usage: dsconf [-v] [-j] instance replication set [-h] --suffix SUFFIX
                                                 [--repl-add-bind-dn REPL_ADD_BIND_DN]
                                                 [--repl-del-bind-dn REPL_DEL_BIND_DN]
                                                 [--repl-add-ref REPL_ADD_REF]
                                                 [--repl-del-ref REPL_DEL_REF]
                                                 [--repl-purge-delay REPL_PURGE_DELAY]
                                                 [--repl-tombstone-purge-interval REPL_TOMBSTONE_PURGE_INTERVAL]
                                                 [--repl-fast-tombstone-purging REPL_FAST_TOMBSTONE_PURGING]
                                                 [--repl-bind-group REPL_BIND_GROUP]
                                                 [--repl-bind-group-interval REPL_BIND_GROUP_INTERVAL]
                                                 [--repl-protocol-timeout REPL_PROTOCOL_TIMEOUT]
                                                 [--repl-backoff-max REPL_BACKOFF_MAX]
                                                 [--repl-backoff-min REPL_BACKOFF_MIN]
                                                 [--repl-release-timeout REPL_RELEASE_TIMEOUT]
                                                 [--repl-keepalive-update-interval REPL_KEEPALIVE_UPDATE_INTERVAL]

โœจ OPTIONS 'dsconf replication set' โœจ

  • --suffix SUFFIX โ€” sets the DN of the replication suffix, bestie. That's the whole vibe ๐ŸŽ€
  • --repl-add-bind-dn REPL_ADD_BIND_DN โ€” adds a bind (supplier) DN ๐Ÿ’–
  • --repl-del-bind-dn REPL_DEL_BIND_DN โ€” takes a bind (supplier) DN away, bye bye ๐Ÿ‘‹
  • --repl-add-ref REPL_ADD_REF โ€” adds a replication referral, and heads up: this one is for consumers only ๐Ÿงš
  • --repl-del-ref REPL_DEL_REF โ€” removes a replication referral (also consumers only โ€” the original page literally spells it "conusmers" and honestly, we respect the typo era ๐Ÿ’€)
  • --repl-purge-delay REPL_PURGE_DELAY โ€” sets the replication purge delay โณ
  • --repl-tombstone-purge-interval REPL_TOMBSTONE_PURGE_INTERVAL โ€” sets the interval, in seconds, to check for tombstones that can be purged ๐Ÿชฆ
  • --repl-fast-tombstone-purging REPL_FAST_TOMBSTONE_PURGING โ€” turns the tombstone-purging performance improvement on or off. Yes it's a toggle, slay ๐Ÿ”ฅ
  • --repl-bind-group REPL_BIND_GROUP โ€” sets a group entry DN containing members that are "bind/supplier" DNs ๐Ÿ‘‘
  • --repl-bind-group-interval REPL_BIND_GROUP_INTERVAL โ€” sets an interval in seconds to check if the bind group has been updated ๐Ÿ”„
  • --repl-protocol-timeout REPL_PROTOCOL_TIMEOUT โ€” sets a timeout in seconds for how long to wait before stopping replication when the server is under load ๐Ÿ˜ฎโ€๐Ÿ’จ
  • --repl-backoff-max REPL_BACKOFF_MAX โ€” the max time in seconds a replication agreement should stay in a backoff state while waiting to acquire the consumer. Default is 300 seconds โœจ
  • --repl-backoff-min REPL_BACKOFF_MIN โ€” the starting time in seconds a replication agreement should stay in a backoff state while waiting to acquire the consumer. Default is 3 seconds ๐ŸŒธ
  • --repl-release-timeout REPL_RELEASE_TIMEOUT โ€” a timeout in seconds a replication supplier should send updates before it yields its replication session ๐Ÿซถ
  • --repl-keepalive-update-interval REPL_KEEPALIVE_UPDATE_INTERVAL โ€” interval in seconds for how often the server will apply an internal update to keep the RUV from getting stale. The default is 1 hour (3600 seconds) โฐ

๐Ÿ‘€ COMMAND 'dsconf replication monitor' ๐Ÿ‘€

usage: dsconf [-v] [-j] instance replication monitor [-h]
                                                     [-c [CONNECTIONS
...]]
                                                     [-a [ALIASES ...]]

โœจ OPTIONS 'dsconf replication monitor' โœจ

  • -c [CONNECTIONS ...], --connections [CONNECTIONS ...] โ€” sets the connection values for monitoring other not-connected topologies. The format is 'host:port:binddn:bindpwd'. You can use regex for host and port ๐Ÿ˜Œ. You can set bindpwd to * and it'll be requested at runtime, or you can include the path to the password file in square brackets โ€” like [~/pwd.txt] ๐Ÿ”
  • -a [ALIASES ...], --aliases [ALIASES ...] โ€” enables displaying an alias instead of host:port, if an alias is assigned to a host:port combination. The format: alias=host:port ๐Ÿ’…

๐Ÿ“Š COMMAND 'dsconf replication lag-report' ๐Ÿ“Š

usage: dsconf [-v] [-j] instance replication lag-report [-h]
                                                           --log-dirs
LOG_DIRS [LOG_DIRS ...]
                                                           --suffixes
SUFFIXES [SUFFIXES ...]
                                                           --output-dir
OUTPUT_DIR
                                                           [--output-format
OUTPUT_FORMAT [OUTPUT_FORMAT ...]]
                                                           [--json]
                                                           [--only-fully-replicated
 |
                                                           --only-not-replicated]
                                                           [--lag-time-lowest
LAG_TIME_LOWEST]
                                                           [--etime-lowest
ETIME_LOWEST]
                                                           [--start-time
START_TIME]
                                                           [--end-time
END_TIME]
                                                           [--utc-offset
UTC_OFFSET]
                                                           [--anonymous]
                                                           [--precision
{fast,balanced,full}]
                                                           [--max-chart-points
MAX_CHART_POINTS]

๐Ÿงธ INPUT OPTIONS 'dsconf replication lag-report' ๐Ÿงธ

  • --log-dirs LOG_DIRS [LOG_DIRS ...] โ€” list of log directories to analyze ๐Ÿ“
  • --suffixes SUFFIXES [SUFFIXES ...] โ€” list of suffixes to analyze ๐ŸŒˆ

๐ŸŽ€ OUTPUT OPTIONS 'dsconf replication lag-report' ๐ŸŽ€

  • --output-dir OUTPUT_DIR โ€” directory to write analysis reports to ๐Ÿ’–
  • --output-format OUTPUT_FORMAT [OUTPUT_FORMAT ...] โ€” one or more output formats: html, json, png, csv. Default: html โœจ
  • --json โ€” output the result as JSON (for UI integration / programmatic use) ๐Ÿค–

๐Ÿฆ‹ FILTERING OPTIONS 'dsconf replication lag-report' ๐Ÿฆ‹

  • --only-fully-replicated โ€” show only fully replicated entries โœ…
  • --only-not-replicated โ€” show only entries that failed to replicate ๐Ÿ˜ญ
  • --lag-time-lowest LAG_TIME_LOWEST โ€” filter entries with lag time above this threshold (seconds) โฑ๏ธ
  • --etime-lowest ETIME_LOWEST โ€” filter entries with etime above this threshold (seconds) โณ

๐ŸŒธ TIME RANGE OPTIONS 'dsconf replication lag-report' ๐ŸŒธ

  • --start-time START_TIME โ€” start time for analysis (YYYY-MM-DD HH:MM:SS) ๐Ÿ—“๏ธ
  • --end-time END_TIME โ€” end time for analysis (YYYY-MM-DD HH:MM:SS) ๐Ÿ—“๏ธ

๐Ÿ’œ ADDITIONAL OPTIONS 'dsconf replication lag-report' ๐Ÿ’œ

  • --utc-offset UTC_OFFSET โ€” UTC offset in ยฑHHMM format (e.g., -0400, +0530) ๐ŸŒ
  • --anonymous โ€” anonymize server names in the report ๐Ÿ•ต๏ธ

๐Ÿ”ฅ PERFORMANCE OPTIONS 'dsconf replication lag-report' ๐Ÿ”ฅ

  • --precision {fast,balanced,full} โ€” analysis precision vs speed: fast (more sampling), balanced (default), full (no sampling) ๐ŸŽ๏ธ
  • --max-chart-points MAX_CHART_POINTS โ€” maximum total data points to include across all chart series (sampling applied if exceeded). Default depends on --precision ๐Ÿ“ˆ

๐Ÿ‘‘ COMMAND 'dsconf repl-agmt' ๐Ÿ‘‘

usage: dsconf [-v] [-j] instance repl-agmt [-h]
                                        {list,enable,disable,init,init-status,poke,status,delete,create,set,get}
       ...

โœจ POSITIONAL ARGUMENTS 'dsconf repl-agmt' โœจ

  • dsconf repl-agmt list โ€” list all replication agreements ๐Ÿ“‹
  • dsconf repl-agmt enable โ€” enable replication agreement โœ…
  • dsconf repl-agmt disable โ€” disable replication agreement โ›”
  • dsconf repl-agmt init โ€” initialize replication agreement ๐Ÿš€
  • dsconf repl-agmt init-status โ€” check the agreement initialization status ๐Ÿ”
  • dsconf repl-agmt poke โ€” trigger replication to send updates now ๐Ÿ‘‰๐Ÿ“จ
  • dsconf repl-agmt status โ€” displays the current status of the replication agreement ๐Ÿฉบ
  • dsconf repl-agmt delete โ€” delete replication agreement ๐Ÿ—‘๏ธ
  • dsconf repl-agmt create โ€” initialize replication agreement ๐ŸŒฑ
  • dsconf repl-agmt set โ€” set an attribute in the replication agreement ๐Ÿ› ๏ธ
  • dsconf repl-agmt get โ€” get replication configuration ๐Ÿ“–

๐Ÿ“‹ COMMAND 'dsconf repl-agmt list' ๐Ÿ“‹

usage: dsconf [-v] [-j] instance repl-agmt list [-h] --suffix SUFFIX
                                                       [--entry ENTRY]

๐ŸŽ€ OPTIONS 'dsconf repl-agmt list' ๐ŸŽ€

  • --suffix SUFFIX โ€” sets the DN of the suffix to look up replication agreements for ๐Ÿ”Ž
  • --entry ENTRY โ€” returns the entire entry for each agreement ๐Ÿ’–

โœ… COMMAND 'dsconf repl-agmt enable' โœ…

usage: dsconf [-v] [-j] instance repl-agmt enable [-h] --suffix SUFFIX
                                                         AGMT_NAME

AGMT_NAME โ€” the name of the replication agreement ๐Ÿท๏ธ

โœจ OPTIONS 'dsconf repl-agmt enable' โœจ

  • --suffix SUFFIX โ€” sets the DN of the replication suffix ๐ŸŒธ

โ›” COMMAND 'dsconf repl-agmt disable' โ›”

usage: dsconf [-v] [-j] instance repl-agmt disable [-h] --suffix SUFFIX
                                                          AGMT_NAME

AGMT_NAME โ€” the name of the replication agreement ๐Ÿท๏ธ

โœจ OPTIONS 'dsconf repl-agmt disable' โœจ

  • --suffix SUFFIX โ€” sets the DN of the replication suffix ๐ŸŒธ

๐Ÿš€ COMMAND 'dsconf repl-agmt init' ๐Ÿš€

usage: dsconf [-v] [-j] instance repl-agmt init [-h] --suffix SUFFIX
       AGMT_NAME

AGMT_NAME โ€” the name of the replication agreement ๐Ÿท๏ธ

โœจ OPTIONS 'dsconf repl-agmt init' โœจ

  • --suffix SUFFIX โ€” sets the DN of the replication suffix ๐ŸŒธ

๐Ÿ” COMMAND 'dsconf repl-agmt init-status' ๐Ÿ”

usage: dsconf [-v] [-j] instance repl-agmt init-status [-h] --suffix
       SUFFIX
                                                              AGMT_NAME

AGMT_NAME โ€” the name of the replication agreement ๐Ÿท๏ธ

โœจ OPTIONS 'dsconf repl-agmt init-status' โœจ

  • --suffix SUFFIX โ€” sets the DN of the replication suffix ๐ŸŒธ

๐Ÿ‘‰ COMMAND 'dsconf repl-agmt poke' ๐Ÿ‘‰

usage: dsconf [-v] [-j] instance repl-agmt poke [-h] --suffix SUFFIX
       AGMT_NAME

AGMT_NAME โ€” the name of the replication agreement ๐Ÿท๏ธ

โœจ OPTIONS 'dsconf repl-agmt poke' โœจ

  • --suffix SUFFIX โ€” sets the DN of the replication suffix ๐ŸŒธ

๐Ÿฉบ COMMAND 'dsconf repl-agmt status' ๐Ÿฉบ

usage: dsconf [-v] [-j] instance repl-agmt status [-h] --suffix SUFFIX
                                                         [--bind-dn BIND_DN]
                                                         [--bind-passwd
       BIND_PASSWD]
                                                         [--bind-passwd-file
       BIND_PASSWD_FILE]
                                                         [--bind-passwd-prompt]
                                                         AGMT_NAME

AGMT_NAME โ€” the name of the replication agreement ๐Ÿท๏ธ

โœจ OPTIONS 'dsconf repl-agmt status' โœจ

  • --suffix SUFFIX โ€” sets the DN of the replication suffix ๐ŸŒธ
  • --bind-dn BIND_DN โ€” sets the DN to use to authenticate to the consumer. If it's not set, the current instance's root DN will be used. It will be used for all agreements ๐Ÿ”
  • --bind-passwd BIND_PASSWD โ€” sets the password for the bind DN. It will be used for all agreements ๐Ÿ”‘
  • --bind-passwd-file BIND_PASSWD_FILE โ€” file containing the password. It will be used for all agreements ๐Ÿ“„
  • --bind-passwd-prompt โ€” prompt for passwords for each agreement's instance separately ๐Ÿ™‹

๐Ÿ—‘๏ธ COMMAND 'dsconf repl-agmt delete' ๐Ÿ—‘๏ธ

usage: dsconf [-v] [-j] instance repl-agmt delete [-h] --suffix SUFFIX
                                                         AGMT_NAME

AGMT_NAME โ€” the name of the replication agreement ๐Ÿท๏ธ

โœจ OPTIONS 'dsconf repl-agmt delete' โœจ

  • --suffix SUFFIX โ€” sets the DN of the replication suffix ๐ŸŒธ

๐Ÿ‘‘ COMMAND 'dsconf repl-agmt create' ๐Ÿ‘‘

okay bestie, this is the main character command of the whole repl-agmt saga โ€” the one that actually makes a replication agreement out of thin air. creating a whole relationship between two servers, no cap. ๐Ÿ’–

dsconf [-v] [-j] instance repl-agmt create [-h] --suffix SUFFIX
                                           --host HOST
                                           --port PORT
                                           --conn-protocol CONN_PROTOCOL
                                           [--bind-dn BIND_DN]
                                           [--bind-passwd BIND_PASSWD]
                                           [--bind-passwd-file BIND_PASSWD_FILE]
                                           [--bind-passwd-prompt]
                                           --bind-method BIND_METHOD
                                           [--frac-list FRAC_LIST]
                                           [--frac-list-total FRAC_LIST_TOTAL]
                                           [--strip-list STRIP_LIST]
                                           [--schedule SCHEDULE]
                                           [--conn-timeout CONN_TIMEOUT]
                                           [--protocol-timeout PROTOCOL_TIMEOUT]
                                           [--wait-async-results WAIT_ASYNC_RESULTS]
                                           [--busy-wait-time BUSY_WAIT_TIME]
                                           [--session-pause-time SESSION_PAUSE_TIME]
                                           [--flow-control-window FLOW_CONTROL_WINDOW]
                                           [--flow-control-pause FLOW_CONTROL_PAUSE]
                                           [--bootstrap-bind-dn BOOTSTRAP_BIND_DN]
                                           [--bootstrap-bind-passwd BOOTSTRAP_BIND_PASSWD]
                                           [--bootstrap-bind-passwd-file BOOTSTRAP_BIND_PASSWD_FILE]
                                           [--bootstrap-bind-passwd-prompt]
                                           [--bootstrap-conn-protocol BOOTSTRAP_CONN_PROTOCOL]
                                           [--bootstrap-bind-method BOOTSTRAP_BIND_METHOD]
                                           [--init]
                                           AGMT_NAME
๐Ÿšจ heads up, bestie: --suffix, --host, --port, --conn-protocol and --bind-method are not optional here. they're required-required, no skipping, the vibe check will fail if you ghost them. the rest are bracketed because they're giving optional โœจ

๐ŸŽ€ AGMT_NAME ๐ŸŽ€

  • AGMT_NAME โ€” literally just the name of the replication agreement, bestie. that's it. that's the job. name your agreement like you name your playlists, with love. ๐ŸŒธ

โœจ OPTIONS 'dsconf repl-agmt create' โœจ

  • --suffix SUFFIX โ€” sets the DN of the replication suffix. this is the what โ€” what part of the tree are we even replicating, queen? ๐Ÿ’…
  • --host HOST โ€” sets the hostname of the remote replica. your pen pal server's address. ๐Ÿฆ‹
  • --port PORT โ€” sets the port number of the remote replica. which door do we knock on? this one. ๐Ÿšช
  • --conn-protocol CONN_PROTOCOL โ€” sets the replication connection protocol: LDAP, LDAPS, or StartTLS. pick your lane, pick your security level, periodt. ๐Ÿ”
  • --bind-dn BIND_DN โ€” sets the bind DN the agreement uses to authenticate to the replica. it's giving "hi, it's me, let me in." ๐Ÿ‘‘
  • --bind-passwd BIND_PASSWD โ€” sets the credentials for the bind DN. the password. the secret. the tea. ๐Ÿคซ
  • --bind-passwd-file BIND_PASSWD_FILE โ€” file containing the password. keep it in a file if you don't wanna type it in the group chat. ๐Ÿ“„
  • --bind-passwd-prompt โ€” prompt for password. it'll ask you nicely instead. ๐Ÿซถ
  • --bind-method BIND_METHOD โ€” sets the bind method: "SIMPLE", "SSLCLIENTAUTH", "SASL/DIGEST", or "SASL/GSSAPI". four flavors, all valid, choose your fighter. โœจ
  • --frac-list FRAC_LIST โ€” sets the list of attributes to NOT replicate to the consumer during incremental updates. i.e. the stuff you're deliberately leaving on read. ๐Ÿ™ˆ
  • --frac-list-total FRAC_LIST_TOTAL โ€” sets the list of attributes to NOT replicate during a total initialization. same energy, but for the big full-send copy. ๐Ÿ’ซ
  • --strip-list STRIP_LIST โ€” sets a list of attributes that are removed from updates only if the event would otherwise be empty. typically this is set to "modifiersname" and "modifytimestmap" (yes bestie, that's spelled exactly how the manpage spells it โ€” we don't fix, we transcribe ๐Ÿ’€). it's the "don't send an update that's literally just metadata" filter. ๐Ÿงน
  • --schedule SCHEDULE โ€” sets the replication update schedule: 'HHMM-HHMM DDDDDDD' where D = 0-6 (Sunday - Saturday). yes that's the format, seven day digits, one per day of the week. calendar girl behavior. ๐Ÿ—“๏ธ
  • --conn-timeout CONN_TIMEOUT โ€” sets the timeout used for replication connections. how long we wait before we're like "okay they're not answering, moving on." โฐ
  • --protocol-timeout PROTOCOL_TIMEOUT โ€” sets a timeout in seconds on how long to wait before stopping replication when the server is under load. under load = server is stressed, and this tells it how long to hang on before bailing. ๐Ÿ˜ฎโ€๐Ÿ’จ
  • --wait-async-results WAIT_ASYNC_RESULTS โ€” sets the amount of time in milliseconds the server waits if the consumer is not ready before resending data. patience in milliseconds, we're precise here. โฑ๏ธ
  • --busy-wait-time BUSY_WAIT_TIME โ€” sets the amount of time in seconds a supplier should wait after a consumer sends back a busy response before making another attempt to acquire access. consumer said "busy rn ๐Ÿ’…", so supplier waits this long before trying again. ๐Ÿ”
  • --session-pause-time SESSION_PAUSE_TIME โ€” sets the amount of time in seconds a supplier should wait between update sessions. it's the little breather between rounds. ๐ŸŒฌ๏ธ
  • --flow-control-window FLOW_CONTROL_WINDOW โ€” sets the maximum number of entries and updates sent by a supplier, which are not acknowledged by the consumer. i.e. how many un-acked things can be in flight before we pump the brakes. ๐Ÿ›‘
  • --flow-control-pause FLOW_CONTROL_PAUSE โ€” sets the time in milliseconds to pause after reaching the number of entries and updates set in "--flow-control-window". the cooldown after the brake pump. โ„๏ธ
  • --bootstrap-bind-dn BOOTSTRAP_BIND_DN โ€” sets an optional bind DN the agreement can use to bootstrap initialization when bind groups are being used. optional, so your call bestie. ๐ŸŽ€
  • --bootstrap-bind-passwd BOOTSTRAP_BIND_PASSWD โ€” sets the bootstrap credentials for the bind DN. the bootstrap password. the bootstrap tea. ๐Ÿ“
  • --bootstrap-bind-passwd-file BOOTSTRAP_BIND_PASSWD_FILE โ€” file containing the password. ๐Ÿ“
  • --bootstrap-bind-passwd-prompt โ€” file containing the password. yes, that's genuinely what the manpage says for this one โ€” we're reporting it exactly as written, no editing, no guessing. ๐Ÿ™ˆ
  • --bootstrap-conn-protocol BOOTSTRAP_CONN_PROTOCOL โ€” sets the replication bootstrap connection protocol: LDAP, LDAPS, or StartTLS. same three lanes, bootstrap edition. ๐ŸŒˆ
  • --bootstrap-bind-method BOOTSTRAP_BIND_METHOD โ€” sets the bind method: "SIMPLE", or "SSLCLIENTAUTH". note: just the two this time, not all four. ๐Ÿ‘€
  • --init โ€” initializes the agreement after creating it. one and done, create + init in a single slay. ๐Ÿ”ฅ

๐Ÿ’œ COMMAND 'dsconf repl-agmt set' ๐Ÿ’œ

now this one is the edit button on an agreement you already made. no creating, just tweaking. glow-up energy. โœจ

dsconf [-v] [-j] instance repl-agmt set [-h] --suffix SUFFIX
                                        [--host HOST]
                                        [--port PORT]
                                        [--conn-protocol CONN_PROTOCOL]
                                        [--bind-dn BIND_DN]
                                        [--bind-passwd BIND_PASSWD]
                                        [--bind-passwd-file BIND_PASSWD_FILE]
                                        [--bind-passwd-prompt]
                                        [--bind-method BIND_METHOD]
                                        [--frac-list FRAC_LIST]
                                        [--frac-list-total FRAC_LIST_TOTAL]
                                        [--strip-list STRIP_LIST]
                                        [--schedule SCHEDULE]
                                        [--conn-timeout CONN_TIMEOUT]
                                        [--protocol-timeout PROTOCOL_TIMEOUT]
                                        [--wait-async-results WAIT_ASYNC_RESULTS]
                                        [--busy-wait-time BUSY_WAIT_TIME]
                                        [--session-pause-time SESSION_PAUSE_TIME]
                                        [--flow-control-window FLOW_CONTROL_WINDOW]
                                        [--flow-control-pause FLOW_CONTROL_PAUSE]
                                        [--bootstrap-bind-dn BOOTSTRAP_BIND_DN]
                                        [--bootstrap-bind-passwd BOOTSTRAP_BIND_PASSWD]
                                        [--bootstrap-bind-passwd-file BOOTSTRAP_BIND_PASSWD_FILE]
                                        [--bootstrap-bind-passwd-prompt]
                                        [--bootstrap-conn-protocol BOOTSTRAP_CONN_PROTOCOL]
                                        [--bootstrap-bind-method BOOTSTRAP_BIND_METHOD]
                                        AGMT_NAME
๐ŸŒธ see how --suffix is the only thing still required-required and everything else went full brackets? yeah. that's the difference between create and set, bestie. notice it. iykyk.

๐Ÿฆ‹ AGMT_NAME ๐Ÿฆ‹

  • AGMT_NAME โ€” the name of the replication agreement. same deal as before, just the name, that's the whole vibe. ๐Ÿ’–

โœจ OPTIONS for dsconf repl-agmt set โœจ

okay bestie, this is the big one โ€” literally every knob you can twist on an agreement ๐Ÿ’…

  • --suffix SUFFIX โ€” sets the DN of the replication suffix ๐Ÿฆ‹
  • --host HOST โ€” sets the hostname of the remote replica
  • --port PORT โ€” sets the port number of the remote replica
  • --conn-protocol CONN_PROTOCOL โ€” sets the replication connection protocol: LDAP, LDAPS, or StartTLS โœจ
  • --bind-dn BIND_DN โ€” sets the Bind DN the agreement uses to authenticate to the replica
  • --bind-passwd BIND_PASSWD โ€” sets the credentials for the bind DN ๐Ÿ”
  • --bind-passwd-file BIND_PASSWD_FILE โ€” file containing the password
  • --bind-passwd-prompt โ€” prompt for password
  • --bind-method BIND_METHOD โ€” sets the bind method: "SIMPLE", "SSLCLIENTAUTH", "SASL/DIGEST", or "SASL/GSSAPI"
  • --frac-list FRAC_LIST โ€” sets a list of attributes to NOT replicate to the consumer during incremental updates ๐Ÿ™ˆ
  • --frac-list-total FRAC_LIST_TOTAL โ€” sets a list of attributes to NOT replicate during a total initialization
  • --strip-list STRIP_LIST โ€” sets a list of attributes that are removed from updates only if the event would otherwise be empty. Typically this is set to "modifiersname" and "modifytimestmap" ๐Ÿ‘€
  • --schedule SCHEDULE โ€” sets the replication update schedule: 'HHMM-HHMM DDDDDDD' where D = 0-6 (Sunday - Saturday).
  • --conn-timeout CONN_TIMEOUT โ€” sets the timeout used for replication connections
  • --protocol-timeout PROTOCOL_TIMEOUT โ€” sets a timeout in seconds on how long to wait before stopping replication when the server is under load ๐Ÿ˜ฎโ€๐Ÿ’จ
  • --wait-async-results WAIT_ASYNC_RESULTS โ€” sets the amount of time in milliseconds the server waits if the consumer is not ready before resending data
  • --busy-wait-time BUSY_WAIT_TIME โ€” sets the amount of time in seconds a supplier should wait after a consumer sends back a busy response before making another attempt to acquire access.
  • --session-pause-time SESSION_PAUSE_TIME โ€” sets the amount of time in seconds a supplier should wait between update sessions.
  • --flow-control-window FLOW_CONTROL_WINDOW โ€” sets the maximum number of entries and updates sent by a supplier, which are not acknowledged by the consumer.
  • --flow-control-pause FLOW_CONTROL_PAUSE โ€” sets the time in milliseconds to pause after reaching the number of entries and updates set in "--flow-control-window" โธ๏ธ
  • --bootstrap-bind-dn BOOTSTRAP_BIND_DN โ€” sets an optional bind DN the agreement can use to bootstrap initialization when bind groups are being used
  • --bootstrap-bind-passwd BOOTSTRAP_BIND_PASSWD โ€” sets the bootstrap credentials for the bind DN ๐Ÿ”‘
  • --bootstrap-bind-passwd-file BOOTSTRAP_BIND_PASSWD_FILE โ€” file containing the password
  • --bootstrap-bind-passwd-prompt โ€” prompt for password
  • --bootstrap-conn-protocol BOOTSTRAP_CONN_PROTOCOL โ€” sets the replication bootstrap connection protocol: LDAP, LDAPS, or StartTLS
  • --bootstrap-bind-method BOOTSTRAP_BIND_METHOD โ€” sets the bind method: "SIMPLE", or "SSLCLIENTAUTH"

๐Ÿ’– COMMAND dsconf repl-agmt get ๐Ÿ’–

usage: dsconf [-v] [-j] instance repl-agmt get [-h] --suffix SUFFIX
AGMT_NAME

AGMT_NAME โ€” the suffix DN for which to display the replication configuration ๐Ÿซถ

OPTIONS for dsconf repl-agmt get

  • --suffix SUFFIX โ€” sets the DN of the replication suffix

๐ŸŒˆ COMMAND dsconf repl-winsync-agmt ๐ŸŒˆ

winsync time!! windows + directory server, living their bestie life together ๐ŸชŸ๐Ÿ’ž

usage: dsconf [-v] [-j] instance repl-winsync-agmt [-h]
                                         {list,enable,disable,init,init-status,poke,status,delete,create,set,get}
...

POSITIONAL ARGUMENTS for dsconf repl-winsync-agmt

  1. dsconf repl-winsync-agmt list โ€” list all the replication winsync agreements ๐Ÿ“‹
  2. dsconf repl-winsync-agmt enable โ€” enable replication winsync agreement โœ…
  3. dsconf repl-winsync-agmt disable โ€” disable replication winsync agreement ๐Ÿšซ
  4. dsconf repl-winsync-agmt init โ€” initialize replication winsync agreement
  5. dsconf repl-winsync-agmt init-status โ€” check the agreement initialization status ๐Ÿ‘€
  6. dsconf repl-winsync-agmt poke โ€” trigger replication to send updates now ๐Ÿ‘‰
  7. dsconf repl-winsync-agmt status โ€” display the current status of the replication agreement
  8. dsconf repl-winsync-agmt delete โ€” delete replication winsync agreement ๐Ÿ’€
  9. dsconf repl-winsync-agmt create โ€” initialize replication winsync agreement
  10. dsconf repl-winsync-agmt set โ€” set an attribute in the replication winsync agreement
  11. dsconf repl-winsync-agmt get โ€” display replication configuration

๐ŸŒธ COMMAND dsconf repl-winsync-agmt list

usage: dsconf [-v] [-j] instance repl-winsync-agmt list [-h] --suffix
SUFFIX

OPTIONS for dsconf repl-winsync-agmt list

  • --suffix SUFFIX โ€” sets the DN of the suffix to look up replication winsync agreements ๐Ÿ”

๐ŸŽ€ COMMAND dsconf repl-winsync-agmt enable

usage: dsconf [-v] [-j] instance repl-winsync-agmt enable [-h] --suffix
SUFFIX
                                                             AGMT_NAME

AGMT_NAME โ€” the name of the replication winsync agreement

OPTIONS for dsconf repl-winsync-agmt enable

  • --suffix SUFFIX โ€” sets the DN of the replication winsync suffix

๐Ÿฆ‹ COMMAND dsconf repl-winsync-agmt disable

usage: dsconf [-v] [-j] instance repl-winsync-agmt disable [-h]
                                                              --suffix
SUFFIX
                                                              AGMT_NAME

AGMT_NAME โ€” the name of the replication winsync agreement

OPTIONS for dsconf repl-winsync-agmt disable

  • --suffix SUFFIX โ€” sets the DN of the replication winsync suffix

โœจ COMMAND dsconf repl-winsync-agmt init

usage: dsconf [-v] [-j] instance repl-winsync-agmt init [-h] --suffix
SUFFIX
                                                           AGMT_NAME

AGMT_NAME โ€” the name of the replication winsync agreement

OPTIONS for dsconf repl-winsync-agmt init

  • --suffix SUFFIX โ€” sets the DN of the replication winsync suffix

๐Ÿ‘‘ COMMAND dsconf repl-winsync-agmt init-status

usage: dsconf [-v] [-j] instance repl-winsync-agmt init-status
       [-h] --suffix SUFFIX AGMT_NAME

AGMT_NAME โ€” the name of the replication agreement

OPTIONS for dsconf repl-winsync-agmt init-status

  • --suffix SUFFIX โ€” sets the DN of the replication suffix

๐Ÿ”ฅ COMMAND dsconf repl-winsync-agmt poke

usage: dsconf [-v] [-j] instance repl-winsync-agmt poke [-h] --suffix
SUFFIX
                                                           AGMT_NAME

AGMT_NAME โ€” the name of the replication winsync agreement

OPTIONS for dsconf repl-winsync-agmt poke

  • --suffix SUFFIX โ€” sets the DN of the replication winsync suffix

๐Ÿ’œ COMMAND dsconf repl-winsync-agmt status

usage: dsconf [-v] [-j] instance repl-winsync-agmt status [-h] --suffix
SUFFIX
                                                             AGMT_NAME

AGMT_NAME โ€” the name of the replication agreement

OPTIONS for dsconf repl-winsync-agmt status

  • --suffix SUFFIX โ€” sets the DN of the replication suffix

๐Ÿ“ COMMAND dsconf repl-winsync-agmt delete

usage: dsconf [-v] [-j] instance repl-winsync-agmt delete [-h] --suffix
SUFFIX
                                                             AGMT_NAME

AGMT_NAME โ€” the name of the replication winsync agreement

OPTIONS for dsconf repl-winsync-agmt delete

  • --suffix SUFFIX โ€” sets the DN of the replication winsync suffix

๐Ÿ’… COMMAND dsconf repl-winsync-agmt create

okay this usage block is long long, bestie. deep breath, we're getting through it together ๐Ÿซถ

usage: dsconf [-v] [-j] instance repl-winsync-agmt create [-h] --suffix
SUFFIX
                                                             --host HOST
                                                             --port PORT
                                                             --conn-protocol CONN_PROTOCOL
                                                             --bind-dn BIND_DN
                                                             [--bind-passwd BIND_PASSWD]
                                                             [--bind-passwd-file BIND_PASSWD_FILE]
                                                             [--bind-passwd-prompt]
                                                             [--frac-list FRAC_LIST]
                                                             [--schedule SCHEDULE]
                                                             --win-subtree WIN_SUBTREE
                                                             --ds-subtree DS_SUBTREE
                                                             --win-domain WIN_DOMAIN
                                                             [--sync-users SYNC_USERS]
                                                             [--sync-groups SYNC_GROUPS]
                                                             [--sync-interval SYNC_INTERVAL]
                                                             [--one-way-sync ONE_WAY_SYNC]
                                                             [--move-action MOVE_ACTION]
                                                             [--win-filter WIN_FILTER]
                                                             [--ds-filter DS_FILTER]
                                                             [--subtree-pair SUBTREE_PAIR]
                                                             [--conn-timeout CONN_TIMEOUT]
                                                             [--busy-wait-time BUSY_WAIT_TIME]
                                                             [--session-pause-time SESSION_PAUSE_TIME]
                                                             [--flatten-tree]
                                                             [--init]
                                                             AGMT_NAME

AGMT_NAME โ€” the name of the replication winsync agreement ๐ŸŒŸ

โœจ OPTIONS dsconf repl-winsync-agmt create โœจ

okay bestie, here's every single knob you can twist when you're creating a winsync agreement. buckle up, there's a lot ๐Ÿ’…

  • --suffix SUFFIX โ€” sets the DN of the replication winsync suffix ๐ŸŽ€
  • --host HOST โ€” sets the hostname of the AD server ๐Ÿ–ฅ๏ธ
  • --port PORT โ€” sets the port number of the AD server ๐Ÿ”Œ
  • --conn-protocol CONN_PROTOCOL โ€” sets the replication winsync connection protocol: LDAP, LDAPS, or StartTLS ๐Ÿ”
  • --bind-dn BIND_DN โ€” sets the bind DN the agreement uses to authenticate to the AD Server ๐Ÿชช
  • --bind-passwd BIND_PASSWD โ€” sets the credentials for the Bind DN ๐Ÿ”‘
  • --bind-passwd-file BIND_PASSWD_FILE โ€” file containing the password ๐Ÿ“„
  • --bind-passwd-prompt โ€” prompt for password ๐Ÿ™ˆ
  • --frac-list FRAC_LIST โ€” sets a list of attributes to NOT replicate to the consumer during incremental updates ๐Ÿšซ
  • --schedule SCHEDULE โ€” sets the replication update schedule ๐Ÿ—“๏ธ
  • --win-subtree WIN_SUBTREE โ€” sets the suffix of the AD Server ๐ŸŒณ
  • --ds-subtree DS_SUBTREE โ€” sets the Directory Server suffix ๐ŸŒฒ
  • --win-domain WIN_DOMAIN โ€” sets the AD Domain ๐Ÿฐ
  • --sync-users SYNC_USERS โ€” synchronizes users between AD and DS ๐Ÿซ‚
  • --sync-groups SYNC_GROUPS โ€” synchronizes groups between AD and DS ๐Ÿ‘ฏ
  • --sync-interval SYNC_INTERVAL โ€” sets the interval that DS checks AD for changes in entries โฑ๏ธ
  • --one-way-sync ONE_WAY_SYNC โ€” sets which direction to perform synchronization: "toWindows", or "fromWindows". By default sync occurs in both directions. โ†”๏ธ
  • --move-action MOVE_ACTION โ€” sets instructions on how to handle moved or deleted entries: "none", "unsync", or "delete" ๐Ÿ“ฆ
  • --win-filter WIN_FILTER โ€” sets a custom filter for finding users in AD Server ๐Ÿ”Ž
  • --ds-filter DS_FILTER โ€” sets a custom filter for finding AD users in DS ๐Ÿ”
  • --subtree-pair SUBTREE_PAIR โ€” sets the subtree pair: <DS_SUBTREE>:<WINDOWS_SUBTREE> ๐Ÿงฌ
  • --conn-timeout CONN_TIMEOUT โ€” sets the timeout used for replicaton connections โณ
  • --busy-wait-time BUSY_WAIT_TIME โ€” sets the amount of time in seconds a supplier should wait after a consumer sends back a busy response before making another attempt to acquire access ๐Ÿ˜ฎโ€๐Ÿ’จ
  • --session-pause-time SESSION_PAUSE_TIME โ€” sets the amount of time in seconds a supplier should wait between update sessions ๐Ÿ›‘
  • --flatten-tree โ€” By default, the tree structure of AD is preserved into 389. This MAY cause replication to fail in some cases, as you may need to create missing OU's to recreate the same treestructure. This setting when enabled, removes the tree structure of AD and flattens all entries into the ds-subtree. This does NOT affect or change the tree structure of the AD directory. ๐Ÿซ 
  • --init โ€” Initializes the agreement after creating it โœจ

โญ COMMAND dsconf repl-winsync-agmt set โญ

usage: dsconf [-v] [-j] instance repl-winsync-agmt set [-h] [--suffix
SUFFIX]
                                                       [--host HOST]
                                                       [--port PORT]
                                                       [--conn-protocol
CONN_PROTOCOL]
                                                       [--bind-dn
BIND_DN]
                                                       [--bind-passwd
BIND_PASSWD]
                                                       [--bind-passwd-file
BIND_PASSWD_FILE]
                                                       [--bind-passwd-prompt]
                                                       [--frac-list
FRAC_LIST]
                                                       [--schedule
SCHEDULE]
                                                       [--win-subtree
WIN_SUBTREE]
                                                       [--ds-subtree
DS_SUBTREE]
                                                       [--win-domain
WIN_DOMAIN]
                                                       [--sync-users
SYNC_USERS]
                                                       [--sync-groups
SYNC_GROUPS]
                                                       [--sync-interval
SYNC_INTERVAL]
                                                       [--one-way-sync
ONE_WAY_SYNC]
                                                       [--move-action
MOVE_ACTION]
                                                       [--win-filter
WIN_FILTER]
                                                       [--ds-filter
DS_FILTER]
                                                       [--subtree-pair
SUBTREE_PAIR]
                                                       [--conn-timeout
CONN_TIMEOUT]
                                                       [--busy-wait-time
BUSY_WAIT_TIME]
                                                       [--session-pause-time
SESSION_PAUSE_TIME]
                                                       AGMT_NAME
  • AGMT_NAME โ€” the name of the replication winsync agreement ๐Ÿท๏ธ

๐ŸŒธ OPTIONS dsconf repl-winsync-agmt set ๐ŸŒธ

  • --suffix SUFFIX โ€” sets the DN of the replication winsync suffix ๐ŸŽ€
  • --host HOST โ€” sets the hostname of the AD server ๐Ÿ–ฅ๏ธ
  • --port PORT โ€” sets the port number of the AD server ๐Ÿ”Œ
  • --conn-protocol CONN_PROTOCOL โ€” sets the replication winsync connection protocol: LDAP, LDAPS, or StartTLS ๐Ÿ”
  • --bind-dn BIND_DN โ€” sets the bind DN the agreement uses to authenticate to the AD Server ๐Ÿชช
  • --bind-passwd BIND_PASSWD โ€” sets the credentials for the Bind DN ๐Ÿ”‘
  • --bind-passwd-file BIND_PASSWD_FILE โ€” file containing the password ๐Ÿ“„
  • --bind-passwd-prompt โ€” prompt for password ๐Ÿ™ˆ
  • --frac-list FRAC_LIST โ€” sets a list of attributes to NOT replicate to the consumer during incremental updates ๐Ÿšซ
  • --schedule SCHEDULE โ€” sets the replication update schedule ๐Ÿ—“๏ธ
  • --win-subtree WIN_SUBTREE โ€” sets the suffix of the AD Server ๐ŸŒณ
  • --ds-subtree DS_SUBTREE โ€” sets the Directory Server suffix ๐ŸŒฒ
  • --win-domain WIN_DOMAIN โ€” sets the AD Domain ๐Ÿฐ
  • --sync-users SYNC_USERS โ€” synchronizes users between AD and DS ๐Ÿซ‚
  • --sync-groups SYNC_GROUPS โ€” synchronizes groups between AD and DS ๐Ÿ‘ฏ
  • --sync-interval SYNC_INTERVAL โ€” sets the interval that DS checks AD for changes in entries โฑ๏ธ
  • --one-way-sync ONE_WAY_SYNC โ€” sets which direction to perform synchronization: "toWindows", or "fromWindows". By default sync occurs in both directions. โ†”๏ธ
  • --move-action MOVE_ACTION โ€” sets instructions on how to handle moved or deleted entries: "none", "unsync", or "delete" ๐Ÿ“ฆ
  • --win-filter WIN_FILTER โ€” sets a custom filter for finding users in AD Server ๐Ÿ”Ž
  • --ds-filter DS_FILTER โ€” sets a custom filter for finding AD users in DS ๐Ÿ”
  • --subtree-pair SUBTREE_PAIR โ€” sets the subtree pair: <DS_SUBTREE>:<WINDOWS_SUBTREE> ๐Ÿงฌ
  • --conn-timeout CONN_TIMEOUT โ€” sets the timeout used for replicaton connections โณ
  • --busy-wait-time BUSY_WAIT_TIME โ€” sets the amount of time in seconds a supplier should wait after a consumer sends back a busy response before making another attempt to acquire access ๐Ÿ˜ฎโ€๐Ÿ’จ
  • --session-pause-time SESSION_PAUSE_TIME โ€” sets the amount of time in seconds a supplier should wait between update sessions ๐Ÿ›‘
lowkey iconic that set reuses basically the whole create list โ€” yeah bestie, that's on purpose, so you can tweak any of it later ๐Ÿ’–

๐Ÿ’ซ COMMAND dsconf repl-winsync-agmt get ๐Ÿ’ซ

usage: dsconf [-v] [-j] instance repl-winsync-agmt get [-h] --suffix
SUFFIX
                                                       AGMT_NAME
  • AGMT_NAME โ€” the suffix DN for the replication configuration to display ๐Ÿ‘€

๐Ÿฆ‹ OPTIONS dsconf repl-winsync-agmt get ๐Ÿฆ‹

  • --suffix SUFFIX โ€” sets the DN of the replication suffix ๐ŸŽ€

๐Ÿ‘‘ COMMAND dsconf repl-tasks ๐Ÿ‘‘

usage: dsconf [-v] [-j] instance repl-tasks [-h]
                                  {cleanallruv,list-cleanruv-tasks,abort-cleanallruv,list-abortruv-tasks}
...

๐ŸŽ€ POSITIONAL ARGUMENTS dsconf repl-tasks ๐ŸŽ€

  • dsconf repl-tasks cleanallruv โ€” cleanup old/removed replica IDs ๐Ÿงน
  • dsconf repl-tasks list-cleanruv-tasks โ€” list all the running CleanAllRUV tasks ๐Ÿ“‹
  • dsconf repl-tasks abort-cleanallruv โ€” abort cleanallruv tasks ๐Ÿ›‘
  • dsconf repl-tasks list-abortruv-tasks โ€” list all the running CleanAllRUV abort tasks ๐Ÿ“

๐ŸŒˆ COMMAND dsconf repl-tasks cleanallruv ๐ŸŒˆ

usage: dsconf [-v] [-j] instance repl-tasks cleanallruv [-h] --suffix
SUFFIX
                                                        --replica-id
REPLICA_ID
                                                        [--force-cleaning]

๐Ÿ’œ OPTIONS dsconf repl-tasks cleanallruv ๐Ÿ’œ

  • --suffix SUFFIX โ€” sets the Directory Server suffix ๐ŸŒฒ
  • --replica-id REPLICA_ID โ€” sets the replica ID to remove/clean ๐Ÿ—‘๏ธ
  • --force-cleaning โ€” ignores errors and make a best attempt to clean all replicas ๐Ÿ’ช

โญ COMMAND dsconf repl-tasks list-cleanruv-tasks โญ

usage: dsconf [-v] [-j] instance repl-tasks list-cleanruv-tasks
       [-h] [--suffix SUFFIX]

๐Ÿ“ OPTIONS dsconf repl-tasks list-cleanruv-tasks ๐Ÿ“

  • --suffix SUFFIX โ€” lists only tasks for the specified suffix ๐ŸŽฏ

๐Ÿ”ฅ COMMAND dsconf repl-tasks abort-cleanallruv ๐Ÿ”ฅ

usage: dsconf [-v] [-j] instance repl-tasks abort-cleanallruv
       [-h] --suffix SUFFIX --replica-id REPLICA_ID [--certify]

๐Ÿงš OPTIONS dsconf repl-tasks abort-cleanallruv ๐Ÿงš

  • --suffix SUFFIX โ€” sets the Directory Server suffix ๐ŸŒฒ
  • --replica-id REPLICA_ID โ€” sets the replica ID of the cleaning task to abort ๐Ÿ›‘
  • --certify โ€” enforces that the abort task completed on all replicas โœ…

๐Ÿ’– COMMAND dsconf repl-tasks list-abortruv-tasks ๐Ÿ’–

usage: dsconf [-v] [-j] instance repl-tasks list-abortruv-tasks
       [-h] [--suffix SUFFIX]

๐ŸŒธ OPTIONS dsconf repl-tasks list-abortruv-tasks ๐ŸŒธ

  • --suffix SUFFIX โ€” lists only tasks for the specified suffix ๐ŸŽฏ

๐Ÿฆ‹ COMMAND dsconf repl-conflict ๐Ÿฆ‹

usage: dsconf [-v] [-j] instance repl-conflict [-h]
                                     {list,compare,delete,delete-all,swap,convert,list-glue,delete-glue,convert-glue}
...
okay so this one is ALL about conflict entries โ€” and bestie, there is more coming on this one in the next part ๐Ÿ‘€ don't go anywhere ๐Ÿ’…

๐Ÿ’ซ POSITIONAL ARGUMENTS 'dsconf repl-conflict' ๐Ÿ’ซ

okay so these are the little sub-commands that live under dsconf repl-conflict, and they're all about dealing with the messy entries replication leaves behind. slay โœจ

  • dsconf repl-conflict list โ€” lists out the conflict entries, bestie ๐Ÿ‘€
  • dsconf repl-conflict compare โ€” puts the conflict entry up against its valid counterpart so you can see the diff vibe ๐Ÿ”
  • dsconf repl-conflict delete โ€” deletes a conflict entry, gone girl, bye ๐Ÿ’…
  • dsconf repl-conflict delete-all โ€” deletes all the conflict entries. all of them. every last one ๐Ÿงน
  • dsconf repl-conflict swap โ€” replaces the valid entry with the conflict entry (yes it's giving chaos, but sometimes that's the move) ๐Ÿ”„
  • dsconf repl-conflict convert โ€” converts the conflict entry into a valid entry, while keeping the original valid entry counterpart ๐Ÿฆ‹ This requires that the converted conflict entry have a new RDN value. For example: "cn=my_new_rdn_value".
  • dsconf repl-conflict list-glue โ€” lists the replication glue entries ๐Ÿฏ
  • dsconf repl-conflict delete-glue โ€” deletes the glue entry and its child entries (whole little family gone, no cap) ๐Ÿ˜ญ
  • dsconf repl-conflict convert-glue โ€” converts the glue entry into a regular entry โญ

๐ŸŽ€ COMMAND 'dsconf repl-conflict list' ๐ŸŽ€

usage: dsconf [-v] [-j] instance repl-conflict list [-h] suffix

suffix โ€” sets the backend name, or suffix, to look for conflict entries.


๐ŸŽ€ COMMAND 'dsconf repl-conflict compare' ๐ŸŽ€

usage: dsconf [-v] [-j] instance repl-conflict compare [-h] DN

DN โ€” the DN of the conflict entry.


๐ŸŽ€ COMMAND 'dsconf repl-conflict delete' ๐ŸŽ€

usage: dsconf [-v] [-j] instance repl-conflict delete [-h] DN

DN โ€” the DN of the conflict entry.


๐ŸŽ€ COMMAND 'dsconf repl-conflict delete-all' ๐ŸŽ€

usage: dsconf [-v] [-j] instance repl-conflict delete-all [-h] suffix

suffix โ€” sets the backend name, or suffix, to remove all conflict entries from.


๐ŸŽ€ COMMAND 'dsconf repl-conflict swap' ๐ŸŽ€

usage: dsconf [-v] [-j] instance repl-conflict swap [-h] DN

DN โ€” the DN of the conflict entry.


๐ŸŽ€ COMMAND 'dsconf repl-conflict convert' ๐ŸŽ€

usage: dsconf instance [-v] [-j] repl-conflict convert [-h] --new-rdn
NEW_RDN
                                                          DN

DN โ€” the DN of the conflict entry.


๐Ÿ’– OPTIONS 'dsconf repl-conflict convert' ๐Ÿ’–

  • --new-rdn NEW_RDN โ€” sets the new RDN for the converted conflict entry, bestie. For example: "cn=my_new_rdn_value" โœจ

๐ŸŽ€ COMMAND 'dsconf repl-conflict list-glue' ๐ŸŽ€

usage: dsconf [-v] [-j] instance repl-conflict list-glue [-h] suffix

suffix โ€” the backend name, or suffix, to look for glue entries.


๐ŸŽ€ COMMAND 'dsconf repl-conflict delete-glue' ๐ŸŽ€

usage: dsconf [-v] [-j] instance repl-conflict delete-glue [-h] DN

DN โ€” the DN of the glue entry.


๐ŸŽ€ COMMAND 'dsconf repl-conflict convert-glue' ๐ŸŽ€

usage: dsconf [-v] [-j] instance repl-conflict convert-glue [-h] DN

DN โ€” the DN of the glue entry.


๐ŸŒธ COMMAND 'dsconf sasl' ๐ŸŒธ

usage: dsconf [-v] [-j] instance sasl [-h]
                            {list,get-mechs,get-available-mechs,get,create,delete}
...

๐ŸŒˆ POSITIONAL ARGUMENTS 'dsconf sasl' ๐ŸŒˆ

  • dsconf sasl list โ€” displays the available SASL mappings ๐Ÿ“‹
  • dsconf sasl get-mechs โ€” displays the SASL mechanisms that the server will accept โœ…
  • dsconf sasl get-available-mechs โ€” displays the SASL mechanisms that are available to the server (subtle difference, iconic behaviour) ๐Ÿ‘‘
  • dsconf sasl get โ€” displays SASL mappings ๐Ÿ”
  • dsconf sasl create โ€” creates a SASL mapping ๐Ÿ› ๏ธ
  • dsconf sasl delete โ€” deletes the SASL object ๐Ÿ’€

โญ COMMAND 'dsconf sasl list' โญ

usage: dsconf [-v] [-j] instance sasl list [-h] [--details]

๐Ÿ’… OPTIONS 'dsconf sasl list' ๐Ÿ’…

  • --details โ€” displays each SASL mapping in detail ๐Ÿ”ฌ

โญ COMMAND 'dsconf sasl get-mechs' โญ

usage: dsconf [-v] [-j] instance sasl get-mechs [-h]

โญ COMMAND 'dsconf sasl get-available-mechs' โญ

usage: dsconf [-v] [-j] instance sasl get-available-mechs [-h]

โญ COMMAND 'dsconf sasl get' โญ

usage: dsconf [-v] [-j] instance sasl get [-h] [selector]

selector โ€” the SASL mapping name to display.


โญ COMMAND 'dsconf sasl create' โญ

usage: dsconf [-v] [-j] instance sasl create [-h] [--cn [CN]]
                                             [--nsSaslMapRegexString
[NSSASLMAPREGEXSTRING]]
                                             [--nsSaslMapBaseDNTemplate
[NSSASLMAPBASEDNTEMPLATE]]
                                             [--nsSaslMapFilterTemplate
[NSSASLMAPFILTERTEMPLATE]]
                                             [--nsSaslMapPriority
[NSSASLMAPPRIORITY]]

๐Ÿ’… OPTIONS 'dsconf sasl create' ๐Ÿ’…

  • --cn [CN] โ€” the value of cn
  • --nsSaslMapRegexString [NSSASLMAPREGEXSTRING] โ€” the value of nsSaslMapRegexString
  • --nsSaslMapBaseDNTemplate [NSSASLMAPBASEDNTEMPLATE] โ€” the value of nsSaslMapBaseDNTemplate
  • --nsSaslMapFilterTemplate [NSSASLMAPFILTERTEMPLATE] โ€” the value of nsSaslMapFilterTemplate
  • --nsSaslMapPriority [NSSASLMAPPRIORITY] โ€” the value of nsSaslMapPriority

โญ COMMAND 'dsconf sasl delete' โญ

usage: dsconf [-v] [-j] instance sasl delete [-h] map_name

map_name โ€” the SASL mapping name (that's the "cn" value, bestie).


๐Ÿ”ฅ COMMAND 'dsconf security' ๐Ÿ”ฅ

usage: dsconf [-v] [-j] instance security [-h]
                                {set,get,enable,disable,disable_plain_port,certificate,ca-certificate,rsa,encryption-module,ciphers,csr,key,export-cert}
...

๐ŸŒˆ POSITIONAL ARGUMENTS 'dsconf security' ๐ŸŒˆ

  • dsconf security set โ€” set the general security options โš™๏ธ
  • dsconf security get โ€” display the general security options ๐Ÿ‘€
  • dsconf security enable โ€” enable security โœ…
  • dsconf security disable โ€” disable security ๐Ÿšซ
  • dsconf security disable_plain_port โ€” disables the plain text LDAP port, so only LDAPS keeps functioning. it's giving locked-down ๐Ÿ”’
  • dsconf security certificate โ€” manage TLS certificates ๐Ÿ“œ
  • dsconf security ca-certificate โ€” manage TLS certificate authorities ๐Ÿ‘‘
  • dsconf security rsa โ€” query and update RSA security options ๐Ÿ”
  • dsconf security encryption-module โ€” manage encryption modules ๐Ÿงฉ
  • dsconf security ciphers โ€” manage secure ciphers ๐Ÿ”ข
  • dsconf security csr โ€” manage certificate signing requests โœ๏ธ
  • dsconf security key โ€” manage keys in the NSS DB ๐Ÿ—๏ธ
  • dsconf security export-cert โ€” export a certificate to PEM or DER/Binary format. PEM format is the default ๐Ÿ“ค

โญ COMMAND 'dsconf security set' โญ

usage: dsconf [-v] [-j] instance security set [-h] [--security SECURITY]
                                              [--listen-host
LISTEN_HOST]
                                              [--secure-port
SECURE_PORT]
                                              [--tls-client-auth
TLS_CLIENT_AUTH]
                                              [--tls-client-renegotiation
TLS_CLIENT_RENEGOTIATION]
                                              [--require-secure-authentication
REQUIRE_SECURE_AUTHENTICATION]
                                              [--check-hostname
CHECK_HOSTNAME]
                                              [--extract-pemfiles
EXTRACT_PEMFILES]
                                              [--verify-cert-chain-on-startup
VERIFY_CERT_CHAIN_ON_STARTUP]
                                              [--session-timeout
SESSION_TIMEOUT]
                                              [--tls-protocol-min
TLS_PROTOCOL_MIN]
                                              [--tls-protocol-max
TLS_PROTOCOL_MAX]
                                              [--allow-insecure-ciphers
ALLOW_INSECURE_CIPHERS]
                                              [--allow-weak-dh-param
ALLOW_WEAK_DH_PARAM]
                                              [--cipher-pref
CIPHER_PREF]

Use this command for setting security related options that live in cn=config and cn=encryption,cn=config ๐Ÿซถ

And fyi bestie: to enable/disable security you can just use the enable and disable commands instead, way less effort ๐Ÿ’…

๐Ÿ’– OPTIONS 'dsconf security set' ๐Ÿ’–

  • --security SECURITY โ€” enables or disables security (nsslapd-security)
  • --listen-host LISTEN_HOST โ€” sets the host or IP address to listen on for LDAPS (nsslapd-securelistenhost)
  • --secure-port SECURE_PORT โ€” sets the port for LDAPS to listen on (nsslapd-securePort)
  • --tls-client-auth TLS_CLIENT_AUTH โ€” configures the client authentication requirement (nsSSLClientAuth)
  • --tls-client-renegotiation TLS_CLIENT_RENEGOTIATION โ€” allows client TLS renegotiation (nsTLSAllowClientRenegotiation)
  • --require-secure-authentication REQUIRE_SECURE_AUTHENTICATION โ€” configures whether binds over LDAPS, StartTLS, or SASL are required (nsslapd-require-secure-binds)
  • --check-hostname CHECK_HOSTNAME โ€” checks the subject of the remote certificate against the hostname (nsslapd-ssl-check-hostname)
  • --extract-pemfiles EXTRACT_PEMFILES โ€” at server shutdown, extract the server's certificates and keys to PEM files (nsslapd-extract-pemfiles)
  • --verify-cert-chain-on-startup VERIFY_CERT_CHAIN_ON_STARTUP โ€” validates the server certificate during startup (nsslapd-validate-cert)
  • --session-timeout SESSION_TIMEOUT โ€” sets the secure session timeout (nsSSLSessionTimeout)
  • --tls-protocol-min TLS_PROTOCOL_MIN โ€” sets the minimal allowed secure protocol version (sslVersionMin)
  • --tls-protocol-max TLS_PROTOCOL_MAX โ€” sets the maximal allowed secure protocol version (sslVersionMax)
  • --allow-insecure-ciphers ALLOW_INSECURE_CIPHERS โ€” allows weak ciphers for legacy use (allowWeakCipher) ๐Ÿ˜ฌ
ngl, "legacy use" here is doing a lot of heavy lifting. it's allowing weak ciphers on purpose, so know that going in.
  • --allow-weak-dh-param ALLOW_WEAK_DH_PARAM โ€” allows short DH params for legacy use (allowWeakDHParam) ๐Ÿ˜ฌ
  • --cipher-pref CIPHER_PREF โ€” directly sets the nsSSL3Ciphers attribute. It's a comma-separated list of cipher names (prefixed with + or -), optionally including +all or -all. The attribute may optionally be prefixed by the keyword "default". Please refer to the documentation of the attribute for a more detailed description. (nsSSL3Ciphers)

โญ COMMAND 'dsconf security get' โญ

usage: dsconf [-v] [-j] instance security get [-h]

โญ COMMAND 'dsconf security enable' โญ

usage: dsconf instance [-v] [-j] security enable [-h] [--cert-name
CERT_NAME]

If missing, it creates the security database, then turns on security functionality โœ…

โš ๏ธ heads up bestie: please note this is usually not enough for TLS connections to actually work โ€” proper setup of the CA and the server certificate is necessary. no shortcuts, sorry ๐Ÿ˜ญ

๐Ÿ’… OPTIONS 'dsconf security enable' ๐Ÿ’…

  • --cert-name CERT_NAME โ€” sets the name of the certificate the server should use ๐Ÿ“œ

โญ COMMAND 'dsconf security disable' โญ

usage: dsconf instance [-v] [-j] security disable [-h]

Turn off security functionality. The rest of the configuration will be left untouched, so nothing else gets dragged into it ๐Ÿซถ


โญ COMMAND 'dsconf security disable_plain_port' โญ

usage: dsconf instance [-v] [-j] security disable_plain_port [-h]

โญ COMMAND 'dsconf security certificate' โญ

usage: dsconf [-v] [-j] instance security certificate [-h]
                                                      {add,set-trust-flags,del,get,list}
...

๐ŸŽ€ POSITIONAL ARGUMENTS 'dsconf security certificate'

Like, pick your fighter, bestie ๐Ÿ’…

  • dsconf security certificate add โ€” Add a server certificate ๐Ÿ”ฅ
  • dsconf security certificate set-trust-flags โ€” Set the Trust flags
  • dsconf security certificate del โ€” Delete a certificate
  • dsconf security certificate get โ€” Display a server certificate's information ๐Ÿ‘€
  • dsconf security certificate list โ€” List the server certificates ๐Ÿ“‹

๐Ÿ’– COMMAND 'dsconf security certificate add'

okay so the vibe is:

usage: dsconf instance [-v] [-j] security certificate add [-h] --file FILE
                                                            --name NAME
                                                            [--primary-cert]
                                                            [--pkcs12-pin-text PKCS12_PIN_TEXT]
                                                            [--pkcs12-pin-stdin]
                                                            [--pkcs12-pin-path PKCS12_PIN_PATH]
                                                            [--do-it]

This is the one that Add a server certificate to the NSS database. No cap. ๐ŸŒธ

โœจ OPTIONS 'dsconf security certificate add'

  • --file FILE โ€” Sets the file name of the certificate ๐Ÿ“
  • --name NAME โ€” Sets the name/nickname of the certificate ๐Ÿท๏ธ
  • --primary-cert โ€” Sets this certificate as the server's certificate ๐Ÿ‘‘
  • --pkcs12-pin-text PKCS12_PIN_TEXT โ€” The PKCS#12 password as plain text. WARNING: Password may appear in process list or shell history. Use --pkcs12-pin-stdin or --pkcs12-pin-path to prevent password exposure. ๐Ÿšจ like bestie please use the safe one
  • --pkcs12-pin-stdin โ€” Read the PKCS#12 password from stdin โŒจ๏ธ
  • --pkcs12-pin-path PKCS12_PIN_PATH โ€” Path to a file containing the PKCS#12 password ๐Ÿ“„
  • --do-it โ€” Force the addition of a certificate that cannot be verified ๐Ÿ’€ (yes it's literally called that, it's giving "no thoughts head empty, just send it")

๐ŸŒˆ COMMAND 'dsconf security certificate set-trust-flags'

usage: dsconf instance [-v] [-j] security certificate set-trust-flags
       [-h] --flags FLAGS name

Change the trust flags of a server certificate โ€” glow up those flags girl โœจ

  • name โ€” The name/nickname of the certificate ๐Ÿท๏ธ

โœจ OPTIONS 'dsconf security certificate set-trust-flags'

  • --flags FLAGS โ€” Sets the trust flags for the server certificate ๐Ÿšฉ

๐Ÿฆ‹ COMMAND 'dsconf security certificate del'

usage: dsconf instance [-v] [-j] security certificate del [-h] name

Delete a server certificate from the NSS database or DynamicCerts backend. bye bestie ๐Ÿซถ

  • name โ€” The name/nickname of the certificate ๐Ÿท๏ธ

๐Ÿ’œ COMMAND 'dsconf security certificate get'

usage: dsconf instance [-v] [-j] security certificate get [-h] name

Displays detailed information about a certificate, such as trust attributes, expiration dates, Subject and Issuer DNs ๐Ÿ‘€ the whole lore drop fr

  • name โ€” Set the name/nickname of the certificate ๐Ÿท๏ธ

โญ COMMAND 'dsconf security certificate list'

usage: dsconf instance [-v] [-j] security certificate list [-h]

List all server certificates in the NSS database or DynamicCerts backend. ๐Ÿ“‹ iconic


๐Ÿงš COMMAND 'dsconf security ca-certificate'

usage: dsconf [-v] [-j] instance security ca-certificate [-h]
                                                         {add,set-trust-flags,del,get,list}
       ...

๐ŸŽ€ POSITIONAL ARGUMENTS 'dsconf security ca-certificate'

  • dsconf security ca-certificate add โ€” Add a Certificate Authority ๐Ÿ‘‘
  • dsconf security ca-certificate set-trust-flags โ€” Set the Trust flags
  • dsconf security ca-certificate del โ€” Delete a certificate
  • dsconf security ca-certificate get โ€” Displays a Certificate Authority's information ๐Ÿ‘€
  • dsconf security ca-certificate list โ€” List the Certificate Authorities ๐Ÿ“‹

๐Ÿ”ฅ COMMAND 'dsconf security ca-certificate add'

usage: dsconf instance [-v] [-j] security ca-certificate add
       [-h] --file FILE --name NAME [NAME ...] [--do-it]

Add a CA certificate (PEM or DER only) to the NSS database or DynamicCerts backend. (PEM or DER only โ€” read that again bestie, not everything works here)

โœจ OPTIONS 'dsconf security ca-certificate add'

  • --file FILE โ€” Path to the CA certificate file (PEM or DER). If adding a PEM bundle then specify multiple names one for each certificate, otherwise a number increment will be added to the previous name. ๐Ÿ“
  • --name NAME [NAME ...] โ€” Sets the name/nickname of the CA certificate ๐Ÿท๏ธ (yes you can pass a whole list of them, slay)
  • --do-it โ€” Force the addition of a certificate that cannot be verified ๐Ÿ’€ (unverified cert? just vibes)

๐ŸŒธ COMMAND 'dsconf security ca-certificate set-trust-flags'

usage: dsconf instance [-v] [-j] security ca-certificate set-trust-flags
       [-h] --flags FLAGS name

Change the trust attributes of a CA certificate. Certificate Authorities typically use "CT,," ๐Ÿ” noting that down

  • name โ€” The name/nickname of the CA certificate ๐Ÿท๏ธ

โœจ OPTIONS 'dsconf security ca-certificate set-trust-flags'

  • --flags FLAGS โ€” Sets the trust flags for the CA certificate ๐Ÿšฉ

๐Ÿซถ COMMAND 'dsconf security ca-certificate del'

usage: dsconf instance [-v] [-j] security ca-certificate del [-h] name

Delete a CA certificate from the NSS database โ€” gone, periodt ๐Ÿ’…

  • name โ€” The name/nickname of the CA certificate ๐Ÿท๏ธ

๐ŸŒˆ COMMAND 'dsconf security ca-certificate get'

usage: dsconf instance [-v] [-j] security ca-certificate get [-h] name

Get detailed information about a CA certificate, like trust attributes, expiration dates, Subject and Issuer DN ๐Ÿ‘€ the full tea

  • name โ€” The name/nickname of the CA certificate ๐Ÿท๏ธ

๐Ÿฆ‹ COMMAND 'dsconf security ca-certificate list'

usage: dsconf instance [-v] [-j] security ca-certificate list [-h]

List the CA certificates in the NSS database ๐Ÿ“‹


๐Ÿ‘‘ COMMAND 'dsconf security rsa'

usage: dsconf [-v] [-j] instance security rsa [-h]
                                              {set,get,enable,disable}
       ...

๐ŸŽ€ POSITIONAL ARGUMENTS 'dsconf security rsa'

  • dsconf security rsa set โ€” Set RSA security options โš™๏ธ
  • dsconf security rsa get โ€” Get RSA security options ๐Ÿ‘€
  • dsconf security rsa enable โ€” Enable RSA โœ…
  • dsconf security rsa disable โ€” Disable RSA โŒ

โš™๏ธ COMMAND 'dsconf security rsa set'

usage: dsconf [-v] [-j] instance security rsa set [-h]
                                                  [--tls-allow-rsa-certificates TLS_ALLOW_RSA_CERTIFICATES]
                                                  [--nss-cert-name NSS_CERT_NAME]
                                                  [--nss-token NSS_TOKEN]

Use this command for setting RSA (private key) related options located in cn=RSA,cn=encryption,cn=config. ๐Ÿ”

To enable/disable RSA you can use enable and disable commands instead. fykyk ๐Ÿ’ก

โœจ OPTIONS 'dsconf security rsa set'

  • --tls-allow-rsa-certificates TLS_ALLOW_RSA_CERTIFICATES โ€” Activates the use of RSA certificates (nsSSLActivation) โœ…
  • --nss-cert-name NSS_CERT_NAME โ€” Sets the server certificate name in NSS DB (nsSSLPersonalitySSL) ๐Ÿท๏ธ
  • --nss-token NSS_TOKEN โ€” Sets the security token name (module of NSS DB) (nsSSLToken) ๐Ÿ”‘

๐Ÿ‘€ COMMAND 'dsconf security rsa get'

usage: dsconf [-v] [-j] instance security rsa get [-h]

โœ… COMMAND 'dsconf security rsa enable'

usage: dsconf [-v] [-j] instance security rsa enable [-h]

โŒ COMMAND 'dsconf security rsa disable'

usage: dsconf [-v] [-j] instance security rsa disable [-h]

๐Ÿงฉ COMMAND 'dsconf security encryption-module'

usage: dsconf [-v] [-j] instance security encryption-module
       [-h] {add,delete,edit,list,get} ...

๐ŸŽ€ POSITIONAL ARGUMENTS 'dsconf security encryption-module'

  • dsconf security encryption-module add โ€” Add an encryption module โž•
  • dsconf security encryption-module delete โ€” Delete an encryption module ๐Ÿ—‘๏ธ
  • dsconf security encryption-module edit โ€” Edit an encryption module โœ๏ธ
  • dsconf security encryption-module list โ€” List encryption modules ๐Ÿ“‹
  • dsconf security encryption-module get โ€” Get an encryption module ๐Ÿ‘€

โž• COMMAND 'dsconf security encryption-module add'

usage: dsconf instance [-v] [-j] security encryption-module add
       [-h] --cert-nickname CERT_NICKNAME [--activated] [--token TOKEN]
       [--server-key-extract-file SERVER_KEY_EXTRACT_FILE]
       [--server-cert-extract-file SERVER_CERT_EXTRACT_FILE]
       name

Add a new encryption module to the encryption module list. โœจ

  • name โ€” The name of the encryption module ๐Ÿท๏ธ

โœจ OPTIONS 'dsconf security encryption-module add'

  • --cert-nickname CERT_NICKNAME โ€” The personality or nickname of the server certificate ๐ŸŽญ
  • --activated โ€” Activate the encryption module. โšก
  • --token TOKEN โ€” The token of the encryption module. Default is "internal (software)". ๐Ÿ”‘
  • --server-key-extract-file SERVER_KEY_EXTRACT_FILE โ€” The file name of the server key extract file ๐Ÿ“„
  • --server-cert-extract-file SERVER_CERT_EXTRACT_FILE โ€” The file name of the server cert extract file ๐Ÿ“„

๐Ÿ—‘๏ธ COMMAND 'dsconf security encryption-module delete'

usage: dsconf instance [-v] [-j] security encryption-module delete [-h]
       name

Delete an encryption module from the encryption module list. bye ๐Ÿ‘‹

  • name โ€” The name of the encryption module ๐Ÿท๏ธ

โœ๏ธ COMMAND 'dsconf security encryption-module edit'

usage: dsconf instance [-v] [-j] security encryption-module edit
       [-h] [--cert-nickname CERT_NICKNAME] [--activate] [--deactivate]
       [--token TOKEN] [--server-key-extract-file SERVER_KEY_EXTRACT_FILE]
       [--server-cert-extract-file SERVER_CERT_EXTRACT_FILE]
       name

Edit an encryption module in the encryption module list. ๐Ÿ› ๏ธ

  • name โ€” The name of the encryption module ๐Ÿท๏ธ

โœจ OPTIONS 'dsconf security encryption-module edit'

  • --cert-nickname CERT_NICKNAME โ€” The personality or nickname of the server certificate ๐ŸŽญ
  • --activate โ€” Activate the encryption module โšก
  • --deactivate โ€” Deactivate the encryption module ๐Ÿ’ค
  • --token TOKEN โ€” The token of the encryption module. ๐Ÿ”‘
  • --server-key-extract-file SERVER_KEY_EXTRACT_FILE โ€” The file name of the server key extract file ๐Ÿ“„
  • --server-cert-extract-file SERVER_CERT_EXTRACT_FILE โ€” The file name of the server cert extract file ๐Ÿ“„

๐Ÿ“‹ COMMAND 'dsconf security encryption-module list'

usage: dsconf instance [-v] [-j] security encryption-module list
       [-h] [--just-names]

List all encryption modules in the encryption module list. ๐Ÿงฉ

โœจ OPTIONS 'dsconf security encryption-module list'

  • --just-names โ€” Just list the modules by its name and not the full entry ๐Ÿท๏ธ (short n sweet, we love a minimal moment)

๐Ÿ‘€ COMMAND 'dsconf security encryption-module get'

usage: dsconf instance [-v] [-j] security encryption-module get [-h]
       name

Get an encryption module from the encryption module list. ๐Ÿงฉ

  • name โ€” The name of the encryption module ๐Ÿท๏ธ

๐Ÿ” COMMAND 'dsconf security ciphers'

usage: dsconf [-v] [-j] instance security ciphers [-h]
                                                  {enable,disable,get,set,list}
       ...

๐ŸŽ€ POSITIONAL ARGUMENTS 'dsconf security ciphers'

  • dsconf security ciphers enable โ€” Enable ciphers โœ…
  • dsconf security ciphers disable โ€” Disable ciphers โŒ
  • dsconf security ciphers get โ€” Get ciphers attribute ๐Ÿ‘€
  • dsconf security ciphers set โ€” Set ciphers attribute โš™๏ธ
  • dsconf security ciphers list โ€” List ciphers ๐Ÿ“‹

๐ŸŽ€ COMMAND 'dsconf security ciphers enable'

usage: dsconf instance [-v] [-j] security ciphers enable [-h] cipher [cipher ...]

Use this command to enable specific ciphers. bestie we are turning them ON ๐Ÿ’…

cipher โ€” the cipher (or ciphers) you wanna enable โœจ


๐ŸŽ€ COMMAND 'dsconf security ciphers disable'

usage: dsconf instance [-v] [-j] security ciphers disable [-h] cipher [cipher ...]

Use this command to disable specific ciphers. yep, the opposite energy โ€” we're turning them OFF ๐Ÿ™ˆ

cipher โ€” the cipher (or ciphers) getting the boot ๐Ÿฅพ


๐ŸŽ€ COMMAND 'dsconf security ciphers get'

usage: dsconf instance [-v] [-j] security ciphers get [-h]

Use this command to get the contents of the nsSSL3Ciphers attribute. like, show me what's in there rn ๐Ÿ‘€


๐ŸŽ€ COMMAND 'dsconf security ciphers set'

usage: dsconf instance [-v] [-j] security ciphers set [-h] cipher-string

Use this command to directly set the nsSSL3Ciphers attribute. It is a comma separated list of cipher names (prefixed with + or -), optionally including +all or -all. The attribute may optionally be set to the keyword default. Please refer to the documentation of the attribute for a more detailed description. (no cap, the docs go deeper on this one ๐Ÿ“–)

cipher-string โ€” the actual comma-separated value you're handing over ๐Ÿซถ


๐ŸŽ€ COMMAND 'dsconf security ciphers list'

usage: dsconf instance [-v] [-j] security ciphers list [-h] [--enabled | --supported | --disabled]

List secure ciphers. With no arguments at all, it lists the ciphers as configured in the nsSSL3Ciphers attribute. simple as that โœจ

โœจ OPTIONS 'dsconf security ciphers list'

  • --enabled โ€” Lists only enabled ciphers ๐Ÿ”ฅ
  • --supported โ€” Lists only supported ciphers ๐Ÿ’–
  • --disabled โ€” Lists only supported ciphers but without the enabled ciphers (so, the supported-but-not-on ones, iykyk)

๐ŸŽ€ COMMAND 'dsconf security csr'

usage: dsconf [-v] [-j] instance security csr [-h] {list,get,req,del} ...

โœจ POSITIONAL ARGUMENTS 'dsconf security csr'

  • dsconf security csr list โ€” List CSRs ๐Ÿ“‹
  • dsconf security csr get โ€” Display CSR content ๐Ÿ‘€
  • dsconf security csr req โ€” Generate a Certificate Signing Request ๐ŸŒธ
  • dsconf security csr del โ€” Delete a CSR file ๐Ÿ’€

๐ŸŽ€ COMMAND 'dsconf security csr list'

usage: dsconf instance [-v] [-j] security csr list [-h] [--path PATH]

List all CSR files in the instance configuration directory โœจ

โœจ OPTIONS 'dsconf security csr list'

  • --path PATH, -p PATH โ€” Directory containing the CSR file ๐Ÿ“‚

๐ŸŽ€ COMMAND 'dsconf security csr get'

usage: dsconf instance [-v] [-j] security csr get [-h] name

Displays the contents of a CSR, which can be used for submittal to a CA ๐Ÿซถ

  • name โ€” Name of the CSR file to display

๐ŸŽ€ COMMAND 'dsconf security csr req'

usage: dsconf instance [-v] [-j] security csr req [-h] --subject SUBJECT --name NAME [alt_names ...]

Generate a CSR that can be submitted to a CA for verification ๐Ÿ‘‘

  • alt_names โ€” CSR alternative names. These are auto-detected if not provided ๐Ÿ’…

โœจ OPTIONS 'dsconf security csr req'

  • --subject SUBJECT, -s SUBJECT โ€” Subject field
  • --name NAME, -n NAME โ€” Name

๐ŸŽ€ COMMAND 'dsconf security csr del'

usage: dsconf [-v] [-j] instance security csr del [-h] name

Delete a CSR file ๐Ÿ’€

  • name โ€” Name of the CSR file to delete

๐ŸŽ€ COMMAND 'dsconf security key'

usage: dsconf [-v] [-j] instance security key [-h] {list,del} ...

โœจ POSITIONAL ARGUMENTS 'dsconf security key'

  • dsconf security key list โ€” List all keys in the NSS DB ๐Ÿ”‘
  • dsconf security key del โ€” Delete a key from the NSS DB ๐Ÿ’€

๐ŸŽ€ COMMAND 'dsconf security key list'

usage: dsconf [-v] [-j] instance security key list [-h] [--orphan]

โœจ OPTIONS 'dsconf security key list'

  • --orphan โ€” List orphan keys. And bestie, an orphan key is a private key in the NSS DB for which there is NO cert with the corresponding public key ๐Ÿ˜ญ. An orphan key gets created during CSR generation โ€” and when the associated certificate is imported into the NSS DB, its orphan state will be removed. so it's not forever, it gets adopted eventually ๐Ÿซถ

๐ŸŽ€ COMMAND 'dsconf security key del'

usage: dsconf instance [-v] [-j] security key del [-h] key_id

Remove a key from the NSS DB. Make sure the key is not in use before you delete it โš ๏ธ (for real, double-check first)

  • key_id โ€” This is the key ID displayed when listing keys ๐Ÿ‘‘

๐ŸŽ€ COMMAND 'dsconf security export-cert'

usage: dsconf instance [-v] [-j] security export-cert [-h] [--binary-format] [--output-file OUTPUT_FILE] nickname
  • nickname โ€” The name of the certificate to export ๐Ÿ“œ

โœจ OPTIONS 'dsconf security export-cert'

  • --binary-format โ€” Export certificate in DER/binary format ๐Ÿงš
  • --output-file OUTPUT_FILE โ€” The name for the exported certificate. Default name is the certificate nickname with an extension of .pem or .crt โœจ

๐ŸŽ€ COMMAND 'dsconf schema'

usage: dsconf [-v] [-j] instance schema [-h] {list,attributetypes,objectclasses,matchingrules,reload,validate-syntax,import-openldap-file} ...

โœจ POSITIONAL ARGUMENTS 'dsconf schema'

  • dsconf schema list โ€” List all schema objects on this system ๐Ÿ“‹
  • dsconf schema attributetypes โ€” Work with attribute types on this system ๐Ÿ’…
  • dsconf schema objectclasses โ€” Work with objectClasses on this system ๐ŸŽ€
  • dsconf schema matchingrules โ€” Work with matching rules on this system ๐Ÿงš
  • dsconf schema reload โ€” Dynamically reload schema while the server is running ๐Ÿ”„
  • dsconf schema validate-syntax โ€” Run a task to check that all attributes in an entry have the correct syntax โœ…
  • dsconf schema import-openldap-file โ€” Import openldap formatted dynamic schema ldifs. These will contain values like olcAttributeTypes and olcObjectClasses ๐Ÿ“ฅ

๐ŸŽ€ COMMAND 'dsconf schema list'

usage: dsconf [-v] [-j] instance schema list [-h] [--include-oc-sup]

โœจ OPTIONS 'dsconf schema list'

  • --include-oc-sup โ€” Include the superior objectclasses' may and must attributes ๐Ÿ‘‘

๐ŸŽ€ COMMAND 'dsconf schema attributetypes'

usage: dsconf [-v] [-j] instance schema attributetypes [-h] {get_syntaxes,list,query,add,replace,remove} ...

โœจ POSITIONAL ARGUMENTS 'dsconf schema attributetypes'

  • dsconf schema attributetypes get_syntaxes โ€” List all available attribute type syntaxes ๐Ÿ”ค
  • dsconf schema attributetypes list โ€” List available attribute types on this system ๐Ÿ“‹
  • dsconf schema attributetypes query โ€” Query an attribute to determine object classes that may or must take it ๐Ÿ”
  • dsconf schema attributetypes add โ€” Add an attribute type to this system โž•
  • dsconf schema attributetypes replace โ€” Replace an attribute type on this system ๐Ÿ”
  • dsconf schema attributetypes remove โ€” Remove an attribute type on this system ๐Ÿ’€

๐ŸŽ€ COMMAND 'dsconf schema attributetypes get_syntaxes'

usage: dsconf [-v] [-j] instance schema attributetypes get_syntaxes [-h]

๐ŸŽ€ COMMAND 'dsconf schema attributetypes list'

usage: dsconf [-v] [-j] instance schema attributetypes list [-h]

๐ŸŽ€ COMMAND 'dsconf schema attributetypes query'

usage: dsconf [-v] [-j] instance schema attributetypes query [-h] [name]
  • name โ€” Attribute type to query ๐Ÿ”

๐ŸŽ€ COMMAND 'dsconf schema attributetypes add'

usage: dsconf [-v] [-j] instance schema attributetypes add [-h] [--oid OID] [--desc DESC] [--x-origin X_ORIGIN] [--aliases ALIASES [ALIASES ...]] [--single-value] [--multi-value] [--no-user-mod] [--user-mod] [--equality EQUALITY] [--substr SUBSTR] [--ordering ORDERING] [--usage USAGE] [--sup SUP] --syntax SYNTAX name
  • name โ€” NAME of the object โœจ

โœจ OPTIONS 'dsconf schema attributetypes add'

  • --oid OID โ€” OID assigned to the object ๐Ÿ”ข
  • --desc DESC โ€” Description text (DESC) of the object ๐Ÿ“
  • --x-origin X_ORIGIN โ€” Provides information about where the attribute type is defined ๐Ÿ“
  • --aliases ALIASES [ALIASES ...] โ€” Additional NAMEs of the object ๐Ÿท๏ธ
  • --single-value โ€” True if the matching rule must have only one value. Only one of the flags this or --multi-value should be specified โ˜๏ธ
  • --multi-value โ€” True if the matching rule may have multiple values (default). Only one of the flags this or --single-value should be specified โœจ
  • --no-user-mod โ€” True if the attribute is not modifiable by a client application. Only one of the flags this or --user-mod should be specified ๐Ÿ”’
  • --user-mod โ€” True if the attribute is modifiable by a client application (default). Only one of the flags this or --no-user-mode should be specified ๐Ÿ”“
  • --equality EQUALITY โ€” NAME or OID of the matching rule used for checking whether attribute values are equal ๐ŸŸฐ
  • --substr SUBSTR โ€” NAME or OID of the matching rule used for checking whether an attribute value contains another value ๐Ÿ”Ž
  • --ordering ORDERING โ€” NAME or OID of the matching rule used for checking whether attribute values are lesser - equal than ๐Ÿ“Š
  • --usage USAGE โ€” The flag indicates how the attribute type is to be used. Choose from the list: userApplications (default), directoryOperation, distributedOperation, dSAOperation ๐ŸŽš๏ธ
  • --sup SUP โ€” The NAME or OID of attribute type this attribute type is derived from ๐ŸŒฑ
  • --syntax SYNTAX โ€” OID of the LDAP syntax assigned to the attribute ๐Ÿ”ค

๐ŸŽ€ COMMAND 'dsconf schema attributetypes replace'

usage: dsconf [-v] [-j] instance schema attributetypes replace [-h] [--oid OID] [--desc DESC] [--x-origin X_ORIGIN] [--aliases ALIASES [ALIASES ...]] [--single-value] [--multi-value] [--no-user-mod] [--user-mod] [--equality EQUALITY] [--substr SUBSTR] [--ordering ORDERING] [--usage USAGE] [--sup SUP] [--syntax SYNTAX] name
  • name โ€” NAME of the object โœจ
  • --oid OID โ€” the OID you're handing to this object. like its official little nametag ๐Ÿ’–
  • --desc DESC โ€” the description text (DESC) for the object. tell us what it is, bestie.
  • --x-origin X_ORIGIN โ€” serves up the tea on where the attribute type is defined ๐Ÿซ–
  • --aliases ALIASES [ALIASES ...] โ€” extra NAMEs for the object, because one name is never enough, we love a multi-hyphenate โœจ
  • --single-value โ€” true if the matching rule must have only one value. and heads up: only one of the flags โ€” this one or --multi-value โ€” should be specified. pick a lane, bestie ๐Ÿ’…
  • --multi-value โ€” true if the matching rule may have multiple values (default). same rule applies: only one of the flags โ€” this one or --single-value โ€” should be specified.
  • --no-user-mod โ€” true if the attribute is not modifiable by a client application. and again: only one of the flags โ€” this one or --user-mod โ€” should be specified.
  • --user-mod โ€” true if the attribute is modifiable by a client application (default). only one of the flags โ€” this one or --no-user-mode โ€” should be specified.
  • --equality EQUALITY โ€” NAME or OID of the matching rule used for checking whether attribute values are equal ๐Ÿ‘ฏ
  • --substr SUBSTR โ€” NAME or OID of the matching rule used for checking whether an attribute value contains another value ๐Ÿ“
  • --ordering ORDERING โ€” NAME or OID of the matching rule used for checking whether attribute values are lesser-equal than.
  • --usage USAGE โ€” this flag says how the attribute type is gonna be used. choose from the list: userApplications (default), directoryOperation, distributedOperation, dSAOperation. no mixing, pick one ๐Ÿ‘‘
  • --sup SUP โ€” the NAME or OID of the attribute type this attribute type is derived from. its ancestor, its origin story, its lore.
  • --syntax SYNTAX โ€” OID of the LDAP syntax assigned to the attribute.

๐Ÿ’ซ COMMAND dsconf schema attributetypes remove ๐Ÿ’ซ

usage: dsconf [-v] [-j] instance schema attributetypes remove [-h] name
  • name โ€” NAME of the object. that's it, that's the whole vibe ๐ŸŽ€

๐ŸŒˆ COMMAND dsconf schema objectclasses ๐ŸŒˆ

usage: dsconf [-v] [-j] instance schema objectclasses [-h]
                                                      {list,query,add,replace,remove}
...

๐Ÿ“‹ POSITIONAL ARGUMENTS dsconf schema objectclasses

  • dsconf schema objectclasses list โ€” list all the available objectClasses on this system. window shopping basically ๐Ÿ›๏ธ
  • dsconf schema objectclasses query โ€” query an objectClass. go ask it questions.
  • dsconf schema objectclasses add โ€” add an objectClass to this system.
  • dsconf schema objectclasses replace โ€” replace an objectClass on this system.
  • dsconf schema objectclasses remove โ€” remove an objectClass from this system.

โœจ COMMAND dsconf schema objectclasses list โœจ

usage: dsconf [-v] [-j] instance schema objectclasses list [-h]
                                                          [--include-sup]

๐Ÿ” OPTIONS dsconf schema objectclasses list

  • --include-sup โ€” include the superior objectclasses' "may" and "must" attributes. get the whole family tree ๐ŸŒณ

๐Ÿฆ‹ COMMAND dsconf schema objectclasses query ๐Ÿฆ‹

usage: dsconf [-v] [-j] instance schema objectclasses query
       [-h] [--include-sup] [name]
  • name โ€” the ObjectClass to query. which one are we investigating bestie ๐Ÿ”Ž

๐Ÿ” OPTIONS dsconf schema objectclasses query

  • --include-sup โ€” include the superior objectclasses' "may" and "must" attributes. yes, the ancestors too ๐Ÿ’œ

๐ŸŒธ COMMAND dsconf schema objectclasses add ๐ŸŒธ

usage: dsconf [-v] [-j] instance schema objectclasses add [-h] [--oid
OID]
                                                          [--desc DESC]
                                                          [--x-origin
X_ORIGIN]
                                                          [--must MUST
[MUST ...]]
                                                          [--may MAY
[MAY ...]]
                                                          [--kind KIND]
                                                          [--sup SUP
[SUP ...]]
                                                          name
  • name โ€” NAME of the object. every icon needs a name, periodt.

๐Ÿ’– OPTIONS dsconf schema objectclasses add

  • --oid OID โ€” OID assigned to the object.
  • --desc DESC โ€” description text (DESC) of the object. spill the details ๐Ÿ“
  • --x-origin X_ORIGIN โ€” provides information about where the attribute type is defined.
  • --must MUST [MUST ...] โ€” NAMEs or OIDs of all attributes an entry of the object must have. non-negotiable, mandatory, no skipping ๐Ÿ‘‘
  • --may MAY [MAY ...] โ€” NAMEs or OIDs of additional attributes an entry of the object may have. optional extras, lovely.
  • --kind KIND โ€” kind of an object. STRUCTURAL (default), ABSTRACT, AUXILIARY.
  • --sup SUP [SUP ...] โ€” NAME or OIDs of object classes this object is derived from.

๐Ÿ’… COMMAND dsconf schema objectclasses replace ๐Ÿ’…

usage: dsconf [-v] [-j] instance schema objectclasses replace
       [-h] [--oid OID] [--desc DESC] [--x-origin X_ORIGIN]
       [--must MUST [MUST ...]] [--may MAY [MAY ...]] [--kind KIND]
       [--sup SUP [SUP ...]]
       name
  • name โ€” NAME of the object.

๐Ÿ’– OPTIONS dsconf schema objectclasses replace

  • --oid OID โ€” OID assigned to the object.
  • --desc DESC โ€” description text (DESC) of the object.
  • --x-origin X_ORIGIN โ€” provides information about where the attribute type is defined.
  • --must MUST [MUST ...] โ€” NAMEs or OIDs of all attributes an entry of the object must have.
  • --may MAY [MAY ...] โ€” NAMEs or OIDs of additional attributes an entry of the object may have.
  • --kind KIND โ€” kind of an object. STRUCTURAL (default), ABSTRACT, AUXILIARY.
  • --sup SUP [SUP ...] โ€” NAME or OIDs of object classes this object is derived from.

๐ŸŽ€ COMMAND dsconf schema objectclasses remove ๐ŸŽ€

usage: dsconf [-v] [-j] instance schema objectclasses remove [-h] name
  • name โ€” NAME of the object. bye bestie ๐Ÿ‘‹ (not me being emotional about a schema deletion)

๐Ÿ’€ COMMAND dsconf schema matchingrules ๐Ÿ’€

usage: dsconf [-v] [-j] instance schema matchingrules [-h] {list,query}
...

๐Ÿ“‹ POSITIONAL ARGUMENTS dsconf schema matchingrules

  • dsconf schema matchingrules list โ€” list all the available matching rules on this system.
  • dsconf schema matchingrules query โ€” query a matching rule.

๐Ÿ”ฅ COMMAND dsconf schema matchingrules list ๐Ÿ”ฅ

usage: dsconf [-v] [-j] instance schema matchingrules list [-h]

no options, no flags, just vibes. it lists. it's enough. โœจ


๐Ÿ”Ž COMMAND dsconf schema matchingrules query ๐Ÿ”Ž

usage: dsconf [-v] [-j] instance schema matchingrules query [-h] [name]
  • name โ€” the Matching rule to query.

๐Ÿงš COMMAND dsconf schema reload ๐Ÿงš

usage: dsconf [-v] [-j] instance schema reload [-h] [-d SCHEMADIR]
[--wait]
                                                   [--timeout TIMEOUT]

๐ŸŒŸ OPTIONS dsconf schema reload

  • -d SCHEMADIR, --schemadir SCHEMADIR โ€” the directory where the schema files are located. go get 'em ๐Ÿ“‚
  • --wait โ€” wait for the reload task to complete. patience is a virtue, bestie, and also a flag.
  • --timeout TIMEOUT โ€” set a timeout to wait for the reload task. Default is 120 seconds.

โญ COMMAND dsconf schema validate-syntax โญ

usage: dsconf instance [-v] [-j] schema validate-syntax [-h] [-f FILTER]
                                                       [--timeout
TIMEOUT]
                                                       DN
  • DN โ€” the Base DN that contains entries to validate. this is your starting point, your home base ๐Ÿ 

๐ŸŒˆ OPTIONS dsconf schema validate-syntax

  • -f FILTER, --filter FILTER โ€” filter for entries to validate. if you omit it, all entries with filter "(objectclass=*)" get validated. no filter, no escape ๐Ÿ˜ญ
  • --timeout TIMEOUT โ€” set a timeout to wait for the validation task. Default is 120 seconds.

๐Ÿ“ COMMAND dsconf schema import-openldap-file ๐Ÿ“

usage: dsconf instance [-v] [-j] schema import-openldap-file
       [-h] [--confirm] schema_file
  • schema_file โ€” path to the openldap dynamic schema ldif to import. bring your file, we're migrating ๐Ÿšš

๐Ÿ’œ OPTIONS dsconf schema import-openldap-file

  • --confirm โ€” confirm that you want to apply these schema migration actions to the 389-ds instance. by default, no actions are taken. so like, nothing happens until you say the word. it's giving very-consent-forward of it ๐Ÿ’…

๐Ÿ‘‘ OPTIONS ๐Ÿ‘‘

  • -v, --verbose โ€” display verbose operation tracing while the command runs. it will narrate everything, very main character.
  • -j, --json โ€” return the result in a JSON object. for the machines ๐Ÿค–
  • -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 the password of the bind DN. it asks, you type, nobody sees, we love a discreet moment ๐Ÿ™ˆ
  • -y PWDFILE, --pwdfile PWDFILE โ€” specifies a file containing the password of the bind DN.
  • -b BASEDN, --basedn BASEDN โ€” base DN (root naming context) of the instance to manage.
  • -Z, --starttls โ€” connect with StartTLS. secure that connection, we stay encrypted around here ๐Ÿ”’

๐Ÿ’– AUTHOR

"Red Hat, Inc., and William Brown" <389-devel@lists.fedoraproject.org>


aaaand that's a wrap on DSCONF(8), bestie!! ๐ŸŽ‰ this bad boy is from lib389 3.3.1, dated 2026-09-11 โ€” go forth and schema responsibly, no cap ๐Ÿซถ๐Ÿ’–โœจ

๐Ÿ“ฆ where this page comes from