IBM Aspera High-Speed Transfer Server (HSTS)

https://www.ibm.com/docs/en/ahts
Admin
IBM Aspera High-Speed Transfer Server (HSTS) is a software solution designed for fast, secure, and...
Tokens:165,556
Snippets:2,773
Trust Score:10
Update:1 month ago
Show doc for...
Tokens:
Raw
### Example Logging Class and User Assignment

Source: https://www.ibm.com/docs/en/ahts/4.4.x?topic=csfcl-server-logging-configuration-ascp-ascp4-3

A practical example creating 'admin' and 'home' logging classes and assigning users to them.

```bash
> asconfigurator -x "set_log_setting_data;classes,admin;directory,/root/logs;log_size,3;level,dbg"
 > asconfigurator -x "set_log_setting_data;classes,home;directory,$(home)/logs;log_size,20;level,dbg1"
 > asconfigurator -x "set_user_data;user_name,root;logging_class,admin"
 > asconfigurator -x "set_user_data;user_name,user1;logging_class,home"
```

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

### Install SysV init.d on RHEL 9

Source: https://www.ibm.com/docs/en/ahts/4.4.x?topic=cloud-getting-started-trapd-service

Required for starting the Trapd service on RHEL 9 systems.

```bash
dnf install initscripts chkconfig
```

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

### Single-file transfer examples

Source: https://www.ibm.com/docs/en/ahts/4.4.x?topic=line-using-standard-io-as-source-destination

Examples demonstrating uploading to a file, downloading to stdout, and uploading to a named pipe using ascp.

```bash
cat myfile | ascp -l 100m --mode=send --user=username --host=10.0.0.2 stdio:///newfile?1025 /remote-dir
```

```bash
ascp -l 100m --mode=recv --user=username --host=10.0.0.2 remote_file stdio://
```

```bash
ascp -l 100m --mode=send --user=username --host=10.0.0.2 local_file stdio:////tmp/outpipe
```

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

### SSH host key path configuration example

Source: https://www.ibm.com/docs/en/ahts/4.4.x?topic=iu-installing-configuring-ssh-server-2

Example of the resulting configuration entry in the aspera.conf file.

```xml
<ssh_host_key_path>/etc/ssh/ssh_host_rsa_key.pub</ssh_host_key_path>
```

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

### Start the Application

Source: https://www.ibm.com/docs/en/ahts/4.4.x?topic=gui-creating-ssh-keys-in

Command to launch the application from the terminal.

```bash
# asperascp
```

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

### Create a specific Vlink example

Source: https://www.ibm.com/docs/en/ahts/4.4.x?topic=csfcl-controlling-bandwidth-usage-virtual-links-from-command-line-4

Example command to create a Vlink with ID 108, named '50Mbps cap', and a capacity of 50 Mbps.

```bash
# asconfigurator -x "set_trunk_data;id,108;trunk_name,50Mbps cap;trunk_capacity,50000;trunk_on,true"
```

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

### Install VLC media player

Source: https://www.ibm.com/docs/en/ahts/4.4.x?topic=streaming-testing-video

Installs the vlc-nox package for playing media streams.

```bash
# sudo apt-get install vlc-nox
```

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

### Start Cluster Services

Source: https://www.ibm.com/docs/en/ahts/4.4.x?topic=database-configure-cluster

Commands to start the required Aspera services on primary and replica nodes.

```bash
# systemctl start asperaredisd
               # systemctl start asperaredissentinel
 # systemctl start asperanoded
 # systemctl start asperarund
```

```bash
# systemctl start asperaredisd
 # systemctl start asperaredissentinel
 # systemctl start asperanoded
 # systemctl start asperarund
```

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

### Configure License File

Source: https://www.ibm.com/docs/en/ahts/4.4.x?topic=iu-installing-hsts-2

Create the license file and verify the installation via the command line.

```bash
/opt/aspera/etc/aspera-license
```

