Node-Level Configuration Options

To start node configuration, go to Nodes in the Console menu. Click edit for an existing node that you wish to configure. The server's admin credentials are required for the configuration. See Updating a Node's Admin Credentials.

The node configuration options can be found in the Configuration tab. The following is a summarized chart for navigating and changing values when you click on an individual section. Click Save changes when finished:

Configuration at the node level will affect all user accounts and group accounts on that node performing Aspera transfers.
Section Configuration Details
Database Configuring policy and logging level settings.
Transfer Server Setting transfer server IP address and port.
HTTP Fallback Server Enable and configure HTTP / HTTPS fallback server.
Docroot Setting document root and its access permissions.
Authorization Connection permissions, token key, and encryption requirements.
Bandwidth Incoming and outgoing transfer bandwidth and policy settings.
Advanced File Handling File handling settings, such as file block size, overwrite rules, and exclude pattern.
Advanced Network Options Network IP address, port, and socket buffer settings.

Database

# Field Description Values Default
1 Host IP Enter the Aspera Console server's IP address, default 127.0.0.1 valid IPv4 address 127.0.0.1
2 Port The default value for an Aspera Console installation is 4406. Valid port numbers range between 1 and 65535. Integer between 1 and 65535 4406
3 User User login for the database server. text string blank
4 Database Name Name of the database used to store Aspera transfer data. text string blank
5 Threads The number of parallel connections used for database logging. A higher value may be useful when a large number of files are being transferred within a given time frame. Integer between 1 and 40 10
6 Stop Transfers on Database Error Quits all ongoing transfers and no new transfers are permitted when a database error prevents data from being written to the database. Set this to true if all transfers must be logged by your organization.
  • true
  • false
false
7 Session Progress Setting this value to true will log transfer status such as number of files transferred, and bytes transferred, at a given interval.
  • true
  • false
true
8 Session Progress Interval The frequency at which an Aspera node logs transfer session information, up to 65535 seconds. Positive integer 1
9 File Events Setting this value to true enables the logging of complete file paths and file names. Performance may be improved when transferring datasets containing thousands of files. Also see File Per Session for setting a threshold for the number of files to log per session.
  • true
  • false
true
10 File Progress Setting this value to true will log file status such as bytes transferred at a given interval.
  • true
  • false
true
11 File Progress Interval The frequency at which an Aspera node logs file transfer information, up to 65535 seconds. The default setting of 1 logging sessions every second. Integer between 1 and 65535 1
12 Files Per Session The value is the cut-off point for file names logged in a given session. For example, if the value is set to 50, the first 50 file names will be recorded for any session. The session will still record the number of files transferred along with the number of files completed, failed, or skipped. The default setting of 0 will log all file names for a given session. Positive integer or zero 0
13 Ignore Empty Files Setting this to true will block the logging of zero-byte files.
  • true
  • false
false
14 Ignore No-transfer Files Setting this to true will block the logging of files that have not been transferred because they exist at the destination at the time the transfer started.
  • true
  • false
false
15 Rate Events Setting this to true will log changes made to the Target Rate, Minimum Rate, and Transfer Policy of a transfer by any user or Aspera node administrator during a transfer.
  • true
  • false
true

Transfer Server

# Field Description Values Default
1 Bind Address This is the network interface address on which the transfer server listens. The default value 127.0.0.1 enables the transfer server to accept transfer requests from the local computer. Setting the value to 0.0.0.0 allows the Aspera transfer server to accept transfer requests on all network interfaces for this node. Alternatively, a specific network interface address may be specified. Valid IPv4 address 127.0.0.1
2 Bind Port The port at which the transfer server will accept transfer requests. Integer between 1 and 65535 40001

HTTP Fallback Server

