StorNext 4.x Web Services (WSAPI) Commands, Usage, and Description

Note: Web services in this topic were introduced in StorNext 4.0. Web services in this topic are still supported in StorNext 5. If you are creating new integrations, use the Web Services (V1) commands, or the Web Services (V2) commands.

The Web Services Application Programming Interface feature (WS-API) provides an HTTP-based interface to a subset of the StorNext Storage Manager User Commands. WS-API provides basic control over StorNext Storage Manager systems to track media and drives, and to store/truncate/retrieve files from any computer capable of creating a Web Services connection, which includes Windows, Macintosh, and Linux-based systems, among others.

When first released in StorNext 4.0, WS-API returned the text-format output of the commands. The most recent WS-API release changes the commands listed below to add structured Extensible Markup Language (XML) or JavaScript Object Notation (JSON) optional output formats.

The following subset of Storage Manager Commands supports the -F parameter to select XML, JSON or text output, and their associated WS-API interfaces (in parentheses):

fscancel (doCancel)
fsfileinfo (getFileLocation)
fsfiletapeloc (getFileTapeLocation)
fsmedinfo (getMediaReport)
fsmedlist (getMediaInfo)
fsqueue (getSMQueue)
fsrelocate (relocateFiles)
fsretrieve (doRetrieve)
fsrmdiskcopy (doTruncate)
fsstate (getDriveReport)
fsstore (doStore)
fswascfg (getWasConfiguration)
vsmove (doMediaMove)

The new fsxsd and vsxsd commands provide access to XML schemas describing the output of those commands.