```bash
$ ascp -A
```

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

### Verify aspera.conf Configuration

Source: https://www.ibm.com/docs/en/ahts/4.4.x?topic=database-configure-cluster

Example of the server section in /opt/aspera/etc/aspera.conf after configuration.

```xml
<server>
        <db_type>ha_redis</db_type>
        <db_host>10.11.100.160,10.11.52.248,10.11.52.249</db_host>
        <db_port>41415,41415,41415</db_port>
</server>
```

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

### Start asperanginx Service

Source: https://www.ibm.com/docs/en/ahts/4.4.x?topic=api-securing-node-service-behind-reverse-proxy

Start the Nginx service after configuring the nginx.conf file.

```bash
# systemctl start asperanginx
```

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

### Apply Vlink example

Source: https://www.ibm.com/docs/en/ahts/4.4.x?topic=csfcl-controlling-bandwidth-usage-virtual-links-from-command-line-4

Example commands to set Vlink 108 for global outgoing transfers and Vlink 109 for a specific user.

```bash
# asconfigurator -x "set_node_data;transfer_out_bandwidth_aggregate_trunk_id,108"
 # asconfigurator -x "set_user_data;user_name,aspera_user_1;transfer_out_bandwidth_aggregate_trunk_id,109"
```

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

### SSH host key fingerprint configuration example

Source: https://www.ibm.com/docs/en/ahts/4.4.x?topic=iu-installing-configuring-ssh-server-2

Example of the resulting configuration entry for the fingerprint in aspera.conf.

```xml
<ssh_host_key_fingerprint>8e6371caacdfb9d7228680132a7cd72a685320a2</ssh_host_key_fingerprint>
```

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

### Restore process output example

Source: https://www.ibm.com/docs/en/ahts/4.4.x?topic=suhna-backing-up-restoring-node-database-2

Example output indicating a successful data transfer during restoration.

```text
All data transferred. Waiting for the last reply...
Last reply received from server.
errors: 0, replies: number
```

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

### Example upload token request

Source: https://www.ibm.com/docs/en/ahts/4.4.x?topic=aa-transfer-token-creation-node-api-3

A concrete example of an upload token request for a specific user and destination.

```bash
> curl -i -v -X POST -u nodeuser:nodepassword -d '{ "transfer_requests" : [ { "transfer_request" : { "paths" : [{}], "destination_root" : "/" } } ] }";' http://serengeti.com:9091/files/upload_setup
```

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

### Enable a service

Source: https://www.ibm.com/docs/en/ahts/4.4.x?topic=awswf-creating-managing-configuring-services-2

Starts a previously disabled or stopped service.

```bash
# /opt/aspera/bin/asrun send --enable="d109d1bd-7db7-409f-bb16-ca6ff9abb5f4"
[asrun send] code=0
null
```

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

### Configure central_server settings

Source: https://www.ibm.com/docs/en/ahts/4.4.x?topic=csfcl-asperaconf-transfer-server-configuration-2

Example XML structure for the central_server section within aspera.conf.

```xml
<central_server>
  <address>127.0.0.1</address>                                  <!-- Address -->
  <port>40001</port>                                            <!-- Port -->
  <persistent_store>enable</persistent_store>                   <!-- Persistent Storage -->
  <files_per_session>1000</files_per_session>                   <!-- Files Per Session -->
  <persistent_store_path></persistent_store_path>               <!-- Persistent Storage Path -->
  <persistent_store_max_age>86400</persistent_store_max_age>    <!-- Maximum Age -->
  <persistent_store_on_error>ignore</persistent_store_on_error> <!-- Exit Central on Storage Error -->	
  <compact_on_startup>enable</compact_on_startup>               <!-- Compact Database on Startup -->
  <ignore_empty_files>true</ignore_empty_files>                 <!-- Ignore Empty Files -->
  <ignore_no_transfer_files>true</ignore_no_transfer_files>     <!-- Ignore No-transfer Files -->
  <validation_timeout>300</validation_timeout>                  <!-- Post-Transfer Validation Timeout -->
</central_server>
```

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

