Synchronization Server Documentation Index
Command-Line Tool Reference Home

collect-support-data

Description
Examples
Arguments

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.

Examples

Collects data about the server installed in the same server root from which the tool is invoked:
collect-support-data --bindDN uid=admin,dc=example,dc=com \
     --bindPassword password

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 Synchronization Server 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

-h {host}
--hostname {host}

Description Address on which the local Synchronization Server is listening
Default Value localhost
Required No
Multi-Valued No

-p {port}
--port {port}

Description Synchronization Server port number
Lower Bound 1
Upper Bound 65535
Default Value 389
Required No
Multi-Valued No

-D {bindDN}
--bindDN {bindDN}

Description DN used to bind to the server
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

-Z
--useSSL

Description Use SSL for secure communication with the server

-q
--useStartTLS

Description Use StartTLS to secure communication with the server

-X
--trustAll

Description Trust all server SSL certificates

-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

-P {trustStorePath}
--trustStorePath {trustStorePath}

Description Certificate trust store path
Required No
Multi-Valued No

-T {trustStorePassword}
--trustStorePassword {trustStorePassword}

Description Certificate trust store PIN
Required No
Multi-Valued No

-U {path}
--trustStorePasswordFile {path}

Description Certificate trust 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

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

Description SASL bind options
Required No
Multi-Valued Yes

--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

--noLdap

Description Specify that no effort should be made to collect any information over LDAP. This option should be used only as a last resort if the server is completely unresponsive or will not start

--pid {pid}

Description Specify the ID of an additional process from which information is to be collected. This option is useful for troubleshooting external server tools
Required No
Multi-Valued Yes

--sequential

Description Collect data sequentially as opposed to in parallel. This has the effect of reducing the initial memory footprint of this tool at a cost of taking longer to complete. Use this option if running this tool results in 'out of memory' errors

--reportCount {count}

Description Number of reports generated for commands that support sampling (for example, mpstat). A value of 0 (zero) indicates that no reports will be generated for these commands. If not specified, this option is 10 by default
Lower Bound 0
Required No
Multi-Valued No

--reportInterval {interval}

Description Number of seconds between reports for commands that support sampling (for example, mpstat). This option must have a value greater than 0 (zero). If not specified this option is 1 by default
Lower Bound 1
Required No
Multi-Valued No

--maxJstacks {number}

Description Number of jstack samples to collect. If not specified, this option is 10 by default
Lower Bound 0
Required No
Multi-Valued No

--collectExpensiveData

Description Collect data from expensive or long running processes. These processes are not executed by default because they may impact a running server

--comment {comment}

Description Specify additional information about the collected data set. This comment will be added to the generated archive as a README file
Required No
Multi-Valued No

--includeBinaryFiles

Description Specify that binary files should be included in the archive collection

-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