mirror of https://github.com/OpenIdentityPlatform/OpenDJ.git

Mark Craig
07.31.2015 b2568d582c2ab449bdaa514334a1d968ed0588bf
opendj-config/src/main/resources/com/forgerock/opendj/dsconfig/dsconfig.properties
@@ -442,26 +442,7 @@
 xlink:href="admin-guide#about-acis" \
 xlink:role="http://docbook.org/xlink/role/olink" \
 ><citetitle>About Access Control Instructions</citetitle></link>
REF_DSCFG_DURATION_SYNTAX_REL_URL_1002=<itemizedlist>                    \
 <para>                                                                  \
   Some property values take a time duration.                            \
   Durations are expressed as numbers followed by units.                 \
   For example <literal>1 s</literal> means one second,                  \
   and <literal>2 w</literal> means two weeks.                           \
   Some durations have minimum granularity or maximum units,             \
   so you cannot necessary specify every duration                        \
   in milliseconds or weeks for example.                                 \
   Some durations allow you to use a special value to mean unlimited.    \
   Units are specified as follows.                                       \
 </para>                                                                 \
                                                                         \
 <listitem><para><literal>ms</literal>: milliseconds</para></listitem>   \
 <listitem><para><literal>s</literal>: seconds</para></listitem>         \
 <listitem><para><literal>m</literal>: minutes</para></listitem>         \
 <listitem><para><literal>h</literal>: hours</para></listitem>           \
 <listitem><para><literal>d</literal>: days</para></listitem>            \
 <listitem><para><literal>w</literal>: weeks</para></listitem>           \
</itemizedlist>
REF_DSCFG_DURATION_SYNTAX_REL_URL_1002=<xinclude:include href="itemizedlist-duration.xml" />
REF_DSCFG_ARG_ADDITIONAL_INFO_1003=%s properties depend on the %s type, \
 which depends on the %s option.
REF_DSCFG_SUBTYPE_DEPENDENCIES_1004=%s properties depend on the %s type, \
@@ -504,243 +485,6 @@
REF_DSCFG_STRING_1038=A String
REF_DSCFG_UNKNOWN_1039=Unknown
REF_SHORT_DESC_DSCONFIG_1040=manage OpenDJ directory server configuration
REF_DSCFG_DOC_TOOL_DESCRIPTION_1041=<para>                                                 \
 The <command>dsconfig</command> command is the primary command-line tool                  \
 for viewing and editing OpenDJ configuration.                                             \
 When started without arguments,                                                           \
 <command>dsconfig</command> prompts you for administration connection information,        \
 including the host name, administration port number,                                      \
 administrator bind DN and administrator password.                                         \
 The <command>dsconfig</command> 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.  \
</para>                                                                                    \
                                                                                           \
<para>                                                                                     \
 When you pass connection information, subcommands, and additional options                 \
 to <command>dsconfig</command>,                                                           \
 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 <option>--no-prompt</option>                                          \
 and <option>--trustAll</option> options, respectively).                                   \
</para>                                                                                    \
                                                                                           \
<para>                                                                                     \
 You can prepare <command>dsconfig</command> batch scripts                                 \
 by running the tool with the <option>--commandFilePath</option> option                    \
 in interactive mode,                                                                      \
 then reading from the batch file with the <option>--batchFilePath</option> option         \
 in script mode.                                                                           \
 Batch files can be useful when you have many <command>dsconfig</command> commands to run  \
 and want to avoid starting the JVM and setting up a new connection for each command.      \
</para>                                                                                    \
                                                                                           \
<para>                                                                                     \
 The <command>dsconfig</command> command categorizes                                       \
 directory server configuration into <firstterm>components</firstterm>,                    \
 also called <firstterm>managed objects</firstterm>.                                       \
 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.                                                          \
</para>                                                                                    \
                                                                                           \
<para>                                                                                     \
 Configuration components have <firstterm>properties</firstterm>.                          \
 For example, the LDAP Connection Handler component has properties                         \
 such as <literal>listen-port</literal> and <literal>allow-start-tls</literal>.            \
 You can set the component's <literal>listen-port</literal> property                       \
 to <literal>389</literal> to use the default LDAP port number.                            \
 You can set the component's <literal>allow-start-tls</literal> property                   \
 to <literal>true</literal> to permit LDAP client applications to use StartTLS.            \
 Much of the configuration you do with <command>dsconfig</command>                         \
 involves setting component properties.                                                    \
