| Exit Print View | |
Sun OpenDS Standard Edition 2.0 Command-Line Usage Guide |
|
|
|
The status command displays basic directory server status information.
status [options]
The status command can be used to display basic directory server information, such as the status of the server (started or stopped), the configured connection handlers, or the list of defined back ends and suffixes.
If the directory server is started, the status command connects to the server over SSL, via the administration connector.
For more information, see Managing Administration Traffic to the Server in Sun OpenDS Standard Edition 2.0 Administration Guide.
If the directory server is stopped, you must run this command as a user with file system access rights to read the configuration files (particularly the config.ldif file).
Note - Certain monitoring data can only be displayed when the directory server is running (for example, the number of entries in a back end).
The status command contacts the directory server over SSL via the administration connector. These connection options are used to contact the directory server.
Use the bind DN to authenticate to the directory 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.
Contact the directory server on the specified hostname or IP address. If this option is not provided, a default of localhost is used.
Use the bind password in the specified file when authenticating to the directory server. This option must not be used in conjunction with --bindPassword.
Use the client keystore certificate in the specified path.
Use the specified certificate for client authentication.
Use the specified options for SASL authentication.
Contact the directory server at the specified administration port. If this option is not provided, a default administration port of 4444 is used.
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.
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.
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.
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.
Use the bind password when authenticating to the directory 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 -.
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.
Trust all server SSL certificates that the directory 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.
Use non-interactive mode. If some data in the command is missing, you are not prompted and the command will fail.
Indicate that the command should not use a properties file to get the default command-line options.
Specify the path to the properties file that contains the default command-line options.
Run in “script friendly” mode. Script friendly mode will not prompt you for any information but requires that all values be provided through command-line options.
Display command-line usage information for the command and exit without making any attempt to stop or restart the directory server.
Display the version information for the directory server and exit rather than attempting to run this command.
The following examples show how to use the directory server commands. You can use the commands on any UNIX, Linux, or Windows system that has at least the Java SE 5 (at least Sun version 1.5.0_08, preferably the latest version of Java SE 6) runtime environment installed on its target system.
For more information, see Directory Server System Requirements in Sun OpenDS Standard Edition 2.0 Installation Guide.
An exit code of 0 indicates that the operation completed successfully. A nonzero exit code indicates that an error occurred during processing.
The directory server supports the use of a properties file that passes in any default option values used with the status 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 Directory Server Commands.
The following options can be stored in a properties file:
bindDN
bindPassword
bindPasswordFile
certNickname
hostname
keyStorePassword
keyStorePasswordFile
keyStorePath
port
saslOption
trustAll
trustStorePassword
trustStorePasswordFile
trustStorePath
Entries in the properties file have the following format:
toolname.propertyname=propertyvalue
For example:
status.bindPassword=password
UNIX and Linux: install-dir/bin/status
Windows: install-dir\bat\status.bat
|
|