IBM Blockchainud

https://www.ibm.com/docs/en/asdc
Admin
IBM Cloud Object Storage service for S3 compatibles.
Tokens:253,445
Snippets:1,722
Trust Score:10
Update:10 months ago
Show doc for...
Tokens:
Raw
### ascp: Command-Line Transfer Examples (Shell)

Source: https://www.ibm.com/docs/en/asdc/4_topic=atfcl-comparison-ascp-ascp4-options-4

Demonstrates common 'ascp' command-line usage for transferring files, including general examples, file manipulation, and using standard I/O. Requires the 'ascp' binary to be installed and in the system's PATH.

```shell
# General example: Transfer a file from local to remote
ascp /path/to/local/file.txt user@remote_host:/path/to/remote/directory/

# General example: Transfer a file from remote to local
ascp user@remote_host:/path/to/remote/file.txt /path/to/local/directory/

# File manipulation: Create a directory on the remote host
ascp -d user@remote_host:/path/to/new_directory

# Using Standard I/O: Pipe output from another command to ascp for upload
cat /path/to/local/file.txt | ascp - user@remote_host:/path/to/remote/file.txt

# Using Standard I/O: Pipe content from ascp to standard output for download
ascp user@remote_host:/path/to/remote/file.txt - > /path/to/local/file.txt
```

--------------------------------

### Google Cloud Storage Upload/Download Examples

Source: https://www.ibm.com/docs/en/asdc/4_topic=hdfs-transfers-aspera-demand-cloud-based-hstss

Command-line examples for performing uploads and downloads with Google Cloud Storage using 'ascp'. These examples assume the Aspera server is running on a Google Compute instance.

```APIDOC
## Google Cloud Storage Upload/Download Examples

### Description
This section provides examples for uploading and downloading files to and from Google Cloud Storage using the Aspera CLI ('ascp'). These commands are intended for use when the Aspera server is running on a Google Compute instance.

### Upload Syntax
```bash
ascp [options] --mode=send --user=username --host=server_address source_files gs:///my_bucket/my_path
```

### Upload Example
```bash
ascp --mode=send --user=bear --host=10.0.0.5 bigfile.txt gs:///2017_transfers/data
```

### Download Syntax
```bash
ascp [options] --mode=recv --user=username --host=server gs:///my_bucket/my_path/source_file destination_path
```

### Download Example
```bash
ascp --mode=recv --user=bear --host=10.0.0.5 gs:///2017_transfers/data/bigfile.txt /data
```
```

--------------------------------

### Azure Blob Storage Upload/Download Syntax and Examples using ascp

Source: https://www.ibm.com/docs/en/asdc/4_topic=atosh-transfers-aspera-demand-cloud-based-hstss

Provides command-line examples for uploading and downloading files to Azure blob storage via 'ascp'. Credentials (storage account and access key) are embedded in the destination URI. A note is included for Azure Files syntax.

```shell
> ascp options --mode=send --user=username --host=server_address source_files azu://storage_account:storage_access_key@blob.core.windows.net/path_to_blob
> ascp --mode=send --user=AS037d8eda429737d6 --host=dev920350144d2.azure.asperaondemand.com bigfile.txt azu://astransfer:zNfMtU...nBTkhB@blob.core.windows.net/abc
> ascp options --mode=recv --user=username --host=server azu://storage_account:storage_access_key@blob.core.windows.net/path_to_blob/source_file destination_path
> ascp --mode=recv --user=AS037d8eda429737d6 --host=dev920350144d2.azure.asperaondemand.com azu://astransfer:zNfMtU...nBTkhB@blob.core.windows.net/abc /downloads
```

--------------------------------

### ascp Command Reference and Examples

Source: https://www.ibm.com/docs/en/asdc/4_topic=atfcl-ascp-faqs-4

This section details the 'ascp' command-line utility for high-speed file transfers. It includes a general command reference, examples for common transfer scenarios, file manipulation, and advanced usage like using standard I/O and filters.

```bash
# Ascp Command Reference (Illustrative Example)
ascp [options] <source> <destination>

# Ascp General Examples
# Transfer a file from local to remote:
ascp my_local_file.txt user@remote_host:/remote/directory/

# Transfer a file from remote to local:
ascp user@remote_host:/remote/directory/remote_file.txt .

# Using filters to include and exclude files:
ascp --include "*.txt" --exclude "*.log" local_dir/ user@remote_host:/remote/dir/

# Using Standard I/O as the Source or Destination
# Example: Pipe a tar archive directly to ascp for transfer
tar czf - /my/local/data | ascp - file.tar.gz user@remote_host:/backup/
```

--------------------------------

### Azure Blob Storage: Upload and Download with ascp

Source: https://www.ibm.com/docs/en/asdc/4_topic=atosh-transfers-aspera-demand-cloud-based-hstss-1

Provides syntax and examples for uploading and downloading files to Azure Blob Storage using `ascp`. Authentication includes storage account and access key. For Azure Files, a different syntax is noted. These examples are for scenarios without a configured docroot.

```bash
$ ascp options --mode=send --user=username --host=server_address source_files azu://storage_account:storage_access_key@blob.core.windows.net/path_to_blob
$ ascp --mode=send --user=AS037d8eda429737d6 --host=dev920350144d2.azure.asperaondemand.com bigfile.txt azu://astransfer:zNfMtU...nBTkhB@blob.core.windows.net/abc
```

