manage-tasks
Prev | Directory Server Tools | Next

## Name

manage-tasks — manage OpenDJ server administration tasks

## Synopsis

`manage-tasks`

## Description

This utility can be used to obtain a list of tasks scheduled to run within the Directory Server as well as information about individual tasks.

## Options

The manage-tasks command takes the following options:

Command options:

`-c | --cancel {taskID}`

  ID of a particular task to cancel.

`--connectTimeout {timeout}`

  Maximum length of time (in milliseconds) that can be taken to establish a connection. Use '0' to specify no time out.

  Default: 30000

`-i | --info {taskID}`

  ID of a particular task about which this tool will display information.

`-s | --summary`

  Print a summary of tasks.

  Default: false

LDAP connection options:

`-D | --bindDN {bindDN}`

  DN to use to bind to the server.

  Default: cn=Directory Manager

`-h | --hostname {host}`

  The fully-qualified directory server host name that will be used when generating self-signed certificates for LDAP SSL/StartTLS, the administration connector, and replication.

  Default: localhost.localdomain

`-j | --bindPasswordFile {bindPasswordFile}`

  Bind password file.

`-K | --keyStorePath {keyStorePath}`

  Certificate key store path.

`-N | --certNickname {nickname}`

  Nickname of the certificate that the server should use when accepting SSL-based connections or performing StartTLS negotiation.

`-o | --saslOption {name=value}`

  SASL bind options.

`-p | --port {port}`

  Directory server administration port number.

  Default: 4444

`-P | --trustStorePath {trustStorePath}`

  Certificate trust store path.

`-T | --trustStorePassword {trustStorePassword}`

  Certificate trust store PIN.

`-u | --keyStorePasswordFile {keyStorePasswordFile}`

  Certificate key store PIN file. A PIN is required when you specify to use an existing certificate as server certificate.

`-U | --trustStorePasswordFile {path}`

  Certificate trust store PIN file.

`-w | --bindPassword {bindPassword}`

  Password to use to bind to the server. Use -w - to ensure that the command prompts for the password, rather than entering the password as a command argument.

`-W | --keyStorePassword {keyStorePassword}`

  Certificate key store PIN. A PIN is required when you specify to use an existing certificate as server certificate.

`-X | --trustAll`

  Trust all server SSL certificates.

  Default: false

Utility input/output options:

`-n | --no-prompt`

  Use non-interactive mode. If data in the command is missing, the user is not prompted and the tool will fail.

  Default: false

`--noPropertiesFile`

  No properties file will be used to get default command line argument values.

  Default: false

`--propertiesFilePath {propertiesFilePath}`

  Path to the file containing default property values used for command line arguments.

General options:

`-V | --version`

  Display Directory Server version information.

  Default: false

`-H | --help`

  Display this usage information.

  Default: false

## Exit Codes

0

  The command completed successfully.

> 0

  An error occurred.

## Examples

The following example demonstrates use of the command with a server that does daily backups at 2:00 AM.

    $ manage-tasks -p 4444 -h opendj.example.com -D "cn=Directory Manager" \
     -w password -s

      ID                                Type    Status
      ---------------------------------------------------------------
      example-backup                    Backup  Recurring
      example-backup-20110622020000000  Backup  Waiting on start time

Prev | Up | Next
manage-account | Home | rebuild-index