`bm ilm rule ls`

Syntax

The bm ilm rule ls command summarizes all configured object lifecycle management rules on a Buckit bucket in a tabular format.

The bm ilm rule list command has equivalent functionality to bm ilm rule ls.

EXAMPLE

The following command lists all lifecycle management rules for the mydata bucket on the mybuckit Buckit deployment:

bm ilm rule ls mybuckit/mydata

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 │
└────────┴─────────┴────────┴─────────────────────┴────────────────┴───────────────┘

SYNTAX

The bm ilm rule ls command has the following syntax:

bm [GLOBALFLAGS] ilm rule 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

Required

The alias and full path to the bucket on the Buckit deployment for which to list the object lifecycle management rules. For example:

bm ilm rule ls mybuckit/mydata

--expiry

Optional

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

Mutually exclusive with --transition.

--transition

Optional

bm ilm rule 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 bm ilm rule ls to list a bucket’s lifecycle management rules:

bm ilm rule 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.

Show Policy Modification Time

Use bm ilm rule ls with --json to show the time the policy for a bucket was last updated.

bm ilm rule ls ALIAS/PATH --json

Replace ALIAS with the alias of the S3-compatible host.
Replace PATH with the path to the bucket on the S3-compatible host.

The updateAt property in the JSON output contains the date and time the policy was updated.

The output resembles the following:

{
 "status": "success",
 "target": "mybuckit/mybucket",
 "config": {
  "Rules": [
   {
    "Expiration": {
     "Days": 30
    },
    "ID": "ci1o2mg0sko6f1r3krv0",
    "Status": "Enabled"
   }
  ]
 },
 "updatedAt": "2023-06-09T19:45:30Z"
}

Required Permissions

For permissions required to list rules, refer to the required permissions on the parent command.

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.