### Verify HSTS Version

Source: https://www.ibm.com/docs/en/ahts/4.4.x?topic=iu-upgrading-rolling-back-hsts-3

Command to display the currently installed product version.

```bash
# ascp -A 
```

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

### Enable a service

Source: https://www.ibm.com/docs/en/ahts/4.4.x?topic=awswf-creating-managing-configuring-services-3

Starts a previously stopped service without triggering a configuration reload.

```bash
> asrun send --enable="d109d1bd-7db7-409f-bb16-ca6ff9abb5f4"
[asrun send] code=0
null
```

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

### Example aspera.conf Configuration

Source: https://www.ibm.com/docs/en/ahts/4.4.x?topic=csfcl-controlling-bandwidth-usage-virtual-links-from-command-line-2

The resulting XML structure in aspera.conf after defining a Vlink.

```xml
<CONF version="2">
  ...
  <trunks>
    <trunk>
      <id>108</id>                                   <!-- Vlink ID -->
      <name>50Mbps cap</name>                        <!-- Vlink Name -->
      <capacity>
        <schedule format="ranges">50000</schedule>   <!-- Capacity -->
      </capacity>
      <on>true</on>                                  <!-- On -->  
    </trunk>
  </trunks>
</CONF>
```

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

### Configure Entitlement

Source: https://www.ibm.com/docs/en/ahts/4.4.x?topic=upgrades-installing-hsts

Commands to install dependencies, enable ALEE service, and verify connectivity.

```bash
dnf install initscripts chkconfig
```

```bash
# asalee-config.sh enable
# alee-admin register customer_ID entitlement_ID
# systemctl restart asperanoded
```

```bash
# curl -i https://api.ibmaspera.com/metering/ping
```

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

### Manual aspera.conf Logging Configuration

Source: https://www.ibm.com/docs/en/ahts/4.4.x?topic=csfcl-server-logging-configuration-ascp-ascp4-3

Example of the XML structure for logging settings within the aspera.conf file.

```xml
...
<default>
    <file_system>...</file_system>
     <logging>
        <directory>logging_directory</directory>
        <log_size>size_mb</log_size>
        <log_count>count</log_count>
        <level>log_level</level>
    </logging>
</default>
...
```

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

### Install the public key on the server

Source: https://www.ibm.com/docs/en/ahts/4.4.x?topic=suug-setting-up-users-public-key-server-7

Create the .ssh directory and append the client's public key to the authorized_keys file.

```bash
# mkdir /home/aspera_user_1/.ssh
# cat /tmp/id_rsa.pub >> /home/aspera_user_1/.ssh/authorized_keys
```

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

### Install HSTS Package

Source: https://www.ibm.com/docs/en/ahts/4.4.x?topic=upgrades-installing-hsts

Commands to install the HSTS package on supported Linux distributions.

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

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

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

### Service status output example

Source: https://www.ibm.com/docs/en/ahts/4.4.x?topic=folders-creating-managing-configuring-services

Example JSON output returned when listing services.

```json
[asrun send] code=0
{
    "services": [
         {
              "id":"52ca847a-6981-47e1-9f9b-b661cf298af1",
              "configuration": {
                     "enabled":true,
                     "run_as": {
                          "pass": "*****",
                          "user":"root"
                      },
                      "type":"WATCHD"
               },
               "state":"RUNNING",
               "state_changed_at":"2016-10-20T19:14:34Z"
          },
         {
               "id":"d109d1bd-7db7-409f-bb16-ca6ff9abb5f4",
               "configuration": {
                     "enabled":true,
                     "run_as":{
                          "pass": "*****",
                          "user":"root"
                      },
                      "type":"WATCHFOLDERD"
               },
               "state":"RUNNING",
               "state_changed_at":"2016-10-20T00:11:19Z"
           }
     ]
}
```

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

