RDK Resources
[*RDK Preferred*]
Code Management Facility
RDK Forums
[RDK Conferences]
RDK Support
Archives
Papers & Presentations Archive
profile
object
(Profile Properties)Property | Type | Required |
---|---|---|
name | string | Required |
versionHash | string | Required |
value | object | Required |
Name of the Profile. This is value is accessible from within the Report Profile as dataModel parameter "Profile.Name".
name
string
Unique value that is expected to change when anything within the Report Profile is changed.
versionHash
string
The JSON representing this Report Profile.
value
object
(JSON object which is a T2 Report Profile)Simple example to illustrate the JSON structure. The actual "value" object would be in the form of valid JSON representing a T2 report profile.
Code Block |
---|
{ "profiles": [ { "name": "Example_profile_1", "versionHash": "profile1Hash111", "value": {JSON representing a Report Profile} }, { "name": "Example_profile_2", "versionHash": "profile2Hash111", "value": {JSON representing a Report Profile} } ] } |
A profile set containing three profiles, "LMLITE_primer_TEST", "RDKB_CCSPWifi_Profile" and "RDKB_SelfHeal_Profile".
Note that an abbreviated set of parameters is used for each profile for illustrative purposes, therefore, these may not represent desired production profiles.
"value" objects would be in the form of valid JSON representing a T2 report profile.
Code Block |
---|
{ "profiles": [{ "name": "LMLITE_primer_TEST", "versionHash": "lmliteHash111", "value": { "Description": "A report for a few CCSP-LM-LITE details", "Version": "0.1", "Protocol": "HTTP", "EncodingType": "JSON", "ReportingInterval": 60, "TimeReference": "0001-01-01T00:00:00Z", "ActivationTimeOut": 90, "Parameter": [{ "type": "grep", "marker": "SYS_SH_TADProcess_restart", "search": "Restarting CcspTandDSsp", "logFile": "LM.txt.0", "use": "absolute" }, { "type": "event", "name": "LMLite_caught_wifi_disconnect", "eventName": "WIFI_INFO_clientdisconnect", "component": "ccsp_lmlite", "use": "count", "reportEmpty": false }, { "type": "dataModel", "name": "UPTIME", "reference": "Device.DeviceInfo.UpTime", "use": "absolute" }], "HTTP": { "URL": "https://<>", "Compression": "None", "Method": "POST", "RequestURIParameter": [{ "Name": "profileName", "Reference": "Profile.Name" }] }, "JSONEncoding": { "ReportFormat": "NameValuePair", "ReportTimestamp": "None" } } }, { "name": "RDKB_CCSPWifi_Profile", "versionHash": "wifiHash111", "value": { "Description": "Report to check WiFi Parameters", "Version": "1", "Protocol": "HTTP", "EncodingType": "JSON", "ReportingInterval": 180, "TimeReference": "0001-01-01T00:00:00Z", "Parameter": [{ "type": "dataModel", "reference": "Device.WiFi.Radio.1.Stats.X_<Cable Operator>_NoiseFloor" }, { "type": "dataModel", "reference": "Device.WiFi.Radio.2.Stats.X_<Cable Operator>_NoiseFloor" }, { "type": "event", "eventName": "2GclientMac_split", "component": "ccsp_wifiagent", "use": "absolute" }, { "type": "event", "eventName": "5GclientMac_split", "component": "ccsp_wifiagent", "use": "absolute" }, { "type": "event", "name": "wifiradio WIFI_COUNT", "eventName": "WIFI_MAC_1_TOTAL_COUNT:0", "component": "ccsp_wifiagent", "use": "count", "reportEmpty": false }, { "type": "dataModel", "name": "UPTIME", "reference": "Device.DeviceInfo.UpTime", "use": "absolute" }], "HTTP": { "URL": "https://<>", "Compression": "None", "Method": "POST", "RequestURIParameter": [{ "Name": "profileName", "Reference": "Profile.Name" }, { "Name": "reportVersion", "Reference": "Profile.Version" }] }, "JSONEncoding": { "ReportFormat": "NameValuePair", "ReportTimestamp": "None" } } }, { "name": "RDKB_SelfHeal_Profile", "hash": "selfHealHash2", "value": { "Description": "Report to check SelfHeal Parameters", "Version": "2", "Protocol": "HTTP", "EncodingType": "JSON", "ReportingInterval": 180, "TimeReference": "0001-01-01T00:00:00Z", "Parameter": [{ "type": "dataModel", "name": "Profile", "reference": "Device.DeviceInfo.X_RDK.RDKProfileName" }, { "type": "dataModel", "name": "Time", "reference": "Device.Time.CurrentLocalTime" }, { "type": "dataModel", "name": "mac", "reference": "Device.DeviceInfo.X_<Cable Operator>_WAN_MAC" }, { "type": "dataModel", "name": "erouterIpv4", "reference": "Device.DeviceInfo.X_<Cable Operator>_WAN_IP" }, { "type": "dataModel", "name": "erouterIpv6", "reference": "Device.DeviceInfo.X_<Cable Operator>_WAN_IPv6" }, { "type": "dataModel", "name": "PartnerId", "reference": "Device.DeviceInfo.X_RDKCENTRAL-COM_Syndication.PartnerId" }, { "type": "dataModel", "name": "Version", "reference": "Device.DeviceInfo.SoftwareVersion" }, { "type": "dataModel", "name": "AccountId", "reference": "Device.DeviceInfo.X_RDKCENTRAL-COM_RFC.Feature.AccountInfo.AccountID" }, { "type": "dataModel", "name": "MAC", "reference": "Device.DeviceInfo.X_<Cable Operator>_CM_MAC" }, { "type": "dataModel", "reference": "Profile.Name" }, { "type": "dataModel", "reference": "Profile.Version" }, { "type": "dataModel", "reference": "Device.DeviceInfo.UpTime", "use": "absolute" }, { "type": "event", "eventName": "SYS_ERROR_AdvSecurity_NotRunning", "component": "test_and_diagnostics", "use": "absolute" }, { "type": "event", "eventName": "SYS_SH_lighttpdCrash", "component": "test_and_diagnostics", "use": "count", "reportEmpty": false }, { "type": "dataModel", "name": "WAN_SSH_STATUS", "reference": "Device.DeviceInfo.X_RDKCENTRAL-COM_Syndication.WANsideSSH.Enable", "use": "absolute" }], "HTTP": { "URL": "http://<>:<port no>/telemetry2/v1/device/report", "Compression": "None", "Method": "POST", "RequestURIParameter": [{ "Name": "deviceId", "Reference": "Device.DeviceInfo.X_<Cable Operator>_CM_MAC" }, { "Name": "profileName", "Reference": "Profile.Name" }] }, "JSONEncoding": { "ReportFormat": "NameValuePair", "ReportTimestamp": "None" } } } ] } |
Send an empty set of profiles to remove all Telemetry 2.0 profiles from a device.
Code Block |
---|
{ "profiles": [] } |