minio/docs

mirror of https://github.com/minio/docs.git synced 2025-07-28 19:42:10 +03:00

Files

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

5.7 KiB

Raw Permalink Blame History

`mc retention clear`

minio

Table of Contents

mc retention clear

Syntax

The mc retention clear command removes the Write-Once Read-Many (WORM) locking <minio-object-locking> settings for an object or object(s) in a bucket. You can also remove the default object lock settings for a bucket.

To change the retention status of an object under legal hold <minio-object-locking-legalhold>, use mc legalhold clear.

EXAMPLE

The following command removes the default object lock configuration for the mydata bucket on the myminio MinIO deployment:

mc retention clear --default myminio/mydata

SYNTAX

The command has the following syntax:

mc [GLOBALFLAGS] retention clear           \
                 [--default]               \
                 [--recursive]             \
                 [--rewind "string"]       \
                 [--version-id "string"]*  \
                 [--versions]              \
                 ALIAS

mc retention clear --version-id is mutually exclusive with multiple other parameters. See the reference documentation for more information.

Parameters

ALIAS

Required The full path to the object or objects for which to clear the object lock configuration. Specify the alias <mc alias> of a configured S3-compatible service as the prefix to the ALIAS bucket path. For example:

mc retention clear play/mybucket/object.txt

If the ALIAS specifies a bucket or bucket prefix, include

~mc retention clear --recursive to clear the object lock settings to the bucket contents.
If the ALIAS bucket has versioning enabled,

mc retention clear by default applies to only the latest object version. Use ~mc retention clear --version-id or ~mc retention clear --versions to clear the object lock settings for a specific version or for all versions of the object.

--default

Optional Clears the default object lock settings for the bucket specified to ~mc retention clear ALIAS.

If specifying ~mc retention clear --default, mc retention clear ignores all other flags.

--recursive, r

Optional Recursively clears the object lock settings for all objects in the specified ~mc retention clear ALIAS path.

Mutually exclusive with ~mc retention clear --version-id.

--rewind

--version-id, vid

Mutually exclusive with any of the following flags:

~mc retention clear --versions
~mc retention clear --rewind
~mc retention clear --recursive

--versions

Use ~mc retention clear --versions and ~mc retention clear --rewind together to remove the retention settings from all object versions that existed at a specific point-in-time.

Global Flags

Examples

Clear Object Lock Settings for an Object or Object(s)

Specific Object

mc retention clear ALIAS/PATH

Replace ALIAS <mc retention clear ALIAS> with the alias <mc alias> of a configured S3-compatible host.
Replace PATH <mc retention clear ALIAS> with the path to the object.

Multiple Objects

Use mc retention clear with ~mc retention clear --recursive to clear the retention settings from all objects in a bucket:

mc retention clear --recursive ALIAS/PATH

Replace ALIAS <mc retention clear ALIAS> with the alias <mc alias> of a configured S3-compatible host.
Replace PATH <mc retention clear ALIAS> with the path to the bucket.

5.7 KiB Raw Permalink Blame History