| Exit Print View | |
Sun OpenDS Standard Edition 2.2 Command-Line Usage Guide |
|
|
|
The vdp-setup command manages Sun OpenDS Standard Edition proxy setup.
This command is not supported for the directory server.
vdp-setup [options]
The vdp-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 vdp-setup can only be launched once. It can be run in two 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 Sun OpenDS Standard Edition proxy.
Script-friendly mode. Script-friendly mode can be used in scripts where all appropriate values are provided in the form of command-line options.
To run vdp-setup in command-line mode, use the --cli option. The options that can be provided are listed below. Note that no options are allowed if the command is run in GUI mode.
The vdp-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.
Port on which the Administration Connector should listen for communication.
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 LDAPS communication. The LDAPS port will be configured and SSL will be enabled only if this argument is explicitly specified.
Generate a self-signed 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, or PKCS#12) as server certificate.
Certificate key store PIN file. A PIN is required when you specify to use an existing certificate (JKS, JCEKS, or PKCS#12) 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 vdp-setup command. You can use the commands on any UNIX, Linux, or Windows system that has at least 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.
See Sun OpenDS Standard Edition System Requirements in Sun OpenDS Standard Edition 2.2 Installation Guide for more information.
The following command runs an installation in GUI mode:
$ vdp-setup
Script-friendly mode enables you to create installation scripts with the setup command when many directory server instances must be configured for large replicated environments. Script-friendly 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).
$ vdp-setup --cli --no-prompt -Q -p 1389 --adminConnectorPort 4444 \ -D "cn=Directory Manager" -w password
An exit code of 0 indicates that the operation completed successfully. A nonzero exit code indicates that an error occurred during processing.
The vdp-setup command writes a log file named vdp-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/vdp-setup
Windows: install-dir\vdp-setup.bat
|
|