```bash
$ ascp options --mode=recv --user=username --host=server azu://storage_account:storage_access_key@blob.core.windows.net/path_to_blob/source_file destination_path
$ ascp --mode=recv --user=AS037d8eda429737d6 --host=dev920350144d2.azure.asperaondemand.com azu://astransfer:zNfMtU...nBTkhB@blob.core.windows.net/abc /downloads
```

--------------------------------

### Azure Blob Storage Upload/Download Examples

Source: https://www.ibm.com/docs/en/asdc/4_topic=hdfs-transfers-aspera-demand-cloud-based-hstss

Examples for transferring files to and from Azure Blob Storage using the 'ascp' command. Includes syntax for specifying storage account, access key, and the path within the blob container.

```APIDOC
## Azure Blob Storage Upload/Download Examples

### Description
This section illustrates how to upload and download files to/from Azure Blob Storage using the Aspera CLI ('ascp'). The examples show the required command-line syntax, including authentication details like storage account and access key, and how to specify the target path within Azure.

### Upload Syntax
```bash
ascp [options] --mode=send --user=username --host=server_address source_files azu://storage_account:storage_access_key@blob.core.windows.net/path_to_blob
```

### Upload Example
```bash
ascp --mode=send --user=AS037d8eda429737d6 --host=dev920350144d2.azure.asperaondemand.com bigfile.txt azu://astransfer:zNfMtU...nBTkhB@blob.core.windows.net/abc
```

### Download Syntax
```bash
ascp [options] --mode=recv --user=username --host=server azu://storage_account:storage_access_key@blob.core.windows.net/path_to_blob/source_file destination_path
```

### Download Example
```bash
ascp --mode=recv --user=AS037d8eda429737d6 --host=dev920350144d2.azure.asperaondemand.com azu://astransfer:zNfMtU...nBTkhB@blob.core.windows.net/abc /downloads
```

**Note:** For Azure Files, use the syntax: `azure-files://storage_account:storage_access_key@file.core.windows.net/share`.
```

--------------------------------

### Google Cloud Storage: Upload and Download with ascp

Source: https://www.ibm.com/docs/en/asdc/4_topic=atosh-transfers-aspera-demand-cloud-based-hstss-1

Illustrates uploading and downloading files to Google Cloud Storage using `ascp`. These examples are for instances running on Google Compute and assume no docroot configuration. Authentication is handled via the `gs://` protocol.

```bash
$ ascp options --mode=send --user=username --host=server_address source_files gs:///my_bucket/my_path
$ ascp --mode=send --user=bear --host=10.0.0.5 bigfile.txt gs:///2017_transfers/data
```

```bash
$ ascp options --mode=recv --user=username --host=server gs:///my_bucket/my_path/source_file destination_path
$ ascp --mode=recv --user=bear --host=10.0.0.5 gs:///2017_transfers/data/bigfile.txt /data
```

--------------------------------

### Install Desktop Client on RedHat/zLinux/CentOS

Source: https://www.ibm.com/docs/en/asdc/4_topic=iu-installing-desktop-client-2

Installs the IBM Desktop Client using RPM package manager on RedHat, zLinux, and CentOS systems. Assumes the installer has been downloaded to the specified path. This command is suitable for new installations or upgrades if the system is prepared.

```bash
$ rpm -Uvh /path_to_installer/aspera-desktopclient-version.rpm
```

--------------------------------

### ascp: Ascp Command Reference (Shell)

Source: https://www.ibm.com/docs/en/asdc/4_topic=atfcl-comparison-ascp-ascp4-options-4

Provides a basic reference for the 'ascp' command, outlining key options and their functions. This is a subset of the full command reference and may not cover all parameters. Assumes 'ascp' is installed.

```shell
# Ascp Command Reference Snippet
# Usage: ascp [options] SRC DST
# Options:
# -d, --create-dir     Create destination directory if it does not exist.
# -f, --file           Specify a file to transfer.
# -r, --recursive      Recursively copy entire directories.
# -L, --link           Preserve symbolic links.
# -p, --preserve       Preserve file attributes (permissions, timestamps).
# --checksum           Enable checksum verification.
# --report-checksum    Report checksums for transferred files.
# --encrypt-at-rest    Enable client-side encryption-at-rest.
# -h, --help           Display help message.
```

--------------------------------

### IBM COS - S3 Upload/Download Examples

Source: https://www.ibm.com/docs/en/asdc/4_topic=hdfs-transfers-aspera-demand-cloud-based-hstss

Syntax and examples for uploading and downloading files to/from IBM Cloud Object Storage (COS) using the S3 protocol with the 'ascp' command.

```APIDOC
## IBM COS - S3 Upload/Download Examples

### Description
This section details the command-line syntax and provides examples for uploading and downloading files to and from IBM Cloud Object Storage (COS) using the S3 API endpoint with the Aspera CLI ('ascp').

### Upload Syntax
```bash
ascp [options] --mode=send --user=username --host=server_address source_files s3://access_id:secret_key@accessor_endpoint/vault_name
```

### Upload Example
```bash
ascp --mode=send --user=bear --host=s3.example.com bigfile.txt s3://3ITI3OIUFEH233:KrcEW...AIuwQ@38.123.76.24/demo2017
```

### Download Syntax
```bash
ascp [options] --mode=send --user=username --host=server_address s3://access_id:secret_key@accessor_endpoint/vault_name/source_files destination_path
```

### Download Example
```bash
ascp --mode=recv --user=bear --host=s3.example.com s3://3ITI3OIUFEH233:KrcEW...AIuwQ@38.123.76.24/demo2017/bigfile.txt /tmp/
```
```