Note: While Console can change a node's settings for HTTP fallback, Console does not support HTTP fallback for transfers it initiates.
# Field Description Values Default
1 Cert File The absolute path to an SSL certificate file. If left blank, the default certificate file that came with your Aspera Enterprise Server will be used. file path blank
2 Key File The absolute path to an SSL key file. If left blank, the default certificate file that came with your Aspera Enterprise Server will be used. file path blank
3 Bind Address This is the network interface address on which the HTTP Fallback Server listens. The default value 0.0.0.0 allows the Aspera HTTP Fallback Server to accept transfer requests on all network interfaces for this node. Alternatively, a specific network interface address may be specified. valid IPv4 address 0.0.0.0
4 Restartable Transfers Setting this to true allows interrupted transfers to resume at the point of interruption.
  • true
  • false
true
5 Session Activity Timeout Any value greater than 0 sets the amount of time, in seconds, that the HTTP Fallback Server will wait without any transfer activity before canceling the transfer. Notice that this option cannot be left at 0, otherwise interrupted HTTP Fallback sessions will get stuck until server or asperacentral is restarted. Positive integer 0
6 Enable HTTP Enables the HTTP Fallback Server that allows failed UDP transfers to continue over HTTP.
  • true
  • false
false
7 HTTP Port The port on which the HTTP server listens. Valid port numbers range between 1 and 65535. positive integer 8080
8 Enable HTTPS Enables the HTTPS Fallback Server that allows failed UDP transfers to continue over HTTPS.
  • true
  • false
false
9 HTTPS Port The port on which the HTTPS server listens. Valid port numbers range between 1 and 65535. positive integer 8443

Docroot

# Field Description Values Default
1 Absolute Path The Absolute Path describes the area of the file system that is accessible by Aspera users. The default empty value gives users access to the entire file system. file path N/A
2 Read Allowed Setting this to true allows users to transfer from the designated area of the file system as specified by the Absolute Path value.
  • true
  • false
N/A
3 Write Allowed Setting this to true allows users to transfer to the designated area of the file system as specified by the Absolute Path value.
  • true
  • false
N/A
4 Browse Allowed Setting this to true allows users to browse the directory.
  • true
  • false
N/A

Authorization

# Field Description Values Default
1 Incoming Transfers The default setting of allow allows users to transfer to this computer. Setting this to deny will prevent transfers to this computer. When set to require token, only transfers initiated with valid tokens will be allowed to transfer to this computer. Token-based transfers are typically employed by web applications such as Faspex and require a Token Encryption Key.
  • allow
  • deny
  • require token
allow
2 Incoming External Provider URL The value entered should be the URL of the external authorization provider for incoming transfers. The default empty setting disables external authorization. Aspera servers can be configured to check with an external authorization provider. This SOAP authorization mechanism can be useful to organizations requiring custom authorization rules. HTTP URL blank
3 Incoming External Provider SOAP Action The SOAP action required by the external authorization provider for incoming transfers. Required if External Authorization is enabled. text string blank
4 Outgoing Transfers The default setting of allow allows users to transfer from this computer. Setting this to deny will prevent transfers from this computer. When set to require token, only transfers initiated with valid tokens will be allowed to transfer from this computer. Token-based transfers are typically employed by web applications such as Faspex and require a Token Encryption Key.
  • allow
  • deny
  • require token
allow
5 Outgoing External Provider URL The value entered should be the URL of the external authorization provider for outgoing transfers. The default empty setting disables external authorization. Aspera servers can be configured to check with an external authorization provider. This SOAP authorization mechanism can be useful to organizations requiring custom authorization rules. HTTP URL, default blank  
6 Outgoing External Provider Soap Action The SOAP action required by the external authorization provider for outgoing transfers. Required if External Authorization is enabled. Text string blank
7 Token Encryption Cipher The cipher used to generate encrypted authorization tokens.
  • aes-128
  • aes-192
  • aes-256
aes-128
8 Token Encryption Key This is the secret token that will be used to authorize those transfers configured to require token. Token generation is part of the Aspera SDK. See the Aspera Developer's Network (Token-based Authorization Topic) for more information. Text string blank
9 Token Life (seconds) Sets token expiration for users of web-based transfer applications. Positive integer 1200
10 Encryption Allowed Describes the type of transfer encryption accepted by this computer. When set to any the computer allows both encrypted and non-encrypted transfers. When set to none the computer restricts transfers to non-encrypted transfers only. When set to aes-128 the computer restricts transfers to encrypted transfers only.
  • any
  • none
  • aes-128