### List all client parameters

Source: https://www.ibm.com/docs/en/ahts/4.4.x?topic=ar-client-configurations-3

Run this command to view a complete list of available client parameters.

```bash
> asuserdata -+
```

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

### Start Aspera Watch and Watch Folders services

Source: https://www.ibm.com/docs/en/ahts/4.4.x?topic=awswf-creating-managing-configuring-services-3

Use these commands to initiate the services under a specified system user.

```bash
> asperawatchd --user username 
 > asperawatchfolderd --user username
```

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

### Install HSTS Package

Source: https://www.ibm.com/docs/en/ahts/4.4.x?topic=iu-installing-hsts-2

Install the HSTS package on RedHat, zLinux, or CentOS using the rpm command.

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

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

### Configure file system settings in aspera.conf

Source: https://www.ibm.com/docs/en/ahts/4.4.x?topic=csfcl-asperaconf-file-system-configuration-3

Example structure for the <file_system> section, defining access paths, thread counts, and file handling behaviors.

```xml
<file_system>
   <access>
      <paths>
         <path>
            <absolute peer_ip="ip_address">/path/$(name)</absolute>
                                                       <!-- Absolute Path (conditional) -->
            <absolute>/path/$(name)</absolute>            <!-- Absolute Path -->            <!-- Growing files handling can also be specified within the <absolute> section; 
                 for detailed informataion, see the following table -->
            <restrictions>
                <restriction></restriction>       <!-- File Restriction 1 -->
                <restriction></restriction>       <!-- File Restriction 2 -->
            </restrictions>
            <read_allowed>true</read_allowed>          <!-- Read Allowed -->
            <write_allowed>true</write_allowed>        <!-- Write Allowed -->
            <dir_allowed>true</dir_allowed>            <!-- Browse Allowed -->
         </path>
      </paths>
   </access>
   <read_block_size>0</read_block_size>                <!-- Read Block Size -->
   <write_block_size>0</write_block_size>              <!-- Write Block Size -->
   <read_threads>0</read_threads>                       <!–- Number of I/O Read Threads -->
   <write_threads>0</write_threads>                     <!–- Number of I/O Write Threads -->
   <scan_threads>0</scan_threads>                       <!-- Number of Dir Scanning Threads -->
   <meta_threads>0</meta_threads>                       <!-- Number of Metadata Threads -->
   <worker_threads>0</worker_threads>
   <sparse_file>false</sparse_file>                     <!-- Sparse File Checking -->
   <fail_on_attr_error>yes</fail_on_attr_error>         <!-- Behavior on Attr Error -->
   <compression_method>lz4</compression_method>         <!-- Compression Method for File Transfer --> 
   <use_file_cache>true</use_file_cache>               <!-- Use File Cache -->
   <max_file_cache_buffer>0</max_file_cache_buffer>    <!-- Max File Cache Buffer-->
   <resume_suffix>.aspx</resume_suffix>                <!-- Resume Suffix -->
   <symbolic_links>follow,create</symbolic_links>      <!-- Symbolic Link Actions -->
   <preserve_attributes> </preserve_attributes>        <!-- Preserve Attributes -->
   <overwrite>allow</overwrite>                        <!-- Overwrite -->
   <file_manifest>disable</file_manifest>              <!-- File Manifest -->
   <file_manifest_path>path</file_manifest_path>        <!-- File Manifest Path -->
   <file_manifest_inprogress_suffix>.aspera-inprogress</file_manifest_inprogress_suffix>
                                                       <!-- File Manifest Suffix -->
   <pre_calculate_job_size>any</pre_calculate_job_size><!-- Pre-Calculate Job Size -->
    <replace_illegal_chars></replace_illegal_chars>     <!-- Convert Restricted Windows™ Characters -->  
   <storage_rc>
      <adaptive>true</adaptive>                        <!-- Storage Rate Control -->
   </storage_rc>
   <filters>                                           <!-– File Filter Pattern List -->
      <filter>rule1</filter>
      <filter>rule2</filter>
   </filters>
   <partial_file_suffix>.partial</partial_file_suffix> <!-- Partial File Suffix --> 
   <file_checksum>any</file_checksum>                  <!-– File Checksum Method -->  
</file_system>
```

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

