bm ilm rule export
Syntax
The bm ilm rule export command exports the object lifecycle management configuration for a Buckit bucket.
The bm ilm rule export command outputs to STDOUT by default.
You can output the contents to a .json file for archival or ingestion using bm ilm rule import.
The following command exports the lifecycle management configuration
of the mydata bucket on the mybuckit deployment to the
mydata-lifecycle-config.json file:
bm ilm rule export mybuckit/mydata > mydata-lifecycle-config.json
The command has the following syntax:
bm [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 Buckit deployment for which to export object lifecycle management rules. For example:
bm ilm rule export mybuckit/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:
bm ilm rule export mybuckit/mybucket > bucket-lifecycle.json
bm ilm rule export ALIAS > file.json
Replace
ALIASwith the alias of the Buckit deployment and the bucket for which to export object lifecycle management rules:mybuckit/mydataReplace
file.jsonwith 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 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.