The following command-line utilities are available, which can be run in interactive, noninteractive, or script mode.

Command-Line Tool Description

backup

Run full or incremental backups on one or more PingDataMetrics Server backends. This utility also supports the use of a properties file to pass predefined command-line arguments. See Managing the tools.properties File for more information.

base64

Encode raw data using the base64 algorithm or decode base64-encoded data back to its raw representation.

collect-support-data

Collect and package system information useful in troubleshooting problems. The information is packaged as a .zip archive that can be sent to a technical support representative.

create-rc-script

Create an Run Control (RC) script that may be used to start, stop, and restart the server on UNIX-based systems.

config-diff

Generate a summary of the configuration changes in a local or remote server instance. The tool can be used to compare configuration settings when troubleshooting issues, or when verifying configuration settings on new servers.

dsconfig

View and edit the server configuration.

dsframework

Manage administrative server groups or the global administrative user accounts that are used to configure servers within server groups.

dsjavaproperties

Configure the Java virtual machine (JVM) arguments used to run the server and associated tools. Before launching the command, edit the properties file located in config/java.properties to specify the desired JVM options and JAVA_HOME environment variable.

ldapmodify

Perform LDAP modify, add, delete, and modify DN operations.

ldappasswordmodify

Perform LDAP password modify operations.

ldapsearch

Perform LDAP search operations.

ldif-diff

Compare the contents of two LDIF files, the output being an LDIF file needed to bring.

ldifmodify

Apply a set of modify, add, and delete operations against data in an LDIF file.

manage-extension

Install or update extension bundles. An extension bundle is a package of extension(s) that utilize the Server SDK to extend the functionality of the server. Extension bundles are installed from a .zip archive or file system directory. The server is restarted to activate the extension(s).

metric-engine-schema

Show current and required DBMS schema version information.

monitored-servers

Configure the set of servers to be monitored by this PingDataMetrics Server and prepare external servers for monitoring.

query-metric

Explore collected monitoring data by forming queries for data.

queryrate

Execute metric queries.

restore

Restore a backup of the server backend.

revert-update

Returns a server to the version before the last update was performed.

review-license

Review or accept the product license.

server-state

View information about the current state of the server process.

setup

Perform the initial setup for the server instance.

start-server

Start the server

status

Display basic server information.

stop-server

Stop or restart the server.

sum-file-sizes

Calculate the sum of the sizes for a set of files.

uninstall

Uninstall the server

update

Update the server to a newer version by downloading and unzipping the new server install package on the same host as the server to update. Use the update tool from the new server package to update the older version of the server. During the update process, the server is stopped if running, then the update is performed. A check is performed to determine if the newly updated server starts without major errors. If it cannot start cleanly, the update is backed out and the server is returned to its prior state. See the revert-update tool for information on reverting an update.