GLOBUS RM

NAME

globus rm - Delete a single path; wait for it to complete.

SYNOPSIS

globus rm [OPTIONS] ENDPOINT_ID:PATH

DESCRIPTION

Submit a 'delete task' to delete a single path, and then block and wait for it to complete.

Output is similar to globus task wait, and it is safe to globus task wait on a globus rm which timed out.

Symbolic links are never followed - only unlinked (deleted).

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

--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: enable-globs]

--star-silent, --unsafe

Don’t prompt when the trailing character is a "*".

-f, --ignore-missing

Don’t throw errors if the file or dir is absent

-r, --recursive

Recursively delete dirs

--timeout-exit-code INTEGER

If the task times out, exit with this status code. Must have a value in 0,1,50-99 [default: 1]

-H, --heartbeat

Every polling interval, print "." to stdout to indicate that task wait is still active

--polling-interval INTEGER

Number of seconds between task status checks. [default: 1]

--timeout N

Wait N seconds. If the task does not terminate by then, or terminates with an unsuccessful status, exit with status 1

--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 rm $ep_id:~/myfile.txt

Delete a directory recursively.

$ ep_id=313ce13e-b597-5858-ae13-29e46fea26e6
$ globus rm $ep_id:~/mydir --recursive

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.