Skip to content

Silo Client Administration

The Silo client mc provides the mc admin command for performing administrative tasks on SILO. Compatibility with unmodified upstream MinIO is best effort.

While mc supports general S3-compatible services, mc admin uses MinIO-specific administration APIs with SILO as the supported server. S3 compatibility alone does not provide these APIs.

mc admin has the following syntax:

mc admin [FLAGS] COMMAND [ARGUMENTS]

Command Quick reference

The following table lists mc admin commands:

Command

Description

mc admin accesskey

The mc admin accesskey command and its subcommands create and manage Access Keys for internally managed users on a MinIO deployment.

mc admin cluster bucket

The mc admin cluster bucket command and its subcommands provide tools for manually importing and exporting MinIO bucket metadata.

mc admin cluster iam

The mc admin cluster iam command and its subcommands provide tools for manually importing and exporting MinIO identity and access management (IAM) metadata.

mc admin decommission

The mc admin decommission command starts the decommissioning process for a MinIO server pools. Decommissioning is designed for removing an older server pool whose hardware is no longer sufficient or performant compared to the pools in the deployment. MinIO automatically migrates data from the decommissioned pool to the remaining pools in the deployment based on the ratio of free space available in each pool.

mc admin group

The mc admin group command manages groups on a MinIO deployment.

mc admin heal

The mc admin heal command scans for objects that are damaged or corrupted and heals those objects.

mc admin info

The mc admin info command displays information on a MinIO server. For distributed MinIO deployments, mc admin info displays information for each MinIO server in the deployment.

mc admin kms key

The mc admin kms key command performs cryptographic key management operations through the MinIO Key Encryption Service (KES).

mc admin logs

Use the mc admin logs command to show MinIO server logs.

mc admin policy

The mc admin policy commands manage policies for use with MinIO Policy-Based Access Control (PBAC). MinIO PBAC uses IAM-compatible policy JSON documents to define rules for accessing resources on a MinIO server.

mc admin prometheus

The mc admin prometheus command and its subcommands provide access to MinIO Prometheus metrics.

mc admin rebalance

The mc admin rebalance command allows starts, monitors, or stops a rebalancing operation on a MinIO deployment. Rebalancing redistributes objects across all pools in the deployment.

mc admin replicate

The mc admin replicate command creates and manages site replication for a set of MinIO peer sites.

Site replication mimics an active-active bucket replication, but for multiple MinIO deployments. Wherever a change occurs to IAM settings, buckets, or objects across the set of sites, the change replicates across all sites in the site replication group.

mc admin scanner

The mc admin scanner commands provide information about the scanner process.

mc admin service

The mc admin service command can restart or unfreeze MinIO servers.

mc admin trace

The mc admin trace command displays API operations occurring on the target MinIO deployment.

mc admin update

The mc admin update command retains the inherited server update API. Current SILO permanently disables in-place updates; use verified packages, binaries, or images.

mc admin user

The mc admin user command and its subcommands manage MinIO users.

Installation

Install the maintained client from Download & Install, or follow the source-build instructions in the mc reference. Standalone archives and Linux packages use the mcli command name; substitute mcli admin for mc admin in the examples when that is the installed name.

Quickstart

Ensure that the host machine has mc installed prior to starting this procedure.

Warning

Important

The example prompts for credentials so they do not appear in the shell command history. Protect the client configuration directory, which stores the alias credentials.

Use the mc alias set command to add the deployment to the mc configuration.

mcli alias set ALIAS https://silo.example.net

Replace ALIAS and the endpoint, then enter credentials when prompted.

Use the mc admin info command to test the connection to the newly added MinIO deployment:

mc admin info <ALIAS>

Global Options

mc admin supports the same global options as mc. See Global Options.