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.

Detailed Description

Server Monitor Interface.

Member Enumeration Documentation

◆ ServerPowerCheckMethod

enum servermon::ServerMonitor::ServerPowerCheckMethod

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.

◆ ServerPowerControlResult

enum servermon::ServerMonitor::ServerPowerControlResult

Server Power Control Result.

Enumerator
NO_ERROR	No error, operation may still be in progress.
SHUTDOWN_CMD_FAILED	Error issuing the shutdown command to the server.
SWITCHING_OFF_FAILED	Switching the outlet or outlet group off failed.
SWITCHING_ON_FAILED	Switching the outlet or outlet group on failed.
POWER_CHECK_TIMEOUT	Checking if power is off timed out.

◆ ServerPowerState

enum servermon::ServerMonitor::ServerPowerState

Server Power Control State.

Enumerator
UNKNOWN	Power state currently not known.
ON	Server power target is on.
OFF	Server power target is off.
SHUTTING_DOWN	Server is being manually shut down.

◆ ServerReachability

enum servermon::ServerMonitor::ServerReachability

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)

Member Function Documentation

◆ addServer()

int servermon::ServerMonitor::addServer	(	out int	id,
		in ServerSettings	settings
	)

Add a new server entry.

Parameters

id	New entry id, automatically assigned
settings	New server settings

Returns: 0 if OK; 2 if the settings are invalid; 3 if an entry for the given hostname exists; 4 if the maximum number of servers is reached

Note: The ServerSettings structure can be "sparse"; fields missing in the JSON representation will be set to default values.

◆ deleteServer()

int servermon::ServerMonitor::deleteServer ( in int id )

Delete a server entry.

Parameters

id Entry id

Returns: 0 if OK; 1 if the entry does not exist

◆ getServer()

int servermon::ServerMonitor::getServer	(	out Server	server,
		in int	id
	)

Retrieve a server entry (settings and status).

Parameters

server	Server settings and status
id	Entry id

Returns: 0 if OK; 1 if the entry does not exist

◆ listServers()

map<int, Server> servermon::ServerMonitor::listServers ( )

Retrieve a list of server entries (settings and status).

Returns: Server list

◆ modifyServer()

int servermon::ServerMonitor::modifyServer	(	in int	id,
		in ServerSettings	settings
	)

Modify an existing server entry.

Parameters

id	Entry id
settings	New settings

Returns: 0 if OK; 1 if the entry does not exist; 2 if the settings are invalid; 3 if an entry for the given hostname exists

Note: The ServerSettings structure can be "sparse"; fields missing in the JSON representation will remain unchanged.

◆ powerControl()

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.

Parameters

id	Entry id
on	Switch power on if true, off if false

Returns: 0 if OK; 1 if the entry does not exist; 2 if the settings are invalid

Member Data Documentation

◆ ServerAddedEvent

valueobject servermon::ServerMonitor::ServerAddedEvent

A new server entry was added.

id of the added server entry

◆ ServerDeletedEvent

valueobject servermon::ServerMonitor::ServerDeletedEvent

A server entry was deleted.

id of the deleted server entry

◆ ServerPowerControlCompletedEvent

valueobject servermon::ServerMonitor::ServerPowerControlCompletedEvent

Event: A power control operation was completed.

id of the server

◆ ServerPowerControlInitiatedEvent

valueobject servermon::ServerMonitor::ServerPowerControlInitiatedEvent

Event: A power control operation was initiated.

id of the server

◆ ServerPowerStateEvent

valueobject servermon::ServerMonitor::ServerPowerStateEvent

Event: ServerPowerState has changed.

id of the server entry

◆ ServerReachabilityEvent

valueobject servermon::ServerMonitor::ServerReachabilityEvent

Event: Reachability status for a monitored server has changed or server continues to be unreachable.

id of the server entry

◆ ServerSettingsChangedEvent

valueobject servermon::ServerMonitor::ServerSettingsChangedEvent

A server entry was changed.

id of the server entry

The documentation for this interface was generated from the following file:

ServerMonitor.idl

Classes

Public Types

Public Member Functions

Public Attributes

Detailed Description

Member Enumeration Documentation

◆ ServerPowerCheckMethod

◆ ServerPowerControlResult

◆ ServerPowerState

◆ ServerReachability

Member Function Documentation

◆ addServer()

◆ deleteServer()

◆ getServer()

◆ listServers()

◆ modifyServer()

◆ powerControl()

Member Data Documentation

◆ ServerAddedEvent

◆ ServerDeletedEvent

◆ ServerPowerControlCompletedEvent

◆ ServerPowerControlInitiatedEvent

◆ ServerPowerStateEvent

◆ ServerReachabilityEvent

◆ ServerSettingsChangedEvent