JavaScript is required to for searching.
Skip Navigation Links
Exit Print View
Oracle Fusion Middleware Command-Line Usage Guide for Oracle Unified Directory 11g Release 1 (11.1.1)
search filter icon
search icon

Document Information

Preface

1.  Server Administration Commands

create-rc-script

Synopsis

Description

Options

General Options

Examples

Code Generated by the create-rc-script Command

Exit Codes

Location

Related Commands

dsconfig

Synopsis

Description

Help Subcommands

General Subcommands

Core Server Subcommands

Database Subcommands

Logging Subcommands

Replication Subcommands

Security Subcommands

User Management Subcommands

Options

LDAP Connection Options

Command Input/Output Options

General Options

Examples

Exit Codes

Using a Properties File

Location

Related Commands

dsreplication

Synopsis

Description

Server Subcommands

Options

Configuration Options

LDAP Connection Options

Command Input/Output Options

General Options

Examples

Exit Codes

Using a Properties File

Location

Related Commands

ds2oud

Synopsis

Description

Options

Oracle Directory Server Enterprise Edition LDAP Connection Options

Oracle Unified Directory LDAP Connection Options

Command Input/Output Options

General Options

Examples

Exit Codes

Location

Related Commands

dps2oud

Synopsis

Description

Options

LDAP Connection Options

General Options

Examples

Exit Codes

Location

Related Commands

gicadm

Synopsis

Description

Options

LDAP Connection Options

Command Input/Output Options

General Options

Examples

Exit Codes

Location

Related Commands

manage-tasks

Synopsis

Description

Options

LDAP Connection Options

Command Input/Output Options

General Options

Examples

Exit Codes

Using a Properties File

Location

Related Commands

oud-replication-gateway-setup

Synopsis

Description

Options

Replication Gateway Configuration Options

Oracle Directory Server Enterprise Edition Server Options

Replication Gateway Security Options

Oracle Unified Directory Server Options

Secure Connection Options

Command Input/Output Options

General Options

Examples

Exit Codes

Using a Properties File

Log Files

Location

Related Commands

oud-setup

Synopsis

Description

Options

Command Input/Output Options

General Options

Examples

Exit Codes

Using a Properties File

Log Files

Location

Related Commands

oud-proxy-setup

Synopsis

Description

Options

Command Input/Output Options

General Options

Examples

Exit Codes

Log Files

Location

Related Commands

start-ds

Synopsis

Description

Options

Command Input/Output Options

General Options

Examples

Exit Codes

Location

Related Commands

status

Synopsis

Description

LDAP Connection Options

Command Input/Output Options

General Options

Examples

Exit Codes

Using a Properties File

Location

stop-ds

Synopsis

Description

Options

LDAP Connection Options

Command Input/Output Options

General Options

Examples

Exit Codes

Using a Properties File

Location

Related Commands

uninstall

Synopsis

Description

Removing a Directory Server

Options

LDAP Connection Options

Removing a Proxy Server

Options

LDAP Connection Options

Removing a Replication Gateway Server

Options

Gateway Connection Options

Oracle Unified Directory Server Connection Options

Oracle Directory Server Enterprise Edition Server Connection Options

Secure Connection Options

Command Input/Output Options

General Options

Examples

Exit Codes

Using a Properties File

Log Files

Location

Related Commands

windows-service

Synopsis

Description

Command Options

General Options

Examples

Exit Codes

Location

Related Commands

2.  Data Administration Commands

3.  LDAP Client Commands

4.  Other Commands

5.  General Command-Line Usage Information

stop-ds

The stop-ds command stops a server instance.

Synopsis

stop-ds [options]

Description

The stop-ds command is used to stop or restart the server. It can operate on either a local or remote server instance.

The ability to perform a local stop of the server is currently only available on UNIX based systems. When run locally, stop-ds sends a kill signal to the server process. This method of stopping the server is used if stop-ds is run without any options and if a PID file (install-dir/logs/server.pid) exists.

The remote shutdown mechanism issues an LDAP request to create a task entry in the server. The command can be run from any system that can communicate with the server (local or remote). It can also be used to restart the server. In this case, the server does an “in-core” restart, which reinitializes itself without shutting down the JVM.

When it is run remotely, stop-ds communicates with the server over SSL, through the administration connector. For more information, see Managing Administration Traffic to the Server in Oracle Fusion Middleware Administration Guide for Oracle Unified Directory.

Options

The stop-ds command accepts an option in either its short form (for example, -D bindDN) or its long form equivalent (for example, --bindDN bindDN).

-r,--stopReason reason

Provide a human-readable reason for the shutdown. If a reason is provided, it appears in the server's error log, and is provided to shut down plug-ins and shut down listeners.

-R,--restart

Restart the server rather than shutting it down. If the --restart option is used along with authentication options, the server will reinitialize itself without shutting down the JVM. Because the JVM is not stopped, any configuration changes that require a JVM restart will not take effect. If the --restart option is used without authenticating, the server will first stop, then start. A new process will replace the original server.

