Documentation

Documentation

mc ilm ls

Syntax

The mc ilm ls command lists all configured object lifecycle management rules on a MinIO bucket.

The following command lists all lifecycle management rules for the mydata bucket on the myminio MinIO deployment:

mc ilm ls myminio/mydata

The mc ilm ls command has the following syntax:

mc [GLOBALFLAGS] ilm ls                        \
                 [--expiry | --transition]     \
  • Brackets [] indicate optional parameters.

  • Parameters sharing a line are mutually dependent.

  • Parameters seperated 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 alias and full path to the bucket on the MinIO deployment for which to list the object lifecycle management rules. For example:

mc ilm ls myminio/mydata
--expiry

Optional mc ilm ls returns only fields related to lifecycle rule expiration.

Mutually exclusive with --transition.

--transition

Optional mc ilm ls returns only fields related to lifecycle rule transition.

Mutually exclusive with --expiry.

Global Flags

This command supports any of the global flags.

Examples

List Bucket Lifecycle Management Rules

Use mc ilm ls to list a bucket’s lifecycle management rules:

mc ilm ls ALIAS/PATH
  • Replace ALIAS with the alias of the S3-compatible host.

  • Replace PATH with the path to the bucket on the S3-compatible host.

Behavior

S3 Compatibility

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

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