SIAM Utility Reference

The SIAM utilities provide command-line tools for performing SIAM system operations. The utilities are implemented as a collection of scripts that wrap Java/native C applications; mostly the scripts are written in bash, csh, and Perl.
The utilities are indexed here by function; click the links to view man pages for each utility.

For a simple summary of commands and options, see the Quick Reference Summary

Commonly Used

Command Description Path Info
Node
exitNode Shutdown SIAM application SIAM_HOME/utils/exitNode
listPorts Show instrument service status SIAM_HOME/utils/listPorts
nodeInfo Show SIAM node configuration information (number of subnodes, etc.) SIAM_HOME/utils/nodeInfo
nodeStatus Show SIAM node status information SIAM_HOME/utils/nodeStatus
nodeTest Start SIAM application SIAM_HOME/utils/nodeTest
Port Management
cachePort Save current instrument service configuration settings SIAM_HOME/utils/cachePort
portProperties Show instrument service configuration information SIAM_HOME/utils/portProperties
powerDownPort Turn off power to an instrument port SIAM_HOME/utils/powerDownPort
powerUpPort Turn on power to an instrument port SIAM_HOME/utils/powerUpPort
restartPort Restart instrument port SIAM_HOME/utils/restartPort
scanPort Start an instrument service SIAM_HOME/utils/scanPort
shutdownPort Stop instrument service SIAM_HOME/utils/shutdownPort
setProperty Set an instrument service configuration parameter SIAM_HOME/utils/setProperty
Sampling
getLastSample Show last data sample taken by an instrument service SIAM_HOME/utils/getLastSample
getMetadata Show instrument service metadata SIAM_HOME/utils/getMetadata
samplePort Request instrument service to take a sample SIAM_HOME/utils/restartPort
Scheduling
resumeSchedule Resume paused instrument service sample schedule SIAM_HOME/utils/resumeSchedule
setSchedule Set an instrument service schedule SIAM_HOME/utils/setSchedule
showSchedule Show an instrument service schedule SIAM_HOME/utils/showSchedule
suspendSchedule Pause instrument service sample schedule SIAM_HOME/utils/suspendSchedule
synch Change an instrument service start time SIAM_HOME/utils/synch

Deployed.Node

Command Description Path Info
addService Add a service Jar file to the service code directory for use with an ID only puck SIAM_HOME/utils/addService
auxTelem Shell script passed to /etc/inittab to enablethe secondary radio port as a Linux tty SIAM_HOME/native/arm-linux/top/etc/auxTelem.sh This script applies only to MMC platform, but may be adapted to other platforms
exitNode Shutdown SIAM application SIAM_HOME/utils/exitNode
getLeases List CPU and comms leases established on specified SIAM node SIAM_HOME/utils/getLeases
killj9 Kill all j9 JVM processes SIAM_HOME/utils/killj9 This script applies only to MMC platform, but may be adapted to other platforms
lease Manage communications leases for a SIAM node SIAM_HOME/utils/lease
listPorts Show instrument service status SIAM_HOME/utils/listPorts
listServices Show services registered using addService SIAM_HOME/utils/listServices
listSubnodes List information about subnodes of the specified SIAM node SIAM_HOME/utils/listSubnodes
node Start SIAM application (with specified portal host) SIAM_HOME/utils/node
nodeInfo Show SIAM node configuration information (number of subnodes, etc.) SIAM_HOME/utils/nodeInfo
nodeStatus Show SIAM node status information SIAM_HOME/utils/nodeStatus
nodeTest Start SIAM application SIAM_HOME/utils/nodeTest
removeService Remove an ID-only PUCK instrument that has been registered using addService SIAM_HOME/utils/removeService
setNodeProperty Set SIAM node application property (configuration) values SIAM_HOME/utils/setNodeProperty

Deployed.service

Command Description Path Info
annotatePort Insert annotation into an instrument service data stream SIAM_HOME/utils/annotatePort
cachePort Save current instrument service configuration settings SIAM_HOME/utils/cachePort
conPort Acquires a console session to a specified instrument port SIAM_HOME/utils/conPort See Environment Notes for SIAM_BIN setting
filters Manage telemetry filters SIAM_HOME/utils/... getfilter, setfilter, clearfilter
getLastSample Show last data sample taken by an instrument service SIAM_HOME/utils/getLastSample SIAM_HOME/utils/portStatus
getMetadata Show instrument service metadata SIAM_HOME/utils/getMetadata
portProperties Show instrument service configuration information SIAM_HOME/utils/portProperties
portStatus Report status of Dual Port Adapter (DPA) instrument port SIAM_HOME/utils/portStatus This utility applies only to MMC platform
powerDownPort Turn off power to an instrument port SIAM_HOME/utils/powerDownPort
powerUpPort Turn on power to an instrument port SIAM_HOME/utils/powerUpPort
removeService Remove an ID-only PUCK instrument that has been registerd with addService SIAM_HOME/utils/removeService
restartPort Restart instrument port SIAM_HOME/utils/restartPort
samplePort Request instrument service to take a sample SIAM_HOME/utils/restartPort
scanPort Start an instrument service SIAM_HOME/utils/scanPort
setInstClock Synchronize instrument clock with SIAM node clock (approximate) SIAM_HOME/utils/setInstClock
setProperty Set an instrument service configuration parameter SIAM_HOME/utils/setProperty
setSchedule Set an instrument service schedule SIAM_HOME/utils/setSchedule
showSchedule Show an instrument service schedule SIAM_HOME/utils/showSchedule
shutdownPort Stop instrument service SIAM_HOME/utils/shutdownPort

PUCK

Command Description Path Info
catJar List the contents of a SIAM instrument service JAR
SIAM_HOME/utils/catJar
puckit Generate a SIAM instrument service JAR, which may be used in an associated PUCK-enabled instrument, or on SIAM node
SIAM_HOME/utils/puckit
writePuck Write payload content to a PUCK-enabled device.
PUCK utilities and classes are maintained in a separate software package
listPuck List payload content of a PUCK-enabled device.
PUCK utilities and classes are maintained in a separate software package
extractPuck Get a payload (content) from a PUCK-enabled device.
PUCK utilities and classes are maintained in a separate software package
dumpPuck Dump PUCK payload contents to the console.
PUCK utilities and classes are maintained in a separate software package
erasePuck Clear PUCK payload memory and datasheet
PUCK utilities and classes are maintained in a separate software package
readDatasheet List PUCK datasheet
PUCK utilities and classes are maintained in a separate software package
writeDatasheet Write PUCK datasheet contents
PUCK utilities and classes are maintained in a separate software package

Shore.autoscript

Command Description Path Info
autoScript Transfer a script from a portal to a primary SIAM node; execute it and receive the results

portal

SIAM_HOME/shoreUtils/manageAutoScript

SIAM node

SIAM_HOME/utils/runAutoscript

Shore.portal

Command Description Path Info
portal

Logs

Command Description Path Info
getPackets Request a set of packets from a SIAM node (with optional filtering) SIAM_HOME/utils/getPackets
logPublish Publish a set of SIAM packets to Shore Side Data System (SSDS) ingest server SIAM_HOME/utils/logPublish Specific to SSDS
logView View data log contents on console, filter and format results SIAM_HOME/utils/logView
repubBatch Call logPublish for multiple device IDs SIAM_HOME/shoreUtils/repubBatch Specific to SSDS