</para>
REF_DSCFG_DOC_SUBCOMMANDS_DESCRIPTION_1042=<para>                                       \
  The <command>dsconfig</command> command provides many subcommands.                    \
 </para>                                                                                \
                                                                                        \
 <para>                                                                                 \
  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.                     \
 </para>                                                                                \
                                                                                        \
 <itemizedlist>                                                                         \
  <listitem><para>create-<replaceable>component</replaceable></para></listitem>         \
  <listitem><para>list-<replaceable>component</replaceable>s</para></listitem>          \
  <listitem><para>delete-<replaceable>component</replaceable></para></listitem>         \
  <listitem><para>get-<replaceable>component</replaceable>-prop</para></listitem>       \
  <listitem><para>set-<replaceable>component</replaceable>-prop</para></listitem>       \
 </itemizedlist>                                                                        \
                                                                                        \
 <para>                                                                                 \
  Here, <replaceable>component</replaceable> names are names of managed object types.   \
  Subcommand <replaceable>component</replaceable> 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.                          \
 </para>                                                                                \
                                                                                        \
 <itemizedlist>                                                                         \
  <para>                                                                                \
   For example, the Log Publisher component has these corresponding subcommands.        \
  </para>                                                                               \
                                                                                        \
  <listitem><para><command>create-log-publisher</command></para></listitem>             \
  <listitem><para><command>list-log-publishers</command></para></listitem>              \
  <listitem><para><command>delete-log-publisher</command></para></listitem>             \
  <listitem><para><command>get-log-publisher-prop</command></para></listitem>           \
  <listitem><para><command>set-log-publisher-prop</command></para></listitem>           \
 </itemizedlist>                                                                        \
                                                                                        \
 <para>                                                                                 \
  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 <command>list-log-publishers</command> subcommand.    \
 </para>                                                                                \
                                                                                        \
 <screen>                                                                         \n    \
$ <userinput>dsconfig \\                                                          \n    \
 list-log-publishers \\                                                           \n    \
 --hostname opendj.example.com \\                                                 \n    \
 --port 4444 \\                                                                   \n    \
 --bindDN "cn=Directory Manager" \\                                               \n    \
 --bindPassword password \\                                                       \n    \
 --trustAll</userinput>                                                           \n    \
<computeroutput>                                                                  \n    \
Log Publisher                 : Type                   : enabled                  \n    \
------------------------------:------------------------:--------                  \n    \
File-Based Access Logger      : file-based-access      : true                     \n    \
File-Based Audit Logger       : file-based-audit       : false                    \n    \
File-Based Debug Logger       : file-based-debug       : false                    \n    \
File-Based Error Logger       : file-based-error       : true                     \n    \
File-Based HTTP Access Logger : file-based-http-access : false                    \n    \
Replication Repair Logger     : file-based-error       : true</computeroutput>    \n    \
                                                                                  \n    \
$ <userinput>dsconfig \\                                                          \n    \
 get-log-publisher-prop \\                                                        \n    \
 --publisher-name "File-Based Access Logger" \\                                   \n    \
 --property rotation-policy \\                                                    \n    \
 --hostname opendj.example.com \\                                                 \n    \
 --port 4444 \\                                                                   \n    \
 --bindDN "cn=Directory Manager" \\                                               \n    \
 --bindPassword password \\                                                       \n    \
 --trustAll</userinput>                                                           \n    \
