Aspera Desktop Client

https://www.ibm.com/docs/en/adc
Admin
The Aspera Desktop Client is a client application for high-speed data transfer, designed to...
Tokens:264,747
Snippets:1,549
Trust Score:10
Update:10 months ago
Show doc for...
Tokens:
Raw
### Ascp Command-Line Transfer Examples

Source: https://www.ibm.com/docs/en/adc/index_topic=windows-ascp-transferring-from-command-line

Provides general examples for using the 'ascp' command-line tool to transfer files. These examples illustrate basic syntax and common use cases for initiating transfers. Dependencies include having the 'ascp' binary installed and accessible in the system's PATH.

```shell
# Example: Basic file transfer from local to remote
ascp local_file.txt user@remote_host:/path/to/destination/

# Example: Transferring a directory recursively
ascp -r local_directory/ user@remote_host:/path/to/destination/

# Example: Transferring with specific SSH port
ascp -P 2222 local_file.txt user@remote_host:/path/to/destination/

# Example: Transferring to a specific port on the remote server
ascp -p 9090 local_file.txt user@remote_host:/path/to/destination/
```

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

### Ascp Command-Line File Transfer Examples

Source: https://www.ibm.com/docs/en/adc/index_topic=macos-ascp-transferring-from-command-line

Provides general examples for using the 'ascp' command-line tool to transfer files. This includes basic transfer operations and common use cases. Assumes 'ascp' is installed and in the system's PATH.

```bash
# Basic file transfer
ascp source_file user@remote_host:/path/to/destination

# Transferring a directory recursively
ascp -r source_directory user@remote_host:/path/to/destination

# Transferring to a specific port
ascp -P 12345 source_file user@remote_host:/path/to/destination

# Preserving file permissions
ascp -p source_file user@remote_host:/path/to/destination

# Specifying a different SSH key
ascp -i ~/.ssh/id_rsa source_file user@remote_host:/path/to/destination
```

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

### Start Aspera Desktop Client GUI Application

Source: https://www.ibm.com/docs/en/adc/index_topic=gui-overview-desktop-client

This command initiates the Aspera Desktop Client GUI application. It's the primary method for launching the graphical interface for managing transfers. No specific dependencies are mentioned for this command itself, as it assumes the Aspera client is already installed.

```bash
# asperascp
```

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

### Start Aspera Services on systemd

Source: https://www.ibm.com/docs/en/adc/index_topic=upgrades-before-upgrading-downgrading

This code snippet demonstrates how to manually start Aspera services when downgrading to older versions (3.7.4 and older) on an OS that uses systemd. These commands are necessary because the installer cannot start them automatically.

```shell
# systemctl start asperacentral
# systemctl start asperahttpd
# systemctl start asperarund
# systemctl start asperanoded
```

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

### Install Aspera Desktop Client on Minimal Linux (YUM)

Source: https://www.ibm.com/docs/en/adc/index_topic=iu-installing-desktop-client-3

This command installs the Aspera Desktop Client on minimal Linux systems using YUM, ensuring all required dependencies are met. It is recommended for clean system installations. Use this command with administrator privileges, replacing '/path_to_installer/aspera-desktopclient-version.rpm' with the actual path to your downloaded installer file.

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

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

### Ascp Growing Files Configuration Example

Source: https://www.ibm.com/docs/en/adc/index_topic=atfcl-ascp-command-reference-3

An example demonstrating how to use the growing files feature with specific wait times and confirmation stop settings.

```bash
source?grow=60&wait_start=mtime&confirm_stop=true
```

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

### Ascp Command-Line Transfer Examples

Source: https://www.ibm.com/docs/en/adc/index_topic=atfcl-ascp-general-examples

Illustrates common use cases for the 'ascp' command-line tool, demonstrating various file transfer scenarios. These examples are useful for understanding basic and advanced transfer configurations.

