| Raritan PX2/PX3 JSON-RPC API
    | 
Server Monitor Interface. More...
import"ServerMonitor.idl";
| Classes | |
| struct | Server | 
| Server Entry.  More... | |
| struct | ServerPowerSettings | 
| Settings for controlling and checking power state of the server.  More... | |
| struct | ServerSettings | 
| Server Reachability Settings.  More... | |
| struct | ServerStatus | 
| Server Reachability Status.  More... | |
| Public Types | |
| enum | ServerReachability { WAITING, REACHABLE, UNREACHABLE, ERROR } | 
| Server Reachability State.  More... | |
| enum | ServerPowerState { UNKNOWN, ON, OFF, SHUTTING_DOWN } | 
| Server Power Control State.  More... | |
| enum | ServerPowerControlResult { NO_ERROR, SHUTDOWN_CMD_FAILED, SWITCHING_OFF_FAILED, SWITCHING_ON_FAILED, POWER_CHECK_TIMEOUT } | 
| Server Power Control Result.  More... | |
| enum | ServerPowerCheckMethod { TIMER, POWER_DROP } | 
| Methods of checking power state.  More... | |
| Public Member Functions | |
| int | addServer (out int id, in ServerSettings settings) | 
| Add a new server entry.  More... | |
| int | modifyServer (in int id, in ServerSettings settings) | 
| Modify an existing server entry.  More... | |
| int | deleteServer (in int id) | 
| Delete a server entry.  More... | |
| int | getServer (out Server server, in int id) | 
| Retrieve a server entry (settings and status).  More... | |
| map< int, Server > | listServers () | 
| Retrieve a list of server entries (settings and status).  More... | |
| int | powerControl (in int id, in boolean on) | 
| Control the power state of the outlets the server uses.  More... | |
| Public Attributes | |
| valueobject | ServerPowerStateEvent: idl::Event { int id | 
| Event: ServerPowerState has changed.  More... | |
| string | host | 
| Server hostname/IP address. | |
| ServerPowerState | oldPowerState | 
| Old power state. | |
| ServerPowerState | newPowerState | 
| New power state. | |
| valueobject | ServerPowerControlInitiatedEvent: event::UserEvent { int id | 
| Event: A power control operation was initiated.  More... | |
| boolean | on | 
| True if server shall be switched on, false otherwise. | |
| valueobject | ServerPowerControlCompletedEvent: idl::Event { int id | 
| Event: A power control operation was completed.  More... | |
| ServerPowerControlResult | result | 
| Result of the power control operation. | |
| valueobject | ServerReachabilityEvent: idl::Event { int id | 
| Event: Reachability status for a monitored server has changed or server continues to be unreachable.  More... | |
| ServerReachability | reachable | 
| Current Reachability state. | |
| valueobject | ServerAddedEvent: event::UserEvent { int id | 
| A new server entry was added.  More... | |
| ServerSettings | settings | 
| Settings of the added server. | |
| valueobject | ServerSettingsChangedEvent: event::UserEvent { int id | 
| A server entry was changed.  More... | |
| ServerSettings | oldSettings | 
| Settings before change. | |
| ServerSettings | newSettings | 
| Settings after change. | |
| valueobject | ServerDeletedEvent: event::UserEvent { int id | 
| A server entry was deleted.  More... | |
| constant int | ERR_NO_SUCH_ID = 1 | 
| No such ID. | |
| constant int | ERR_INVALID_SETTINGS = 2 | 
| Invalid settings. | |
| constant int | ERR_DUPLICATE_HOSTNAME = 3 | 
| Duplicate hostname. | |
| constant int | ERR_MAX_SERVERS_REACHED = 4 | 
| Maximum number of server entries. | |
Server Monitor Interface.
Server Power Control Result.
| int servermon::ServerMonitor_2_0_1::addServer | ( | out int | id, | 
| in ServerSettings | settings | ||
| ) | 
Add a new server entry.
| id | New entry id, automatically assigned | 
| settings | New server settings | 
| int servermon::ServerMonitor_2_0_1::deleteServer | ( | in int | id | ) | 
Delete a server entry.
| id | Entry id | 
| int servermon::ServerMonitor_2_0_1::getServer | ( | out Server | server, | 
| in int | id | ||
| ) | 
Retrieve a server entry (settings and status).
| server | Server settings and status | 
| id | Entry id | 
| map<int, Server> servermon::ServerMonitor_2_0_1::listServers | ( | ) | 
Retrieve a list of server entries (settings and status).
| int servermon::ServerMonitor_2_0_1::modifyServer | ( | in int | id, | 
| in ServerSettings | settings | ||
| ) | 
Modify an existing server entry.
| id | Entry id | 
| settings | New settings | 
| int servermon::ServerMonitor_2_0_1::powerControl | ( | in int | id, | 
| in boolean | on | ||
| ) | 
Control the power state of the outlets the server uses.
Attempting to switch the power off will issue a graceful shutdown of the server beforehand.
| id | Entry id | 
| on | Switch power on if true, off if false | 
| valueobject servermon::ServerMonitor_2_0_1::ServerAddedEvent | 
A new server entry was added.
id of the added server entry
| valueobject servermon::ServerMonitor_2_0_1::ServerDeletedEvent | 
A server entry was deleted.
id of the deleted server entry
| valueobject servermon::ServerMonitor_2_0_1::ServerPowerControlCompletedEvent | 
Event: A power control operation was completed.
id of the server
| valueobject servermon::ServerMonitor_2_0_1::ServerPowerControlInitiatedEvent | 
Event: A power control operation was initiated.
id of the server
| valueobject servermon::ServerMonitor_2_0_1::ServerPowerStateEvent | 
Event: ServerPowerState has changed.
id of the server entry
| valueobject servermon::ServerMonitor_2_0_1::ServerReachabilityEvent | 
Event: Reachability status for a monitored server has changed or server continues to be unreachable.
id of the server entry
| valueobject servermon::ServerMonitor_2_0_1::ServerSettingsChangedEvent | 
A server entry was changed.
id of the server entry
 1.8.14
 1.8.14