Metrics Engine Documentation Index

Available Tools

Documentation is available for the following command-line tools:

backup Back up one or more Metrics Engine backends
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
config-diff Compares Metrics Engine configurations and produces a dsconfig batch file needed to bring the source inline with the target
create-rc-script Create an RC script that may be used to start, stop, and restart the Metrics Engine on UNIX-based systems
dsconfig View and edit the Metrics Engine configuration
dsframework Manage administrative server groups or the global administrative user accounts that are used to configure servers within server groups
dsjavaproperties Configure the JVM options used to run the Metrics Engine and associated tools
ldapmodify Perform LDAP modify, add, delete, and modify DN operations in the Metrics Engine
ldappasswordmodify Perform LDAP password modify operations in the Metrics Engine
ldapsearch Perform LDAP search operations in the Metrics Engine
ldif-diff Compare the contents of two LDIF files, the output being an LDIF file needed to bring the source file in sync with the target
ldifmodify Apply a set of modify, add, and delete operations to data in an LDIF file
list-backends List the backends and base DNs configured in the Metrics Engine
manage-extension Install or update UnboundID Metrics Engine extension bundles
metric-engine-schema Show current and required UnboundID Metrics Engine DBMS schema version information. Can compare current schema to different versions to display the schema changes, and can update the schema from one version to another
monitored-servers Configure the set of servers to be monitored by this Metrics Engine and prepare external servers for monitoring
query-metric Explore collected monitoring data by forming queries for charts and data
restore Restore a backup of a Metrics Engine backend
revert-update This tool returns a server to the version before the last update was performed. Unlike the 'update' tool, this tool operates on the local instance from which it is invoked. This tool relies on files from the 'history' directory that are created during an update to restore the server to a prior state. It should be noted that this tool does not revert database files to prior states. Therefore, any changes made to the directory data between the time of the update and time of reversion will be lost.
review-license Review and/or indicate your acceptance of the product license
server-state View information about the current state of the Metrics Engine process
start-metrics-engine Start the Metrics Engine
status Display basic server information
stop-metrics-engine Stop or restart the server
sum-file-sizes Calculate the sum of the sizes for a set of files
summarize-config View a summary of the Metrics Engine configuration
uninstall Uninstall the Metrics Engine.
validate-file-signature For best results, file signatures should be validated by the same instance used to generate the file. However, it may be possible to validate signatures generated on other instances in a replicated topology