MinIO Client on SILO

mc alias list

Mon, 01 Jan 0001 00:00:00 +0000

Syntax

The mc alias list command lists all aliases in the local mc configuration.

The command output includes the configured access key and secret key associated to each alias.

The following command lists all aliases configured on the local host machine:

mc alias list

The mc alias list command has the following syntax:

mc anonymous set

Mon, 01 Jan 0001 00:00:00 +0000

Syntax

The mc anonymous set command sets anonymous (i.e. unauthenticated or public) access policies for a bucket.

Buckets with anonymous policies allow clients to access the bucket contents and perform actions consistent with the specified policy without authentication.

To set anonymous bucket policies using an IAM JSON policy, use the mc anonymous set-json command.

The following command sets anonymous access policies for several buckets on the myminio MinIO deployment:

mc batch cancel

Mon, 01 Jan 0001 00:00:00 +0000

Added: mc

RELEASE.2023-03-20T17-17-53Z

Syntax

The mc batch cancel stops an ongoing batch job.

You must specify the job ID. To find the job ID, use mc batch list.

The following command outputs the job definition for the job identified as KwSysDpxcBU9FNhGkn2dCf.

mc batch cancel myminio KwSysDpxcBU9FNhGkn2dCf

The command has the following syntax:

mc encrypt clear

Mon, 01 Jan 0001 00:00:00 +0000

Syntax

The mc encrypt clear command removes the current default encryption settings for a bucket.

The following command removes the default encryption settings for the mydata bucket on the MinIO deployment associated with the myminio alias:

mc encrypt clear myminio/mydata

The command has the following syntax:

mc [GLOBALFLAGS] encrypt clear 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.

mc event add

Mon, 01 Jan 0001 00:00:00 +0000

Syntax

The mc event add command adds event notification triggers to a bucket.

MinIO automatically sends triggered events to the configured notification target.

The following command creates a new event notification trigger for all PUT and DELETE operations for the mydata bucket on the myminio MinIO deployment:

mc event add --event "put,delete" myminio/mydata arn:aws:sqs::primary:target

The specified ARN corresponds to a configured bucket notification target on the myminio deployment.

mc idp ldap accesskey disable

Mon, 01 Jan 0001 00:00:00 +0000

Description

mc idp ldap accesskey disable disables the specified access key on the MinIO deployment.

The following example disables the access key mykey on the minio deployment:

mc idp ldap accesskey disable minio mykey

The command has the following syntax:

mc [GLOBALFLAGS] idp ldap accesskey disable \
 ALIAS \
 KEY

Replace ALIAS with the alias of a MinIO deployment configured for AD/LDAP integration.

mc idp ldap add

Mon, 01 Jan 0001 00:00:00 +0000

Description

The mc idp ldap add command creates an AD/LDAP IDP server configuration.

MinIO supports no more than one (1) AD/LDAP provider per deployment.

The following example sets the AD/LDAP configuration settings for the myminio deployment.

mc idp ldap add \
 myminio \
 server_addr=myldapserver:636 \
 lookup_bind_dn=cn=admin,dc=min,dc=io \
 lookup_bind_password=somesecret \
 user_dn_search_base_dn=dc=min,dc=io \
 user_dn_search_filter="(uid=%s)" \
 group_search_base_dn=ou=swengg,dc=min,dc=io \
 group_search_filter="(&(objectclass=groupofnames)(member=%d))"

The command has the following syntax:

mc idp ldap policy attach

Mon, 01 Jan 0001 00:00:00 +0000

Description

The mc idp ldap policy attach command attaches one or more polices to an entity.

The following example attaches the policy userpolicy to the user bobfisher on the myminio deployment:

mc idp ldap policy attach myminio \
 userpolicy \
 --user='uid=bobfisher,ou=people,ou=hwengg,dc=min,dc=io'

The command has the following syntax:

mc [GLOBALFLAGS] idp ldap policy attach \
 POLICYNAME \
 [POLICY2] ... \
 ALIAS \
 [--user=`USER`] \
 [--group=`GROUP`]

Replace ALIAS with the alias of a MinIO deployment to configure for AD/LDAP integration.

mc ilm restore

Mon, 01 Jan 0001 00:00:00 +0000

Syntax

The mc ilm restore command creates a temporary copy of an object archived on a remote tier. The copy automatically expires after 1 day by default.

Use this command to allow applications to access a tiered object through the MinIO deployment (e.g. “hot tier”). The archived object remains on the remote tier, while the temporary copy becomes HEAD for that object.

Added: mc

RELEASE.2023-04-12T02-21-51Z

Use mc stat to display whether a restored object reads from the local temporary copy or the remote tier. Objects currently in the process of restoration from the remote tier show a status of Ongoing : true.

mc ilm rule add

Mon, 01 Jan 0001 00:00:00 +0000

Changed: RELEASE.2022-12-24T15-21-38Z

mc ilm rule rm replaces mc ilm add.

Syntax

The mc ilm rule add command adds an object lifecycle management rule to a bucket.

The command supports adding both Transition (Tiering) and Expiration lifecycle management rules.

The following command adds new lifecycle management rules to the mydata bucket on the myminio deployment:

mc ilm tier add

Mon, 01 Jan 0001 00:00:00 +0000

Changed: RELEASE.2022-12-24T15-21-38Z

mc ilm tier add replaces mc admin tier add.

Description

The mc ilm tier add command creates a new remote storage tier to a supported storage services.

See Object Transition for a complete list.

Supported S3 Services

mc ilm tier add supports only the following S3-compatible services as a remote target for object tiering:

MinIO
Amazon S3
Google Cloud Storage
Azure Blob Storage

Permissions

MinIO requires the following administrative permissions on the cluster in which you create remote tiers for object transition lifecycle management rules:

mc legalhold clear

Mon, 01 Jan 0001 00:00:00 +0000

Syntax

The mc legalhold clear command removes the current legal hold setting for an object or objects.

Removing the legal hold on object(s) does not remove any other GOVERNANCE Mode and COMPLIANCE Mode retention settings in place for the object(s)

The following command removes the legal hold on all objects in the mydata bucket on the myminio MinIO deployment:

mc license info

Mon, 01 Jan 0001 00:00:00 +0000

Description

The mc license info command displays information about the MinIO deployment’s license status. Specifically, whether the deployment uses the AGPLv3 Open Source license of the MinIO Commercial License.

You must register your deployment with MinIO MinIO SUBNET to activate your commercial license.

For example, the command returns the following information for an unregistered deployment:

