User, Group and Default Configurations

General Syntax

This collection of commands configures settings for transfer authorization, bandwidth, and
encryption. These settings can apply to particular users, users in particular
groups, or globally to all users.

The URL of the external authorization provider for incoming transfers.

Values: (String)

authorization_transfer_out_external_provider_url

The URL of the external authorization provider for outgoing transfers.

Values: (String)

authorization_transfer_in_external_provider_soap_action

The SOAP action required by the external authorization provider for incoming
transfers.

Values: (String)

authorization_transfer_out_external_provider_soap_action

The SOAP action required by the external authorization provider for outgoing
transfers.

Values: (String)

token_encryption_type

The cipher used to generate encrypted authorization tokens.

Values: aes-128 (default), aes-192,
aes-256

token_encryption_key

The secret passphrase used to generate encrypted authorization tokens. Use
instead of token_encryption_keyfile.

Values: (String)

token_life_seconds

The length of time a token is valid in seconds. The default value is 86400
seconds (24 hours).

Values: (Number)

Transfer Bandwidth Policies

transfer_in_bandwidth_aggregate_trunk_id

The ID of the Vlink to apply to incoming transfers. A value of 0 disables
the Vlink.

Values: (Number 0-255)

transfer_out_bandwidth_aggregate_trunk_id

The ID of the Vlink to apply to outgoing transfers. A value of 0 disables
the Vlink.

Values: (Number 0-255)

transfer_in_bandwidth_flow_target_rate_cap

The maximum value to which the target rate for incoming transfers can be
set.

Values: (Number)

transfer_out_bandwidth_flow_target_rate_cap

The maximum value to which the target rate for outgoing transfers can be set
(in Kbps).

Values: (Number)

transfer_in_bandwidth_flow_target_rate_default

The default value to which the target rate for incoming transfers is set (in
Kbps).

Values: (Number)

transfer_out_bandwidth_flow_target_rate_default

The default value to which the target rate for outgoing transfers is set (in
Kbps).

Values: (Number)

transfer_in_bandwidth_flow_target_rate_lock

A value of false allows users to adjust the transfer rate for incoming
transfers. A value of true prevents users from adjusting the transfer rate
for incoming transfers.

Values: false (default), true

transfer_out_bandwidth_flow_target_rate_lock

A value of false allows users to adjust the transfer rate for outgoing
transfers. A value of true prevents users from adjusting the transfer rate
for outgoing transfers.

Values: false (default), true

transfer_in_bandwidth_flow_min_rate_cap

The maximum value to which the minimum rate for incoming transfers can be
set (in Kbps). Transfers cannot go slower than the minimum rate.

Values: (Number)

transfer_out_bandwidth_flow_min_rate_cap

The maximum value to which the minimum rate for outgoing transfers can be
set (in Kbps). Transfers cannot go slower than the minimum rate.

Values: (Number)

transfer_in_bandwidth_flow_min_rate_default

The default value to which the minimum rate for incoming transfers is set
(in Kbps). Transfers cannot go slower than the minimum rate.

Values: (Number)

transfer_out_bandwidth_flow_min_rate_default

The default value to which the minimum rate for outgoing transfers is set
(in Kbps). Transfers cannot go slower than the minimum rate.

Values: (Number)

transfer_in_bandwidth_flow_min_rate_lock

A value of false allows users to adjust the minimum rate for incoming
transfers. A value of true prevents users from adjusting the minimum rate
for incoming transfers.

Values: false (default), true

transfer_out_bandwidth_flow_min_rate_lock

A value of false allows users to adjust the minimum rate for outgoing
transfers. A value of true prevents users from adjusting the minimum rate
for outgoing transfers.

Values: false (default), true

transfer_in_bandwidth_flow_policy_default

The default bandwidth policy for incoming transfers. The bandwidth policy
determines how transfers adjust their rates according to network
conditions.

Values: fair (default), fixed, high, low

transfer_out_bandwidth_flow_policy_default

The default bandwidth policy for outgoing transfers. The bandwidth policy
determines how transfers adjust their rates according to network
conditions.

Values: fair (default), fixed, high, low

transfer_in_bandwidth_flow_policy_lock

A value of false allows users to adjust the bandwidth policy for incoming
transfers. A value of true prevents users from adjusting the bandwidth
policy for incoming transfers.

