MaintenanceManager - API Documentation

This is triggered by the MaintenanceonBootup and startMaintenance to execute all maintenance tasks in a specific order with all preconditions asserted like Network Status, reboot flags, critical update, etc 

A Maintenance Manager method to trigger Critical tasks via 3 Scripts

• StartDCM_maintenance.sh
• RFCbase.sh
• xconfImageCheck.sh

These are triggered in case if the network is reconnected after there is no active network connection available during an Unsolicited Maintenance and network retry fails with Maintenance Status with MAINTENANCE_ERROR

This is an IARM based event handler for Maintenance Manager, triggered by _MaintenanceMgrEventHandler, this sets appropriate Task Completion or Error Status and 

completion/ incompletion of all tasks it sets the Maintenance Status and joins the thread accordingly

1. Maintenance start time from XConf comes as local time. This is because in the past the maintenance start time is used to configure Cron directly, which works based on local time. This has limitations at the begin and at the end of the daylight saving period as it can happen that maintenance doesn't run for that day, or run twice (e.g. if it's between 1am and 2am, it won't run the day daylight saving period starts – and clock moves forward - and it will run twice the day daylight saving period ends – and clock moves backward)
2. on the contrary, the start time provided to the upper layers by the maintenance Thunder service needs to make sure that maintenance never fails to run or run twice during the same day. For this reason, the time reported back is always epoch or Unix Time express in number of seconds since 1st Jan 1970 (UTC). Care needs to be put in converting local time to epoch time so that maintenance always run once every day. 

JsonRPC Method to gracefully end all the current running maintenance tasks, joins all threads and exists maintenance with MAINTENANCE_ERROR Status. This RPC Call gives successful response with true if the running maintenance is stopped successfully and it returns false response if there is a failure in the stopping process or if thee is no running Maintenance to stop. This is used by App (EPG/AS) to stop the current running maintenance. Stop Maintenance feature is controlled via an RFC Device.DeviceInfo.X_RDKCENTRAL-COM_RFC.Feature.StopMaintenance.Enable (this is defaulted to true i.e. Enabled by default)

curl -H "Authorization: Bearer `WPEFrameworkSecurityUtility | cut -d '"' -f 4`" --header "Content-Type: application/json" --request POST --silent -d '{"jsonrpc":"2.0","id":"3","method":"org.rdk.MaintenanceManager.1.stopMaintenance","params":{}}' http://127.0.0.1:9998/jsonrpc 

Positive 

{"jsonrpc":"2.0","id":3,"result":{"success":true}}

Negative

{"jsonrpc":"2.0","id":3,"result":{"success":false}}

JsonRPC Method to set the Maintenance Mode.

• FOREGROUND
  • This mode is a vanilla mode that lets Maintenance to run all the Maintenance Tasks
• BACKGROUND

1. Abort activities currently running and if the task can't run in background (if maintenance was already started with FOREGROUND mode). The only exception is a critical software download.
2. Execute tasks not impacting user experience if the maintenance mode is set to BACKGROUND before calling startMaintenance

curl -H "Authorization: Bearer `WPEFrameworkSecurityUtility | cut -d '"' -f 4`" --header "Content-Type: application/json" --request POST --silent -d '{"jsonrpc":"2.0","id":"3","method":"org.rdk.MaintenanceManager.1.setMaintenanceMode","params":{"maintenanceMode":"FOREGROUND"}}' http://127.0.0.1:9998/jsonrpc

curl -H "Authorization: Bearer `WPEFrameworkSecurityUtility | cut -d '"' -f 4`" --header "Content-Type: application/json" --request POST --silent -d '{"jsonrpc":"2.0","id":"3","method":"org.rdk.MaintenanceManager.1.setMaintenanceMode","params":{"maintenanceMode":"BACKGROUND"}}' http://127.0.0.1:9998/jsonrpc

{"jsonrpc":"2.0","id":3,"result":{"success":true}}

{"jsonrpc":"2.0","id":3,"result":{"success":false}}

curl -H "Authorization: Bearer `WPEFrameworkSecurityUtility | cut -d '"' -f 4`" --header "Content-Type: application/json" --request POST --silent -d '{"jsonrpc":"2.0","id":"3","method":"org.rdk.MaintenanceManager.1.getMaintenanceMode","params":{"maintenanceMode":"BACKGROUND"}}' http://127.0.0.1:9998/jsonrpc

Foreground

{"jsonrpc":"2.0","id":3,"result":{"maintenanceMode":"FOREGROUND","optOut":"NONE","success":true}}

Background

{"jsonrpc":"2.0","id":3,"result":{"maintenanceMode":"BACKGROUND","optOut":"NONE","success":true}}

Returns the corresponding Maintenance Status String for the respective Maintenance Status. Below are the possible Maintenance statuses that will be returned

• MAINTENANCE_IDLE
• MAINTENANCE_STARTED
• MAINTENANCE_ERROR
• MAINTENANCE_COMPLETE
• MAINTENANCE_INCOMPLETE

Returns when the passed OptOutMode is in either of the one below;

• ENFORCE_OPTOUT
• BYPASS_OPTOUT
• IGNORE_UPDATE
• NONE

Returns the corresponding Maintenance Status String for the respective Maintenance IARM Status. Below are the possible IARM statuses that will be returned

• MAINTENANCE_DCM_COMPLETE
• MAINTENANCE_DCM_ERROR
• MAINTENANCE_RFC_COMPLETE
• MAINTENANCE_RFC_ERROR
• MAINTENANCE_LOGUPLOAD_COMPLETE
• MAINTENANCE_LOGUPLOAD_ERROR
• MAINTENANCE_PINGTELEMETRY_COMPLETE
• MAINTENANCE_PINGTELEMETRY_ERROR
• MAINTENANCE_FWDOWNLOAD_COMPLETE
• MAINTENANCE_FWDOWNLOAD_ERROR
• MAINTENANCE_REBOOT_REQUIRED
• MAINTENANCE_FWDOWNLOAD_ABORTED
• MAINTENANCE_CRITICAL_UPDATE
• MAINTENANCE_EMPTY