Initial Provisioning via USB Key

Also known as “ZTP over USB”, this feature allows provisioning an unconfigured (factory erased) unit from a USB storage device like a thumb drive.

The USB device must contain a filesystem recognized by the OM (currently FAT32 or ext4) with a file named manifest.og in the root directory. This file specifies which provisioning steps will be done. An article with a partial description of the file format is here:

https://opengear.zendesk.com/hc/en-us/articles/115002786366-Automated-enrollment-using-USB

The USB device can be inserted any time (before or after power is applied to the unit) and as long as the unit is unconfigured, the ZTP over USB process will be triggered. Here “unconfigured” has the same meaning as for ZTP: no changes made to the ogconfig data store.

Note:Setting the root password on first log in counts as a config change.

The following manifest.og keys are implemented. This provides image installation, Lighthouse enrollment, and arbitrary script execution:

# manifest.og contains <key>=<value> pairs. Recognized keys are:

# image : Firmware image file name on the USB device's filesystem that will be flashed after boot once the image is validated

# script : Configuration script to run

# address : Primary Lighthouse address to enroll with

# api_port : Optional port to use for the primary address when requesting enrollment

# external_endpoints : List of additional "address:port" endpoints to fall back to when enrolling

# password : LH global or bundle enrollment password

# bundle : Name of LH enrollment bundle