RDK Resources
[*RDK Preferred*]
Code Management Facility
RDK Forums
[RDK Conferences]
RDK Support
Archives
Papers & Presentations Archive
WebConfig is used as the production delivery mechanism for T2 report profiles.
T2 report profiles are created in XConf, then are referenced via T2 Rules. When a WebConfig Supplementary Services request for Telemetry occurs, XConf resolves the rules in order to identify all T2 report profiles that apply. Then XConf packages up the T2 report profiles into a full set and returns the JSON to WebConfig.
Unlike what is done for the T1/Legacy/DCM telemetry configuration, T2 does not reach out to XConf directly for T2 report profiles.
If you are using T2 profiles for development, you may be setting profiles manually on the device by setting Device.X_RDKCENTRAL-COM_T2.ReportProfiles. This will work, but if WebConfig is enabled, the profiles you set will be replaced by WebConfig supplementary services on reboot and during the maintenance window. This is by design because the T2 component always expects a full set of T2 profiles, so any profiles that are not present in the set received will be removed. See Report Profiles Set for more information.
To configure a T2 profile for delivery by WebConfig, please continue reading.
If instead of using WebConfig, you'd like to disable the WebConfig Supplementary Services request altogether, please see Disabling WebConfig Supplementary Services.
Use the XConf Admin UI and follow the instructions in this section. See Feature Validation : Xconf Server for information about the RDK-M XConf instance.
For more details on T2 profiles, please see the following links:
Please watch the demo video (TBD) for a quick lesson in creating a T2 Report Profile in XConf.
A few things to note:
Profile.Name
if you include that in your T2 profile (which is highly recommended!).Please watch the demo video (TBD) for a quick lesson in creating a T2 Rule in XConf.
A few things to note:
Configure WebConfig Supplementary Services for Telemetry on a device by setting Device.X_RDK_WebConfig.SupplementaryServiceUrls.Telemetry to http:
//<yourWebConfigInstance>/api/v1/device/<mac>/config
, where <mac> is the MAC address of the device, all lowercase without colons. You can do so via WebPA in the cloud or dmcli or rbuscli directly on the device. For instance, in the RDK-M environment, you would use http:
//webconfig.rdkcentral.com:9007/api/v1/device/<mac>/config
For example,
dmcli eRT setv Device.X_RDK_WebConfig.SupplementaryServiceUrls.Telemetry string
http:
//webconfig.rdkcentral.com:9007/api/v1/device/aabbccddeeff/config
If instead of using WebConfig, you'd like to disable the request for WebConfig Supplementary Services for Telemetry altogether, you can do so by setting the data model property to "NULL". You can do so via WebPA in the cloud or dmcli or rbuscli directly on the device.
For example,
dmcli eRT setv Device.X_RDK_WebConfig.SupplementaryServiceUrls.Telemetry string NULL
There are two ways to make a device get the latest T2 profiles:
Device.X_RDK_WebConfig.ForceSync
to "telemetry". You can do this in one of two ways:dmcli eRT setv Device.X_RDK_WebConfig.ForceSync string "telemetry"
When T2 profiles are received via WebConfig, they are persisted in msgPack format in /nvram/
.t2reportprofiles
/profiles
.msgpack
To check that the device received the profiles on the device, you can get a human-readable version of the profiles.msgpack file by doing the following on the device:
webcfg_decoder -m
/nvram/
.t2reportprofiles
/profiles
.msgpack
v