### Base transfer command for filter examples

Source: https://www.ibm.com/docs/en/ahts/4.4.x?topic=atfcl-using-filters-include-exclude-files-2

The command used as a baseline for the provided filter rule examples.

```bash
# ascp rules aspera@my_demo.example.com:Upload/AAA /tmp/dest
```

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

### Create Access Key via Command Line

Source: https://www.ibm.com/docs/en/ahts/4.4.x?topic=aa-access-key-authentication-4

Example of using curl to create an access key for local storage.

```bash
# curl -ki -u nodeadmin:superP@55wOrD -X POST https://localhost:9092/access_keys -d'{"storage":{"type":"local","path":"/projects/project1"}}
```

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

### Initialize User Keystore

Source: https://www.ibm.com/docs/en/ahts/4.4.x?topic=macos-secrets-management-askmscli

Initializes the keystore for a specific user or the default daemon user.

```bash
$ sudo askmscli -i -u username
```

```bash
$ sudo askmscli -i -u asperadaemon
```

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

### Filter rule: Exclude names starting with wxy

Source: https://www.ibm.com/docs/en/ahts/4.4.x?topic=atfcl-using-filters-include-exclude-files-2

Exclude directories and files whose names start with wxy.

```text
-E 'wxy*'
```

```text
AAA/abc/def
AAA/abc/.def
AAA/abc/.wxy/def
AAA/abc/xyz/def/
< AAA/abc/wxy/def
< AAA/abc/wxy/.def
< AAA/abc/wxy/tuv/def
< AAA/abc/xyz/def/wxy
< AAA/wxyfile
< AAA/wxy/xyx/
< AAA/wxy/xyxfile
```

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

### Register Aspera Entitlement

Source: https://www.ibm.com/docs/en/ahts/4.4.x?topic=iu-installing-hsts-3

Registers the entitlement using the alee-admin utility. Requires that ALEE was installed during the custom installation process.

```bash
> "C:\Program Files\Aspera\Enterprise Server\bin\alee-admin.exe" register Customer_ID Entitlement_ID
```

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

### List asconfigurator Parameters

Source: https://www.ibm.com/docs/en/ahts/4.4.x?topic=csfcl-controlling-bandwidth-usage-virtual-links-from-command-line-2

Display all available parameters for the asconfigurator utility.

```bash
$ /Library/Aspera/bin/asuserdata -+
```

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

### View All HTTP Server Parameters

Source: https://www.ibm.com/docs/en/ahts/4.4.x?topic=ar-http-server-configurations-2

Run this command to display a complete list of available HTTP server configuration parameters.

```bash
# /opt/aspera/bin/asuserdata -+
```

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

### Activate License

Source: https://www.ibm.com/docs/en/ahts/4.4.x?topic=upgrades-installing-hsts

Commands for GUI startup, license file creation, and verification.

```bash
# asperascp
```

```bash
/opt/aspera/etc/aspera-license
```

```bash
$ ascp -A
```

```bash
chmod 644 aspera-license
```

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

### Display ascp4 usage options

Source: https://www.ibm.com/docs/en/ahts/4.4.x?topic=atfcl-ascp4-command-reference-4

Run this command to view the help menu and available options for ascp4.

```bash
ascp4 -h
```

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

### Filter rule: Include wxy at any level

Source: https://www.ibm.com/docs/en/ahts/4.4.x?topic=atfcl-using-filters-include-exclude-files-2

Include directories and files at any level starting with wxy, excluding dot-files and files under wxy unless they start with wxy.

```text
-N '*/wxy*' -E 'AAA/**'
```

