Raritan PX2/PX3 JSON-RPC API
|
6 #include <UserEvent.idl>
@ DOWNLOADING
The device is downloading a firmware image from a URL.
Definition: Firmware.idl:44
@ INCOMPLETE
The update was not completed.
Definition: Firmware.idl:20
string certified_by
Key certificate issuer.
Definition: Firmware.idl:81
@ SUCCESSFUL
The update was successfully completed.
Definition: Firmware.idl:18
string version
Firmware image version
Definition: Firmware.idl:66
string signed_by
Signature issuer.
Definition: Firmware.idl:79
time timestamp
UNIX timestamp (UTC) when the update was started.
Definition: Firmware.idl:30
boolean model_supported
true if the model is found on the support list
Definition: Firmware.idl:85
string product
Product name.
Definition: Firmware.idl:70
void startUpdate(in vector< UpdateFlags > flags)
Launch the firmware update process.
int hardFactoryReset()
Reset all device data to factory defaults.
boolean certificate_good
true if the key certificate is valid
Definition: Firmware.idl:82
string getVersion()
Returns the currently installed firmware version.
vector< UpdateHistoryEntry > getUpdateHistory()
Fetch the firmware update history.
@ NONE
No firmware image has been uploaded/downloaded.
Definition: Firmware.idl:41
boolean getImageInfo(out ImageInfo_1_0_1 info)
Return information about a currently uploaded firmware image.
@ CROSS_HW
Ignore hardware constraints.
Definition: Firmware.idl:93
ImageState
Image upload/download state.
Definition: Firmware.idl:40
string oldVersion
Previous firmware version.
Definition: Firmware.idl:31
string min_downgrade_version
Minimum image version for running firmware.
Definition: Firmware.idl:68
void reboot()
Reboot the device.
@ DOWNLOAD_FAILED
There was a problem downloading the image from a URL.
Definition: Firmware.idl:45
Image upload/download status.
Definition: Firmware.idl:52
string imageVersion
Firmware version of update image.
Definition: Firmware.idl:32
int size_done
Progress of the running upload or download (if available)
Definition: Firmware.idl:57
int size_total
Total size of the image (if available)
Definition: Firmware.idl:56
string oem
OEM name.
Definition: Firmware.idl:72
string imageMD5
MD5 hash of update image.
Definition: Firmware.idl:33
boolean signature_present
true if the image is signed
Definition: Firmware.idl:78
valueobject FirmwareUpdateFailedEvent
Event: Firmware update failed.
Definition: Firmware.idl:116
valueobject FirmwareUpdateStartedEvent
Event: Firmware update started.
Definition: Firmware.idl:109
boolean valid
The file is a valid firmware image.
Definition: Firmware.idl:64
Basic IDL definitions.
Definition: Event.idl:10
UpdateFlags
Flags for startUpdate() method.
Definition: Firmware.idl:91
string newVersion
Firmware version the device is being upgraded to.
Definition: Firmware.idl:108
string error_message
Error message; empty if there was no error.
Definition: Firmware.idl:54
valueobject FirmwareValidationFailedEvent
Event: Firmware validation failed.
Definition: Firmware.idl:103
Firmware image information
Definition: Firmware.idl:63
boolean compatible
true if the image is compatible with this device
Definition: Firmware.idl:76
boolean signature_good
true if the signature is valid
Definition: Firmware.idl:80
string hwid_blacklist
Hardware ID blacklist.
Definition: Firmware.idl:74
void factoryReset()
Reset the device configuration to factory defaults.
time time_started
UNIX timestamp (UTC) of the last state change (if available)
Definition: Firmware.idl:55
valueobject SystemStartupEvent
Event: System startup finished.
Definition: Firmware.idl:98
valueobject SystemShutdownEvent
Event: System shutdown started.
Definition: Firmware.idl:100
Firmware management methods
Definition: Firmware.idl:121
valueobject FirmwareUpdateEvent
Event: Firmware update base event.
Definition: Firmware.idl:107
string hwid_whitelist
Hardware ID whitelist.
Definition: Firmware.idl:73
Firmware update history entry TODO: implement CR# 45668 on next interface change add comment field ba...
Definition: Firmware.idl:29
ImageState state
Image upload/download state.
Definition: Firmware.idl:53
@ UPLOAD_FAILED
There was a problem uploading an image to the device.
Definition: Firmware.idl:43
@ FAILED
The update failed.
Definition: Firmware.idl:19
@ ALLOW_UNTRUSTED
Allow untrusted firmwares.
Definition: Firmware.idl:94
boolean model_list_present
true if the image includes a supported models list
Definition: Firmware.idl:84
string min_required_version
Minimum running firmware version for image.
Definition: Firmware.idl:67
UpdateHistoryStatus
Firmware update history status
Definition: Firmware.idl:17
@ COMPLETE
A complete image has been successfully uploaded/downloaded.
Definition: Firmware.idl:46
UpdateHistoryStatus status
Update status.
Definition: Firmware.idl:34
string platform
Platform name.
Definition: Firmware.idl:71
@ UPLOADING
A firmware image is currently being uploaded.
Definition: Firmware.idl:42
ImageStatus getImageStatus()
Get the current firmware image upload/download status.
valueobject FirmwareUpdateCompletedEvent
Event: Firmware updated successfully.
Definition: Firmware.idl:114
@ CROSS_OEM
Ignore version, product and OEM constraints.
Definition: Firmware.idl:92
Firmware Management
Definition: Firmware.idl:12
void discardImage()
Discard the currently uploaded firmware image, cancel the update.