collect-support-data

Description

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.

Information collected may include configuration files, server monitor entries, portions of log files, JVM thread stack dumps, system metrics, and other data that may be helpful in diagnosing problems, understanding server performance, or otherwise assisting with support requests. Although the tool will do its best to obscure or omit sensitive data, and the entire archive may be encrypted if you desire, you may wish to review the resulting support data archive to ensure verify its contents. Further, the archive will include a summary of any potential problems or concerns that are identified in the course of collecting the support data.

Examples

collect-support-data --bindDN uid=admin,dc=example,dc=com \
     --bindPasswordFile admin-pw.txt

collect-support-data --useRemoteServer --hostname ds.example.com --port 636 \
     --useSSL --trustStorePath config/truststore \
     --bindDN uid=admin,dc=example,dc=com --bindPasswordFile admin-pw.txt \
     --collectExpensiveData --collectReplicationStateDump \
     --securityLevel maximum --logDuration "10 minutes" --encrypt \
     --passphraseFile encryption-passphrase.txt --generatePassphrase \
     --outputPath csd.zip

collect-support-data \
     --decrypt support-data-ds-inst1-20200615195607.672Z-zip-encrypted \
     --passphraseFile encryption-passphrase.txt

Arguments

-V
--version

-H
--help

--help-ldap

--help-sasl

--help-debug

-h {host}
--hostname {host}

-p {port}
--port {port}

-D {dn}
--bindDN {dn}

-w {password}
--bindPassword {password}

-j {path}
--bindPasswordFile {path}

--promptForBindPassword

-Z
--useSSL

-q
--useStartTLS

-X
--trustAll

-K {path}
--keyStorePath {path}

-W {password}
--keyStorePassword {password}

-u {path}
--keyStorePasswordFile {path}

--promptForKeyStorePassword

--keyStoreFormat {format}

-P {path}
--trustStorePath {path}

-T {password}
--trustStorePassword {password}

-U {path}
--trustStorePasswordFile {path}

--promptForTrustStorePassword

--trustStoreFormat {format}

-N {nickname}
--certNickname {nickname}

--enableSSLDebugging

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

--useSASLExternal

--helpSASL

--outputPath {path}

--encrypt

--passphraseFile {path}

--generatePassphrase

--decrypt {path}

--collectExpensiveData

--collectReplicationStateDump

--includeBinaryFiles

--archiveExtensionSource

--sequential

--securityLevel {none|obscure-secrets|maximum}

--jstackCount {count}

--reportCount {count}

--reportIntervalSeconds {seconds}

--logTimeRange {startTime[,endTime]}

--logDuration {duration}

--pid {pid}

--comment {value}

--useRemoteServer

--useAdministrativeSession

--proxyToServerAddress {address}

--proxyToServerPort {port}

--noLDAP

-n
--noPrompt

--dryRun

--interactive

--propertiesFilePath {path}

--generatePropertiesFile {path}

--noPropertiesFile

--suppressPropertiesFileComment