CLI Menu

Command Line Interface (CLI) CLI QuickStart GuideCommand Line Interface (CLI) ExamplesUsing the CLI with High Assurance Resources

NAME

globus task show - Show detailed information about a specific task

SYNOPSIS

globus task show ['OPTIONS'] 'TASK_ID'

DESCRIPTION

The globus task show command prints information to standard out detailing the status and other info about a task. The task may be pending, completed, or in progress.

OPTIONS

-t, --successful-transfers

Show files that were successfully transferred as a result of this task. This option completely changes the output, only producing this information and no other task details.

--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

When text output is requested, output varies slightly between 'TRANSFER' and 'DELETE' tasks, and between active and completed tasks.

All of the following which apply will be shown:

  • 'Task ID'

  • 'Type'

  • 'Status'

  • 'Is Paused'

  • 'Label'

  • 'Files'

  • 'Directories'

  • 'Source Endpoint'

  • 'Source Endpoint ID'

  • 'Destination Endpoint'

  • 'Destination Endpoint ID'

  • 'Endpoint'

  • 'Endpoint ID'

  • 'Completion Time'

  • 'Deadline'

  • 'Details'

  • 'Request Time'

  • 'Bytes Transferred'

  • 'Bytes Per Second'

  • 'Faults'

  • 'Total Subtasks'

  • 'Subtasks Succeeded'

  • 'Subtasks Pending'

  • 'Subtasks Retrying'

  • 'Subtasks Failed'

  • 'Subtasks Canceled'

  • 'Subtasks Expired'

If --successful-transfers is given, the following fields are used:

  • 'Source Path'

  • 'Destination Path'

EXAMPLES

Show detailed info about a task as text

$ globus task show TASK_ID

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.

© 2010- The University of Chicago Legal