```bash
# Basic transfer from local to remote
ascp /path/to/local/file user@remote_host:/path/to/remote/directory

# Basic transfer from remote to local
ascp user@remote_host:/path/to/remote/file /path/to/local/directory

# Transferring a directory recursively
ascp -r /path/to/local/directory user@remote_host:/path/to/remote/

# Specifying a different SSH port
ascp -P 2222 /path/to/local/file user@remote_host:/path/to/remote/directory

# Using a specific private key
ascp -i ~/.ssh/id_rsa /path/to/local/file user@remote_host:/path/to/remote/directory

# Transferring with a specific bandwidth limit (e.g., 100 Mbps)
ascp -l 100m /path/to/local/file user@remote_host:/path/to/remote/directory

# Preserving file permissions
ascp -p /path/to/local/file user@remote_host:/path/to/remote/directory

# Showing transfer progress
ascp --progress /path/to/local/file user@remote_host:/path/to/remote/directory

# Transferring multiple files using wildcards
ascp /path/to/local/*.txt user@remote_host:/path/to/remote/directory

# Transferring files from a list (response file)
ascp -z responses.txt user@remote_host:/path/to/remote/directory
```

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

### Install Aspera Desktop Client on Linux (RPM)

Source: https://www.ibm.com/docs/en/adc/index_topic=iu-installing-desktop-client-3

This command installs the Aspera Desktop Client using the RPM package manager on Red Hat, zLinux, and CentOS. Ensure you have administrator privileges and replace '/path_to_installer/aspera-desktopclient-version.rpm' with the actual path to your downloaded installer file.

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

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

### Install Aspera Desktop Client using RPM on Linux

Source: https://www.ibm.com/docs/en/adc/index_topic=iu-installing-desktop-client-2

This command installs the Aspera Desktop Client package using the RPM package manager on Red Hat, zLinux, and CentOS. Ensure you have the correct path to the installer file. Requires administrator privileges.

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

```

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

### Ascp4 Command-Line Transfer Examples

Source: https://www.ibm.com/docs/en/adc/index_topic=macos-ascp-transferring-from-command-line

Provides examples for using the 'ascp4' command-line tool, which is an updated version of 'ascp'. This section covers basic transfer operations specific to 'ascp4'.

```bash
# Basic file transfer with ascp4
ascp4 source_file user@remote_host:/path/to/destination

# Transferring a directory recursively with ascp4
ascp4 -r source_directory user@remote_host:/path/to/destination
```

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

### Install Aspera Desktop Client on Red Hat/zLinux/CentOS

Source: https://www.ibm.com/docs/en/adc/index_topic=upgrades-installing-desktop-client

This command installs the Aspera Desktop Client on Red Hat, zLinux, and CentOS systems using the RPM package manager. Ensure you have admin permissions and replace 'version' with your specific package version. For minimal systems, a 'yum install' command is provided to include dependencies.

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

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

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

### Example: Uploading Two Files

Source: https://www.ibm.com/docs/en/adc/index_topic=atfcl-using-standard-io-as-source-destination-2

An example demonstrating how to upload two files, 'myfile1' (1025 bytes) and 'myfile2' (20 bytes), to '/remote-dir' on a server at '10.0.0.2' with a transfer rate of 100 Mbps.

```text
File: myfile1 
Size: 1025 

<< 1025 bytes of data>> 
File: myfile2 
Size: 20

<<20 bytes of data>>
```

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

### Ascp Command-Line File Manipulation Examples

Source: https://www.ibm.com/docs/en/adc/index_topic=macos-ascp-transferring-from-command-line

Demonstrates how to use the 'ascp' command-line tool for file manipulation during transfers, such as creating directories or handling symbolic links. These examples illustrate advanced 'ascp' functionalities.

```bash
# Create destination directory if it doesn't exist
ascp -d source_file user@remote_host:/path/to/new_directory/

# Handling symbolic links: preserve links
ascp -L source_link user@remote_host:/path/to/destination/

# Handling symbolic links: follow links
ascp -l source_link user@remote_host:/path/to/destination/

# Overwriting existing files
ascp -O source_file user@remote_host:/path/to/destination/existing_file

