RDK Resources
[*RDK Preferred*]
Code Management Facility
RDK Forums
[RDK Conferences]
RDK Support
Archives
Papers & Presentations Archive
RDK Platforms define a set of environment variable and function (through shell scripts) which enables the middle-ware and application to access device specific information. There are service files and shell scripts to do this job and this are provided by the Sysint-Broadband component.
SysInt scripts: Generic build and system integration scripts.
These are set of scripts provided to help you bring up, manage, control and monitor Routers. These scripts include the following:
- Erouter0 info
- Script for DCM simulator Support
- Script for NTPD
- Factory Reset operation
- Log Rotate operation
- Self heal operation
- Firmware Upgrade functionality
- Webpa Server URL
- Remote Management operation
Some device specific information is available from shell environment in form of variables mainly through property files i.e. /etc/device.properties (configuration file specific to a platform). Platforms also can override certain properties if needed.
Along with this a collection of utility scripts defined under “/lib/rdk” provide information regarding common properties.
Environment variables
1) /etc/device.properties
| Variable Name | Description |
|---|---|
| DEVICE_TYPE | Type of the device (Broadband or Extender) |
| BUILD_TYPE | Build type ( dev or prod) |
| MOCA_INTERFACE | Name of the MOCA interface |
| ETHERNET_INTERFACE | Name of the Ethernet interface |
| BUILD_VERSION | Build Version |
| MANUFACTURE | OEM manufacturer name |
| LOG_PATH | Path for device logs. |
| CORE_PATH | Path for corefiles |
| PROCESS_RESTART_LOG | |
| MESH_SUPPORTED | Give info of Mesh Support. |
| WAN_TYPE | Display input wan type. |
| WanFailOverSupportEnable | |
| BOX_TYPE | Model name of the Router. |
| ARM_INTERFACE | |
| MODEL_NAME | Model name of the Router. |
| ATOM_INTERFACE | |
| ATOM_INTERFACE_IP | |
| ATOM_PROXY_SERVER | |
| PARODUS_URL | |
| WEBPA_CLIENT_URL | |
| OneWiFiEnabled | Indicate support of Onewifi for the device. |
| MODEL_NUM | Model number for the device |
| NVRAM2_SUPPORTED | Indicate support of NVRAM for the device. |
| TFTP_SERVER_IP | |
| PART_SIZE_OFFSET | |
| SERVERURL | |
| WEBCONFIG_INTERFACE | Webpa Url |
2)/etc/dcm.properties
| Variable Name | Description |
|---|---|
| LOG_SERVER | Indicate Log server URL |
| DCM_LOG_SERVER | Indicate Log server URL |
| DCM_LOG_SERVER_URL | Indicate Log server URL |
| DCM_SCP_SERVER | Indicate Log server URL |
| HTTP_UPLOAD_LINK | Indicate upload path for logs. |
| DCA_UPLOAD_URL | Indicate Log server URL |
| DCM_HTTP_SERVER_URL | Indicate Log server URL |
| DCM_LA_SERVER_URL | Indicate upload path for logs. |
3)/etc/include.properties
| Variable Name | Description |
|---|---|
| LOG_PATH | |
| CRON_SPOOL | |
| CRON_FIFO_FILE | |
| PERSISTENT_PATH | |
| RAMDISK_PATH | |
| TEMP_LOG_PATH | |
| UTILITY_PATH | |
| RDK_PATH | |
| EROUTER_INTERFACE | |
| TELEMETRY_JSON_RESPONSE | |
| CLOUDURL |
4) /etc/logFiles.properties → Contains component name with specified log file name.
5) /etc/telemetry2_0.properties
| Variable Name | Description |
|---|---|
| T2_0_BIN | Path for telemetry binary. |
| T2_0_APP | Name of telemetry binary. |
| T2_0_LOGFILE | Path for storing telemetry logs. |
| T2_0_ATOM_LOGFILE | path for storing telemetry atom logs. |
| DCM_LOG_FILE | Part for storing dcm script logs. |
Shell Scripts
| Script Name | Description |
|---|---|
| StartDCM.sh | Script for establishing connections with webpa server. |
| DCMscript.sh | Script for executing operations after connection establishment with server. |
| uploadSTBLogs.sh | Script for uploading logs to the server. |
| interfaceCalls.sh | Script for basic functions execution like reboot, uptime. |
| commonUtils.sh | Script for basic linux utilities execution. |
| logfiles.sh | Script for defining path and file for storing device logs. |
| backupLogs.sh | Script to backup the logs for the device. |
| bank_image_switch.sh | |
| deviceInitiatedFWDnld.sh | |
| imageFlasher.sh | Script for remote flashing of image. |
| rpi_sw_install.sh | |
| rpi_sw_install1.sh | |
| snmpUtils.sh | |
| rpi_image_Flasher.sh | |
| swupdate_utility.sh | Remote swupdate facility script. |
| dcaSplunkUpload.sh | |
| dca_utility.sh | |
| log_timestamp.sh | Script for displaying time stamp. |
| disableIpv6Autoconf.sh | |
| getpartnerid.sh | |
| disable_systemd_restart_param.sh | |
| handlesnmpv3.sh | |
| ocsp-support.sh | |
| disableUnusedInterfaces.sh | |
| postwanstatusevent.sh | |
| startSSH.sh | |
| utils.sh | |
| core_shell.sh | |
| deviceInitiatedFWDnld.sh | |
| getaccountid.sh | |
| interfaceCalls.sh | |
| run_rm_key.sh | |
| corrective_action.sh | |
| resource_monitor.sh | |
| self_heal_connectivity_test.sh | For auto recovery of the tasks |
| task_health_monitor.sh | For monitoring functionality of the tasks in router. |
Sysint-Broadband derived Services
| Service | description |
|---|---|
| rfc.service | For enabling rfc services. |
| dropbear.service | Service for ssh connection oriented functionality. |
| dump-backup.service | |
| hostapd_backup_check.service | Service verifies hostapd process |
| ntpd.service | Service for invoking network time. |
| ocsp-support.service | OCSP supported service. |
| previous-log-backup.service | Service file for previous log backup. |
| swupdate.service | Software update oriented service. |
| disable_systemd_restart_param.service | disable_systemd_restart_param for all ccsp service's |
Overview
Community Forums
Content Tools
Tasks