Admin Commands

The AIStor Client command line tool includes the mc admin subcommand tree for performing administrative tasks on your MinIO AIStor deployments.

mc admin target MinIO AIStor deployments exclusively and do not support any other S3-compatible service.

The command has the following top-level syntax. Use the --help parameter to view the CLI help.

mc admin [FLAGS] COMMAND [ARGUMENTS]

Global options

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

Command quick reference

The following table lists mc admin commands:

CommandDescription
mc admin accesskeyCreates and manages Access Keys for internally managed users on a MinIO AIStor deployment.
mc admin bucket quotaDeprecated. Use mc quota instead. Configures, displays, or clears a hard quota on a bucket.
mc admin cluster bucketImports and exports MinIO AIStor bucket metadata.
mc admin cluster iamImports and exports MinIO AIStor identity and access management (IAM) metadata.
mc admin cluster statsOpens an interactive dashboard of realtime and historic cluster statistics.
mc admin configManages the configuration settings of a MinIO AIStor deployment.
mc admin cordonRemove a node from service for maintenance purposes.
mc admin decommissionStarts the decommissioning process for MinIO AIStor server pools and migrates data from the decommissioned pool to remaining pools.
mc admin groupManages groups on a MinIO AIStor deployment.
mc admin healScans for and heals objects that are damaged or corrupted.
mc admin infoDisplays information on a MinIO AIStor server or, for distributed deployments, each Object Store.
mc admin kms keyPerforms cryptographic key management operations through the MinIO Key Encryption Service (KES).
mc admin logsShows Object Store logs.
mc admin maintenance hostsLists hosts and their maintenance state.
mc admin nameRetrieves or sets the cluster name for a MinIO AIStor deployment.
mc admin object infoReports the internal metadata and shard layout of a single object.
mc admin policyManages policies for MinIO Policy-Based Access Control (PBAC) using IAM-compatible policy JSON documents.
mc admin prometheusProvides access to MinIO Prometheus metrics.
mc admin rebalanceStarts, monitors, or stops a rebalancing operation and redistributes objects across all pools.
mc admin replicateCreates and manages site replication for a set of MinIO AIStor peer sites, synchronizing changes across all sites.
mc admin scannerProvides information about the scanner process.
mc admin serviceRestarts or unfreezes MinIO AIStor servers.
mc admin traceDisplays API operations occurring on the target MinIO AIStor deployment.
mc admin uncordonRestore a cordoned node to active service after maintenance.
mc admin updateUpdates all MinIO AIStor servers in the deployment and supports using a private mirror server.
mc admin userManages MinIO AIStor users.
mc admin cluster servicesDisplays the configuration and status of the services running on a deployment.
mc admin driveInspects the drives of a deployment.
mc admin nodeInspects the nodes of a deployment.
mc admin object unlockSummarizes and releases the locks held on an object.
mc admin poolInspects the server pools of a deployment.
mc admin setInspects the erasure sets of a deployment.

On this page