Raritan Computer CC-WSAPI-0B-v5.1.0-E Marine Radio User Manual


 
Chapter 2: API Definitions
11
String deviceName i.e the name of the Raritan device. This field
is filled in only for out-of-band interfaces; otherwise, it the empty
string.
String name -
String id - Unique identifier referenced by AccessMethod
String description - User description of the interface
String type - Function of the interface
NodeData
Description of a node's configuration.
Elements
String name
InterfaceData[] interfacesData The interfaces attached to this
node
AssociationData[] associations - Category values with which the
node is associated
NodePowerStatus
Describes the power status of a node through its interfaces.
Elements
PowerInterfaceStatus [] powerInterfaceStatus Contains an
entry for each of the node's power interfaces.
PowerInterfaceStatus
Describes the interface and power operation statuses of a power
interface.
Elements
InterfaceAvailabilityAndStatus availabilityAndStatus The
general interface status.
String operation The most recent power operation.
boolean inProgress true if the operation is still running.
boolean successful true if the operation has finished
successfully. If both successful and inProgress are false, then
the operation failed.
String failureReason If the operation failed, then this field will
typically contain a description of the failure.
xsd:dateTime timeStamp The time that the CC-SG updated the
power operation status.