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

XML manifest file configuration parameters

Configuration parameters on the STB can be overridden by supplying override values in the XML manifest file. You do this by creating subtags to the PermanentParams tag in the XML. Below is a list of the supported parameters in this version of the software. Please keep in mind the supported parameters may change slightly between different DBL versions. Please check the DTD file describing all these parameters carefully.

In DBL versions older than 7.x, a few parameters have different names when used in the XML manifest file. These are IPConfigMethod (known in the XML manifest as IPResolution) and CurrentColorCoding (known as UserColorCoding).

Parameter Valid values Description
<IPResolution> DHCP
Fixed
Defines how the default network interface should be configured, either through DHCP or manually configured (also known as using fixed IP).
<IPAddress> IP address is used if IPResolution is set to Fixed
<Netmask> Netmask is used if IPResolution is set to Fixed.
<Gateway> Gateway is used if IPResolution is set to Fixed
<DNS1> DNS1 is used if IPResolution is set to Fixed
<DNS2> DNS2 is used if IPResolution is set to Fixed
<DhcpTimeout> >0 DHCP answer timeout in seconds.
<SplashOrder> 1 - 4, 6 - 7 A sequence of download protocols used for retrieval of the boot splash.
1 - Bootcast
2 - TFTP
3 - Local storage
4 - SAP (Session Announcement Protocol)
5 - Reserved
6 - HTTP
7 - USB
<BootOrder> 1 - 4, 6 - 7 A sequence of download protocols used for retrieval of the boot image.
1 - Bootcast
2 - TFTP
3 - Local storage
4 - SAP (Session Announcement Protocol)
5 - Reserved
6 - HTTP
7 - USB
<DiagnosticOrder> 1 - 4, 6 - 7 A sequence of download protocols used for retrieval of the diagnostic image.
1 - Bootcast
2 - TFTP
3 - Local storage
4 - SAP (Session Announcement Protocol)
5 - Reserved
6 - HTTP
7 - USB
<FirmwarelogAddress> An IP address + port to the log client, e.g. 192.168.0.10:19997
<NetconsolelogAddress> An IP address + port + MAC address to the log client, e.g. 192.168.0.10:19997@00:11:22:33:44:55
<Bootcast> A multicast address to where the meta data file are transmitted.
<BootcastTimeout> 1-255 Data timeout in seconds for Bootcast, e.g. the maximum time between two multicast data packets.
<BootcastAttempts> 1-255 The number of attempts before bootcast downloading fails.
<BootcastId> An arbitrary text string identifying the VIP. The bootcast id used to identify the correct meta data file, normally on the form <operator>-<VIP_TARGET>, for example, arris- vip4302. -dev should be added on development units.
<IgnoreBootcastVersion> Yes
No
If enabled, the image version on the network is not fetched and compared with the image stored in local storage. Can be useful if running without network connection such as some DVB units.
<TftpServer1> Primary TFTP server address.
<TftpServer2> Secondary TFTP server address.
<TftpServer3> Third TFTP server address.
<TftpServer4> Fourth TFTP server address.
<TftpPoolAttempts> 1-255 The number of attempts for all TFTP servers in the TFTP server pool.
<TftpNodeAttempts> 1-255 The number of TFTP attempts performed.
<TftpTimeout> 1-255 TFTP data timeout in seconds to be negotiated by the server.
<TftpRrqTimeout> 1-255 TFTP read request timeout in seconds.
<TftpBlockSize> 8 - 65464 TFTP data block size in bytes to be negotiated with the server.
<SapAddress> Sets the multicast address and port for SAP (Session Announcement Protocol). Can also be a DNS name, which will be resolved using DNS. In this case, the SAP multicast address and port is expected in a text record reply from the DNS server.
<SapTimeout> 1 - 255 Data timeout in seconds for SAP, e.g. the maximum time between two multicast data packets.
<SapAttempts> 1 - 255 The number of attempts before SAP downloading fails.
<SapId> An arbitrary text string identifying the VIP. The SAP id used to identify the correct meta data file, normally on the form <operator>.<VIP model>, for example, arris.vip4302. If no SAP id is specified, the default SAP id is based on the bootcast id with slashes replaced by dots.
<HttpServer> URL or IP address to the HTTP boot server.
<HttpPort> 0 - 65535 Port number for HTTP boot server.
<HttpTimeout> 1 - 255 Connection and data timeout in seconds for HTTP requests.
<HttpAttempts> 1 - 255 The number of HTTP request attempts before failing.
<HttpProxy> Domain name or IP address to a HTTP proxy. If not specified, no HTTP proxy is used.
<HttpProxyPort> Port number for a HTTP proxy.
<SplashFilename> Splash filename when using the TFTP protocol.
<KernelFilename> Kernel (boot image) filename when using the TFTP protocol.
<DiagnosticFilename> Diagnostic image filename when using the TFTP protocol.
<NtpServerAddress> IP address to the NTP server.
<NtpServerList> <IP address>,<IP address>...,<IP address> Comma separated list of IP addresses to NTP servers.
<DhcpServerAddress> IP address of the DHCP server used.
<IgmpVersion> 0 - 3 Force the IGMP version on the network interface used. When set to 0, the Linux kernel will auto detect the IGMP version starting with version 3 and fallback to version 2 if not all clients on the same network supports version 3.
<VendorClassId> Vendor class ID string used for identifying the VIP model in the DHCP communication, normally on the form <operator>_<VIP_TARGET>, for example, ARRIS_VIP4302. This parameter should be a uppercase mirror of BootcastId
<UserColorCoding> PAL
NTSC
PAL-M
PAL-N
PAL-NC
NTSC-J
NTSC-443
TV system format used.
<FrontButtonCode> A list of colon separated hex values used as key codes for enabled front buttons, e.g. 0x74:0x58:0x67:0x3b:0x3d:0x6a:0x57:0x69:0x6c:0x44. Note: In older box models this list was limited to only 8 buttons and the FrontButtonCodeExt was used to support more buttons (see below).
<FrontButtonCodeExt> Was used in conjunction with the FrontButtonCode parameter (see above) to specify additional front button key codes.
<FrontButtonHardReset> Specifies the time in seconds to push the power button before initating a software reset of the system. If not specified, no reset will occur.
<LedStandbyState> On
Off
Defines if the standby led should be active or not during standby.
<ShowIPSettings> Yes
No
Defines if the IP settings submenu is visible in the bootloader menu from the start.
<ShowAdvancedSettings> Yes
No
Defines if the advanced settings submenu is visible in the bootloader menu from the start.
<AllowSubmenuCodes> Yes
No
Defines if the secret codes should be allowed to enable the IP and advanced settings submenus for production units. This parameter is always regarded as enabled for development units.
<MenuHidden> Yes
No
Defines if the bootloader menu will be hidden (disabled) for the user or not.
<HideTvSystem> Yes
No
Defines if the TV system submenu should be hidden for the user or not.
<InternalProgress> Yes
No
Turns on or off the internal progress bar used for showing the boot progress.
<ProgressbarColor> 0-255,0-255,0-255 R,G,B value specifying the color to be used for the progress bar.
<RFFrequency> Specifies the RF frequency to use on models having an RF modulator.
<Language> IETF language tag.
DBL version < 7: en-US, sv-SE, nl-NL, tr-TR, pt-PT
Specifies the language to use for status and error messages during boot as well as the language used in dialogs and boot menu in the bootloader.
<Messages> See default messages here Customer or language specific status and error messages for screen or front panel. Not used in DBL 7 and newer.
<StatusScreen> Yes
No
Turns status and error messages on or off during boot.
<StatusScreenColor> 0-255,0-255,0-255 R,G,B value specifying the color of the status and error messages on screen.
<HideUpdatingMsg> Yes
No
Turns on or off the updating status message shown during boot (defined by the message tag <StatusmsgUpdating> for DBL version < 7).
<InfoScreen> Yes
No
Specify if the information dialog should be shown or not, invoked by pressing the info button on the remote during boot.
<InfoKey> Additional key code for displaying the information dialog during DBL boot.
<MenuKey> Additional key code for activating the boot menu in the bootloader.
<DiagnosticKey> Key code for activating the diagnostic image.
<FactoryReset> Yes
No
Enables or disables (grays out) the factory reset button in the boot menu which allows the end user to perform a factory reset.
<RemoveSoftware> Yes
No
Enables or disables (grays out) the remove software button in the boot menu which allows the end user to perform a removal of the splash image, boot image and diagnostic image stored in the unit.
<BootWithoutNet> Yes
No
Specifies if the box should continue to boot if network is not present and no IP information is available. However, network link is always first listened for. This parameter must be disabled (i.e. No) when using a three stage boot loader.
<DvbNetworkId> Specifies the default DVB network ID to use for software updates using the golden image on DVB enabled units. 65536 (-1) means auto detect.
<DvbFrequency> Specifies the default DVB frequency to connect to for software updates using the golden image on DVB enabled units.
<DvbSymbolRate> Specifies the default DVB symbol rate to use for software updates using the golden image on DVB enabled units.
<DvbModulation> 16QAM
32QAM
64QAM
128QAM
256QAM
Specifies the default DVB modulation to use for software updates using the golden image on DVB enabled units.
<IRFrequency> Specifies the IR frequency in kHz to select on boards having multiple IR receivers.
<IRProtocols> P1[:ID1,...,IDn];...;Pn[:ID1,...,IDn]
where ID is a number and P is:
KREATVIR
SEJIN
RSTEP_KPN
RSTEP
NEC
RC5
RCMM
Specifies the IR protocols that should have priority. Entries are separated using semicolon and optional RCU IDs are comma separated after a colon. Example values:
KREATVIR
RCMM:52,80
KREATVIR;RSTEP:21
<IgnoreVci> Yes
No
Ignore VCI parameters (Vendor Class Information sent in DHCP option 43). Useful when the DHCP server cannot be used for sending boot parameters such as in local NAT networks.
<Diagnostic> Yes
No
Enables or disables (grays out) the diagnostic button in the boot menu which allows the end user to start a special diagnostic software.
<TblShowSplash> Yes
No
Enables or disables if the splash should be displayed when there is a valid TBL present.
<WifiWizardDisabled> Yes
No
Specifies if the WiFi or network wizard should be allowed to displayed or not during boot.
<WifiWPSDisabled> Yes
No
Specifies if WPS should be disabled or not.
<WiFiRSSI> Comma separated list with quality:rcpi values specifying the mapping between RCPI signal levels and their quality levels, e.g. 0:-100,1:-90,2:-80,3:-70,4:-60,5:-50, which is currently what is being used.
<DiagnosticStorageDevice> mtd2
mtd3
Specifies what storage device the diagnostic image is located. Currently mtd2 and mtd3 refers to the flash and reserved partitions in the local flash memory. mtd3 must only be used if the reserved partition feature is enabled at production time. The reserved partition must use UBIFS.
<Translations> Base64 encoded MO translations file, specified in a sub tag with the language code.

5.1.1.p8

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