The dsconfig command provides many subcommands.
Subcommands let you create, list, and delete entire configuration components,
and also let you get and set component properties.
Subcommands therefore have names that reflect these five actions.
create-componentlist-componentsdelete-componentget-component-propset-component-prop
Here, component names are names of managed object types.
Subcommand component names
are lower-case, hyphenated versions of the friendly names.
When you act on an actual configuration component,
you provide the name of the component as an option argument.
For example, the Log Publisher component has these corresponding subcommands.
create-log-publisherlist-log-publishersdelete-log-publisherget-log-publisher-propset-log-publisher-prop
When you create or delete Log Publisher components
and when you get and set their configuration properties,
you provide the name of the actual log publisher,
which you can find by using the list-log-publishers subcommand.
$ dsconfig \
list-log-publishers \
--hostname opendj.example.com \
--port 4444 \
--bindDN "cn=Directory Manager" \
--bindPassword password \
--trustAll
Log Publisher : Type : enabled
------------------------------:------------------------:--------
File-Based Access Logger : file-based-access : true
File-Based Audit Logger : file-based-audit : false
File-Based Debug Logger : file-based-debug : false
File-Based Error Logger : file-based-error : true
File-Based HTTP Access Logger : file-based-http-access : false
Replication Repair Logger : file-based-error : true
$ dsconfig \
get-log-publisher-prop \
--publisher-name "File-Based Access Logger" \
--property rotation-policy \
--hostname opendj.example.com \
--port 4444 \
--bindDN "cn=Directory Manager" \
--bindPassword password \
--trustAllProperty : Value(s)
----------------:--------------------------------------------------------------
rotation-policy : 24 Hours Time Limit Rotation Policy, Size Limit Rotation
: Policy
Many subcommands let you set property values.
Notice in the reference for the subcommands below
that specific options are available for handling multi-valued properties.
Whereas you can assign a single property value
by using the option,
you assign multiple values to a multi-valued property
by using the option.
You can reset the values of the multi-valued property
by using the option.
Use the following options to view help for subcommands.
dsconfig --help-all
Display all subcommands
dsconfig --help-core-server
Display subcommands relating to core server
dsconfig --help-database
Display subcommands relating to caching and back-ends
dsconfig --help-logging
Display subcommands relating to logging
dsconfig --help-replication
Display subcommands relating to replication
dsconfig --help-security
Display subcommands relating to authentication and authorization
dsconfig --help-user-management
Display subcommands relating to user management
For help with individual subcommands,
either use dsconfig subcommand --help,
or start dsconfig in interactive mode,
without specifying a subcommand.
To view all component properties,
use the dsconfig list-properties command.