You are using GNU AFFERO GENERAL PUBLIC LICENSE Version 3 (https://www.gnu.org/licenses/agpl-3.0.txt)

If you are building proprietary applications, you may want to choose the commercial license
included as part of the Standard and Enterprise subscription plans. (https://min.io/signup?ref=mc)

Applications must otherwise comply with all the GNU AGPLv3 License & Trademark obligations.

Use mc license register to associate your deployment with your SUBNET account. If you are not already signed up for SUBNET, see the Registration page.

mc replicate add

Mon, 01 Jan 0001 00:00:00 +0000

Changed: RELEASE.2022-12-24T15-21-38Z

mc replicate add replaces the mc admin bucket remote add command.

MinIO automatically creates remote targets based on a given file path or resource location (such as an IP or DNS address). Users defining a remote target no longer need to determine an ARN for the remote bucket.

Syntax

The mc replicate add command creates a new server-side replication rule for a bucket on a MinIO deployment.

mc retention set

Mon, 01 Jan 0001 00:00:00 +0000

Syntax

The mc retention set command configures the Write-Once Read-Many (WORM) locking settings for an object or object(s) in a bucket. You can also set the default object lock settings for a bucket, where all objects without explicit object lock settings inherit the bucket default.

To lock an object under legal hold, use mc legalhold set.

mc retention set requires that the specified bucket has object locking enabled. You can only enable object locking at bucket creation. See mc mb --with-lock for documentation on creating buckets with object locking enabled.

mc share download

Mon, 01 Jan 0001 00:00:00 +0000

Syntax

The mc share download command generates a temporary presigned URL with integrated access credentials for downloading objects from a MinIO bucket. The temporary URL expires after a configurable time limit.

Applications can perform a GET to retrieve the object from the URL.
Users can open the URL in a browser to download the object.

For more information on shareable object URLs, see the Amazon S3 documentation on Pre-Signed URLs.

mc support callhome

Mon, 01 Jan 0001 00:00:00 +0000

Description

The mc support callhome command allows the enabling or disabling of diagnostic information from a deployment to MinIO SUBNET.

All mc support commands require an active SUBNET subscription.

When enabled, MinIO sends diagnostic information to SUBNET.

MinIO disables this functionality by default, regardless of registration status. You must explicitly enable the callhome function to begin information upload.

SUBNET Registration Required

The mc support commands are designed for MinIO deployments registered with MinIO SUBNET to ensure optimal outcome of diagnostics and performance testing. Deployments not registered with SUBNET cannot use the mc support commands.

mc support top api

Mon, 01 Jan 0001 00:00:00 +0000

SUBNET Registration Required

Syntax

The mc support top api command summarizes the real-time API events on a MinIO deployment server.

The following command displays the current in-progress S3 API calls on the alias myminio.

mc tag set

Mon, 01 Jan 0001 00:00:00 +0000

Syntax

The mc tag set command sets one or more tags to a bucket or object.

MinIO supports adding up to 10 custom tags to an object.

The following command sets tags for the mydata bucket on the myminio MinIO deployment:

mc tag set myminio/mydata "tag1=value1&tag2=value2"

The command has the following syntax:

mc version enable

Mon, 01 Jan 0001 00:00:00 +0000

Syntax

The mc version enable command enables versioning on the specified bucket.

The following command enables versioning for the mybucket bucket on the myminio MinIO deployment:

 mc version enable myminio/mybucket

The command has the following syntax:

mc [GLOBALFLAGS] version enable ALIAS \
 --exclude-folders \
 --excluded-prefixes

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.

MinIO Client Settings

Mon, 01 Jan 0001 00:00:00 +0000

This page covers settings for the MinIO Client.

You can establish or modify settings by defining:

an environment variable on the host system prior to starting or restarting the MinIO Server. Refer to your operating system’s documentation for how to define an environment variable.
a configuration setting using mc admin config set.

If you define both an environment variable and the similar configuration setting, MinIO uses the environment variable value.

Some settings have only an environment variable or a configuration setting, but not both.

mc alias remove

Mon, 01 Jan 0001 00:00:00 +0000

Syntax

The mc alias remove removes an existing alias from the local mc configuration.

The following command removes the myminio alias for a MinIO deployment from the host machine:

mc alias remove myminio

The mc alias remove command has the following syntax:

mc [GLOBALFLAGS] alias remove 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.

mc anonymous get

Mon, 01 Jan 0001 00:00:00 +0000

Syntax

The mc anonymous get command gets the anonymous (i.e. unauthenticated or public) access policies for a bucket.

Buckets with anonymous policies allow clients to access the bucket contents and perform actions consistent with the specified policy without authentication.

To get the JSON policy assigned to the bucket, use the mc anonymous get-json command.

The following command retrieves the anonymous access policy for the mydata bucket on the myminio MinIO deployment:

mc batch describe

Mon, 01 Jan 0001 00:00:00 +0000

Changed: MinIO

RELEASE.2022-10-08T20-11-00Z or later

Syntax

The mc batch describe command outputs the job definition for a specified job ID.

You must specify the job ID. To find the job ID, use mc batch list.

The following command outputs the job definition for the job identified as KwSysDpxcBU9FNhGkn2dCf.

mc batch describe myminio KwSysDpxcBU9FNhGkn2dCf

The command has the following syntax:

mc encrypt info

Mon, 01 Jan 0001 00:00:00 +0000

Syntax

The mc encrypt info command returns the current default encryption settings for a bucket.

The following command returns the default encryption setting for the mydata bucket on the myminio MinIO deployment.

mc encrypt info myminio/mydata

The command has the following syntax:

mc [GLOBALFLAGS] encrypt info 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.

mc event ls

Mon, 01 Jan 0001 00:00:00 +0000

Syntax

The mc event ls command lists all event notification triggers for a bucket.

The alias mc event list has equivalent functionality to mc event ls.

The following command lists all configured event notifications for the specified bucket notification target for the mydata bucket on the myminio MinIO deployment:

mc event ls myminio myminio/mydata arn:aws:sqs::primary:target

The command has the following syntax:

mc idp ldap accesskey edit

Mon, 01 Jan 0001 00:00:00 +0000

Description

mc idp ldap accesskey edit modifies the specified access key on the local server.

The following example modifies the secret for the access key mykey on the minio deployment:

mc idp ldap accesskey edit myminio/ mykey --secret-key 'xxxxxxx'

The command has the following syntax:

mc [GLOBALFLAGS] idp ldap accesskey rm \
 ALIAS \
 KEY \
 [--secret-key <string>] \
 [--policy <string>] \
 [--name <string>] \
 [--description <string>] \
 [--expiry-duration <string>] \
 [--expiry <string>]

Replace ALIAS with the alias of a MinIO deployment configured for AD/LDAP integration.

mc idp ldap disable

Mon, 01 Jan 0001 00:00:00 +0000

Description

The mc idp ldap disable command disables the currently configured AD/LDAP provider.

The following example disables the AD/LDAP configurations on the myminio deployment.

mc idp ldap disable \
 myminio

The command has the following syntax:

mc [GLOBALFLAGS] idp ldap disable \
 ALIAS

Replace ALIAS with the alias of a MinIO deployment to disable the AD/LDAP integration.

mc idp ldap policy detach

Mon, 01 Jan 0001 00:00:00 +0000

Description

The mc idp ldap policy detach command detaches one or more polices from an entity.

The following example detaches the policy userpolicy from the user bobfisher on the myminio deployment.

mc idp ldap policy detach myminio \
 userpolicy \
 --user='uid=bobfisher,ou=people,ou=hwengg,dc=min,dc=io'

The command has the following syntax:

mc [GLOBALFLAGS] idp ldap policy detach \
 POLICYNAME \
 [POLICY2] ... \
 ALIAS \
 [--user=`USER`] \
 [--group=`GROUP`]

Replace ALIAS with the alias of a MinIO deployment to configure for AD/LDAP integration.

mc ilm rule edit

Mon, 01 Jan 0001 00:00:00 +0000

Changed: RELEASE.2022-12-24T15-21-38Z

mc ilm rule edit replaces mc ilm edit.

Syntax

The mc ilm rule edit command modifies an existing object lifecycle management rule on a MinIO bucket.

The following command modifies existing lifecycle management rules for the mydata bucket on the myminio deployment:

mc ilm rule edit --id "c79ntj94b0t6rukh6lr0" --expiry-days 90 myminio/mydata

mc ilm rule edit --id "c79nu2p4b0t6qko19rgg" --expired-object-delete-marker myminio/mydata

mc ilm rule edit --id "c79n19dn10dnab109fg1" --transition-days 30 --tier "COLDTIER"

The command modifies the specified rules as follows:

mc ilm tier check

Mon, 01 Jan 0001 00:00:00 +0000

Description

The mc ilm tier check command displays the configuration for remote tier on a deployment.

Syntax

The command has the following syntax:

The following example displays the configuration for an existing remote tier called WARM-TIER on the myminio deployment.

 mc ilm tier check myminio WARM-TIER

The command has the following syntax:

mc legalhold info

Mon, 01 Jan 0001 00:00:00 +0000

Syntax

The mc legalhold info command returns the current legal hold setting for an object or objects.

mc legalhold requires that the specified bucket has object locking enabled. You can only enable object locking at bucket creation. See mc mb --with-lock for documentation on creating buckets with object locking enabled.

The following command retrieves the current legalhold status for objects in the mydata bucket on the myminio MinIO deployment:

mc license register

Mon, 01 Jan 0001 00:00:00 +0000

Important

mc license register requires MinIO Client version RELEASE.2023-11-20T16-30-59Z or later. While not strictly required, best practice keeps the MinIO Client version in alignment with the MinIO Server version.

Description

The mc license register command connects your deployment with your MinIO SUBNET account.

After registration, you can upload deployment health reports directly to SUBNET using the mc support diag command.

The following example registers the minio alias with MinIO SUBNET:

mc replicate backlog

Mon, 01 Jan 0001 00:00:00 +0000

Changed: mc.RELEASE.2023-07-18T21-05-38Z

mc replicate diff has been renamed mc replicate backlog. No functionality has changed.

Description

The mc replicate backlog shows a list of unreplicated new or deleted objects.

You can list the replication status of objects for a particular remote target. To do so, you must have the ARN of the remote target. You can use retrieve the remote targets configured for a bucket to find the ARN.

mc retention info

Mon, 01 Jan 0001 00:00:00 +0000

Syntax

The mc retention info command configures the Write-Once Read-Many (WORM) locking settings for an object or object(s) in a bucket. You can also set the default object lock settings for a bucket, where all objects without explicit object lock settings inherit the bucket default.

To lock an object under legal hold, use mc legalhold set.

mc retention info requires that the specified bucket has object locking enabled. You can only enable object locking at bucket creation. See mc mb --with-lock for documentation on creating buckets with object locking enabled.

mc share upload

Mon, 01 Jan 0001 00:00:00 +0000

Syntax

The mc share upload command generates a temporary presigned URL with integrated access credentials for uploading objects to a MinIO bucket. The temporary URL expires after a configurable time limit.

Applications can perform a PUT to upload an object using the URL.

For more information on shareable object URLs, see the Amazon S3 documentation on Pre-Signed URLs.

The following command generates a new presigned upload URL for the mydata bucket on the myminio MinIO deployment:

mc support diag

Mon, 01 Jan 0001 00:00:00 +0000

SUBNET Registration Required

Command History

The command used to create the diagnostic report has changed over time.

MinIO Client Release	Command	Notes
RELEASE.2022-02-13T23-26-13Z	`mc support diag`	Command moved to `mc support`
RELEASE.2020-11-17T00-39-14Z	`mc admin subnet health`	Command made a SUBNET subcommand
RELEASE.2020-10-03T02-54-56Z	`mc admin health`	Command renamed to health
Original Command	`mc admin obd`	Command renamed `mc admin health`

Description

The mc support diag command generates a health report for a MinIO deployment.

mc support top locks

Mon, 01 Jan 0001 00:00:00 +0000

SUBNET Registration Required

Syntax

The mc support top locks command lists the ten oldest locks on a MinIO deployment.

The command outputs the age of the lock, type of lock, owner, and resource. The output resembles the following:

mc tag list

Mon, 01 Jan 0001 00:00:00 +0000

Syntax

The mc tag list command lists all tags from a bucket or object.

The following command lists tags for the mydata bucket on the myminio MinIO deployment:

mc tag list myminio/mydata

The command has the following syntax:

mc [GLOBALFLAGS] tag set \
 [--rewind "string"] \
 [--versions] \
 [--version-id "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.

mc version info

Mon, 01 Jan 0001 00:00:00 +0000

Syntax

The mc version info command returns the versioning status for the specified bucket.

The following command returns the versioning status for the mybucket bucket on the myminio MinIO deployment:

mc version info myminio/mybucket

The command has the following syntax:

mc [GLOBALFLAGS] version info 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.

mc alias set

Mon, 01 Jan 0001 00:00:00 +0000

Syntax

The mc alias set command adds or updates an alias to the local mc configuration.

The following command adds an alias for a MinIO deployment myminio running at the URL https://myminio.example.net. mc uses the specified username and password for authenticating to the MinIO deployment:

mc alias set myminio https://myminio.example.net minioadminuser minioadminpassword

If the myminio alias already exists, the command overwrites that alias with the new URL, access key, and secret key.

mc anonymous list

Mon, 01 Jan 0001 00:00:00 +0000

Syntax

The mc anonymous list retrieves all anonymous (i.e. unauthenticated or public) access policies for a bucket.

Buckets with anonymous policies allow clients to access the bucket contents and perform actions consistent with the specified policy without authentication.

The following command lists all anonymous access policies for the mydata bucket on the myminio MinIO deployment:

mc batch generate

Mon, 01 Jan 0001 00:00:00 +0000

Changed: MinIO

RELEASE.2022-10-08T20-11-00Z or later

Syntax

The mc batch generate command creates a basic YAML-formatted template file for the specified job type.

After MinIO creates the file, open it in your preferred text editor tool to further customize. You can define one job task definition per batch file.

See job types for the supported jobs you can generate.

The following command creates a basic YAML file for a replicate job on the mybucket bucket of the myminio alias.

mc encrypt set

Mon, 01 Jan 0001 00:00:00 +0000

Syntax

The mc encrypt set encrypt command sets or updates the default bucket Server-Side Encryption (SSE) mode. MinIO automatically encrypts objects written to that bucket using the specified SSE mode.

mc encrypt set only supports SSE-KMS and SSE-S3.

The following command sets the default SSE-KMS encryption key for the bucket mydata on the myminio MinIO deployment:

mc encrypt set sse-kms "minio-encryption-key" myminio/mydata

The command has the following syntax:

mc event rm

Mon, 01 Jan 0001 00:00:00 +0000

Syntax

The mc event rm command removes an event notification trigger from a bucket.

The mc event remove command has equivalent functionality to mc event rm.

The following command removes a configured event notifications for the specified bucket notification target for the mydata bucket on the myminio MinIO deployment:

mc event rm myminio/mydata arn:aws:sqs::primary:target

The command has the following syntax:

mc idp ldap accesskey enable

Mon, 01 Jan 0001 00:00:00 +0000

Description

The mc idp ldap accesskey enable enables the specified access key on the local server.

The following example enables the access key mykey from the minio deployment:

mc idp ldap accesskey enable minio/ mykey

The command has the following syntax:

mc [GLOBALFLAGS] idp ldap accesskey enable \
 ALIAS \
 KEY

Replace ALIAS with the alias of a MinIO deployment configured for AD/LDAP integration.

mc idp ldap enable

Mon, 01 Jan 0001 00:00:00 +0000

Description

The mc idp ldap enable command enables the currently configured AD/LDAP provider.

The following example enables the AD/LDAP configurations on the myminio deployment.

mc idp ldap enable \
 myminio

The command has the following syntax:

mc [GLOBALFLAGS] idp ldap enable \
 ALIAS

Replace ALIAS with the alias of a MinIO deployment to enable the AD/LDAP integration.

mc idp ldap policy entities

Mon, 01 Jan 0001 00:00:00 +0000

Description

The mc idp ldap policy entities command displays a list of mappings for a user, group, and/or policy.

The following example lists all mappings for a specific policy, a set of groups, and a selection of users on the myminio deployment.

Specifically, it lists:

Users mapped to the finteam-policy policy.
Policies assigned to the uid=bobfisher,ou=people,ou=hwengg,dc=min,dc=io user.
Policies assigned to the cn=projectb,ou=groups,ou=swengg,dc=min,dc=io group.

mc idp ldap policy entities myminio \
 --policy finteam-policy \
 --user 'uid=bobfisher,ou=people,ou=hwengg,dc=min,dc=io' \
 --group 'cn=projectb,ou=groups,ou=swengg,dc=min,dc=io'

The command has the following syntax:

mc ilm rule export

Mon, 01 Jan 0001 00:00:00 +0000

Changed: 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 tier info

Mon, 01 Jan 0001 00:00:00 +0000

Description

The mc ilm tier info command outputs statistics about a tier or all tiers for a deployment.

Required Permissions

MinIO requires the following permissions scoped to to the bucket or buckets for which you are creating lifecycle management rules.

MinIO also requires the following administrative permissions on the cluster in which you are creating remote tiers for object transition lifecycle management rules:

For example, the following policy provides permission for configuring object transition lifecycle management rules on any bucket in the cluster:.

mc legalhold set

Mon, 01 Jan 0001 00:00:00 +0000

Syntax

The mc legalhold set command enables legal hold Write-Once Read-Many (WORM) object locking on an object or objects.

The following command enables legalhold WORM locking on all existing objects in the mydata bucket on the myminio MinIO deployment:

mc license update

Mon, 01 Jan 0001 00:00:00 +0000

Description

Use the mc license update command to replace a license key for a deployment.

For deployments registered for MinIO SUBNET, MinIO automatically checks for and updates the license every month.

Examples

Update the License Key for a Deployment with Alias `minio1`

mc license update minio1 license.key

Syntax

The command has the following syntax:

mc [GLOBALFLAGS] license update \
 ALIAS \
 [LICENSE-FILE-WITH-PATH] \
 [--airgap]

Parameters

`ALIAS`

mc-cmd

Required

The alias of the MinIO deployment.

mc replicate ls

Mon, 01 Jan 0001 00:00:00 +0000

Changed: RELEASE.2022-12-24T15-21-38Z

mc replicate ls replaces the mc admin bucket remote ls command.

Syntax

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

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

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

mc retention clear

Mon, 01 Jan 0001 00:00:00 +0000

Syntax

The mc retention clear command removes the Write-Once Read-Many (WORM) locking settings for an object or object(s) in a bucket. You can also remove the default object lock settings for a bucket.

To change the retention status of an object under legal hold, use mc legalhold clear.

The following command removes the default object lock configuration for the mydata bucket on the myminio MinIO deployment:

mc share ls

Mon, 01 Jan 0001 00:00:00 +0000

Syntax

The mc share ls command displays any unexpired presigned URLs generated by mc share upload or mc share download

The mc share list command has equivalent functionality to mc share ls.

Applications can perform a PUT to retrieve the object from the URL.

For more information on shareable object URLs, see the Amazon S3 documentation on Pre-Signed URLs.

The following command lists all upload and download presigned URLs respectively for the mydata bucket on the myminio MinIO deployment:

mc support inspect

Mon, 01 Jan 0001 00:00:00 +0000

SUBNET Registration Required

Description

The mc support inspect command collects the data and metadata associated to objects at the specified path.

MinIO assembles this data from each backend drive storing an erasure shard for each specified object. The command produces an encrypted zip file that includes all matching files with their respective host+drive+path.

mc support top disk

Mon, 01 Jan 0001 00:00:00 +0000

SUBNET Registration Required

Syntax

The mc support top disk command displays current drive statistics.

The following command displays the current in-progress S3 API calls on the alias myminio.

mc tag remove

Mon, 01 Jan 0001 00:00:00 +0000

Syntax

The mc tag remove command removes all tags from a bucket or object.

The following command removes tags for the mydata bucket on the myminio MinIO deployment:

mc tag remove myminio/mydata

The command has the following syntax:

mc [GLOBALFLAGS] tag remove \
 [--rewind "string"] \
 [--versions] \
 [--version-id "string"]* \

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.

mc version suspend

Mon, 01 Jan 0001 00:00:00 +0000

Syntax

The mc version suspend command disables versioning on the specified bucket.

The following command disables versioning for the mybucket bucket on the myminio MinIO deployment:

mc version suspend myminio/mybucket

The command has the following syntax:

mc [GLOBALFLAGS] version suspend 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.

mc alias import

Mon, 01 Jan 0001 00:00:00 +0000

Syntax

The mc alias import command imports an alias configuration from a JSON document.

You can use mc alias export to create the necessary JSON for import.

The following command imports an alias configuration from a JSON document:

mc alias import newalias ./credentials.json

Use mc alias list newalias to confirm the import succeeded.

The mc alias import command has the following syntax:

mc anonymous links

Mon, 01 Jan 0001 00:00:00 +0000

Syntax

The mc anonymous links retrieves the HTTP URL for anonymous (i.e. unauthenticated or public) access to a bucket.

Buckets with anonymous policies allow clients to access the bucket contents and perform actions consistent with the specified policy without authentication.

The following command retrieves HTTP URLs for the mydata bucket on the myminio MinIO deployment:

mc batch list

Mon, 01 Jan 0001 00:00:00 +0000

Changed: MinIO

RELEASE.2022-10-08T20-11-00Z or later

Syntax

The mc batch list command outputs a list of the batch jobs currently in progress on a deployment.

The following command outputs a list of all jobs currently in progress on the myminio alias.

mc batch list myminio

The command has the following syntax:

mc idp ldap accesskey info

Mon, 01 Jan 0001 00:00:00 +0000

Description

The mc idp ldap accesskey info outputs information about the specified access key(s).

This command works against access keys created by an AD/LDAP user after authenticating to MinIO.

Create AD/LDAP service accounts with the mc idp ldap accesskey create command.

MinIO supports using AssumeRoleWithLDAPIdentity to generate temporary access keys using the Security Token Service.

The following example outputs details for the access key mykey from the minio deployment:

mc idp ldap info

Mon, 01 Jan 0001 00:00:00 +0000

Description

The mc idp ldap info command outputs the current configuration for an AD/LDAP provider on a specified MinIO deployment.

The following example outputs the AD/LDAP configuration settings on the myminio deployment.

mc idp ldap info \
 myminio

The command has the following syntax:

mc [GLOBALFLAGS] idp ldap info \
 ALIAS

Replace ALIAS with the alias of a MinIO deployment to retrieve info on the AD/LDAP integration.

mc ilm rule import

Mon, 01 Jan 0001 00:00:00 +0000

Changed: RELEASE.2022-12-24T15-21-38Z

mc ilm rule import replaces mc ilm import.

Syntax

The mc ilm rule import command imports an object lifecycle management configuration and applies it to a MinIO bucket.

The mc ilm rule import command imports from STDIN by default. You can input the contents from a .json file, such as one produced by mc ilm rule export.

The following command imports the lifecycle management configuration from mydata-lifecycle-config.json and applies it to the mydata bucket on the myminio deployment:

mc ilm tier ls

Mon, 01 Jan 0001 00:00:00 +0000

Changed: RELEASE.2022-12-24T15-21-38Z

mc ilm tier ls replaces mc admin tier ls.

Description

The mc ilm tier ls command shows the remote tiers configured on a deployment.

The mc ilm tier list command has equivalent functionality to mc ilm tier ls.

Syntax

The command has the following syntax:

The following example outputs a list of the existing remote tiers on the myminio deployment.

mc replicate update

Mon, 01 Jan 0001 00:00:00 +0000

Changed: RELEASE.2022-12-24T15-21-38Z

mc replicate update replaces the mc admin bucket remote update command.

Changed: RELEASE.2022-11-07T23-47-39Z

mc replicate update replaces the mc replicate edit command.

Syntax

The mc replicate update command modifies an existing bucket replication rule.

mc [GLOBALFLAGS] replicate update FLAGS [FLAGS] ARGUMENTS [ARGUMENTS]

The following command modifies an existing replication rule for the mydata bucket on the myminio MinIO deployment:

mc support perf

Mon, 01 Jan 0001 00:00:00 +0000

Changed: RELEASE.2022-07-24T02-25-13Z

mc support perf replaces the mc admin speedtest command.

SUBNET Registration Required

Description

Use the mc support perf command to review the performance of the S3 API (read/write), network IO, and storage (drive read/write).

mc support top net

Mon, 01 Jan 0001 00:00:00 +0000

SUBNET Registration Required

Syntax

The mc support top net command displays realtime network metrics.

The following command displays the current realtime network metrics for the alias myminio deployment.

mc alias export

Mon, 01 Jan 0001 00:00:00 +0000

Added: mc.RELEASE.2023-11-15T22-45-58Z

Syntax

The mc alias export command exports an alias configuration from the existing configuration.

The command outputs the result to STDOUT where you can either capture the output as a file or perform further modifications to the output as necessary.

Use the mc alias import command to import the resulting JSON configuration.

The following command exports an alias configuration from the existing host and outputs it to a file:

mc anonymous get-json

Mon, 01 Jan 0001 00:00:00 +0000

Syntax

The mc anonymous get-json command gets anonymous (i.e. unauthenticated or public) access policies for a bucket.

Buckets with anonymous policies allow clients to access the bucket contents and perform actions consistent with the specified policy without authentication.

The following command retrieves the JSON-formatted anonymous policy for the mydata bucket on the myminio MinIO deployment:

mc batch start

Mon, 01 Jan 0001 00:00:00 +0000

Changed: MinIO

RELEASE.2022-10-08T20-11-00Z or later

Syntax

The mc batch start command launches a batch job from a job batch YAML file.

The batch job runs to completion (or up to the number of retries specified in the file) one time. To run the batch job again after completion, you must start it again.

The following command creates a basic YAML file for a replicate job on the mybucket bucket of the myminio alias.

mc cat

Mon, 01 Jan 0001 00:00:00 +0000

Syntax

The mc cat command concatenates the contents of a file or object to another file or object. You can also use the command to display the contents of the specified file or object to STDOUT. cat has similar functionality to cat.

The following command concatenates the contents of an object on a MinIO deployment to STDOUT:

mc idp ldap accesskey ls

Mon, 01 Jan 0001 00:00:00 +0000

Description

The mc idp ldap accesskey ls displays a list of LDAP access key pairs.

mc idp ldap accesskey ls is also known as mc idp ldap accesskey list.

This command works against access keys created by an AD/LDAP user after authenticating to MinIO.

Create AD/LDAP service accounts with the mc idp ldap accesskey create command.

MinIO supports using AssumeRoleWithLDAPIdentity to generate temporary access keys using the Security Token Service.

The following example returns a list of access keys associated with the authenticated user on the minio alias:

mc idp ldap ls

Mon, 01 Jan 0001 00:00:00 +0000

Description

The mc idp ldap ls command lists the existing set of configurations for an AD/LDAP provider.

mc idp ldap ls is also known as mc idp ldap list.

The following example lists the AD/LDAP configuration settings for the myminio deployment.

mc idp ldap ls \
 myminio

The command has the following syntax:

mc ilm rule ls

Mon, 01 Jan 0001 00:00:00 +0000

Changed: RELEASE.2022-12-24T15-21-38Z

mc ilm rule ls replaces mc ilm ls.

Changed: RELEASE.2023-05-26T23-31-54Z

mc ilm rule ls --json output includes the policy modification time in updateAt.

Syntax

The mc ilm rule ls command summarizes all configured object lifecycle management rules on a MinIO bucket in a tabular format.

The mc ilm rule list command has equivalent functionality to mc ilm rule ls.

The following command lists all lifecycle management rules for the mydata bucket on the myminio MinIO deployment:

mc ilm tier rm

Mon, 01 Jan 0001 00:00:00 +0000

Description

The mc ilm tier rm command removes an remote tier that has not been used to transition any objects.

The mc ilm tier remove command has equivalent functionality to mc ilm tier rm

Note

Once a tier has transitioned objects, it cannot be removed.

Required Permissions

MinIO requires the following permissions scoped to to the bucket or buckets for which you are creating lifecycle management rules.

MinIO also requires the following administrative permissions on the cluster in which you are creating remote tiers for object transition lifecycle management rules:

mc replicate resync

Mon, 01 Jan 0001 00:00:00 +0000

Syntax

The mc replicate resync command resynchronizes all objects in the specified MinIO bucket to a remote replication target.

This command requires first configuring the remote bucket target using the mc replicate add command. You must specify the resulting remote ARN as part of running mc replicate resync.

This command supports rebuilding a MinIO deployment using an active-active replication remote as the “backup” source. See the following tutorials for more information on active-active replication:

mc support profile

Mon, 01 Jan 0001 00:00:00 +0000

SUBNET Registration Required

Description

mc support profile runs a system profile for your deployment. The results of the profile can provide insight into the MinIO server process running on a given node.

The resulting report is intended for use by MinIO Engineering. You can upload the report to MinIO SUBNET. Independent or third-party use of these profiles for diagnostics and remediation is done at your own risk.

mc support top rpc

Mon, 01 Jan 0001 00:00:00 +0000

SUBNET Registration Required

Syntax

The mc support top rpc command displays metrics for remote procedure calls (RPC).

The following command displays the current remote procedure call metrics for the alias myminio deployment.

mc anonymous set-json

Mon, 01 Jan 0001 00:00:00 +0000

Syntax

The mc anonymous set-json command sets anonymous (i.e. unauthenticated or public) access policies for a bucket using using an IAM JSON policy document.

Buckets with anonymous policies allow clients to access the bucket contents and perform actions consistent with the specified policy without authentication.

The following command applies the JSON-formatted anonymous policy to the mydata bucket on the myminio MinIO deployment:

mc batch status

Mon, 01 Jan 0001 00:00:00 +0000

Changed: MinIO

RELEASE.2022-10-08T20-11-00Z or later

Syntax

The mc batch status command outputs summaries of job events on a MinIO server.

Changed: mc

RELEASE.2024-07-03T20-17-25Z

Batch status displays summaries for active, in-progress jobs or any batch job completed in the previous three (3) days.

The following command outputs the status of the specified job with JobID KwSysDpxcBU9FNhGkn2dCf currently in progress on the myminio alias.

mc cp

Mon, 01 Jan 0001 00:00:00 +0000

Syntax

The mc cp command copies objects to or from a MinIO deployment, where the source can MinIO or a local filesystem.

You can also use mc cp against the local filesystem to produce similar results to the cp commandline tool.

Note

mc cp only copies the latest version or the specified version of an object without any version information or modification date. To copy all versions, version information, and related metadata, use mc replicate add or mc admin replicate.

mc idp ldap accesskey rm

Mon, 01 Jan 0001 00:00:00 +0000

Description

The mc idp ldap accesskey rm deletes the specified access key from the local server.

mc idp ldap accesskey rm is also known as mc idp ldap accesskey remove.

This command works against access keys created by an AD/LDAP user after authenticating to MinIO.

Create AD/LDAP service accounts with the mc idp ldap accesskey create command.

MinIO supports using AssumeRoleWithLDAPIdentity to generate temporary access keys using the Security Token Service.

The following example deletes the access key mykey from the minio deployment:

mc idp ldap rm

Mon, 01 Jan 0001 00:00:00 +0000

Description

The mc idp ldap rm command removes the existing configuration for an AD/LDAP provider.

mc idp ldap rm is also known as mc idp ldap remove.

The following example removes the AD/LDAP provider settings for the myminio deployment.

mc idp ldap rm \
 myminio

The command has the following syntax:

mc ilm rule rm

Mon, 01 Jan 0001 00:00:00 +0000

Changed: RELEASE.2022-12-24T15-21-38Z

mc ilm rule rm replaces mc ilm rm.

Syntax

The mc ilm rule rm command removes an object lifecycle management rule from a MinIO Bucket.

The following command removes a single lifecycle management rule from the mydata bucket on the myminio MinIO deployment:

mc ilm rule rm --id "bgrt1ghju" myminio/mydata

The command has the following syntax:

mc ilm tier update

Mon, 01 Jan 0001 00:00:00 +0000

Changed: RELEASE.2022-12-24T15-21-38Z

mc ilm tier update replaces mc admin tier edit.

Description

The mc ilm tier update command modifies an existing configured remote tier.

Use mc admin on MinIO Deployments Only

MinIO does not support using mc admin commands with other S3-compatible services, regardless of their claimed compatibility with MinIO deployments.

Supported S3 Services

mc ilm tier supports only the following S3-compatible services as a remote target for object tiering:

mc replicate rm

Mon, 01 Jan 0001 00:00:00 +0000

Changed: RELEASE.2022-12-24T15-21-38Z

mc replicate rm replaces the mc admin bucket remote rm command. Removing the replication automatically removes the underlying remote target.

Syntax

The mc replicate rm command removes a replication rule from a MinIO bucket.

The mc replicate remove command has equivalent functionality to mc replicate rm.

mc [GLOBALFLAGS] replicate rm FLAGS [FLAGS] ALIAS

The following command removes the replication rule with specified id from the mydata bucket on the myminio MinIO deployment:

mc support proxy

Mon, 01 Jan 0001 00:00:00 +0000

Description

Use the mc support proxy command to configure a proxy to use to communicate with MinIO SUBNET.

Examples

Set a Proxy URL

Define the proxy URL to use when the deployment minio1 communicates to SUBNET. The proxy URL in the example is http://my.proxy.

mc support proxy set minio1 http://my.proxy

Remove the Proxy URL Configured for a Deployment

The following command removes the URL configured as the proxy for the alias minio1.

mc diff

Mon, 01 Jan 0001 00:00:00 +0000

Syntax

The mc diff mc computes the differences between two filesystem directories or MinIO buckets. mc diff lists only those objects which are missing or which differ in size. mc diff does not compare the contents of objects.

The following command computes the difference between an object on a local filesystem and an object in the mydata bucket on the myminio MinIO deployment:

mc idp ldap update

Mon, 01 Jan 0001 00:00:00 +0000

Description

The mc idp ldap update command modifies an existing set of configurations for an AD/LDAP provider.

The following example changes two of the AD/LDAP configuration settings for the myminio deployment.

mc idp ldap update \
 myminio \
 lookup_bind_dn=cn=admin,dc=min,dc=io \
 lookup_bind_password=somesecret

The command has the following syntax:

mc [GLOBALFLAGS] idp ldap update \
 ALIAS \
 [CFG_PARAM1] \
 [CFG_PARAM2]...

Replace ALIAS with the alias of a MinIO deployment to update for AD/LDAP integration.

mc replicate status

Mon, 01 Jan 0001 00:00:00 +0000

Syntax

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 du

Mon, 01 Jan 0001 00:00:00 +0000

Syntax

The mc du command summarizes the disk usage of buckets and folders. You can also use du against the local filesystem to produce similar results as the du command.

The following command prints the disk usage of the mybucket bucket on the myminio MinIO deployment:

mc du play/mybucket

The output resembles the following:

mc replicate export

Mon, 01 Jan 0001 00:00:00 +0000

Syntax

The mc replicate export command exports the JSON-formatted replication rules for a MinIO bucket to STDOUT.

The following command exports the replication configuration for the mydata bucket on the myminio MinIO deployment:

mc replicate export myminio/mydata > mydata-replication.json

The command has the following syntax:

mc [GLOBALFLAGS] 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.

mc support upload

Mon, 01 Jan 0001 00:00:00 +0000

Description

mc support upload copies a file from the local file system to a SUBNET ticket.

SUBNET Registration Required

Syntax

The mc support profile command has the following syntax:

mc [GLOBALFLAGS] support profile \
 ALIAS \
 FILE \
 [--comment "string"] \
 [--enc] \
 [--issue integer]

Parameters

`ALIAS`

mc-cmd

mc replicate import

Mon, 01 Jan 0001 00:00:00 +0000

Syntax

The mc replicate import command imports JSON-formatted replication rules for a MinIO bucket from STDIN.

The following command imports the replication configuration for the mydata bucket on the myminio MinIO deployment:

mc replicate import myminio/mydata < mydata-replication.json

The command has the following syntax:

mc [GLOBALFLAGS] import 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.

mc find

Mon, 01 Jan 0001 00:00:00 +0000

Syntax

The mc find command supports searching for objects on a MinIO deployment. You can also use the command to search for files on a filesystem.

The following command searches for all objects matching the specified pattern in the mydata bucket on the myminio MinIO deployment:

mc find myminio/mydata --name "*.jpg"

The command has the following syntax:

mc get

Mon, 01 Jan 0001 00:00:00 +0000

Added: mc

RELEASE.2024-02-24T01-33-20Z

Syntax

The mc get command downloads an object from a target S3 deployment to the local file system.

mc get provides a simplified interface for downloading files compared to mc cp or mc mirror. mc get uses a one-way download function that trades efficiency for the power and complexity of the other commands.

The following downloads the file logo.png from an s3 source to the local file system at path ~/images/collateral/.

mc head

Mon, 01 Jan 0001 00:00:00 +0000

Syntax

The mc head command displays the first n lines of an object, where n is an argument specified to the command.

mc head does not perform any transformation or formatting of object contents to facilitate readability. You can also use mc head against the local filesystem to produce similar results to the head commandline tool.

The following command returns the first 10 lines of an object in the mydata bucket on the myminio MinIO deployment:

mc idp ldap accesskey create-with-login

Mon, 01 Jan 0001 00:00:00 +0000

Added: mc

RELEASE.2024-04-18T16-45-29Z

Description

The mc idp ldap accesskey create-with-login uses interactive terminal-based prompt to authenticate with the external AD/LDAP server and generate access keys for use with MinIO.

The following example prompts the user to provide their AD/LDAP credentials. It then generates a new access key pair using the policy or policies associated with that AD/LDAP user.

mc idp openid

Mon, 01 Jan 0001 00:00:00 +0000

Added: RELEASE.2023-05-26T23-31-54Z

mc idp openid and its subcommands replace mc admin idp openid.

Description

The mc idp openid commands allow you to manage configurations to 3rd party OpenID Identity and Access Management (IAM) integrations.

Define configuration settings as an alternative to using environment variables when setting up an OpenID connection. The mc idp openid commands are only supported against MinIO deployments.

Note

MinIO OpenID environment variables override their corresponding configuration settings as modified or set by this command.

mc ls

Mon, 01 Jan 0001 00:00:00 +0000

Syntax

The mc ls command lists buckets and objects on MinIO or another S3-compatible service.

You can also use mc ls against the local filesystem to produce similar results as the ls command.

The following command lists all objects and object versions in the mydata bucket on the myminio MinIO deployment:

mc ls --recursive --versions myminio/mydata

The output resembles the following:

mc mb

Mon, 01 Jan 0001 00:00:00 +0000

Syntax

The mc mb command creates a new bucket or directory at the specified path.

You can also use mc mb against the local filesystem to produce similar results to the mkdir -p commandline tool.

The following command creates a new bucket mydata on the myminio MinIO deployment. The command creates the bucket with object locking enabled.

mc mirror

Mon, 01 Jan 0001 00:00:00 +0000

Syntax

The mc mirror command synchronizes content to MinIO deployment, similar to the rsync utility. mc mirror supports filesystems, MinIO deployments, and other S3-compatible hosts as the synchronization source.

Note

mc mirror only synchronizes the current object without any version information or metadata. To synchronize an object’s version history and metadata, consider using mc replicate for bucket replication or mc admin replicate for site replication.

The following command synchronizes content from a local filesystem directory to the mydata bucket on the myminio MinIO deployment.

mc mv

Mon, 01 Jan 0001 00:00:00 +0000

Syntax

The mc mv command moves an object from source to the target, such as between MinIO deployments or between buckets on the same MinIO deployment. mc mv also supports moving objects between a local filesystem and MinIO.

You can also use mc mv against the local filesystem to produce similar results to the mv commandline tool.

The following command moves objects from the mydata bucket to the archive bucket on the myminio MinIO deployment:

mc od

Mon, 01 Jan 0001 00:00:00 +0000

Syntax

The mc od command copies a local file to a remote location in a specified number of parts and part sizes. The command outputs the time it took to upload the file.

Use the mc od to mimic the functionality of the Linux dd command.

The following command Upload 200MiB of a file to a bucket in 5 parts of size 40MiB. The output shows the results of the upload, including the length of time it took for the upload to complete.

mc ping

Mon, 01 Jan 0001 00:00:00 +0000

Syntax

The mc ping command performs a liveness check on a specified target.

The following sends a response request to the target(s) and outputs the minimum, maximum, average, and roundtrip times of the response, as well as the number of errors encountered when processing the request.

mc ping play --count 5

The command pings the deployment at the alias play for five cycles. The output resembles the following:

mc pipe

Mon, 01 Jan 0001 00:00:00 +0000

Syntax

The mc pipe command streams content from STDIN to a target object.

The following command writes contents of STDIN to an S3 compatible storage.

echo "My Meeting Notes" | mc pipe s3/engineering/meeting-notes.txt

The command has the following syntax:

mc [GLOBALFLAGS] pipe \
 TARGET \
 [--attr "string"] \
 [--checksum "string"] \
 [--enc-kms "string"] \
 [--enc-s3 "string"] \
 [--enc-c "string"] \
 [--storage-class, --sc "string"] \
 [--tags "string"]

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.

mc put

Mon, 01 Jan 0001 00:00:00 +0000

Added: mc

RELEASE.2024-02-24T01-33-20Z

Syntax

The mc put uploads an object from the local file system to a bucket on a target S3 deployment.

mc put provides a simplified interface for uploading files compared to mc cp or mc mirror. mc put uses a one-way upload function that trades efficiency for the power and complexity of the other commands.

The following uploads the file logo.png from the local file system at path ~/images/collateral/ to a bucket called marketing on the MinIO deployment with the alias of minio.

mc rb

Mon, 01 Jan 0001 00:00:00 +0000

Syntax

The mc rb command removes one or more buckets on MinIO or another S3-compatible service.

To remove only the contents of a bucket, use mc rm instead.

Important

mc rb permanently deletes bucket(s) on the target deployment, including any and all object versions and bucket configurations such as lifecycle management or replication.

You can also use mc rb against the local filesystem to produce similar results to the rm --rf commandline tool.

mc ready

Mon, 01 Jan 0001 00:00:00 +0000

Syntax

The mc ready command checks the status of a cluster and whether the cluster has read and write quorum.

The following sends a GET request to the cluster at alias myminio and returns its status.

mc ready myminio

The command sends a GET request to the deployment at the alias myminio.’ The command repeats the request until it is successful.

mc rm

Mon, 01 Jan 0001 00:00:00 +0000

Syntax

The mc rm command removes objects from a bucket on a MinIO deployment. To completely remove a bucket, use mc rb instead.

You can also use mc rm against the local filesystem to produce similar results to the rm commandline tool.

For more information on how MinIO performs DELETE actions on objects, see Object Deletion.

Important

mc rm supports removing multiple objects or files in a single command. Consider using the --dry-run option to validate that the operation targets only the desired objects/files.

mc sql

Mon, 01 Jan 0001 00:00:00 +0000

Syntax

The mc sql command provides an S3 Select interface for performing sql queries on objects in the specified MinIO deployment.

See Selecting content from objects for more information on S3 Select behavior and limitations.

The following command queries all objects in the mydata bucket on the myminio MinIO deployment:

mc sql --recursive --query "select * from S3Object" myminio/mydata

The command has the following syntax:

mc stat

Mon, 01 Jan 0001 00:00:00 +0000

Syntax

The mc stat command displays information on objects in a MinIO bucket, including object metadata. You can also use it to retrieve bucket metadata.

You can use mc stat against the local filesystem to produce similar results to the stat commandline tool.

The following command displays information on all objects in the mydata bucket on the myminio MinIO deployment:

mc tree

Mon, 01 Jan 0001 00:00:00 +0000

Syntax

The mc tree command lists all prefixes inside a MinIO bucket in a tree format. The command optionally supports listing all objects inside of bucket at each prefix, including the bucket root.

You can also use mc tree against a local filesystem directory to produce similar results to the tree commandline tool.

The following command prints a complete tree of all objects at any depth in the mydata bucket on the myminio MinIO deployment:

mc undo

Mon, 01 Jan 0001 00:00:00 +0000

Syntax

The mc undo command reverses changes due to either a PUT or DELETE operation at a specified path.

The following command reverts the last three uploads and/or deletions of the file.zip object on the myminio deployment in the data bucket:

mc undo myminio/data/file.zip --last 3

The command has the following syntax:

mc update

Mon, 01 Jan 0001 00:00:00 +0000

Syntax

The mc update command automatically updates the mc binary to the latest stable version.

Running this command is equivalent to manually downloading the latest stable binary and using it to replace the existing mc installation on the host machine.

The following command updates the mc binary on the local host:

mc update

The command has the following syntax:

mc watch

Mon, 01 Jan 0001 00:00:00 +0000

Syntax

The mc watch command watches for events on the specified MinIO bucket or local filesystem path. For S3 services, use mc event add to configure bucket event notifications on S3-compatible services.

You can also use mc watch against a local filesystem directory to produce similar results to running the inotify -e modify,create,delete,move command.

The following command watches for events on any object or prefix in the mydata bucket on the myminio MinIO deployment:

mc idp ldap accesskey create

Mon, 01 Jan 0001 00:00:00 +0000

Added: mc

RELEASE.2023-12-23T08-47-21Z

Description

The mc idp ldap accesskey create allows you to add LDAP access key pairs.

The following example creates a new access key pair with the same policy as the authenticated user on the minio alias:

mc idp ldap accesskey create minio/

The command has the following syntax: