aoc Command Reference

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 Interact with Aspera on Cloud workspaces.

The browse Subcommand

Use the browse subcommand to browse a location in AoC. The syntax for browse is as follows:
$ aspera aoc browse [args] path

Arguments for the browse subcommand:

Option Definition
-c num

--count num

[Optional] Retrieve only up to num items. The default value is 1000.
-D [Optional] Set the debug level to INFO.
-DD [Optional] Set the debug level to DEBUG.
-DDD [Optional] Set the debug level to TRACE.
--file-id ID [Optional] The root file ID when you are browsing by node ID. For more information, see the reference entry for aspera aoc node list.
--http-proxy proxy_hostOrIp [Optional] The hostname or IP address of the HTTP proxy computer.

proxy_hostOrIP should take the following form:

scheme://proxy_address:port

-k num

--skip num

[Optional] Skip the first num items. num must be a multiple of the value you set with --count.
-L path

--log-path path

[Optional] The path to the AoC log file.
--node-id ID [Optional] The ID of the node you want to browse.
-o organization_name

--organization organization_name

The name of the organization in AoC that you want to interact with. Organizations are specified in the .aspera_cli_conf file.
--path path The path in AoC that you want to browse.
Note: For the aspera aoc browse command, --path is a positional parameter. That is, you can omit the argument name itself, but the path (to the AoC location that you want to browse) must appear after all other arguments.

If your command sequence omits the path, or inverts the order of arguments, the Aspera CLI prompts you for the required information.

-u username

--username username

[Optional] The AoC username (an email address).
-w workspace_name

--workspace workspace_name

The AoC workspace to interact with.

The delete Subcommand

Use the delete subcommand to delete files or folders in AoC. The syntax for delete is as follows:
$ aspera aoc delete [args] path

Arguments for the delete subcommand:

Option Definition
-D [Optional] Set the debug level to INFO.
-DD [Optional] Set the debug level to DEBUG.
-DDD [Optional] Set the debug level to TRACE.
--file-id ID [Optional] The root file ID when you are browsing by node ID. For more information, see the reference entry for aspera aoc node list.
--http-proxy proxy_hostOrIp [Optional] The hostname or IP address of the HTTP proxy computer.

proxy_hostOrIP should take the following form:

scheme://proxy_address:port

-L path

--log-path path

[Optional] The path to the AoC log file.
--node-id ID [Optional] The ID of the node you want to interact with.
-o organization_name

--organization organization_name

The name of the organization in AoC that you want to interact with. Organizations are specified in the .aspera_cli_conf file.
--package-id ID [Optional unless deleting a package] The ID of the package you want to delete.
-s path

--source path

The path to the file you want to delete.
-u username

--username username

[Optional] The AoC username (an email address).
-w workspace_name

--workspace workspace_name

The AoC workspace to interact with.

The download Subcommand

Use the download subcommand to download files or folders from AoC. The syntax for download is as follows:
$ aspera aoc download [args] source_path destination_path [-- ascp-args]

Arguments for the download subcommand:

Option Definition
-d path

--destination path

The path to the destination.
Note: The source and destination of the transfer are positional parameters. That is, you can form your command sequence without explicitly including the --source and --destination arguments themselves, as long as your source and destination values follow these rules:
  • Source and destination must both be named.
  • Source must be named first, then destination.
  • Source and destination must be named after all other arguments.
  • Source and destination must be named before any ascp arguments (using the -- syntax).
If your command sequence omits either source or destination, or inverts their order, the Aspera CLI prompts you for the required information.
-D [Optional] Set the debug level to INFO.
-DD [Optional] Set the debug level to DEBUG.
-DDD [Optional] Set the debug level to TRACE.
--file-id ID [Optional] The root file ID when you are browsing by node ID. For more information, see the reference entry for aspera aoc node list.
--http-proxy proxy_hostOrIp [Optional] The hostname or IP address of the HTTP proxy computer.

