### Example of starting a Watch Folder Source: https://www.ibm.com/docs/en/ahte/4.4.x/index_topic=wffcl-creating-pull-watch-folder-api An example demonstrating how to start a Watch Folder with specific user credentials, a configuration file path, and a sample host and port. The response includes the unique ID of the created Watch Folder. ```bash > curl -k --user watchfolder_admin:XF324cd28 -H "X-aspera-WF-version:2017_10_23" -X POST -d @/watchfolder_conf.json https://198.51.100.22:9092/v3/watchfolders { "id": "b394d0ee-1cda-4f0d-b785-efdc6496c585" } ``` -------------------------------- ### Ascp General Examples for File Transfers Source: https://www.ibm.com/docs/en/ahte/4.4.x/index_topic=atfcl-ascp-general-examples-2 This section provides practical examples of the `ascp` command for various file transfer operations. These examples demonstrate how to initiate transfers, specify source and destination, and utilize common options. No external dependencies are required beyond the `ascp` utility itself, which is part of the IBM Aspera HSTE installation. ```bash # Basic transfer from local to remote ascp @: # Basic transfer from remote to local ascp @: # Transfer a directory recursively ascp -r @: # Transfer with a specific SSH port ascp -P @: # Transfer with a specific private key ascp -i @: # Preserve file permissions ascp -p @: # Use a specific cipher ascp -c @: # Use a specific pre-transfer command ascp --pre-cmd "" @: # Use a specific post-transfer command ascp --post-cmd "" @: # Transfer multiple files ascp @: # Transfer files matching a pattern ascp "*.txt" @: # Resume interrupted transfers ascp --resume @: # Set transfer rate limit (e.g., 100 Mbps) ascp --rate @: # Set bandwidth limit (e.g., 100 MB/s) ascp --bwlimit @: # Use a specific configuration file ascp -C @: # List files on remote server without transferring ascp -l @: # Delete source file after successful transfer ascp --remove-source-files @: # Transfer with overwrite option ascp --overwrite @: # Transfer with skip existing option ascp --skip-existing @: # Transfer from standard input cat | ascp - @: # Transfer to standard output ascp @: - ``` -------------------------------- ### Sample Policies Source: https://www.ibm.com/docs/en/ahte/4.4.x/index_topic=folders-configuring-custom-watch-folder-permissions-policies Examples of common policy configurations. ```APIDOC ## Sample Policies **Policy to view policies and user permissions:** ```json { "id": "read-permissions", "statements": [ { "effect": "ALLOW", "actions": [ "PERM_LIST_*" ], "resources": [] } ] } ``` **Policy for all Watch Folders actions:** ```json { "id": "all-watch-folders", "statements": [ { "effect": "ALLOW", "actions": [ "WF_*", "PERM_LIST_RESOURCES" ], "resources": [ "arn:watchfolder:wfd:*" ] } ] } ``` ``` -------------------------------- ### Get All Configurations with asuserdata Source: https://www.ibm.com/docs/en/ahte/4.4.x/index_topic=ar-examples-1 This command retrieves all available configurations or sample commands, particularly useful for exploring nearly all settings. It acts as a comprehensive information retrieval tool for the Aspera system. ```bash /Library/Aspera/bin/asuserdata -+ ``` -------------------------------- ### Start Aspera Watchd Daemon Source: https://www.ibm.com/docs/en/ahte/4.4.x/index_topic=sync-aspera-watch-service-session-examples This command initiates the `asperawatchd` daemon, which monitors specified directories for changes. It requires a username for authentication. ```bash # /opt/aspera/bin/asperawatchd --user username ``` -------------------------------- ### Manually Start Aspera Watcher Services After Upgrade Source: https://www.ibm.com/docs/en/ahte/4.4.x/index_topic=iu-installing-hste-3 Manually starts the 'asperawatchd' or 'asperawatchfolderd' services after an upgrade. This is necessary for non-root users as the installer does not migrate these services automatically. ```bash sudo systemctl start asperawatchd sudo systemctl start asperawatchfolderd ``` -------------------------------- ### Download Growing File with Wait Period using ASCP Source: https://www.ibm.com/docs/en/ahte/4.4.x/index_topic=atfcl-ascp-general-examples-2 Demonstrates how to download a file that is still being written to the source directory. It specifies a wait period for the transfer to start and a null read for calculating wait time. ```bash ascp --mode=recv --user=root --host=10.0.0.2 "file:////tmp/myfile?grow=120&wait_start=null_read" file:////tmp2/mylocalfile ``` -------------------------------- ### Start asperaredisd Service (Shell) Source: https://www.ibm.com/docs/en/ahte/4.4.x/index_topic=sync-aspera-watch-service-session-examples This command starts the asperaredisd service, specifying the path to the modified Redis configuration file. This ensures Redis is running with the new settings. ```shell # /opt/aspera/sbin/asperaredisd /filepath/redis_configuration.conf. ``` -------------------------------- ### Async push session with Aspera Watch Service Source: https://www.ibm.com/docs/en/ahte/4.4.x/index_topic=sync-aspera-watch-service-session-examples This example demonstrates how to configure and start asperawatchd on the local host to push files. The 'async' command with the '--watchd' option specifies the datastore, host, and port for asperawatchd, along with the watch name, local destination, and remote destination. ```shell async --watchd redis:localhost:31415:root -N watch_push -d /data/D1 -r adminuser@10.0.0.1:/data/R1 ``` -------------------------------- ### Verify Certificate Connection (OpenSSL) Source: https://www.ibm.com/docs/en/ahte/4.4.x/index_topic=suhna-installing-ssl-certificates-1 Tests the connection to the Aspera node service using OpenSSL to verify the installed certificate. It connects to the specified server and port, and the output indicates success (verify return:0) or failure (verify return:1) along with potential error messages. ```shell /Library/Aspera/bin/openssl s_client -connect myserver:9092 ``` -------------------------------- ### IBM Aspera HSTE Admin Guides Source: https://www.ibm.com/docs/en/ahte/4.4.x/index_topic=logging- This section details the administrative guides for the IBM Aspera High-Speed Transfer Endpoint (HSTE) across different operating systems, covering installation, configuration, and management. ```APIDOC ## IBM Aspera HSTE Admin Guides ### Description Provides administrative guides for setting up and managing the IBM Aspera High-Speed Transfer Endpoint (HSTE) on various platforms. ### Supported Platforms - Linux - Windows - MacOS - PowerLinux - zLinux - AIX ### Key Topics Covered - Introduction to HSTE - Installation and upgrades - Server setup and configuration (GUI and command line) - User and group management - Secrets management with askmscli - Transferring files (GUI, ascp, ascp4) - Automated execution of Lua scripts - Aspera Watch Service and Watch Folders - Aspera Sync (setup, running, monitoring, troubleshooting) - Setting up HSTE for Node API - Authentication and authorization - Asconfigurator reference - Troubleshooting - Appendix ``` -------------------------------- ### ASCP Configuration for Growing Files Source: https://www.ibm.com/docs/en/ahte/4.4.x/index_topic=atfcl-ascp-general-examples-2 Shows the necessary configuration in the ascp.conf file to enable the growing files feature. This includes defining access paths with grow and wait_start parameters. ```xml file:////tmp?grow=120;wait_start=null_read ``` -------------------------------- ### Create and Start Watch Folders Services Source: https://www.ibm.com/docs/en/ahte/4.4.x/index_topic=folders-creating-push-watch-folder-aswatchfolderadmin Commands to create a Watch Service and a Watch Folder service for a user on a local computer. These are essential first steps for setting up Watch Folders functionality. ```shell # /opt/aspera/sbin/asperawatchd --user username # /opt/aspera/sbin/asperawatchfolderd --user username ``` -------------------------------- ### Copy Certificate File (Shell) Source: https://www.ibm.com/docs/en/ahte/4.4.x/index_topic=suhna-installing-ssl-certificates-1 Creates a backup of the existing Aspera server certificate file before replacement. This is a safety measure to ensure the original file can be restored if needed. It uses the `cp` command for copying. ```shell cp aspera_server_cert.pem aspera_server_cert.pem.bak ``` -------------------------------- ### Restart Aspera Services (Shell) Source: https://www.ibm.com/docs/en/ahte/4.4.x/index_topic=suhna-installing-ssl-certificates-1 Restarts essential Aspera services after certificate updates. It uses `launchctl` to unload and then load the plist files for `asperacentral`, `asperahttpd`, and `asperanoded`. This ensures the new certificates are recognized and active. ```shell sudo launchctl unload /Library/LaunchDaemons/com.aspera.asperacentral.plist sudo launchctl load /Library/LaunchDaemons/com.aspera.asperacentral.plist sudo launchctl unload /Library/LaunchDaemons/com.aspera.asperahttpd.plist sudo launchctl load /Library/LaunchDaemons/com.aspera.asperahttpd.plist sudo launchctl unload /Library/LaunchDaemons/com.aspera.asperanoded.plist sudo launchctl load /Library/LaunchDaemons/com.aspera.asperanoded.plist ``` -------------------------------- ### Start Aspera Sync Utility Source: https://www.ibm.com/docs/en/ahte/4.4.x/index_topic=ra-composing-sync-session-1 This command initiates the Aspera Sync utility. It is the first step in configuring a sync session and requires no specific arguments to start. ```bash $ async ``` -------------------------------- ### Create Working Directory with Command Prompt Source: https://www.ibm.com/docs/en/ahte/4.4.x/index_topic=suhna-setting-up-ssl-your-nodes These commands create a new working directory named 'ssl' on the C drive and navigate into it. This is the initial setup step for generating SSL certificates. ```command-line > cd c:\ > mkdir ssl > cd c:\ssl ``` -------------------------------- ### Bidirectional Async Sync Command Example Source: https://www.ibm.com/docs/en/ahte/4.4.x/index_topic=ssu-sync-database This example demonstrates the command-line arguments for initiating a bidirectional Aspera Sync session. It specifies the session name, local and remote database directories, local and remote data directories, and the transfer mode. The output shows the resulting database and transfer cache locations on both the client and server. ```bash > -N ex1 -b c:/db -B d:/aspera/var -d c:/data/users -r admin@server:d:/storage/users -K bidi ``` -------------------------------- ### Get Help for aswatchadmin subscribe Source: https://www.ibm.com/docs/en/ahte/4.4.x/index_topic=uawss-starting-aspera-watch-services-creating-watches-1 This command displays the help information for the 'aswatchadmin subscribe' utility, detailing all available options and their usage for creating and configuring watch subscriptions. ```bash $ /Library/Aspera/bin/aswatchadmin subscribe -h ``` -------------------------------- ### Example Mock Directory Transfer with ascp Source: https://www.ibm.com/docs/en/ahte/4.4.x/index_topic=a-testing-optimizing-transfer-performance Example of transferring a mock directory named 'mydir' containing 1 million files to '/tmp' on a remote host. Files are named 'testfile', start with 0 size, increase sequentially, and have a 2-byte increment. ```bash > ascp --mode=send --user=username --host=10.0.0.2 faux:///mydir?file=testfile&count=1m&size=0&inc=2&seq=sequential /tmp ``` -------------------------------- ### Start Aspera Watchd Service Source: https://www.ibm.com/docs/en/ahte/4.4.x/index_topic=uawss-sync-aspera-watch-service-session-examples-2 This command starts the `asperawatchd` service, which monitors a specified directory for changes. It requires the username under which the service will run. This is a prerequisite for initiating Aspera Sync sessions involving watched folders. ```bash asperawatchd --user username ``` -------------------------------- ### Create and Enable Vlink using asconfigurator Source: https://www.ibm.com/docs/en/ahte/4.4.x/index_topic=ar-examples Creates a new Vlink with a specified ID and capacity, and enables it for use. This involves using `asconfigurator` with the `set_trunk_data` action and providing the ID, enable status, and capacity. ```bash > asconfigurator -x "set_trunk_data;id,101;trunk_on,true;trunk_capacity,100000" ``` -------------------------------- ### Multi-Session Transfer Example without File Splitting Source: https://www.ibm.com/docs/en/ahte/4.4.x/index_topic=atfcl-multi-session-transfers-2 This example demonstrates a multi-session transfer setup for a dual-core system, utilizing different UDP ports for each session to achieve higher throughput. No multi-session threshold is set, meaning files will not be split. ```bash # ascp -C 1:2 -O 33001 -l 1000m /dir01 10.0.0.2:/remote_dir # ascp -C 2:2 -O 33002 -l 1000m /dir01 10.0.0.2:/remote_dir ``` -------------------------------- ### Start Watch Folder using cURL Source: https://www.ibm.com/docs/en/ahte/4.4.x/index_topic=wffcl-creating-push-watch-folder-api This snippet demonstrates how to start a Watch Folder by sending a POST request to the Aspera API. It requires user credentials, a specific API version header, and the path to a JSON configuration file. The output is a JSON object containing the Watch Folder's ID. ```shell > curl -k --user node_api_user:node_api_password -H "X-aspera-WF-version:2017_10_23" -X POST -d @path/to/json_file https://host:node_api_port/v3/watchfolders { "id": "b394d0ee-1cda-4f0d-b785-efdc6496c585" } ``` -------------------------------- ### Start Aspera Watch Services Source: https://www.ibm.com/docs/en/ahte/4.4.x/index_topic=awswf-creating-managing-configuring-services-1 These commands are used to start the asperawatchd and asperawatchfolderd services. They require specifying a username under which the service will run. Ensure the specified user has the necessary docroot and write permissions. ```bash $ asperawatchdasperawatchd --user username $ asperawatchdasperawatchfolderd --user username ``` -------------------------------- ### Create and Configure a Vlink using asconfigurator Source: https://www.ibm.com/docs/en/ahte/4.4.x/index_topic=csfcl-controlling-bandwidth-usage-virtual-links-from-command-line-4 This command creates or modifies a Vlink with specified parameters such as ID, name, capacity, and activation status. The capacity is defined in Kbps and the `trunk_on` parameter activates the Vlink. This is a fundamental step in setting up bandwidth caps. ```bash # asconfigurator -x "set_trunk_data;id,vlink_id;trunk_capacity,bandwidth;trunk_on,true" # asconfigurator -x "set_trunk_data;id,108;trunk_name,50Mbps cap;trunk_capacity,50000;trunk_on,true" ``` -------------------------------- ### GET /access_control/policies/policy_id Source: https://www.ibm.com/docs/en/ahte/4.4.x/index_topic=folders-configuring-custom-watch-folder-permissions-policies Retrieves the configuration of an existing access control policy. ```APIDOC ## GET /access_control/policies/policy_id ### Description Retrieves the configuration of an existing access control policy. ### Method GET ### Endpoint /access_control/policies/policy_id ### Parameters #### Path Parameters - **policy_id** (string) - Required - The unique identifier of the policy to retrieve. ### Request Example ```bash curl -k --user node_api_user:node_api_password -X GET https://localhost:9092/access_control/policies/policy_id ``` ### Response #### Success Response (200) - **policy_configuration** (object) - The configuration of the policy. - **id** (string) - The unique identifier of the policy. - **name** (string) - The name of the policy. - **permissions** (array) - A list of permissions associated with the policy. - **resource** (string) - The resource the permission applies to. - **action** (string) - The action allowed on the resource. #### Response Example ```json { "policy_configuration": { "id": "policy_id", "name": "Example Policy", "permissions": [ { "resource": "/data", "action": "read" } ] } } ``` ``` -------------------------------- ### Uni-directional Push Async Sync Command Example Source: https://www.ibm.com/docs/en/ahte/4.4.x/index_topic=ssu-sync-database This example illustrates the command-line syntax for a uni-directional Aspera Sync session in 'push' mode. It defines the session name, local and remote database directories, local and remote data directories, and the transfer mode. The output details the created database and transfer cache paths on the client and server. ```bash > -N ex2 -b c:/db -B d:/aspera/var -d c:/data/users -r admin@server:d:/storage/users -K push ``` -------------------------------- ### Aspera Configuration with Peer IP Fitness Rule Example Source: https://www.ibm.com/docs/en/ahte/4.4.x/index_topic=ar-syntax-usage-1 An example of an Aspera configuration XML snippet demonstrating a fitness rule. The 'value' parameter is set to 'allow' only if the peer IP address matches '192.168.15.81'. ```xml allow ``` -------------------------------- ### Manual aspera.conf Vlink Configuration Example Source: https://www.ibm.com/docs/en/ahte/4.4.x/index_topic=csfcl-controlling-bandwidth-usage-virtual-links-from-command-line-1 This XML snippet demonstrates how a Vlink is represented within the `aspera.conf` file, showing the structure for ID, name, capacity, and activation status. The capacity can be scheduled using a `` tag. ```xml ... 108 50Mbps cap 50000 true ``` -------------------------------- ### Aspera Sync Push Session Example using Watch Service Source: https://www.ibm.com/docs/en/ahte/4.4.x/index_topic=uawss-sync-aspera-watch-service-session-examples This example demonstrates how to configure and start the Aspera Watch service on the local host to push files. It utilizes the 'async' command with the '--watchd' option to specify the watch service details and defines source and destination directories. ```bash async --watchd redis:localhost:31415:svcaspera -N watch_push -d C:\data\D1 -r adminuser@10.0.0.1:d:\data\R1 ``` -------------------------------- ### Aspera File Upload Example Source: https://www.ibm.com/docs/en/ahte/4.4.x/index_topic=atfcl-using-filters-include-exclude-files Demonstrates how to upload a local directory to an Aspera server using the `ascp` command. This is a basic example showing the source path and destination. ```bash > ascp C:\tmp\src my_user_name@my_demo.example.com:Upload/ ``` -------------------------------- ### GET /access_control/policies/policy_id/users Source: https://www.ibm.com/docs/en/ahte/4.4.x/index_topic=folders-configuring-custom-watch-folder-permissions-policies Retrieves a list of users associated with a specific access control policy. ```APIDOC ## GET /access_control/policies/policy_id/users ### Description Retrieves a list of users associated with a specific access control policy. ### Method GET ### Endpoint /access_control/policies/policy_id/users ### Parameters #### Path Parameters - **policy_id** (string) - Required - The unique identifier of the policy. ### Request Example ```bash curl -k --user node_api_user:node_api_password -X GET https://localhost:9092/access_control/policies/policy_id/users ``` ### Response #### Success Response (200) - **users** (array) - A list of users associated with the policy. - **user_id** (string) - The identifier of the user. - **username** (string) - The name of the user. #### Response Example ```json { "users": [ { "user_id": "user123", "username": "john.doe" } ] } ``` ``` -------------------------------- ### Create and Enable Vlink (asconfigurator) Source: https://www.ibm.com/docs/en/ahte/4.4.x/index_topic=ar-examples-1 Creates a Virtual Link (Vlink) with a specified ID and capacity, and enables it. Vlinks are used for optimizing transfer paths. This command requires the Vlink ID, whether to turn it on, and its capacity in bits per second. ```bash asconfigurator -x "set_trunk_data;id,101;trunk_on,true;trunk_capacity,100000" ``` -------------------------------- ### Aspera CLI: Include Hidden Directories and Specific Files Source: https://www.ibm.com/docs/en/ahte/4.4.x/index_topic=async-filtering-patterns-examples This example expands on including specific directories by also including directories that start with a period (hidden directories) at any level. It adds `--include='.*/'` to the previous example, alongside the existing includes for 'Raw' and 'Jpg', and continues to exclude all other files and hidden files. ```bash # async ... --include='.*/' --include='/Raw/**' --include='/Jpg/**' \ --exclude='*' --exclude='.*' ... ``` -------------------------------- ### Start Aspera Redis Service Source: https://www.ibm.com/docs/en/ahte/4.4.x/index_topic=uawss-sync-aspera-watch-service-session-examples-1 This command starts the asperaredisd service, which manages the Redis database for Aspera. It requires the path to the configuration file as an argument. Ensure the configuration file is correctly set up before running this command. ```shell /opt/aspera/sbin/asperaredisd /filepath/redis_configuration.conf. ``` -------------------------------- ### Bidirectional Sync Command Example (Aspera Async) Source: https://www.ibm.com/docs/en/ahte/4.4.x/index_topic=async-bidirectional-example This command sets up a bidirectional synchronization session between a local and a remote directory. It specifies the pair name, local and remote paths, authentication, transfer rate, policy, block sizes, and enables continuous and bidirectional transfer modes. Path separator considerations for different operating systems are important. ```bash $ async -N asyncTwoWay -d /fio/S -r admin@192.168.200.218:d:/mnt/fio/S -w v00d00 -l 100M -a fair -g 1M -G 1M -C -K BIDI ``` -------------------------------- ### Example of Renamed Files After Synchronization Source: https://www.ibm.com/docs/en/ahte/4.4.x/index_topic=ts-resolving-bidirectional-sync-file-conflicts This example demonstrates the file structure after renaming a conflicted file (Document2 to Document2_computerA) on one computer (A) and then running an asynchronous synchronization session. Both endpoints will have the original and the renamed version of the file, enabling later comparison and resolution. ```shell async -N my_bidi_sync -d /my_documents -r colleague@B:/home/my_documents -w pass -K bidi / SYNCHRONIZED /Document1 SYNCHRONIZED /Document2 SYNCHRONIZED /Document2_computerA SYNCHRONIZED /Document3 SYNCHRONIZED ``` -------------------------------- ### ascp Transfer Random Data (No Source Storage) Source: https://www.ibm.com/docs/en/ahte/4.4.x/index_topic=atfcl-ascp-general-examples-2 This example shows how to transfer a specified amount of random data using 'ascp' without requiring source storage. It uses the faux:// protocol with a size specifier and designates the destination directory. ```bash #ascp --mode=send --user=root --host=10.0.0.2 faux:///newfile?20g /remote-dir ``` -------------------------------- ### Initialize User Keystore (Aspera) Source: https://www.ibm.com/docs/en/ahte/4.4.x/index_topic=windows-secrets-management-askmscli This command initializes the keystore for a specific transfer user, which is necessary when using dynamic token encryption keys. It ensures that each user's cryptographic material is properly set up. ```bash > askmscli.exe -u username -i -L- -DD ``` -------------------------------- ### Aspera Sync Pull Session Example using Watch Service Source: https://www.ibm.com/docs/en/ahte/4.4.x/index_topic=uawss-sync-aspera-watch-service-session-examples This example illustrates how to configure and start the Aspera Watch service on the remote host to pull files. It uses the 'async' command with the '-K pull' option to initiate a pull session, relying on the remote host's aspera.conf file to determine Watch service usage. ```bash async -N watch_pull -d C:\data\D1 -r adminuser@10.0.0.1:d:\data\R11 -K pull ``` -------------------------------- ### Sample Policies Source: https://www.ibm.com/docs/en/ahte/4.4.x/index_topic=wffcl-configuring-custom-watch-folder-permissions-policies Provides example JSON configurations for common policy use cases. ```APIDOC ## Sample Policies ### Policy to View Permissions Allows a user to view policies and user permissions. ```json { "id": "read-permissions", "statements": [ { "effect": "ALLOW", "actions": [ "PERM_LIST_*" ], "resources": [] } ] } ``` ### Policy for All Watch Folder Actions Allows a user to perform all actions on all Watch Folders managed by any daemon. ```json { "id": "all-watch-folders", "statements": [ { "effect": "ALLOW", "actions": [ "WF_*", "PERM_LIST_RESOURCES" ], "resources": [ "arn:watchfolder:wfd:*" ] } ] } ``` ``` -------------------------------- ### Initiate Aspera Sync Session with Watchd Source: https://www.ibm.com/docs/en/ahte/4.4.x/index_topic=uawss-sync-aspera-watch-service-session-examples Example command to start an Aspera Sync session. It specifies the Watchd service for monitoring a remote Redis instance, a local directory, a remote target directory, and the transfer mode. ```bash async --watchd redis:10.54.44.194:31415 -N watch_remote -d C:\data\D1 -r adminuser@10.0.0.1:d:\data\R11 -K BIDI ``` -------------------------------- ### Basic ascp Command with Proxy Source: https://www.ibm.com/docs/en/ahte/4.4.x/index_topic=line-ascp-general-examples This example demonstrates the basic syntax for using the 'ascp' command with a proxy server. It specifies the proxy address and credentials, followed by the source and destination paths. Ensure the proxy details and paths are correctly configured for your environment. ```bash # ascp --proxy dnats://aspera_proxy:pa33w0rd@10.0.0.7 /data/file1 Pat@10.0.0.2:/Pat_data/ ``` -------------------------------- ### Aspera CLI Watch Daemon Configuration Example Source: https://www.ibm.com/docs/en/ahte/4.4.x/index_topic=async-command-reference Provides an example of how to configure the Aspera CLI to use a watch daemon connected to Redis. This option allows for specified datastore, host, and port, with an optional domain for specific configurations. Ensure the specified datastore is correct. ```bash --watchd=redis:localhost:31415 ``` -------------------------------- ### Start Aspera Application Command Source: https://www.ibm.com/docs/en/ahte/4.4.x/index_topic=upgrades-testing-locally-initiated-transfer This command initiates the Aspera Connect application from the terminal. It is the first step in using the application for file transfers. ```bash $ asperascp ``` -------------------------------- ### asrun send - Enable Service Source: https://www.ibm.com/docs/en/ahte/4.4.x/index_topic=awswf-creating-managing-configuring-services-1 Enables a specified service by its ID, starting it again without altering its saved configuration. ```APIDOC ## POST /asrun/send ### Description Enable a specific service by its ID. This restarts a previously disabled service without reloading its configuration. ### Method POST (simulated via command-line utility) ### Endpoint `$asrun send --enable "[service_id]"` ### Parameters #### Query Parameters - `--enable` (string) - Required - The ID of the service to enable. ### Request Example ```bash $ $asrun send --enable="d109d1bd-7db7-409f-bb16-ca6ff9abb5f4" ``` ### Response #### Success Response (200) - **null** (null) - Indicates the operation was successful. #### Response Example ```json null ``` ``` -------------------------------- ### ascp Transfer Random Data (No Source or Destination Storage) Source: https://www.ibm.com/docs/en/ahte/4.4.x/index_topic=atfcl-ascp-general-examples-2 This example demonstrates transferring a specified amount of random data using 'ascp' without needing either source or destination storage. It utilizes the faux:// protocol for both generating random data and as a placeholder for the destination. ```bash #ascp --mode=send --user=root --host=10.0.0.2 faux:///dummy?10m faux:// ``` -------------------------------- ### Aspera Sync Configuration Example Source: https://www.ibm.com/docs/en/ahte/4.4.x/index_topic=ssu-configuring-sync-endpoints-1 An example of synchronous file transfer configuration within the `aspera.conf` file. It includes settings for directory creation mode and permissions, ACL and extended attribute preservation, and default asynchronous transfer settings. ```xml ... 755 none none ... ... ... true 20 20 AS_NULL log ... ``` -------------------------------- ### Include Dot Directories and Raw/Jpg Directories Source: https://www.ibm.com/docs/en/ahte/4.4.x/index_topic=ra-filtering-patterns-examples This example extends the previous one by also including directories that start with a dot ('.') at any level, in addition to the 'Raw' and 'Jpg' directories. It still excludes all other files and dot files. ```bash > async ... --include='.*/' --include='/Raw/**' --include='/Jpg/**' \ --exclude='*' --exclude='.*' ... ``` -------------------------------- ### Start Aspera Watch Service and Watch Folder Daemon Source: https://www.ibm.com/docs/en/ahte/4.4.x/index_topic=wffcl-creating-push-watch-folder-aswatchfolderadmin Commands to initiate the Aspera Watch Service and the Watch Folder service for a specified user. These are fundamental for enabling watch folder functionality. ```bash > /opt/aspera/sbin/asperawatchd --user username > /opt/aspera/sbin/asperawatchfolderd --user username ``` -------------------------------- ### Activate Aspera Perpetual License Source: https://www.ibm.com/docs/en/ahte/4.4.x/index_topic=iu-installing-hste-3 Activates a perpetual license for Aspera. This involves creating a license file with the provided license key string and verifying the installation. ```bash /opt/aspera/etc/aspera-license ``` ```bash #ascp -A ``` -------------------------------- ### View Certificate Chain Source: https://www.ibm.com/docs/en/ahte/4.4.x/index_topic=suhna-installing-ssl-certificates-1 This snippet displays the certificate chain, showing the issuer (i:) and subject (s:) details. It is used to identify if only the root certificate is present, indicating a verification failure. ```text Certificate chain 0 s:/C=US/ST=California/L=Emeryville/O=IBM/OU=Aspera Inc IT Department/CN=*.asperafiles.com i:/C=US/O=Symantec Corporation/OU=Symantec Trust Network/CN=Symantec Class 3 Secure Server CA - G4 ``` -------------------------------- ### Enable HTTPS and Set Port using asconfigurator Source: https://www.ibm.com/docs/en/ahte/4.4.x/index_topic=ar-examples Enables HTTPS for the Aspera server and sets the specific port for HTTPS connections. These commands utilize `asconfigurator` and can be chained together for efficiency. ```bash > asconfigurator -x "set_http_server_data;enable_https,true" > asconfigurator -x "set_http_server_data;https_port,8444" ``` ```bash > asconfigurator -x "set_http_server_data;enable_https,true;https_port,8444" ``` -------------------------------- ### Create SSH Directory and Navigate Source: https://www.ibm.com/docs/en/ahte/4.4.x/index_topic=as-creating-ssh-keys-from-command-line These commands create the necessary .ssh directory in the user's home directory and then navigate into it. This is the first step in setting up SSH key-based authentication. ```shell > md user_home_dir\.ssh > cd user_home_dir\.ssh ``` -------------------------------- ### Get All User Data for a Group (asuserdata) Source: https://www.ibm.com/docs/en/ahte/4.4.x/index_topic=ar-examples-1 Retrieves all configuration data for a specified group. This command is useful for auditing or understanding the settings applied to a particular group. It requires the group name as an argument. ```bash /Library/Aspera/bin/asuserdata -g aspera_group ``` -------------------------------- ### Include Specific Patterns Source: https://www.ibm.com/docs/en/ahte/4.4.x/index_topic=ra-async-command-reference Specifies patterns for files or directories to be included in the synchronization process. This option allows for precise control over what gets synchronized. ```bash --include="pattern" ```