Skip to content

JabraCLI Reference

JabraCLI is a cross-platform command-line tool for managing supported Jabra personal and meeting room devices. This page documents the command groups, subcommands, and options used for scripting and operational workflows.

For a scenario-focused overview, see Using JabraCLI.

Top-Level Usage

bash
jabracli [command] [options]

Top-level commands:

  • config Use pre-defined configurations to ensure devices are set up as desired.
  • firmware Update firmware on attached devices.
  • device List and get info about Jabra devices.
  • property Work with properties of attached devices.

Top-level options:

  • -o, --output-format <output-format> Output format. Supported values: text, json.
  • -?, -h, --help Show help and usage information.
  • --version Show version information.

Command Groups

device

Use this group to list attached devices and monitor device lifecycle events.

Subcommands:

  • device list List attached Jabra devices.
  • device watch Watch device events.

Examples:

bash
jabracli device list
jabracli device list --all
jabracli device watch --names "deviceAdded,deviceRemoved"

Options:

  • device list --all Show all devices (disables default filter).
  • device watch --names <names> Required. Comma-separated list of event names.

Parameter hints:

  • Event names for --names can be discovered from jabracli device watch --help.
  • Use jabracli device list --output-format json as input for automation workflows.

Common uses:

  • Build an inventory of currently attached Jabra devices.
  • Trigger workflows when devices are attached or removed.
  • Feed real-time device lifecycle events into monitoring pipelines.

property

Use this group to read, write, and watch supported device properties.

Subcommands:

  • property read Read values from an attached device.
  • property write Write values to an attached device.
  • property watch Watch properties from an attached device.

Examples:

bash
jabracli property read --pid "<product-id>" --names "<propertyA>,<propertyB>"
jabracli property write --pid "<product-id>" --values "<propertyA>=<valueA>,<propertyB>=<valueB>"
jabracli property watch --pid "<product-id>" --names "<propertyA>,<propertyB>"

Options:

  • --pid <product-id> Required for all property subcommands.
  • read/watch --names <names> Required. Comma-separated property names.
  • write --values <values> Required. Format: propertyName1=propertyValue1,propertyName2=propertyValue2.

Parameter hints:

  • Get --pid <product-id> values from jabracli device list --output-format json.
  • For --names, use supported property names for the connected model. See Select device properties.
  • For --values, first read current values with property read, then supply writable name=value pairs.

For popular selectable properties, see Select device properties.

Common uses:

  • Validate settings before handing devices to end users.
  • Enforce organization-specific property baselines.
  • Observe changing device properties during troubleshooting.

firmware

Use this group to find, download, and apply firmware files.

Subcommands:

  • firmware list List firmware versions available for download from jabra.com.
  • firmware download Download firmware files from jabra.com.
  • firmware update Update firmware on specified attached devices from a local firmware file.

Examples:

bash
jabracli firmware list --pid "<product-id>"
jabracli firmware download --pid "<product-id>" --version "<firmware-version>"
jabracli firmware update --pid "<product-id>" --firmware-file "./firmware.zip"
jabracli firmware update --pid "<product-id>" --firmware-file "./firmware.zip" --check-only

Options:

  • list --pid <product-id> Required.
  • download --pid <product-id> --version <version> Required.
  • update --pid <product-id> --firmware-file <path> Required.
  • update --check-only Validate upgrade feasibility without modifying the device.

Parameter hints:

  • Get --pid <product-id> values from jabracli device list --output-format json.
  • Get available --version <version> values from jabracli firmware list --pid "<product-id>".
  • --firmware-file <path> should point to a local file downloaded with jabracli firmware download.

Common uses:

  • Identify available firmware for a specific device model.
  • Download firmware for controlled or offline rollout.
  • Validate and execute firmware updates during maintenance windows.

config

Use this group to inspect or apply a configuration JSON file to matching attached devices.

Subcommands:

  • config show Show the content of a configuration file.
  • config apply Apply firmware and properties defined in a configuration file.

Examples:

bash
jabracli config show --config "./config.json"
jabracli config apply --config "./config.json"
jabracli config apply --config "./config.json" --check-only

Options:

  • --config <config> Path to configuration JSON file. Default is config.json in the current directory.
  • config apply --check-only Validate matching state without modifying the device.

Parameter hints:

  • If --config is omitted, JabraCLI uses config.json in the current working directory.
  • Use jabracli config show --config "./config.json" to validate file content before config apply.

Common uses:

  • Apply a standard firmware and property baseline to many devices.
  • Run compliance checks without changing device state.
  • Keep provisioning repeatable by version-controlling configuration files.

Configuration File Example

Sample configuration for a PanaCast 50 firmware workflow:

json
{
  "Name": "PanaCast 50 Sample",
  "DeviceModels": [
    {
      "PID": 12305,
      "Properties": {
        "zoomMode2" : "intelligentZoom", //fullScreen, intelligentZoom, activeSpeaker
        "roomCapacity" : 6,
        "peopleCountEnabled" : true
      },
      "Firmware": {
        "LocalPath": "./Jabra_PanaCast_50_9.0.5.zip"
      }
    }
  ]
}

See Jabra Device Properties Sample app for more examples of supported properties and values to include in the configuration files.

Contact developer support if you need help finding the right property names and values for your use case.

Operational Notes

  • Prefer --output-format json for automation pipelines.
  • Device support, available firmware, and selectable properties depend on device and firmware capabilities.

Usage Telemetry Collection

JabraCLI will share anonymized usage telemetry with GN to support product improvements. This includes command usage patterns and error occurrences. No personally identifiable information or sensitive data is collected. Contact developer support if you have questions or concerns about telemetry collection.