Documentation

mc replicate status

The mc replicate status command displays the replication status of a MinIO bucket. The status also lists the remote target path or location.

The following command displays the current replication status of the mydata bucket on the myminio MinIO deployment:

mc replicate status myminio/mydata

The command has the following syntax:

mc [GLOBALFLAGS] replicate status TARGET
                           [--limit-upload value]
                           [--limit-download value]
  • 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.

Required

The alias of the MinIO deployment and full path to the bucket or bucket prefix for which to display the replication status. For example:

mc replicate status myminio/mybucket
Optional

Limit download rates to no more than a specified rate in KiB/s, MiB/s, or GiB/s. Valid units include:

  • B for bytes

  • K for kilobytes

  • G for gigabytes

  • T for terabytes

  • Ki for kibibytes

  • Gi for gibibytes

  • Ti for tebibytes

For example, to limit download rates to no more than 1 GiB/s, use the following:

--limit-download 1G

If not specified, MinIO uses an unlimited download rate.

Optional

Limit upload rates to no more than the specified rate in KiB/s, MiB/s, or GiB/s. Valid units include:

  • B for bytes

  • K for kilobytes

  • G for gigabytes

  • T for terabytes

  • Ki for kibibytes

  • Gi for gibibytes

  • Ti for tebibytes

For example, to limit upload rates to no more than 1 GiB/s, use the following:

--limit-upload 1G

If not specified, MinIO uses an unlimited upload rate.

This command supports any of the global flags.

Use mc replicate status to show bucket replication status:

mc replicate status ALIAS/PATH
  • Replace ALIAS with the alias of the MinIO deployment.

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

Changed in version mc: RELEASE.2023-03-20T17-17-53Z

The standard output of this command does not display ARNs previously removed from a replication configuration.

To list all ARNs, including ARNs no longer part of the replication, use the --json flag. The json output continues to show data replicated under old ARNs. This may be valuable if an ARN was removed and re-added for the same bucket.

New ARNs do not cause re-replication of previously synced objects.