minio/docs
1
0
Fork 0
mirror of https://github.com/minio/docs.git synced 2025-07-02 05:02:40 +03:00
Code Activity
Files
rename
docs/source/reference/minio-mc/mc-support-inspect.rst
Daryl White 6482571bf2 Update mc reference docs for improved nav structure (#717) 
- Adds landing pages for all two-word `mc` commands
- Nests three+ word commands under appropriate two-word commands
- Updates MinIO Client doc
- Uses description from each command to populate list of subcommand
descriptions
- Modifies toctree for MinIO Client doc and each command/subcommand to
improve left nav experienc

Closes #710
2023-02-02 16:52:36 -06:00

3.4 KiB
Raw Permalink Blame History

mc support inspect

minio

Table of Contents

mc support inspect

Description

The mc support inspect command collects the data and metadata associated to objects at the specified path.

MinIO assembles this data from each backend drive storing an erasure shard <minio-erasure-coding> for each specified object.

The command produces an encrypted zip file that includes all matching files with their respective host+drive+path.

RELEASE.2023-01-11T03-14-16Z

The file uploads to MinIO for use by the engineering team in support efforts. The file saves the the current working directory in the event the file does not successfully upload (such as in an airgapped environment).

RELEASE.2022-12-12T19-27-27Z

When writing the zip archive, MinIO also encrypts the zip index of file names included in the archive.

The resulting report is intended for use by MinIO Engineering via |SUBNET| and may contain internal or private data points associated to the object. Exercise caution before sending a report to a third party or posting the report in a public forum.

Important

mc support inspect requires a MinIO deployment server from October 2021 or later.

Wildcards

The command supports wildcard * pattern matching for prefixes or objects.

mc support inspect ALIAS/bucket/path/**/xl.meta

This command collects all xl.meta associated to objects at ALIAS/bucket/path/.

Examples

Download Metadata for an Object

You can download the metadata for an object. Metadata stores in an xl.meta binary file.

The following command downloads the xl.meta from mybucket/myobject on the minio1 deployment.

The file downloads from all drives as a zip archive file.

mc support inspect minio1/mybucket/myobject/xl.meta

The contents of the xl.meta file are not human readable. You can convert the contents of an xl.meta file to JSON format.

Download All Objects at a Prefix Recursively

The following command downloads all objects recursively found at a prefix.

Caution

This can be an expensive operation. Proceed with caution.

mc support inspect minio1/mybucket/myobject/**

Syntax

The command has the following syntax:

mc [GLOBALFLAGS] support inspect       \
                         [--legacy]   \
                         TARGET

Parameters

--legacy

Use the older method of exporting inspection data, which does not encrypt data by default.

TARGET

The path to the location or object to inspect. The path should include the alias <alias> of the MinIO deployment and, if needed, the prefix and/or object name.

Global Flags