--------------------------------

### Amazon S3 Upload/Download Examples

Source: https://www.ibm.com/docs/en/asdc/4_topic=hdfs-transfers-aspera-demand-cloud-based-hstss

Examples demonstrating how to upload and download files to/from Amazon S3 using the 'ascp' command. It covers scenarios with and without IAM roles, showing the syntax for including access ID and secret key in the destination path.

```APIDOC
## Amazon S3 Upload/Download Examples

### Description
This section provides command-line syntax and examples for uploading and downloading files to/from Amazon S3 using the Aspera CLI ('ascp'). It details how to include authentication credentials (access ID and secret key) directly in the destination path when not using IAM roles.

### Upload Syntax
```bash
ascp [options] --mode=send --user=username --host=s3_server_addr source_files s3://access_id:secret_key@s3.amazonaws.com/my_bucket
```

### Upload Example
```bash
ascp --mode=send --user=bear --host=s3.example.com bigfile.txt s3://1K3C18FBWF9902:GEyU...AqXuxtTVHWtc@s3.amazonaws.com/demos2014
```

### Download Syntax
```bash
ascp [options] --mode=recv --user=username --host=s3_server_addr s3://access_id:secret_key@s3.amazonaws.com/my_bucket/my_source_path destination_path
```

### Download Example
```bash
ascp --mode=recv --user=bear --host=s3.example.com s3://1K3C18FBWF9902:GEyU...AqXuxtTVHWtc@s3.amazonaws.com/demos2014/bigfile.txt /tmp/
```
```

--------------------------------

### Install Desktop Client with Dependencies on Minimal Linux

Source: https://www.ibm.com/docs/en/asdc/4_topic=iu-installing-desktop-client-2

Installs the IBM Desktop Client and its required dependencies on minimal Linux installations (e.g., RedHat, zLinux, CentOS) using YUM package manager. This ensures all necessary components are present for the application to function correctly.

```bash
$ yum --nogpgcheck install /path_to_installer/aspera-desktopclient-version.rpm
```

--------------------------------

### Amazon S3 Upload/Download Syntax and Examples using ascp

Source: https://www.ibm.com/docs/en/asdc/4_topic=atosh-transfers-aspera-demand-cloud-based-hstss

Demonstrates the command-line syntax for uploading and downloading files to Amazon S3 using the 'ascp' command. It shows how to include access IDs and secret keys in the destination path. IAM roles can bypass the need for explicit credentials.

```shell
> ascp options --mode=send --user=username --host=s3_server_addr source_files s3://access_id:secret_key@s3.amazonaws.com/my_bucket
> ascp --mode=send --user=bear --host=s3.example.com bigfile.txt s3://1K3C18FBWF9902:GEyU...AqXuxtTVHWtc@s3.amazonaws.com/demos2014
> ascp options --mode=recv --user=username --host=s3_server_addr s3://access_id:secret_key@s3.amazonaws.com/my_bucket/my_source_path destination_path
> ascp --mode=recv --user=bear --host=s3.example.com s3://1K3C18FBWF9902:GEyU...AqXuxtTVHWtc@s3.amazonaws.com/demos2014/bigfile.txt /tmp/
```

--------------------------------

### Execute High-Speed File Transfer with ascp4

Source: https://www.ibm.com/docs/en/asdc/4_topic=atfcl-ascp4-examples-3

This snippet shows how to use the `ascp4` command for high-speed file transfers. It specifies various parameters for logging, performance tuning (threads and transfer rate), and the source and destination paths. Ensure the Aspera client is installed and configured on the source machine.

```bash
ascp4 -L /tmp/logs -R /tmp/logs -l1g --scan-threads=2 --read-threads=8 --write-threads=16 --meta-threads=8  /data/100K aspera@10.0.113.53:/data
```

--------------------------------

### Google Cloud Storage Upload/Download Syntax and Examples using ascp

Source: https://www.ibm.com/docs/en/asdc/4_topic=atosh-transfers-aspera-demand-cloud-based-hstss

Illustrates the 'ascp' command for uploading and downloading files to Google Cloud Storage. It assumes the Aspera server is running on a Google Compute instance. Credentials are not explicitly shown in the syntax, implying default or instance-based authentication.

```shell
> ascp options --mode=send --user=username --host=server_address source_files gs:///my_bucket/my_path
> ascp --mode=send --user=bear --host=10.0.0.5 bigfile.txt gs:///2017_transfers/data
> ascp options --mode=recv --user=username --host=server gs:///my_bucket/my_path/source_file destination_path
> ascp --mode=recv --user=bear --host=10.0.0.5 gs:///2017_transfers/data/bigfile.txt /data
```

--------------------------------

### Amazon S3: Upload and Download with ascp

