Raritan PX2/PX3 JSON-RPC API
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Pages
AssetStrip.idl
1 #ifndef __ASSETMGRMODEL_ASSETSTRIP_IDL__
2 #define __ASSETMGRMODEL_ASSETSTRIP_IDL__
3 
4 #include <AssetStripConfig.idl>
5 #include <UserEvent.idl>
6 
10 module assetmgrmodel {
12  interface AssetStrip_2_0_3 {
13 
17  constant int NO_ERROR = 0;
18  constant int ERR_INVALID_PARAM = 1;
19  constant int ERR_NO_SUCH_OBJECT = 2;
20 
24  constant int MAIN_STRIP_COLUMN = 0;
25 
27  enumeration State {
31  AVAILABLE
32  };
33 
37  enumeration StripType {
39  COMPOSITE
40  };
41 
45  enumeration TagType {
48  NONE
49  };
50 
55  enumeration CascadeState {
57  CASCADE_FIRMWARE_UPDATE
58  };
59 
63  structure DeviceInfo {
64  int deviceId;
65  int hardwareId;
68  int appVersion;
70  boolean isCascadable;
72  };
73 
77  structure StripInfo {
82  boolean bladeOverflow;
86  };
87 
91  structure TagInfo {
93  int slotNumber;
94  string familyDesc;
95  string rawId;
96  };
97 
103  structure RackUnitInfo {
107  int size;
108  AssetStripConfig_1_0_1.RackUnitSettings settings;
112  };
113 
115  valueobject StripInfoChangedEvent extends idl.Event {
116  StripInfo oldInfo;
118  };
119 
121  valueobject StateChangedEvent extends idl.Event {
122  State oldState;
125  };
127 
129  valueobject RackUnitChangedEvent extends event.UserEvent {
130  int rackUnitNumber;
132  };
133 
137  structure TagChangeInfo {
141  int slotPosition;
143  };
145 
147  valueobject TagEvent extends idl.Event {
148  vector<TagChangeInfo> tags;
149  vector<TagInfo> allTags;
150  };
151 
153  valueobject TagAddedEvent extends TagEvent { };
155  valueobject TagRemovedEvent extends TagEvent { };
156 
158  enumeration FirmwareUpdateState {
161  UPDATE_FAILED
162  };
163 
165  valueobject FirmwareUpdateStateChangedEvent extends idl.Event {
167  };
168 
170  valueobject BladeOverflowChangedEvent extends idl.Event {
171  boolean overflow;
172  };
174 
176  valueobject OrientationChangedEvent extends idl.Event {
177  AssetStripConfig_1_0_1.Orientation oldOrientation;
179  };
180 
182  valueobject CompositionChangedEvent extends idl.Event {
183  int oldComponentCount;
185  };
186 
192  State getState();
193 
199  DeviceInfo getDeviceInfo();
200 
206  StripInfo getStripInfo();
207 
216  int getRackUnitInfo(in int rackUnitNumber, out RackUnitInfo info);
217 
223  vector<RackUnitInfo> getAllRackUnitInfos();
224 
235  int getTag(in int rackUnitNumber, in int slotNumber, out TagInfo tagInfo);
236 
248  vector<TagInfo> getAllTags();
249 
259  vector<TagInfo> getMainTags();
260 
273  int getExtensionTags(in int rackUnitNumber, out vector<TagInfo> tags);
274 
281  void triggerPowercycle(in boolean hard);
282  };
283 }
284 
285 #endif /* __ASSETMGRMODEL_ASSETSTRIP_IDL__ */
string rawId
The asset tag ID (6 byte hexadecimal string 'AABBCCDDEEFF')
Definition: AssetStrip.idl:95
AssetStripConfig_1_0_1 RackUnitSettings settings
settings for a single rack unit
Definition: AssetStrip.idl:108
Asset Strip Config interface.
Definition: AssetStripConfig.idl:12
Orientation
AssetStripConfig orientation
Definition: AssetStripConfig.idl:51
Connected asset strip is unsupported.
Definition: AssetStrip.idl:30
Information describing a tag change.
Definition: AssetStrip.idl:137
single, monolitic strip
Definition: AssetStrip.idl:38
Firmware update in progress.
Definition: AssetStrip.idl:29
State
AssetStrip state
Definition: AssetStrip.idl:27
int deviceId
Device type (indicated a certain hardware)
Definition: AssetStrip.idl:64
int rackUnitNumber
The rack unit this tag is connected to, range 0..rackUnitCount-1.
Definition: AssetStrip.idl:92
Update is running.
Definition: AssetStrip.idl:159
TagType type
type of the asset tag (single, extension, none or unknown)
Definition: AssetStrip.idl:106
int rackUnitRelativePosition
relative position to strip
Definition: AssetStrip.idl:110
boolean bladeOverflow
Out of space for new blade extension tags, read-only.
Definition: AssetStrip.idl:82
Infos for a single rack unit.
Definition: AssetStrip.idl:103
Update was completed successfully.
Definition: AssetStrip.idl:160
Information for a single tag.
Definition: AssetStrip.idl:91
int maxBladeTagCount
Maximum number of tags supported on blade extensions.
Definition: AssetStrip.idl:79
int mainTagCount
Current number of tags on the main asset strip.
Definition: AssetStrip.idl:80
StripType
Type of the connected asset strip.
Definition: AssetStrip.idl:37
DeviceInfo deviceInfo
Information about connected strip, only valid if newState is AVAILABLE.
Definition: AssetStrip.idl:124
int slotNumber
Blade slot this tag is connected to, 0 is the main strip, >0 for blades.
Definition: AssetStrip.idl:93
vector< TagInfo > allTags
New list of detected tags after change.
Definition: AssetStrip.idl:149
int maxMainTagCount
Maximum number of tags supported on the main strip.
Definition: AssetStrip.idl:78
int protocolVersion
Protocol version the strip is supporting.
Definition: AssetStrip.idl:66
CascadeState cascadeState
State of the cascade (only for composite strips)
Definition: AssetStrip.idl:85
int appVersion
Application code software version.
Definition: AssetStrip.idl:68
TagType
Type of an asset tag connected to a rack unit.
Definition: AssetStrip.idl:45
TagInfo tag
Tag which was attached or detached.
Definition: AssetStrip.idl:138
boolean rackUnitCountConfigurable
Rack unit count has to be configured, i.e. is not auto detected.
Definition: AssetStrip.idl:71
StripInfo newInfo
Information after change.
Definition: AssetStrip.idl:117
CascadeState
For composite asset strips CascadeState shows additional information about the state of the complete ...
Definition: AssetStrip.idl:55
int rackUnitPosition
resulting rack unit position (display number)
Definition: AssetStrip.idl:105
AssetStripConfig_1_0_1 Orientation newOrientation
Strip orientation after change.
Definition: AssetStrip.idl:178
Dynamic (may change with a connected strip) information for an AssetStrip.
Definition: AssetStrip.idl:77
int newComponentCount
Component count after change.
Definition: AssetStrip.idl:184
int rackUnitCount
Rack unit count, i.e. number of tags connectable.
Definition: AssetStrip.idl:83
string parentBladeTagId
Asset tag ID of the parent blade tag, empty if the tag is not an extension tag.
Definition: AssetStrip.idl:140
State newState
State after change.
Definition: AssetStrip.idl:123
boolean isCascadable
The asset strip type.
Definition: AssetStrip.idl:70
RackUnitInfo rackUnit
New rack unit information.
Definition: AssetStrip.idl:131
int bladeTagCount
Current number of tags on all blade extensions.
Definition: AssetStrip.idl:81
int assetStripCascadePosition
number of strip in cascade
Definition: AssetStrip.idl:109
boolean orientationSensAvailable
Indicates whether the strip has an orientation sensor.
Definition: AssetStrip.idl:69
int size
blade extension size (4,8,16), 1 for single tags or 0 if nothing connected
Definition: AssetStrip.idl:107
Asset Management Strip interface.
Definition: AssetStrip.idl:12
single asset tag connected to main strip or an extension
Definition: AssetStrip.idl:46
int componentCount
Number of components.
Definition: AssetStrip.idl:84
No strip connected.
Definition: AssetStrip.idl:28
int rackUnitNumber
rack unit for the settings, range 0..rackUnitCount-1
Definition: AssetStrip.idl:104
int hardwareId
Hardware ID, revision.
Definition: AssetStrip.idl:65
int assetStripNumberOfRackUnits
number of rack units in strip that this rack unit belongs to
Definition: AssetStrip.idl:111
FirmwareUpdateState
Enumeration: State of firmware update.
Definition: AssetStrip.idl:158
blade server extension, only possible on the main strip
Definition: AssetStrip.idl:47
cascade is up and running
Definition: AssetStrip.idl:56
string familyDesc
Tag family description, indicating different tag hardware.
Definition: AssetStrip.idl:94
RackUnitInfo info
Rack unit the tag was/is connected to.
Definition: AssetStrip.idl:139
int bootVersion
Bootcode software version.
Definition: AssetStrip.idl:67
Static (type, version) information for an AssetStrip.
Definition: AssetStrip.idl:63