Setting Up a Windows Node

A node is a machine running an Aspera transfer server product (IBM Aspera Enterprise Server, IBM Aspera Connect Server) which has been configured for Node API. Aspera web applications authenticate to remote node services using a Node API username and password. Different nodes may use different Node API username and password pairs.
Note: The following instructions require you to have administrative privileges.
  1. Verify you have installed IBM Aspera Enterprise Server with a valid Connect Server license on your transfer server.
    Run the following command:
    > ascp -A
    If you need to update your transfer server license, follow the instructions in IBM Aspera Enterprise Server Admin Guide: Updating Product License.
  2. Create a new system account on the node .
    Click Control Panel > User Accounts and add a new account. This system user account is associated with the Node API account in the steps below.
    Note:

    After creating a Windows user account, log in as that user at least once for Windows to set up the user's home folder.

    The examples in the steps below use xfer-user as an example username.

The following steps use the asconfigurator utility to modify the aspera.conf configuration file, located at:

C:\Program Files (x86)\Aspera\Enterprise Server\etc\aspera.conf
.

  1. Add the user to aspera.conf and set the docroot.
    Run the following asconfigurator command with the node username and the docroot path:
    > asconfigurator -x "set_user_data;user_name,username;absolute,/
    docroot/path"
    For example:
    > asconfigurator -x "set_user_data;user_name,xfer-user;absolute,/project1"
    CAUTION:
    Aspera recommends that you not use spaces in your docroot. If your docroot contains spaces, you may not receive all email notifications relating to transfer activity.
  2. Set up token authorization for the user in aspera.conf.
    Run the following asconfigurator command to set the encryption key for the user:
    > asconfigurator -x "set_user_data;user_name,username;token_encryption_key,encryption_key"
    The encryption key can be any string of numbers. Aspera recommends a string that is at least 20 characters long. For example:
    > asconfigurator -x "set_user_data;user_name,xfer-user;token_encryption_key,gj5o930t78m34ejme9dx"
  3. Verify persistent storage is enabled in aspera.conf for use with stats collector.
    Run the following asuserdata command to verify that the persistent_store parameter is set to enable:
    > asuserdata -c
    
    central server option set:
      address: "127.0.0.1"
      port: "40001"
      backlog: "200"
      schema_validation: "enable"
      mgmt_backlog: "200"
      mgmt_port: "0"
      transfer_list_path: ""
      persistent_store: "enable"
      persistent_store_path: ""
      persistent_store_max_age: "86400"
      persistent_store_on_error: "ignore"
      event_buffer_capacity: "1000"
      event_buffer_overrun: "block"
      compact_on_startup: "enable"
      files_per_session: "1000000"
      file_errors: "true"
      ignore_empty_files: "true"
      ignore_skipped_files: "true"
      ignore_no_transfer_files: "true"
      db_synchronous: "off"
      db_journal: "wal"
    If persistent storage is not enabled, you must run the following asconfigurator command to enable it:
    > asconfigurator -x "set_central_server_data;persistent_store,enable"
    Restart the Aspera Central service to update the node configuration:
    # service asperacentral restart
  4. Restart the Aspera Central service from the Services window.
    Click Start Menu > Control Panel > Administrative Tools > Services. Right-click Aspera Central and select Restart.
  5. Set up a transfer user account with a Node API username and password.
    Note: Aspera recommends that you use different names for the system user account and transfer user account in order to minimize confusion when tracing transactions and events.
    Run the following commands:
    > asnodeadmin -a -u node_api_username -p node_api_password -x username
    For example:
    > asnodeadmin -a -u shares-node-user -p ****** -x xfer-user
    Run the following command to check the system user was successfully added to asnodeadmin:
    > asnodeadmin -l
    The result should be similar to the following example:
                    user       system/transfer user                    acls
    ====================    =======================    ====================
           node_api_username                  username    []
  6. Install the IBM Aspera Connect Browser Plug-In key.
    1. If the .ssh folder does not already exist in the system user's home directory, run the following commands to create the folder:
      > cd "C:\Documents and Settings\username"
      > mkdir .ssh
      For example:
      > cd "C:\Documents and Settings\xfer-user"
      > mkdir .ssh
    2. If the authorized_keys file does not already exist, use a text editor to create or edit the following file: C:\Documents and Settings\username\.ssh\authorized_keys.
    3. Copy the contents of the aspera_id_dsa.pub (C:\Program Files (x86)\Aspera\Enterprise Server\var\aspera_id_dsa.pub ) public key to the file.
      The file must be named "authorized_keys" without file extensions. Some text editors add a .txt extension to the filename automatically. Be sure to remove the extension if it was added to the filename.
  7. Set up the transfer user account as a user in Enterprise Server, if it is not already configured.
    For more information on adding users, see the IBM Aspera Enterprise Server Admin Guide: Setting Up Users.
The transfer node is now ready for connection to Shares. For instructions on adding a node to Shares, see Adding Nodes.