<?xml version="1.0" encoding="UTF-8"?>
<!--
! CCPL HEADER START
!
! This work is licensed under the Creative Commons
! Attribution-NonCommercial-NoDerivs 3.0 Unported License.
! To view a copy of this license, visit
! or send a letter to Creative Commons, 444 Castro Street,
! Suite 900, Mountain View, California, 94041, USA.
!
! You can also obtain a copy of the license at
! See the License for the specific language governing permissions
! and limitations under the License.
!
! If applicable, add the following below this CCPL HEADER, with the fields
! enclosed by brackets "[]" replaced with your own identifying information:
! Portions Copyright [yyyy] [name of copyright owner]
!
! CCPL HEADER END
!
! Copyright 2011-2012 ForgeRock AS
! Portions Copyright 2013 Jens Elkner
!
-->
version="5.0" xml:lang="en"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://docbook.org/ns/docbook http://docbook.org/xml/5.0/xsd/docbook.xsd"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:xi="http://www.w3.org/2001/XInclude">
<refmeta>
<refentrytitle><application>dsframework</application></refentrytitle>
</refmeta>
<refnamediv>
<refname><application>dsframework</application></refname>
<refpurpose>manage OpenDJ administration framework</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>dsframework</command>
<arg choice="plain"><replaceable class="command">subcommand</replaceable></arg>
<arg>subcommand_opts</arg>
<sbr/><sbr/>
xpointer='xpointer(//para[@name="s-remote"]/*)'/>
<sbr/><sbr/>
xpointer='xpointer(//para[@name="s-auth"]/*)'/>
<sbr/><sbr/>
xpointer='xpointer(//para[@name="s-props"]/*)'/>
xpointer='xpointer(//para[@name="s-misc"]/*[@name="sc-verbose"])'/>
xpointer='xpointer(//para[@name="s-general"]/*)'/>
</cmdsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>
This utility can be used to perform operations in the directory server
administration framework.
</para>
<para>
This utility has no interactive mode. Consider using <option>-X</option> if you
authenticate over a secure connection protected with a self-signed certificate.
</para>
</refsection>
<refsection>
<title>Subcommands</title>
<refsection>
<cmdsynopsis>
<command>dsframework</command>
<group>
<arg choice="plain">--help-all</arg>
<arg choice="plain">--help-admin-user</arg>
<arg choice="plain">--help-server</arg>
<arg choice="plain">--help-server-group</arg>
</group>
</cmdsynopsis>
<para>
The <command>dsframework</command> command provides many subcommands. Use the
options above to view help related to all or admin-user, server or server group
subcommands, only.
</para>
<para>
For help with individual subcommands, use <command>dsframework</command>
<replaceable class="command">subcommand</replaceable> <option>--help</option>.
A listing of all subcommands and its specific options is shown below.
</para>
</refsection>
<!-- Generated - see man-dsconfig.xml for more info -->
<!-- End Of generated stuff -->
</refsection>
<refsection>
<title>Options</title>
<para>The following options are supported.</para>
<refsection>
<title>LDAP Connection Options</title>
<variablelist>
xpointer='xpointer(//para[@name="l-remote"]/*)'/>
xpointer='xpointer(//para[@name="l-auth"]/*)'/>
</variablelist>
</refsection>
<refsection>
<variablelist>
xpointer='xpointer(//para[@name="l-props"]/*)'/>
xpointer='xpointer(//para[@name="l-misc"]/*[@name="lc-verbose"])'/>
</variablelist>
</refsection>
<refsection>
<title>General Options</title>
xpointer='xpointer(//para[@name="l-general"]/*)'/>
</refsection>
</refsection>
<refsection>
<title>Examples</title>
<informalexample>
<para>
This example lists server properties.
</para>
<literallayout><prompt
-D "cn=Directory Manager" -w password -X list-server-properties</command></literallayout>
<screen>
Option Types:
r -- Property value(s) are readable
w -- Property value(s) are writable
m -- The property is mandatory
s -- The property is single-valued
Property Options Syntax Default
---------------------------------------------------------------------
ldapsport rw-- INTEGER -
certificate rw-s STRING -
hostname r-ms STRING localhost
ldapport rwm- INTEGER 389
jmxsEnabled rw-s BOOLEAN false
instancepath rw-s STRING -
ldapsEnabled rw-s BOOLEAN false
jmxsport rw-- INTEGER -
os rw-s STRING -
ds-cfg-key-id rw-s STRING -
jmxport rw-- INTEGER -
description rw-s STRING -
id rw-s STRING -
startTLSEnabled rw-s BOOLEAN false
jmxEnabled rw-s BOOLEAN false
ds-cfg-public-key-certificate rw-s CERTIFICATE_BINARY -
location rw-s STRING -
ldapEnabled rw-s BOOLEAN false
</screen>
</informalexample>
</refsection>
</refentry>