In Console, a node is defined as an Aspera-transfer-enabled computer. A node can be added as a managed node (typically a local system) or an unmanaged node. The following table displays tasks that can be performed on each node type:
Type | Permissions |
---|---|
Managed Node | Initiate transfers with; monitor; configure |
Unmanaged Node | Initiate transfers with |
To add a managed node, prepare an account with Administrator or Root permissions on the node machine and follow the steps below.
-
Check your node machine's version of Aspera transfer software
To function properly with Console, a node must have Aspera Enterprise Server, Connect Server or Point-to-Point version 2.2.1+ installed. To verify your node machine's product version, run the command below.
>$ ascp -A
Note that if you have an older version, you can download the latest from http://asperasoft.com/downloads.
-
Apply patch to Aspera Central on node machine
If you are running Enterprise Server, Connect Server or Point-to-Point version 2.7.X or older on your node, then you need to apply a patch to Aspera Central. To download the patch, please go to http://www.asperasoft.com/en/support/patches_10/Aspera_Central_27448979_Patch_Readme_35 and follow the on-screen instructions.
-
Configure the node machine's firewall
Please refer to the firewall requirements documented in the topic System and Firewall Requirements.
-
(Optional) Upload your node machine's private SSH key file to Console
If you would like to use a public/private keypair to connect to this node machine, you can upload your private key through the Configuration screen. For additional information and instructions on this process, please review the topic SSH Key Configuration.
-
Create a node in Console
In Aspera Console, go to Nodes > New Managed Node .
Within the Creating New Node screen, enter your managed node's IP address, name and SSH port. Enable the Create default Console groups checkbox if you would like to create the three default Console groups (i.e., Transfer Admin, Transfer Initiator and Transfer Monitor), which are defined below.
- Nodes in the Transfer Admin group can manage transfers, including initiating, cancelling and deleting transfers.
- Nodes in the Transfer Initiator group can only initiate transfers.
- Nodes in the Transfer Monitor group can only monitor transfers.
When finished, click Create.
-
Prepare a user to run the Aspera Central service (Windows node-only)
IMPORTANT NOTE: This step is necessary when you are setting up a Windows node and using a non-local user to run the Aspera Central service.
Aspera Console communicates with nodes through the Aspera Central service. When you are adding a node that runs Windows and you are using a non-local user to run Aspera Central on the node (i.e. an Active Directory user), the user must have special permissions configured to allow Console to manage the node. On the Windows node machine, navigate to Control Panel > Administrative Tools and launch Local Security Policy. Within the Local Security Policy window, select Local Policies > User Rights Assignment in the left panel, and add the newly-created user to the following policies (by double-clicking each policy):
- Adjust memory quotas for a process
- Backup files and directories
- Replace a process level token
- Restore files and directories
-
Set the Aspera Central service to run as the new user
Navigate to Control Panel > Administrative Tools and click Services. Double-click Aspera Central in the right panel.
Within the Aspera Central Properties window, click the Log On tab and, under the Log on as: section, select This account: > Browse and select the user account that you just created.
-
Prepare an Administrator's account on the node machine
To utilize Console's node configuration feature on the node machine, you must do the following:
- Create an an Administrator's account on the node machine.
- Add the Admin account to your Aspera transfer product.
- Provide the admin account's credentials to Console.
Follow the instructions below for your managed node's specific operating system.
Platform Instructions Windows On a managed Windows node, prepare an administrator's account and open your Aspera product's user interface ( Start > All Programs > Aspera > "product name" ). Click Configuration to view the Server Configuration. Under Server Configuration, click the Users tab, then
, and finally, enter your administrator's account details.
Once you have added the account, go to the user's docroot settings by clicking the Docroot tab.
Check Overwrite for Absolute Path and leave it blank. By doing so, the user can override default docroots under the node- or group-level setting.
OS 10.6 On a managed Mac OS 10.6 node, you must enable the root user account. Go to Macintosh HD > System > Library > CoreServices and click Directory Utility. Within the Directory Utility, first unlock it to allow changes, and then click Edit > Enable Root User . You must also set a password. OS X 10.5 On a managed Mac OS 10.5 node, you must enable the root user account. Go to Macintosh HD > Applications > Utilities and click Directory Utility. Within the Directory Utility, first unlock it to allow changes, and then click Edit > Enable Root User . You must also set a password. OS X 10.4 On a managed Mac OS 10.4 node, you must enable the root user account. Go to Macintosh HD > Applications > Utilities and click NetInfo Manager. Within the NetInfo Manager, first unlock it to allow changes, and then click users > root . Locate the property passwd, and assign a new password. RedHat, Solaris, FreeBSD On a managed RedHat, Solaris or FreeBSD node, you must create an administrative user account that has permissions to run OpenSSH and to write to the file aspera.conf. aspera.conf can be found in the directory "/opt/aspera/etc/". Once you have located aspera.conf, open it with a text editor and add the administrative user, along with a blank docroot. In the example below, the user is asp1. <?xml version='1.0' encoding='UTF-8'?> <CONF version="2"> <aaa><realms><realm> <users> <user> <name>asp1</name> <file_system> <access> <paths><path><absolute> </absolute></path></paths> </access> </file_system> </user> ... </users> </realm></realms></aaa> ... </CONF>
Isilon OneFS On a managed Isilon OneFS node, you must create an administrative user account that has permissions to run OpenSSH and to write to the file aspera.conf. aspera.conf can be found in the directory "/ifs/.ifsvar/aspera/etc/aspera.conf". Once you have located aspera.conf, open it with a text editor and add the administrative user, along with a blank docroot. In the example below, the user is asp1. <?xml version='1.0' encoding='UTF-8'?> <CONF version="2"> <aaa><realms><realm> <users> <user> <name>asp1</name> <file_system> <access> <paths><path><absolute> </absolute></path></paths> </access> </file_system> </user> ... </users> </realm></realms></aaa> ... </CONF>
-
Within Console, enter the node machine's administrative credentials and create an admin account
Once the node machine's administrative credentials have been created, log in to Console and navigate to Nodes. Here, click the edit link for the respective node. On the Node Maintenance screen, select Credentials and then Edit Credentials. Note that you may use password or public key authentication. If you elect to use public key authentication, then you must have your SSH private key configured in Console. For additional instructions, please refer to the topic SSH Key Configuration. For public key authentication, check Use SSH Key and select your uploaded key. To authenticate by password, enter the account's password.
Once the node's administrative credentials have been entered into Console, go to the Accounts tab, click Add User, and enter the administrative account information. Overwrite the Absolute Path field and leave it blank (empty value).
-
Connect the node to Console
Once the node's administrative account has been added to Console, go to the Connect tab and complete the form below. When finished, click Connect node to Console.
Item Description Use SSH Tunneling Connect Console to the node via an SSH tunnel. SSH Tunneling is only supported on nodes running Aspera Enterprise Server 2.7+. Database Address Enter Console's database address. Database Port Display the Console database's port number. Transfer Server Bind Address Enter an IP address for Aspera Central to bind its connections. Transfer Server Bind Port Enter a port for Aspera Central to bind its connections. -
Restart Aspera Central
After saving your settings, click the Restart Aspera Central button to restart Aspera Central on the node. Note that all ongoing transfers will be terminated.
At this point, a connection should be established between Console and your managed node. To verify the connect, select Nodes within the Console menu and locate the node within the table. If the node is connected, the Hostname, Sessions, OS and Restarted fields will be populated.
If you see an error message (e.g. "DB Logger Never Connected"), then it is recommended that you perform the steps above again, or contact Technical Support for assistance.