minio/docs
1
0
Fork 0
mirror of https://github.com/minio/docs.git synced 2025-09-17 18:22:26 +03:00
Code Activity
Files
DOCS-860-part2a
docs/source/reference/minio-mc/mc-legalhold-info.rst
Andrea Longo 1f8ce6dec2 Add reference page for mc du (#783) 
Create a new reference page for `mc du` and link it in the list of `mc`
commands.

Staged:

http://192.241.195.202:9000/staging/DOCS-764/linux/html/reference/minio-mc/mc-du.html

Includes drive-by fixes to make the _Optional_ notations appear in a
more consistent manner. (Including several otherwise unrelated pages.)
There's more opportunistic fixes here than I might normally do in the
same PR, but seemed better to get it over with.

Fixes https://github.com/minio/docs/issues/764

---------

Co-authored-by: Ravind Kumar <ravind@min.io>
2023-03-30 13:36:41 -06:00

3.4 KiB
Raw Permalink Blame History

mc legalhold info

minio

Table of Contents

mc legalhold info

Syntax

The mc legalhold info command returns the current legal hold <minio-object-locking-legalhold> setting for an object or objects.

mc legalhold requires that the specified bucket has object locking enabled. You can only enable object locking at bucket creation. See mc 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 myminio MinIO deployment:

mc legalhold info --recursive myminio/mydata

SYNTAX

The command has the following syntax:

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

Parameters

ALIAS

Required The MinIO alias <alias> and path to the object or objects on which to enable the legal hold. For example:

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

--recursive, r

Returns the legal hold status of all objects in the ~mc legalhold info ALIAS bucket or bucket prefix.

--rewind

--version-id, vid

Global Flags

Examples

Retrieve the Legal Hold Status Objects

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

mc legalhold clear [--recursive] ALIAS/PATH
  • Replace ALIAS <mc legalhold info ALIAS> with the alias <alias> of the S3-compatible host.
  • Replace PATH <mc legalhold info ALIAS> 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 ~mc legalhold info --recursive option.

Behavior

S3 Compatibility