Command Client Library
DEPRECATED CONTENT - FOR REFERENCE ONLY
Note: IBM Aspera will end support for the Command Client Library by the end of March 2019. We recommend using the Node API instead; see https://developer.ibm.com/aspera/docs/node-api-reference/ for more information.
The Command Client Library allows for remote invocation of file system commands on an Aspera Server. This SDK provides an interface that allows a program to securely execute file system commands on a remote computer. These commands could include listing directory contents, copying files, renaming files, moving files and others. The commands are executed inside the Aspera Shell, which could optionally provide a secure sandbox. This SDK also includes multibyte character support allowing for proper display of pathnames that use multiple languages. The SDK is available as a static library file (.lib) for C++, DLL and .NET and as a JAR (.jar) file for Java. This section includes a brief overview of the different languages.
The Aspera C++ Command Client Library provides the base platform to perform file system operations on any remote machine running Aspera Connect Server. The Command Client library provides a friendly API to perform filesystem operations. The class CommandClient provides methods to connect to a remote host and to perform various operations. The methods execLs, execMd5sum, execDf and execDu return pointers to objects that contain the reply from the command server. All these reply objects/classes have a printReply() method that prints a summary of the information received from the command server They also have methods to extract only the information of interest. All methods that allow execution(prefixed with 'exec') of commands take an object of 'CmdError' class as parameter. In case the command fails, the description of the failure is stored to this object.
To learn more please see the C++ Command Client Library Documentation.
The Aspera Command Client is a library to programmatically perform simple file operations on a remote machine through SSH protocol. When you connect to a remote machine using the command client library, the library establishes an ssh connection to the server and invokes Aspera Command Server (ascmd). Subsequently, all commands issued by the client will be executed on the remote machine by the Command Server and returned to the Command Client. The client library provides the response of the command to the user application in a well formed data structure. It is not possible to execute any commands other than those listed above using the Command Client library.
To learn more please see the Java Command Client API Documentation.
The Aspera C# Command Client library provides the base to perform file system operations on any remote machine running the Aspera Command Server. The Command Client library provides a friendly API to perform filesystem operations. The class CommandClient provides methods to connect to a remote host and to perform various operations. The methods execLs, execDf , execInfo and execDu return pointers to objects that contain the reply from the command server. All these reply classes have a toString() method that prints a summary of the information received from the command server. Also provided are methods to access only the information of interest. All exec methods throw a CommandClientException if the command server returns an error, and a CommandClientInternalException if the command client library runs into any internal error.
To learn more please see the .NET Command Client Library Documentation.
To view the API documentation, please select the version you wish to view
To download the Command Client Library SDK, please choose your platform below.
- Linux 32 bitLinux 32 bit
- Linux 64 bitLinux 64 bit
- Mac IntelMac Intel
- Mac PowerPCMac PowerPC