Skip to content

options ¤

Module for aria2c options.

This module defines the Options class, which holds information retrieved with the get_option or get_global_option methods of the client.

Classes:

  • Options –

    This class holds information retrieved with the get_option or get_global_option methods of the client.

Options ¤

Options(
    api: API, struct: dict, download: Download | None = None
)

This class holds information retrieved with the get_option or get_global_option methods of the client.

Instances are given a reference to an API instance to be able to change their values both locally and remotely, by using the API client and calling remote methods to change options.

The options are available with the same names, using underscores instead of dashes, except for "continue" (which is a Python reserved keyword) which is here called "continue_downloads". For example, "max-concurrent-downloads" is used like options.max_concurrent_downloads = 5.

Parameters:

  • api (API) –

    The reference to an API instance.

  • struct (dict) –

    A dictionary Python object returned by the JSON-RPC client.

  • download (Download | None, default: None ) –

    An optional Download object to inform about the owner, or None to tell they are global options.

Methods:

  • get –

    Get the value of an option given its name.

  • get_struct –

    Return a copy of the struct dictionary of this Options object.

  • set –

    Set the value of an option given its name.

Attributes:

Source code in src/aria2p/options.py 
32
33
34
35
36
37
38
39
40
41
42
43
def __init__(self, api: API, struct: dict, download: Download | None = None):
    """Initialize the object.

    Parameters:
        api: The reference to an [`API`][aria2p.api.API] instance.
        struct: A dictionary Python object returned by the JSON-RPC client.
        download: An optional [`Download`][aria2p.downloads.Download] object
            to inform about the owner, or None to tell they are global options.
    """
    self.api = api
    self.download = download
    self._struct = struct or {}

all_proxy property writable ¤

all_proxy: str

Return the all-proxy option value.

Use a proxy server for all protocols.

