13.2.46. system

Interface for system wide operations of EVerest

13.2.46.1. Variables

firmware_update_status:object (system-FirmwareUpdateStatus)
Describes the current status of a firmware update of the system
There is an extended definition for this object here.
log_status:object (system-LogStatus)
Describes the current status of log upload of the system
There is an extended definition for this object here.

13.2.46.2. Commands

update_firmware:string
Call to start a firmware update
firmware_update_request:object <required> (system-FirmwareUpdateRequest)
Meta data containing information about the firmware request
There is an extended definition for this object here.
Returns the result of the attempt to update the firmware
There is an extended definition for this object here.
allow_firmware_installation:void
Call to allow a firmware installation to proceed
upload_logs:object
Call to start a log upload
upload_logs_request:object <required> (system-UploadLogsRequest)
Meta data containing information about the log request request
There is an extended definition for this object here.
Returns the result of the attempt to upload the logs
There is an extended definition for this object here.
is_reset_allowed:boolean
Call to determine if a reset of the system is allowed
type:string <required> (system-ResetType)
Type of the reset (Soft or Hard)
There is an extended definition for this object here.
Result:boolean
Indicates if the system can be reset
reset:void
Call to reset the system immediately
type:string <required> (system-ResetType)
Type of the reset (Soft or Hard)
There is an extended definition for this object here.
scheduled:boolean <required>
Indicates if this reset command was scheduled or immediately executed. A scheduled reset means that the system was waiting for all transactions to finish before this command was executed. This value is only informational.
set_system_time:boolean
Call to set the system time of EVerest
timestamp:string <required>
The new system time in RFC3339 format
format:date-time
Result:boolean
Returns true if the system time could be set successfully, else false
get_boot_reason:string
Call to get the boot reason of the system
Result:string (system-BootReason)
Returns the boot reason of the system
There is an extended definition for this object here.