minio/docs

mirror of https://github.com/minio/docs.git synced 2025-05-28 00:41:14 +03:00

Move reference docs for mc admin idp commands to mc idp (#873 )

All the `mc admin idp *` commands have been renamed `mc idp *`.
Deprecate everything under `mc admin idp` and create pages for their new
names in the MinIO Client section.

Affects the following commands and subcommands;
* `mc admin idp ldap`
* `mc admin idp openid`
*  `mc admin idp ldap policy`

The new pages maintain the existing content and page structure. New
pages for each subcommand are out of scope for this PR.

Partly addresses https://github.com/minio/docs/issues/859 and
https://github.com/minio/docs/issues/866

Staged:

http://192.241.195.202:9000/staging/DOCS-859-part-2-idp/linux/html/reference/minio-mc.html

http://192.241.195.202:9000/staging/DOCS-859-part-2-idp/linux/html/reference/minio-mc-admin.html

http://192.241.195.202:9000/staging/DOCS-859-part-2-idp/linux/html/reference/minio-mc-deprecated.html

Co-authored-by: Daryl White <53910321+djwfyi@users.noreply.github.com>

2023-06-08 11:58:22 -06:00

7.2 KiB

Raw Blame History

MinIO Admin Client

minio

Table of Contents

mc admin

The MinIO Client mc command line tool provides The command command for performing administrative tasks on your MinIO deployments.

While mc supports any S3-compatible service, mc admin only supports MinIO deployments.

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 bucket remote`
`mc admin cluster bucket`
`mc admin cluster iam`
`mc admin console`
`mc admin decommission`
`mc admin group`
`mc admin heal`
`mc admin info`
`mc admin kms key`
`mc admin logs`
`mc admin obd`
`mc admin policy`
`mc admin profile`
`mc admin prometheus`
`mc admin rebalance`
`mc admin replicate`
`mc admin service`
`mc admin top`
`mc admin trace`
`mc admin update`
`mc admin user`

Installation

Quickstart

Ensure that the host machine has mc installed <mc-admin-install> prior to starting this procedure.

Important

The following example temporarily disables the bash history to mitigate the risk of authentication credentials leaking in plain text. This is a basic security measure and does not mitigate all possible attack vectors. Defer to security best practices for your operating system for inputting sensitive information on the command line.

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

bash +o history
mc config host add <ALIAS> <ENDPOINT> ACCESS_KEY SECRET_KEY
bash -o history

Replace each argument with the required values. Specifying only the mc config host add command starts an input prompt for entering the required values.

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 minio-mc-global-options.

/reference/minio-mc-admin/mc-admin-bucket-remote /reference/minio-mc-admin/mc-admin-cluster-bucket /reference/minio-mc-admin/mc-admin-cluster-iam /reference/minio-mc-admin/mc-admin-config /reference/minio-mc-admin/mc-admin-console /reference/minio-mc-admin/mc-admin-decommission /reference/minio-mc-admin/mc-admin-group /reference/minio-mc-admin/mc-admin-heal /reference/minio-mc-admin/mc-admin-info /reference/minio-mc-admin/mc-admin-kms-key /reference/minio-mc-admin/mc-admin-logs /reference/minio-mc-admin/mc-admin-obd /reference/minio-mc-admin/mc-admin-policy /reference/minio-mc-admin/mc-admin-profile /reference/minio-mc-admin/mc-admin-prometheus /reference/minio-mc-admin/mc-admin-rebalance /reference/minio-mc-admin/mc-admin-replicate /reference/minio-mc-admin/mc-admin-service /reference/minio-mc-admin/mc-admin-top /reference/minio-mc-admin/mc-admin-trace /reference/minio-mc-admin/mc-admin-update /reference/minio-mc-admin/mc-admin-user

7.2 KiB Raw Blame History