status — display basic OpenDJ server information

Synopsis

status {options}

Description

This utility can be used to display basic server information.

Options

The status command takes the following options:

Command options:

--offline

Indicates that the command must be run in offline mode.

Default: false

LDAP connection options:

--connectTimeout {timeout}

Maximum length of time (in milliseconds) that can be taken to establish a connection. Use '0' to specify no time out.

Default: 30000

-D | --bindDn {bindDN}

DN to use to bind to the server.

Default: uid=admin

-E | --reportAuthzId

Use the authorization identity control.

Default: false

-h | --hostname {host}

Fully-qualified server host name or IP address.

Default: localhost.localdomain

-N | --certNickname {nickname}

Nickname of the certificate that should be sent to the server for SSL client authentication.

-o | --saslOption {name=value}

SASL bind options.

-p | --port {port}

Directory server administration port number.

-T | --trustStorePassword {trustStorePassword}

Truststore cleartext password.

--useJavaKeyStore {keyStorePath}

JKS keystore containing the certificate which should be used for SSL client authentication.

--useJavaTrustStore {trustStorePath}

Use a JKS truststore file for validating server certificate.

--useJceKeyStore {keyStorePath}

JCEKS keystore containing the certificate which should be used for SSL client authentication.

--useJceTrustStore {trustStorePath}

Use a JCEKS truststore file for validating server certificate.

--useJvmTrustStore

Use the a JVM truststore for validating server certificate.

Default: false

--usePasswordPolicyControl

Use the password policy request control.

Default: false

--usePkcs11KeyStore

PKCS#11 keystore containing the certificate which should be used for SSL client authentication.

Default: false

--usePkcs12KeyStore {keyStorePath}

PKCS#12 keystore containing the certificate which should be used for SSL client authentication.

--usePkcs12TrustStore {trustStorePath}

Use a PKCS#12 truststore file for validating server certificate.

-w | --bindPassword {bindPassword}

Password to use to bind to the server. Omit this option while providing the bind DN to ensure that the command prompts for the password, rather than entering the password as a command argument.

-W | --keyStorePassword {keyStorePassword}

Keystore cleartext password.

-X | --trustAll

Trust all server SSL certificates.

Default: false

Utility input/output options:

-n | --no-prompt

Use non-interactive mode. If data in the command is missing, the user is not prompted and the tool will fail.

Default: false

--noPropertiesFile

No properties file will be used to get default command line argument values.

Default: false

--propertiesFilePath {propertiesFilePath}

Path to the file containing default property values used for command line arguments.

-r | --refresh {period}

When this argument is specified, the status command will display its contents periodically. Used to specify the period (in seconds) between two displays of the status.

-s | --script-friendly

Use script-friendly mode.

Default: false

General options:

-V | --version

Display Directory Server version information.

Default: false

-H | --help

Display this usage information.

Default: false

Exit Codes

0

The command completed successfully.

> 0

An error occurred.

Examples

The following command displays the status of a running directory server:

$ status \
 --hostname opendj.example.com \
 --port 4444 \
 --bindDn uid=admin \
 --bindPassword password \
 --trustAll
>>>> General details

Version                        : ForgeRock Directory Services 7.0.2
Installation and instance path : /path/to/opendj
Run status                     : Started
Host name                      : <fqdn>
Administration port (LDAPS)    : 4444
Open connections               : 1


>>>> Running server Java details

Java version       : <version>
Java vendor        : <vendor>
JVM available CPUs : <cores>
JVM max heap size  : <size>


>>>> Connection handlers

Name  : Port : Protocol : Security  : Status   : Load m1 rate : Load m5 rate
------:------:----------:-----------:----------:--------------:-------------
HTTP  : 8080 : HTTP     : Unsecured : Enabled  : 0.0          : 0.0
HTTPS : 8443 : HTTP     : SSL       : Enabled  : 0.0          : 0.0
LDAP  : 1389 : LDAP     : Unsecured : Enabled  : 0.0          : 0.0
LDAPS : 1636 : LDAP     : SSL       : Enabled  : 0.0          : 0.0
LDIF  : -    : LDIF     : -         : Disabled : -            : -
SNMP  : 161  : SNMP     : -         : Disabled : -            : -


>>>> Local backends

Base DN              : Entries : Replication : Backend     : Type                           : Status
---------------------:---------:-------------:-------------:--------------------------------:--------
uid=Monitor          : 1       : -           : monitorUser : LDIF                           : Enabled
uid=admin            : 1       : -           : rootUser    : LDIF                           : Enabled
dc=example,dc=com    : 180     : -           : userData    : DB (<size> active cache size)  : Enabled


>>>> Disk space

Disk space : State  : Free space
-----------:--------:-----------
/          : normal : <size>
Read a different version of :