bm batch status

Syntax

The bm batch status command outputs summaries of job events on a Buckit server.

The following command outputs the status of the specified job with JobID KwSysDpxcBU9FNhGkn2dCf currently in progress on the mybuckit alias.

bm batch status mybuckit "KwSysDpxcBU9FNhGkn2dCf"

The command has the following syntax:

bm [GLOBALFLAGS] batch list TARGET           \
                            ["JOBID"]
  • 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
Required

The alias for which to display batch job statuses.

JOBID
Optional

The unique identifier of a job to summarize. To find the ID of a job, use bm batch list.

If not specified, the command returns a summary for the current active batch job.

Global Flags

This command supports any of the global flags.

Example

Summarize the Events of an Active Replicate Job

The following command provides the real-time summary of an active job on the deployment at alias mybuckit:

bm batch status mybuckit "KwSysDpxcBU9FNhGkn2dCf"
  • Replace mybuckit with the alias of the Buckit deployment that should run the job.

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

●∙∙
JobType:        replicate
Objects:        28766
Versions:       28766
FailedObjects:  0
Transferred:    406 MiB
Elapsed:        2m14.227222868s
CurrObjName:    share/doc/xml-core/examples/foo.xmlcatalogs

S3 Compatibility

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

Buckit provides no guarantees for other S3-compatible services, as their S3 API implementation is unknown and therefore unsupported. While bm commands may work as documented, any such usage is at your own risk.