any

Bandwidth

# Field Description Values Default
1 Incoming Vlink ID The value sets the Vlink ID for incoming transfers. Vlinks are a mechanism to define aggregate transfer policies. The default setting of 0 disables Vlinks. One Vlink—the virtual equivalent of a network trunk—represents a bandwidth allowance that may be allocated to a node, group, or user. Vlink ID are defined in each Vlink created in Aspera Console. The Vlink ID is a unique numeric identifier. See Configuring Virtual Links Pre-defined value 0
2 Incoming Target Rate Cap (Kbps) The value sets the Target Rate Cap for incoming transfers. The Target Rate Cap is the maximum target rate that a transfer can request, in kilobits per second. No transfer may be adjusted above this setting, at any time. The default setting of Unlimited signifies no Target Rate Cap. Clients requesting transfers with initial rates above the Target Rate Cap will be denied. Positive integer Unlimited
3 Incoming Target Rate Default (Kbps) This value represents the initial rate for incoming transfers, in kilobits per second. Users may be able to modify this rate in real time as allowed by the software in use. This setting is not relevant to transfers with a Fixed policy. Positive integer 10000
4 Incoming Target Rate Lock After an incoming transfer is started, its target rate may be modified in real time. The default setting false gives users the ability to adjust the transfer rate. A setting of true prevents real-time modification of the transfer rate.
  • true
  • false
false
5 Incoming Minimum Rate Cap (Kbps) The value sets the Minimum Rate Cap for incoming transfers. The Minimum Rate Cap is a level specified in kilobits per second, below which an incoming transfer will not slow, despite network congestion or physical network availability. The default value of Unlimited effectively turns off the Minimum Rate Cap. Positive integer Unlimited
6 Incoming Minimum Rate Default (Kbps) This value represents the initial minimum rate for incoming transfers, in kilobits per second. Users may be able to modify this rate in real time as allowed by the software in use. This setting is not relevant to transfers with a Fixed policy. Positive integer 0
7 Incoming Minimum Rate Lock After an incoming transfer is started, its minimum rate may be modified in real time. The default setting of false gives users the ability to adjust the transfer's minimum rate. A setting of true prevents real-time modification of the transfer rate. This setting is not relevant to transfers with a Fixed policy.
  • true
  • false
false
8 Incoming Bandwidth Policy Default The value chosen sets the default Bandwidth Policy for incoming transfers. The default policy value may be overridden by client applications initiating transfers.
  • fixed
  • high
  • fair
  • low
fair
9 Incoming Bandwidth Policy Allowed The value chosen sets the allowed Bandwidth Policy for incoming transfers. Aspera transfers use fixed, high, fair and low policies to accommodate network-sharing requirements. When set to any, the server will not deny any transfer based on policy setting. When set to high, transfers with a Policy of high and less aggressive transfer policies (such as, fair or low) will be permitted. Fixed transfers will be denied. When set to low, only transfers with a Bandwidth Policy of low will be allowed.
  • fixed
  • high
  • fair
  • low
fair
10 Incoming Bandwidth Policy Lock After an incoming transfer is started, its Policy may be modified in real time. The default setting of false gives users the ability to adjust the transfer's Policy. A setting of true prevents real-time modification of the Policy.
  • true
  • false
