GLOBUS DELETE
DESCRIPTION
Submits an asynchronous task that deletes files and/or directories on the target endpoint.
globus delete has two modes. Single target, which deletes one file or one directory, and batch, which takes in several lines to delete multiple files or directories. See "Batch Input" below for more information.
Symbolic links are never followed - only unlinked (deleted).
Batch Input
If you give a PATH without the --batch
flag, you will submit a
single-file or single-directory delete task.
Using --batch
, globus delete
can submit a task which deletes multiple files or
directories.
Each line of --batch
input is treated as a path to a file or directory to delete.
Lines are of the form PATH
Note that unlike globus transfer
, --recursive
is not an option at the per-line
level, instead, if given with the original command, all paths that point to
directories will be recursively deleted.
Empty lines and comments beginning with '#' are ignored.
If you use --batch
and supply a PATH via the commandline, the commandline PATH is
treated as a prefix to all of the paths read from the --batch
input.
OPTIONS
- --skip-activation-check
-
Submit the task even if the endpoint(s) aren’t currently activated.
-
--deadline
[%Y-%m-%d|%Y-%m-%dT%H:%M:%S|%Y-%m-%d
%H:%M:%S]
-
Set a deadline for this to be canceled if not completed by.
-
--label
TEXT
-
Set a label for this task.
-
--submission-id
TEXT
-
Task submission ID, as generated by
globus task generate-submission-id
. Used for safe resubmission in the presence of network failures. -
--notify
{on,off,succeeded,failed,inactive}
-
Comma separated list of task events which notify by email. 'on' and 'off' may be used to enable or disable notifications for all event types. Otherwise, use 'succeeded', 'failed', or 'inactive'.
- --dry-run
-
Don’t actually submit the task, print submission data instead
-
--batch
FILENAME
-
Accept a batch of paths from a file. Use
-
to read from stdin.Uses ENDPOINT_ID as passed on the commandline.
See documentation on "Batch Input" for more information.
- --enable-globs / --no-enable-globs
-
Enable expansion of *, ?, and [ ] characters in the last component of file paths, unless they are escaped with a preceding backslash, \ [default: no-enable-globs]
- --star-silent, --unsafe
-
Don’t prompt when the trailing character is a "*". Implicit in --batch
- -f, --ignore-missing
-
Don’t throw errors if the file or dir is absent
- -r, --recursive
-
Recursively delete dirs
-
--local-user
TEXT
-
Optional value passed to identity mapping specifying which local user account to map to. Only usable with Globus Connect Server v5 mapped collections.
- -v, --verbose
-
Control level of output, make it more verbose.
- --quiet
-
Suppress non-essential output. This is higher precedence than
--verbose
. - -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"
EXAMPLES
Delete a single file.
$ ep_id=313ce13e-b597-5858-ae13-29e46fea26e6
$ globus delete $ep_id:~/myfile.txt
Delete a directory recursively.
$ ep_id=313ce13e-b597-5858-ae13-29e46fea26e6
$ globus delete $ep_id:~/mydir --recursive
Use the batch input method to transfer multiple files and or dirs.
$ ep_id=313ce13e-b597-5858-ae13-29e46fea26e6
$ globus delete $ep_id --batch - --recursive
~/myfile1.txt
~/myfile2.txt
~/myfile3.txt
~/mygodatadir
<EOF>
Submit a deletion task and get back the task ID for use in globus task wait
:
$ ep_id=313ce13e-b597-5858-ae13-29e46fea26e6
$ task_id="$(globus delete $ep_id:~/mydir --recursive --jmespath 'task_id' --format unix)"
$ echo "Waiting on $task_id"
$ globus task wait "$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.
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.