|Oracle® Fusion Middleware Man Page Reference for Oracle Directory Server Enterprise Edition
11g Release 1 (22.214.171.124.0)
Part Number E28967-01
|PDF · Mobi · ePub|
Manage the administration of Directory Proxy Server
install-path/bin/dpadm [subcommand] [global-options] [subcommand-options] [subcommand-operands]
dpadm command is the administration command for the Directory Proxy Server. Use the
dpadm command with one of the subcommands described in this man page.
The following subcommands are supported:
dpadm add-cert [-i] [-W
INSTANCE_PATH CERT_ALIAS CERT_FILE
Adds a certificate to the certificate database.
dpadm add-selfsign-cert [-i] [-W
] [ -S
Creates a self-signed certificate and adds it to the certificate database.
dpadm autostart [--off [--v6]] [-i]
Enables or disables Directory Proxy Server instance startup at system boot. This command is only available if you installed native packages.
Creates a backup archive of the Directory Proxy Server instance.
dpadm create [-i] [-p
Creates a Directory Proxy Server Instance.
Deletes an instance of Directory Proxy Server.
dpadm disable-service [-T
Disables a Directory Proxy Server from being managed as a service. This command is on Windows distributions and Solaris native package distributions only.
dpadm enable-service [-T
Enables a Directory Proxy Server instance to be managed as a service. This command is on Windows distributions and Solaris native package distributions only.
Displays the flag values for the Directory Proxy Server instance.
dpadm import-cert [-i] [-W
Imports the public and private keys of a certificate in the certificate database.
Displays information about the status and configuration of the Directory Proxy Server instance.
dpadm list-certs [-i] [-C] [-W
Lists all certificates in the certificate database.
dpadm list-running-instances [--all]
Displays running instances on a host. By default, the only instances that are launched by the same installation as
dpadm are listed.
dpadm remove-cert [-i] [-W
Removes a certificate from the certificate database.
dpadm renew-cert [-i] [-W
Renews a certificate in the certificate database.
dpadm request-cert [-i] [-W
] [ -s
] [--keysize KEYSIZE ] [--validity
Generates a certificate request.
dpadm restart [-i] [-W
Restarts a Directory Proxy Server instance.
Restores a Directory Proxy Server instance from a backup archive.
dpadm set-flags [-i] [-W
Sets flags values for a Directory Proxy Server instance.
dpadm show-cert [-i] [-W
Displays a certificate.
If no CERT_ALIAS is specified, the default server certificate is displayed.
Splits the LDIF file given by LDIF_FILE into multiple LDIF files according to the data distribution configured in Directory Proxy Server. One LDIF file is created for each data view defined in the LDIF_FILE file.
The LDIF files are stored in the OUTPUT_FILE_DIR directory and are automatically named after the data view, with the following format: OUTPUT_FILE_DIR.DATA_VIEW_NAME
dpadm split-ldif command can be launched even if the Directory Proxy Server is running.
dpadm start [-Ei] [-W
Starts a Directory Proxy Server instance.
Stops a Directory Proxy Server instance.
dpadm stop-running-instances [-i] [--force]
Stops Directory Proxy Server instances. The instances launched by the same installation as
dpadm will be stopped.
dpadm upgrade [-i]
Upgrades Directory Proxy Server instance from versions 6.x, 7.0, and 11g R1 to version 126.96.36.199.0.
The following options are global, and are applicable to all commands and subcommands. The global options must follow their respective commands or subcommands to execute successfully.
Displays instructions for accessing help.
Displays the current version of
dpadm. The version is provided in the format year.monthday.time DISTRIB. So version number
2009.1004.0035 was built on October 4th, 2009 at 00h35. DISTRIB indicates the distribution type. NAT refers to the native packages version. ZIP refers to the ZIP version. If the components used by
dpadm are not aligned, the version of each individual component is displayed.
Displays instructions for accessing verbose help.
The following options are applicable to the subcommands where they are specified.
Displays running instances from any installation path.
Lists Certificate Authority certificates only. The default is to list server certificates only.
L=CITY to the subject DN. Default is none.
C=COUNTRY to the subject DN. The default is none.
Defines the Proxy Manager DN. The default is
Starts Directory Proxy Server with the configuration used at the last successful startup.
When used with
stop-running-instances, the command forcibly shuts down all the running server instances that are created using the same
dpadm installation. When used with
stop, the command forcibly shuts down the instance even if the instance is not initiated by the current installation.
Specifies the output format. The options are
ascii. The default is
Specifies the group name for the owner of the server instance. The default is the name of the current group.
Does not prompt for confirmation before performing the operation.
Specifies the certificate password. The default is to prompt for a password.
Specifies the key-pair generation algorithm (DSA or RSA).
Specifies the signature algorithm used to sign the certificate. The signature algorithm depends on the underlying key-pair generation algorithm. The default signature algorithm is
SHA1withDSA when the key algorithm is
SHA1withRSA when the key algorithm is
CN=NAME to the subject DN. The default is the hostname.
Specifies the length of private key.
Reads the output password from the
OUTPUT_FILE file. The default is a prompt for a password.
Stores the command results in the
OUTPUT_FILE file. The default is
Disables the autostart of an instance of Directory Proxy Server at system boot
O=ORG to the subject DN. The default is none.
OU=ORG-UNIT to the subject DN. The default is none.
Specifies the port for LDAP traffic. The default is
Specifies the secure SSL port for LDAP traffic. The default is
Specifies the subject DN. The default is
ST=STATE to the subject DN. Default is the hostname.
Service type. Can be
SMF when using Solaris 10, or
WIN_SERVICE when using Windows.
Specifies the user name for the owner of the server instance. The default is the name of the current user.
Specifies that the version of the Directory Proxy Server instance is 6.x.
Sets validity of the certificate to
Reads the certificate database password from the
CERT_PW_FILE file. The default is a prompt for password.
Reads the password from the
PW_FILE file. The default is a prompt for password.
The following operands are supported:
Specifies the path to the backup of the Directory Proxy Server instance.
Specifies the certificate alias.
Specifies the file that contains the certificate.
Specifies a flag that represents a property operand when using the command
dpadm get-flags. Possible flags:
Specifies a flag and its value. The FLAG=VALUE operand can have the following values:
Sets the certificate database password storage mode to
on. The certificate database password is stored on the file system. This is the default value.
Sets the certificate database password storage mode to
off. The certificate database password is not stored on the file system. You are prompted to supply the certificate database password when needed.
jvm-args="arg1 arg2 ..."
These values are arguments passed to the Java Virtual Machine (JVM).
The default value is
memory is the maximum memory size for the JVM. The default value is
-Xmx250M (250 MB).
memory is the startup memory size for the JVM. The default value is
-Xms250M (250 MB). The startup memory size
memory should be the same as the maximum memory size
ratio is applicable to the Sun Hotspot JVM only, and is the ratio between old and young generation memory. The recommended value is
-XX:NewRatio=1, which is equal old and young generation memory.
-d flag specifies which JVM is used (32-bits or 64-bits). By default, Directory Proxy Server is launched with a 64-bit JVM, if available, and with a 32-bit JVM otherwise. If you want to override this behavior and specify the JVM, set the
jvm-args flag to either d-32 or d-64, for example
jvm-args=-Xmx250M -Xms250M -d32
You can use the
jvm-args flag to pass a list of arguments to the JVM. For information about JVM arguments not described in this man page, see the java(1) man page.
Sets JAVA_HOME that take precedence over JAVA_HOME defined in the environment.
Sets the permissions of configuration and log files.
Specifies the path to the Directory Proxy Server instance.
Specifies the LDIF file that is to be split by using the
Specifies the directory where LDIF files are placed after being split by the
The following exit status values are returned:
An error occurred.
The following examples show how the
dpadm command is used.
The following example shows how to create a Directory Proxy Server instance.
$ dpadm create /local/dps
The following example shows how to start a Directory Proxy Server instance.
$ dpadm start /local/dps
The following example shows how to get information about a Directory Proxy Server instance.
$ dpadm info /local/dps
attributes(5) for descriptions of the following attributes:
|ATTRIBUTE TYPE||ATTRIBUTE VALUE|