# Renaming file during transfer
ascp source_file user@remote_host:/path/to/destination/new_filename
```

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

### Ascp4 Command-Line Transfer Examples

Source: https://www.ibm.com/docs/en/adc/index_topic=windows-ascp-transferring-from-command-line

Provides examples for using the 'ascp4' command-line tool, which is an updated version of 'ascp'. It covers basic transfer operations and syntax specific to 'ascp4'. Requires the 'ascp4' binary.

```shell
# Example: Basic file transfer using ascp4
ascp4 local_file.txt user@remote_host:/path/to/destination/

# Example: Transferring a directory recursively with ascp4
ascp4 -r local_directory/ user@remote_host:/path/to/destination/

# Example: Transferring with a specific SSH port using ascp4
ascp4 -P 2222 local_file.txt user@remote_host:/path/to/destination/
```

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

### Management Port Commands for Persistent Downloads

Source: https://www.ibm.com/docs/en/adc/index_topic=atfcl-using-standard-io-as-source-destination-2

Example commands sent over the management port (12345) to initiate a persistent download session for multiple files. Commands include 'START' to define source and destination, and 'DONE' to signal the end of the transfer list.

```text
 FASPMGR 2
 Type: START
 Source: /tmp/myfile1
 Destination: mynewfile1

 FASPMGR 2
 Type: START
 Source: /tmp/myfile2
 Destination: mynewfile2

 FASPMGR 2
 Type: DONE
```

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

### Ascp: Fair-Policy Transfer Example

Source: https://www.ibm.com/docs/en/adc/index_topic=atfcl-ascp-general-examples-2

Shows how to perform a fair-policy transfer with specified maximum and minimum transfer rates. This example transfers files from a local directory to a remote host, without encryption.

```bash
# ascp --policy=fair -l 100m -m 1m /local-dir/files root@10.0.0.2:/remote-dir 
```

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

### Install Aspera Desktop Client on Debian

Source: https://www.ibm.com/docs/en/adc/index_topic=upgrades-installing-desktop-client

This command installs the Aspera Desktop Client on Debian-based systems using the dpkg package manager. Ensure you have admin permissions and replace 'version' with your specific package version.

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

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

### Download Through Aspera Forward Proxy with Authentication

Source: https://www.ibm.com/docs/en/adc/index_topic=atfcl-ascp-general-examples-3

This example shows how to download a file through an Aspera forward proxy server, including proxy authentication. The command specifies the proxy host, proxy username, and password. The user will still be prompted for their own transfer user password after the command is initiated.

```bash
# ascp -P 10.0.0.7 -p aspera_proxy -w pa33w0rd /data/file1 Pat@10.0.0.2:/Pat_data/
```

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

### Ascp: Transfer Growing Files Example

Source: https://www.ibm.com/docs/en/adc/index_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 a wait period and specific configuration for the `ascp.conf` file.

```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>
```

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

### Example: Transferring Files Using --file-list

Source: https://www.ibm.com/docs/en/adc/index_topic=atfcl-ascp-command-reference

Demonstrates how to use the --file-list option to transfer specific files and directories. The example shows the content of a list file and the corresponding ascp command, followed by the resulting file structure at the destination.

```bash
> ascp --file-list=list.txt --mode=send --user=username --host=ip_addr .

```

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

### Aspera ascp Filtering Example with Specific Files

Source: https://www.ibm.com/docs/en/adc/index_topic=atfcl-using-filters-include-exclude-files-2

Demonstrates the filtering process with a concrete example using `-N` and `-E` rules on a source directory. It shows how files are evaluated against rules in order and explains the outcome based on matches and rule precedence.

```bash
# Example command:
ascp -N 'file2' -E 'file[0-9]' /images/icons/ user1@examplehost:/tmp

