GLOBUS TASK CANCEL(1)
NAME
globus task cancel - Cancel a task owned by the current user
SYNOPSIS
globus task cancel ['OPTIONS'] 'TASK_ID'
globus task cancel --all ['OPTIONS']
DESCRIPTION
The globus task cancel command cancels a specific task which 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
-
When given, 'TASK_ID' is not required. Cancel all pending and executing tasks.
- --map-http-status 'TEXT'
-
Map non success HTTP response codes to exit codes other than 1. e.g. "--map-http-satus 403=0,404=0" would exit with 0 even if a 403 or 404 http error code was received. Valid exit codes are 0,1,50-99.
- -F, --format '[json|text]'
-
Set the output format for stdout. Defaults to "text".
- --jq, --jmespath 'EXPR'
-
Supply a JMESPath expression to apply to json output. Takes precedence over any specified '--format' and forces the format to be json processed by this expression.
A full specification of the JMESPath language for querying JSON structures may be found at https://jmespath.org/
- -h, --help
-
Show help text for this command.
- -v, --verbose
-
Control the level of output.
Use -v or --verbose to show warnings and any additional text output.
Use -vv to add informative logging.
Use -vvv to add debug logging and full stack on any errors. (equivalent to -v --debug)
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.