Source: https://www.ibm.com/docs/en/asdc/4_topic=atosh-transfers-aspera-demand-cloud-based-hstss-1

Demonstrates how to upload and download files to/from Amazon S3 using the `ascp` command-line tool. Requires specifying access ID and secret key unless IAM roles are used. These examples assume no docroot is configured.

```bash
$ ascp options --mode=send --user=username --host=s3_server_addr source_files s3://access_id:secret_key@s3.amazonaws.com/my_bucket
$ ascp --mode=send --user=bear --host=s3.example.com bigfile.txt s3://1K3C18FBWF9902:GEyU...AqXuxtTVHWtc@s3.amazonaws.com/demos2014
```

```bash
$ ascp options --mode=recv --user=username --host=s3_server_addr s3://access_id:secret_key@s3.amazonaws.com/my_bucket/my_source_path destination_path
$ ascp --mode=recv --user=bear --host=s3.example.com s3://1K3C18FBWF9902:GEyU...AqXuxtTVHWtc@s3.amazonaws.com/demos2014/bigfile.txt /tmp/
```

--------------------------------

### Ascp Faux Source Directory Transfer Example

Source: https://www.ibm.com/docs/en/asdc/4_topic=a-testing-optimizing-transfer-performance

This example shows how to transfer a simulated directory using faux:///. It configures the directory name, file naming conventions, number of files, initial file size, and sequential size increment. The target path is also specified.

```bash
> ascp --mode=send --user=username --host=10.0.0.2 faux:///mydir?file=testfile&count=1m&size=0&inc=2&seq=sequential /tmp
```

--------------------------------

### ascp4: Transferring from the Command Line (Shell)

Source: https://www.ibm.com/docs/en/asdc/4_topic=atfcl-comparison-ascp-ascp4-options-4

Illustrates the basic usage of 'ascp4', the next-generation command-line transfer tool. It follows a similar structure to 'ascp' but may have different default behaviors or options. Requires 'ascp4' to be installed.

```shell
# Example for ascp4 (syntax may vary based on version)
ascp4 /path/to/local/file.txt user@remote_host:/path/to/remote/directory/
ascp4 user@remote_host:/path/to/remote/file.txt /path/to/local/directory/

# Example with options (specific options may differ from ascp)
ascp4 -r --preserve /path/to/local/directory/ user@remote_host:/path/to/remote/backup/
```

--------------------------------

### aspera.conf Example for Checksum and Manifest Configuration

Source: https://www.ibm.com/docs/en/asdc/4_topic=atfcl-reporting-checksums

An example of the aspera.conf file content showing the configuration for checksum reporting (md5), file manifest (text), and manifest path.

```xml
<file_system>
    ...
    <file_checksum>md5</file_checksum>
    <file_manifest>text</file_manifest>
    <file_manifest_path>C:\\Users\\Public\\reports</file_manifest_path>
    ...
</file_system>
```

--------------------------------

### Install IBM Desktop Client on RedHat/zLinux/CentOS

Source: https://www.ibm.com/docs/en/asdc/4_topic=upgrades-installing-desktop-client

Installs the IBM Desktop Client using the RPM package manager on RedHat, zLinux, and CentOS systems. This command requires root permissions. If dependencies are missing on a minimal system, use the 'yum install' command.

```bash
$ rpm -Uvh /path_to_installer/aspera-desktopclient-version.rpm

```

```bash
$ yum --nogpgcheck install /path_to_installer/aspera-desktopclient-version.rpm

```

--------------------------------

### Install IBM Desktop Client on Debian

Source: https://www.ibm.com/docs/en/asdc/4_topic=upgrades-installing-desktop-client

Installs the IBM Desktop Client using the dpkg package manager on Debian-based systems. This command requires root permissions.

```bash
$ dpkg -i /path_to_installer/aspera-desktopclient-version.deb

```

--------------------------------

### Public Key Authentication for Transfer

Source: https://www.ibm.com/docs/en/asdc/4_topic=atfcl-ascp-general-examples-4

This example demonstrates using public key authentication for secure file transfers. It specifies the path to the private key file for authentication.

```bash
# Example: ascp --key=<home dir>/.ssh/aspera_user_1-key local-dir/files user@remote_host:/remote_dir
```

--------------------------------

### Launch IBM Aspera Desktop Client GUI

Source: https://www.ibm.com/docs/en/asdc/4_topic=gui-overview-desktop-client

This command launches the IBM Aspera Desktop Client GUI application. No specific inputs are required, and the output is the graphical user interface for managing transfers.

```bash
# asperascp
```

--------------------------------

### Help and Host Configuration

Source: https://www.ibm.com/docs/en/asdc/4_topic=line-ascp4-command-reference

Options for displaying help information and configuring the transfer host.

```APIDOC
## Help and Host Configuration

### Description
Options for accessing help documentation and specifying the target host for transfers.

### Options

- `-h, --help`:
  - **Description**: Display the usage summary.

- `--host=`host:
  - **Description**: Transfer to the specified host name or address.
  - **Requirement**: Requires `--mode`.
  - **Alternative**: This option can be used instead of specifying the host as part of the filename (as `hostname:filepath`).
```

--------------------------------

### ASCP: Exclude directories and files whose names start with 'wxy'

Source: https://www.ibm.com/docs/en/asdc/4_topic=atfcl-using-filters-include-exclude-files-3

