Raritan PX2/PX3 JSON-RPC API
Firmware.idl
1 
4 module firmware {
5 
9  enumeration UpdateHistoryStatus {
13  };
14 
21  structure UpdateHistoryEntry {
22  time timestamp;
23  string oldVersion;
24  string imageVersion;
25  string imageMD5;
27  };
28 
32  enumeration ImageState {
33  NONE,
39  };
40 
44  structure ImageStatus {
46  string error_message;
47  time time_started;
48  int size_total;
49  int size_done;
50  };
51 
55  structure ImageInfo_1_0_1 {
56  boolean valid;
57 
58  string version;
61 
62  string product;
63  string platform;
64  string oem;
65  string hwid_whitelist;
66  string hwid_blacklist;
67 
68  boolean compatible;
69 
71  string signed_by;
72  boolean signature_good;
73  string certified_by;
74  boolean certificate_good;
75 
77  boolean model_supported;
78  };
79 
83  enumeration UpdateFlags {
87  };
88 
92  interface Firmware_2_0_0 {
93 
99  void reboot();
100 
104  void factoryReset();
105 
111  string getVersion();
112 
118  vector<UpdateHistoryEntry> getUpdateHistory();
119 
125  ImageStatus getImageStatus();
126 
130  void discardImage();
131 
139  boolean getImageInfo(out ImageInfo_1_0_1 info);
140 
149  void startUpdate(in vector<UpdateFlags> flags);
150 
151  };
152 
153 }
Allow untrusted firmwares.
Definition: Firmware.idl:86
string platform
Platform name.
Definition: Firmware.idl:63
string version
Firmware image version
Definition: Firmware.idl:58
string imageMD5
MD5 hash of update image.
Definition: Firmware.idl:25
string error_message
Error message; empty if there was no error.
Definition: Firmware.idl:46
Firmware update history entry TODO: implement CR# 45668 on next interface change add comment field ba...
Definition: Firmware.idl:21
string signed_by
Signature issuer.
Definition: Firmware.idl:71
int size_total
Total size of the image (if available)
Definition: Firmware.idl:48
ImageState state
Image upload/download state.
Definition: Firmware.idl:45
UpdateFlags
Flags for startUpdate() method.
Definition: Firmware.idl:83
string oem
OEM name.
Definition: Firmware.idl:64
string imageVersion
Firmware version of update image.
Definition: Firmware.idl:24
Image upload/download status.
Definition: Firmware.idl:44
boolean model_list_present
true if the image includes a supported models list
Definition: Firmware.idl:76
int size_done
Progress of the running upload or download (if available)
Definition: Firmware.idl:49
The update was not completed.
Definition: Firmware.idl:12
The device is downloading a firmware image from a URL.
Definition: Firmware.idl:36
UpdateHistoryStatus status
Update status.
Definition: Firmware.idl:26
boolean signature_present
true if the image is signed
Definition: Firmware.idl:70
Firmware Management
Definition: Firmware.idl:4
There was a problem downloading the image from a URL.
Definition: Firmware.idl:37
Ignore version, product and OEM constraints.
Definition: Firmware.idl:84
boolean signature_good
true if the signature is valid
Definition: Firmware.idl:72
string certified_by
Key certificate issuer.
Definition: Firmware.idl:73
string product
Product name.
Definition: Firmware.idl:62
string min_downgrade_version
Minimum image version for running firmware.
Definition: Firmware.idl:60
UpdateHistoryStatus
Firmware update history status
Definition: Firmware.idl:9
The update was successfully completed.
Definition: Firmware.idl:10
string min_required_version
Minimum running firmware version for image.
Definition: Firmware.idl:59
Ignore hardware constraints.
Definition: Firmware.idl:85
boolean compatible
true if the image is compatible with this device
Definition: Firmware.idl:68
boolean certificate_good
true if the key certificate is valid
Definition: Firmware.idl:74
No firmware image has been uploaded/downloaded.
Definition: Firmware.idl:33
boolean valid
The file is a valid firmware image.
Definition: Firmware.idl:56
string hwid_whitelist
Hardware ID whitelist.
Definition: Firmware.idl:65
time time_started
Timestamp of the last state change (if available)
Definition: Firmware.idl:47
boolean model_supported
true if the model is found on the support list
Definition: Firmware.idl:77
string hwid_blacklist
Hardware ID blacklist.
Definition: Firmware.idl:66
string oldVersion
Previous firmware version.
Definition: Firmware.idl:23
ImageState
Image upload/download state.
Definition: Firmware.idl:32
There was a problem uploading an image to the device.
Definition: Firmware.idl:35
The update failed.
Definition: Firmware.idl:11
A firmware image is currently being uploaded.
Definition: Firmware.idl:34
Firmware management methods
Definition: Firmware.idl:92
A complete image has been successfully uploaded/downloaded.
Definition: Firmware.idl:38
time timestamp
Timestamp when the update was started.
Definition: Firmware.idl:22
Firmware image information
Definition: Firmware.idl:55