<?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
!
-->
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>status</application></refentrytitle>
</refmeta>
<refnamediv>
<refname><application>status</application></refname>
<refpurpose>display basic OpenDJ server information</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>status</command>
<arg>-n</arg>
<arg>-r <replaceable class="parameter">seconds</replaceable></arg>
<sbr/><sbr/>
xpointer='xpointer(//para[@name="s-remote"]/*[@name="sc-contimeout"])'/>
<sbr/><sbr/>
xpointer='xpointer(//para[@name="s-auth"]/*)'/>
<sbr/><sbr/>
xpointer='xpointer(//para[@name="s-props"]/*)'/>
xpointer='xpointer(//para[@name="s-misc"]/*[@name="sc-script"])'/>
xpointer='xpointer(//para[@name="s-general"]/*)'/>
</cmdsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>
This utility can be used to display basic server information.
</para>
</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"]/*[@name="lc-contimeout"])'/>
xpointer='xpointer(//para[@name="l-auth"]/*)'/>
</variablelist>
</refsection>
<refsection>
<variablelist>
<varlistentry>
<term><option>-n, --no-prompt</option></term>
<listitem>
<para>
Use non-interactive mode. If data in the command is missing, the user is not
prompted and the tool will fail.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-r, --refresh</option> <replaceable
class="parameter">period</replaceable></term>
<listitem>
<para>
When this argument is specified, the status command will display its contents
periodically. Used to specify the period (in seconds) between two status displays.
</para>
</listitem>
</varlistentry>
xpointer='xpointer(//para[@name="l-props"]/*)'/>
xpointer='xpointer(//para[@name="l-misc"]/*[@name="lc-script"])'/>
</variablelist>
</refsection>
<refsection>
<title>General Options</title>
<variablelist>
xpointer='xpointer(//para[@name="l-general"]/*)'/>
</variablelist>
</refsection>
</refsection>
<refsection>
<title>Examples</title>
<informalexample>
<literallayout><prompt
>$ </prompt><command>status -D "cn=Directory Manager" -w password</command></literallayout>
<screen>
--- Server Status ---
Server Run Status: Started
Open Connections: 1
--- Server Details ---
Host Name: localhost.localdomain
Administrative Users: cn=Directory Manager
Installation Path: $OpenDJ
Version: OpenDJ @VERS_FULL@
Java Version: 1.6.0_29
Administration Connector: Port 4444 (LDAPS)
--- Connection Handlers ---
Address:Port : Protocol : State
-------------:-------------:---------
-- : LDIF : Disabled
8989 : Replication : Enabled
0.0.0.0:161 : SNMP : Disabled
0.0.0.0:636 : LDAPS : Disabled
0.0.0.0:1389 : LDAP : Enabled
0.0.0.0:1689 : JMX : Disabled
--- Data Sources ---
Base DN: dc=example,dc=com
Backend ID: userRoot
Entries: 160
Replication: Enabled
Missing Changes: 0
Age of Oldest Missing Change: <not available>
Base DN: dc=myCompany,dc=com
Backend ID: myCompanyRoot
Entries: 3
Replication: Disabled
Base DN: o=myOrg
Backend ID: myOrgRoot
Entries: 3
Replication: Disabled
</screen>
</informalexample>
</refsection>
</refentry>