Skip to content

mc ilm ls

Note

Changed: RELEASE.2022-12-24T15-21-38Z

mc ilm ls replaced by mc ilm rule ls.

Syntax

The mc ilm ls command summrizes all configured object lifecycle management rules on a MinIO bucket in a tabular format.

The output of the command might resemble the following:

┌───────────────────────────────────────────────────────────────────────────────┐
│ Transition for latest version (Transition)                                    │
├────────┬─────────┬────────┬─────────────────────┬──────────────┬──────────────┤
│ ID     │ STATUS  │ PREFIX │ TAGS                │ DAYS TO TIER │ TIER         │
├────────┼─────────┼────────┼─────────────────────┼──────────────┼──────────────┤
│ rule-1 │ Enabled │ doc/   │ key1=val1&key2=val2 │            0 │ WARM-MINIO-1 │
└────────┴─────────┴────────┴─────────────────────┴──────────────┴──────────────┘
┌────────────────────────────────────────────────────────────────┐
│ Transition for older versions (NoncurrentVersionTransition)    │
├────────┬─────────┬────────┬──────┬──────────────┬──────────────┤
│ ID     │ STATUS  │ PREFIX │ TAGS │ DAYS TO TIER │ TIER         │
├────────┼─────────┼────────┼──────┼──────────────┼──────────────┤
│ rule-2 │ Enabled │ logs/  │ -    │           10 │ WARM-MINIO-1 │
└────────┴─────────┴────────┴──────┴──────────────┴──────────────┘
┌────────────────────────────────────────────────────────────────────────────────────────┐
│ Expiration for latest version (Expiration)                                             │
├────────┬─────────┬────────┬─────────────────────┬────────────────┬─────────────────────┤
│ ID     │ STATUS  │ PREFIX │ TAGS                │ DAYS TO EXPIRE │ EXPIRE DELETEMARKER │
├────────┼─────────┼────────┼─────────────────────┼────────────────┼─────────────────────┤
│ rule-1 │ Enabled │ doc/   │ key1=val1&key2=val2 │             30 │ false               │
└────────┴─────────┴────────┴─────────────────────┴────────────────┴─────────────────────┘
┌──────────────────────────────────────────────────────────────────────────────────┐
│ Expiration for older versions (NoncurrentVersionExpiration)                      │
├────────┬─────────┬────────┬─────────────────────┬────────────────┬───────────────┤
│ ID     │ STATUS  │ PREFIX │ TAGS                │ DAYS TO EXPIRE │ KEEP VERSIONS │
├────────┼─────────┼────────┼─────────────────────┼────────────────┼───────────────┤
│ rule-1 │ Enabled │ doc/   │ key1=val1&key2=val2 │             15 │             0 │
│ rule-2 │ Enabled │ logs/  │ -                   │              1 │             3 │
└────────┴─────────┴────────┴─────────────────────┴────────────────┴───────────────┘

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 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

mc-cmd

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

mc-cmd

Optional

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

Mutually exclusive with --transition.

--transition

mc-cmd

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

This page preserves historical syntax. See the current mcli reference for supported commands and compatibility scope.