Raritan PX2/PX3 JSON-RPC API
Classes | Public Types | Public Member Functions | Public Attributes | List of all members
assetmgrmodel::AssetStrip_2_0_5 Interface Reference

Asset Management Strip interface. More...

import"AssetStrip.idl";

Classes

struct  DeviceInfo
 Static (type, version) information for an AssetStrip. More...
 
struct  RackUnitInfo
 Infos for a single rack unit. More...
 
struct  StripInfo
 Dynamic (may change with a connected strip) information for an AssetStrip. More...
 
struct  TagChangeInfo
 Information describing a tag change. More...
 
struct  TagInfo
 Information for a single tag. More...
 

Public Types

enum  State { DISCONNECTED, FIRMWARE_UPDATE, UNSUPPORTED, AVAILABLE }
 AssetStrip state More...
 
enum  StripType { SIMPLE, COMPOSITE }
 Type of the connected asset strip. More...
 
enum  TagType { SINGLE, EXTENSION, NONE }
 Type of an asset tag connected to a rack unit. More...
 
enum  CascadeState { CASCADE_ACTIVE, CASCADE_FIRMWARE_UPDATE }
 For composite asset strips CascadeState shows additional information about the state of the complete cascade. More...
 
enum  FirmwareUpdateState { UPDATE_STARTED, UPDATE_SUCCESSFUL, UPDATE_FAILED }
 Enumeration: State of firmware update. More...
 

Public Member Functions

State getState ()
 Get the current state of the AssetStrip. More...
 
DeviceInfo getDeviceInfo ()
 Get static (hardware and firmware) information. More...
 
StripInfo getStripInfo ()
 Get dynamic (number of tags) information. More...
 
int getRackUnitInfo (in int rackUnitNumber, out RackUnitInfo info)
 Get info with all settings of a rack unit at once. More...
 
vector< RackUnitInfogetAllRackUnitInfos ()
 Get infos with settings for all rack units. More...
 
int getTag (in int rackUnitNumber, in int slotNumber, out TagInfo tagInfo)
 Get the asset tag for a rack unit. More...
 
vector< TagInfogetAllTags ()
 Get all asset tags of the strip. More...
 
vector< TagInfogetMainTags ()
 Get all asset tags on the main strip. More...
 
int getExtensionTags (in int rackUnitNumber, out vector< TagInfo > tags)
 Get all asset tags on an extension. More...
 
void triggerPowercycle (in boolean hard)
 Trigger a powercycle of either the whole asset strip port or the LED part power supply on the asset strip. More...
 
int programTagIDs (in vector< TagInfo > tagInfos)
 Program custom tag IDs. More...
 
FirmwareUpdateState getFirmwareUpdateState ()
 Retrieve state of firmware update. More...
 

Public Attributes

constant int NO_ERROR = 0
 Error codes. More...
 
constant int ERR_INVALID_PARAM = 1
 Invalid parameter for an operation.
 
constant int ERR_NO_SUCH_OBJECT = 2
 Requested object does not exist.
 
constant int ERR_NOT_SUPPORTED = 3
 Requested operation is not supported.
 
constant int ERR_OPERATION_FAILED = 4
 Operation did not succeed.
 
constant int MAIN_STRIP_COLUMN = 0
 Constants.
 
