0N/A<?
xml version="1.0" encoding="UTF-8"?>
0N/A ! This work is licensed under the Creative Commons 0N/A ! Attribution-NonCommercial-NoDerivs 3.0 Unported License. 2362N/A ! To view a copy of this license, visit 2362N/A ! or send a letter to Creative Commons, 444 Castro Street, 0N/A ! Suite 900, Mountain View, California, 94041, USA. 0N/A ! You can also obtain a copy of the license at 0N/A ! See the License for the specific language governing permissions 0N/A ! and limitations under the License. 0N/A ! If applicable, add the following below this CCPL HEADER, with the fields 0N/A ! enclosed by brackets "[]" replaced with your own identifying information: 0N/A ! Portions Copyright [yyyy] [name of copyright owner] 2362N/A ! Copyright 2011-2014 ForgeRock AS 0N/A<
refentry xml:
id='stop-ds-1' 0N/A version='5.0' xml:
lang='en' 0N/A <
info><
copyright><
year>2011-2014</
year><
holder>ForgeRock AS</
holder></
copyright></
info>
0N/A <
refentrytitle>stop-ds</
refentrytitle><
manvolnum>1</
manvolnum>
0N/A <
refmiscinfo class="software">OpenDJ</
refmiscinfo>
0N/A <
refmiscinfo class="version"><?
eval ${
docTargetVersion}?></
refmiscinfo>
0N/A <
refname>stop-ds</
refname>
0N/A <
refpurpose>stop OpenDJ directory server</
refpurpose>
0N/A <
command>stop-ds</
command>
0N/A <
arg choice="opt">options</
arg>
0N/A <
title>Description</
title>
0N/A <
para>This utility can be used to request that the directory server stop
0N/A running or perform a restart.</
para>
0N/A <
para>When run without connection options, <
command>stop-ds</
command>
0N/A sends a signal to the OpenDJ process to stop the server. When run with
0N/A connection options, the <
command>stop-ds</
command> connects to the OpenDJ
0N/A administration port and creates a shutdown task to stop the server.</
para>
0N/A <
title>Options</
title>
0N/A <
para>The following options are supported.</
para>
0N/A <
term><
option>-r, --stopReason {stopReason}</
option></
term>
0N/A <
para>Reason the server is being stopped or restarted.</
para>
0N/A <
term><
option>-R, --restart</
option></
term>
0N/A <
para>Attempt to automatically restart the server once it has
0N/A <
term><
option>-t, --stopTime {stopTime}</
option></
term>
0N/A <
para>Indicates the
date/
time at which the shutdown operation will begin
0N/A as a server task expressed in format YYYYMMDDhhmmssZ for UTC time or
0N/A YYYYMMDDhhmmss for local time. A value of '0' will cause the shutdown to
0N/A be scheduled for immediate execution. When this option is specified the
0N/A operation will be scheduled to start at the specified time after which this
0N/A utility will exit immediately.</
para>
0N/A <
term><
option>-Y, --proxyAs {authzID}</
option></
term>
0N/A <
para>Use the proxied authorization control with the given authorization
0N/A <
title>LDAP Connection Options</
title>
0N/A <
term><
option>-D, --bindDN {bindDN}</
option></
term>
0N/A <
para>DN to use to bind to the server</
para>
0N/A <
term><
option>-h, --hostname {host}</
option></
term>
0N/A <
para>Directory server hostname or IP address</
para>
0N/A <
para>Default value: 127.0.0.1</
para>
0N/A <
term><
option>-j, --bindPasswordFile {bindPasswordFile}</
option></
term>
0N/A <
para>Bind password file</
para>
0N/A <
term><
option>-K, --keyStorePath {keyStorePath}</
option></
term>
0N/A <
para>Certificate key store path</
para>
0N/A <
term><
option>-N, --certNickname {nickname}</
option></
term>
0N/A <
para>Nickname of certificate for SSL client authentication</
para>
0N/A <
term><
option>-o, --saslOption {name=value}</
option></
term>
0N/A <
para>SASL bind options</
para>
0N/A <
term><
option>-p, --port {port}</
option></
term>
0N/A <
para>Directory server administration port number</
para>
0N/A <
para>Default value: 4444</
para>
0N/A <
term><
option>-P, --trustStorePath {trustStorePath}</
option></
term>
0N/A <
para>Certificate trust store path</
para>
0N/A <
term><
option>-T, --trustStorePassword {trustStorePassword}</
option></
term>
0N/A <
para>Certificate trust store PIN</
para>
0N/A <
term><
option>-u, --keyStorePasswordFile {keyStorePasswordFile}</
option></
term>
0N/A <
para>Certificate key store PIN file</
para>
0N/A <
term><
option>-U, --trustStorePasswordFile {path}</
option></
term>
0N/A <
para>Certificate trust store PIN file</
para>
0N/A <
term><
option>-w, --bindPassword {bindPassword}</
option></
term>
0N/A <
para>Password to use to bind to the server</
para>
0N/A <
para>Use <
option>-w -</
option> to have the command prompt for the
0N/A password, rather than enter the password on the command line.</
para>
0N/A <
term><
option>-W, --keyStorePassword {keyStorePassword}</
option></
term>
0N/A <
para>Certificate key store PIN</
para>
0N/A <
term><
option>-X, --trustAll</
option></
term>
0N/A <
para>Trust all server SSL certificates</
para>
0N/A <
term><
option>--noPropertiesFile</
option></
term>
0N/A <
para>No properties file will be used to get default command line
<
term><
option>--propertiesFilePath {propertiesFilePath}</
option></
term>
<
para>Path to the file containing default property values used for
command line arguments</
para>
<
term><
option>-Q, --quiet</
option></
term>
<
para>Use quiet mode</
para>
<
title>General Options</
title>
<
term><
option>-V, --version</
option></
term>
<
para>Display version information</
para>
<
term><
option>-?, -H, --help</
option></
term>
<
para>Display usage information</
para>
<
title>Exit Codes</
title>
<
para>The command completed successfully.</
para>
<
para>An error occurred.</
para>
<
para>The following example restarts OpenDJ directory server.</
para>
$ <
userinput>stop-ds --restart</
userinput>
<
computeroutput>Stopping Server...
...The Directory Server has started successfully</
computeroutput>