```text
AAA/abc/wxy/tuv/
AAA/abc/xyz/def/wxy
AAA/wxyfile 
AAA/wxy/xyx/
< AAA/abc/def
< AAA/abc/.def
< AAA/abc/.wxy/def
< AAA/abc/wxy/def     * 
< AAA/abc/wxy/.def
< AAA/abc/wxy/tuv/def
< AAA/wxy/xyxfile
```

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

### Display asuserdata help

Source: https://www.ibm.com/docs/en/ahts/4.4.x?topic=reference-reading-output

Command to list all available options for the asuserdata utility.

```bash
asuserdata -h
```

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

### Access Key Configuration Output

Source: https://www.ibm.com/docs/en/ahts/4.4.x?topic=aa-access-key-authentication-2

Example JSON output showing the configuration details of a local storage access key.

```json
HTTP/1.1 200 OK
Cache: no-cache
Connection: close
Content-Type: application/json; charset=utf-8

[
{
    "id" : "ak_1234",
    "secret" : "j3489tht42o8y32unifhkfw38ty238h3rih",
    "token_verification_key" : "9mgr3wtl4utmf394ur2ur52jgj934864ginsrh",
    "storage" : {
        "type" : "local",
        "path" : "/"
    },
    "license" : {
        "customer_id" : "customer1",
        "entitlement_id" : "43gsdi459-23r3r-w38ron-23523ro-sr82h3r8h3r"
    },
    "configuration" : {
        "transfer" : {
            "cipher" : "aes-128",
            "policy" : "fair",
            "target_rate_kbps" : 10000,
            "target_rate_cap_kbps" : 20000,
            "content_protection_secret" : "secretsecret",
            "preserve_timestamps" : false,
            "aggressiveness" : 0.00
        },
        "server" : {
            "activity_event_logging" : true,
            "recursive_counts" : true,
            "aej_logging" : true
        }
    }
}
]
```

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

### View asnodeadmin Help

Source: https://www.ibm.com/docs/en/ahts/4.4.x?topic=api-node-admin-tool

Command to display all available options for the asnodeadmin tool.

```bash
asnodeadmin -h
```

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

### GET /access_keys

Source: https://www.ibm.com/docs/en/ahts/4.4.x?topic=aa-access-key-authentication-4

Retrieves the ID and configuration of all access keys.

```APIDOC
## GET /access_keys

### Description
Retrieves the ID and configuration of all access keys.

### Method
GET

### Endpoint
https://localhost:9092/access_keys

### Response
#### Success Response (200)
- **id** (string) - The access key ID.
- **secret** (string) - The access key secret.
- **token_verification_key** (string) - The token verification key.
- **storage** (object) - Storage configuration details.
- **license** (object) - License information.
- **configuration** (object) - Transfer and server configuration settings.
```

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

### Exclude Dot-files and Dot-directories

Source: https://www.ibm.com/docs/en/ahts/4.4.x?topic=chig-configuring-filters-include-exclude-files-1

Transfer all files except those starting with a dot.

```text
+ * 
- AAA/**
```

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

### Initialize user keystore

Source: https://www.ibm.com/docs/en/ahts/4.4.x?topic=macos-secrets-management-askmscli

Initializes the keystore for a specific transfer user.

```bash
$ sudo askmscli -i -u username
```

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

### Start ascp4 transport

Source: https://www.ibm.com/docs/en/ahts/4.4.x?topic=streaming-testing-video

Initiates the ascp4 stream transport from the sender computer to the receiver.

```bash
# ascp4 --mode=send --user=computerB_user -i ~/.ssh/id_rsa --host=computerB  --compression=none --read-threads=1 --write-threads=1 udp://233.3.3.3:3000?loopback=1&ttl=2 udp://233.4.4.4:4000?loopback=1&ttl=2
```

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

### Filter rule: Exclude dot-files and directories