This example demonstrates how to exclude all directories and files that start with 'wxy'. The '-E' flag followed by 'wxy*' applies this exclusion rule to the entire transfer. This is useful for excluding specific project directories or temporary files.

```bash
ascp <source> <destination>

# Example command to exclude directories and files whose names start with 'wxy':
-E 'wxy*'
```

--------------------------------

### ASCP: Include 'wxy*' items at any level, exclude dot-files/dirs

Source: https://www.ibm.com/docs/en/asdc/4_topic=atfcl-using-filters-include-exclude-files-3

This example includes directories and files at any level that start with 'wxy', while excluding dot-files, dot-directories, and any files under 'wxy' directories (unless they also start with 'wxy'). Subdirectories under 'wxy' are included. The pattern '*/wxy*' targets 'wxy' items at any depth.

```bash
ascp <source> <destination>

# Example command to include items at any level starting with 'wxy', excluding dot-files/dirs and files under 'wxy':
-N '*/wxy*' -E 'AAA/**'
```

--------------------------------

### Download Through Aspera Forward Proxy with Authentication

Source: https://www.ibm.com/docs/en/asdc/4_topic=line-ascp-general-examples

Illustrates downloading a file through an Aspera forward proxy. The command includes proxy server details and authentication credentials for the proxy. The transfer user's password will be prompted for after the command is executed.

```bash
# Example command structure (actual command not fully provided in source):
# ascp --proxy-host=10.0.0.7 --proxy-user=aspera_proxy --proxy-password=pa33w0rd /data/file1 Pat@10.0.0.2:/Pat_data/
```

--------------------------------

### Ascp Example: Transferring Growing Files

Source: https://www.ibm.com/docs/en/asdc/4_topic=atfcl-ascp-general-examples-2

Demonstrates how to use the 'ascp' command to transfer files that are still being written to the source directory. It includes parameters for wait time and zero-byte read, and shows the corresponding aspera.conf configuration.

```bash
ascp --mode=recv --user=root --host=10.0.0.2 "file:////tmp/myfile?grow=120&wait_start=null_read" file:////tmp2/mylocalfile
```

```xml
<default>
    <file_system>
        <access>
            <paths><path><absolute>
                file:////tmp?grow=120;wait_start=null_read
            </absolute></path></paths>
        </access>
    </file_system>
</default>
```

--------------------------------

### Execute FASP4 Management Commands with Ascp4

Source: https://www.ibm.com/docs/en/asdc/4_topic=atfcl-ascp4-examples-2

This example demonstrates how to execute FASP4 management commands (PUT, WRITE, CLOSE) using the ascp4 command. It specifies log file locations and connects to the management port 5000 on localhost. The `--faspmgr-io` option enables FASP4 management I/O.

```bash
# ascp4 -L /tmp/client-logs -R /tmp/server-logs --faspmgr-io -M 5000 localhost:/tmp
```

--------------------------------

### Increase Client and Server Concurrency with Ascp4

Source: https://www.ibm.com/docs/en/asdc/4_topic=atfcl-ascp4-examples-2

This example shows how to configure ascp4 for increased transfer performance by specifying the number of scan, read, meta, and write threads. It increases client-side concurrency with two scan threads and eight read threads, and server-side concurrency with eight meta threads and sixteen write threads.

```bash
# ascp4 --client-scan-threads 2 --client-read-threads 8 --server-meta-threads 8 --server-write-threads 16
```

--------------------------------

### Download Test Files using ascp

Source: https://www.ibm.com/docs/en/asdc/4_topic=iu-testing-transfer-4

Demonstrates how to use the `ascp` command-line utility to download a test file from a server. It requires the server address, login account, source file path, and a local download location. The output shows transfer progress and speed.

```shell
# ascp -T xeno@my_demo.example.com:test-dir-large/100MB /tmp/

```

--------------------------------

### Google Cloud Storage Upload/Download Authentication

Source: https://www.ibm.com/docs/en/asdc/4_topic=atosh-transfers-aspera-demand-cloud-based-hstss

Instructions for uploading and downloading files to/from Google Cloud Storage via `ascp`, assuming the VMI is a Google Compute instance. Examples are provided for both operations.

```APIDOC
## POST /upload/google-cloud-storage

### Description
Uploads files to Google Cloud Storage using the `ascp` command-line tool. This method assumes the VMI is a Google Compute instance.

### Method
POST

### Endpoint
`ascp --mode=send --user=<username> --host=<server_address> <source_files> gs://<my_bucket>/<my_path>`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None (parameters are part of the command line)

### Request Example
```bash
ascp --mode=send --user=bear --host=10.0.0.5 bigfile.txt gs:///2017_transfers/data
```

## GET /download/google-cloud-storage

### Description
Downloads files from Google Cloud Storage using the `ascp` command-line tool. This method assumes the VMI is a Google Compute instance.

### Method
GET

### Endpoint
`ascp --mode=recv --user=<username> --host=<server> gs://<my_bucket>/<my_path>/<source_file> <destination_path>`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None (parameters are part of the command line)