<computeroutput>Property        : Value(s)                                        \n    \
----------------:--------------------------------------------------------------   \n    \
rotation-policy : 24 Hours Time Limit Rotation Policy, Size Limit Rotation        \n    \
                : Policy</computeroutput>                                         \n    \
 </screen>                                                                              \
                                                                                        \
 <para>                                                                                 \
  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>--set</option> option,                                           \
  you assign multiple values to a multi-valued property                                 \
  by using the <option>--add</option> option.                                           \
  You can reset the values of the multi-valued property                                 \
  by using the <option>--reset</option> option.                                         \
 </para>                                                                                \
                                                                                        \
 <itemizedlist>                                                                         \
  <para>                                                                                \
  Some property values take a time duration.                                            \
  Durations are expressed as numbers followed by units.                                 \
  For example <literal>1 s</literal> means one second,                                  \
  and <literal>2 w</literal> means two weeks.                                           \
  Some durations have minimum granularity or maximum units,                             \
  so you cannot necessary specify every duration in milliseconds or weeks for example.  \
  Some durations allow you to use a special value to mean unlimited.                    \
  Units are specified as follows:                                                       \
 </para>                                                                                \
                                                                                        \
  <listitem><para><literal>ms</literal>: milliseconds</para></listitem>                 \
  <listitem><para><literal>s</literal>: seconds</para></listitem>                       \
  <listitem><para><literal>m</literal>: minutes</para></listitem>                       \
  <listitem><para><literal>h</literal>: hours</para></listitem>                         \
  <listitem><para><literal>d</literal>: days</para></listitem>                          \
  <listitem><para><literal>w</literal>: weeks</para></listitem>                         \
 </itemizedlist>                                                                        \
                                                                                        \
 <para>                                                                                 \
  Use the following options to view help for subcommands.                               \
 </para>                                                                                \
                                                                                        \
 <variablelist>                                                                         \
  <varlistentry>                                                                        \
   <term><command>dsconfig --help-all</command></term>                                  \
   <listitem>                                                                           \
    <para>                                                                              \
     Display all subcommands                                                            \
    </para>                                                                             \
   </listitem>                                                                          \
  </varlistentry>                                                                       \
  <varlistentry>                                                                        \
   <term><command>dsconfig --help-core-server</command></term>                          \
   <listitem>                                                                           \
    <para>                                                                              \
     Display subcommands relating to core server                                        \
    </para>                                                                             \
   </listitem>                                                                          \
  </varlistentry>                                                                       \
  <varlistentry>                                                                        \
   <term><command>dsconfig --help-database</command></term>                             \
   <listitem>                                                                           \
    <para>                                                                              \
     Display subcommands relating to caching and back-ends                              \
    </para>                                                                             \
   </listitem>                                                                          \
  </varlistentry>                                                                       \
  <varlistentry>                                                                        \
   <term><command>dsconfig --help-logging</command></term>                              \
   <listitem>                                                                           \
    <para>                                                                              \
     Display subcommands relating to logging                                            \
    </para>                                                                             \
   </listitem>                                                                          \
  </varlistentry>                                                                       \
  <varlistentry>                                                                        \
   <term><command>dsconfig --help-replication</command></term>                          \
   <listitem>                                                                           \
    <para>                                                                              \
     Display subcommands relating to replication                                        \
    </para>                                                                             \
   </listitem>                                                                          \
  </varlistentry>                                                                       \
  <varlistentry>                                                                        \
   <term><command>dsconfig --help-security</command></term>                             \
   <listitem>                                                                           \
    <para>                                                                              \
     Display subcommands relating to authentication and authorization                   \
    </para>                                                                             \
   </listitem>                                                                          \
  </varlistentry>                                                                       \
  <varlistentry>                                                                        \
   <term><command>dsconfig --help-user-management</command></term>                      \
   <listitem>                                                                           \
    <para>                                                                              \
     Display subcommands relating to user management                                    \
    </para>                                                                             \
   </listitem>                                                                          \
  </varlistentry>                                                                       \
 </variablelist>                                                                        \
                                                                                        \
 <para>                                                                                 \
  For help with individual subcommands,                                                 \
  either use <command>dsconfig <replaceable>subcommand</replaceable> --help</command>,  \
  or start <command>dsconfig</command> in interactive mode,                             \
  without specifying a subcommand.                                                      \
 </para>                                                                                \
                                                                                        \
 <para>                                                                                 \
  To view all component properties,                                                     \
  use the <command>dsconfig list-properties</command> command.                          \
 </para>
REF_DSCFG_DOC_TOOL_DESCRIPTION_1041=<xinclude:include href="description-dsconfig.xml" />
REF_DSCFG_DOC_SUBCOMMANDS_DESCRIPTION_1042=<xinclude:include href="description-dsconfig-subcommands.xml" />