The dsconfig command is the primary command-line tool
for viewing and editing OpenDJ configuration.
When started without arguments,
dsconfig prompts you for administration connection information,
including the host name, administration port number,
administrator bind DN and administrator password.
The dsconfig command then connects securely
to the directory server over the administration port.
Once connected it presents you with a menu-driven interface to the server configuration.
When you pass connection information, subcommands, and additional options
to dsconfig,
the command runs in script mode and so is not interactive,
though it can prompt you to ask whether to apply changes
and whether to trust certificates
(unless you use the
and options, respectively).
You can prepare dsconfig batch scripts
by running the tool with the option
in interactive mode,
then reading from the batch file with the option
in script mode.
Batch files can be useful when you have many dsconfig commands to run
and want to avoid starting the JVM and setting up a new connection for each command.
The dsconfig command categorizes
directory server configuration into components,
also called managed objects.
Actual components often inherit from a parent component type.
For example, one component is a Connection Handler.
An LDAP Connection Handler is a type of Connection Handler.
You configure the LDAP Connection Handler component
to specify how OpenDJ directory server handles LDAP connections
coming from client applications.
Configuration components have properties.
For example, the LDAP Connection Handler component has properties
such as listen-port and allow-start-tls.
You can set the component's listen-port property
to 389 to use the default LDAP port number.
You can set the component's allow-start-tls property
to true to permit LDAP client applications to use StartTLS.
Much of the configuration you do with dsconfig
involves setting component properties.