# Assuming /images/icons/ contains file1, file2, and fileA:
# - file1 is excluded by -E 'file[0-9]'
# - file2 is included by -N 'file2'
# - fileA is included as it doesn't match any exclude rule and no final exclude rule is present.
```

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

### Example: Transfer Faux Directory with Ascp

Source: https://www.ibm.com/docs/en/adc/index_topic=appendix-testing-optimizing-transfer-performance

An example demonstrating how to send a simulated directory containing 1 million files with sequential size increments to a remote host using ascp.

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

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

### Example aspera.conf with Checksum and Manifest Settings

Source: https://www.ibm.com/docs/en/adc/index_topic=atfcl-reporting-checksums

An example of the `aspera.conf` file showing the configuration for checksum reporting and file manifest. It includes settings for checksum type, manifest format, and the directory where manifest files are stored.

```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 Aspera Desktop Client with Dependencies using YUM on Linux

Source: https://www.ibm.com/docs/en/adc/index_topic=iu-installing-desktop-client-2

This command installs the Aspera Desktop Client and its required dependencies using YUM on minimal Linux systems. The `--nogpgcheck` flag is used to bypass GPG signature verification. Requires administrator privileges.

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

```

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

### Aspera CLI Proxy Transfer Example

Source: https://www.ibm.com/docs/en/adc/index_topic=atfcl-ascp-general-examples-2

This command demonstrates how to use the Aspera CLI with a proxy server. It specifies the proxy address and credentials, followed by the source and destination file paths. This is useful for transferring files through a secure intermediary.

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

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

### Increase Concurrency with Ascp4

Source: https://www.ibm.com/docs/en/adc/index_topic=line-ascp4-examples

This example illustrates how to configure ascp4 for enhanced transfer performance by increasing the number of client and server threads. It specifies two scan threads and eight read threads on the client, and eight meta threads and 16 write threads on the server.

```bash
# ascp4 -L /tmp/client-logs -R /tmp/server-logs --client-threads scan=2,read=8 --server-threads meta=8,write=16 localhost:/tmp
```

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

### Download through Aspera Forward Proxy with Authentication using `ascp`

Source: https://www.ibm.com/docs/en/adc/index_topic=line-ascp-general-examples

Illustrates downloading a file through an Aspera forward proxy with proxy authentication. The user will be prompted for their transfer user password after the command is run.

```bash
# ascp -l 100m --proxy-host=10.0.0.7 --proxy-user=aspera_proxy --proxy-pass=pa33w0rd /data/file1 Pat@10.0.0.2:/Pat_data/
```

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

### Include 'wxy*' Directly Under 'AAA'

Source: https://www.ibm.com/docs/en/adc/index_topic=atfcl-using-filters-include-exclude-files-2

This example specifically includes directories and files that start with 'wxy' but are located directly under the 'AAA' directory. The `-N 'wxy*'` pattern targets these items, while `-E 'AAA/**'` excludes everything else within 'AAA'.

```shell
ascp rules aspera@my_demo.com:Upload/AAA /tmp/dest
-N 'wxy*' -E 'AAA/**'
```

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

### Aspera ASCP Configuration: Growing File Settings

Source: https://www.ibm.com/docs/en/adc/index_topic=atfcl-ascp-general-examples-1

Shows the necessary configuration within the `ascp.conf` file to enable the growing files feature. It specifies the file path and the parameters for `grow` and `wait_start` to be applied globally or to specific paths.

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

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

### Aspera CLI: Exclude all dot files and dot directories

Source: https://www.ibm.com/docs/en/adc/index_topic=atfcl-using-filters-include-exclude-files-3

This example demonstrates how to exclude all files and directories that start with a dot ('.') from an Aspera transfer. It uses the wildcard '*' to match any character sequence and applies the exclusion rule to all items within the 'AAA' directory.

```bash
ascp rules aspera@my_demo.example.com:Upload/AAA /tmp/dest
-N "*" -E "AAA/**"
```

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

### Exclude Files/Dirs Starting with '.'

Source: https://www.ibm.com/docs/en/adc/index_topic=atfcl-using-filters-include-exclude-files-2

This example shows how to exclude all files and directories that begin with a dot ('.') from a transfer. It uses the `-N '*'` pattern to include everything and `-E 'AAA/**'` to exclude all items within the AAA directory, effectively filtering out dot files and directories.

```shell
ascp rules aspera@my_demo.example.com:Upload/AAA /tmp/dest
-N '*' -E 'AAA/**'
```

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

### Backup Database with asnodeadmin

Source: https://www.ibm.com/docs/en/adc/index_topic=iu-before-upgrading-downgrading-2

This command backs up the Aspera database using the `asnodeadmin` utility. It takes the path to the database backup file as an argument. Ensure you have the necessary permissions to execute this command.

```bash
sudo /opt/aspera/bin/asnodeadmin -b /filepath/database.backup
```

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

### Include 'wxy' Subdirectories and Files at a Specific Location

Source: https://www.ibm.com/docs/en/adc/index_topic=atfcl-using-filters-include-exclude-files-2

This example includes the 'wxy' directory located at `AAA/abc/` and all its subdirectories and files, including those starting with a dot ('.'). The `-N 'AAA/abc/wxy/**'` pattern specifically targets this directory and its contents for inclusion, while `-E 'AAA/**'` excludes all other items within 'AAA'.

```shell
ascp rules aspera@my_demo.example.com:Upload/AAA /tmp/dest
-N 'AAA/abc/wxy/**' -E 'AAA/**'
```

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

### Download through Aspera Forward Proxy with Authentication

Source: https://www.ibm.com/docs/en/adc/index_topic=atfcl-ascp-general-examples-2

This example illustrates downloading a file through an Aspera forward proxy. It includes proxy server details, authentication credentials for the proxy, and the source and destination paths. The user will be prompted for their transfer user password after running the command.

```bash
# Example command structure for proxy authentication (actual command not fully provided in source text):
# ascp -P <proxy_port> --proxy-user=<proxy_username> --proxy-pass=<proxy_password> <source_file> <transfer_user>@<transfer_host>:<destination_path>
```

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

### Include 'wxy' and its Subdirectories, Including Dot Files

Source: https://www.ibm.com/docs/en/adc/index_topic=atfcl-using-filters-include-exclude-files-2

This example demonstrates including 'wxy' directories and files at any level, even those starting with a dot ('.'). It uses two include patterns (`-N '*/wxy*'` and `-N '*/wxy/**'`) to capture both 'wxy' items and their contents, including dot files within them, while `-E 'AAA/**'` excludes other items.

```shell
ascp rules aspera@my_demo.example.com:Upload/AAA /tmp/dest
-N '*/wxy*' -N '*/wxy/**' -E 'AAA/**'
```

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

### Ascp: Fixed-Policy Transfer Example

Source: https://www.ibm.com/docs/en/adc/index_topic=atfcl-ascp-general-examples-3

Demonstrates a fixed-policy transfer with a target rate of 100 Mbps. This example transfers all files from a local directory to a remote destination on host 10.0.0.2 without encryption.

```bash
# ascp --policy=fixed -l 100m /local-dir/files root@10.0.0.2:/remote-dir 
```

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

### Ascp: Fixed-Policy Transfer Example

Source: https://www.ibm.com/docs/en/adc/index_topic=atfcl-ascp-general-examples-2

Demonstrates a fixed-policy transfer using `ascp`, setting a target transfer rate. This example is for transferring files from a local directory to a remote host without encryption.

```bash
# ascp --policy=fixed -l 100m /local-dir/files root@10.0.0.2:/remote-dir
```

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

### Transfer using a File Pair List with `ascp`

Source: https://www.ibm.com/docs/en/adc/index_topic=atfcl-ascp-general-examples-2

This demonstrates how to use a file pair list with `ascp` to specify multiple source files/directories and their corresponding destinations. The `--file-pair-list` option points to the list file, and `.` indicates the destination is the current 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 .
```

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

