Documentation

mc ilm rule export

Changed in version RELEASE.2022-12-24T15-21-38Z: mc ilm rule export replaces mc ilm export.

Syntax

The mc ilm rule export command exports the object lifecycle management configuration for a MinIO bucket.

The mc ilm rule export command outputs to STDOUT by default. You can output the contents to a .json file for archival or ingestion using mc ilm rule import.

The following command exports the lifecycle management configuration of the mydata bucket on the myminio deployment to the mydata-lifecycle-config.json file:

mc ilm rule export myminio/mydata > mydata-lifecycle-config.json

The command has the following syntax:

mc [GLOBALFLAGS] ilm rule export ALIAS
  • 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 MinIO deployment for which to export object lifecycle management rules. For example:

mc ilm rule export myminio/mydata > bucket-lifecycle.json

Global Flags

This command supports any of the global flags.

Examples

Export the Bucket Lifecycle Management Configuration

The following command exports the bucket lifecycle management configuration to the bucket-lifecycle.json file:

mc ilm rule export myminio/mybucket > bucket-lifecycle.json
mc ilm rule export ALIAS > file.json
  • Replace ALIAS with the alias of the MinIO deployment and the bucket for which to export object lifecycle management rules:

    myminio/mydata

  • Replace file.json with the name of the file to which to export the lifecycle management rules.

Required Permissions

For permissions required to export a rule, refer to the required permissions on the parent command.

Behavior

S3 Compatibility

The mc commandline tool is built for compatibility with the AWS S3 API and is tested with 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.