Metrics Engine Documentation Index
Command-Line Tool Reference Home

status

Description
Examples
Arguments

Description

Display basic server information.

This tool prints information about the server, such as version, connection handlers, and data sources. Some information may not be available if the server is not running, or if authentication credentials are missing or do not have sufficient privileges, or if the invoking user does not have sufficient file system access rights.

Examples

Display current status information about the server, showing no more than the last five alert notifications:
status --bindDN uid=admin,dc=example,dc=com --bindPassword password \
     --maxAlerts 5

For examples and help with LDAP options see LDAP Option Help. For help with SASL authentication, see SASL Option Help

Arguments

-V
--version

Description Display Metrics Engine version information

-H
--help

Description Display general usage information

--help-ldap

Description Display help for using LDAP options

--help-sasl

Description Display help for using SASL options

--help-debug

Description Display help for using debug options
Advanced Yes

-n
--no-prompt

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

-Z
--useSSL

Description Use SSL for secure communication with the server

-q
--useStartTLS

Description Use StartTLS to secure communication with the server

--useNoSecurity

Description Use no security when communicating with the server

-h {host}
--hostname {host}

Description Fully qualified host name or IP address of the local Metrics Engine
Default Value localhost
Required No
Multi-Valued No

-p {port}
--port {port}

Description Metrics Engine port number
Default Value 389
Required No
Multi-Valued No

-D {bindDN}
--bindDN {bindDN}

Description DN used to bind to the server
Default Value cn=Directory Manager
Required No
Multi-Valued No

-w {bindPassword}
--bindPassword {bindPassword}

Description Password used to bind to the server
Required No
Multi-Valued No

-j {bindPasswordFile}
--bindPasswordFile {bindPasswordFile}

Description Bind password file
Required No
Multi-Valued No

-o {name=value}
--saslOption {name=value}

Description SASL bind options
Required No
Multi-Valued Yes

-X
--trustAll

Description Trust all server SSL certificates

-P {trustStorePath}
--trustStorePath {trustStorePath}

Description Certificate trust store path
Required No
Multi-Valued No

-K {keyStorePath}
--keyStorePath {keyStorePath}

Description Certificate key store path
Required No
Multi-Valued No

-W {keyStorePassword}
--keyStorePassword {keyStorePassword}

Description Certificate key store PIN
Required No
Multi-Valued No

-u {keyStorePasswordFile}
--keyStorePasswordFile {keyStorePasswordFile}

Description Certificate key store PIN file
Required No
Multi-Valued No

-N {nickname}
--certNickname {nickname}

Description Nickname of the certificate for SSL client authentication
Required No
Multi-Valued No

--propertiesFilePath {propertiesFilePath}

Description Path to the file that contains default property values used for command-line arguments
Required No
Multi-Valued No

--noPropertiesFile

Description Specify that no properties file will be used to get default command-line argument values

--script-friendly

Description Use script-friendly mode

-F
--fullVersion

Description Display extended Metrics Engine version information

--summary

Description Print a subset of available information

--allServers

Description Display status for all servers in this server's administrative domain

--maxAlerts {count}

Description The maximum number of alert notifications to display
Lower Bound 0
Default Value 15
Required Yes
Multi-Valued No

--severity {severity}

Description Specifies the lowest severity for alerts displayed in the Administrative Alerts table. Must be one of [info,warning,error,fatal]
Allowed Values info
warning
error
fatal
Default Value info
Required No
Multi-Valued No