The uninstall command stops and removes a directory server instance.
The uninstall command can be used to stop and uninstall all or selected directory server components. The command connects to the server over SSL, via the administration connector port (described in Managing Administration Traffic to the Server in Sun OpenDS Standard Edition 2.0 Administration Guide) and can be run in one of three modes:
Graphical user interface (GUI) mode. GUI mode is the default and recommended installation option. The uninstall command provides an easy interface for removing your installation.
Interactive command-line mode. The command runs in interactive command-line mode when the --cli option is called.
Script-friendly mode. Script-friendly mode can be used in scripts where all appropriate values are provided in the form of command-line options. Use the --no-prompt and the --quiet options to suppress interactivity and output information, respectively.
Whether running in GUI mode or in command-line mode, uninstall lists the components that you can remove. If uninstall cannot remove all of the directory server files, it displays a message that lists any directories that are still present.
The uninstall command accepts an option in either its short form (for example, -Q) or its long form equivalent (for example, --quiet).
Remove all components.
Remove all backup files.
Remove configuration files.
Remove all database content.
Remove LDIF files.
Specify whether the uninstall tool should continue when an error occurs during processing. This option can only be used with --no-prompt.
Run the utility in interactive mode rather than in GUI mode. If this option is not used, it cannot accept other options.
Remove server libraries and administrative tools.
Remove all log files.
Specify the name of this host (or IP address) as it is referenced in remote servers for replication.
Specify the user ID of the global administrator to bind to the directory server.
Use the bind password in the specified file when authenticating to the directory server. This option must not be used in conjunction with --bindPassword.
Use the client keystore certificate in the specified path.
Use the certificate for SSL client authentication.
Use the specified options for SASL authentication.
Use the client trust store certificate in the specified path. This option is not needed if --trustAll is used, although a trust store should be used when working in a production environment.
Use the password needed to access the certificates in the client trust store. This option is only required if --trustStorePath is used and the specified trust store requires a password to access its contents (which most trust stores do not require). This option must not be used in conjunction with --trustStorePasswordFile.
Use the password in the specified file to access the certificates in the client keystore. This option is only required if --keyStorePath is used. This option must not be used in conjunction with --keyStorePassword.
Use the password in the specified file to access the certificates in the client trust store. This option is only required if --trustStorePath is used and the specified trust store requires a password to access its contents (most trust stores do not require this). This option must not be used in conjunction with --trustStorePassword.
Use the bind password when authenticating to the directory server. This password can be used for simple authentication as well as password-based SASL mechanisms. This option must not be used in conjunction with --rootUserPasswordFile. To prompt for the password, type -w -.
Use the password needed to access the certificates in the client keystore. This option is only required if --keyStorePath is used. This option must not be used in conjunction with --keyStorePasswordFile.
Trust any certificate that the server presents. This option can be used for testing purposes, but for security reasons, a trust store should be used to determine whether the client should accept the server certificate.
Run in non-interactive mode. If some data in the command is missing, you are not prompted and the uninstall will fail.
Indicate that the utility will not use a properties file to get the default command-line options.
Specify the path to the properties file that contains the default command-line options.
Run in quiet mode. No output will be generated unless a significant error occurs during the process.
Run in verbose mode, displaying diagnostics on standard output.
Display command-line usage information for the utility and exit without making any attempt to stop or restart the directory server.
Display the version information for the directory server and exit rather than attempting to run this command.
The following examples show how to use the directory server commands. You can use the commands on any UNIX, Linux, or Windows system that has at least the Java SE 5 (at least Sun version 1.5.0_08, preferably the latest version of Java SE 6) runtime environment installed on its target system.
The following command opens the Uninstaller GUI and prompts you to select the components that must be deleted:
The following command prompts you to indicate whether all components, or specific components, should be removed, and then runs the uninstall utility. If the directory server is running, you are prompted to stop the server before continuing.
$ uninstall --cli
The following command removes all directory server components. When prompted to confirm your request, accept the default to remove your directory server instance.
$ uninstall --cli -a
The following command removes the libraries (-l) on the directory server. Everything else is preserved. If the directory server is running, the command prompts you to stop the server.
$ uninstall --cli -l
Script-friendly mode enables you to create an uninstallation script with the uninstall utility. Script-friendly mode requires the --no-prompt (-n) and --quiet (-Q) options to be provided. If no option is present, the uninstall utility defaults to interactive mode.
The following command uninstalls all server components in script-friendly mode.
$ uninstall --cli -a -n -Q
An exit code of 0 indicates that the operation completed successfully. An exit code of 1 indicates that an error occurred during processing.
The directory server supports the use of a properties file that passes in any default option values used with the uninstall command. The properties file is convenient when working in different configuration environments, especially in scripted or embedded applications. For more information, see Using a Properties File With Directory Server Commands.
The following options can be stored in a properties file:
Entries in the properties file have the following format:
The uninstall utility writes a log file named opends-uninstallation-IDnumber, where IDnumber is a decimal number. The log files are located at these paths:
UNIX (Solaris): /var/tmp/
Windows: The %TEMP% folder. By default, this folder is C:\Documents and Settings\user\Local Settings\Temp.
The uninstall command is located at these paths:
UNIX and Linux: install-dir/uninstall