Help Center

Menu

terminateJob

Terminate a job in the queue.

dxp-next job-runner terminateJob --help 
Usage: dxp-next job-runner terminateJob [options] <jobName> <executionId> <reason>

Terminate a job in the queue

Arguments:
  jobName                      Name of the job to pass to the request
  executionId                  Name of the job execution id to pass to the request
  reason                       Reason for job termination, eg "Cancelling due to mistake in inputs"

Options:
  -t, --tenant <string>        Tenant ID to run against. If not provided will use configured tenant from login
  -ou, --overrideUrl <string>  Developer option to override the entire job runner url with a custom value
  -h, --help                   display help for command
Required parameters
jobName

Name of the job to pass to the request.

executionId

Name of the job execution ID to pass to the request.

reason

The reason for the termination. For example, "Cancelling due to mistake in inputs."

Optional parameters
-t --tenant <string>

The tenant ID for deployment. If this string is not provided the service will use the configured tenant from login.

-ou --overrideUrl <string>

Developer option to override the entire Job runner URL with a custom value.

-h --help

Display the help for this command.