Legrand / Raritan / Server Technology Xerus™ JSON-RPC API
Loading...
Searching...
No Matches
Classes | Enumerations
firmware Module Reference

Firmware Management More...

Classes

interface  Firmware
 Firmware management methods More...
 
struct  FirmwareUpdateCompletedEvent
 Event: Firmware updated successfully. More...
 
struct  FirmwareUpdateEvent
 Event: Firmware update base event. More...
 
struct  FirmwareUpdateFailedEvent
 Event: Firmware update failed. More...
 
struct  FirmwareUpdateStartedEvent
 Event: Firmware update started. More...
 
interface  FirmwareUpdateStatus
 Firmware update status interface. More...
 
struct  FirmwareValidationFailedEvent
 Event: Firmware validation failed. More...
 
struct  ImageInfo
 Firmware image information More...
 
struct  ImageStatus
 Image upload/download status. More...
 
struct  SystemShutdownEvent
 Event: System shutdown started. More...
 
struct  SystemStartupEvent
 Event: System startup finished. More...
 
struct  UpdateHistoryEntry
 Firmware update history entry TODO: implement CR# 45668 on next interface change add comment field based on firmware tag "char tag[64];" to improve firmware update history entries without rootfs images More...
 
struct  UpdateStatus
 Firmware update status More...
 

Enumerations

enum  UpdateHistoryStatus { SUCCESSFUL , FAILED , INCOMPLETE }
 Firmware update history status More...
 
enum  ImageState {
  NONE , UPLOADING , UPLOAD_FAILED , DOWNLOADING ,
  DOWNLOAD_FAILED , COMPLETE
}
 Image upload/download state. More...
 
enum  UpdateFlags { CROSS_OEM , CROSS_HW , ALLOW_UNTRUSTED }
 Flags for startUpdate() method. More...
 

Detailed Description

Firmware Management

Enumeration Type Documentation

◆ ImageState

Image upload/download state.

Enumerator
NONE 

No firmware image has been uploaded/downloaded.

UPLOADING 

A firmware image is currently being uploaded.

UPLOAD_FAILED 

There was a problem uploading an image to the device.

DOWNLOADING 

The device is downloading a firmware image from a URL.

DOWNLOAD_FAILED 

There was a problem downloading the image from a URL.

COMPLETE 

A complete image has been successfully uploaded/downloaded.

Definition at line 40 of file Firmware.idl.

◆ UpdateFlags

Flags for startUpdate() method.

Enumerator
CROSS_OEM 

Ignore version, product and OEM constraints.

CROSS_HW 

Ignore hardware constraints.

ALLOW_UNTRUSTED 

Allow untrusted firmwares (ignored when secure boot is active)

Definition at line 91 of file Firmware.idl.

◆ UpdateHistoryStatus

Firmware update history status

Enumerator
SUCCESSFUL 

The update was successfully completed.

FAILED 

The update failed.

INCOMPLETE 

The update was not completed.

Definition at line 17 of file Firmware.idl.