6330N/A<?xml version="1.0" encoding="UTF-8"?>
6330N/A<!--
6330N/A ! CCPL HEADER START
6330N/A !
6330N/A ! This work is licensed under the Creative Commons
6330N/A ! Attribution-NonCommercial-NoDerivs 3.0 Unported License.
6330N/A ! To view a copy of this license, visit
6330N/A ! http://creativecommons.org/licenses/by-nc-nd/3.0/
6330N/A ! or send a letter to Creative Commons, 444 Castro Street,
6330N/A ! Suite 900, Mountain View, California, 94041, USA.
6330N/A !
6330N/A ! You can also obtain a copy of the license at
6330N/A ! trunk/opendj3/legal-notices/CC-BY-NC-ND.txt.
6330N/A ! See the License for the specific language governing permissions
6330N/A ! and limitations under the License.
6330N/A !
6330N/A ! If applicable, add the following below this CCPL HEADER, with the fields
6330N/A ! enclosed by brackets "[]" replaced with your own identifying information:
6330N/A ! Portions Copyright [yyyy] [name of copyright owner]
6330N/A !
6330N/A ! CCPL HEADER END
6330N/A !
6330N/A ! Copyright 2011-2012 ForgeRock AS
6330N/A ! Portions Copyright 2013 Jens Elkner
6330N/A !
6330N/A-->
6330N/A<refentry xml:id="dsframework-1" xmlns="http://docbook.org/ns/docbook"
6330N/A version="5.0" xml:lang="en"
6330N/A xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
6330N/A xsi:schemaLocation="http://docbook.org/ns/docbook http://docbook.org/xml/5.0/xsd/docbook.xsd"
6330N/A xmlns:xlink="http://www.w3.org/1999/xlink"
6330N/A xmlns:xi="http://www.w3.org/2001/XInclude">
6330N/A <xi:include href="common.xml" xpointer='xpointer(//info[@name="info"])'/>
6330N/A <refmeta>
6330N/A <refentrytitle><application>dsframework</application></refentrytitle>
6330N/A <xi:include href="common.xml" xpointer='xpointer(//manvolnum[@name="v1m"])'/>
6330N/A </refmeta>
6330N/A <refnamediv>
6330N/A <refname><application>dsframework</application></refname>
6330N/A <refpurpose>manage OpenDJ administration framework</refpurpose>
6330N/A </refnamediv>
6330N/A <refsynopsisdiv>
6330N/A <cmdsynopsis>
6330N/A <command>dsframework</command>
6330N/A <arg choice="plain"><replaceable class="command">subcommand</replaceable></arg>
6330N/A <arg>subcommand_opts</arg>
6330N/A <sbr/><sbr/>
6330N/A <xi:include href="common.xml"
6330N/A xpointer='xpointer(//para[@name="s-remote"]/*)'/>
6330N/A <sbr/><sbr/>
6330N/A <xi:include href="common.xml"
6330N/A xpointer='xpointer(//para[@name="s-auth"]/*)'/>
6330N/A <sbr/><sbr/>
6330N/A <xi:include href="common.xml"
6330N/A xpointer='xpointer(//para[@name="s-props"]/*)'/>
6330N/A <xi:include href="common.xml"
6330N/A xpointer='xpointer(//para[@name="s-misc"]/*[@name="sc-verbose"])'/>
6330N/A <xi:include href="common.xml"
6330N/A xpointer='xpointer(//para[@name="s-general"]/*)'/>
6330N/A </cmdsynopsis>
6330N/A </refsynopsisdiv>
6330N/A <refsection>
6330N/A <title>Description</title>
6330N/A <para>
6330N/AThis utility can be used to perform operations in the directory server
6330N/Aadministration framework.
6330N/A </para>
6330N/A <para>
6330N/AThis utility has no interactive mode. Consider using <option>-X</option> if you
6330N/Aauthenticate over a secure connection protected with a self-signed certificate.
6330N/A </para>
6330N/A </refsection>
6330N/A <refsection>
6330N/A <title>Subcommands</title>
6330N/A <refsection>
6330N/A <cmdsynopsis>
6330N/A <command>dsframework</command>
6330N/A <group>
6330N/A <arg choice="plain">--help-all</arg>
6330N/A <arg choice="plain">--help-admin-user</arg>
6330N/A <arg choice="plain">--help-server</arg>
6330N/A <arg choice="plain">--help-server-group</arg>
6330N/A </group>
6330N/A </cmdsynopsis>
6330N/A <para>
6330N/AThe <command>dsframework</command> command provides many subcommands. Use the
6330N/Aoptions above to view help related to all or admin-user, server or server group
6330N/Asubcommands, only.
6330N/A </para>
6330N/A <para>
6330N/AFor help with individual subcommands, use <command>dsframework</command>
6330N/A<replaceable class="command">subcommand</replaceable> <option>--help</option>.
6330N/AA listing of all subcommands and its specific options is shown below.
6330N/A </para>
6330N/A </refsection>
6330N/A<!-- Generated - see man-dsconfig.xml for more info -->
6330N/A <xi:include href='scmd-dsframework.xml' xpointer='xpointer(//refsection)'/>
6330N/A<!-- End Of generated stuff -->
6330N/A </refsection>
6330N/A <refsection>
6330N/A <title>Options</title>
6330N/A <para>The following options are supported.</para>
6330N/A <refsection>
6330N/A <title>LDAP Connection Options</title>
6330N/A <variablelist>
6330N/A <xi:include href="common.xml"
6330N/A xpointer='xpointer(//para[@name="l-remote"]/*)'/>
6330N/A <xi:include href="common.xml"
6330N/A xpointer='xpointer(//para[@name="l-auth"]/*)'/>
6330N/A </variablelist>
6330N/A </refsection>
6330N/A <refsection>
6330N/A <title>Utility Input/Output Options</title>
6330N/A <variablelist>
6330N/A <xi:include href="common.xml"
6330N/A xpointer='xpointer(//para[@name="l-props"]/*)'/>
6330N/A <xi:include href="common.xml"
6330N/A xpointer='xpointer(//para[@name="l-misc"]/*[@name="lc-verbose"])'/>
6330N/A </variablelist>
6330N/A </refsection>
6330N/A <refsection>
6330N/A <title>General Options</title>
6330N/A <xi:include href="common.xml"
6330N/A xpointer='xpointer(//para[@name="l-general"]/*)'/>
6330N/A </refsection>
6330N/A </refsection>
6330N/A <refsection>
6330N/A <title>Examples</title>
6330N/A <informalexample>
6330N/A <para>
6330N/AThis example lists server properties.
6330N/A </para>
6330N/A <literallayout><prompt
6330N/A>$ </prompt><command>dsframework -p 4444 -h opendj.example.com \
6330N/A -D "cn=Directory Manager" -w password -X list-server-properties</command></literallayout>
6330N/A <screen>
6330N/AOption Types:
6330N/A
6330N/A r -- Property value(s) are readable
6330N/A w -- Property value(s) are writable
6330N/A m -- The property is mandatory
6330N/A s -- The property is single-valued
6330N/A
6330N/AProperty Options Syntax Default
6330N/A---------------------------------------------------------------------
6330N/Aldapsport rw-- INTEGER -
6330N/Acertificate rw-s STRING -
6330N/Ahostname r-ms STRING localhost
6330N/Aldapport rwm- INTEGER 389
6330N/AjmxsEnabled rw-s BOOLEAN false
6330N/Ainstancepath rw-s STRING -
6330N/AldapsEnabled rw-s BOOLEAN false
6330N/Ajmxsport rw-- INTEGER -
6330N/Aos rw-s STRING -
6330N/Ads-cfg-key-id rw-s STRING -
6330N/Ajmxport rw-- INTEGER -
6330N/Adescription rw-s STRING -
6330N/Aid rw-s STRING -
6330N/AstartTLSEnabled rw-s BOOLEAN false
6330N/AjmxEnabled rw-s BOOLEAN false
6330N/Ads-cfg-public-key-certificate rw-s CERTIFICATE_BINARY -
6330N/Alocation rw-s STRING -
6330N/AldapEnabled rw-s BOOLEAN false
6330N/A</screen>
6330N/A </informalexample>
6330N/A </refsection>
6330N/A <xi:include href="common.xml" xpointer='xpointer(//refsection[@name="env"])'/>
6330N/A <xi:include href="common.xml" xpointer='xpointer(//refsection[@name="exit-0-gt0"])'/>
6330N/A <xi:include href="common.xml" xpointer='xpointer(//refsection[@name="seeAlso"])'/>
6330N/A</refentry>