1
0
mirror of https://github.com/minio/docs.git synced 2025-07-30 07:03:26 +03:00
Files
docs/source/reference/deprecated/mc-admin-top.rst
Andrea Longo 091a321e32 Improve mc deprecated reference: cleanup, move mc admin top (#1019)
First batch of mc deprecation cleanup:

[x] Reorder section TOC: `mc` alphabetical, then `mc admin`
alphabetical.
[x] Standardize deprecation notice format and wording.
[x] Move `mc admin top` to deprecated section.

Staged

http://192.241.195.202:9000/staging/DOCS-896-cleanup-mc-admin-top/linux/reference/minio-mc-deprecated.html

Partially addresses https://github.com/minio/docs/issues/896
2023-10-05 10:29:02 -06:00

60 lines
1.2 KiB
ReStructuredText

================
``mc admin top``
================
.. default-domain:: minio
.. contents:: Table of Contents
:local:
:depth: 2
.. mc:: mc admin top
.. versionchanged:: RELEASE.2022-08-11T00-30-48Z
``mc admin top`` replaced by :mc-cmd:`mc support top`.
Description
-----------
.. start-mc-admin-top-desc
The :mc-cmd:`mc admin top` command returns statistics for distributed
MinIO deployments, similar to the output of the ``top`` command.
.. end-mc-admin-top-desc
.. admonition:: Use ``mc admin`` on MinIO Deployments Only
:class: note
.. include:: /includes/facts-mc-admin.rst
:start-after: start-minio-only
:end-before: end-minio-only
Syntax
------
.. mc-cmd:: locks
:fullpath:
Returns the 10 oldest locks on the MinIO deployment.
The command has the following syntax:
.. code-block:: shell
:class: copyable
mc admin top locks TARGET
The command supports the following arguments:
.. mc-cmd:: TARGET
The :mc-cmd:`alias <mc alias>` of a configured MinIO deployment from which
the command retrieves statistics.
The alias *must* correspond to a distributed (multi-node) MinIO deployment.
The command returns an error for :term:`single-node single-drive` deployments.