### Request Example
```bash
ascp --mode=recv --user=bear --host=10.0.0.5 gs:///2017_transfers/data/bigfile.txt /data
```
```

--------------------------------

### Transfer File via Aspera Proxy with Authentication

Source: https://www.ibm.com/docs/en/asdc/4_topic=atfcl-ascp-general-examples

This command demonstrates transferring a file through an Aspera forward proxy. It includes proxy authentication credentials (username and password) and specifies the target file and destination directory. The user will be prompted for their transfer user password after execution.

```bash
> ascp --proxy dnats://aspera_proxy:pa33w0rd@10.0.0.7 /data/file1 Pat@10.0.0.2:/Pat_data/
```

--------------------------------

### ASCP: Exclude 'wxy*' items at a specific location '/AAA/abc/'

Source: https://www.ibm.com/docs/en/asdc/4_topic=atfcl-using-filters-include-exclude-files-3

This example shows how to exclude directories and files starting with 'wxy' but only if they are located within the '/AAA/abc/' path. The '-E '/AAA/abc/wxy*'' flag specifically targets these items for exclusion. Other 'wxy' items outside this path are not affected.

```bash
ascp <source> <destination>

# Example command to exclude directories and files starting with 'wxy' at a specific location:
-E '/AAA/abc/wxy*'
```

--------------------------------

### Amazon S3 Upload/Download Authentication

Source: https://www.ibm.com/docs/en/asdc/4_topic=atosh-transfers-aspera-demand-cloud-based-hstss

This section details how to upload and download files to/from Amazon S3 using the `ascp` command when a docroot is not configured. It covers syntax for specifying access keys and provides examples.

```APIDOC
## POST /upload/amazon-s3

### Description
Uploads files to Amazon S3 using the `ascp` command-line tool. Authentication is handled via access ID and secret key in the destination path.

### Method
POST

### Endpoint
`ascp --mode=send --user=<username> --host=<s3_server_addr> <source_files> s3://<access_id>:<secret_key>@s3.amazonaws.com/<my_bucket>`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None (parameters are part of the command line)

### Request Example
```bash
ascp --mode=send --user=bear --host=s3.example.com bigfile.txt s3://1K3C18FBWF9902:GEyU...AqXuxtTVHWtc@s3.amazonaws.com/demos2014
```

## GET /download/amazon-s3

### Description
Downloads files from Amazon S3 using the `ascp` command-line tool. Authentication is handled via access ID and secret key in the source path.

### Method
GET

### Endpoint
`ascp --mode=recv --user=<username> --host=<s3_server_addr> s3://<access_id>:<secret_key>@s3.amazonaws.com/<my_bucket>/<my_source_path> <destination_path>`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None (parameters are part of the command line)

### Request Example
```bash
ascp --mode=recv --user=bear --host=s3.example.com s3://1K3C18FBWF9902:GEyU...AqXuxtTVHWtc@s3.amazonaws.com/demos2014/bigfile.txt /tmp/
```
```

--------------------------------

### Ascp: Upload Folder Contents Only (Recursive)

Source: https://www.ibm.com/docs/en/asdc/4_topic=atfcl-ascp-file-manipulation-examples-3

Uploads all files and folders within a specified directory, but not the parent directory itself. This is useful for transferring the contents of a folder into an existing destination folder.

```shell
# ascp /clips/out/* /in/
```

--------------------------------

### Ascp: Upload with Content Protection

Source: https://www.ibm.com/docs/en/asdc/4_topic=atfcl-ascp-general-examples-1

Demonstrates uploading a file with content protection using a password. The password is set as an environment variable, and the transfer is encrypted.

```bash
$ export ASPERA_SCP_FILEPASS=secRet ascp -l 10m --file-crypt=encrypt local-dir/file root@10.0.0.2:/remote-dir/
```

--------------------------------

### Define Faux Source Directory Parameters

Source: https://www.ibm.com/docs/en/asdc/4_topic=a-testing-optimizing-transfer-performance-4

This section details the parameters used to configure a faux source directory. It includes options for directory name, file naming root, file count, initial file size, size increment, sequence type (sequential or random), and buffer initialization.

```text
faux:///dirname?file=file&count=count&size=size&inc=increment&seq=sequence&buf_init=buf_option

# Parameters:
#   dirname: Name for the directory (required).
#   file: Root for file names, default is "file" (optional).
#   count: Number of files in the directory (required).
#   size: Size of the first file, default 0 (optional). Modifiers k, m, g, t, p, e allowed.
#   increment: Byte increment for next file size, default 0 (optional).
#   sequence: "sequential" or "random", default is "sequential" (optional).
#   buf_init: "none", "zero", or "random", default is "zero" (optional). Not allowed for downloads.
```

--------------------------------

### Ascp: Transfer with File Pair List

Source: https://www.ibm.com/docs/en/asdc/4_topic=atfcl-ascp-general-examples-1

Demonstrates how to specify multiple source-destination pairs for a transfer using a file list. The file list contains paths to source directories and their corresponding destination directories relative to the user's docroot.

```text
/tmp/folder1
tmp1
/tmp/folder2
tmp2
```

```bash
$ ascp --user=user_1 --host=10.0.0.2 --mode=send --file-pair-list=/tmp/filepairlist.txt .
```

--------------------------------

### IBM COS - S3 Upload/Download Authentication

Source: https://www.ibm.com/docs/en/asdc/4_topic=atosh-transfers-aspera-demand-cloud-based-hstss

Documentation for uploading and downloading files to/from IBM Cloud Object Storage (S3 compatible) using `ascp`. Includes syntax and examples for access keys, endpoint, and vault name.

```APIDOC
## POST /upload/ibm-cos-s3