proxy_hostOrIP should take the following form:

scheme://proxy_address:port

-L path

--log-path path

[Optional] The path to the AoC log file.
--node-id ID [Optional] The ID of the node you want to interact with.

-o organization_name
--organization organization_name

The name of the organization in AoC that is the source of the content. Organizations are specified in the .aspera_cli_conf file.
-s path

--source path

The path to the file to download.
Note: The source and destination of the transfer are positional parameters. That is, you can form your command sequence without explicitly including the --source and --destination arguments themselves, as long as your source and destination values follow these rules:
  • Source and destination must both be named.
  • Source must be named first, then destination.
  • Source and destination must be named after all other arguments.
  • Source and destination must be named before any ascp arguments (using the -- syntax).
If your command sequence omits either source or destination, or inverts their order, the Aspera CLI prompts you for the required information.
-u username

--username username

[Optional] The AoC username (an email address).
-w workspace_name

--workspace workspace_name

The AoC workspace to interact with.

The get Subcommand

Use the get subcommand to download a package from AoC. The syntax for get is as follows:
$ aspera aoc get --package-id ID [args] destination_path [-- ascp-args]

Arguments for the get subcommand:

Option Definition
-d path

--destination path

The path to the destination.
Note: The destination of the transfer is a positional parameter. That is, you can form your command sequence without explicitly including the --destination argument itself, as long as your destination value follows these rules:
  • Destination must be named after all other arguments.
  • Destination must be named before any ascp arguments (using the -- syntax).
If your command sequence omits the destination, or inverts the order of arguments, the Aspera CLI prompts you for the required information.
-D [Optional] Set the debug level to INFO.
-DD [Optional] Set the debug level to DEBUG.
-DDD [Optional] Set the debug level to TRACE.
--http-proxy proxy_hostOrIp [Optional] The hostname or IP address of the HTTP proxy computer.

proxy_hostOrIP should take the following form:

scheme://proxy_address:port

-L path

--log-path path

[Optional] The path to the AoC log file.
--node-id ID [Optional] The ID of the node you want to interact with.
-o organization_name

--organization organization_name

The name of the organization in AoC that is the source of the content. Organizations are specified in the .aspera_cli_conf file.
--package-id ID The ID of the package to download.
-u username

--username username

[Optional] The AoC username (an email address).
-w workspace_name

--workspace workspace_name

The AoC workspace to interact with.

The mkdir Subcommand

Use the mkdir subcommand to create a folder in AoC. The syntax for mkdir is as follows:
$ aspera aoc mkdir [args] path

Arguments for the mkdir subcommand:

Option Definition
-D [Optional] Set the debug level to INFO.
-DD [Optional] Set the debug level to DEBUG.
-DDD [Optional] Set the debug level to TRACE.
--http-proxy proxy_hostOrIp [Optional] The hostname or IP address of the HTTP proxy computer.

proxy_hostOrIP should take the following form:

scheme://proxy_address:port

-L path

--log-path path

[Optional] The path to the AoC log file.
-o organization_name

--organization organization_name

The name of the organization in AoC. Organizations are specified in the .aspera_cli_conf file.
--path path The path in AoC where you want to create a folder.
Note: The path is a positional parameter. That is, you can form your command sequence without explicitly including the --path argument itself, as long as your path value is named after all other arguments.

If your command sequence omits the path, or inverts the order of arguments, the Aspera CLI prompts you for the required information.

-u username

--username username

[Optional] The AoC username (an email address).
-w workspace_name

--workspace workspace_name

The AoC workspace to interact with.

The node list Subcommand

Use the node list subcommand to interact with an AoC node. The syntax for node list is as follows:
$ aspera aoc node list [args]

Arguments for the node list subcommand:

Option Definition
-D [Optional] Set the debug level to INFO.
-DD [Optional] Set the debug level to DEBUG.
-DDD [Optional] Set the debug level to TRACE.
-L path

--log-path path