### Example: Uploading with Offset

Source: https://www.ibm.com/docs/en/adc/index_topic=atfcl-using-standard-io-as-source-destination-2

An example for updating bytes 10-19 of '/remote-dir/myfile1' on a server. The 'Offset:' parameter is set to 10, and the 'Size:' indicates the number of bytes to transfer (10 bytes in this case).

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

<< 10 bytes of data>> 
```

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

### File Transfer using File Pair List with `ascp`

Source: https://www.ibm.com/docs/en/adc/index_topic=line-ascp-general-examples

Demonstrates transferring multiple source files or directories to different destinations using a file pair list. The destinations are relative to the transfer user's docroot.

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

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

### Aspera ASCP: Transfer with File Pair List

Source: https://www.ibm.com/docs/en/adc/index_topic=atfcl-ascp-general-examples-1

Demonstrates transferring multiple source directories to different destinations using a file pair list. The `filepairlist.txt` contains pairs of source paths and their corresponding destination directories relative to the user's docroot. The `.` at the end signifies the current directory as the base for relative destinations.

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

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

### Ascp Growing File Configuration Example (Conceptual)

Source: https://www.ibm.com/docs/en/adc/index_topic=atfcl-ascp-command-reference-1

An illustrative example showing how to adjust the modification time (mtime) of a source file to signal completion for the growing file feature. This requires an external program.

```bash
# Example: Using 'touch' to update mtime (conceptual)
touch -t YYYYMMDDhhmm.ss source_file
```

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

### Apache Velocity Conditional Statement Example

Source: https://www.ibm.com/docs/en/adc/index_topic=tfig-configuring-transfer-notifications-3

This example shows how to implement conditional logic in Apache Velocity templates using `#if`, `#else`, and `#end` directives. It allows for dynamic content generation based on specific conditions, enabling targeted messaging.

