aspera Command Reference
Syntax
All command sequences begin with the program name, aspera. The aspera program
uses the following command syntax:
# aspera command subcommand [arguments]
Commands
The aspera program offers the following commands:
aoc | Interact with the Aspera on Cloud application. |
ats | Interact with the Aspera on Cloud transfer service. |
faspex | Interact with the Faspex application. |
help | View the help information for a command. |
node | Interact with a node transfer server. |
shares | Interact with the Shares application. |
--version | Print the version number of this program. |
Aspera on Cloud Subcommands
The aoc command offers the following subcommands:
Subcommand | Definition |
---|---|
browse | Browse an IBM Aspera on Cloud directory. |
delete | Delete a file in Aspera on Cloud. |
download | Download a file or folder from Aspera on Cloud. |
get | Download a package from Aspera on Cloud. |
help | View Help information for a command. |
mkdir | Create a folder in Aspera on Cloud. |
node list | Interact with an Aspera on Cloud node. |
rename | Rename a file in Aspera on Cloud. |
send | Send a package through Aspera on Cloud. |
upload | Upload a file or folder to Aspera on Cloud. |
workspace list | Get a list of the Aspera on Cloud workspaces. |
For details on the Aspera on Cloud subcommands and their arguments, see aoc Command Reference.
Aspera on Cloud Transfer Service Subcommands
The Aspera on Cloud transfer service (AoCts) allows you to:
- Run high-speed transfers to and from your cloud storage.
- Transfer among your different cloud storages.
- Connect your cloud storage to Aspera web applications.
The ats command offers the following subcommands:
Subcommand | Definition |
---|---|
browse | Browse files and directories. |
delete | Delete one or more files or directories. |
download | Download files or directories. |
help | View Help information for a specific command. |
rename | Rename a file or directory. |
upload | Upload files or directories. |
For details on the AoCts subcommands and their arguments, see ats Command Reference.
Faspex Subcommands
The faspex command offers the following subcommands:
dropbox | Show information about a dropbox. |
get | Download a package from a URL. |
help | View Help information for a specific command. |
list | List the contents of an inbox (Inbox, Sent, or Archived). |
send | Send a package. |
For details on the Faspex subcommands and their arguments, see faspex Command Reference.
Node Subcommands
The node command offers the following subcommands:
Subcommand | Definition |
---|---|
browse | Browse files and directories. |
delete | Delete one or more files or directories. |
download | Download files or directories. |
help | View help for a specific command. |
rename | Rename a file or directory. |
upload | Upload files or directories. |
For details on the node subcommands and their arguments, see node Command Reference.
Shares Subcommands
The shares command offers the following subcommands:
browse | Browse files and directories on a Shares server. |
delete | Delete one or more files or directories from a Shares server. |
download | Download files or directories from a Shares server. |
help | View help for a specific command. |
rename | Rename a file or directory on a Shares server. |
upload | Upload files or directories to a Shares server. |
For details on the Shares subcommands and their arguments, see shares Command Reference.
Getting Help
The aspera program also offers a help command that can explain any command in
more detail, and provide you with sample use cases. To view the help, type the following:
# aspera help [faspex|files|shares]
To view the help for a particular subcommand, the syntax is as follows:
# aspera [faspex|files|shares] help subcommand
For example, to see the options for the Faspex send command, type the following:
# aspera faspex help send
Finding the Software Version Number
To see the version of the aspera client that is installed, type the following:
# aspera version