<?xml version="1.0" encoding="UTF-8"?>

<refentry xml:id='stop-ds-1'

xmlns='http://docbook.org/ns/docbook'

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:xinclude='http://www.w3.org/2001/XInclude'>

<info><copyright><year>2011-2012</year><holder>ForgeRock AS</holder></copyright></info>

<refmeta>

<refentrytitle>stop-ds</refentrytitle><manvolnum>1</manvolnum>

<refmiscinfo class="software">OpenDJ</refmiscinfo>

<refmiscinfo class="version"><?eval ${docTargetVersion}?></refmiscinfo>

</refmeta>

<refnamediv>

<refname>stop-ds</refname>

<refpurpose>stop OpenDJ directory server</refpurpose>

</refnamediv>

<refsynopsisdiv>

<cmdsynopsis>

<command>stop-ds</command>

<arg choice="opt">options</arg>

</cmdsynopsis>

</refsynopsisdiv>

<refsect1>

<title>Description</title>

<para>This utility can be used to request that the directory server stop

running or perform a restart.</para>

<para>When run without connection options, <command>stop-ds</command>

sends a signal to the OpenDJ process to stop the server. When run with

connection options, the <command>stop-ds</command> connects to the OpenDJ

administration port and creates a shutdown task to stop the server.</para>

</refsect1>

<refsect1>

<title>Options</title>

<para>The following options are supported.</para>

<variablelist>

<varlistentry>

<term><option>-r, --stopReason {stopReason}</option></term>

<listitem>

<para>Reason the server is being stopped or restarted.</para>

</listitem>

</varlistentry>

<varlistentry>

<term><option>-R, --restart</option></term>

<listitem>

<para>Attempt to automatically restart the server once it has

stopped.</para>

</listitem>

</varlistentry>

<varlistentry>

<term><option>-t, --stopTime {stopTime}</option></term>

<listitem>

<para>Indicates the date/time at which the shutdown operation will begin

as a server task expressed in format YYYYMMDDhhmmssZ for UTC time or

YYYYMMDDhhmmss for local time. A value of '0' will cause the shutdown to

be scheduled for immediate execution. When this option is specified the

operation will be scheduled to start at the specified time after which this

utility will exit immediately.</para>

</listitem>

</varlistentry>

<varlistentry>

<term><option>-Y, --proxyAs {authzID}</option></term>

<listitem>

<para>Use the proxied authorization control with the given authorization

ID.</para>

</listitem>

</varlistentry>

</variablelist>

<refsect2>

<title>LDAP Connection Options</title>

<variablelist>

<varlistentry>

<term><option>-D, --bindDN {bindDN}</option></term>

<listitem>

<para>DN to use to bind to the server</para>

</listitem>

</varlistentry>

<varlistentry>

<term><option>-h, --hostname {host}</option></term>

<listitem>

<para>Directory server hostname or IP address</para>

<para>Default value: 127.0.0.1</para>

</listitem>

</varlistentry>

<varlistentry>

<term><option>-j, --bindPasswordFile {bindPasswordFile}</option></term>

<listitem>

<para>Bind password file</para>

</listitem>

</varlistentry>

<varlistentry>

<term><option>-K, --keyStorePath {keyStorePath}</option></term>

<listitem>

<para>Certificate key store path</para>

</listitem>

</varlistentry>

<varlistentry>

<term><option>-N, --certNickname {nickname}</option></term>

<listitem>

<para>Nickname of certificate for SSL client authentication</para>

</listitem>

</varlistentry>

<varlistentry>

<term><option>-o, --saslOption {name=value}</option></term>

<listitem>

<para>SASL bind options</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>-P, --trustStorePath {trustStorePath}</option></term>

<listitem>

<para>Certificate trust store path</para>

</listitem>

</varlistentry>

<varlistentry>

<term><option>-T, --trustStorePassword {trustStorePassword}</option></term>

<listitem>

<para>Certificate trust store PIN</para>

</listitem>

</varlistentry>

<varlistentry>

<term><option>-u, --keyStorePasswordFile {keyStorePasswordFile}</option></term>

<listitem>

<para>Certificate key store PIN file</para>

</listitem>

</varlistentry>

<varlistentry>

<term><option>-U, --trustStorePasswordFile {path}</option></term>

<listitem>

<para>Certificate trust store PIN file</para>

</listitem>

</varlistentry>

<varlistentry>

<term><option>-w, --bindPassword {bindPassword}</option></term>

<listitem>

<para>Password to use to bind to the server</para>

<para>Use <option>-w -</option> to have the command prompt for the

password, rather than enter the password on the command line.</para>

</listitem>

</varlistentry>

<varlistentry>

<term><option>-W, --keyStorePassword {keyStorePassword}</option></term>

<listitem>

<para>Certificate key store PIN</para>

</listitem>

</varlistentry>

<varlistentry>

<term><option>-X, --trustAll</option></term>

<listitem>

<para>Trust all server SSL certificates</para>

</listitem>

</varlistentry>

</variablelist>

</refsect2>

<refsect2>

<title>Utility Input/Output Options</title>

<variablelist>

<varlistentry>

<term><option>--noPropertiesFile</option></term>

<listitem>

<para>No properties file will be used to get default command line

argument values</para>

</listitem>

</varlistentry>

<varlistentry>

<term><option>--propertiesFilePath {propertiesFilePath}</option></term>

<listitem>

<para>Path to the file containing default property values used for

command line arguments</para>

</listitem>

</varlistentry>

<varlistentry>

<term><option>-Q, --quiet</option></term>

<listitem>

<para>Use quiet mode</para>

</listitem>

</varlistentry>

</variablelist>

</refsect2>

<refsect2>

<title>General Options</title>

<variablelist>

<varlistentry>

<term><option>-V, --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 restarts OpenDJ directory server.</para>

<screen>$ stop-ds --restart

Stopping Server...

...The Directory Server has started successfully</screen>

</refsect1>

</refentry>