```velocity
#if
 ...
#else
 ...
#end
```

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

### Create SSH Directory and Navigate

Source: https://www.ibm.com/docs/en/adc/index_topic=atfcl-creating-ssh-keys-from-command-line-1

This snippet demonstrates how to create a '.ssh' directory in the user's home directory if it doesn't exist and then navigate into it. This is a prerequisite for storing SSH keys.

```bash
$ mkdir /Users/username/.ssh
$ cd /Users/username/.ssh
```

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

### Aspera CLI: Advanced Filtering Example

Source: https://www.ibm.com/docs/en/adc/index_topic=atfcl-using-filters-include-exclude-files-3

Illustrates a more complex filtering scenario with multiple include and exclude rules applied sequentially. This example shows how to specifically include 'file2' while excluding files matching a pattern like 'file[0-9]'.

```bash
ascp -N 'file2' -E 'file[0-9]' /images/icons/ user1@examplehost:/tmp
```

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

### Aspera ASCP: Download Growing File with Wait Period

Source: https://www.ibm.com/docs/en/adc/index_topic=atfcl-ascp-general-examples-1

Demonstrates downloading a file that is still being written to the source directory. It uses the `grow` option to specify a wait period and `wait_start=null_read` to calculate wait time based on zero bytes read. This is useful for large files or slow sources.

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

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

### Exclude Directories and Files Starting with 'wxy'

Source: https://www.ibm.com/docs/en/adc/index_topic=atfcl-using-filters-include-exclude-files-2

This command excludes any directory or file whose name starts with 'wxy'. The `-E 'wxy*'` option is applied to filter these items out from the transfer. Note that this exclusion applies at any level within the transfer path.

```shell
ascp rules aspera@my_demo.example.com:Upload/AAA /tmp/dest
-E 'wxy*'
```

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

### Aspera ASCP: WebSocket Transfer Example

Source: https://www.ibm.com/docs/en/adc/index_topic=atfcl-ascp-general-examples-1

Illustrates how to initiate a file transfer using the WebSocket protocol. This requires the Aspera Node Service to be configured for HTTPS and uses `--ws-connect` and `-P` options to specify WebSocket usage and port. Authentication tokens are also necessary.

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

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

### Aspera Upload Command Example

Source: https://www.ibm.com/docs/en/adc/index_topic=atfcl-using-filters-include-exclude-files-1

This command demonstrates uploading a local directory to a remote server using Aspera's `ascp` utility. It requires specifying the source directory, the remote user and host, and the destination directory on the server.

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

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

### aspera.conf File Checksum Configuration Example

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

This example shows the relevant lines within the `aspera.conf` file that configure checksum reporting. It specifies 'md5' as the checksum type, enables text-based file manifests, and sets a directory for storing manifest files.

```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>
```
Tokens:
Raw