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 manage-tasks command manages and monitors tasks that have been scheduled to run on the directory server.
This command is not supported for the proxy.
manage-tasks [options]
The manage-tasks command can be used to manage and monitor tasks that have been scheduled to run on the directory server. Tasks are scheduled by providing the appropriate scheduling information when the task is invoked (see Configuring Commands As Tasks in Oracle Fusion Middleware Administration Guide for Oracle Unified Directory). The manage-tasks command can be used to list tasks that are currently scheduled or that have already been executed. In addition, you can get more detailed information about a task's scheduled and execution time, its log messages, and its options.
The manage-tasks command can only be run on an online server instance, and accesses the task back end over SSL through the administration connector (described in Managing Administration Traffic to the Server in Oracle Fusion Middleware Administration Guide for Oracle Unified Directory.)
The manage-tasks command accepts an option in either its short form (for example, -c taskID) or its long form equivalent (for example, --cancel taskID).
Specify a particular task to cancel.
Display information for a particular task.
Print a summary of tasks.
Use the bind DN to authenticate to the directory server. This option is used when performing simple authentication and is not required if SASL authentication is used. The default value for this option is cn=Directory Manager.
Contact the directory server on the specified hostname or IP address. If this option is not provided, a default of localhost is used.
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 specified certificate for client authentication.
Use the specified options for SASL authentication.
Contact the directory server at the specified administration port. If this option is not provided, a default administration port of 4444 is used.
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 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 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 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 bind password when authenticating to the directory server. This option can be used for simple authentication as well as password-based SASL mechanisms. This option must not be used in conjunction with --bindPasswordFile. 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 all server SSL certificates that the directory 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 non-interactive mode. If required option values are missing, you are not prompted and the command will fail.
Indicates that a properties file is not used to obtain 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 manage tasks.
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.
Example 1-27 Displaying a Summary of Scheduled Tasks
The following command displays a list of scheduled tasks:
$ manage-tasks -h localhost -p 4444 -D "cn=directory manager" -w password -X -s ID Type Status ------------------------------------------------- 2008101610361710 Backup Completed successfully 2008101610403710 Restore Completed successfully 2008101610442610 Restore Waiting on start time
Example 1-28 Obtaining Task Information
The following command returns information about a specific task:
$ manage-tasks -h localhost -p 4444 -D "cn=directory manager" -w password -X \ -i 2008101610442610 Task Details ------------------------------------------------------- ID 2008101610442610 Type Restore Status Waiting on start time Scheduled Start Time Jan 25, 2009 12:15:00 PM SAST Actual Start Time Completion Time Dependencies None Failed Dependency Action None Email Upon Completion admin@example.com Email Upon Error admin@example.com Restore Options ---------------------------------- Backup Directory /backup/userRoot
Example 1-29 Canceling a Scheduled Task
The following command cancels a scheduled task. The command uses the --no-prompt option to run in non-interactive mode.
$ manage-tasks -h localhost -p 4444 -D "cn=directory manager" -w password -X \ -c 2008101610442610 Task 2008101610442610 canceled
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 manage-tasks 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.
UNIX and Linux: instance-dir/OUD/bin/manage-tasks
Windows: instance-dir\OUD\bat\manage-tasks.bat