1
0
mirror of https://github.com/minio/docs.git synced 2025-08-06 14:42:56 +03:00
Files
docs/source/reference/minio-mc/mc-batch-cancel.rst
Daryl White 840417a6f7 Doc updates for mc RELEASE.2023-03-20T17-17-53Z (#799)
- Adds note that `mc support proxy set|remove` no longer require
registration
- Adds info about stale ARNs for `mc replicate status` command
- Additional information for --dry-run flag in `mc rm`
- Thoroughly updates and restructures `mc admin policy` commands
- Adds new `mc batch cancel` command
- Updates deprecated commands for newly deprecated mc admin policy
functions
- Fixes toctree on mc admin page to allow for mc admin policy subcommand
nesting

Closes #766

Other fixes not part of the release:
- Updates `--fake` flag on `mc rm` to `--dry-run`
- Updates `--fake` flag on `mc mirror` to `--dry-run`
2023-04-05 10:50:40 -05:00

93 lines
1.9 KiB
ReStructuredText

.. _minio-mc-batch-cancel:
===================
``mc batch cancel``
===================
.. default-domain:: minio
.. contents:: Table of Contents
:local:
:depth: 2
.. mc:: mc batch cancel
.. versionadded:: mc RELEASE.2023-03-20T17-17-53Z
Syntax
------
.. start-mc-batch-cancel-desc
The :mc:`mc batch cancel` stops an ongoing batch job.
.. end-mc-batch-cancel-desc
You must specify the job ID.
To find the job ID, use :mc-cmd:`mc batch list`.
.. tab-set::
.. tab-item:: EXAMPLE
The following command outputs the job definition for the job identified as ``KwSysDpxcBU9FNhGkn2dCf``.
.. code-block:: shell
:class: copyable
mc batch cancel myminio KwSysDpxcBU9FNhGkn2dCf
.. tab-item:: SYNTAX
The command has the following syntax:
.. code-block:: shell
:class: copyable
mc [GLOBALFLAGS] batch cancel TARGET JOBID
.. include:: /includes/common-minio-mc.rst
:start-after: start-minio-syntax
:end-before: end-minio-syntax
Parameters
~~~~~~~~~~
.. mc-cmd:: TARGET
:required:
The :ref:`alias <alias>` for the MinIO deployment on which the job is currently running.
.. mc-cmd:: JOBID
:required:
The unique identifier of the batch job to cancel.
To find the ID of a job, use :mc:`mc batch list`.
Global Flags
~~~~~~~~~~~~
.. include:: /includes/common-minio-mc.rst
:start-after: start-minio-mc-globals
:end-before: end-minio-mc-globals
Example
-------
Cancel an ongoing batch job
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The following command cancels the job with ID ``KwSysDpxcBU9FNhGkn2dCf`` on the deployment at alias ``myminio``:
.. code-block:: shell
:class: copyable
mc batch cancel myminio KwSysDpxcBU9FNhGkn2dCf
S3 Compatibility
~~~~~~~~~~~~~~~~
.. include:: /includes/common-minio-mc.rst
:start-after: start-minio-mc-s3-compatibility
:end-before: end-minio-mc-s3-compatibility