Jabra for Developers

Appearance

Using JabraCLI ​

This page provides an introduction to the use cases and scenarios JabraCLI is designed for.

JabraCLI is intended for technical users who need predictable and scriptable device control, including:

  • IT administrators managing fleets of USB connected Jabra devices in shared offices and home-office environments
  • Integration engineers embedding device management tasks into enterprise tooling
  • Support and operations teams validating device state during troubleshooting

For a detailed reference of commands and options, see JabraCLI Reference.

USB connected devices only

Be aware that only USB connected Jabra devices (including dongle connected headsets) are currently supported. See Supported Devices.

Manage Devices Offline ​

Consider more user-friendly options

To manage a fleet of Jabra personal or meeting room devices - or update a single device - consider signing up for a Jabra Plus Management account or use Jabra Direct or Jabra Xpress. These are simpler options for a more user-friendly experience.

Customers looking to implement a fully offline device management solution - e.g. for secure environments without internet access - can use JabraCLI as the basic building block to update firmware and manage centrally defined device settings without any cloud dependencies at runtime.

For example, this enables IT administrators to apply a pre-defined configuration on Jabra devices to ensure they are always set up according to company policy when connected.

This is what the jabracli config commands are designed for — the workflow below outlines how to prepare and roll out such a configuration.

High-Level Workflow ​

Regardless of how the configuration is produced, the offline workflow follows the same shape:

Prepare config file

Produce a config.json file and the firmware file(s) it references. There are two supported ways to do this - both produce a configuration that jabracli config apply can consume:

Option 1 - Export from Jabra Plus Management (recommended if you have a tenant)

Design the configuration in a UI instead of authoring JSON by hand. Requires a Jabra Plus Management tenant on cloud.jabra.com.

  1. Sign in to your Jabra Plus Management tenant on cloud.jabra.com.
  2. Create the desired device configuration in the Jabra Plus Management UI and export it in the format compatible with JabraCLI. This produces a config.json file.
  3. Run jabracli config resolve --config <path-to-config.json> to download the firmware files referenced by the exported configuration.

Option 2 - Author the configuration manually

Suitable when you do not have a Jabra Plus Management tenant or want full control over the configuration file contents.

  1. Create a config.json file with the desired device settings and firmware versions.
    • See Configuration File Example for the file format and options.
    • Use jabracli device list and jabracli firmware list to get product ID (PID) and firmware version information.
    • Use jabracli config show --config <path-to-config.json> to validate the file.
  2. Download the firmware file(s) referenced by the configuration - from jabra.com/support or via jabracli firmware download.
Distribute to target machines

Distribute JabraCLI together with the configuration file and firmware file(s) to the target machines where Jabra devices will be connected. Place the configuration and firmware files in a location available on the local file system, and install the JabraCLI executable via software distribution tools or manual installation.

Automate applying the configuration

Automate applying the configuration by periodically running jabracli config apply --config <path-to-config.json> on each target machine. This applies the configuration and firmware updates on matching connected devices.

Integrate with Purpose-Built Multi‑Vendor Enterprise Systems ​

Customers with niche needs for device management setup - e.g. need for uniform device management across different brands of devices, or need to integrate device management into existing enterprise software - can use JabraCLI as a component in a more complex solution that combines the tool with other software and scripts.

The not-continuously-running nature of the JabraCLI commands makes it suitable for integration into larger scripts and software solutions that perform multiple tasks, where device management is just one part of the overall workflow.

Run One-Off Device Tasks ​

Technical users can also use JabraCLI for one-off device management operations, e.g. to update the firmware on a specific Jabra device or to read a specific device property for troubleshooting purposes.

Embed Device Management in Third-Party Software ​

Integration partners building software with Jabra device management capabilities can use JabraCLI as a component in their solution to perform specific device management tasks like updating firmware, applying configurations, or retrieving device information.

For this use case it is recommended to also understand the capabilities of the Jabra SDKs. They integrate more naturally into supported development stacks (JavaScript and .NET). However, for firmware update capabilities JabraCLI is currently the only option.