Configuration Settings (aspera.conf)

Updating aspera.conf for Directory Creation

The async command uses aspera.conf settings to configure options such as connection timeouts, ACL and extended attributes preservation, and directory creation.

  1. Open aspera.conf
    OS Version File
    32-bit Windows C:\Program Files (x86)\Aspera\Enterprise Server\etc\aspera.conf
    64-bit Windows C:\Program Files\Aspera\Enterprise Server\etc\aspera.conf
    Note: On systems with Aspera Point-to-Point installed, replace "Enterprise Server" with "Point-to-Point" in the file path above.
  2. Add or locate the <file_system> and <default> sections.
    <file_system>
       ...	
       <directory_create_mode> </directory_create_mode> <!-- dir creation permissions -->
       <directory_create_grant_mask>755</directory_create_grant_mask> <!-- dir creation permissions -->
       <preserve_acls>none</preserve_acls> <!-- ACL storage format (native, metafile, or none) -->
       <preserve_xattrs>none</preserve_xattrs> <!-- XATTR storage format (native, metafile, or none) -->
       ...  
    </file_system>
       ...
    <default>
       ...
       <async_db_spec>  </async_db_spec>
       <async_connection_timeout>  </async_connection_timeout> <!-- no. of seconds to wait for connection -->
       <async_session_timeout>  </async_session_timeout> <!-- seconds to wait for session to resume -->
       <async_log_dir>/opt/aspera/var/log</async_log_dir> <!-- async log directory (absolute path) -->
       <async_log_level>disable</async_log_level> <!-- async log level (disable, log, dbg1, or dbg2) -->
       ...
    </default>
    

    Field Description Section Values Default
    <directory_create_mode> Specify the 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. <file_system> Positive integer (octal) undefined
    <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. <file_system> Positive integer (octal) 755
    <preserve_acls>

    Preserve the ACL access data from Windows or OSX files if the setting is native or metafile.

    If native, async expects that the destination supports the same native ACL format as the source; if the destination does not, async generates an error and exits.

    If metafile, async writes the access data to a separate file in the same location; the file has same name but with the added extension .aspera-meta. The data is in a generic format that can reside on any platform and also be reconverted to native form if the file is again synced with a system that supports it.

    If the setting is none, no ACL data is preserved at all.

    ACL preservation is only meaningful if both hosts are in the same domain. If a SID (security ID) in a source file does not exist at a destination, the sync proceeds but no ACL data is saved and the log records that the ACL could not be applied.

    These aspera.conf settings can be overwritten using the --preserve-acls=setting option on the async command line.

    <file_system> native, metafile, or none none
    <preserve_xattrs>

    Preserve OSX extended attributes data (xattr) if the setting is native or metafile.

    If native, async expects that the destination supports the same native xattr format as the source; if not, it generates an error and exits.

    If metafile, async writes the xattr data to a separate file in the same location; the file has the same name with the added extension .aspera-meta. The aspera-meta files are platform-independent and can be copied between hosts without loss of data. Their data can be reconverted to the native form if the file is again synced with an OSX system.

    If the setting is none, no xattr data is preserved at all. If the sync is run by a regular user, only user-level attributes are preserved. If run as superuser, all attributes are preserved.

    These aspera.conf settings can be overwritten using the --preserve-xattrs=setting option on the async command line.

    <file_system> native, metafile, or none none
    <async_db_spec>   <default>    
    <async_connection_timeout> The number of seconds async should wait for a connection to be established before terminating. <default> Positive integer 20
    <async_session_timeout> The number of seconds async should wait for a non-responsive session to resume before terminating. <default> Positive integer 20
  3. Validate aspera.conf

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

    Platform Command
    32-bit Windows
    "C:\Program Files\Aspera\Enterprise Server\bin\asuserdata" -b -v -a
    64-bit Windows
    "C:\Program Files (x86)\Aspera\Enterprise Server\bin\asuserdata" -b -v -a
    Note: On systems with Aspera Point-to-Point installed, replace "Enterprise Server" with "Point-to-Point" in the file path above.