Raritan PX2/PX3 JSON-RPC API
|
6 #ifndef __ASSETMGRMODEL_ASSETSTRIP_IDL__
7 #define __ASSETMGRMODEL_ASSETSTRIP_IDL__
9 #include <AssetStripConfig.idl>
10 #include <UserEvent.idl>
22 constant
int NO_ERROR = 0;
23 constant
int ERR_INVALID_PARAM = 1;
24 constant
int ERR_NO_SUCH_OBJECT = 2;
25 constant
int ERR_NOT_SUPPORTED = 3;
26 constant
int ERR_OPERATION_FAILED = 4;
31 constant
int MAIN_STRIP_COLUMN = 0;
64 CASCADE_FIRMWARE_UPDATE
123 valueobject StripInfoChangedEvent extends
idl.Event {
129 valueobject StateChangedEvent extends
idl.Event {
137 valueobject RackUnitChangedEvent extends
event.UserEvent {
155 valueobject TagEvent extends
idl.Event {
156 vector<TagChangeInfo> tags;
161 valueobject TagAddedEvent extends TagEvent { };
163 valueobject TagRemovedEvent extends TagEvent { };
173 valueobject FirmwareUpdateStateChangedEvent extends
idl.Event {
178 valueobject BladeOverflowChangedEvent extends
idl.Event {
184 valueobject OrientationChangedEvent extends
idl.Event {
190 valueobject CompositionChangedEvent extends
idl.Event {
191 int oldComponentCount;
int programTagIDs(in vector< TagInfo > tagInfos)
Program custom tag IDs.
void triggerPowercycle(in boolean hard)
Trigger a powercycle of either the whole asset strip port or the LED part power supply on the asset s...
CascadeState
For composite asset strips CascadeState shows additional information about the state of the complete ...
Definition: AssetStrip.idl:62
StripInfo getStripInfo()
Get dynamic (number of tags) information.
int newComponentCount
Component count after change.
Definition: AssetStrip.idl:192
Static (type, version) information for an AssetStrip.
Definition: AssetStrip.idl:70
boolean bladeOverflow
Out of space for new blade extension tags, read-only.
Definition: AssetStrip.idl:89
TagInfo tag
Tag which was attached or detached.
Definition: AssetStrip.idl:146
int size
blade extension size (4,8,16), 1 for single tags or 0 if nothing connected
Definition: AssetStrip.idl:115
@ DISCONNECTED
No strip connected.
Definition: AssetStrip.idl:35
@ CASCADE_ACTIVE
cascade is up and running
Definition: AssetStrip.idl:63
int assetStripCascadePosition
number of strip in cascade
Definition: AssetStrip.idl:117
int deviceId
Device type (indicated a certain hardware)
Definition: AssetStrip.idl:71
Dynamic (may change with a connected strip) information for an AssetStrip.
Definition: AssetStrip.idl:84
int appVersion
Application code software version.
Definition: AssetStrip.idl:75
int protocolVersion
Protocol version the strip is supporting.
Definition: AssetStrip.idl:73
int bladeTagCount
Current number of tags on all blade extensions.
Definition: AssetStrip.idl:88
vector< TagInfo > getAllTags()
Get all asset tags of the strip.
int getExtensionTags(in int rackUnitNumber, out vector< TagInfo > tags)
Get all asset tags on an extension.
boolean orientationSensAvailable
Indicates whether the strip has an orientation sensor.
Definition: AssetStrip.idl:76
int assetStripNumberOfRackUnits
number of rack units in strip that this rack unit belongs to
Definition: AssetStrip.idl:119
int rackUnitRelativePosition
relative position to strip
Definition: AssetStrip.idl:118
StripInfo newInfo
Information after change.
Definition: AssetStrip.idl:125
TagType
Type of an asset tag connected to a rack unit.
Definition: AssetStrip.idl:52
int hardwareId
Hardware ID, revision.
Definition: AssetStrip.idl:72
vector< RackUnitInfo > getAllRackUnitInfos()
Get infos with settings for all rack units.
@ UPDATE_SUCCESSFUL
Update was completed successfully.
Definition: AssetStrip.idl:168
int mainTagCount
Current number of tags on the main asset strip.
Definition: AssetStrip.idl:87
Asset Management Strip interface.
Definition: AssetStrip.idl:17
CascadeState cascadeState
State of the cascade (only for composite strips)
Definition: AssetStrip.idl:92
Basic IDL definitions.
Definition: Event.idl:10
int maxMainTagCount
Maximum number of tags supported on the main strip.
Definition: AssetStrip.idl:85
@ FIRMWARE_UPDATE
Firmware update in progress.
Definition: AssetStrip.idl:36
RackUnitInfo rackUnit
New rack unit information.
Definition: AssetStrip.idl:139
int componentCount
Number of components.
Definition: AssetStrip.idl:91
Settings for a single rack unit (LED state)
Definition: AssetStripConfig.idl:111
Orientation
AssetStripConfig orientation
Definition: AssetStripConfig.idl:56
DeviceInfo deviceInfo
Information about connected strip, only valid if newState is AVAILABLE.
Definition: AssetStrip.idl:132
int slotNumber
Blade slot this tag is connected to, 0 is the main strip, >0 for blades.
Definition: AssetStrip.idl:100
string parentBladeTagId
Asset tag ID of the parent blade tag, empty if the tag is not an extension tag.
Definition: AssetStrip.idl:148
Asset Management Model.
Definition: AssetStrip.idl:15
vector< TagInfo > getMainTags()
Get all asset tags on the main strip.
int rackUnitPosition
resulting rack unit position (display number)
Definition: AssetStrip.idl:113
TagType type
type of the asset tag (single, extension, none or unknown)
Definition: AssetStrip.idl:114
FirmwareUpdateState
Enumeration: State of firmware update.
Definition: AssetStrip.idl:166
boolean programmable
Is the asset tag ID programmable?
Definition: AssetStrip.idl:103
FirmwareUpdateState getFirmwareUpdateState()
Retrieve state of firmware update.
Infos for a single rack unit.
Definition: AssetStrip.idl:111
int rackUnitNumber
The rack unit this tag is connected to, range 0..rackUnitCount-1.
Definition: AssetStrip.idl:99
int rackUnitCount
Rack unit count, i.e. number of tags connectable.
Definition: AssetStrip.idl:90
State newState
State after change.
Definition: AssetStrip.idl:131
boolean isCascadable
The asset strip type.
Definition: AssetStrip.idl:77
AssetStripConfig_1_0_1::Orientation newOrientation
Strip orientation after change.
Definition: AssetStrip.idl:186
DeviceInfo getDeviceInfo()
Get static (hardware and firmware) information.
Information describing a tag change.
Definition: AssetStrip.idl:145
StripType
Type of the connected asset strip.
Definition: AssetStrip.idl:44
int slotPosition
Blade slot position of the tag, 0 if the tag is not an extension tag.
Definition: AssetStrip.idl:150
int bootVersion
Bootcode software version.
Definition: AssetStrip.idl:74
AssetStripConfig_1_0_1::RackUnitSettings settings
settings for a single rack unit
Definition: AssetStrip.idl:116
@ EXTENSION
blade server extension, only possible on the main strip
Definition: AssetStrip.idl:54
Asset Strip Config interface.
Definition: AssetStripConfig.idl:17
RackUnitInfo info
Rack unit the tag was/is connected to.
Definition: AssetStrip.idl:147
@ SIMPLE
single, monolitic strip
Definition: AssetStrip.idl:45
@ UNSUPPORTED
Connected asset strip is unsupported.
Definition: AssetStrip.idl:37
int maxBladeTagCount
Maximum number of tags supported on blade extensions.
Definition: AssetStrip.idl:86
@ UPDATE_STARTED
Update is running.
Definition: AssetStrip.idl:167
State
AssetStrip state
Definition: AssetStrip.idl:34
string rawId
The asset tag ID (6 byte hexadecimal string 'AABBCCDDEEFF')
Definition: AssetStrip.idl:102
boolean rackUnitCountConfigurable
Rack unit count has to be configured, i.e. is not auto detected.
Definition: AssetStrip.idl:78
State getState()
Get the current state of the AssetStrip.
string familyDesc
Tag family description, indicating different tag hardware.
Definition: AssetStrip.idl:101
int rackUnitNumber
rack unit for the settings, range 0..rackUnitCount-1
Definition: AssetStrip.idl:112
int getTag(in int rackUnitNumber, in int slotNumber, out TagInfo tagInfo)
Get the asset tag for a rack unit.
int getRackUnitInfo(in int rackUnitNumber, out RackUnitInfo info)
Get info with all settings of a rack unit at once.
Information for a single tag.
Definition: AssetStrip.idl:98
vector< TagInfo > allTags
New list of detected tags after change.
Definition: AssetStrip.idl:157
@ SINGLE
single asset tag connected to main strip or an extension
Definition: AssetStrip.idl:53