### Description
Uploads files to IBM Cloud Object Storage (S3 compatible) using the `ascp` command-line tool. Authentication uses access ID, secret key, accessor endpoint, and vault name.

### Method
POST

### Endpoint
`ascp --mode=send --user=<username> --host=<server_address> <source_files> s3://<access_id>:<secret_key>@<accessor_endpoint>/<vault_name>`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None (parameters are part of the command line)

### Request Example
```bash
ascp --mode=send --user=bear --host=s3.example.com bigfile.txt s3://3ITI3OIUFEH233:KrcEW...AIuwQ@38.123.76.24/demo2017
```

## GET /download/ibm-cos-s3

### Description
Downloads files from IBM Cloud Object Storage (S3 compatible) using the `ascp` command-line tool. Authentication uses access ID, secret key, accessor endpoint, and vault name.

### Method
GET

### Endpoint
`ascp --mode=send --user=<username> --host=<server_address> s3://<access_id>:<secret_key>@<accessor_endpoint>/<vault_name>/<source_files> <destination_path>`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None (parameters are part of the command line)

### Request Example
```bash
ascp --mode=send --user=bear --host=s3.example.com s3://3ITI3OIUFEH233:KrcEW...AIuwQ@38.123.76.24/demo2017 /tmp/
```
```

--------------------------------

### Azure Blob Storage Upload/Download Authentication

Source: https://www.ibm.com/docs/en/asdc/4_topic=atosh-transfers-aspera-demand-cloud-based-hstss

This section covers uploading and downloading files to/from Azure Blob Storage using `ascp`, including syntax for storage account, access key, and destination path, along with examples.

```APIDOC
## POST /upload/azure-blob

### Description
Uploads files to Azure Blob Storage using the `ascp` command-line tool. Authentication uses storage account and access key in the destination path.

### Method
POST

### Endpoint
`ascp --mode=send --user=<username> --host=<server_address> <source_files> azu://<storage_account>:<storage_access_key>@<blob.core.windows.net>/<path_to_blob>`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None (parameters are part of the command line)

### Request Example
```bash
ascp --mode=send --user=AS037d8eda429737d6 --host=dev920350144d2.azure.asperaondemand.com bigfile.txt azu://astransfer:zNfMtU...nBTkhB@blob.core.windows.net/abc
```

## GET /download/azure-blob

### Description
Downloads files from Azure Blob Storage using the `ascp` command-line tool. Authentication uses storage account and access key in the source path.

### Method
GET

### Endpoint
`ascp --mode=recv --user=<username> --host=<server> azu://<storage_account>:<storage_access_key>@<blob.core.windows.net>/<path_to_blob>/<source_file> <destination_path>`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None (parameters are part of the command line)

### Request Example
```bash
ascp --mode=recv --user=AS037d8eda429737d6 --host=dev920350144d2.azure.asperaondemand.com azu://astransfer:zNfMtU...nBTkhB@blob.core.windows.net/abc /downloads
```
```

--------------------------------

### Ascp: Transfer using WebSocket Protocol

Source: https://www.ibm.com/docs/en/asdc/4_topic=atfcl-ascp-general-examples-1

Shows how to initiate a file transfer using the WebSocket protocol. This requires the Aspera Node Service to be enabled and configured for HTTPS. A token (basic, bearer, or transfer) must also be provided.

```bash
$ ascp -L- --ws-connect -P 9093  --host=www.example.com --mode=send --user=xeno c:/Users/xeno/Desktop/myfile  /Desktop/ dest
```

--------------------------------

### Upload and move file with --move-after-transfer

Source: https://www.ibm.com/docs/en/asdc/4_topic=atfcl-ascp-file-manipulation-examples-3

Uploads a file to a remote server and then moves the source file on the client to a specified archive directory. This ensures the file is not duplicated locally after a successful upload.

```shell
# ascp --move-after-transfer=C:/Users/Pat/Archive C:/Users/Pat/srcdir/file0012 Pat@10.0.0.1:/ 
```

--------------------------------

### aclean Command Reference

Source: https://www.ibm.com/docs/en/asdc/4_topic=appendix-aclean-reference

Documentation for the aclean command-line tool, including its syntax, path formats, options, and examples.

```APIDOC
## aclean Command Reference

### Description
The `aclean` command-line tool provides a fast method for deleting directories and files from both local and object storage. It allows filtering of content based on last modified times and supports dry runs for testing deletion operations. The tool can be run on any platform where Ascp4 is supported.

**Note:** The directory specified in an `aclean` command is not deleted itself. Only the content within that directory matching the specified options is removed.

### Syntax
```
aclean [options] directory
```

### Directory Path Format
*   **Local paths:** Can be full or relative paths. Use `/` separators for all operating systems, including Windows. Full Windows paths should be formatted as `/c:/path/to/delete`.
*   **Object storage:** Specify paths using URIs. Examples include Azure storage (`azu://storage_account:storage_access_key@blob.core.windows.net/path_to_blob`) and AWS S3 (`s3://access_id:secret_key@s3.amazonaws.com/my_bucket/path`). Variable components of the URI must be URL encoded.

