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 oud-proxy-setup command manages Oracle Unified Directory proxy setup.
This command is supported only for the proxy.
oud-proxy-setup [options]
The oud-proxy-setup command installs and configures a directory server instance, including specifying the ports on which it will listen, the DN and password for the initial root user, the base DN for the directory data, authentication methods, as well load balancing, distribution, and a global index catalog, depending on the deployment chosen.
The oud-proxy-setup can only be launched once. It can be run in one of the following modes:
Graphical user interface (GUI) mode. GUI mode is the default and recommended installation option. The setup GUI provides an easy interface for defining and deploying your Oracle Unified Directory proxy.
The utility launches the graphical installer and creates the Oracle Unified Directory instance in OUD-base-location/instance-dir. The default instance directory name is asinst_1, with subsequent instances on the same server named asinst_2, asinst_3, and so on.
Command-line interface (CLI) mode. The command-line setup defines the proxy port, host name, and security configuration. If you specify the --cli option with oud-proxy-setup then you must provide the required values in the command line, else the default values are used. If you do not provide any value for a parameter that has no default value then the setup fails, and an error message is displayed.
The utility launches the command-line installer and creates the Oracle Unified Directory instance in OUD-base-location/instance-dir. The default instance directory name is asinst_1, with subsequent instances on the same server named asinst_2, asinst_3, and so on.
The proxy setup CLI mode prompts the user to accept the license. Use the --no-prompt option to automatically accept the license.
The oud-proxy-setup 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.
Port on which the Directory Server should listen for LDAP communication. The default value is 389.
Port on which the Administration Connector should listen for communication. The default value is 4444.
Skip the check to determine whether the specified ports are usable.
DN for the initial root user for the Directory Server.
Password for the initial root user for the Directory Server.
Path to a file containing the password for the initial root user for the Directory Server.
Enable StartTLS to allow secure communication with the server using the LDAP port.
Port on which the Directory Server should listen for LDAP SSL (LDAPS) communication. The LDAPS port will be configured and SSL will be enabled only if this argument is explicitly specified. The default value is 636.
Generate a self-signed certificate that the server should use when accepting SSL-based connections or performing StartTLS negotiation.
Path of a PKCS#11 key store containing the certificate that the server should use when accepting SSL-based connections or performing StartTLS negotiation.
Path of a Java Key Store (JKS) containing a certificate to be used as the server certificate.
Path of a JCEKS containing a certificate to be used as the server certificate.
Path of a PKCS#12 key store containing the certificate that the server should use when accepting SSL-based connections or performing StartTLS negotiation.
Certificate key store PIN. A PIN is required when you specify to use an existing certificate (JKS, JCEKS, PKCS#12, or PKCS#11) as server certificate.
Certificate key store PIN file. A PIN is required when you specify to use an existing certificate (JKS, JCEKS, PKCS#12, or PKCS#11) as server certificate.
Nickname of the certificate that the server should use when accepting SSL-based connections or performing StartTLS negotiation.
Do not start the server when the configuration is completed.
Run in quiet mode. No output will be generated unless a significant error occurs during the process.
Use verbose mode
Specify the path to the properties file that contains the default command-line options.
Indicate that a properties file will not be used to get the default command-line options.
Perform an installation in non-interactive mode, for license acceptance only. If some data in the command is missing the user will not be prompted and the command will fail.
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 oud-proxy-setup command.
See System Requirements and Certification in Oracle Fusion Middleware Installation Guide for Oracle Unified Directory for more information.
Example 1-38 Running oud-proxy-setup in GUI Mode
The following command runs an installation in GUI mode:
$ oud-proxy-setup
The utility launches the graphical installer and creates the Oracle Unified Directory instance in OUD-base-location/instance-dir. The default instance directory name is asinst_1, with subsequent instances on the same server named asinst_2, asinst_3, and so on. To specify a different instance name, set the INSTANCE_NAME environment variable before you run the setup, for example:
$ export INSTANCE_NAME=my-oud-proxy-instance
Example 1-39 Running oud-proxy-setup in Non-Interactive CLI Mode
The non-interactive CLI mode enables you to create installation scripts with the setup command when many proxy server instances must be configured for large replicated environments. This mode requires the --no-prompt and --quiet options to be provided. If no option is present, the setup command defaults to interactive mode.
The following command runs the installation in non-interactive (--no-prompt) and quiet (-Q) modes. It sets the LDAP port (-p), the administration connector port (--adminConnectorPort), the root DN (-D), and the root DN password (-w).
$ oud-proxy-setup --cli --no-prompt -Q -p 1389 --adminConnectorPort 4444 \ -D "cn=Directory Manager" -w password
The utility launches the command-line installer and creates the Oracle Unified Directory instance in OUD-base-location/instance-dir. The default instance directory name is asinst_1, with subsequent instances on the same server named asinst_2, asinst_3, and so on. To specify a different instance name, set the INSTANCE_NAME environment variable before you run the setup, for example:
$ export INSTANCE_NAME=my-oud-proxy-instance
An exit code of 0 indicates that the operation completed successfully. A nonzero exit code indicates that an error occurred during processing.
The oud-proxy-setup command writes a log file named oud-proxy-setup.log, once the setup in complete. The log file is 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
UNIX and Linux: install-dir/oud-proxy-setup
Windows: install-dir\oud-proxy-setup.bat