Values: false (default), true

transfer_out_bandwidth_flow_policy_lock

A value of false allows users to adjust the bandwidth policy for outgoing
transfers. A value of true prevents users from adjusting the bandwidth
policy for outgoing transfers.

Values: false (default), true

transfer_in_bandwidth_flow_policy_allowed

The allowed bandwidth policies for incoming transfers. The chosen value and
any policy less aggressive will be allowed. In order from most to least
aggressive the policies are fixed, high, fair and low.

Values: any (default), high, fair, low

transfer_out_bandwidth_flow_policy_allowed

The allowed bandwidth policies for outgoing transfers. The chosen value and
any policy less aggressive will be allowed. In order from most to least
aggressive the policies are fixed, high, fair and low.

Values: any (default), high, fair, low

Transfer Encryption

transfer_encryption_allowed_cipher

The type of transfer encryption accepted. When set to 'any' both encrypted
and unencrypted transfers are allowed.

Values: any (default), aes-128, aes-192, aes-256, none

transfer_encryption_fips_mode

Whether transfers should be encrypted with a FIPS 140-2 certified encryption
module.

Values: false (default), true

content_protection_required

Whether transferred content should be left encrypted at the
destination.

Values: false (default), true

content_protection_strong_pass_required

Whether a strong passphrase is required for content protection (6 characters
long, at least one letter, number and special symbol).

Values: false (default), true

Transfer File System Options

resume_suffix

The extension of files used to store metadata and enable resumption of
partially completed transfers. Include a '.' in the suffix, such as:
.aspera

Values: (String), default .aspx

preserve_attributes

The file creation policy. When set to none the timestamps
of source files are not preserved. When set to times the
timestamps of source files are preserved at the destination.

Values: use client setting (default), none, times

overwrite

Whether Aspera clients are allowed to overwrite existing files on the
server.

Values: allow (default), deny

file_manifest

A file manifest is a file containing a list of everything transferred in a
given transfer session. When set to text file manifests are
generated.

Values: none (default), text, disable

file_manifest_path

The location (path) where file manifests are created.

Values: (Absolute path)

pre_calculate_job_size

The policy of calculating total job size before a transfer. If set to
any, the client configuration is followed. If set to
no, job size calculation is disabled before
transferring.

Values: any (default), no, yes

replace_illegal_chars

Convert restricted Windows characters in file and directory names to a
non-reserved character of your choice.

Values: (Non-reserved character)

file_filters

Include or exclude files or directories with the specified pattern in the transfer. Add
multiple entries for more inclusion/exclusion patterns. To specify an
inclusion, add '+ ' (+ and whitespace) at the beginning of the pattern. To
specify an exclusion, add '- ' (- and whitespace) at the beginning of the
pattern.

Two symbols can be used in the setting of patterns:

*
(Asterisk) Represents zero to many characters in a string, for example,
*.tmp matches .tmp and abcde.tmp.

Extension to be added to the names of files that are currently only
partially transferred. Include a '.' in the suffix, such as:
.aspera

Values: (String)

file_checksum

Type of checksum to compute while reading a file. Checksums are used to
verify that file contents on the destination match what was read on the
destination.

Values: any (default), md5, sha1

async_enabled

Whether async is enabled on the server.

Values: true (default), false

async_connection_timeout

The time period async waits to establish a connection, in
seconds.

Values: (Number)

async_session_timeout

The time period async waits for an unresponsive session,
in seconds.

Values: (Number)

Document Root Options

absolute

The absolute path of the document root (docroot), which is the area of the
file system that is accessible by Aspera users.

Values: (Absolute path)

read_allowed

Whether users are allowed to transfer files from the docroot (in other
words, download from the docroot).

Values: true (default), false

write_allowed

Whether users are allowed to transfer files to the docroot (in other words,
upload to the docroot).

Values: true (default), false

dir_allowed

Whether users are allowed to browse files in the docroot.

Values: true (default), false

file_restriction

Restrict the files that are allowed for transfers. Restrictions are set as
wildcard templates. The first character is a separator (preferably a "|")
which can be used to set multiple restrictions. Restrictions are processed
in order and according to the following rules:

If a restriction starts with a "!", any files that match the rest of
the wildcard template are rejected.

If a restriction does not start with a "!", then any file that
matches is allowed