| Legrand / Raritan / Server Technology Xerus™ JSON-RPC API
    | 
Server Monitor Interface. More...
import <ServerMonitor.idl;
| Classes | |
| struct | Server | 
| Server Entry.  More... | |
| struct | ServerAddedEvent | 
| A new server entry was added.  More... | |
| struct | ServerDeletedEvent | 
| A server entry was deleted.  More... | |
| struct | ServerPowerControlCompletedEvent | 
| Event: A power control operation was completed.  More... | |
| struct | ServerPowerControlInitiatedEvent | 
| Event: A power control operation was initiated.  More... | |
| struct | ServerPowerSettings | 
| Settings for controlling and checking power state of the server.  More... | |
| struct | ServerPowerStateEvent | 
| Event: ServerPowerState has changed.  More... | |
| struct | ServerReachabilityEvent | 
| Event: Reachability status for a monitored server has changed or server continues to be unreachable.  More... | |
| struct | ServerSettings | 
| Server Reachability Settings.  More... | |
| struct | ServerSettingsChangedEvent | 
| A server entry was changed.  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. | |
| int | modifyServer (in int id, in ServerSettings settings) | 
| Modify an existing server entry. | |
| int | deleteServer (in int id) | 
| Delete a server entry. | |
| int | getServer (out Server server, in int id) | 
| Retrieve a server entry (settings and status). | |
| map< int, Server > | listServers () | 
| Retrieve a list of server entries (settings and status). | |
| int | powerControl (in int id, in boolean on) | 
| Control the power state of the outlets the server uses. | |
| Public Attributes | |
| 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.
Definition at line 13 of file ServerMonitor.idl.
Methods of checking power state.
| Enumerator | |
|---|---|
| TIMER | Server is assumed to be off after a time interval. | 
| POWER_DROP | Server is off if power consumption dropped. | 
Definition at line 49 of file ServerMonitor.idl.
Server Power Control Result.
Definition at line 38 of file ServerMonitor.idl.
Server Reachability State.
| Enumerator | |
|---|---|
| WAITING | Waiting for reliable connection. | 
| REACHABLE | Server is up and running. | 
| UNREACHABLE | No response from server. | 
| ERROR | Error pinging server (e.g. DNS lookup failure) | 
Definition at line 18 of file ServerMonitor.idl.
| int servermon::ServerMonitor::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::deleteServer | ( | in int | id | ) | 
Delete a server entry.
| id | Entry id | 
| int servermon::ServerMonitor::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::listServers | ( | ) | 
Retrieve a list of server entries (settings and status).
| int servermon::ServerMonitor::modifyServer | ( | in int | id, | 
| in ServerSettings | settings ) | 
Modify an existing server entry.
| id | Entry id | 
| settings | New settings | 
| int servermon::ServerMonitor::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 | 
| constant int servermon::ServerMonitor::ERR_DUPLICATE_HOSTNAME = 3 | 
Duplicate hostname.
Definition at line 172 of file ServerMonitor.idl.
| constant int servermon::ServerMonitor::ERR_INVALID_SETTINGS = 2 | 
Invalid settings.
Definition at line 171 of file ServerMonitor.idl.
| constant int servermon::ServerMonitor::ERR_MAX_SERVERS_REACHED = 4 | 
Maximum number of server entries.
Definition at line 173 of file ServerMonitor.idl.
| constant int servermon::ServerMonitor::ERR_NO_SUCH_ID = 1 | 
No such ID.
Definition at line 170 of file ServerMonitor.idl.