mc support inspect
SILO behavior: diagnostics run locally without SUBNET registration or automatic uploads. License info/unregister operate on local state; license update retains the explicit-file path. Online registration/renewal and uploads are disabled. Retained upstream syntax below does not enable those services. See mcli compatibility.
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 for each specified object. The command produces an encrypted zip file that includes all matching files with their respective host+drive+path.
Diagnostic output stays local; SUBNET online services are disabled. Compatibility flags do not enable uploads.
Changed: RELEASE.2023-01-11T03-14-16Z
The file uploads to MinIO for use by the engineering team in support efforts. If the upload fails, such as in an air-gapped environment, the command saves the file to the current working directory.
Changed: RELEASE.2022-12-12T19-27-27Z
When writing the zip archive, MinIO also encrypts the zip index of file names included in the archive.
Changed: RELEASE.2024-10-29T15-34-59Z
Inspect now generates unique file names to help distinguish one inspect file from another. The file name reflects the inspected path.
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 when using the Bash shell. For non-Bash shells, a message displays indicating that wildcard patterns are only supported in Bash.
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.
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.
Syntax
The command has the following syntax:
Parameters
--legacy
mc-cmd
Optional
Use the older method of exporting inspection data, which does not encrypt data by default.
TARGET
mc-cmd
Required
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
This command supports any of the global flags.