### Options
| Option (short, long)          | Description                                                                                        |
|-------------------------------|----------------------------------------------------------------------------------------------------|
| `-h, --help`                  | Display help information.                                                                          |
| `-A, --version`               | Display the tool's version.                                                                        |
| `-L, --logdir <filepath>`     | Set the filepath for the log directory.                                                            |
| `-n, --dry-run`               | Perform a trial run to show what content would be deleted without actually deleting it.          |
| `-t, --threads <number>`      | Set the number of threads to use for scanning the directory. (Default: 8)                          |
| `--remove-empty-dirs`         | Delete empty subdirectories within the specified directory.                                        |
| `--remove-newer-than=<MTIME>` | Delete files that are newer than the specified `MTIME`. `MTIME` format: `YYYY-mm-dd HH:MM`. Timestamp is based on local time. |
| `--remove-older-than=<MTIME>` | Delete files that are older than the specified `MTIME`. `MTIME` format: `YYYY-mm-dd HH:MM`. Timestamp is based on local time. |

### Examples
*   **Delete the contents of a local directory:**
    ```bash
    aclean /temp/logs-test/
    ```

*   **View what files would be deleted (dry run):**
    ```bash
    aclean --dry-run /temp/logs-test/
    ```

*   **Delete empty subdirectories:**
    ```bash
    aclean --remove-empty-dirs /temp/logs-test/
    ```

*   **Delete files older than a specific date from Azure object storage:**
    ```bash
    aclean --remove-older-than=2017-03-27 13:34 azu://user:key@blob.microsoft.com
    ```
```

--------------------------------

### Upload Files with Offset via Stdin using `ascp`

Source: https://www.ibm.com/docs/en/asdc/4_topic=atfcl-using-standard-io-as-source-destination

This example shows how to update specific byte ranges within a file on a remote server using `ascp`. The `Offset` parameter in the `sourcefile` stream specifies the starting byte for overwriting, allowing for partial file updates. This is useful for scenarios where only a portion of a file needs modification.

```bash
type sourcefile | ascp -l 100m --mode=send --user=username --host=10.0.0.2 stdio-tar:// /remote-dir
```

```text
File: myfile1 
Size: 10
Offset: 10 

<< 10 bytes of data>>
```

--------------------------------

### Sample File List Content

Source: https://www.ibm.com/docs/en/asdc/4_topic=atfcl-ascp-command-reference

An example of the content expected within a file specified by the --file-list option. Each line represents a source file or directory to be transferred.

```text
/tmp/code/compute.php 
doc_dir
images/iris.png 
images/rose.png
```

--------------------------------

### Download Test File using ascp (Linux/macOS)

Source: https://www.ibm.com/docs/en/asdc/4_topic=upgrades-testing-transfer

This command demonstrates how to download a file from a remote Aspera server using the 'ascp' command-line utility. It prompts for confirmation of the server's key and the user's password.

```bash
ascp user@my_demo.example.com:/remote/path/to/file /local/path
y
my_password
```

--------------------------------

### Aspera Upload Example using ascp

Source: https://www.ibm.com/docs/en/asdc/4_topic=atfcl-using-filters-include-exclude-files-1

Demonstrates how to upload a local directory to a remote server using the 'ascp' command. This requires specifying the source directory, the remote user and host, and the destination path on the server.

```bash
ascp /tmp/src my_user_name@my_demo.example.com:Upload/
```

--------------------------------

### Set Chunk Size with ascp4 Command

Source: https://www.ibm.com/docs/en/asdc/4_topic=atfcl-ascp4-transfers-object-storage-2

This command demonstrates how to apply the previously configured chunk size when initiating an ascp4 session. The `--chunk-size` flag is used to specify the size in bytes. Ensure the ascp4 tool is installed and accessible in your PATH.

```bash
ascp4 session --chunk-size=1048576
```

--------------------------------

### Upload directory with --src-base and remove local contents

Source: https://www.ibm.com/docs/en/asdc/4_topic=atfcl-ascp-file-manipulation-examples-3

Uploads directory contents to a server, stripping the srcbase path and preserving file structure. After transfer, it deletes the transferred contents, including empty directories, from the client, excluding partial files.

```shell
# ascp --src-base=/content --remove-after-transfer --remove-empty-directories /content/ root@10.0.0.1:/storage/*
```

--------------------------------

### Aspera CLI Proxy Connection Example

Source: https://www.ibm.com/docs/en/asdc/4_topic=atfcl-ascp-general-examples-2

This command demonstrates how to establish a connection to a remote host using a proxy server. It specifies the proxy details and the destination for the file transfer. Ensure the proxy server details and credentials are correct.

```bash
#ascp --proxy dnats://aspera_proxy:pa33w0rd@10.0.0.7 /data/file1 Pat@10.0.0.2:/Pat_data/
```

--------------------------------

### Launch Aspera Desktop Client GUI (Linux)

Source: https://www.ibm.com/docs/en/asdc/4_topic=upgrades-testing-transfer

This command launches the graphical user interface for the IBM Aspera High-Speed Desktop Client on Linux systems. It requires the 'asperascp' executable to be in the system's PATH.

```bash
$ asperascp
```
Tokens:
Raw