:orphan:


.. _everest_interfaces_system:


######
system
######

| Interface for system wide operations of EVerest


*********
Variables
*********
| **firmware_update_status**: *object*  (:ref:`system-FirmwareUpdateStatus <system-FirmwareUpdateStatus>`)
|  Describes the current status of a firmware update of the system
| **log_status**: *object*  (:ref:`system-LogStatus <system-LogStatus>`)
|  Describes the current status of log upload of the system

********
Commands
********
| **update_firmware**:*string*
|  Call to start a firmware update
|  **firmware_update_request**: *object* <required> (:ref:`system-FirmwareUpdateRequest <system-FirmwareUpdateRequest>`)
|   Meta data containing information about the firmware request
|  **Result**: *string*  (:ref:`system-UpdateFirmwareResponse <system-UpdateFirmwareResponse>`)
|   Returns the result of the attempt to update the firmware
| **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> (:ref:`system-UploadLogsRequest <system-UploadLogsRequest>`)
|   Meta data containing information about the log request request
|  **Result**: *object*  (:ref:`system-UploadLogsResponse <system-UploadLogsResponse>`)
|   Returns the result of the attempt to upload the logs
| **is_reset_allowed**:*boolean*
|  Call to determine if a reset of the system is allowed
|  **type**: *string* <required> (:ref:`system-ResetType <system-ResetType>`)
|   Type of the reset (Soft or Hard)
|  **Result**: *boolean* 
|   Indicates if the system can be reset
| **reset**:*void*
|  Call to reset the system immediately
|  **type**: *string* <required> (:ref:`system-ResetType <system-ResetType>`)
|   Type of the reset (Soft or Hard)
|  **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*  (:ref:`system-BootReason <system-BootReason>`)
|   Returns the boot reason of the system

******
Errors
******
| **/errors/system** :
|  **CommunicationFault** : The communication to the hardware or underlying driver is lost or has errors.