Guide

CLI Managing Sync Jobs

The sync command surface is designed for headless import operations when you need to run ABM Warranty jobs outside the GUI. It gives you direct control over tenant targeting, sync mode selection, and runtime tuning so operational jobs can be executed and reviewed from terminal workflows.

This page breaks each sync capability into practical commands and expected output. Use it as a runbook for listing tenants, inspecting chunk-size preferences, launching full or scoped syncs, and reviewing job history for troubleshooting and audit visibility.

Sync Help

Start with the sync help output to see the complete command surface, option requirements, and command aliases for both --sync and sync forms.

abm-warranty sync --help
ABM Warranty Sync CLI

OVERVIEW
  Run headless sync jobs for a specific tenant.

USAGE
  abm-warranty --sync --tenant-id <TENANT_ID> --type <full|partial|single> [--serial <SERIAL>]
  abm-warranty sync --tenant-id <TENANT_ID> --type <full|partial|single> [--serial <SERIAL>]
  abm-warranty --chunk-size
  abm-warranty --set-chunk-size <VALUE>

COMMANDS
  --list-tenants
      List available tenant IDs and names.
  --chunk-size
      Print current global chunk-size preference and allowed values.
  --set-chunk-size <VALUE>
      Set global chunk-size preference used by full/partial sync.

  --show-jobs --tenant-id <TENANT_ID>
      Print expanded sync run/chunk history for a tenant.

  --sync --tenant-id <TENANT_ID> --type <full|partial|single> [--serial <SERIAL>]
      Run sync now.

OPTIONS
  --tenant-id <TENANT_ID>
      Required for --sync and --show-jobs.
  --type <full|partial|single>
      Required for --sync.
  --serial <SERIAL>
      Required for --type single.
  <VALUE>
      Allowed chunk sizes:
      10, 50, 100, 200, 500, 1000, 2000, 5000, 10000

EXAMPLES
  abm-warranty --list-tenants
  abm-warranty --chunk-size
  abm-warranty --set-chunk-size 500
  abm-warranty --show-jobs --tenant-id BUSINESSAPI.xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
  abm-warranty --sync --tenant-id BUSINESSAPI.xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx --type full
  abm-warranty sync --tenant-id BUSINESSAPI.xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx --type partial
  abm-warranty --sync --tenant-id BUSINESSAPI.xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx --type single --serial C02XXXXXXX

CANCELLATION
  Use Ctrl+C to cancel an active sync.
  Ctrl+X is not cancel for this CLI. Ctrl+Z suspends the process.

The help output defines required flags clearly, including when --tenant-id, --type, and --serial are mandatory. It also documents cancellation behavior so operators can safely stop an active sync run.

List Available Tenants

Use tenant listing before running jobs so you target the correct tenant identifier in scripted or manual workflows.

abm-warranty --list-tenants

This command returns the tenant IDs and display names currently available to the local runtime context.

Check Current Chunk Size

Use chunk-size inspection to confirm the global batch setting used for full and partial sync jobs.

abm-warranty --chunk-size

The output shows the active preference and valid values, which helps validate performance tuning before larger sync operations.

Set Global Chunk Size

Use this command to tune chunk processing volume for full and partial runs when you need to balance speed, API pressure, and local processing overhead.

abm-warranty --set-chunk-size 500

After this update, subsequent eligible sync jobs will use the configured chunk size preference until changed again.

Show Sync Job History

Use job history output to inspect recent run and chunk activity for a specific tenant. This is useful for support triage, verification, and timeline review.

abm-warranty --show-jobs --tenant-id BUSINESSAPI.xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

This command prints expanded sync history scoped to the provided tenant ID, including run-level and chunk-level status details.

Run a Full Sync

Use full sync when you need a complete refresh of the tenant dataset in one headless run.

abm-warranty --sync --tenant-id BUSINESSAPI.xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx --type full

This executes a full sync immediately for the selected tenant and records the run in sync job history.

Run a Partial Sync

Use partial sync for routine incremental processing when full dataset refresh is not required.

abm-warranty sync --tenant-id BUSINESSAPI.xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx --type partial

This starts a partial job using the same tenant targeting model with a lighter data scope than a full run.

Run a Single-Device Sync

Use single-device mode when you need focused troubleshooting or validation for one serial number.

abm-warranty --sync --tenant-id BUSINESSAPI.xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx --type single --serial C02XXXXXXX

In single mode, the serial is required and the sync scope is constrained to one device for targeted verification.