aspera.conf - Transfer

The configuration options in <transfer/> section of aspera.conf

This topic shows you how to modify the aspera.conf <transfer/> section.

  1. Open aspera.conf.
    /opt/aspera/etc/aspera.conf

    You can also find the example aspera.conf in the samples directory:

    /opt/aspera/etc/samples/aspera-everything.conf
  2. Add or locate the <transfer/> section using a template.

    The following template includes all options:

    <transfer>
     <in>
        <bandwidth>
           <aggregate>
              <trunk_id>109</trunk_id>        <!-- Incoming VLink ID -->
           </aggregate>
           <flow>
              <target_rate>
                 <cap></cap>                  <!-- Incoming Target Rate Cap -->
                 <default>10000</default>     <!-- Incoming Target Rate Default -->
                 <lock>false</lock>           <!-- Incoming Target Rate Lock -->
              </target_rate> 
              <min_rate>
                 <cap></cap>                  <!-- Incoming Minimum Rate Cap -->
                 <default></default>          <!-- Incoming Minimum Rate Default -->
                 <lock>false</lock>           <!-- Incoming Minimum Rate Lock -->
              </min_rate>
              <policy>
                 <cap></cap>                  <!-- Incoming Policy Allowed -->
                 <default></default>          <!-- Incoming Policy Default -->
                 <lock>false</lock>           <!-- Incoming Policy Lock -->
              </policy>
              <priority>
                 <cap></cap>                  <!-- Incoming Priority Allowed -->
                 <default></default>          <!-- Incoming Priority Default -->
                 <lock>false</lock>           <!-- Incoming Priority Lock -->
              </priority>
              <network_rc>
                 <module></module>              <!-- Incoming Rate Control Module -->
                 <tcp_friendly>no</tcp_friendly>    <!-- Incoming TCP Friendly Mode -->
              </network_rc>  
           </flow>
        </bandwidth>
     </in>
     <out>
        <bandwidth>
           <aggregate>
              <trunk_id>109</trunk_id>        <!-- Outgoing VLink ID -->
           </aggregate>
           <flow>
              <target_rate>
                 <cap></cap>                  <!-- Outgoing Target Rate Cap -->
                 <default>10000</default>     <!-- Outgoing Target Rate Default -->
                 <lock>false</lock>           <!-- Outgoing Target Rate Lock -->
              </target_rate> 
              <min_rate>
                 <cap></cap>                  <!-- Outgoing Minimum Rate Cap -->
                 <default>0</default>         <!-- Outgoing Minimum Rate Default -->
                 <lock>false</lock>           <!-- Outgoing Minimum Rate Lock -->
              </min_rate>
              <policy>
                 <cap></cap>                  <!-- Outgoing Policy Allowed -->
                 <default></default>          <!-- Outgoing Policy Default -->
                 <lock>false</lock>           <!-- Outgoing Policy Lock -->
              </policy>
              <priority>
                 <cap></cap>                  <!-- Outgoing Priority Allowed -->
                 <default></default>          <!-- Outgoing Priority Default -->
                 <lock>false</lock>           <!-- Outgoing Priority Lock -->
              </priority>
              <network_rc>
                 <module></module>              <!-- Outgoing Rate Control Module -->
                 <tcp_friendly>no</tcp_friendly>    <!-- Outgoing TCP Friendly Mode -->
              </network_rc>  
           </flow>
        </bandwidth>
     </out>
     <protocol_options>
        <bind_ip_address></bind_ip_address>            <!--Bind IP Address-->
        <bind_udp_port>33001</bind_udp_port>           <!--Bind UDP Port-->
        <disable_batching>false</disable_batching>     <!--Disable Packet Batching-->
        <batch_size>1</batch_size>        	           <!--Batch Size-->		
        <datagram_size>1000</datagram_size>            <!--Datagram Size-->
        <max_sock_buffer>0</max_sock_buffer>           <!--Maximum Socket Buffer (bytes)-->   
        <min_sock_buffer>0</min_sock_buffer>           <!--Minimum Socket Buffer (bytes)-->   
        <rtt_autocorrect>false</rtt_autocorrect>       <!--RTT auto correction-->   
        <rtt_reverse_infer>false</rtt_reverse_infer>   <!--Reverse path congestion inference-->   
     </protocol_options>
     
     <encryption>
        <content_protection_strong_pass_required>  <!--Strong Password Required for Content Protection-->
           false
        </content_protection_strong_pass_required>
        <content_protection_required>              <!--Content Protection Required-->
           false
        </content_protection_required>
        <allowed_cipher>any</allowed_cipher>        <!--Encryption Allowed-->
        <fips_mode>false</fips_mode>               <!--Transfer in FIPS-140-2-certified encryption mode-->
     </encryption>
     
    </transfer>
  3. Configuration options reference.

    The following table explains all configuration options:

    Field Description Values Default
    Incoming Vlink ID The value sets 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 , a group, or a user. Vlink ID is defined in each Vlink created in Aspera Console. Vlink ID is a unique numeric identifier. pre-defined value 0
    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
    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 Policy of Fixed. positive integer 10000
    Incoming Target Rate Lock After an incoming 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
    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
    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 Policy of Fixed. positive integer 0
    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 Policy of Fixed.
    • true
    • false
    false
    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 (e.g. fair or low) will be permitted. When set to fair, transfers of fair and low will be permitted, while fixed transfers will be denied. When set to low, only transfers with a Bandwidth Policy of low will be allowed.
    • fixed
    • high
    • fair (regular)
    • low
    any
    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 (regular)
    • low
    fair
    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
    Incoming Priority Allowed The highest priority your client can request. Use the value 0 to unset this option; 1 to allow high priority, 2 to enforce normal priority.
    • 0
    • 1
    • 2
    1
    Incoming Priority Default The initial priority setting. Use the value 0 to unset this option, 1 to allow high priority; 2 to enforce normal priority
    • 0
    • 1
    • 2
    2
    Incoming Priority Lock To disallow your clients change the priority, set the value to true
    • true
    • false
    false
    Module (for incoming rate control) Located within the incoming </network_rc> stanza, this hidden setting is meant for advanced users to select an incoming rate control module (which will only be applied at the local "receiver" side). It should only be used with special instructions for debugging. Options include:
    • delay-odp: queue scaling controller
    • delay-adv: advanced rate controller
    • air: FASP air
    • delay-odp
    • delay-adv
    • air
    blank
    TCP Friendly (for incoming rate control) Located within the incoming </network_rc> stanza, this hidden setting is meant for advanced users to turn TCP-friendly mode on or off (which will only be applied at the local "receiver" side when the transfer policy is set to fair). It should only be used with special instructions for debugging. If turned on ("yes"), this mode allows an incoming FASP transfer to maintain relative fair bandwidth share with a TCP flow under congestion.
    • yes
    • no
    no
    Outgoing Vlink ID The value sets 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 , a group, or a user. Vlink ID is defined in each Vlink created in Aspera Console. The Vlink ID is a unique numeric identifier. pre-defined value 0
    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
    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 Policy of Fixed. positive integer 10000
    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
    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 outgoing 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
    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 Policy of Fixed. positive integer 0
    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 Policy of Fixed.
    • true
    • false
    false
    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 (e.g. fair or low) will be permitted. When set to fair, transfers of fair and low will be permitted, while fixed transfers will be denied. When set to low, only transfers with a Bandwidth Policy of low will be allowed.
    • fixed
    • high
    • fair (regular)
    • low
    any
    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 (regular)
    • low
    fair
    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
    Outgoing Priority Allowed The highest priority your client can request. Use the value 0 to unset this option; 1 to allow high priority, 2 to enforce normal priority.
    • 0
    • 1
    • 2
    1
    Outgoing Priority Default The initial priority setting. Use the value 0 to unset this option, 1 to allow high priority; 2 to enforce normal priority.
    • 0
    • 1
    • 2
    2
    Outgoing Priority Lock To disallow your clients change the priority, set the value to true
    • true
    • false
    false
    Module (for outgoing rate control) Located within the outgoing </network_rc> stanza, this hidden setting is meant for advanced users to select an outgoing rate control module (which will only be applied at the local "receiver" side). It should only be used with special instructions for debugging. Options include:
    • delay-odp: queue scaling controller
    • delay-adv: advanced rate controller
    • air: FASP air
    • delay-odp
    • delay-adv
    • air
    blank
    TCP Friendly (for outgoing rate control) Located within the outgoing </network_rc> stanza, this hidden setting is meant for advanced users to turn TCP-friendly mode on or off (which will only be applied at the local "receiver" side when the transfer policy is set to fair). It should only be used with special instructions for debugging. If turned on ("yes"), this mode allows an outgoing FASP transfer to maintain relative fair bandwidth share with a TCP flow under congestion.
    • yes
    • no
    no
    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.
    Important: The bind address should only be modified (changed to an address other than 127.0.0.1) if you, as the System Administrator, understand the security ramifications of doing so, and have undertaken precautions to secure the SOAP service.
    valid IPv4 address blank
    Bind UDP Port Prevent the client-side ascp process from using the specified UDP port. integer between 1 and 65535 33001
    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
    Batch Size When set to "0" (default), the system uses a pre-computed batch size. Set this to "1" for high concurrency servers (senders) in order to reduce CPU utilization in aggregate. Integer 0
    Datagram Size

    Sets the datagram size on the server side. If size is set with both -Z (client side) and <datagram_size> (server side), the <datagram_size> setting is used. In cases where the client-side is pre-3.3, datagram size is determined by the -Z setting, regardless of the server-side setting for <datagram_size>. In such cases, if there is no -Z setting, datagram size is based on the discovered MTU and the server logs the message "LOG Peer client doesn't support alternative datagram size".

    Integer 1492
    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
    Minimum Socket Buffer (bytes) Set the minimum UDP socket buffer size for an ascp session. positive integer 0
    RTT auto correction Enable auto correction of base (minimum) RTT measurement. This feature is helpful for maintaining accurate transfer rates in hypervisor-based virtual environments.
    • true
    • false
    false
    Reverse path congestion inference Enable reverse path congestion inference, where the default setting of "true" prevents the transfer speed of a session from being adversely affected by congestion in the reverse (non data-sending) transfer direction. This feature is useful for boosting speed in bi-directional transfers.
    • true
    • false
    true
    Strong Password Required for Content Encryption When set to true, require the password for content encryption to contain at least 6 characters, of which at least 1 is non-alphanumeric, at least 1 is a letter, and at least 1 is a digit.
    • true
    • false
    false
    Content Protection Required Setting to true requires that content be left encrypted at the destination.
    • Users will be required on upload to enter a password to encrypt the files on the server.
    • Users will be given the option when downloading to decrypt during transfer.
    • true
    • false
    false
    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
    Do encrypted transfers in FIPS-140-2-certified encryption mode When set to true, ascp will use a FIPS 140-2-certified encryption module. Note: When this feature is enabled, transfer start is delayed while the FIPS module is verified.
    • true
    • false
    false
  4. Validate aspera.conf

    When you have finished updating aspera.conf, run the following command to validate it:

    $ /opt/aspera/bin/asuserdata -b -v -a