man-control-panel.xml revision 62da52c144e8d6ba69f611c45deeeb4f985ea24c
2N/A<?xml version="1.0" encoding="UTF-8"?>
2N/A<!--
2N/A ! CCPL HEADER START
2N/A !
2N/A ! This work is licensed under the Creative Commons
2N/A ! Attribution-NonCommercial-NoDerivs 3.0 Unported License.
2N/A ! To view a copy of this license, visit
2N/A ! http://creativecommons.org/licenses/by-nc-nd/3.0/
2N/A ! or send a letter to Creative Commons, 444 Castro Street,
2N/A ! Suite 900, Mountain View, California, 94041, USA.
2N/A !
2N/A ! You can also obtain a copy of the license at
2N/A ! trunk/opendj3/legal-notices/CC-BY-NC-ND.txt.
2N/A ! See the License for the specific language governing permissions
2N/A ! and limitations under the License.
2N/A !
2N/A ! If applicable, add the following below this CCPL HEADER, with the fields
2N/A ! enclosed by brackets "[]" replaced with your own identifying information:
2N/A ! Portions Copyright [yyyy] [name of copyright owner]
2N/A !
2N/A ! CCPL HEADER END
2N/A !
2N/A ! Copyright 2011-2012 ForgeRock AS
2N/A !
2N/A-->
2N/A<refentry xml:id='control-panel-1'
2N/A xmlns='http://docbook.org/ns/docbook'
2N/A version='5.0' xml:lang='en'
2N/A xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
2N/A xsi:schemaLocation='http://docbook.org/ns/docbook http://docbook.org/xml/5.0/xsd/docbook.xsd'
2N/A xmlns:xlink='http://www.w3.org/1999/xlink'
2N/A xmlns:xinclude='http://www.w3.org/2001/XInclude'>
2N/A <info><copyright><year>2011-2012</year><holder>ForgeRock AS</holder></copyright></info>
2N/A <refmeta>
2N/A <refentrytitle>control-panel</refentrytitle><manvolnum>1</manvolnum>
2N/A <refmiscinfo class="software">OpenDJ</refmiscinfo>
2N/A <refmiscinfo class="version"><?eval ${docTargetVersion}?></refmiscinfo>
2N/A </refmeta>
2N/A <refnamediv>
2N/A <refname>control-panel</refname>
2N/A <refpurpose>start the OpenDJ graphical admin interface</refpurpose>
2N/A </refnamediv>
2N/A <refsynopsisdiv>
2N/A <cmdsynopsis>
2N/A <command>control-panel</command>
2N/A <arg choice="req">options</arg>
2N/A </cmdsynopsis>
2N/A </refsynopsisdiv>
2N/A <refsect1>
2N/A <title>Description</title>
2N/A <para>This utility can be used to display the Control Panel window which
2N/A displays basic server information and allows to do some basic administration
2N/A tasks on the server.</para>
2N/A </refsect1>
2N/A <refsect1>
2N/A <title>Options</title>
2N/A <para>The following options are supported.</para>
2N/A <variablelist>
2N/A <varlistentry>
2N/A <term><option>-r, --remote</option></term>
2N/A <listitem>
2N/A <para>Connect to a remote server</para>
2N/A </listitem>
2N/A </varlistentry>
2N/A </variablelist>
2N/A <refsect2>
2N/A <title>LDAP Connection Options</title>
2N/A <variablelist>
2N/A <varlistentry>
2N/A <term><option>--connectTimeout {timeout}</option></term>
2N/A <listitem>
2N/A <para>Maximum length of time (in milliseconds) that can be taken to
2N/A establish a connection. Use '0' to specify no time out.</para>
2N/A <para>Default value: 30000</para>
2N/A </listitem>
2N/A </varlistentry>
2N/A <varlistentry>
<term><option>-D, --bindDN {bindDN}</option></term>
<listitem>
<para>DN to use to bind to the server</para>
<para>Default value: cn=Directory Manager</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-h, --hostname {host}</option></term>
<listitem>
<para>Directory server hostname or IP address</para>
<para>Default value: localhost.localdomain</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-j, --adminPasswordFile {bindPasswordFile}</option></term>
<listitem>
<para>Global administrator password file</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-p, --port {port}</option></term>
<listitem>
<para>Directory server administration port number</para>
<para>Default value: 4444</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-w, --adminPassword {bindPassword}</option></term>
<listitem>
<para>Password for the global administrator</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-X, --trustAll</option></term>
<listitem>
<para>Trust all server SSL certificates</para>
</listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2>
<title>General Options</title>
<variablelist>
<varlistentry>
<term><option>--version</option></term>
<listitem>
<para>Display version information</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-?, -H, --help</option></term>
<listitem>
<para>Display usage information</para>
</listitem>
</varlistentry>
</variablelist>
</refsect2>
</refsect1>
<refsect1>
<title>Exit Codes</title>
<variablelist>
<varlistentry>
<term>0</term>
<listitem>
<para>The command completed successfully.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>&gt; 0</term>
<listitem>
<para>An error occurred.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>Examples</title>
<para>The following example starts the Control Panel on a remote host.</para>
<screen>$ control-panel -r -h opendj.example.com -p 4444 &amp;</screen>
</refsect1>
</refentry>