Source: https://www.ibm.com/docs/en/ahts/4.4.x?topic=atfcl-using-filters-include-exclude-files-2

Exclude all files and directories starting with a dot.

```text
-N '*' -E 'AAA/**'
```

```text
AAA/abc/def
AAA/abc/wxy/def
AAA/abc/wxy/tuv/def
AAA/abc/xyz/def/wxy
AAA/wxyfile
AAA/wxy/xyx/
AAA/wxy/xyxfile
< AAA/abc/.def
< AAA/abc/.wxy/def
< AAA/abc/wxy/.def
```

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

### Configure certificate chain file format

Source: https://www.ibm.com/docs/en/ahts/4.4.x?topic=suhna-installing-ssl-certificates-2

Example structure for the aspera_server_cert.chain file containing the server, intermediate, and root certificates.

```text
-----BEGIN CERTIFICATE----
 (Your Primary SSL certificate: your_server_certificate.crt)
 -----END CERTIFICATE------
    -----BEGIN CERTIFICATE----
    (Intermediate certificate #1)
    -----END CERTIFICATE------
    -----BEGIN CERTIFICATE----
    (Intermediate certificate #2)
    -----END CERTIFICATE------
    -----BEGIN CERTIFICATE----
    (Intermediate certificate #3)
    -----END CERTIFICATE------
-----BEGIN CERTIFICATE----
 (Root certificate)
-----END CERTIFICATE------
```

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

### Transfer Content with ascp

Source: https://www.ibm.com/docs/en/ahts/4.4.x?topic=aa-basic-tokens-4

Syntax and example for uploading files using the ascp utility.

```bash
# ascp -i path/to/private_key_file -d source_path username@hostname:destination_path
```

```bash
# ascp  -i /opt/aspera/var/aspera_tokenauth_id_rsa -d testfile03 xfer@10.0.3.4/tmp
```

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

### Verify Access Keys

Source: https://www.ibm.com/docs/en/ahts/4.4.x?topic=aa-access-key-authentication-4

Command to list existing access keys and an example of the expected JSON response.

```bash
# curl -ki -u node_username:node_password -X GET https://localhost:9092/access_keys
```

```json
HTTP/1.1 200 OK
Cache: no-cache
Connection: close
Content-Type: application/json; charset=utf-8

[
{
    "id" : "ak_1234",
    "secret" : "j3489tht42o8y32unifhkfw38ty238h3rih",
    "token_verification_key" : "9mgr3wtl4utmf394ur2ur52jgj934864ginsrh",
    "storage" : {
        "type" : "local",
        "path" : "/"
    },
    "license" : {
        "customer_id" : "customer1",
        "entitlement_id" : "43gsdi459-23r3r-w38ron-23523ro-sr82h3r8h3r"
    },
    "configuration" : {
        "transfer" : {
            "cipher" : "aes-128",
            "policy" : "fair",
            "target_rate_kbps" : 10000,
            "target_rate_cap_kbps" : 20000,
            "content_protection_secret" : "secretsecret",
            "preserve_timestamps" : false,
            "aggressiveness" : "0.00",
        },
        "server" : {
            "activity_event_logging" : true,
            "recursive_counts" : true,
            "aej_logging" : true
        }
    }
}
]
```

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

### Basic token output example

Source: https://www.ibm.com/docs/en/ahts/4.4.x?topic=aa-basic-tokens-1

The resulting base64 encoded string used for authentication.

```text
ZGlEZXVGTGNwRzlJWWRzdnhqMFNDcTRtT29oTkpUS3ZwNVEyblJXakRnSUE6YXNwZXJh
```

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

### File list format for download tokens

Source: https://www.ibm.com/docs/en/ahts/4.4.x?topic=aa-transfer-token-generation-astokengen-1

Example content for a file specified by the --file-list option, containing a list of source paths.

```text
/monday/first_thing.txt
/monday/next_thing.txt  
/monday/last_thing.txt
```
Tokens:
Raw