To override a previously defined proxy, use "". You also can override this setting and specify a proxy server for a particular protocol using --http-proxy, --https-proxy and --ftp-proxy options. This affects all downloads. The format of PROXY is [http://][USER:PASSWORD@]HOST[:PORT]. See also ENVIRONMENT section.

Note

If user and password are embedded in proxy URI and they are also specified by --{http,https,ftp, all}-proxy-{user,passwd} options, those specified later override prior options. For example, if you specified http-proxy-user=myname, http-proxy-passwd=mypass in aria2.conf and you specified --http-proxy="http://proxy" on the command-line, then you'd get HTTP proxy http://proxy with user myname and password mypass.

Another example: if you specified on the command-line --http-proxy="http://user:pass@proxy" --http-proxy-user="myname" --http-proxy-passwd="mypass", then you'd get HTTP proxy http://proxy with user myname and password mypass.

One more example: if you specified in command-line --http-proxy-user="myname" --http-proxy-passwd="mypass" --http-proxy="http://user:pass@proxy", then you'd get HTTP proxy http://proxy with user user and password pass.

Returns:

all_proxy_passwd property writable ¤

all_proxy_passwd: str

Return the all-proxy-passwd option value.

Set password for --all-proxy option.

Returns:

all_proxy_user property writable ¤

all_proxy_user: str

Return the all-proxy-user option value.

Set user for --all-proxy option.

Returns:

allow_overwrite property writable ¤

allow_overwrite: bool

Return the allow-overwrite option value.

Restart download from scratch if the corresponding control file doesn't exist.

See also --auto-file-renaming option. Default: false.

Returns:

allow_piece_length_change property writable ¤

allow_piece_length_change: bool

Return the allow-piece-length-change option value.

If false is given, aria2 aborts download when a piece length is different from one in a control file.

If true is given, you can proceed but some download progress will be lost. Default: false.

Returns:

always_resume property writable ¤

always_resume: bool

Return the always-resume option value.

Always resume download.

If true is given, aria2 always tries to resume download and if resume is not possible, aborts download. If false is given, when all given URIs do not support resume or aria2 encounters N URIs which does not support resume (N is the value specified using --max-resume-failure-tries option), aria2 downloads file from scratch. See --max-resume-failure-tries option. Default: true.

Returns:

are_global property ¤

are_global: bool

Tell if options are global, or tied to a Download object.

Returns:

  • bool –

    Whether these options are global.

async_dns property writable ¤

async_dns: bool

Return the async-dns option value.

Enable asynchronous DNS.

Default: True.

Returns:

async_dns_server property writable ¤

async_dns_server: list[str]

Return the async-dns-server option value.

Comma separated list of DNS server address used in asynchronous DNS resolver.

Usually asynchronous DNS resolver reads DNS server addresses from /etc/resolv.conf. When this option is used, it uses DNS servers specified in this option instead of ones in /etc/resolv.conf. You can specify both IPv4 and IPv6 address. This option is useful when the system does not have /etc/resolv.conf and user does not have the permission to create it.

Returns:

auto_file_renaming property writable ¤

auto_file_renaming: bool

Return the auto-file-renaming option value.

Rename file name if the same file already exists.

This option works only in HTTP(S)/FTP download. The new file name has a dot and a number(1..9999) appended after the name, but before the file extension, if any. Default: true.

Returns:

auto_save_interval property writable ¤

auto_save_interval: int

Save a control file (*.aria2) every SEC seconds.

If 0 is given, a control file is not saved during download. aria2 saves a control file when it stops regardless of the value. The possible values are between 0 to 600. Default: 60.

Returns:

bt_detach_seed_only property writable ¤

bt_detach_seed_only: bool

Return the bt-detach-seed-only option value.

Exclude seed only downloads when counting concurrent active downloads (See -j option).

This means that if -j3 is given and this option is turned on and 3 downloads are active and one of those enters seed mode, then it is excluded from active download count (thus it becomes 2), and the next download waiting in queue gets started. But be aware that seeding item is still recognized as active download in RPC method. Default: false.

Returns:

bt_enable_hook_after_hash_check property writable ¤

bt_enable_hook_after_hash_check: bool

Return the bt-enable-hook-after-hash-check option value.

Allow hook command invocation after hash check (see -V option) in BitTorrent download.

By default, when hash check succeeds, the command given by --on-bt-download-complete is executed. To disable this action, give false to this option. Default: true.

Returns:

bt_enable_lpd property writable ¤

bt_enable_lpd: bool

Return the bt-enable-lpd option value.

Enable Local Peer Discovery.

If a private flag is set in a torrent, aria2 doesn't use this feature for that download even if true is given. Default: false.

Returns:

bt_exclude_tracker property writable ¤

bt_exclude_tracker: list[str]

Return the bt-exclude-tracker option value.

Comma separated list of BitTorrent tracker's announce URI to remove.

You can use special value * which matches all URIs, thus removes all announce URIs. When specifying * in shell command-line, don't forget to escape or quote it. See also --bt-tracker option.

Returns:

bt_external_ip property writable ¤

bt_external_ip: str

Return the bt-external-ip option value.

Specify the external IP address to use in BitTorrent download and DHT.

It may be sent to BitTorrent tracker. For DHT, this option should be set to report that local node is downloading a particular torrent. This is critical to use DHT in a private network. Although this function is named external, it can accept any kind of IP addresses.

Returns:

bt_force_encryption property writable ¤

bt_force_encryption: bool

Return the bt-force-encryption option value.

Requires BitTorrent message payload encryption with arc4.

This is a shorthand of --bt-require-crypto --bt-min-crypto-level=arc4. This option does not change the option value of those options. If true is given, deny legacy BitTorrent handshake and only use Obfuscation handshake and always encrypt message payload. Default: false.

Returns:

bt_hash_check_seed property writable ¤

bt_hash_check_seed: bool

Return the bt-hash-check-seed option value.

If true is given, after hash check using --check-integrity option and file is complete, continue to seed file.

If you want to check file and download it only when it is damaged or incomplete, set this option to false. This option has effect only on BitTorrent download. Default: true

Returns:

bt_lpd_interface property writable ¤

bt_lpd_interface: str

Return the bt-lpd-interface option value.

Use given interface for Local Peer Discovery.

If this option is not specified, the default interface is chosen. You can specify interface name and IP address. Possible Values: interface, IP address.

Returns:

bt_max_open_files property writable ¤

bt_max_open_files: int

Return the bt-max-open-files option value.

Specify maximum number of files to open in multi-file BitTorrent/Metalink download globally.

Default: 100.

Returns:

bt_max_peers property writable ¤

bt_max_peers: int

Return the bt-max-peers option value.

Specify the maximum number of peers per torrent. 0 means unlimited.

See also --bt-request-peer-speed-limit option. Default: 55.

Returns:

bt_metadata_only property writable ¤

bt_metadata_only: bool

Return the bt-metadata-only option value.

Download meta data only.

The file(s) described in meta data will not be downloaded. This option has effect only when BitTorrent Magnet URI is used. See also --bt-save-metadata option. Default: false.

Returns:

bt_min_crypto_level property writable ¤

bt_min_crypto_level: str

Return the bt-min-crypto-level option value.

Set minimum level of encryption method (plain/arc4).

If several encryption methods are provided by a peer, aria2 chooses the lowest one which satisfies the given level. Default: plain.

Returns:

bt_prioritize_piece property writable ¤

bt_prioritize_piece: str

Return the bt-prioritize-piece option value.

Try to download first and last pieces of each file first (head[=<SIZE>],tail[=<SIZE>]).

This is useful for previewing files. The argument can contain 2 keywords: head and tail. To include both keywords, they must be separated by comma. These keywords can take one parameter, SIZE. For example, if head=<SIZE> is specified, pieces in the range of first SIZE bytes of each file get higher priority. tail=<SIZE> means the range of last SIZE bytes of each file. SIZE can include K or M (1K = 1024, 1M = 1024K). If SIZE is omitted, SIZE=1M is used.

Returns:

bt_remove_unselected_file property writable ¤

bt_remove_unselected_file: bool

Return the bt-remove-unselected-file option value.

Removes the unselected files when download is completed in BitTorrent.

To select files, use --select-file option. If it is not used, all files are assumed to be selected. Please use this option with care because it will actually remove files from your disk. Default: false.

Returns:

bt_request_peer_speed_limit property writable ¤

bt_request_peer_speed_limit: int

Return the bt-request-peer-speed-limit option value.

If the whole download speed of every torrent is lower than SPEED, aria2 temporarily increases the number of peers to try for more download speed.

Configuring this option with your preferred download speed can increase your download speed in some cases. You can append K or M (1K = 1024, 1M = 1024K). Default: 50K.

Returns:

bt_require_crypto property writable ¤

bt_require_crypto: bool

Return the bt-require-crypto option value.

If true is given, aria2 doesn't accept and establish connection with legacy BitTorrent handshake (BitTorrent protocol).

Thus aria2 always uses Obfuscation handshake. Default: false.

Returns:

bt_save_metadata property writable ¤

bt_save_metadata: bool

Return the bt-save-metadata option value.

Save meta data as ".torrent" file.

This option has effect only when BitTorrent Magnet URI is used. The file name is hex encoded info hash with suffix ".torrent". The directory to be saved is the same directory where download file is saved. If the same file already exists, meta data is not saved. See also --bt-metadata-only option. Default: false.

Returns:

bt_seed_unverified property writable ¤

bt_seed_unverified: bool

Return the bt-seed-unverified option value.

Seed previously downloaded files without verifying piece hashes.

Default: False.

Returns:

bt_stop_timeout property writable ¤

bt_stop_timeout: int

Return the bt-stop-timeout option value.

Stop BitTorrent download if download speed is 0 in consecutive SEC seconds.

If 0 is given, this feature is disabled. Default: 0.

Returns:

bt_tracker property writable ¤

bt_tracker: list[str]

Return the bt-tracker option value.

Comma separated list of additional BitTorrent tracker's announce URI.

These URIs are not affected by --bt-exclude-tracker option because they are added after URIs in --bt-exclude-tracker option are removed.

Returns:

bt_tracker_connect_timeout property writable ¤

bt_tracker_connect_timeout: int

Return the bt-tracker-connect-timeout option value.

Set the connect timeout in seconds to establish connection to tracker.

After the connection is established, this option makes no effect and --bt-tracker-timeout option is used instead. Default: 60.

Returns:

bt_tracker_interval property writable ¤

bt_tracker_interval: int

Return the bt-tracker-interval option value.

Set the interval in seconds between tracker requests.

This completely overrides interval value and aria2 just uses this value and ignores the min interval and interval value in the response of tracker. If 0 is set, aria2 determines interval based on the response of tracker and the download progress. Default: 0.

Returns:

bt_tracker_timeout property writable ¤

bt_tracker_timeout: int

Return the bt-tracker-timeout option value.

Set timeout in seconds.

Default: 60.

Returns:

ca_certificate property writable ¤

ca_certificate: str

Return the ca-certificate option value.

Use the certificate authorities in FILE to verify the peers.

The certificate file must be in PEM format and can contain multiple CA certificates. Use --check-certificate option to enable verification.

Note

If you build with OpenSSL or the recent version of GnuTLS which has gnutls_certificateset_x509_system_trust() function and the library is properly configured to locate the system-wide CA certificates store, aria2 will automatically load those certificates at the startup.

Note

WinTLS and AppleTLS do not support this option. Instead you will have to import the certificate into the OS trust store.

Returns:

certificate property writable ¤

certificate: str

Return the certificate option value.

Use the client certificate in FILE.

The certificate must be either in PKCS12 (.p12, .pfx) or in PEM format.

PKCS12 files must contain the certificate, a key and optionally a chain of additional certificates. Only PKCS12 files with a blank import password can be opened!

When using PEM, you have to specify the private key via --private-key as well.

Note

WinTLS does not support PEM files at the moment. Users have to use PKCS12 files.

Note

AppleTLS users should use the KeyChain Access utility to import the client certificate and get the SHA-1 fingerprint from the Information dialog corresponding to that certificate. To start aria2c use --certificate=<SHA-1>. Alternatively PKCS12 files are also supported. PEM files, however, are not supported.

Returns:

check_certificate property writable ¤

check_certificate: bool

Return the check-certificate option value.

Verify the peer using certificates specified in --ca-certificate option.

Default: True.

Returns:

check_integrity property writable ¤

check_integrity: bool

Return the check-integrity option value.

Check file integrity by validating piece hashes or a hash of entire file.

This option has effect only in BitTorrent, Metalink downloads with checksums or HTTP(S)/FTP downloads with --checksum option. If piece hashes are provided, this option can detect damaged portions of a file and re-download them. If a hash of entire file is provided, hash check is only done when file has been already downloaded. This is determined by file length. If hash check fails, file is re-downloaded from scratch. If both piece hashes and a hash of entire file are provided, only piece hashes are used. Default: false.

Returns:

checksum property writable ¤

checksum: str

Return the checksum option value.

Set checksum (<TYPE>=<DIGEST>).

TYPE is hash type. The supported hash type is listed in Hash Algorithms in aria2c -v. DIGEST is hex digest. For example, setting sha-1 digest looks like this: sha-1=0192ba11326fe2298c8cb4de616f4d4140213838 This option applies only to HTTP(S)/FTP downloads.

Returns:

conditional_get property writable ¤

conditional_get: bool

Return the conditional-get option value.

Download file only when the local file is older than remote file.

This function only works with HTTP(S) downloads only. It does not work if file size is specified in Metalink. It also ignores Content-Disposition header. If a control file exists, this option will be ignored. This function uses If-Modified-Since header to get only newer file conditionally. When getting modification time of local file, it uses user supplied file name (see --out option) or file name part in URI if --out is not specified. To overwrite existing file, --allow-overwrite is required. Default: false.

Returns:

conf_path property writable ¤

conf_path: str

Return the conf-path option value.

Change the configuration file path to PATH.

Default: $HOME/.aria2/aria2.conf if present, otherwise $XDG_CONFIG_HOME/aria2/aria2.conf.

Returns:

connect_timeout property writable ¤

connect_timeout: int

Return the connect-timeout option value.

Set the connect timeout in seconds to establish connection to HTTP/FTP/proxy server.

After the connection is established, this option makes no effect and --timeout option is used instead. Default: 60.

Returns:

console_log_level property writable ¤

console_log_level: str

Return the console-log-level option value.

Set log level to output to console.

LEVEL is either debug, info, notice, warn or error. Default: notice.

Returns:

continue_downloads property writable ¤

continue_downloads: bool

Return the continue-downloads option value.

Continue downloading a partially downloaded file.

Use this option to resume a download started by a web browser or another program which downloads files sequentially from the beginning. Currently this option is only applicable to HTTP(S)/FTP downloads.

Returns:

daemon property writable ¤

daemon: bool

Return the daemon option value.

Run as daemon.

The current working directory will be changed to / and standard input, standard output and standard error will be redirected to /dev/null. Default: false.

Returns:

deferred_input property writable ¤

deferred_input: bool

Return the deferred-input option value.

If true is given, aria2 does not read all URIs and options from file specified by --input-file option at startup, but it reads one by one when it needs later.

This may reduce memory usage if input file contains a lot of URIs to download. If false is given, aria2 reads all URIs and options at startup. Default: false.

Warning

--deferred-input option will be disabled when --save-session is used together.

Returns:

dht_entry_point property writable ¤

dht_entry_point: str

Return the dht-entry-point option value.

Set host and port as an entry point to IPv4 DHT network (<HOST>:<PORT>).

Returns:

dht_entry_point6 property writable ¤

dht_entry_point6: str

Return the dht-entry-point6 option value.

Set host and port as an entry point to IPv6 DHT network (<HOST>:<PORT>).

Returns:

dht_file_path property writable ¤

dht_file_path: str

Return the dht-file-path option value.

Change the IPv4 DHT routing table file to PATH.

Default: $HOME/.aria2/dht.dat if present, otherwise $XDG_CACHE_HOME/aria2/dht.dat.

Returns:

dht_file_path6 property writable ¤

dht_file_path6: str

Return the dht-file-path6 option value.

Change the IPv6 DHT routing table file to PATH.

Default: $HOME/.aria2/dht6.dat if present, otherwise $XDG_CACHE_HOME/aria2/dht6.dat.

Returns:

dht_listen_addr6 property writable ¤

dht_listen_addr6: str

Return the dht-listen-addr6 option value.

Specify address to bind socket for IPv6 DHT.

It should be a global unicast IPv6 address of the host.

Returns:

dht_listen_port property writable ¤

dht_listen_port: str

Return the dht-listen-port option value.

Set UDP listening port used by DHT(IPv4, IPv6) and UDP tracker.

Multiple ports can be specified by using ,, for example: 6881,6885. You can also use - to specify a range: 6881-6999. , and - can be used together. Default: 6881-6999.

Note

Make sure that the specified ports are open for incoming UDP traffic.

Returns:

dht_message_timeout property writable ¤

dht_message_timeout: int

Return the dht-message-timeout option value.

Set timeout in seconds.

Default: 10.

Returns:

dir property writable ¤

dir: str

Return the dir option value.

The directory to store the downloaded file.

Returns:

disable_ipv6 property writable ¤

disable_ipv6: bool

Return the disable-ipv6 option value.

Disable IPv6.

This is useful if you have to use broken DNS and want to avoid terribly slow AAAA record lookup. Default: false.

Returns:

disk_cache property writable ¤

disk_cache: int

Return the disk-cache option value.

Enable disk cache.

If SIZE is 0, the disk cache is disabled. This feature caches the downloaded data in memory, which grows to at most SIZE bytes. The cache storage is created for aria2 instance and shared by all downloads. The one advantage of the disk cache is reduce the disk I/O because the data are written in larger unit and it is reordered by the offset of the file. If hash checking is involved and the data are cached in memory, we don't need to read them from the disk. SIZE can include K or M (1K = 1024, 1M = 1024K). Default: 16M.

Returns:

download_result property writable ¤

download_result: str

Return the download-result option value.

This option changes the way Download Results is formatted.

If OPT is default, print GID, status, average download speed and path/URI. If multiple files are involved, path/URI of first requested file is printed and remaining ones are omitted. If OPT is full, print GID, status, average download speed, percentage of progress and path/URI. The percentage of progress and path/URI are printed for each requested file in each row. If OPT is hide, Download Results is hidden. Default: default.

Returns:

dry_run property writable ¤

dry_run: bool

Return the dry-run option value.

If true is given, aria2 just checks whether the remote file is available and doesn't download data.

This option has effect on HTTP/FTP download. BitTorrent downloads are canceled if true is specified. Default: false.

Returns:

dscp property writable ¤

dscp: str

Return the dscp option value.

Set DSCP value in outgoing IP packets of BitTorrent traffic for QoS.

This parameter sets only DSCP bits in TOS field of IP packets, not the whole field. If you take values from /usr/include/netinet/ip.h divide them by 4 (otherwise values would be incorrect, e.g. your CS1 class would turn into CS4). If you take commonly used values from RFC, network vendors' documentation, Wikipedia or any other source, use them as they are.

Returns:

enable_color property writable ¤

enable_color: bool

Return the enable-color option value.

Enable color output for a terminal.

Default: True.

Returns:

enable_dht property writable ¤

enable_dht: bool

Return the enable-dht option value.

Enable IPv4 DHT functionality.

It also enables UDP tracker support. If a private flag is set in a torrent, aria2 doesn't use DHT for that download even if true is given. Default: true.

Returns:

enable_dht6 property writable ¤

enable_dht6: bool

Return the enable-dht6 option value.

Enable IPv6 DHT functionality.

If a private flag is set in a torrent, aria2 doesn't use DHT for that download even if true is given. Use --dht-listen-port option to specify port number to listen on. See also --dht-listen-addr6 option.

Returns:

enable_http_keep_alive property writable ¤

enable_http_keep_alive: bool

Return the enable-http-keep-alive option value.

Enable HTTP/1.1 persistent connection.

Default: True.

Returns:

enable_http_pipelining property writable ¤

enable_http_pipelining: bool

Return the enable-http-pipelining option value.

Enable HTTP/1.1 pipelining.

Default: False.

Note

In performance perspective, there is usually no advantage to enable this option.

Returns:

enable_mmap property writable ¤

enable_mmap: bool

Return the enable-mmap option value.

Map files into memory.

This option may not work if the file space is not pre-allocated. See --file-allocation. Default: false.

Returns:

enable_peer_exchange property writable ¤

enable_peer_exchange: bool

Return the enable-peer-exchange option value.

Enable Peer Exchange extension.

If a private flag is set in a torrent, this feature is disabled for that download even if true is given. Default: True.

Returns:

enable_rpc property writable ¤

enable_rpc: bool

Return the enable-rpc option value.

Enable JSON-RPC/XML-RPC server.

It is strongly recommended to set secret authorization token using --rpc-secret option. See also --rpc-listen-port option. Default: false

Returns:

event_poll property writable ¤

event_poll: str

Specify the method for polling events.

The possible values are epoll, kqueue, port, poll and select. For each epoll, kqueue, port and poll, it is available if system supports it. epoll is available on recent Linux. kqueue is available on various *BSD systems including Mac OS X. port is available on Open Solaris. The default value may vary depending on the system you use.

Returns:

file_allocation property writable ¤

file_allocation: str

Return the file-allocation option value.

Specify file allocation method.

Possible Values: none, prealloc, trunc, falloc.

  • none: Doesn't pre-allocate file space.

  • prealloc: Pre-allocates file space before download begins. This may take some time depending on the size of the file.

  • falloc: If you are using newer file systems such as ext4 (with extents support), btrfs, xfs or NTFS(MinGW build only), falloc is your best choice. It allocates large(few GiB) files almost instantly. Don't use falloc with legacy file systems such as ext3 and FAT32 because it takes almost same time as prealloc and it blocks aria2 entirely until allocation finishes. falloc may not be available if your system doesn't have posix_fallocate(3) function.

  • trunc: Uses ftruncate(2) system call or platform-specific counterpart to truncate a file to a specified length.

Default: prealloc.

Warning

Using trunc seemingly allocates disk space very quickly, but what it actually does is that it sets file length metadata in file system, and does not allocate disk space at all. This means that it does not help avoiding fragmentation.

Note

In multi file torrent downloads, the files adjacent forward to the specified files are also allocated if they share the same piece.

Returns:

follow_metalink: str

Return the follow-metalink option value.

If true or mem is specified, when a file whose suffix is .meta4 or .metalink or content type of application/metalink4+xml or application/metalink+xml is downloaded, aria2 parses it as a metalink file and downloads files mentioned in it.

If mem is specified, a metalink file is not written to the disk, but is just kept in memory. If false is specified, the .metalink file is downloaded to the disk, but is not parsed as a metalink file and its contents are not downloaded. Default: true.

Returns:

follow_torrent property writable ¤

follow_torrent: str

Return the follow-torrent option value.

If true or mem is specified, when a file whose suffix is .torrent or content type is application/x-bittorrent is downloaded, aria2 parses it as a torrent file and downloads files mentioned in it.

If mem is specified, a torrent file is not written to the disk, but is just kept in memory. If false is specified, the .torrent file is downloaded to the disk, but is not parsed as a torrent and its contents are not downloaded. Default: true.

Returns:

force_save property writable ¤

force_save: bool

Return the force-save option value.

Save download with --save-session option even if the download is completed or removed.

This option also saves control file in that situations. This may be useful to save BitTorrent seeding which is recognized as completed state. Default: false.

Returns:

force_sequential property writable ¤

force_sequential: bool

Return the force-sequential option value.

Fetch URIs in the command-line sequentially and download each URI in a separate session, like the usual command-line download utilities.

Default: False.

Returns:

ftp_passwd property writable ¤

ftp_passwd: str

Return the ftp-passwd option value.

Set FTP password. This affects all URIs.

If user name is embedded but password is missing in URI, aria2 tries to resolve password using .netrc. If password is found in .netrc, then use it as password. If not, use the password specified in this option. Default: ARIA2USER@.

Returns:

ftp_pasv property writable ¤

ftp_pasv: bool

Return the ftp-pasv option value.

Use the passive mode in FTP.

If false is given, the active mode will be used. Default: true.

Note

This option is ignored for SFTP transfer.

Returns:

ftp_proxy property writable ¤

ftp_proxy: str

Return the ftp-proxy option value.

Use a proxy server for FTP.

To override a previously defined proxy, use "". See also the --all-proxy option. This affects all ftp downloads. The format of PROXY is [http://][USER:PASSWORD@]HOST[:PORT].

Returns:

ftp_proxy_passwd property writable ¤

ftp_proxy_passwd: str

Return the ftp-proxy-passwd option value.

Set password for --ftp-proxy option.

Returns:

ftp_proxy_user property writable ¤

ftp_proxy_user: str

Return the ftp-proxy-user option value.

Set user for --ftp-proxy option.

Returns:

ftp_reuse_connection property writable ¤

ftp_reuse_connection: bool

Return the ftp-reuse-connection option value.

Reuse connection in FTP.

Default: True.

Returns:

ftp_type property writable ¤

ftp_type: str

Return the ftp-type option value.

Set FTP transfer type.

TYPE is either binary or ascii. Default: binary.

Note

This option is ignored for SFTP transfer.

Returns:

ftp_user property writable ¤

ftp_user: str

Return the ftp-user option value.

Set FTP user. This affects all URIs.

Default: anonymous.

Returns:

gid property writable ¤

gid: str

Return the gid option value.

Set GID manually.

aria2 identifies each download by the ID called GID. The GID must be hex string of 16 characters, thus [0-9a-zA-Z] are allowed and leading zeros must not be stripped. The GID all 0 is reserved and must not be used. The GID must be unique, otherwise error is reported and the download is not added. This option is useful when restoring the sessions saved using --save-session option. If this option is not used, new GID is generated by aria2.

Returns:

hash_check_only property writable ¤

hash_check_only: bool

Return the hash-check-only option value.

If true is given, after hash check using --check-integrity option, abort download whether or not download is complete.

Default: False.

Returns:

header property writable ¤

header: str

Return the header option value.

Append HEADER to HTTP request header.

You can use this option repeatedly to specify more than one header:

$ aria2c --header="X-A: b78" --header="X-B: 9J1" "http://host/file"

Returns:

http_accept_gzip property writable ¤

http_accept_gzip: bool

Return the http-accept-gzip option value.

Send Accept: deflate, gzip request header and inflate response if remote server responds with Content-Encoding: gzip or Content-Encoding: deflate.

Default: False.

Note

Some server responds with Content-Encoding: gzip for files which itself is gzipped file. aria2 inflates them anyway because of the response header.

Returns:

http_auth_challenge property writable ¤

http_auth_challenge: bool

Return the http-auth-challenge option value.

Send HTTP authorization header only when it is requested by the server.

If false is set, then authorization header is always sent to the server. There is an exception: if user name and password are embedded in URI, authorization header is always sent to the server regardless of this option. Default: false.

Returns:

http_no_cache property writable ¤

http_no_cache: bool

Return the http-no-cache option value.

Send Cache-Control: no-cache and Pragma: no-cache header to avoid cached content.

If false is given, these headers are not sent and you can add Cache-Control header with a directive you like using --header option. Default: false.

Returns:

http_passwd property writable ¤

http_passwd: str

Return the http-passwd option value.

Set HTTP password. This affects all URIs.

Returns:

http_proxy property writable ¤

http_proxy: str

Return the http-proxy option value.

Use a proxy server for HTTP.

To override a previously defined proxy, use "". See also the --all-proxy option. This affects all http downloads. The format of PROXY is [http://][USER:PASSWORD@]HOST[:PORT].

Returns:

http_proxy_passwd property writable ¤

http_proxy_passwd: str

Return the http-proxy-passwd option value.

Set password for --http-proxy.

Returns:

http_proxy_user property writable ¤

http_proxy_user: str

Return the http-proxy-user option value.

Set user for --http-proxy.

Returns:

http_user property writable ¤

http_user: str

Return the http-user option value.

Set HTTP user. This affects all URIs.

Returns:

https_proxy property writable ¤

https_proxy: str

Return the https-proxy option value.

Use a proxy server for HTTPS.

To override a previously defined proxy, use "". See also the --all-proxy option. This affects all https download. The format of PROXY is [http://][USER:PASSWORD@]HOST[:PORT].

Returns:

https_proxy_passwd property writable ¤

https_proxy_passwd: str

Return the https-proxy-passwd option value.

Set password for --https-proxy.

Returns:

https_proxy_user property writable ¤

https_proxy_user: str

Return the https-proxy-user option value.

Set user for --https-proxy.

Returns:

human_readable property writable ¤

human_readable: bool

Return the human-readable option value.

Print sizes and speed in human readable format (e.g., 1.2Ki, 3.4Mi) in the console readout.

Default: True.

Returns:

index_out property writable ¤

index_out: str

Return the index-out option value.

Set file path for file with index=INDEX (<INDEX>=<PATH>).

You can find the file index using the --show-files option. PATH is a relative path to the path specified in --dir option. You can use this option multiple times. Using this option, you can specify the output file names of BitTorrent downloads.

Returns:

input_file property writable ¤

input_file: str

Return the input-file option value.

Downloads the URIs listed in FILE.

You can specify multiple sources for a single entity by putting multiple URIs on a single line separated by the TAB character. Additionally, options can be specified after each URI line. Option lines must start with one or more white space characters (SPACE or TAB) and must only contain one option per line. Input files can use gzip compression. When FILE is specified as -, aria2 will read the input from stdin. See the Input File subsection for details. See also the --deferred-input option. See also the --save-session option.

Returns:

interface property writable ¤

interface: str

Return the interface option value.

Bind sockets to given interface.

You can specify interface name, IP address and host name. Possible Values: interface, IP address, host name.

Note

If an interface has multiple addresses, it is highly recommended to specify IP address explicitly. See also --disable-ipv6. If your system doesn't have getifaddrs(3), this option doesn't accept interface name.

Returns:

keep_unfinished_download_result property writable ¤

keep_unfinished_download_result: bool

Return the keep-unfinished-download-result option value.

Keep unfinished download results even if doing so exceeds --max-download-result.

This is useful if all unfinished downloads must be saved in session file (see --save-session option). Please keep in mind that there is no upper bound to the number of unfinished download result to keep. If that is undesirable, turn this option off. Default: true.

Returns:

listen_port property writable ¤

listen_port: str

Return the listen-port option value.

Set TCP port number for BitTorrent downloads.

Multiple ports can be specified by using, for example: 6881,6885. You can also use - to specify a range: 6881-6999. , and - can be used together: 6881-6889, 6999. Default: 6881-6999

Note

Make sure that the specified ports are open for incoming TCP traffic.

Returns:

load_cookies property writable ¤

load_cookies: str

Return the load-cookies option value.

Load Cookies from FILE using the Firefox3 format (SQLite3), Chromium/Google Chrome (SQLite3) and the Mozilla/Firefox(1.x/2.x)/Netscape format.

Note

If aria2 is built without libsqlite3, then it doesn't support Firefox3 and Chromium/Google Chrome cookie format.

Returns:

log property writable ¤

log: str

Return the log option value.

The file name of the log file.

If - is specified, log is written to stdout. If empty string("") is specified, or this option is omitted, no log is written to disk at all.

Returns:

log_level property writable ¤

log_level: str

Return the log-level option value.

Set log level to output.

LEVEL is either debug, info, notice, warn or error. Default: debug.

Returns:

lowest_speed_limit property writable ¤

lowest_speed_limit: int

Return the lowest-speed-limit option value.

Close connection if download speed is lower than or equal to this value(bytes per sec).

0 means aria2 does not have a lowest speed limit. You can append K or M (1K = 1024, 1M = 1024K). This option does not affect BitTorrent downloads. Default: 0.

Returns:

max_concurrent_downloads property writable ¤

max_concurrent_downloads: int

Return the max-concurrent-downloads option value.

Set the maximum number of parallel downloads for every queue item.

See also the --split option. Default: 5.

Returns:

max_connection_per_server property writable ¤

max_connection_per_server: int

Return the max-connection-per-server option value.

The maximum number of connections to one server for each download.

Default: 1.

Returns:

max_download_limit property writable ¤

max_download_limit: int

Return the max-download-limit option value.

Set max download speed per each download in bytes/sec.

0 means unrestricted. You can append K or M (1K = 1024, 1M = 1024K). To limit the overall download speed, use --max-overall-download-limit option. Default: 0.

Returns:

max_download_result property writable ¤

max_download_result: int

Return the max-download-result option value.

Set maximum number of download result kept in memory.

The download results are completed/error/removed downloads. The download results are stored in FIFO queue and it can store at most NUM download results. When queue is full and new download result is created, oldest download result is removed from the front of the queue and new one is pushed to the back. Setting big number in this option may result high memory consumption after thousands of downloads. Specifying 0 means no download result is kept. Note that unfinished downloads are kept in memory regardless of this option value. See --keep-unfinished-download-result option. Default: 1000.

Returns:

max_file_not_found property writable ¤

max_file_not_found: int

Return the max-file-not-found option value.

If aria2 receives "file not found" status from the remote HTTP/FTP servers NUM times without getting a single byte, then force the download to fail.

Specify 0 to disable this option. This options is effective only when using HTTP/FTP servers. The number of retry attempt is counted toward --max-tries, so it should be configured too.

Default: 0.

Returns:

max_mmap_limit property writable ¤

max_mmap_limit: int

Return the max-mmap-limit option value.

Set the maximum file size to enable mmap (see --enable-mmap option).

The file size is determined by the sum of all files contained in one download. For example, if a download contains 5 files, then file size is the total size of those files. If file size is strictly greater than the size specified in this option, mmap will be disabled. Default: 9223372036854775807.

Returns:

max_overall_download_limit property writable ¤

max_overall_download_limit: int

Return the max-overall-download-limit option value.

Set max overall download speed in bytes/sec.

0 means unrestricted. You can append K or M (1K = 1024, 1M = 1024K). To limit the download speed per download, use --max-download-limit option. Default: 0.

Returns:

max_overall_upload_limit property writable ¤

max_overall_upload_limit: int

Return the max-overall-upload-limit option value.

Set max overall upload speed in bytes/sec.

0 means unrestricted. You can append K or M (1K = 1024, 1M = 1024K). To limit the upload speed per torrent, use --max-upload-limit option. Default: 0.

Returns:

max_resume_failure_tries property writable ¤

max_resume_failure_tries: int

Return the max-resume-failure-tries option value.

When used with --always-resume=false, aria2 downloads file from scratch when aria2 detects N number of URIs that does not support resume.

If N is 0, aria2 downloads file from scratch when all given URIs do not support resume. See --always-resume option. Default: 0.

Returns:

max_tries property writable ¤

max_tries: int

Return the max-tries option value.

Set number of tries.

0 means unlimited. See also --retry-wait. Default: 5.

Returns:

max_upload_limit property writable ¤

max_upload_limit: int

Return the max-upload-limit option value.

Set max upload speed per each torrent in bytes/sec.

0 means unrestricted. You can append K or M (1K = 1024, 1M = 1024K). To limit the overall upload speed, use --max-overall-upload-limit option. Default: 0.

Returns:

metalink_base_uri: str

Return the metalink-base-uri option value.

Specify base URI to resolve relative URI in metalink:url and metalink:metaurl element in a metalink file stored in local disk.

If URI points to a directory, URI must end with /.

Returns:

metalink_enable_unique_protocol: bool

Return the metalink-enable-unique-protocol option value.

If true is given and several protocols are available for a mirror in a metalink file, aria2 uses one of them.

Use --metalink-preferred-protocol option to specify the preference of protocol. Default: true.

Returns:

metalink_file: str

Return the metalink-file option value.

The file path to ".meta4" and ".metalink" file.

Reads input from stdin when - is specified. You are not required to use this option because you can specify ".metalink" files without --metalink-file.

Returns:

metalink_language: str

Return the metalink-language option value.

The language of the file to download.

Returns:

metalink_location: list[str]

Return the metalink-location option value.

The location of the preferred server.

A comma-delimited list of locations is acceptable, for example, jp,us.

Returns:

metalink_os: str

Return the metalink-os option value.

The operating system of the file to download.

Returns:

metalink_preferred_protocol: str

Return the metalink-preferred-protocol option value.

Specify preferred protocol.

The possible values are http, https, ftp and none. Specify none to disable this feature. Default: none.

Returns:

metalink_version: str

Return the metalink-version option value.

The version of the file to download.

Returns:

min_split_size property writable ¤

min_split_size: int

Return the min-split-size option value.

aria2 does not split less than 2*SIZE byte range.

For example, let's consider downloading 20MiB file. If SIZE is 10M, aria2 can split file into 2 range [ 0-10MiB) and [10MiB-20MiB) and download it using 2 sources(if --split >= 2, of course). If SIZE is 15M, since 2*15M > 20MiB, aria2 does not split file and download it using 1 source. You can append K or M (1K = 1024, 1M = 1024K). Possible Values: 1M -1024M Default: 20M

Returns:

min_tls_version property writable ¤

min_tls_version: str

Return the min-tls-version option value.

Specify minimum SSL/TLS version to enable.

Possible Values: SSLv3, TLSv1, TLSv1.1, TLSv1.2. Default: TLSv1.

Returns:

multiple_interface property writable ¤

multiple_interface: list[str]

Return the multiple-interface option value.

Comma separated list of interfaces to bind sockets to.

Requests will be split among the interfaces to achieve link aggregation. You can specify interface name, IP address and hostname. If --interface is used, this option will be ignored. Possible Values: interface, IP address, hostname.

Returns:

netrc_path property writable ¤

netrc_path: str

Return the netrc-path option value.

Specify the path to the netrc file.

Default: $(HOME)/.netrc.

Note

Permission of the .netrc file must be 600. Otherwise, the file will be ignored.

Returns:

no_conf property writable ¤

no_conf: bool

Return the no-conf option value.

Disable loading aria2.conf file.

Returns:

no_file_allocation_limit property writable ¤

no_file_allocation_limit: int

Return the no-file-allocation-limit option value.

No file allocation is made for files whose size is smaller than SIZE.

You can append K or M (1K = 1024, 1M = 1024K). Default: 5M.

Returns:

no_netrc property writable ¤

no_netrc: bool

Return the no-netrc option value.

Disable netrc support.

netrc support is enabled by default.

Note

netrc file is only read at the startup if --no-netrc is false. So if --no-netrc is true at the startup, no netrc is available throughout the session. You cannot get netrc enabled even if you send --no-netrc=false using aria2.changeGlobalOption().

Returns:

no_proxy property writable ¤

no_proxy: str

Return the no-proxy option value.

Specify a comma separated list of host names, domains and network addresses with or without a subnet mask where no proxy should be used.

Note

For network addresses with a subnet mask, both IPv4 and IPv6 addresses work. The current implementation does not resolve the host name in an URI to compare network addresses specified in --no-proxy. So it is only effective if URI has numeric IP addresses.

Returns:

on_bt_download_complete property writable ¤

on_bt_download_complete: str

Return the on-bt-download-complete option value.

For BitTorrent, a command specified in --on-download-complete is called after download completed and seeding is over.

On the other hand, this option set the command to be executed after download completed but before seeding. See Event Hook for more details about COMMAND. Possible Values: /path/to/command.

Returns:

on_download_complete property writable ¤

on_download_complete: str

Return the on-download-complete option value.

Set the command to be executed after download completed.

See See Event Hook for more details about COMMAND. See also --on-download-stop option. Possible Values: /path/to/command.

Returns:

on_download_error property writable ¤

on_download_error: str

Return the on-download-error option value.

Set the command to be executed after download aborted due to error.

See Event Hook for more details about COMMAND. See also --on-download-stop option. Possible Values: /path/to/command.

Returns:

on_download_pause property writable ¤

on_download_pause: str

Return the on-download-pause option value.

Set the command to be executed after download was paused.

See Event Hook for more details about COMMAND. Possible Values: /path/to/command.

Returns:

on_download_start property writable ¤

on_download_start: str

Return the on-download-start option value.

Set the command to be executed after download got started.

See Event Hook for more details about COMMAND. Possible Values: /path/to/command.

Returns:

on_download_stop property writable ¤

on_download_stop: str

Return the on-download-stop option value.

Set the command to be executed after download stopped.

You can override the command to be executed for particular download result using --on-download-complete and --on-download-error. If they are specified, command specified in this option is not executed. See Event Hook for more details about COMMAND. Possible Values: /path/to/command.

Returns:

optimize_concurrent_downloads property writable ¤

optimize_concurrent_downloads: str

Return the optimize-concurrent-downloads option value.

Optimizes the number of concurrent downloads according to the bandwidth available (true|false|<A>:<B>).

aria2 uses the download speed observed in the previous downloads to adapt the number of downloads launched in parallel according to the rule N = A + B Log10(speed in Mbps). The coefficients A and B can be customized in the option arguments with A and B separated by a colon. The default values (A=5, B=25) lead to using typically 5 parallel downloads on 1Mbps networks and above 50 on 100Mbps networks. The number of parallel downloads remains constrained under the maximum defined by the --max-concurrent-downloads parameter. Default: false.

Returns:

out property writable ¤

out: str

Return the out option value.

The file name of the downloaded file.

It is always relative to the directory given in --dir option. When the --force-sequential option is used, this option is ignored.

Note

You cannot specify a file name for Metalink or BitTorrent downloads. The file name specified here is only used when the URIs fed to aria2 are given on the command line directly, but not when using --input-file, --force-sequential option.

aria2c -o myfile.zip "http://mirror1/file.zip" "http://mirror2/file.zip"

Returns:

parameterized_uri property writable ¤

parameterized_uri: bool

Return the parameterized-uri option value.

Enable parameterized URI support.

You can specify set of parts: http://{sv1,sv2,sv3}/foo.iso. Also you can specify numeric sequences with step counter: http://host/image[000-100:2].img. A step counter can be omitted. If all URIs do not point to the same file, such as the second example above, -Z option is required. Default: false.

Returns:

pause property writable ¤

pause: bool

Return the pause option value.

Pause download after added.

This option is effective only when --enable-rpc=true is given. Default: false.

Returns:

pause_metadata property writable ¤

pause_metadata: bool

Return the pause-metadata option value.

Pause downloads created as a result of metadata download.

There are 3 types of metadata downloads in aria2: (1) downloading .torrent file. (2) downloading torrent metadata using magnet link. (3) downloading metalink file. These metadata downloads will generate downloads using their metadata. This option pauses these subsequent downloads. This option is effective only when --enable-rpc=true is given. Default: false.

Returns:

peer_id_prefix property writable ¤

peer_id_prefix: str

Return the peer-id-prefix option value.

Specify the prefix of peer ID.

The peer ID in BitTorrent is 20 byte length. If more than 20 bytes are specified, only first 20 bytes are used. If less than 20 bytes are specified, random byte data are added to make its length 20 bytes.

Default: A2-$MAJOR-$MINOR-$PATCH-, $MAJOR, $MINOR and $PATCH are replaced by major, minor and patch version number respectively. For instance, aria2 version 1.18.8 has prefix ID A2-1-18-8-.

Returns:

piece_length property writable ¤

piece_length: str

Return the piece-length option value.

Set a piece length for HTTP/FTP downloads.

This is the boundary when aria2 splits a file. All splits occur at multiple of this length. This option will be ignored in BitTorrent downloads. It will be also ignored if Metalink file contains piece hashes. Default: 1M.

Note

The possible use case of --piece-length option is change the request range in one HTTP pipelined request. To enable HTTP pipelining use --enable-http-pipelining.

Returns:

private_key property writable ¤

private_key: str

Return the private-key option value.

Use the private key in FILE.

The private key must be decrypted and in PEM format. The behavior when encrypted one is given is undefined. See also --certificate option.

Returns:

proxy_method property writable ¤

proxy_method: str

Return the proxy-method option value.

Set the method to use in proxy request.

METHOD is either get or tunnel. HTTPS downloads always use tunnel regardless of this option. Default: get

Returns:

quiet property writable ¤

quiet: bool

Return the quiet option value.

Make aria2 quiet (no console output).

Default: False.

Returns:

realtime_chunk_checksum property writable ¤

realtime_chunk_checksum: bool

Return the realtime-chunk-checksum option value.

Validate chunk of data by calculating checksum while downloading a file if chunk checksums are provided.

Default: True.

Returns:

referer property writable ¤

referer: str

Return the referer option value.

Set an http referrer (Referer).

This affects all http/https downloads. If * is given, the download URI is also used as the referrer. This may be useful when used together with the --parameterized-uri option.

Returns:

remote_time property writable ¤

remote_time: bool

Return the remote-time option value.

Retrieve timestamp of the remote file from the remote HTTP/FTP server and if it is available, apply it to the local file.

Default: False.

Returns:

remove_control_file property writable ¤

remove_control_file: bool

Return the remove-control-file option value.

Remove control file before download.

Using with --allow-overwrite=true, download always starts from scratch. This will be useful for users behind proxy server which disables resume.

Returns:

retry_wait property writable ¤

retry_wait: int

Return the retry-wait option value.

Set the seconds to wait between retries.

When SEC >` 0, aria2 will retry downloads when the HTTP server returns a 503 response. Default: 0.

Returns:

reuse_uri property writable ¤

reuse_uri: bool

Return the reuse-uri option value.

Reuse already used URIs if no unused URIs are left.

Default: True.

Returns:

rlimit_nofile property writable ¤

rlimit_nofile: int

Return the rlimit-nofile option value.

Set the soft limit of open file descriptors.

This open will only have effect when:

a. The system supports it (posix)

b. The limit does not exceed the hard limit.

c. The specified limit is larger than the current soft limit.

This is equivalent to setting nofile via ulimit, except that it will never decrease the limit.

This option is only available on systems supporting the rlimit API.

Returns:

rpc_allow_origin_all property writable ¤

rpc_allow_origin_all: bool

Return the rpc-allow-origin-all option value.

Add Access-Control-Allow-Origin header field with value * to the RPC response.

Default: False.

Returns:

rpc_certificate property writable ¤

rpc_certificate: str

Return the rpc-certificate option value.

Use the certificate in FILE for RPC server.

The certificate must be either in PKCS12 (.p12, .pfx) or in PEM format.

PKCS12 files must contain the certificate, a key and optionally a chain of additional certificates. Only PKCS12 files with a blank import password can be opened!

When using PEM, you have to specify the private key via --rpc-private-key as well. Use --rpc-secure option to enable encryption.

Note

WinTLS does not support PEM files at the moment. Users have to use PKCS12 files.

Note

AppleTLS users should use the KeyChain Access utility to first generate a self-signed SSL-Server certificate, e.g. using the wizard, and get the SHA-1 fingerprint from the Information dialog corresponding to that new certificate. To start aria2c with --rpc-secure use --rpc-certificate=<SHA-1>. Alternatively PKCS12 files are also supported. PEM files, however, are not supported.

Returns:

rpc_listen_all property writable ¤

rpc_listen_all: bool

Return the rpc-listen-all option value.

Listen incoming JSON-RPC/XML-RPC requests on all network interfaces.

If false is given, listen only on local loopback interface. Default: false.

Returns:

rpc_listen_port property writable ¤

rpc_listen_port: int

Return the rpc-listen-port option value.

Specify a port number for JSON-RPC/XML-RPC server to listen to.

Possible Values: 1024-65535. Default: 6800.

Returns:

rpc_max_request_size property writable ¤

rpc_max_request_size: str

Return the rpc-max-request-size option value.

Set max size of JSON-RPC/XML-RPC request in bytes.

If aria2 detects the request is more than SIZE bytes, it drops connection. Default: 2M.

Returns:

rpc_passwd property writable ¤

rpc_passwd: str

Return the rpc-passwd option value.

Set JSON-RPC/XML-RPC password.

Warning

--rpc-passwd option will be deprecated in the future release. Migrate to --rpc-secret option as soon as possible.

Returns:

rpc_private_key property writable ¤

rpc_private_key: str

Return the rpc-private-key option value.

Use the private key in FILE for RPC server.

The private key must be decrypted and in PEM format. Use --rpc-secure option to enable encryption. See also --rpc-certificate option.

Returns:

rpc_save_upload_metadata property writable ¤

rpc_save_upload_metadata: bool

Return the rpc-save-upload-metadata option value.

Save the uploaded torrent or metalink meta data in the directory specified by --dir option.

The file name consists of SHA-1 hash hex string of meta data plus extension. For torrent, the extension is '.torrent'. For metalink, it is '.meta4'. If false is given to this option, the downloads added by aria2.addTorrent() or aria2.addMetalink() will not be saved by --save-session option. Default: true.

Returns:

rpc_secret property writable ¤

rpc_secret: str

Return the rpc-secret option value.

Set RPC secret authorization token.

Read RPC authorization secret token to know how this option value is used.

Returns:

rpc_secure property writable ¤

rpc_secure: bool

Return the rpc-secure option value.

RPC transport will be encrypted by SSL/TLS.

The RPC clients must use https scheme to access the server. For WebSocket client, use wss scheme. Use --rpc-certificate and --rpc-private-key options to specify the server certificate and private key.

Returns:

rpc_user property writable ¤

rpc_user: str

Return the rpc-user option value.

Set JSON-RPC/XML-RPC user.

Warning

--rpc-user option will be deprecated in the future release. Migrate to --rpc-secret option as soon as possible.

Returns:

save_cookies property writable ¤

save_cookies: str

Return the save-cookies option value.

Save Cookies to FILE in Mozilla/Firefox(1.x/2.x)/ Netscape format.

If FILE already exists, it is overwritten. Session Cookies are also saved and their expiry values are treated as 0. Possible Values: /path/to/file.

Returns:

save_not_found property writable ¤

save_not_found: bool

Return the save-not-found option value.

Save download with --save-session option even if the file was not found on the server.

This option also saves control file in that situations. Default: true.

Returns:

save_session property writable ¤

save_session: str

Return the save-session option value.

Save error/unfinished downloads to FILE on exit.

You can pass this output file to aria2c with --input-file option on restart. If you like the output to be gzipped append a .gz extension to the file name. Please note that downloads added by aria2.addTorrent() and aria2.addMetalink() RPC method and whose meta data could not be saved as a file are not saved. Downloads removed using aria2.remove() and aria2.forceRemove() will not be saved. GID is also saved with gid, but there are some restrictions, see below.

Note

Normally, GID of the download itself is saved. But some downloads use meta data (e.g., BitTorrent and Metalink). In this case, there are some restrictions.

magnet URI, and followed by torrent download: GID of BitTorrent meta data download is saved.

URI to torrent file, and followed by torrent download: GID of torrent file download is saved.

URI to metalink file, and followed by file downloads described in metalink file: GID of metalink file download is saved.

local torrent file: GID of torrent download is saved.

local metalink file: Any meaningful GID is not saved.

Returns:

save_session_interval property writable ¤

save_session_interval: int

Return the save-session-interval option value.

Save error/unfinished downloads to a file specified by --save-session option every SEC seconds.

If 0 is given, file will be saved only when aria2 exits. Default: 0.

Returns:

seed_ratio property writable ¤

seed_ratio: float

Return the seed-ratio option value.

Specify share ratio.

Seed completed torrents until share ratio reaches RATIO. You are strongly encouraged to specify equals or more than 1.0 here. Specify 0.0 if you intend to do seeding regardless of share ratio. If --seed-time option is specified along with this option, seeding ends when at least one of the conditions is satisfied. Default: 1.0.

Returns:

seed_time property writable ¤

seed_time: float

Return the seed-time option value.

Specify seeding time in (fractional) minutes.

Also see the --seed-ratio option.

Note

Specifying --seed-time=0 disables seeding after download completed.

Returns:

select_file property writable ¤

select_file: str

Return the select-file option value.

Set file to download by specifying its index.

You can find the file index using the --show-files option. Multiple indexes can be specified by using ,, for example: 3,6. You can also use - to specify a range: 1-5. , and - can be used together: 1-5,8, 9. When used with the -M option, index may vary depending on the query (see --metalink-* options).

Note

In multi file torrent, the adjacent files specified by this option may also be downloaded. This is by design, not a bug. A single piece may include several files or part of files, and aria2 writes the piece to the appropriate files.

Returns:

server_stat_if property writable ¤

server_stat_if: str

Return the server-stat-if option value.

Specify the file name to load performance profile of the servers.

The loaded data will be used in some URI selector such as feedback. See also --uri-selector option. See Server Performance Profile subsection below for file format.

Returns:

server_stat_of property writable ¤

server_stat_of: str

Return the server-stat-of option value.

Specify the file name to which performance profile of the servers is saved.

You can load saved data using --server-stat-if option. See Server Performance Profile subsection below for file format.

Returns:

server_stat_timeout property writable ¤

server_stat_timeout: int

Return the server-stat-timeout option value.

Specifies timeout in seconds to invalidate performance profile of the servers since the last contact to them.

Default: 86400 (24hours).

Returns:

show_console_readout property writable ¤

show_console_readout: bool

Return the show-console-readout option value.

Show console readout.

Default: True.

Returns:

show_files property writable ¤

show_files: bool

Return the show-files option value.

Print file listing of ".torrent", ".meta4" and ".metalink" file and exit.

In case of ".torrent" file, additional information (infohash, piece length, etc) is also printed.

Returns:

socket_recv_buffer_size property writable ¤

socket_recv_buffer_size: int

Return the socket-recv-buffer-size option value.

Set the maximum socket receive buffer in bytes.

Specifying 0 will disable this option. This value will be set to socket file descriptor using SO_RCVBUF socket option with setsockopt() call. Default: 0.

Returns:

split property writable ¤

split: int

Return the split option value.

Download a file using N connections.

If more than N URIs are given, first N URIs are used and remaining URIs are used for backup. If less than N URIs are given, those URIs are used more than once so that N connections total are made simultaneously. The number of connections to the same host is restricted by the --max-connection-per-server option. See also the --min-split-size option. Default: 5

Note

Some Metalinks regulate the number of servers to connect. aria2 strictly respects them. This means that if Metalink defines the maxconnections attribute lower than N, then aria2 uses the value of this lower value instead of N.

Returns:

ssh_host_key_md property writable ¤

ssh_host_key_md: str

Return the ssh-host-key-md option value.

Set checksum for SSH host public key (<TYPE>=<DIGEST>).

TYPE is hash type. The supported hash type is sha-1 or md5. DIGEST is hex digest. For example: sha-1=b030503d4de4539dc7885e6f0f5e256704edf4c3. This option can be used to validate server's public key when SFTP is used. If this option is not set, which is default, no validation takes place.

Returns:

stderr property writable ¤

stderr: bool

Return the stderr option value.

Redirect all console output that would be otherwise printed in stdout to stderr.

Default: False.

Returns:

stop property writable ¤

stop: int

Return the stop option value.

Stop application after SEC seconds has passed.

If 0 is given, this feature is disabled. Default: 0.

Returns:

stop_with_process property writable ¤

stop_with_process: int

Return the stop-with-process option value.

Stop application when process PID is not running.

This is useful if aria2 process is forked from a parent process. The parent process can fork aria2 with its own pid and when parent process exits for some reason, aria2 can detect it and shutdown itself.

Returns:

stream_piece_selector property writable ¤

stream_piece_selector: str

Return the stream-piece-selector option value.

Specify piece selection algorithm used in HTTP/FTP download.

Piece means fixed length segment which is downloaded in parallel in segmented download. If default is given, aria2 selects piece so that it reduces the number of establishing connection. This is reasonable default behavior because establishing connection is an expensive operation. If inorder is given, aria2 selects piece which has minimum index. Index=0 means first of the file. This will be useful to view movie while downloading it. --enable-http-pipelining option may be useful to reduce re-connection overhead. Please note that aria2 honors --min-split-size option, so it will be necessary to specify a reasonable value to --min-split-size option. If random is given, aria2 selects piece randomly. Like inorder, --min-split-size option is honored. If geom is given, at the beginning aria2 selects piece which has minimum index like inorder, but it exponentially increasingly keeps space from previously selected piece. This will reduce the number of establishing connection and at the same time it will download the beginning part of the file first. This will be useful to view movie while downloading it. Default: default.

Returns:

summary_interval property writable ¤

summary_interval: int

Return the summary-interval option value.

Set interval in seconds to output download progress summary.

Setting 0 suppresses the output. Default: 60.

Returns:

timeout property writable ¤

timeout: int

Return the timeout option value.

Set timeout in seconds.

Default: 60.

Returns:

torrent_file property writable ¤

torrent_file: str

Return the torrent-file option value.

The path to the ".torrent" file.

You are not required to use this option because you can specify ".torrent" files without --torrent-file.

Returns:

truncate_console_readout property writable ¤

truncate_console_readout: bool

Return the truncate-console-readout option value.

Truncate console readout to fit in a single line.

Default: True.

Returns:

uri_selector property writable ¤

uri_selector: str

Return the uri-selector option value.

Specify URI selection algorithm.

The possible values are inorder, feedback and adaptive. If inorder is given, URI is tried in the order appeared in the URI list. If feedback is given, aria2 uses download speed observed in the previous downloads and choose fastest server in the URI list. This also effectively skips dead mirrors. The observed download speed is a part of performance profile of servers mentioned in --server-stat-of and --server-stat-if options. If adaptive is given, selects one of the best mirrors for the first and reserved connections. For supplementary ones, it returns mirrors which has not been tested yet, and if each of them has already been tested, returns mirrors which has to be tested again. Otherwise, it doesn't select anymore mirrors. Like feedback, it uses a performance profile of servers. Default: feedback.

Returns:

use_head property writable ¤

use_head: bool

Return the use-head option value.

Use HEAD method for the first request to the HTTP server.

Default: False.

Returns:

user_agent property writable ¤

user_agent: str

Return the user-agent option value.

Set user agent for HTTP(S) downloads.

Default: aria2/$VERSION, $VERSION is replaced by package version.

Returns:

get ¤

get(
    item: str, class_: Callable | None = None
) -> OptionType

Get the value of an option given its name.

Parameters:

  • item (str) –

    The name of the option (example: "input-file").

  • class_ (Callable | None, default: None ) –

    Pass the value through this class/function to change its type.

Returns:

  • OptionType –

    The option value.

Source code in src/aria2p/options.py 
62
63
64
65
66
67
68
69
70
71
72
73
74
75
def get(self, item: str, class_: Callable | None = None) -> OptionType:
    """Get the value of an option given its name.

    Parameters:
        item: The name of the option (example: "input-file").
        class_: Pass the value through this class/function to change its type.

    Returns:
        The option value.
    """
    value = self._struct.get(item)
    if class_ is not None and value is not None:
        return class_(value)
    return value

get_struct ¤

get_struct() -> dict

Return a copy of the struct dictionary of this Options object.

Returns:

  • dict –

    A copy of the struct dictionary.

Source code in src/aria2p/options.py 
54
55
56
57
58
59
60
def get_struct(self) -> dict:
    """Return a copy of the struct dictionary of this Options object.

    Returns:
        A copy of the struct dictionary.
    """
    return deepcopy(self._struct)

set ¤

set(
    key: str, value: str | float | bool | list[str]
) -> bool

Set the value of an option given its name.

Parameters:

  • key (str) –

    The name of the option (example: "input-file").

  • value (str | float | bool | list[str]) –

    The value to set.

Returns:

  • bool –

    True if the value was successfully set, False otherwise.

Source code in src/aria2p/options.py 
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
def set(self, key: str, value: str | float | bool | list[str]) -> bool:
    """Set the value of an option given its name.

    Parameters:
        key: The name of the option (example: "input-file").
        value: The value to set.

    Returns:
        True if the value was successfully set, False otherwise.
    """
    if not isinstance(value, str):
        value = str(value)
    if self.download:
        success = self.api.set_options({key: value}, [self.download])[0]
    else:
        success = self.api.set_global_options({key: value})
    if success:
        self._struct[key] = value
    return success