RDK Platforms define a set of environment variable and function (through shell scripts) which enables the middle-ware middleware 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-Broadbandcomponent.
...
These are set of scripts provided to help you bring up, manage, control and monitorRouters. 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.
...
| 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 | Null device (i,e /dev/null). |
| MESH_SUPPORTED | Give info of Mesh Support. |
| WAN_TYPE | Display input wan type. |
| WanFailOverSupportEnable | Support for WanFailOver. |
| BOX_TYPE | Model name of the Router. |
| ARM_INTERFACE | Holds wan interface name. |
| MODEL_NAME | Model name of the Router. |
| ATOM_INTERFACE | Holds wan interface name. |
| ATOM_INTERFACE_IP | Holds br0 interface ip . |
| ATOM_PROXY_SERVER | Holds br0 interface ip. |
| PARODUS_URL | Parodus server url (local ip address with specified parodus port no). |
| WEBPA_CLIENT_URL | webpa client url(local ip address with specified webpa port no). |
| 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 | Provide tftp server ip address. |
| PART_SIZE_OFFSET | Number used for log rotation. |
| SERVERURL | Webpa Url . |
| WEBCONFIG_INTERFACEWebpa Url | Holds wan interface name. |
2)/etc/dcm.properties
| Inline Table Editing |
|---|
| enableCompactTheme | false |
|---|
| enableExport | false |
|---|
| enableFiltering | false |
|---|
| enableRowNumbers | false |
|---|
| enableInlineEdit | true |
|---|
| enableSorting | false |
|---|
| tableHeight | 0 |
|---|
| enableAutoStretch | false |
|---|
| enableDragAndDrop | false |
|---|
|
|
...
...
...
| log server URL. | | DCM_LOG_SERVER | Indicate |
|
...
| log upload server URL. | | DCM_LOG_SERVER_URL | Indicate |
|
...
| log upload settings 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 telemetry Log server URL. | | DCM_LA_SERVER_URL | Indicate upload path for logs. |
|
3)/etc/include.properties
| Variable Name | Description |
|---|
| LOG_PATH | Defines path for rdkb logs. |
| CRON_SPOOL | Defines path for Cron spool. |
| CRON_FIFO_FILE | Defines path for Cron fifo file. |
| PERSISTENT_PATH | Path for storing PERSISTENT PERSISTENT data. |
| RAMDISK_PATH | Path for storing RAMDISK. |
| TEMP_LOG_PATH | Path for storing temporary logs. |
| UTILITY_PATH | Path for rdkb utilities. |
| RDK_PATH | Path for rdkb utilities. |
| EROUTER_INTERFACE | Indicates interface name for erouter. |
| TELEMETRY_JSON_RESPONSE | File for storing telemetry response. |
| CLOUDURL | Defines server URL. |
...
4) /etc/logFiles.properties → ->Contains component name with specified log file name.
...
| 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 Path for storing telemetry atom logs. |
| DCM_LOG_FILE | Part Path for storing dcm script logs. |
...
| Script Name | Description |
|---|
| StartDCM.sh | Script for establishing connections with webpa server. |
| DCMscript.sh | Script for executing operations after connection establishment with servertelemetry support (T1). |
| 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 storing device logs. |
| backupLogs.sh | Script to backup back up the logs for the device. |
| bank_image_switch.sh | Script for firmware upgrade. |
| deviceInitiatedFWDnld.sh | Script for firmware upgrade. |
| imageFlasher.sh | Script for remote flashing of image. |
| rpi_sw_install.sh | Script for firmware upgrade. |
| rpi_sw_install1.sh | Script for firmware upgrade. |
| snmpUtils.sh | Script for snmp pa support. |
| rpi_image_Flasher.sh | Script for firmware upgrade. |
| swupdate_utility.sh | Remote swupdate facility script. |
| dcaSplunkUpload.sh | Script for T1 support. |
| dca_utility.sh | Script for T1 support. |
| log_timestamp.sh | Script for displaying time stamp. |
| disableIpv6Autoconf.sh | Used to disable ipv6 with defined interface. |
| getpartnerid.sh | For getting partner id. |
| disable_systemd_restart_param.sh | Support script for disable_systemd_restart_param.service. |
| handlesnmpv3.sh | Used to start snmpd.service . |
| ocsp-support.sh | Support script for ocsp-support.service. |
| disableUnusedInterfaces.sh | To disable unused interfaces. |
| postwanstatusevent.sh | For getting wan status. |
| startSSH.sh | Support script for dropbear service. |
| utils.sh | To get the basic info of router utilities. |
| core_shell.sh | For generating crash/dump logs. |
| deviceInitiatedFWDnld.sh | Script for firmware upgrade. |
| getaccountid.sh | Script for target specific get account ip. |
| interfaceCalls.sh | Enables interface-oriented operations. |
| run_rm_key.sh | Executed to generate the server.pem by using openssl. |
| corrective_action.sh | Verifies the running operations the router device like Captive portal. |
| resource_monitor.sh | Used to monitor the tasks and functionality of the router device. |
| self_heal_connectivity_test.sh | For auto healing of the parameters and tasks. |
| task_health_monitor.sh | For monitoring functionality of the tasks in router. |
Sysint-Broadband derived Services
| Inline Table Editing |
|---|
| Service | description |
|---|
| rfc.service | For enabling rfc services (RFC feature support). | | dropbear.service | Service for ssh connection-oriented functionality. | | dump-backup.service |
|
...
| Service for process crash. | | ntpd.service | Service for invoking network time |
|
...
| . | | previous-log-backup.service | Service file for previous log backup. | | swupdate.service | Software update-oriented service |
|
...
