Table Of Contents
VQE-C Configuration Overview
System Configuration File
Network Configuration File
VQE-C Configuration Overview
This chapter provides overview information on the VQE Client (VQE-C) configuration and contains the following topics:
•
System Configuration File
•
Network Configuration File
System Configuration File
The VQE-C system configuration file defines the start-up or "factory default" settings for VQE-C parameters as integrated into a particular platform. The file is text-based and may be edited by the VQE-C integrator using a text editor. Some aspects of the contents of this configuration file and its processing are as follows:
•
All parameters are optional. If a value is not given, the VQE-C assumes a default value for the parameter as defined in the software. The VQE-C parameter default values are documented in the "VQE-C Configuration Parameters: Reference Information" section on page 3-5. The parameters can also be displayed with the show system-config defaults CLI command.
•
If a parameter is assigned an invalid value within the file, an error message is logged upon its processing, the invalid value is ignored, and the VQE-C assumes its software default value for the parameter.
•
If a parameter is not recognized (for example, the parameter name is misspelled), it is ignored without an error or warning being generated.
•
If the system configuration file is not syntactically valid, the file is not loaded. The VQE-C uses the software default values for all parameters in this scenario. For information about the configuration file syntax, see the "VQE-C System Configuration File Syntax" section on page 3-1.
The VQE-C must be supplied with the pathname of the system configuration file when the VQE-C is initialized (vqec_ifclient_init() API). This path may refer to read-only memory, as the VQE-C does not write to this file. If the file is writeable and any changes are made to the system configuration file after initialization, they do not affect the VQE-C until the VQE-C is reinitialized. For information on the vqec_ifclient_init() API, see VQE-C System Integration Guide.
The show system-config start-up CLI command may be used to display the contents of the system configuration file.
Network Configuration File
The VQE-C can also read configuration from a second file called the network configuration file. Parameter values within this network-supplied configuration file override any settings to matching parameters within the system configuration file. If a parameter is not specified in the network configuration file, the VQE-C uses one of the following:
•
If a value for this parameter is present in the system configuration file, the VQE-C uses this value.
•
If no value for this parameter is present in the system configuration file, VQE-C uses the VQE-C software default value.
To enable the VQE-C to use a network configuration file, the system configuration file must include a pathname for the network_cfg_pathname system configuration parameter. This pathname should refer to a location in writeable, nonvolatile storage (for example, flash memory) so that the file contents can be updated over the network and so that updates persist across a reboot.
Not all of the VQE-C configuration parameters are supported within a network configuration file. As examples, the channel_lineup and network_cfg_pathname parameters, which specify the location at which channel lineups and network configuration updates are stored, may not be updated.
Tip
To find out whether assignments to a VQE-C parameter are supported within a network configuration file, see the Configurable with Network field for each parameter description in the "VQE-C Configuration Parameters: Reference Information" section on page 3-5.
Starting with VQE Release 3.4, the VQE-C is also capable of reading configuration from a third file called the override configuration file. Parameter values within this configuration file override any settings to matching parameters within either the system configuration or the network configuration files. If a parameter is not specified in the override configuration file, the VQE-C uses either the value from its network configuration, system configuration, or its software default value (in that order).
Note
Override configurations are applicable to only those deployments where the necessary extensions have been made to STBs and the configuration deployment servers to support the delivery of override configuration files to a STB. For a more information on the deployment of override configurations, see VQE-C System Integration Guide.
To enable the VQE-C to use an override configuration file, the system configuration file must include a pathname for the override_cfg_pathname system configuration parameter. This pathname should refer to a location in writeable, non-volatile storage (for example, flash memory) so that the file contents can be updated and so that updates persist across a reboot.
Not all VQE-C configuration parameters are supported within a network or override configuration file.
Tip
To find out whether assignments to a VQE-C parameter are supported within a network or override configuration file, see the "Configurable with Network" and "Configurable as Override" fields for each parameter description in the "VQE-C Configuration Parameters: Reference Information" section on page 3-5.
On initialization the VQE-C derives a "running configuration" by reading the system configuration file and merging those parameter values with the contents of the network configuration file (if one is present) and override configuration file (if one is present). The VQE-C services are initialized using this merged running configuration. After the initial STB initialization, any changes to the network configuration file or override configuration file are applied dynamically to the extent defined for each parameter.
For platforms that provide access to the VQE-C CLI, the show system-config network and the show system-config override CLI commands can be used to display the network configuration file and override configuration file contents, respectively. Only parameters present in the file and assigned valid values are displayed.
The show system-config command can be used to display the configuration currently running on the VQE-C. This represents the configuration that is actually in use, as derived from merging the override configuration file, network configuration file, start-up configuration file, and the VQE-C software defaults (with highest-to-lowest precedence).
The network configuration file can be delivered in the following ways:
•
By a platform specific delivery mechanism
•
By the VQE-C itself if the configuration delivery infrastructure (CDI) is used
The override configuration can not be delivered via CDI. Therefore, a platform specific implementation is required.
For information about delivery of the network configuration file using the CDI, see the "Configuration Delivery Infrastructure" section on page 2-4.