mc inventory suspend

mc inventory suspend suspends a running inventory job and prevents all future scheduled executions.

Suspension pauses both the current execution and prevents the scheduler from starting any future runs. The job remains in the suspended until you explicitly resume it using mc inventory resume. Resuming a job does not rerun any missed executions regardless of scheduling confugratoin.

To cancel a job once, use mc inventory cancel. To remove a job permanently, use mc inventory delete.

This command requires the admin:InventoryControl.

Syntax

Example Syntax

The command has the following syntax:

mc [GLOBALFLAGS] inventory suspend  \
                       TARGET/BUCKET    \
                       INVENTORY-ID

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

TARGET/BUCKET

Required

The full path to the bucket containing the inventory configuration. Specify both the alias and bucket name in the format ALIAS/BUCKET.

INVENTORY-ID

Required

The unique identifier of the inventory job to suspend.

Global flags

This command supports any of the global flags.

Examples

Suspend a running job

The following command suspends an inventory job that is currently running:

mc inventory suspend myaistor/mybucket active-job

Replace myaistor with the alias of your AIStor deployment.
Replace mybucket with the name of the bucket.
Replace active-job with the inventory configuration ID.

The job stops within approximately 10 seconds and enters the Suspended state.

S3 compatibility

The mc commandline tool is built for compatibility with the AWS S3 API and is tested with AIStor and AWS S3 for expected functionality and behavior.

MinIO provides no guarantees for other S3-compatible services, as their S3 API implementation is unknown and therefore unsupported.

While mc commands may work as documented, any such usage is at your own risk.

Permissions

The user or service account running this command must have the admin:InventoryControl permission.

This is an administrative permission separate from the standard S3 permissions. It allows users to control the execution of inventory jobs.

For more information on AIStor policies and permissions, see Access Management.

Behavior

Suspended jobs

AIStor supports indefinite job suspension.

Resuming a long-suspended job has the following behaviors:

One-time jobs: Execute immediately (if they were Pending/Running) or follow retry timing (if Failed)
Periodic jobs: Resume normal scheduling; no execution of missed runs

The scheduler does not run missed executions for periodic jobs. For example, suspending a daily job on Monday and resuming it on Friday does not result in AIStor running the missed Tuesday-Thursday executions.