mc admin service

Description

The mc admin service command can restart or stop MinIO AIStor servers, and can freeze or unfreeze the S3 API calls they serve.

mc admin service affects all MinIO AIStor servers in the target deployment at the same time. The command interrupts in-progress API operations on the MinIO AIStor deployment. Use caution when issuing this command to a deployment.

Examples

Restart AIStor Servers in target deployment

The following example uses the default myaistor alias. The myaistor alias points to a local minio server running on port 9000.

See mc alias for more information on aliases.

mc admin service restart myaistor

Resume S3 calls on a target deployment

The following example uses the default myaistor alias. The myaistor alias points to a local minio server running on port 9000.

See mc alias for more information on aliases.

mc admin service unfreeze myaistor

Syntax

mc admin service has the following syntax:

mc admin service COMMAND [ARGUMENTS]

mc admin service supports the following commands:

restart

Restarts MinIO AIStor servers. If needed, the command may suggest restarting the node based on the status.

mc admin service restart has the following syntax:

mc admin service restart ALIAS       \
                         [--cancel]  \
                         [--dry-run] \
                         [--rolling duration] \
                         [--wait, -w]

Specify the alias of a configured MinIO AIStor deployment. restart restarts all MinIO AIStor servers in the deployment.

See Parameters for the flags this command accepts.

stop

Stops the MinIO AIStor servers in the deployment.

mc admin service stop has the following syntax:

mc admin service stop ALIAS

Specify the alias of a configured MinIO AIStor deployment. stop stops all MinIO AIStor servers in the deployment, which makes it unavailable. Starting the deployment again is the responsibility of whatever runs the server processes, such as systemd or Kubernetes.

freeze

Pauses the S3 API calls that the deployment serves.

mc admin service freeze has the following syntax:

mc admin service freeze ALIAS

Specify the alias of a configured MinIO AIStor deployment. Use unfreeze to resume the paused calls.

unfreeze

Restart S3 API calls on a MinIO AIStor cluster.

mc admin service unfreeze has the following syntax:

mc admin service unfreeze ALIAS

Specify the alias of a configured MinIO AIStor deployment.

Parameters

The following parameters apply to restart.

--cancel

Optional

Cancels a cluster restart that is in progress.

--dry-run

Optional

Reports the status of each peer without restarting anything.

--rolling

Optional

Restarts the servers in concurrent batches rather than all at once, and waits for each batch to report healthy before starting the next. Specify the period to allow a server to shut down gracefully, such as 30s or 2m.

Without this parameter, mc admin service restart restarts all servers at the same time.

The deployment performs a rolling restart in the background. The command returns once the deployment accepts the request, unless you also specify --wait.

--wait

Alias: -w

Optional

Waits for background initialization to finish before returning. The command polls the deployment until it reports healthy.

This parameter applies whether or not you specify --rolling.