valueobject StripInfoChangedEvent: idl::Event { StripInfo oldInfo
 Event: Asset strip dynamic information has changed. More...
 
StripInfo newInfo
 Information after change.
 
valueobject StateChangedEvent: idl::Event { State oldState
 Event: Asset strip state has changed. More...
 
State newState
 State after change.
 
DeviceInfo deviceInfo
 Information about connected strip, only valid if newState is AVAILABLE.
 
valueobject RackUnitChangedEvent: event::UserEvent { int rackUnitNumber
 Event: A rack unit has changed. More...
 
RackUnitInfo rackUnit
 New rack unit information.
 
valueobject TagEvent: idl::Event { vector<TagChangeInfo> tags
 Event: A tag was added or removed. More...
 
vector< TagInfoallTags
 New list of detected tags after change.
 
valueobject TagAddedEvent: TagEvent { }
 Event: A tag was added.
 
valueobject TagRemovedEvent: TagEvent { }
 Event: A tag was removed.
 
valueobject FirmwareUpdateStateChangedEvent: idl::Event { FirmwareUpdateState state
 Event: Firmware update was started or has finished. More...
 
valueobject BladeOverflowChangedEvent: idl::Event { boolean overflow
 Event: Tag overflow. More...
 
valueobject OrientationChangedEvent: idl::Event { AssetStripConfig_1_0_1::Orientation oldOrientation
 Event: Detected strip orientation has changed. More...
 
AssetStripConfig_1_0_1::Orientation newOrientation
 Strip orientation after change.
 
valueobject CompositionChangedEvent: idl::Event { int oldComponentCount
 Event: Strip composition has changed. More...
 
int newComponentCount
 Component count after change.
 

Detailed Description

Asset Management Strip interface.

Member Enumeration Documentation

◆ CascadeState

For composite asset strips CascadeState shows additional information about the state of the complete cascade.

Enumerator
CASCADE_ACTIVE 

cascade is up and running

CASCADE_FIRMWARE_UPDATE 

a device in the cascade receives a firmware update

◆ FirmwareUpdateState

Enumeration: State of firmware update.

Enumerator
UPDATE_STARTED 

Update is running.

UPDATE_SUCCESSFUL 

Update was completed successfully.

UPDATE_FAILED 

Update has failed.

◆ State

AssetStrip state

Enumerator
DISCONNECTED 

No strip connected.

FIRMWARE_UPDATE 

Firmware update in progress.

UNSUPPORTED 

Connected asset strip is unsupported.

AVAILABLE 

Asset strip is up and running normally.

◆ StripType

Type of the connected asset strip.

Enumerator
SIMPLE 

single, monolitic strip

COMPOSITE 

strip consisting of multiple cascaded strips

◆ TagType

Type of an asset tag connected to a rack unit.

Enumerator
SINGLE 

single asset tag connected to main strip or an extension

EXTENSION 

blade server extension, only possible on the main strip

NONE 

no asset tag connected to main strip or an extension

Member Function Documentation

◆ getAllRackUnitInfos()

vector<RackUnitInfo> assetmgrmodel::AssetStrip_2_0_5::getAllRackUnitInfos ( )

Get infos with settings for all rack units.

Returns
Result: the rack unit infos with settings

◆ getAllTags()

vector<TagInfo> assetmgrmodel::AssetStrip_2_0_5::getAllTags ( )

Get all asset tags of the strip.

Please note that in case there is not a single tag connected to the strip the resulting list will be empty, only connected tag info structures are returned It is guaranteed that extensions on the main strip are returned before any tag on an extension itself.

Returns
Result: list asset tag infos

◆ getDeviceInfo()

DeviceInfo assetmgrmodel::AssetStrip_2_0_5::getDeviceInfo ( )

Get static (hardware and firmware) information.

Returns
Result: hardware and firmware information

◆ getExtensionTags()

int assetmgrmodel::AssetStrip_2_0_5::getExtensionTags ( in int  rackUnitNumber,
out vector< TagInfo tags 
)

Get all asset tags on an extension.

Gets all tags on a single extension for a certain rack unit. List will be empty if there are no tags connected

Parameters
rackUnitNumberrack unit to get the extension tags for, range 0..rackUnitCount-1
tagsResult: list asset tag infos
Returns
NO_ERROR on success
ERR_INVALID_PARAM rack unit count exceeded or rack unit does not contain an extension

◆ getFirmwareUpdateState()

FirmwareUpdateState assetmgrmodel::AssetStrip_2_0_5::getFirmwareUpdateState ( )

Retrieve state of firmware update.

Returns
asset strip firmware update state

◆ getMainTags()

vector<TagInfo> assetmgrmodel::AssetStrip_2_0_5::getMainTags ( )

Get all asset tags on the main strip.

Same as getAllTags, but only consider tags connected to the main asset strip and not on any connected extension. Extensions on the main strip themselves are returned.

Returns
Result: list asset tag infos

◆ getRackUnitInfo()

int assetmgrmodel::AssetStrip_2_0_5::getRackUnitInfo ( in int  rackUnitNumber,
out RackUnitInfo  info 
)

Get info with all settings of a rack unit at once.

Parameters
rackUnitNumberrack unit to get the info for, range 0..rackUnitCount-1
infoResult: info for this rack unit
Returns
NO_ERROR on success
ERR_INVALID_PARAM rack unit count exceeded

◆ getState()

State assetmgrmodel::AssetStrip_2_0_5::getState ( )

Get the current state of the AssetStrip.

Returns
State of the Asset Strip

◆ getStripInfo()

StripInfo assetmgrmodel::AssetStrip_2_0_5::getStripInfo ( )

Get dynamic (number of tags) information.

Returns
Result: tag related information

◆ getTag()

int assetmgrmodel::AssetStrip_2_0_5::getTag ( in int  rackUnitNumber,
in int  slotNumber,
out TagInfo  tagInfo 
)

Get the asset tag for a rack unit.

Parameters
rackUnitNumberrack unit to read the asset tag for, range 0..rackUnitCount-1
slotNumberslot to read the asset tag for, 0 for the main strip, >0 for blades
tagInfoResult: asset tag information
Returns
NO_ERROR on success
ERR_INVALID_PARAM rack unit count exceeded or colum not existing
ERR_NO_SUCH_OBJECT no tag connected to this rack unit

◆ programTagIDs()

int assetmgrmodel::AssetStrip_2_0_5::programTagIDs ( in vector< TagInfo tagInfos)

Program custom tag IDs.

Asset tags of type AMT-P may be programmed by user (custom ID). This method takes a list of (rack unit, slot number, id) tuples that determine which connected tag should be programmed with which ID. TagInfo::rawId specifies the ID. An empty string erases the current custom ID which brings back the original 1-wire ID. Set TagInfo::slotNumber to 0 for tags on main strip and > 0 for blades. TagInfo::familyDesc and TagInfo::programmable are ignored.

Parameters
tagInfosvector of tag information that will be programmed
Returns
NO_ERROR on success
ERR_INVALID_PARAM rack unit out of bounds or custom ID too long
ERR_NO_SUCH_OBJECT rack unit does not exist or has no tag
ERR_NOT_SUPPORTED tag is not programmable
ERR_OPERATION_FAILED programming failed

◆ triggerPowercycle()

void assetmgrmodel::AssetStrip_2_0_5::triggerPowercycle ( in boolean  hard)

Trigger a powercycle of either the whole asset strip port or the LED part power supply on the asset strip.

Parameters
hardtrue=whole port, false=LEDs only

Member Data Documentation

◆ BladeOverflowChangedEvent

valueobject assetmgrmodel::AssetStrip_2_0_5::BladeOverflowChangedEvent

Event: Tag overflow.

Whether the strip is out of space for new blade extension tags

◆ CompositionChangedEvent

valueobject assetmgrmodel::AssetStrip_2_0_5::CompositionChangedEvent

Event: Strip composition has changed.

Component count before change

◆ FirmwareUpdateStateChangedEvent

valueobject assetmgrmodel::AssetStrip_2_0_5::FirmwareUpdateStateChangedEvent

Event: Firmware update was started or has finished.

Update state

◆ NO_ERROR

constant int assetmgrmodel::AssetStrip_2_0_5::NO_ERROR = 0

Error codes.

Operation successful, no error

◆ OrientationChangedEvent

valueobject assetmgrmodel::AssetStrip_2_0_5::OrientationChangedEvent

Event: Detected strip orientation has changed.

Strip orientation before change

◆ RackUnitChangedEvent

valueobject assetmgrmodel::AssetStrip_2_0_5::RackUnitChangedEvent

Event: A rack unit has changed.

Affected rack unit position

◆ StateChangedEvent

valueobject assetmgrmodel::AssetStrip_2_0_5::StateChangedEvent

Event: Asset strip state has changed.

State before change

◆ StripInfoChangedEvent

valueobject assetmgrmodel::AssetStrip_2_0_5::StripInfoChangedEvent

Event: Asset strip dynamic information has changed.

Information before change

◆ TagEvent

valueobject assetmgrmodel::AssetStrip_2_0_5::TagEvent

Event: A tag was added or removed.

Affected tags


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