docs/source/reference/minio-mc/mc-batch-start.rst

mc batch start

minio

Table of Contents

mc batch start

MinIO RELEASE.2022-10-08T20-11-00Z or later

Syntax

The mc batch start command launches a batch job from a job batch YAML file.

The batch job runs to completion (or up to the number of retries specified in the file) one time. To run the batch job again after completion, you must start it again.

EXAMPLE

The following command creates a basic YAML file for a replicate job on the mybucket bucket of the myminio alias.

mc batch start myminio jobfile.yaml

The output of the above command is something similar to:

Successfully start 'replicate' job `B34HHqnNMcg1taynaPfxu` on '2022-10-24 17:19:06.296974771 -0700 PDT'

SYNTAX

The command has the following syntax:

mc [GLOBALFLAGS] batch start    \
                       ALIAS   \
                       JOBFILE

Parameters

ALIAS

The alias <alias> on which to start the batch job.

For example:

mc batch start myminio replicate.yaml

JOBFILE

A YAML-defined batch job. The job may have as many tasks as desired; there is no predefined limit.

Global Flags

Example

Start a Batch Job

The following command starts the batch of job(s) defined in the file replication.yaml on the deployment at alias <mc alias> myminio:

mc batch start myminio ./replication.yaml

• Replace myminio with the alias <mc alias> of the MinIO deployment that should run the job.
• Replace ./replication.yaml with the yaml-formatted file that describes the batch job. Use the file path relative to your current location.

The output of the above command is similar to the following:

Successfully start 'replicate' job `E24HH4nNMcgY5taynaPfxu` on '2022-09-26 17:19:06.296974771 -0700 PDT'

S3 Compatibility

Permissions

You must have the admin:StartBatchJob permission on the deployment to start jobs.