Raritan / Server Technology Xerus™ PDU JSON-RPC API: FirmwareUpdateStatus.idl Source File

Raritan / Server Technology Xerus™ PDU JSON-RPC API

FirmwareUpdateStatus.idl
1 /* SPDX-License-Identifier: BSD-3-Clause */
2 /*
3 * Copyright 2010 Raritan Inc. All rights reserved.
4 */
5
6 /**
7 * %Firmware Management
8 */
9 module firmware {
10
11 /**
12 * %Firmware update status
13 */
14 structure UpdateStatus {
15 string state; ///< Current state of firmware update: NONE, INIT, PREP, SIMULATE, UPDATE, SUCCESS or FAIL
16 int elapsed; ///< Seconds since start of update, 0 if not available
17 int estimated; ///< Estimated total time for update, 0 if not available
18 string error_message; ///< Error message; empty if there was no error
19 };
20
21 /**
22 * %Firmware update status interface.
23 *
24 * Unlike all other sysrpc methods this function is implemented by a
25 * CGI script which is available even during a firmware update. The
26 * URL for this interface is /cgi-bin/fwupdate_progress.cgi.
27 */
28 interface FirmwareUpdateStatus {
29
30 /**
31 * Returns the device's firmware update status.
32 *
33 * @return Update status structure
34 */
35 UpdateStatus getStatus();
36
37 };
38
39 }
firmware::FirmwareUpdateStatus
Firmware update status interface.
Definition: FirmwareUpdateStatus.idl:28
firmware::FirmwareUpdateStatus::getStatus
UpdateStatus getStatus()
Returns the device's firmware update status.
firmware
Firmware Management
Definition: Firmware.idl:12
firmware::UpdateStatus
Firmware update status
Definition: FirmwareUpdateStatus.idl:14
firmware::UpdateStatus::elapsed
int elapsed
Seconds since start of update, 0 if not available.
Definition: FirmwareUpdateStatus.idl:16
firmware::UpdateStatus::error_message
string error_message
Error message; empty if there was no error.
Definition: FirmwareUpdateStatus.idl:18
firmware::UpdateStatus::state
string state
Current state of firmware update: NONE, INIT, PREP, SIMULATE, UPDATE, SUCCESS or FAIL.
Definition: FirmwareUpdateStatus.idl:15
firmware::UpdateStatus::estimated
int estimated
Estimated total time for update, 0 if not available.
Definition: FirmwareUpdateStatus.idl:17