Creating a Push Watch Folder

A local-to-remote (push) Watch Folder monitors a directory on the source node where the Watch Folder runs. If it detects new files in the source directory, it transfers those files to a directory on the destination node.

To use Watch Folders, you must enable the feature (Configuration > Defaults and select Enable Watchfolder management) and add Watch Folder-enabled nodes to Console as managed nodes. For instructions on enabling Watch Folders on a node, see IBM Aspera High-Speed Transfer Server Admin Guide: Watch Folders and the Aspera Watch Service.

  1. Go to Activity > Watchfolders and click Create New Watchfolder.
  2. Enter a name for your watch folder in the Name field.
  3. Select Push for the Watch Folder type.
  4. Configure the source node and directory. Files dropped into the source directory are transferred to the destination node and directory.
    1. Select your source node from the drop-down menu. Only Watch Folder-configured nodes appear in the list.
    2. Select the source directory.
      You can Browse and select the source directory, or manually enter the source path.
      Important: The path is relative to the associated system user's docroot. For example, if you enter project1/final and the user's docroot is /aspera/projects, the source path is /aspera/projects/project1/final.
  5. Enter authentication credentials for the destination node in the Target pane.
    1. Enter the IP address or hostname of the target node.
    2. Choose the type of credentials you want to use for authentication. Enter the credentials to authenticate to the destination node and authorize transfers.
      Authentication Type UI Option Credentials
      SSH with password SSH Password SSH user and SSH password
      SSH with key SSH Key SSH user and SSH private key
      Note: You must give the full path to the SSH key, not the path relative to the docroot.
      HTTPS with Node API Node API Node API user and Node API password
      HTTPS with Shares API Shares Aspera Shares API user and Aspera Shares API password
      Important:

      1) To authenticate using SSH with password, the source node must be running IBM Aspera High-Speed Transfer Server 3.7 or later.

      2) To authenticate using HTTPS with Node API or HTTPS with Shares API, both the source and destination nodes must be running IBM Aspera High-Speed Transfer Server 3.8 or later.

  6. If you want, you can also enter a token string to authenticate the transfers, with the syntax "Basic token_string".
    For instructions on creating an access key on the remote node and generating a token from it, see the IBM Aspera High-Speed Transfer Server Admin Guide: Access Key Authentication.
  7. If you want to specify an Aspera forward proxy for the Watch Folder, enter the proxy address in the following format:
    dnat://login:password@address:port

    For more information on forward proxies, see the IBM Aspera Proxy Admin Guide.

  8. Set ports for SSH/TCP or Node API (depending on your authentication type) connections, and for fasp™ (UDP) connections.
    Target Authentication Default Ports
    SSH Password

    SSH Port: 22
    UDP: 33001

    SSH Key

    SSH Port: 22
    UDP: 33001

    Node API

    Node API Port: 9092
    UDP: 33001

    Shares

    Shares API Port: 443
    UDP: 33001

  9. Select the destination directory.
    You can Browse and select the destination directory, or manually enter the destination path.
    Important: Just like for the source path, the destination path is relative to the associated system user's docroot.
    If you are using an SSH key for authentication and you want to browse for the destination, you need to first add the key to Console to authenticate Console to browse the node. You do not need to add the key to Console if you know the destination path and enter it manually. For more information on adding SSH keys to Console, see Storing SSH Keys on Console.
  10. Configure additional watchfolder settings. See Watchfolder Options.
  11. Click Create.
  12. Test your watch folder.

    Add files to the source directory. Watch Folder detects the new files and transfers the new files to the target directory. You can see the transfer on the Activity Overview page.