[Optional] The path to the AoC log file.
-o organization_name

--organization organization_name

The name of the organization in AoC. Organizations are specified in the .aspera_cli_conf file.
-u username

--username username

[Optional] The AoC username (an email address).

The rename Subcommand

Use the rename subcommand to download files or folders from AoC. The syntax for rename is as follows:
$ aspera aoc rename [args] source_path destination_path

Arguments for the rename subcommand:

Option Definition
-D [Optional] Set the debug level to INFO.
-DD [Optional] Set the debug level to DEBUG.
-DDD [Optional] Set the debug level to TRACE.
-d path

--destination path

The new name for the file.
Note: The source and destination of the file are positional parameters. That is, you can form your command sequence without explicitly including the --source and --destination arguments themselves, as long as your source and destination values follow these rules:
  • Source and destination must both be named.
  • Source must be named first, then destination.
  • Source and destination must be named after all other arguments.
If your command sequence omits either source or destination, or inverts their order, the Aspera CLI prompts you for the required information.
--file-id ID [Optional] The root file ID when you are browsing by node ID. For more information, see the reference entry for aspera aoc node list.
--http-proxy proxy_hostOrIp [Optional] The hostname or IP address of the HTTP proxy computer.

proxy_hostOrIP should take the following form:

scheme://proxy_address:port

-L path

--log-path path

[Optional] The path to the AoC log file.
--node-id ID [Optional] The ID of the node you want to interact with.
-o organization_name

--organization organization_name

The name of the organization in AoC that is the source of the content. Organizations are specified in the .aspera_cli_conf file.
-s path

--source path

The path to the file to rename.
Note: The source and destination of the renamed file are positional parameters. That is, you can form your command sequence without explicitly including the --source and --destination arguments themselves, as long as your source and destination values follow these rules:
  • Source and destination must both be named.
  • Source must be named first, then destination.
  • Source and destination must be named after all other arguments.
If your command sequence omits either source or destination, or inverts their order, the Aspera CLI prompts you for the required information.
-u username

--username username

[Optional] The AoC username (an email address).
-w workspace_name

--workspace workspace_name

The AoC workspace to interact with.

The send Subcommand

Use the send subcommand to send a package. The syntax for send is as follows:
$ aspera aoc send [args] source [-- ascp-args]

Arguments for the send subcommand:

Option Definition
--cc-on-download address_or_username [Optional] Notify users when a package is downloaded. This option takes an argument that can be an email address or an AoC username.
--cc-on-upload address_or_username [Optional] Notify users when a package is uploaded. This option takes an argument that can be an email address or an AoC username.
-D [Optional] Set the debug level to INFO.
-DD [Optional] Set the debug level to DEBUG.
-DDD [Optional] Set the debug level to TRACE.
--dropbox inbox_name [Optional] Send a package to an Aspera on Cloud shared inbox.
Restrictions:
  • The user sending the package must have Can submit permissions to the specified dropbox.
  • You cannot specify multiple shared inboxes.
  • If the shared inbox is configured to require metadata, you must also use the -s or --metadata-file option.
-f path

--file path

The file or files to send in the package. To specify multiple files, separate the files by a space character.
--http-proxy proxy_hostOrIp [Optional] The hostname or IP address of the HTTP proxy computer.

proxy_hostOrIP should take the following form:

scheme://proxy_address:port

-L path

--log-path path

[Optional] The path to the logfile.
--name package_name A name for the package.
--message body_text [Optional] Text for the body of the email message.
--metadata-file [path/]metadata_file [Optional] Specify a file containing the metadata for a shared inbox.
Restrictions:
  • If the shared inbox is configured to require metadata and you do not specify a metadata file with this option, the Aspera CLI displays a template for the file you must create.
  • The metadata file must be in JSON format.
  • If the metadata file is not located in the directory from which the command sequence is run, you must specify its path.
-o organization_name

--organization organization_name