false
11 Outgoing Vlink ID The value sets the Vlink ID for outgoing transfers. Vlinks are a mechanism to define aggregate transfer policies. The default setting of 0 disables Vlinks. One Vlink—the virtual equivalent of a network trunk—represents a bandwidth allowance that may be allocated to a node, group, or user. Vlink ID are defined in each Vlink created in Aspera Console. The Vlink ID is a unique numeric identifier. See Configuring Virtual Links Pre-defined value 0
12 Outgoing Target Rate Cap (Kbps) The value sets the Target Rate Cap for outgoing transfers. The Target Rate Cap is the maximum target rate that a transfer can request, in kilobits per second. No transfer may be adjusted above this setting, at any time. The default setting of Unlimited signifies no Target Rate Cap. Clients requesting transfers with initial rates above the Target Rate Cap will be denied. Positive integer Unlimited
13 Outgoing Target Rate Default (Kbps) This value represents the initial rate for outgoing transfers, in kilobits per second. Users may be able to modify this rate in real time as allowed by the software in use. This setting is not relevant to transfers with a Fixed policy. Positive integer 10000
14 Outgoing Target Rate Lock After an outgoing transfer is started, its target rate may be modified in real time. The default setting of false gives users the ability to adjust the transfer rate. A setting of true prevents real-time modification of the transfer rate.
  • true
  • false
false
15 Outgoing Minimum Rate Cap (Kbps) The value sets the Minimum Rate Cap for outgoing transfers. The Minimum Rate Cap is a level specified in kilobits per second, below which an incoming transfer will not slow, despite network congestion or physical network availability. The default value of Unlimited effectively turns off the Minimum Rate Cap. Positive integer Unlimited
16 Outgoing Minimum Rate Default This value represents the initial minimum rate for outgoing transfers, in kilobits per second. Users may be able to modify this rate in real time as allowed by the software in use. This setting is not relevant to transfers with a Fixed policy. Positive integer 0
17 Outgoing Minimum Rate Lock After an outgoing transfer is started, its minimum rate may be modified in real time. The default setting of false gives users the ability to adjust the transfer's minimum rate. A setting of true prevents real-time modification of the transfer rate. This setting is not relevant to transfers with a Fixed policy.
  • true
  • false
false
18 Outgoing Bandwidth Policy Default The value chosen sets the default Bandwidth Policy for outgoing transfers. The default policy value may be overridden by client applications initiating transfers.
  • fixed
  • high
  • fair
  • low
fair
19 Outgoing Bandwidth Policy Allowed The value chosen sets the allowed Bandwidth Policy for outgoing transfers. Aspera transfers use fixed, high, fair and low policies to accommodate network-sharing requirements. When set to any, the server will not deny any transfer based on policy setting. When set to high, transfers with a Policy of high and less aggressive transfer policies (for example, fair or low) will be permitted. Fixed transfers will be denied. When set to low, only transfers with a Bandwidth Policy of low will be allowed.
  • any
  • high
  • fair
  • low
any
20 Outgoing Bandwidth Policy Lock After an outgoing transfer is started, its Policy may be modified in real time. The default setting of false gives users the ability to adjust the transfer's Policy. A setting of true prevents real-time modification of the Policy.
  • true
  • false
false

Advanced File Handling

# Field Description Values Default
1 File Create Mode Specify file creation mode (permissions). If specified, create files with these permissions (for example 0755), irrespective of File Create Grant Mask and permissions of the file on the source computer. Only takes effect when the server is a non-Windows receiver. Positive integer (octal) undefined
2 File Create Grant Mask Used to determine mode for newly created files if File Create Mode is not specified. If specified, file modes will be set to their original modes plus the Grant Mask values. Only takes effect when the server is a non-Windows receiver and when File Create Mode is not specified. Positive integer (octal) 0644
3 Directory Create Mode Specify directory creation mode (permissions). If specified, create directories with these permissions irrespective of Directory Create Grant Mask and permissions of the directory on the source computer. Only takes effect when the server is a non-Windows receiver. Positive integer (octal) undefined
4 Directory Create Grant Mask Used to determine mode for newly created directories if Directory Create Mode is not specified. If specified, directory modes will be set to their original modes plus the Grant Mask values. Only takes effect when the server is a non-Windows receiver and when Directory Create Mode is not specified. Positive integer (octal) 0755
5 Read Block Size (bytes) This is a performance tuning parameter for an Aspera sender. It represents the number of bytes an Aspera sender reads at a time from the source disk drive. Only takes effect when server is sender. The default of 0 will cause the Aspera sender to use its default internal buffer size, which may be different for different operating systems. Positive integer 0
6 Write Block Size (bytes) This is a performance tuning parameter for an Aspera receiver. Number of bytes an ascp receiver writes data at a time onto disk drive. Only takes effect when server is receiver. The default of 0 will cause the Aspera sender to use its default internal buffer size, which may be different for different operating systems. Positive integer 0
7 Use File Cache This is a performance tuning parameter for an Aspera receiver. Enable or disable per-file memory caching at the data receiver. File level memory caching improves data write speed on Windows platforms in particular, but will use more memory. We suggest using a file cache on systems that are transferring data at speeds close to the performance of their storage device, and disable it for systems with very high concurrency (because memory utilization will grow with the number of concurrent transfers).
  • true
  • false
