minio/docs
1
0
Fork 0
mirror of https://github.com/minio/docs.git synced 2025-04-21 08:05:59 +03:00
Code
docs/source/reference/minio-mc/mc-batch-list.rst
Daryl White f37aee8416
Clean up of batch framework and mc batch docs (#749) 
- Removes bad copy paste info about ilm from batch command docs.
- Clarifies that batch files are one task only.
- Fixes source type from `s3` to `minio`.
- Cleans up indentation errors in replicate yaml example.
- Replicate task is local to remote only.

Closes #748
2023-03-06 16:12:44 -06:00

2.4 KiB
Raw Permalink Blame History

mc batch list

minio

Table of Contents

mc batch list

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

Syntax

The mc batch list command outputs a list of the batch jobs currently in progress on a deployment.

EXAMPLE

The following command outputs a list of all jobs currently in progress on the myminio alias.

mc batch list myminio

SYNTAX

The command has the following syntax:

mc [GLOBALFLAGS] batch list TARGET           \
                            --type "string"

Parameters

TARGET

The alias <alias> of the deployment for which you want to list jobs in progress.

--type

List batch jobs only of a certain type.

Global Flags

Example

List all replicate type batch jobs

The following command lists the replicate type job(s) on the deployment at :mc:`alias <mc alias> myminio:

mc batch list myminio --type "replicate"

  • Replace myminio with the alias <mc alias> of the MinIO deployment that should run the job.

  • Replace replicate with the job type to output.

    Currently, mc batch only supports the replicate job type.

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

ID                      TYPE            USER            STARTED
E24HH4nNMcgY5taynaPfxu  replicate       minioadmin      1 minute ago

S3 Compatibility

Permissions

You must have the admin:ListBatchJobs permission to list jobs on the deployment.