e2f30fb5fd
Closes #605 - Adds the five `mc batch` subcommands - Adds a batch framework page to the Administration section of docs
2.5 KiB
mc batch describe
minio
Table of Contents
mc batch describe
MinIO RELEASE.2022-10-08T20-11-00Z or later
Syntax
The mc batch describe
command outputs the job definition for a specified job ID.
You must specify the job ID. To find the job ID, use mc batch list.
EXAMPLE
The following command outputs the job definition for the job
identified as KwSysDpxcBU9FNhGkn2dCf.
mc batch describe myminio KwSysDpxcBU9FNhGkn2dCfSYNTAX
The command has the following syntax:
mc [GLOBALFLAGS] batch describe TARGET \
JOBIDParameters
TARGET
The alias <alias> for the MinIO deployment to look
for the Job ID.
JOBID
The unique identifier of a job to describe. To find the ID of a job,
use mc batch list.
Global Flags
Example
Show the Definition of an In Progress Batch Job
The following command provides the full job definition of a specific
job at alias <mc alias> myminio:
mc batch describe myminio KwSysDpxcBU9FNhGkn2dCf- Replace
myminiowith thealias <mc alias>of the MinIO deployment that should run the job. - Replace
KwSysDpxcBU9FNhGkn2dCfwith the ID of the job to define.
The output of the above command is similar to the following:
mc batch describe myminio KwSysDpxcBU9FNhGkn2dCf
replicate:
apiVersion: v1
...Note, this example is truncated. The output is the full job definition for the specified job.