The name of the organization in AoC that is the source of the package you are sending. Organizations are specified in the .aspera_cli_conf file.
--public-link [Optional] For recipients who do not have an AoC account:
  • If your AoC workspace is configured to Require external users to authenticate when receiving packages and you specify this CLI option, the user receives an email containing a link that they can use to download the package.

    This AoC setting is found in the Admin app, on the Workspaces > workspaceName > Applications > Packages screen.

  • If your AoC workspace is configured to Require external users to authenticate when receiving packages and you do not specify this CLI option, the user is directed to activate their IBMid, to create an AoC account. The resulting account has the status of limited member of the AoC workspace.
  • If your AoC workspace is not configured to require external users to authenticate, the behavior is the same whether you specify this CLI option or not: the user receives an email containing a link that they can use to download the package.
-r recipient@email.address

--recipient recipient@email.address

Recipient(s) of the package. You can specify this option multiple times, to indicate multiple recipients. The recipient string should be a valid email address.
-u username

--username username

[Optional] The Aspera on Cloud username (an email address).
-w workspace_name

--workspace workspace_name

The Aspera on Cloud workspace to send content to.

The upload Subcommand

Use the upload subcommand to upload files or folders to AoC. The syntax for upload is as follows:
$ aspera aoc upload [args] source_path destination_path [-- ascp-args]

Arguments for the upload subcommand:

Option Definition
-d path

--destination path

The path to the destination.
Note: The source and destination of the transfer are positional parameters. That is, you can form your command sequence without explicitly including the --source and --destination arguments themselves, as long as your source and destination values follow these rules:
  • Source and destination must both be named.
  • Source must be named first, then destination.
  • Source and destination must be named after all other arguments.
  • Source and destination must be named before any ascp arguments (using the -- syntax).
If your command sequence omits either source or destination, or inverts their order, the Aspera CLI prompts you for the required information.
-D [Optional] Set the debug level to INFO.
-DD [Optional] Set the debug level to DEBUG.
-DDD [Optional] Set the debug level to TRACE.
--file-id ID [Optional] The root file ID when you are browsing by node ID. For more information, see the reference entry for aspera aoc node list.
--filelist [Optional] Specify a file that contains a list of files to transfer.
--http-proxy proxy_hostOrIp [Optional] The hostname or IP address of the HTTP proxy computer.

proxy_hostOrIP should take the following form:

scheme://proxy_address:port

-L path

--log-path path

[Optional] The path to the AoC log file.
--node-id ID [Optional] The ID of the node you want to interact with.
-o organization_name

--organization organization_name

The name of the organization in AoC. Organizations are specified in the .aspera_cli_conf file.
-s path

--source path

The path to the file to upload. To specify multiple files, separate the files by a space character.
Note: The source and destination of the transfer are positional parameters. That is, you can form your command sequence without explicitly including the --source and --destination arguments themselves, as long as your source and destination values follow these rules:
  • Source and destination must both be named.
  • Source must be named first, then destination.
  • Source and destination must be named after all other arguments.
  • Source and destination must be named before any ascp arguments (using the -- syntax).
If your command sequence omits either source or destination, or inverts their order, the Aspera CLI prompts you for the required information.
-u username

--username username

[Optional] The AoC username (an email address).
-w workspace_name

--workspace workspace_name

The AoC workspace to interact with.

The workspace list Subcommand

Use the workspace list subcommand to get a list of AoC workspaces. The syntax for workspace list is as follows:
$ aspera aoc workspace list [args]

Arguments for the workspace list subcommand:

Option Definition
-D [Optional] Set the debug level to INFO.
-DD [Optional] Set the debug level to DEBUG.
-DDD [Optional] Set the debug level to TRACE.
-L path

--log-path path

[Optional] The path to the AoC log file.
-o organization_name

--organization organization_name

The name of the organization in AoC. Organizations are specified in the .aspera_cli_conf file.
-u username

--username username

[Optional] The AoC username (an email address).