mc batch start

Note

Changed: MinIO

RELEASE.2022-10-09T21-10-59Z 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.

The following command starts a batch job from jobfile.yaml on 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'

The command has the following syntax:

mc [GLOBALFLAGS] batch start    \
                       ALIAS   \
                       JOBFILE

Brackets [] indicate optional parameters.
Parameters sharing a line are mutually dependent.
Parameters separated using the pipe | operator are mutually exclusive.

Copy the example to a text editor and modify as-needed before running the command in the terminal/shell.

Parameters

`ALIAS`

mc-cmd

Required

The alias on which to start the batch job.

For example:

mc batch start myminio replicate.yaml

`JOBFILE`

mc-cmd

Required

Path to the YAML file that defines one batch job (replicate, keyrotate, or expire).

Global Flags

This command supports any of the global flags.

Example

Start a Batch Job

The following command starts the batch job defined in replication.yaml on the deployment at alias myminio:

mc batch start myminio ./replication.yaml

Replace myminio with the 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

SILO is the supported server for PGSTY mcli; compatibility with upstream MinIO and other S3 services is best effort.

Permissions

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

SILO 20261109 also enforces the authenticated submitter’s local data permissions when the job lists or modifies objects. Credentials in the job definition authorize remote operations separately. See authorization and retries.

JavaScript is required to load comments. View discussions on GitHub.