| Skip Navigation Links | |
| Exit Print View | |
|
Oracle Fusion Middleware Command-Line Usage Guide for Oracle Unified Directory 11g Release 1 (11.1.1) |
| Skip Navigation Links | |
| Exit Print View | |
|
|
Oracle Fusion Middleware Command-Line Usage Guide for Oracle Unified Directory 11g Release 1 (11.1.1) |
1. Server Administration Commands
Code Generated by the create-rc-script Command
Oracle Directory Server Enterprise Edition LDAP Connection Options
Oracle Unified Directory LDAP Connection Options
Replication Gateway Configuration Options
Oracle Directory Server Enterprise Edition Server Options
Replication Gateway Security Options
Oracle Unified Directory Server Options
Removing a Replication Gateway Server
Oracle Unified Directory Server Connection Options
Oracle Directory Server Enterprise Edition Server Connection Options
The uninstall command is used to uninstall the server instance. It is applicable for directory servers, proxy servers, and replication gateway servers. The command removes the server instance, and not the software.
uninstall [options]
The uninstall command is used to uninstall a server instance. It can be run in one of the following modes:
Graphical user interface (GUI) mode. GUI mode is the default and recommended uninstallation option. The uninstall GUI provides an easy interface for removing instance files.
Command-line interface (CLI) mode. The command-line mode is either interactive or non-interactive. The interactive CLI mode prompts you for any required information before the uninstallation begins, and is used with the --cli option, or if no GUI is available.
The non-interactive CLI mode enables you to uninstall the instance files without user intervention. 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 instance files, it displays a message that lists any directories that are still present.
Depending on the type of server installed, you are presented with different uninstall options. These are broadly categorized into the following:
Note - For any instance (directory server, proxy, or replication gateway) type that you decide to remove, the uninstall procedure also stops the server. In addition, for a server instance that is part of a replication topology, the uninstall procedure removes the server that is under deletion from that topology. On a Windows platform, if the instance was installed as a windows service, the windows service is unregistered.
This section describes the options to remove a directory server instance.
The uninstall command accepts an option in either its short form (for example, -i) or its long form equivalent (for example, --cli).
Use the command line install. If not specified the graphical interface will be launched. The rest of the options (excluding help and version) will only be taken into account if this option is specified.
Remove all components of the server (this option is not compatible with the rest of the remove options).
Remove server libraries and administrative tools.
Remove all database content.
Remove all log files.
Remove configuration files.
Remove all backup files.
Remove LDIF files.
Specifies whether the uninstall should continue if there is an error updating references to this server in remote server instances or not. This argument can only be used with the --no-prompt argument.
Specify the user ID of the global administrator to bind to the server.
Use the bind password when authenticating to the 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 bind password in the specified file when authenticating to the directory server. This option must not be used in conjunction with --bindPassword.
Use the specified options for SASL authentication.
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.
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 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 client keystore certificate in the specified path.
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.
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 certificate for SSL client authentication.
Maximum length of time that can be taken to establish a connect in milliseconds. Use 0 to specify no timeout. The default value is 30000.
Specify the name of this host (or IP address) as it is referenced in remote servers for replication.
This section describes the options to remove a proxy server instance.
The uninstall command accepts an option in either its short form (for example, -i) or its long form equivalent (for example, --cli).
Use the command line install. If not specified the graphical interface will be launched. The rest of the options (excluding help and version) will only be taken into account if this option is specified.
Remove all components of the server (this option is not compatible with the rest of the remove options).
Remove server libraries and administrative tools.
Remove all log files.
Remove configuration files.
Remove all backup files.
Remove LDIF files.
Specifies whether the uninstall should continue if there is an error updating references to this server in remote server instances or not. This argument can only be used with the --no-prompt argument.
Specify the user ID of the global administrator to bind to the server.
Use the bind password when authenticating to the 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 bind password in the specified file when authenticating to the directory server. This option must not be used in conjunction with --bindPassword.
Use the specified options for SASL authentication.
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.
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 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 client keystore certificate in the specified path.
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.
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 certificate for SSL client authentication.
Maximum length of time that can be taken to establish a connect in milliseconds. Use 0 to specify no timeout. The default value is 30000.
Specify the name of this host (or IP address) as it is referenced in remote servers for replication.
This section describes the options for removing an instance of the replication gateway server.
The uninstall command accepts an option in either its short form (for example, -i) or its long form equivalent (for example, --cli).
Use the command line install. If not specified the graphical interface will be launched. The rest of the options (excluding help and version) will only be taken into account if this option is specified.
Specifies whether the uninstall should continue if there is an error updating references to this server in remote server instances or not. This argument can only be used with the --no-prompt argument.
The fully-qualified name of the host where the replication gateway is installed. This name must be the one provided during the setup of the replication gateway.
User ID of the Global Administrator to use to bind to the Oracle Unified Directory server. If no Global Administrator was defined previously in the new generation server, then provide a Bind DN. The default value is admin.
Password of the Global Administrator (or of the bind DN) to use to bind to the Oracle Unified Directory server.
File containing the password of the Global Administrator (or of the bind DN) to use to bind to the Oracle Unified Directory server.
Specifies the DN that is used to bind theOracle Directory Server Enterprise Edition server whose contents whose contents are replicated through the replication gateway. The default value is cn=Directory Manager.
Specifies the password that is used to bind theOracle Directory Server Enterprise Edition server whose contents whose contents are replicated through the replication gateway.
Specifies the file that stores the password that is used to bind theOracle Directory Server Enterprise Edition server whose contents are replicated through the replication gateway.
These are SASL bind options.
SASL is not supported for Oracle Unified Directory proxy.
Trust all server SSL certificates that the server presents. This option can be used for convenience and testing purposes, but for security reasons a trust store should be used to determine whether the client should accept the server certificate.
Use the 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 trust store. This option is only required if --trustStorePath is used and the specified trust store requires a password in order 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 trust store. This option is only required if --trustStorePath is used and the specified trust store requires a password in order to access its contents (most trust stores do not require this). This option must not be used in conjunction with --trustStorePassword.
Use the keystore certificate in the specified path.
Use the password needed to access the certificates in the keystore. This option is only required if --keyStorePath is used. This option must not be used in conjunction with --keyStorePasswordFile.
Use the password in the specified file to access the certificates in the keystore. This option is only required if --keyStorePath is used. This option must not be used in conjunction with --keyStorePassword.
Use the specified certificate for SSL client authentication.
Specifies the maximum length of time (in milliseconds) that can be taken to establish a connection. Use 0to specify no time out. The default value is 30000.
Run setup in non-interactive mode. If some data in the command is missing, the user will not be prompted and the command will fail.
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.
Indicate that the command 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.
Display command-line usage information for the command and exit without making any attempt to stop or restart the 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 server commands.
Example 1-46 Uninstalling by Using the Graphical Uninstaller
The following command opens the Uninstaller GUI and prompts you to select the components that must be deleted:
$ uninstall
Example 1-47 Uninstalling by Using the Command Line
The following command prompts you to indicate whether all components, or specific components, should be removed, and then runs the uninstall command. If the server is running, you are prompted to stop the server before continuing.
$ uninstall --cli
Example 1-48 Uninstalling in Non-Interactive CLI Mode
This mode enables you to create an uninstallation script with the uninstall command. It requires the --no-prompt (-n) and --quiet (-Q) options to be provided. If no option is present, the uninstall command defaults to interactive mode. Both, -n and -Q options work in the CLI mode only.
The following command uninstalls all instance components in non-interactive CLI mode.
$ uninstall --cli -a -n -Q
The following exit codes are applicable for a directory server and a proxy server:
Successful.
User cancelled the operation.
User provided invalid data.
Error accessing file system (reading/writing).
Error during the configuration of the Directory Server.
Error starting the Oracle Unified Directory server.
Error stopping the Oracle Unified Directory server.
Error disabling the Windows service.
Application specific error.
Error invoking an Oracle Unified Directory tool.
Bug.
Java version non-compatible.
User provided invalid input.
Print Version.
Print Usage.
Return code for errors that are non-specified.
The following exit codes are applicable for a gateway server:
Successful uninstall.
Unexpected error (potential bug).
Cannot parse arguments or data provided by user is not valid.
The user canceled the uninstall.
Incompatible Java version.
Error initializing the replication gateway configuration (loading the admin framework classes, and so on).
Error stopping the replication gateway.
Error unconfiguring windows service.
Error input limit.
Error updating ADS Contents.
An error with the configuration of the legacy server. The base DN specified in the replica configuration is not a valid DN.
One of the specified legacy (Oracle Directory Server Enterprise Edition) servers is not compatible.
One of the specified new generation (Oracle Unified Directory based) servers is not compatible.
The user does not accept the certificate.
The user does not want to continue because there were issues loading the configuration of some servers.
An error with the configuration of the replication gateway.
The user overcame the maximum number of tries in interactive mode.
The user aborted the uninstall.
Error accessing file system (for instance deleting installation files).
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 Server Commands.
The following options can be stored in a properties file:
adminUID
bindPassword
bindPasswordFile
certNickname
hostname
keyStorePassword
keyStorePasswordFile
keyStorePath
saslOption
SASL is not supported for Oracle Unified Directory.
trustAll
trustStorePassword
trustStorePasswordFile
trustStorePath
Entries in the properties file have the following format:
toolname.propertyname=propertyvalue
For example:
uninstall.bindPassword=password
The uninstall command writes a log file named oud-uninstall-IDnumber, where IDnumber is a decimal number. The log files are located at these paths:
UNIX (Solaris): /var/tmp/
Linux: /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: instance-dir/OUD/uninstall
Windows: instance-dir\OUD\uninstall.bat
|