schedule-exec-task

Description

Schedule an exec task to run a specified command in the server. To run an exec task, a number of conditions must be satisfied: the server's global configuration must have been updated to include 'com.unboundid.directory.server.tasks.ExecTask' in the set of allowed-task values, the requester must have the 'exec-task' privilege, and the command to execute must be listed in the 'exec-command-whitelist.txt' file in the server's config directory. The absolute path (on the server system) of the command to execute must be specified as the first unnamed trailing argument to this program, and the arguments to provide to that command (if any) should be specified as the remaining trailing arguments. The server root is used as the command's working directory, so any arguments that represent relative paths are interpreted as relative to that directory.

Examples

schedule-exec-task --hostname directory.example.com --port 389 \
     --bindDN uid=admin,dc=example,dc=com --promptForBindPassword \
     --waitForCompletion --logCommandOutput /ds/bin/verify-index \
     --baseDN dc=example,dc=com --index cn

Arguments

-V
--version

-H
--help

--help-debug

-h {host}
--hostname {host}

-p {port}
--port {port}

-D {dn}
--bindDN {dn}

-w {password}
--bindPassword {password}

-j {path}
--bindPasswordFile {path}

--promptForBindPassword

-Z
--useSSL

-q
--useStartTLS

-X
--trustAll

-K {path}
--keyStorePath {path}

-W {password}
--keyStorePassword {password}

-u {path}
--keyStorePasswordFile {path}

--promptForKeyStorePassword

--keyStoreFormat {format}

-P {path}
--trustStorePath {path}

-T {password}
--trustStorePassword {password}

-U {path}
--trustStorePasswordFile {path}

--promptForTrustStorePassword

--trustStoreFormat {format}

-N {nickname}
--certNickname {nickname}

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

--useSASLExternal

--helpSASL

--taskID {id}

-t {YYYYMMDDhhmmss}
--startTime {YYYYMMDDhhmmss}

--alertOnStart

--alertOnSuccess

--alertOnError

--emailOnStart {emailAddress}

--emailOnSuccess {emailAddress}

--emailOnError {emailAddress}

--dependsOnTask {id}

--failedDependencyAction {process|cancel|disable}

--waitForCompletion

--outputFile {path}

--logCommandOutput

--taskCompletionStateForNonZeroExitCode {stopped-by-error|completed-with-errors|completed-successfully}

--workingDirectory {path}

--interactive

--propertiesFilePath {path}

--generatePropertiesFile {path}

--noPropertiesFile

--suppressPropertiesFileComment