IBM Aspera Sync delivers high-speed, multi-directional, file-based synchronization and replication at scale. With HSTS support, you can set up sync jobs and conveniently monitor their activity through the Console. Here’s how to configure and monitor your async jobs step by step.
1. Enable Monitoring on the Client
Run the following on your client machine to let the Console display sync activity:
asconfigurator -x "set_client_data;async_management_activity_logging,true"
asconfigurator -x "set_client_data;async_kvstore_activity_logging,true"
systemctl restart asperanoded
The key parameter is async_kvstore_activity_logging=true
in aspera.conf
. Once set, your sync jobs appear under Activity > Sync Jobs in the Console, where you can click a job for session details.
2. Enable Monitoring on the Server (Optional)
To monitor from the server side instead, run:
asconfigurator -x "set_node_data;async_activity_logging,true"
systemctl restart asperanoded
💡 Tip: Enable monitoring either on the client or the server—turning it on for both creates duplicate job entries in the Console.
3. Obtain a Transfer Token (If Required)
If your servers use transfer tokens for authentication, you’ll need to fetch one from the remote machine using the /files/sync_setup
API.
Sample curl command:
curl -kiu node_api_username:node_api_password \
https://ip_or_hostname:9092/files/sync_setup \
-d '{"transfer_requests":[{"transfer_request":{
"type":"sync_upload","paths":[{"source":"/path/to/source",
"destination":"/path/to/dest"}],"destination_root":"/"}}]}'
4. Sample Payload for /files/sync_setup
Use the following JSON payload to define your transfer request:
{
"transfer_requests": [
{
"type": "sync_upload",
"paths": [
{
"source": "/path/to/file",
"destination": "/path/to/destination/file"
}
],
"name": "",
"source_root": ".",
"destination_root": ".",
"target_rate_kbps": ".",
"target_rate_cap_kbps": ".",
"min_rate_cap_kbps": 100,
"fasp_port": 33001,
"cookie": "",
"remote_host": "host_address",
"remote_user": "remote_user",
"cipher_allowed": true,
"lock_rate_policy": true,
"lock_target_rate": true,
"lock_min_rate": true,
"create_dir": true,
"tags": {},
"aspera_connect_settings": {}
}
]
}
The token returned in the response must be supplied to the async command using the -W option.
5. Run the Async Command
Below is an example command to run Async in continuous mode with a 30-minute scan interval:
async -L /path/to/logdir \
-N name_for_job \
-b /path/to/local/db/dir \
-C --scan-interval=30m \
-d /path/to/be/synced --mirror \
-W "token" \
-r remote_user@hostname_or_ip:/path/to/remote/sync/dir \
-R /path/to/remote/logdir \
-B /path/to/remote/dbdir \
-K push
Summary
By enabling activity logging on either the client or server, obtaining a transfer token when needed, and configuring the async command correctly, you can easily set up robust sync jobs with IBM Aspera Sync and monitor them seamlessly through the Console.