-t,--stopTime time

Indicates the date and time at which the shutdown operation begins as a server task, expressed in the format YYYYMMDDhhmmss. A value of 0 causes the shutdown to be scheduled for immediate execution. When this option is used, the operation is scheduled to start at the specified time, after which this command exits immediately.

-Y,--proxyAs authzID

Use authorization control during the shutdown request. The value provided for this option should be an authorization ID, which can be in the form dn: followed by a user DN or u: followed by a user name. Clients will use the proxy authorization v2 control as described in RFC 4370.

LDAP Connection Options

The stop-ds command contacts the server over SSL through the administration connector (described in Managing Administration Traffic to the Server in Oracle Fusion Middleware Administration Guide for Oracle Unified Directory). These connection options are used to contact the server.

-D, --bindDN bindDN

Use the bind DN to authenticate to the server. This option is used when performing simple authentication and is not required if SASL authentication is to be used. The default value for this option is cn=Directory Manager.

-h, --hostname hostname

Contact the server on the specified hostname or IP address. If this option is not provided, a default of localhost is used.

-j, --bindPasswordFile filename

Use the bind password in the specified file when authenticating to the server. This option must not be used in conjunction with --bindPassword.

-K, --keyStorePath path

Use the client keystore certificate in the specified path.

-N, --certNickname nickname

Use the specified certificate for client authentication.

-o, --saslOption name=value

Use the specified options for SASL authentication.

SASL is not supported for Oracle Unified Directory proxy.

-p, --port port

Contact the server at the specified administration port. If this option is not provided, a default administration port of 4444 is used.

-P, --trustStorePath path

Use the client trust store certificate in the specified path. This option is not needed if --trustAll is used, although a trust store should be used when working in a production environment.

-T, --trustStorePassword password

Use the password needed to access the certificates in the client trust store. This option is only required if --trustStorePath is used and the specified trust store requires a password in order to access its contents (which most trust stores do not require). This option must not be used in conjunction with --trustStorePasswordFile.

-u, --keyStorePasswordFile filename

Use the password in the specified file to access the certificates in the client keystore. This option is only required if --keyStorePath is used. This option must not be used in conjunction with --keyStorePassword.

-U, --trustStorePasswordFile filename

Use the password in the specified file to access the certificates in the client trust store. This option is only required if --trustStorePath is used and the specified trust store requires a password in order to access its contents (most trust stores do not require this). This option must not be used in conjunction with --trustStorePassword.

-w, --bindPassword password

Use the bind password when authenticating to the server. This option can be used for simple authentication as well as password-based SASL mechanisms. This option must not be used in conjunction with --bindPasswordFile. To prompt for the password, type -w -.

SASL is not supported for Oracle Unified Directory proxy.

-W, --keyStorePassword password

Use the password needed to access the certificates in the client keystore. This option is only required if --keyStorePath is used. This option must not be used in conjunction with --keyStorePasswordFile.

-X, --trustAll

Trust all server SSL certificates that the server presents. This option can be used for convenience and testing purposes, but for security reasons a trust store should be used to determine whether the client should accept the server certificate.

Command Input/Output Options

--noPropertiesFile

Indicate that a properties file will not be used to get the default command-line options.

--propertiesFilePath path

Specify the path to the properties file that contains the default command-line options.

-Q, --quiet

Run in quiet mode. No output will be generated unless a significant error occurs during the process.

General Options

-?, -H, --help

Display command-line usage information for the command and exit without making any attempt to stop or restart the server.

--version

Display the version information for the server and exit rather than attempting to run this command.

Examples

The following examples show how to use the server commands.

For more information, see System Requirements and Certification in Oracle Fusion Middleware Installation Guide for Oracle Unified Directory.

Example 1-43 Stopping a Server Locally

The following command stops the server:

$ stop-ds

Example 1-44 Stopping a Server Remotely

The following command stops a remote server instance.

$ stop-ds -h remotehost -p 4444 -D "cn=directory manager" -w password -X

Example 1-45 Restarting a Server Remotely

The following command restarts a remote server instance.

$ stop-ds -R -h remotehost -p 4444 -D "cn=directory manager" -w password -X

Exit Codes

Exit Code
Description
0
Server stopped successfully.
98
Server already stopped.
99
Server must be started.
100
Server must be stopped using a system call.
101
Server must be restarted using a system call.
102
Server must be stopped using a protocol.
103
Server must be stopped as a Windows service.
104
Server must be restarted as a Windows service.

Using a Properties File

The server supports the use of a properties file that passes in any default option values used with the stop-ds command. The properties file is convenient when working in different configuration environments, especially in scripted or embedded applications.

For more information, see Using a Properties File With Server Commands.

The following options can be stored in a properties file:

Entries in the properties file have the following format:

toolname.propertyname=propertyvalue

For example:

stop-ds.trustAll=yes

Location

Related Commands

start-ds