• Quick Start
  • Booting
  • Platform
  • Portals
  • References
    • API Reference TOI3
    • IIP Reference
  • Resources
ARRIS Enterprises, Inc. Confidential Information

XML manifest file

The STB begins the HTTP boot process by requesting a page from the server's root directory using the STB Bootcast ID. For a VIP4302WBT the request will be http://www.example.com/arris-vip4302wbt-dev. This file is known as the XML manifest.

For making the HTTP boot more dynamic and configurable on the server side, the STB adds its serial number, MAC address, boot loader version, software version, splash version and diagnostic image version as parameters to the request, e.g.

http://www.example.com/arris-vip4302wbt-dev?product=arris-vip4302wbt-dev&serial=1931690851&mac=00:02:9b:00:01:02&fw_version=6.3&kernel_version=1.0&splash_version=1.0&diagnostic_version=1.0

The response from the server should look something like this:

<sdk_root>/examples/http-boot/arris-vip4302wbt-dev

<?xml version="1.0"?>
<!DOCTYPE StbConfig SYSTEM "stbconfig.dtd">
<StbConfig>
<BootParams>
  <KernelUrl>http://www.example.com/bootimage</KernelUrl>
  <KernelVersion>1.0</KernelVersion>
  <SplashUrl>http://www.example.com/splashimage</SplashUrl>
  <SplashVersion>1.0</SplashVersion>
</BootParams>
<PermanentParams>
  <StatusScreenColor>0,0,0</StatusScreenColor>
</PermanentParams>
</StbConfig>

The manifest file contains two sections. The first section, BootParams, provides details on where the boot image and splash image can be found. Several different protocols can be specified here:


[] = Required
<> = Optional

Infocast: infocast://[multicast group]<:port>/[object name]
TFTP    : tftp://[server ip]<:port>/[path/to/file]
Local   : local://
HTTP    : http://<username:password@>[server name or ip]<:port>/[path/to/file]

User name and password can be percent-encoded and is used for basic access authorization. This feature is only supported in DBL version 6.7 and newer.

The second section of the XML manifest file, PermanentParams, can override some of the factory default configuration parameters. These overrides (not overwrites) will be saved in the STB flash memory, so even if the parameter is later removed from the manifest file the ARRIS boot loader will continue to use the last value provided. A Factory Reset of the STB is necessary to restore the factory default parameters again.

A full list of the supported parameters in this version of the DBL can be found here. Please keep in mind the supported parameters may change slightly between different DBL versions. Please check the DTD file carefully.

5.1.1.p8

Copyright (c) 2018 ARRIS Enterprises, LLC. All Rights Reserved. ARRIS Enterprises, LLC. Confidential Information.