bm replicate ls

Syntax

The bm replicate ls command lists all replication rules on a Buckit bucket.

The bm replicate list command has equivalent functionality to bm replicate ls.

The following command lists all enabled replication rules for the mydata bucket on the mybuckit Buckit deployment:

bm replicate ls --status "enabled" mybuckit/mydata

The command has the following syntax:

bm [GLOBALFLAGS] replicate ls         \
                 [--status "string"]  \
                 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 of the Buckit deployment and full path to the bucket or bucket prefix for which to list the replication rules. For example:

bm replicate ls mybuckit/mybucket
--status
Optional

Filter replication rules on the bucket based on their status. Specify one of the following values:

  • enabled - Show only enabled replication rules.

  • disabled - Show only disabled replication rules.

If omitted, bm replicate ls defaults to showing all replication rules.

Global Flags

This command supports any of the global flags.

Examples

List Existing Replication Rules

Use bm replicate ls to list bucket replication rules:

bm replicate ls ALIAS/PATH
  • Replace ALIAS with the alias of the Buckit deployment.

  • Replace PATH with the path to the bucket or bucket prefix.

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.