`bm legalhold info`

Syntax

The bm legalhold info command returns the current legal hold setting for an object or objects.

bm legalhold requires that the specified bucket has object locking enabled. You can only enable object locking at bucket creation. See bm mb --with-lock for documentation on creating buckets with object locking enabled.

EXAMPLE

The following command retrieves the current legalhold status for objects in the mydata bucket on the mybuckit Buckit deployment:

bm legalhold info --recursive mybuckit/mydata

SYNTAX

The command has the following syntax:

bm [GLOBALFLAGS] legalhold info  \
                 [--recursive]   \
                 [--rewind]      \
                 [--version-id]  \
                 ALIAS

Brackets [] indicate optional parameters.
Parameters sharing a line are mutually dependent.
Parameters separated using the pipe | operator are mutually exclusive.

Copy the example to a text editor and modify as-needed before running the command in the terminal/shell.

Parameters

ALIAS

Required

The Buckit alias and path to the object or objects on which to enable the legal hold. For example:

bm legalhold info play/mybucket/myobjects/objects.txt

--recursive, r: Optional
Returns the legal hold status of all objects in the ALIAS bucket or bucket prefix.

--rewind

Optional

Directs bm legalhold info to operate only on the object version(s) that existed at specified point-in-time.

To rewind to a specific date in the past, specify the date as an ISO8601-formatted timestamp. For example: --rewind "2020.03.24T10:00".
To rewind a duration in time, specify the duration as a string in #d#hh#mm#ss format. For example: --rewind "1d2hh3mm4ss".

--rewind requires that the specified ALIAS be an S3-compatible service that supports Bucket Versioning. For Buckit deployments, use bm version to enable or disable bucket versioning.

--version-id, vid

Optional

Directs bm legalhold info to operate only on the specified object version.

--version-id requires that the specified ALIAS be an S3-compatible service that supports Bucket Versioning. For Buckit deployments, use bm version to enable or disable bucket versioning.

Global Flags

This command supports any of the global flags.

Examples

Retrieve the Legal Hold Status Objects

Use bm legalhold info to retrieve the legal hold status of an object. Include --recursive to return the legal hold status of the contents of a bucket:

bm legalhold clear [--recursive] ALIAS/PATH

Replace ALIAS with the alias of the S3-compatible host.
Replace PATH with the path to the bucket or object on the S3-compatible host. If specifying the path to a bucket or bucket prefix, include the --recursive option.

Behavior

S3 Compatibility

The bm commandline tool is built for compatibility with the AWS S3 API and is tested with Buckit and AWS S3 for expected functionality and behavior.

Buckit provides no guarantees for other S3-compatible services, as their S3 API implementation is unknown and therefore unsupported. While bm commands may work as documented, any such usage is at your own risk.