RDK Resources
[*RDK Preferred*]
Code Management Facility
RDK Forums
[RDK Conferences]
RDK Support
Archives
Papers & Presentations Archive
Page History
| Table of Contents |
|---|
Firmware configuration - /xconf/swu/stb
IP address - It's not necessary to explicitly pass the IP address if this API is called from a device. In fact, it's discouraged since XConf will use the source IP address in the http request. If this API is called from another source (e.g. laptop), then the IP address of the device should be passed. In any case, a non-routable IP address (e.g. 10.x, 192.168.x) should not be passed to XConf. A non-routable IP address may be used in a warehouse. When a request to XConf comes from the warehouse, the IP address is converted to a NAT address.
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"input": {
"estbMac": "CC:CC:CC:CC:CC:C2",
"env": "ASDF",
"model": "ASDF",
"firmwareVersion": "1",
"bypassFilters": [],
"forceFilters": [],
"capabilities": [],
"timeZone": "UTC",
"time": "10/18/2016 12:51:00",
"ipAddress": "0:0:0:0:0:0:0:1",
"rcdl": false,
"rebootDecoupled": false,
"supportsFullHttpUrl": false
},
"rule": {
"type": "MAC_RULE",
"name": "11111111111111",
"noop": false
},
"filters": [
{
"type": "DownloadLocationRoundRobinFilter",
"id": "SINGLETON_DOWNLOAD_LOCATION_ROUND_ROBIN_FILTER",
"name": "DOWNLOAD_LOCATION_ROUND_ROBIN_FILTER_VALUE",
"noop": true
}
],
"explanation": "Request: com.comcast.xconf.estbfirmware.EstbFirmwareContext$Converted@23fe12cd[\r\n estbMac=CC:CC:CC:CC:CC:C2\r\n env=ASDF\r\n model=ASDF\r\n firmwareVersion=1\r\n ecmMac=<null>\r\n receiverId=<null>\r\n controllerId=<null>\r\n channelMapId=<null>\r\n vodId=<null>\r\n bypassFilters=[]\r\n forceFilters=[]\r\n capabilities=[]\r\n timeZone=UTC\r\n time=2016-10-18T12:51:00.000\r\n ipAddress=0:0:0:0:0:0:0:1\r\n]\n matched MAC_RULE f0362812-1777-4109-8a81-7f8907566d07: 11111111111111\n received config: FirmwareConfig[\r\n description=1\r\n supportedModelIds=[1, ASDF]\r\n firmwareDownloadProtocol=tftp\r\n firmwareFilename=1\r\n firmwareLocation=162.150.228.179\r\n firmwareVersion=1\r\n ipv6FirmwareLocation=2001:558:1020:1:250:56ff:fe94:646f\r\n upgradeDelay=<null>\r\n rebootImmediately=false\r\n id=5d9579b2-21f1-45a4-925f-88ed28e75892]\n was blocked/modified by filter SINGLETON_DOWNLOAD_LOCATION_ROUND_ROBIN_FILTER DOWNLOAD_LOCATION_ROUND_ROBIN_FILTER_VALUE",
"config": {
"firmwareDownloadProtocol": "tftp",
"firmwareFilename": "1",
"firmwareVersion": "1",
"rebootImmediately": false,
"firmwareLocation": "162.150.228.179",
"ipv6FirmwareLocation": "2001:558:1020:1:250:56ff:fe94:646f"
}
} |
Change logs - /estbfirmware/changelogs
Request to get all change logs.
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
[
{
"input": {
"estbMac": "CC:CC:CC:CC:CC:C2",
"firmwareVersion": "asdf",
"bypassFilters": [],
"forceFilters": [],
"capabilities": [],
"timeZone": "UTC",
"time": "12/16/2016 13:55:00",
"ipAddress": "0:0:0:0:0:0:0:1",
"rcdl": false,
"rebootDecoupled": false,
"supportsFullHttpUrl": false
},
"rule": {
"type": "MAC_RULE",
"name": "11111111111111",
"noop": false
},
"filters": [
{
"type": "DownloadLocationRoundRobinFilter",
"id": "SINGLETON_DOWNLOAD_LOCATION_ROUND_ROBIN_FILTER",
"name": "DOWNLOAD_LOCATION_ROUND_ROBIN_FILTER_VALUE",
"noop": true
}
],
"explanation": "Request: com.comcast.xconf.estbfirmware.EstbFirmwareContext$Converted@4f733919[\r\n estbMac=CC:CC:CC:CC:CC:C2\r\n env=<null>\r\n model=<null>\r\n firmwareVersion=asdf\r\n ecmMac=<null>\r\n receiverId=<null>\r\n controllerId=<null>\r\n channelMapId=<null>\r\n vodId=<null>\r\n bypassFilters=[]\r\n forceFilters=[]\r\n capabilities=[]\r\n timeZone=UTC\r\n time=2016-12-16T13:55:00.000\r\n ipAddress=0:0:0:0:0:0:0:1\r\n]\n matched MAC_RULE f0362812-1777-4109-8a81-7f8907566d07: 11111111111111\n received config: FirmwareConfig[\r\n description=1\r\n supportedModelIds=[1, ASDF]\r\n firmwareDownloadProtocol=tftp\r\n firmwareFilename=1.bin\r\n firmwareLocation=162.150.228.179\r\n firmwareVersion=1.bin\r\n ipv6FirmwareLocation=<null>\r\n upgradeDelay=<null>\r\n rebootImmediately=false\r\n id=5d9579b2-21f1-45a4-925f-88ed28e75892]\n was blocked/modified by filter SINGLETON_DOWNLOAD_LOCATION_ROUND_ROBIN_FILTER DOWNLOAD_LOCATION_ROUND_ROBIN_FILTER_VALUE",
"config": {
"firmwareDownloadProtocol": "tftp",
"firmwareFilename": "1.bin",
"firmwareLocation": "162.150.228.179",
"firmwareVersion": "1.bin",
"rebootImmediately": false
}
},
{
"input": {
"estbMac": "CC:CC:CC:CC:CC:C2",
"firmwareVersion": "1",
"bypassFilters": [],
"forceFilters": [],
"capabilities": [],
"timeZone": "UTC",
"time": "12/16/2016 13:55:00",
"ipAddress": "0:0:0:0:0:0:0:1",
"rcdl": false,
"rebootDecoupled": false,
"supportsFullHttpUrl": false
},
"rule": {
"type": "MAC_RULE",
"name": "11111111111111",
"noop": false
},
"filters": [
{
"type": "DownloadLocationRoundRobinFilter",
"id": "SINGLETON_DOWNLOAD_LOCATION_ROUND_ROBIN_FILTER",
"name": "DOWNLOAD_LOCATION_ROUND_ROBIN_FILTER_VALUE",
"noop": true
}
],
"explanation": "Request: com.comcast.xconf.estbfirmware.EstbFirmwareContext$Converted@c277e2a[\r\n estbMac=CC:CC:CC:CC:CC:C2\r\n env=<null>\r\n model=<null>\r\n firmwareVersion=1\r\n ecmMac=<null>\r\n receiverId=<null>\r\n controllerId=<null>\r\n channelMapId=<null>\r\n vodId=<null>\r\n bypassFilters=[]\r\n forceFilters=[]\r\n capabilities=[]\r\n timeZone=UTC\r\n time=2016-12-16T13:55:00.000\r\n ipAddress=0:0:0:0:0:0:0:1\r\n]\n matched MAC_RULE f0362812-1777-4109-8a81-7f8907566d07: 11111111111111\n received config: FirmwareConfig[\r\n description=1\r\n supportedModelIds=[1, ASDF]\r\n firmwareDownloadProtocol=tftp\r\n firmwareFilename=1.bin\r\n firmwareLocation=162.150.228.179\r\n firmwareVersion=1.bin\r\n ipv6FirmwareLocation=<null>\r\n upgradeDelay=<null>\r\n rebootImmediately=false\r\n id=5d9579b2-21f1-45a4-925f-88ed28e75892]\n was blocked/modified by filter SINGLETON_DOWNLOAD_LOCATION_ROUND_ROBIN_FILTER DOWNLOAD_LOCATION_ROUND_ROBIN_FILTER_VALUE",
"config": {
"firmwareDownloadProtocol": "tftp",
"firmwareFilename": "1.bin",
"firmwareLocation": "162.150.228.179",
"firmwareVersion": "1.bin",
"rebootImmediately": false
}
},
{
"input": {
"estbMac": "CC:CC:CC:CC:CC:C2",
"firmwareVersion": "2",
"bypassFilters": [],
"forceFilters": [],
"capabilities": [],
"timeZone": "UTC",
"time": "12/16/2016 13:53:00",
"ipAddress": "0:0:0:0:0:0:0:1",
"rcdl": false,
"rebootDecoupled": false,
"supportsFullHttpUrl": false
},
"rule": {
"type": "MAC_RULE",
"name": "11111111111111",
"noop": false
},
"filters": [
{
"type": "DownloadLocationRoundRobinFilter",
"id": "SINGLETON_DOWNLOAD_LOCATION_ROUND_ROBIN_FILTER",
"name": "DOWNLOAD_LOCATION_ROUND_ROBIN_FILTER_VALUE",
"noop": true
}
],
"explanation": "Request: com.comcast.xconf.estbfirmware.EstbFirmwareContext$Converted@32c0d2ed[\r\n estbMac=CC:CC:CC:CC:CC:C2\r\n env=<null>\r\n model=<null>\r\n firmwareVersion=2\r\n ecmMac=<null>\r\n receiverId=<null>\r\n controllerId=<null>\r\n channelMapId=<null>\r\n vodId=<null>\r\n bypassFilters=[]\r\n forceFilters=[]\r\n capabilities=[]\r\n timeZone=UTC\r\n time=2016-12-16T13:53:00.000\r\n ipAddress=0:0:0:0:0:0:0:1\r\n]\n matched MAC_RULE f0362812-1777-4109-8a81-7f8907566d07: 11111111111111\n received config: FirmwareConfig[\r\n description=1\r\n supportedModelIds=[1, ASDF]\r\n firmwareDownloadProtocol=tftp\r\n firmwareFilename=1.bin\r\n firmwareLocation=162.150.228.179\r\n firmwareVersion=1.bin\r\n ipv6FirmwareLocation=<null>\r\n upgradeDelay=<null>\r\n rebootImmediately=false\r\n id=5d9579b2-21f1-45a4-925f-88ed28e75892]\n was blocked/modified by filter SINGLETON_DOWNLOAD_LOCATION_ROUND_ROBIN_FILTER DOWNLOAD_LOCATION_ROUND_ROBIN_FILTER_VALUE",
"config": {
"firmwareDownloadProtocol": "tftp",
"firmwareFilename": "1.bin",
"firmwareLocation": "162.150.228.179",
"firmwareVersion": "1.bin",
"rebootImmediately": false
}
}
] |
Minimum firmware check - /estbfirmware/checkMinimumFirmware
Xconf API which will help determine if firmwareVersion meets minimum check
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"hasMinimumFirmware": true
} |
DCM API
Log upload settings - /loguploader
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"urn:settings:GroupName": null,
"urn:settings:CheckOnReboot": false,
"urn:settings:CheckSchedule:cron": null,
"urn:settings:CheckSchedule:DurationMinutes": null,
"urn:settings:CheckSchedule:StartDate": null,
"urn:settings:CheckSchedule:EndDate": null,
"urn:settings:LogUploadSettings:Message": null,
"urn:settings:LogUploadSettings:Name": null,
"urn:settings:LogUploadSettings:NumberOfDays": null,
"urn:settings:LogUploadSettings:UploadRepositoryName": null,
"urn:settings:LogUploadSettings:UploadOnReboot": null,
"urn:settings:LogUploadSettings:UploadImmediately": false,
"urn:settings:LogUploadSettings:upload": null,
"urn:settings:LogUploadSettings:LogFiles": null,
"urn:settings:LogUploadSettings:LogFiles:StartDate": null,
"urn:settings:LogUploadSettings:LogFiles:EndDate": null,
"urn:settings:LogUploadSettings:UploadSchedule:cron": null,
"urn:settings:LogUploadSettings:UploadSchedule:levelone:cron": null,
"urn:settings:LogUploadSettings:UploadSchedule:leveltwo:cron": null,
"urn:settings:LogUploadSettings:UploadSchedule:levelthree:cron": null,
"urn:settings:LogUploadSettings:UploadSchedule:DurationMinutes": null,
"urn:settings:LogUploadSettings:UploadSchedule:StartDate": null,
"urn:settings:LogUploadSettings:UploadSchedule:EndDate": null,
"urn:settings:VODSettings:Name": "fdas",
"urn:settings:VODSettings:LocationsURL": "http://vod7.location.com/",
"urn:settings:VODSettings:SRMIPList": {},
"urn:settings:TelemetryProfile": {
"id": "fcb969ec-851e-4d80-8452-91f835516e80",
"telemetryProfile": [
{
"header": "qwer",
"content": "yui",
"type": "op",
"pollingFrequency": "3000"
}
],
"schedule": "10 10 * * *",
"expires": 0,
"telemetryProfile:name": "Profile2",
"uploadRepository:URL": "amazon.com",
"uploadRepository:uploadProtocol": "S3"
}
} |
Check now request.
CheckNow request
| Code Block | ||||
|---|---|---|---|---|
| ||||
http://<host>:<port>/loguploader/getSettings?estbIP=60.70.80.90&env=DEV&firmwareVersion=10.12&checkNow=true |
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"input": {
"estbMac": "B4:F2:E8:79:B8:94",
"env": "QA",
"model": "GXG5",
"firmwareVersion": "test1",
"bypassFilters": [
"GLOBAL_PERCENT",
"TIME_FILTER",
"PercentFilter",
"ENV_MODEL_PERCENT"
],
"forceFilters": [],
"capabilities": [],
"timeZone": "UTC",
"time": "05/24/2016 18:57:00",
"ipAddress": "10.20.30.43",
"rcdl": false,
"rebootDecoupled": false,
"supportsFullHttpUrl": false
},
"rule": {
"type": "ENV_MODEL_HARDWARE",
"name": "RuleQA_X1_1.2.3",
"noop": false
},
"filters": [
{
"type": "DownloadLocationRoundRobinFilter",
"id": "SINGLETON_DOWNLOAD_LOCATION_ROUND_ROBIN_FILTER",
"name": "DOWNLOAD_LOCATION_ROUND_ROBIN_FILTER_VALUE",
"noop": true
}
],
"explanation": "Request: com.comcast.xconf.estbfirmware.EstbFirmwareContext$Converted@282a68ed[\r\n estbMac=B4:F2:E8:79:B8:94\r\n env=QA\r\n model=GXG5\r\n firmwareVersion=test1\r\n ecmMac=<null>\r\n receiverId=<null>\r\n controllerId=<null>\r\n channelMapId=<null>\r\n vodId=<null>\r\n bypassFilters=[GLOBAL_PERCENT, TIME_FILTER, PercentFilter, ENV_MODEL_PERCENT]\r\n forceFilters=[]\r\n capabilities=[]\r\n timeZone=UTC\r\n time=2016-05-24T18:57:00.000\r\n ipAddress=10.20.30.43\r\n]\n matched ENV_MODEL_HARDWARE 62af2be5-a660-4127-9127-2edd06b86858: RuleQA_X1_1.2.3\n received config: FirmwareConfig[\r\n description=PACXI3-desc1\r\n supportedModelIds=[PACXI3, GXG5]\r\n firmwareDownloadProtocol=tftp\r\n firmwareFilename=file-pac3\r\n firmwareLocation=192.168.201.2\r\n firmwareVersion=PACXI3_2.0._DEVse\r\n ipv6FirmwareLocation=1991:db8::ff00:42:2014\r\n upgradeDelay=<null>\r\n rebootImmediately=false\r\n id=9264d2b7-6c9c-477c-9f75-0da2ddaac34e]\n was blocked/modified by filter SINGLETON_DOWNLOAD_LOCATION_ROUND_ROBIN_FILTER DOWNLOAD_LOCATION_ROUND_ROBIN_FILTER_VALUE",
"config": {
"id": "9264d2b7-6c9c-477c-9f75-0da2ddaac34e",
"updated": 1444857563223,
"description": "PACXI3-desc1",
"supportedModelIds": [
"PACXI3",
"GXG5"
],
"firmwareDownloadProtocol": "tftp",
"firmwareFilename": "file-pac3",
"firmwareVersion": "PACXI3_2.0._DEVse",
"rebootImmediately": false,
"firmwareLocation": "192.168.201.2",
"ipv6FirmwareLocation": "1991:db8::ff00:42:2014"
}
} |
Change logs - /psg/changelogs
Request to get all change logs.
...
Overview
Community Forums
Content Tools
Tasks