GLOBUS TASK CANCEL

NAME

globus task cancel - Cancel a task

SYNOPSIS

globus task cancel [OPTIONS] TASK_ID

globus task cancel --all [OPTIONS]

DESCRIPTION

Cancel a task you own or all tasks which you own.

This includes not only currently executing tasks, but also any queued tasks which you may have which have not started execution.

You must either provide the '--all' option or a 'TASK_ID'.

OPTIONS

-a, --all

Cancel all in-progress tasks that you own

-v, --verbose

Control level of output.

-h, --help

Show this message and exit.

-F, --format [unix|json|text]

Output format for stdout. Defaults to text.

--jmespath, --jq TEXT

A JMESPath expression to apply to json output. Forces the format to be json processed by this expression.

--map-http-status TEXT

Map HTTP statuses to any of these exit codes: 0,1,50-99. e.g. "404=50,403=51"

OUTPUT

Output depends on whether or not '--all' was provided, and of course on the requested output format.

If '--all' is requested, output will contain all task IDs which were cancelled. If, in addition to this, the output format is text, the results will be streamed as tasks are cancelled. JSON output is buffered and printed all at once, after all of the cancellations.

When '--all' is not passed, output is a simple success message indicating that the task was cancelled, or an error.

EXAMPLES

Cancel a specific task

$ globus task cancel TASK_ID

Cancel all tasks

$ globus task cancel --all

EXIT STATUS

0 on success.

1 if a network or server error occurred, unless --map-http-status has been used to change exit behavior on http error codes.

2 if the command was used improperly.

3 if the command was used on the wrong type of object, e.g. a collection command used on an endpoint.

4 if the command has authentication or authorization requirements which were not met, as in ConsentRequired errors or missing logins.