`mc replicate ls`

Table of Contents

Syntax
- Parameters
- Global Flags
Examples
- List Existing Replication Rules
Behavior
- S3 Compatibility

Syntax

The mc replicate ls command lists all replication rules on a MinIO bucket.

EXAMPLE

The following command lists all enabled replication rules for the mydata bucket on the myminio MinIO deployment:

mc replicate ls --status "enabled" myminio/mydata

SYNTAX

The command has the following syntax:

mc [GLOBALFLAGS] replicate ls         \
                 [--status "string"]  \
                 ALIAS

Brackets [] indicate optional parameters.
Parameters sharing a line are mutually dependent.
Parameters seperated 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 MinIO deployment and full path to the bucket or bucket prefix for which to list the replication rules. For example:

mc replicate ls myminio/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, mc replicate ls defaults to showing all replication rules.

Global Flags

--debug

Optional

Enables verbose output to the console.

For example:

mc --debug COMMAND

--config-dir: Optional
The path to a JSON formatted configuration file that mc uses for storing data. See Configuration File for more information on how mc uses the configuration file.

--JSON

Optional

Enables JSON lines formatted output to the console.

For example:

mc --JSON COMMAND

--no-color: Optional
Disables the built-in color theme for console output. Useful for dumb terminals.

--quiet: Optional
Suppresses console output.

--insecure: Optional
Disables TLS/SSL certificate verification. Allows TLS connectivity to servers with invalid certificates. Exercise caution when using this option against untrusted S3 hosts.

--version: Optional
Displays the current version of mc.

--help: Optional
Displays a summary of command usage on the terminal.

Examples

List Existing Replication Rules

Use mc replicate ls to list bucket replication rules:

mc replicate ls ALIAS/PATH

Replace ALIAS with the alias of the MinIO deployment.
Replace PATH with the path to the bucket or bucket prefix.

Behavior

S3 Compatibility

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