true
8 Max File Cache Buffer (bytes) This is a performance tuning parameter for an Aspera receiver. This value corresponds to the maximal size allocated for per-file memory cache (see Use File Cache). Unit is bytes. The default of 0 will cause the Aspera receiver to use its internal buffer size, which may be different for different operating systems. Positive integer 0
9 Resume Suffix Extension name of a class of special files holding metadata information of regular data files. Useful in the context of resuming partially completed transfers. During resume mode (-k1/2/3), each data file has a corresponding metadata file with the same name and the pre-specified resume suffix. text string aspx
10 Preserve Attributes Configure file creation policy. When set to none, do not preserve the timestamp of source files. When set to times, preserve the timestamp of the source files at destination. none / times undefined
11 Overwrite Overwrite is an Aspera server setting that determines whether Aspera clients are allowed to overwrite files on the server. By default it is set to allow, meaning that clients uploading files to the servers will be allowed to overwrite existing files as long as file permissions allow that action. If set to deny, clients uploading files to the server will not be able to overwrite existing files, regardless of file permissions.
  • allow
  • deny
allow
12 File Manifest When set to text a text file "receipt" of all files within each transfer session is generated. If set to disable no File Manifest is created. The file manifest is a file containing a list of everything that was transferred in a given transfer session. The filename of the File Manifest itself is automatically generated based on the transfer session's unique ID. The location where each manifest is written is specified by the File Manifest Path value. If no File Manifest Path is specified, the file will be generated under the destination path at the receiver, and under the first source path at the sender.
  • text
  • disable
none
13 File Manifest Path Specify the location to store manifest files. Can be an absolute path or a path relative to the transfer user's home. text string blank
14 Pre-Calculate Job Size Configure the policy of calculating total job size before data transfer. If set to any, follow client configurations (-o PreCalculateJobSize={yes|no}). If set to no, disable calculating job size before transferring. If set to yes, enable calculating job size before transferring.
  • any
  • yes
  • no
any
15 Storage Rate Control Enable/Disable disk rate control. When enabled, adjust transfer rate according to the speed of receiving I/O storage, if it becomes a bottleneck.
  • true
  • false
false
16 File checksum method Specify the type of checksum to calculate for transferred files. The content of transfers can be verified by comparing the checksum value at the destination with the value read at the source.
  • any
  • md5
  • sha1
any
16 Partial Suffix Set the file suffix for partially downloaded files.   .aspx

Advanced Network Options

# Field Description Values Default
1 Bind IP Address Specify an IP address for server-side ascp to bind its UDP connection. If a valid IP address is given, ascp sends and receives UDP packets ONLY on the interface corresponding to that IP address. Valid IPv4 address blank
2 Bind UDP Port Specify a port number for server-side ascp to bind its UDP connection. This also prevents client ascp processes from binding to same UDP port. Valid port numbers range between 1 and 65535. Positive integer 33001
3 Disable Packet Batching When set to true, send data packets back to back (no sending a batch of packets). This results in smoother data traffic at a cost of higher CPU usage.
  • true
  • false
false
4 Maximum Socket Buffer (bytes) Upper bound the UDP socket buffer of an ascp session below the input value. The default of 0 will cause the Aspera sender to use its default internal buffer size, which may be different for different operating systems. Positive integer 0
5 Minimum socket buffer (bytes) Set the minimum UDP socket buffer size for an ascp session. Positive integer 0