SIAM utility commands are summarized below, indexed in several categories:

Commonly Used

Node

exitNode nodeURL
listPorts nodeURL [-stats]
nodeInfo nodeURL
nodeStatus nodeURL
nodeTest

Port Management

cachePort nodeURL port [-clear]
portProperties nodeURL portName [portName...]
powerDownPort nodeURL port
powerUpPort nodeURL port
restartPort nodeURL portName [portName...]
scanPort nodeURL portName [portName...]
setProperty nodeURL port name="value" [name="value"...]
shutdownPort nodeURL port

Sampling

getLastSample nodeURL portName [portName...]
getMetadata nodeURL port [acilpsx]
samplePort nodeURL portName [portName...]

Scheduling

resumeSchedule nodeURL port scheduleName
setSchedule nodeURL port scheduleName scheduleSpecifier
showSchedule nodeURL [port [scheduleName] [lookAheadSec]]
suspendSchedule nodeURL port scheduleName
synch nodeURL port scheduleName [delay ms]

Deployed.Node

addService JAR-file
auxTelem.sh -d device -b baud -t timeoutSec -s sleepSec -p powerBit -y terminalEmulation
exitNode nodeURL
getLeases nodeURL
killj9
lease [-establish durationSec [-aux]] [-renew leaseID [-aux]] [-terminate leaseID [-aux]] nodeURL
listPorts nodeURL [-stats]
listServices nodeURL
listSubnodes nodeURL
node portalHost [debugLevel]
nodeInfo nodeURL
nodeStatus nodeURL
nodeTest
removeService uuid
setNodeProperty nodeURL name="value" [name="value"...]

Deployed.service

addSchedule nodeURL port scheduleName scheduleSpecifier [o]
annotatePort nodeURL portName notation
cachePort nodeURL port [-clear]
conPort nodeURL port
getLastSample nodeURL portName [portName...]
getLeases nodeURL
getMetadata nodeURL port [acilpsx]
portProperties nodeURL portName [portName...]
portStatus nodeURL portName [portName...]
powerDownPort nodeURL port
powerUpPort nodeURL port
removeSchedule nodeURL port scheduleName
restartPort nodeURL portName [portName...]
resumeSchedule nodeURL port scheduleName
samplePort nodeURL portName [portName...]
scanPort nodeURL portName [portName...]
setInstClock nodeURL portName [portName...]
setNodeProperty nodeURL name="value" [name="value"...]
setProperty nodeURL port name="value" [name="value"...]
setSchedule nodeURL port scheduleName scheduleSpecifier
showSchedule nodeURL [port [scheduleName] [lookAheadSec]]
shutdownPort nodeURL port
suspendSchedule nodeURL port scheduleName
synch nodeURL port scheduleName [delay ms]

Scheduling

addSchedule nodeURL port scheduleName scheduleSpecifier [o]
removeSchedule nodeURL port scheduleName
resumeSchedule nodeURL port scheduleName
setSchedule nodeURL port scheduleName scheduleSpecifier
showSchedule nodeURL [port [scheduleName] [lookAheadSec]]
suspendSchedule nodeURL port scheduleName
synch nodeURL port scheduleName [delay ms]

PUCK

catJar jarFile [x]
dumpPuck [-b baudHint] [-t triesPerBaud] port
erasePuck [-b baudHint] [-t triesPerBaud] port
extractPuck [-b baudHint] [-t triesPerBaud] port
listPuck [-b baudHint] [-t triesPerBaud] port
puckit serviceClassname servicePropertiesFile serviceXMLFile outputJarfile
readDatasheet [-b baudHint] [-t triesPerBaud] port
writeDatasheet [-b baudHint] [-t triesPerBaud] port [datasheetProperties]
writePuck [-b baudHint] [-t triesPerBaud] port

Shore.portal

Logs

getPackets nodeURL [-between startTime endTime] [-default] [-types type(s)] [-skip subsampleInterval] [-timeout timeoutSec] [-maxbytes n] [-stale] [-nosave] deviceID
logPublish nodeURL -[hsntp] [-start startTime] [-stop stopTime] deviceID logDirectory
logView [-utc] [-type type][-start startTime][-stop stopTime][-age][-skip n][-bin][-hex][-parse class] [-noheader][-stream][-e][-u][-r separator][-h separator][-notype][-stats][-stats][-sheader] deviceID directory
repubBatch nodeURL -[hsntpV] [-b startTime] [-l logPublishPath] [-e endTime] [-d logDirectory] deviceID [deviceID...]

Alphabetical

addSchedule nodeURL port scheduleName scheduleSpecifier [o]
addService JAR-file
annotatePort nodeURL portName notation
auxTelem.sh -d device -b baud -t timeoutSec -s sleepSec -p powerBit -y terminalEmulation
cachePort nodeURL port [-clear]
catJar jarFile [x]
conPort nodeURL port
dumpPuck [-b baudHint] [-t triesPerBaud] port
erasePuck [-b baudHint] [-t triesPerBaud] port
exitNode nodeURL
extractPuck [-b baudHint] [-t triesPerBaud] port
getLastSample nodeURL portName [portName...]
getLeases nodeURL
getMetadata nodeURL port [acilpsx]
getPackets nodeURL [-between startTime endTime] [-default] [-types type(s)] [-skip subsampleInterval] [-timeout timeoutSec] [-maxbytes n] [-stale] [-nosave] deviceID
killj9
lease [-establish durationSec [-aux]] [-renew leaseID [-aux]] [-terminate leaseID [-aux]] nodeURL
listPorts nodeURL [-stats]
listPuck [-b baudHint] [-t triesPerBaud] port
listServices nodeURL
listSubnodes nodeURL
logPublish nodeURL -[hsntp] [-start startTime] [-stop stopTime] deviceID logDirectory
logView [-utc] [-type type][-start startTime][-stop stopTime][-age][-skip n][-bin][-hex][-parse class] [-noheader][-stream][-e][-u][-r separator][-h separator][-notype][-stats][-stats][-sheader] deviceID directory
node portalHost [debugLevel]
nodeInfo nodeURL
nodeStatus nodeURL
nodeTest
portProperties nodeURL portName [portName...]
portStatus nodeURL portName [portName...]
powerDownPort nodeURL port
powerUpPort nodeURL port
puckit serviceClassname servicePropertiesFile serviceXMLFile outputJarfile
readDatasheet [-b baudHint] [-t triesPerBaud] port
removeSchedule nodeURL port scheduleName
removeService uuid
repubBatch nodeURL -[hsntpV] [-b startTime] [-l logPublishPath] [-e endTime] [-d logDirectory] deviceID [deviceID...]
restartPort nodeURL portName [portName...]
resumeSchedule nodeURL port scheduleName
samplePort nodeURL portName [portName...]
scanPort nodeURL portName [portName...]
"
setInstClock nodeURL portName [portName...]
setNodeProperty nodeURL name="value" [name="value"...]
setProperty nodeURL port name="value" [name="value"...]
setSchedule nodeURL port scheduleName scheduleSpecifier
showSchedule nodeURL [port [scheduleName] [lookAheadSec]]
suspendSchedule nodeURL port scheduleName
shutdownPort nodeURL port
synch nodeURL port scheduleName [delay ms]
writeDatasheet [-b baudHint] [-t triesPerBaud] port [datasheetProperties]
writePuck [-b baudHint] [-t triesPerBaud] port