Firmware Update Workflow

1. FW Update Methods
   a. AWS
   b. MinIO

2. Add Manifest URL to zMan MSP Admin Site

3. Perform Firmware Update from zMan Director UI

Firmware Update Overview

zTC firmware updates can be performed from zMan Director using either of the following methods:

• Amazon S3 Cloud
• Built-in MinIO S3-based object store

Using Amazon S3 Cloud

For cloud-based updates, AmZetta uploads the new zTC firmware to Amazon S3 and provides a link to the customer. This link should be added in the zMan MSP Admin site so the new firmware becomes available in zMan Director.

For cloud-based updates, skip the MinIO upload steps and proceed directly to Add Manifest URL to zMan MSP Admin Site.

Using MinIO

zTC firmware can also be uploaded and updated from zMan using the built-in MinIO server.

To perform a firmware update using MinIO, complete the following steps:

1. Upload the zTC firmware image and manifest file to MinIO.
2. Add the manifest file link to the zMan MSP Admin site.
3. Perform the firmware update from the zMan Director UI.

Upload zTC FW Image and Manifest File to MinIO

This section explains how to upload a zTC firmware image and manifest file to the internal MinIO object store used by zMan Director.

Access the MinIO Console

Open the MinIO console using the following URL:

https://<zMan-IP>:7080/minioconsole/login

Log in using the MinIO administrator credentials configured during zMan Director setup.

Username: <admin-user>
Password: xxxx

Upload the Firmware Image and Manifest File

1. Log in to the MinIO console.

2. Create a bucket for the zTC firmware files.

3. Click Manage for the bucket and change the access policy to public.

4. Go to the Buckets page.

5. Upload the zTC firmware image file.

   The firmware image should use the .ima file extension.

6. After the firmware image is uploaded, select the firmware image file.

7. From the Selected Object panel, click Share.

8. Copy the firmware image URL.

The firmware image URL should use the following format:

https://<zMan-IP>:7080/minio/<bucketname and path>/xxx.ima

Example:

https://<zMan-IP>:7080/minio/ztc-fw/1.2.620.ima

Update the Manifest File

Before uploading the manifest.json file, update the manifest so the path value points to the uploaded firmware image URL.

Example:

{
  "model": "zTC3150L",
  "version": "1.2.620",
  "images": [
    {
      "from": "*",
      "to": "1.2.621",
      "path": "https://<zMan-IP>:7080/minio/ztc-fw/1.2.620.ima",
      "checksum": "317287ff3bd36a9e859a5be999ae014f"
    }
  ]
}

Upload the Manifest File

After the manifest file is updated, upload the manifest.json file to the same MinIO bucket.

The manifest URL should use the following format:

https://<zMan-IP>:7080/minio/<bucketname and path>/manifest.json

Example:

https://<zMan-IP>:7080/minio/ztc-fw/manifest.json

Important Notes

The firmware image must be uploaded before the manifest file because the manifest needs to reference the final firmware image URL.

The MinIO bucket access policy must be set to public so zMan Director can retrieve the firmware image during the firmware update process.

The shared MinIO URL may be temporary depending on the MinIO share settings. Verify that the URL used in the manifest will remain accessible when zMan Director performs the firmware update.

Add Manifest URL to zMan MSP Admin Site

This section explains how to add the firmware manifest URL to the zMan MSP Admin site so the firmware package becomes available in zMan Director.

Overview

After the zTC firmware image and manifest.json file are uploaded to MinIO or Amazon S3, the manifest URL must be added to the zMan MSP Admin site.

For cloud-based firmware updates, AmZetta provides the Amazon S3 or CloudFront manifest URL. In that case, the MinIO upload process can be skipped and the provided manifest URL can be added directly in the MSP Admin site.

For MinIO-based firmware updates, use the manifest URL from the MinIO bucket.

Access the zMan MSP Admin Site

Open the zMan MSP Admin site using the following URL:

https://<zMan-IP>:7080/

Log in using the MSP Admin credentials.

Username: [email protected]
Password: xxxxx

The MSP Admin site displays available tenant information under Tenant Management > Tenants.

Add the Firmware Manifest URL

1. In the zMan MSP Admin site, go to System Tools > Firmware.

2. Add the manifest URL for the firmware package.

For MinIO, the manifest URL should use the following format:

https://<zMan-IP>:7080/minio/ztc-fw/manifest.json

For Amazon S3 or CloudFront, the manifest URL may use a format similar to the following:

https://xxxx.cloudfront.net/zTC3150L/1.x.xxxx/manifest_1.x-vxxx.json

3. Save the firmware entry.

After the manifest URL is saved, the firmware package becomes available to zMan Director for firmware update tasks.

Reference Screenshot

The following screenshot shows the MSP Admin interface with the left navigation visible, including the System Tools > Firmware area where firmware management is accessed.

Important Note

Firmware update supports one firmware image file at a time for each firmware version.

Perform Firmware Update from zMan Director UI

This section explains how to perform a zTC firmware update from the zMan Director UI after the firmware manifest has been added in the zMan MSP Admin site.

Overview

After the firmware manifest URL is added in MSP Admin, the firmware package becomes available in zMan Director.

Administrators can apply firmware updates from Device Settings > Firmware Update. Updates can be applied based on the current filter or to all available devices.

Perform a Firmware Update

1. Log in to zMan Director.

2. Navigate to Device Settings > Firmware Update.

3. Use the LIST tab to view available devices.

4. Apply any needed filters to target devices by model or firmware version.

5. Click the firmware update icon on the right side of the page.

6. In the Update Firmware window, choose one of the following options:

   • Update based on filter
   • Update all

7. Select the Target Version.

8. Select the Firmware Image.

9. Confirm the From version field.

10. Choose the update timing:

    • Immediate
    • Schedule

11. Click YES to start or schedule the firmware update.

Immediate Firmware Update

Select Immediate when the firmware update should begin right away.

When the update is applied, the zTC begins downloading the firmware image. After zMan receives confirmation that the download is successful, zMan sends the flash firmware command to the device.

Scheduled Firmware Update

Select Schedule when the firmware update should run at a specific time.

A scheduled firmware task can be used to control when the firmware download and flash process begins. Depending on the task status, scheduled firmware update tasks may be rescheduled or canceled.

Offline Device Behavior

zMan Director allows firmware updates to be assigned to offline devices.

If a device is offline when the update is assigned, the firmware update task is placed into a deferred state. When the device comes back online, zMan pushes the firmware update task to the device.