transferspec::TransferSpec Class Reference

List of all members.

Public Member Functions

def __init__
def remote_host
 The fully qualified domain name or IP address of the transfer server.
def remote_host
def direction
 Transfer direction.
def direction
def remote_user
 The username to use for authentication.
def remote_user
def authentication
 The algorithm used to encrypt data sent during a transfer.
def authentication
def remote_password
 The password to use when authentication is set to "password".
def remote_password
def ssh_port
 The server's TCP port that is listening for SSH connections.
def ssh_port
def fasp_port
 The UDP port for FASP to use.
def fasp_port
def http_fallback
 Attempts to perform an HTTP transfer if a FASP transfer cannot be performed.
def http_fallback
def http_fallback_port
 The port where the Aspera HTTP server is servicing HTTP transfers.
def http_fallback_port
def create_dir
def create_dir
def destination_root
 The transfer destination file path.
def destination_root
def rate_policy
 The congestion control behavior to use when sharing bandwidth.
def rate_policy
def target_rate_kbps
 The desired speed of the transfer.
def target_rate_kbps
def min_rate_kbps
 The minimum transfer rate, in Kbps.
def min_rate_kbps
def lock_rate_policy
 Prevents the user from changing the rate policy during a transfer.
def lock_rate_policy
def target_rate_cap_kbps
 Limit the transfer rate that the user can adjust the target and minimum rates to.
def target_rate_cap_kbps
def lock_target_rate
 Prevents the user from changing the target rate during a transfer.
def lock_target_rate
def lock_min_rate
 Prevents the user from changing the minimum rate during a transfer.
def lock_min_rate
def resume
def resume
def cookie
 Data to associate with the transfer.
def cookie
def dgram_size
 The IP datagram size for FASP to use.
def dgram_size
def content_protection
 Enables content protection (encryption-at-rest), which keeps files encrypted on the server.
def content_protection
def content_protection_passphrase
 A passphrase used to encrypt or decrypt files.
def content_protection_passphrase
def cipher
def cipher
def multi_session
def multi_session
def multi_session_threshold
 set threshold for files that will be considered for multiple sessions.
def multi_session_threshold
def client_access_key
 The access key ID of the access key that is provided by the client, if any.
def client_access_key
def client_cluster_id
def client_cluster_id
def client_token_user_id
def client_token_user_id
def delete_source
 Delete the source if all source files, empty directories and the source argument itself are removed after they are successfully transferred.
def delete_source
def destination_root_id
 The file ID of the destination root directory.
def destination_root_id
def endpoint
 The authentication endpoint; required for Amazon S3 and IBM COS S3.
def endpoint
def error
def error
def keepalive
 If true, transfer in persistent mode.
def keepalive
def https_key_filename
def https_key_filename
def https_certificate_filename
def https_certificate_filename
def https_proxy
def https_proxy
def ignore_host_key
def ignore_host_key
def save_before_override
def save_before_override
def partial_file_suffix
def partial_file_suffix
def report_skipped_files
def report_skipped_files
def auto_bwidth_discovery
def auto_bwidth_discovery
def file_checksum
 File checksum.
def file_checksum
def rexmsg_size
def rexmsg_size
def exclude_newer_than
 Exclude files, but not directories, from the transfer if they are newer than the specified time.
def exclude_newer_than
def exclude_older_than
 Excludes files from the transfer based on when the file was last changed.
def exclude_older_than
def overwrite_policy
def overwrite_policy
def paths
 A list of the file and directory paths to transfer.
def paths
def preserve_times
 Preserve file timestamps.
def preserve_times
def proxy
 The URL of the proxy server.
def proxy
def rate_policy_allowed
 The most aggressive rate policy that is allowed for the transfer.
def rate_policy_allowed
def remote_access_key
 Remote access key for the transfer.
def remote_access_key
def esume_policy
def esume_policy
def server_access_key
 The access key ID of the access key that is provided to the remote node, if any.
def server_access_key
def server_cluster_id
def server_cluster_id
def server_token_user_id
 If the remote node provides a token, the username associated with the token.
def server_token_user_id
def source_root
 The source root directory of the files.
def source_root
def source_root_id
 The file ID of the source root directory.
def source_root_id
def sshfp
 The node's SSH fingerprint, if it is configured in the node's aspera.conf.
def sshfp
def token
 Used for token-based authorization, which involves the server-side application generating a token that gives the client rights to transfer a predetermined set of files.
def token
def min_rate_cap_kbps
def min_rate_cap_kbps
def target_rate_percentage
def target_rate_percentage
def vlink_id
 The ID of the virtual link (bandwidth control) that is applied to the transfer.
def vlink_id
def toJson

Member Function Documentation

def transferspec::TransferSpec::__init__ (   self  ) 

def transferspec::TransferSpec::authentication (   self,
  value 
)

def transferspec::TransferSpec::authentication (   self  ) 

The algorithm used to encrypt data sent during a transfer.

Use this option when transmitting sensitive data. Increases CPU utilization. Possible values: aes128, aes192, aes256

def transferspec::TransferSpec::auto_bwidth_discovery (   self,
  value 
)

def transferspec::TransferSpec::auto_bwidth_discovery (   self  ) 

def transferspec::TransferSpec::cipher (   self,
  value 
)

def transferspec::TransferSpec::cipher (   self  ) 

def transferspec::TransferSpec::client_access_key (   self,
  value 
)

def transferspec::TransferSpec::client_access_key (   self  ) 

The access key ID of the access key that is provided by the client, if any.

def transferspec::TransferSpec::client_cluster_id (   self,
  value 
)

def transferspec::TransferSpec::client_cluster_id (   self  ) 

def transferspec::TransferSpec::client_token_user_id (   self,
  value 
)

def transferspec::TransferSpec::client_token_user_id (   self  ) 

def transferspec::TransferSpec::content_protection (   self,
  value 
)

def transferspec::TransferSpec::content_protection (   self  ) 

Enables content protection (encryption-at-rest), which keeps files encrypted on the server.

Encrypted files have the extension ".aspera-env". Possible values: decrypt, encrypt, disabled

def transferspec::TransferSpec::content_protection_passphrase (   self,
  value 
)

def transferspec::TransferSpec::content_protection_passphrase (   self  ) 

A passphrase used to encrypt or decrypt files.

def transferspec::TransferSpec::cookie (   self,
  value 
)

def transferspec::TransferSpec::cookie (   self  ) 

Data to associate with the transfer.

The cookie is reported to both client- and server-side applications monitoring FASP transfers. It is often used by applications to identify associated transfers.

def transferspec::TransferSpec::create_dir (   self,
  value 
)

def transferspec::TransferSpec::create_dir (   self  ) 

def transferspec::TransferSpec::delete_source (   self,
  value 
)

def transferspec::TransferSpec::delete_source (   self  ) 

Delete the source if all source files, empty directories and the source argument itself are removed after they are successfully transferred.

Default: false.

def transferspec::TransferSpec::destination_root (   self,
  value 
)

def transferspec::TransferSpec::destination_root (   self  ) 

The transfer destination file path.

If destinations are specified in paths, this value is prepended to each destination.

def transferspec::TransferSpec::destination_root_id (   self,
  value 
)

def transferspec::TransferSpec::destination_root_id (   self  ) 

The file ID of the destination root directory.

Required when using Bearer token auth for the destination node.

def transferspec::TransferSpec::dgram_size (   self,
  value 
)

def transferspec::TransferSpec::dgram_size (   self  ) 

The IP datagram size for FASP to use.

If this value is not specified, FASP will automatically detects and use the path MTU as the datagram size. Use this option only to satisfy networks with strict MTU requirements.

def transferspec::TransferSpec::direction (   self,
  value 
)

def transferspec::TransferSpec::direction (   self  ) 

Transfer direction.

Possible values: send, receive

def transferspec::TransferSpec::endpoint (   self,
  value 
)

def transferspec::TransferSpec::endpoint (   self  ) 

The authentication endpoint; required for Amazon S3 and IBM COS S3.

def transferspec::TransferSpec::error (   self,
  value 
)

def transferspec::TransferSpec::error (   self  ) 

def transferspec::TransferSpec::esume_policy (   self,
  value 
)

def transferspec::TransferSpec::esume_policy (   self  ) 

def transferspec::TransferSpec::exclude_newer_than (   self,
  value 
)

def transferspec::TransferSpec::exclude_newer_than (   self  ) 

Exclude files, but not directories, from the transfer if they are newer than the specified time.

Time is specified as number of seconds after the source computer's epoch.

def transferspec::TransferSpec::exclude_older_than (   self,
  value 
)

def transferspec::TransferSpec::exclude_older_than (   self  ) 

Excludes files from the transfer based on when the file was last changed.

This positive value is compared to the "mtime" timestamp in the source file system, usually seconds since 1970-01-01 00:00:00.

def transferspec::TransferSpec::fasp_port (   self,
  value 
)

def transferspec::TransferSpec::fasp_port (   self  ) 

The UDP port for FASP to use.

The default value is satisfactory for most situations. However, it can be changed to satisfy firewall requirements. The default is 33001.

def transferspec::TransferSpec::file_checksum (   self,
  value 
)

def transferspec::TransferSpec::file_checksum (   self  ) 

File checksum.

Possible values: none, md5, sha1, sha256, sha384, sha512

def transferspec::TransferSpec::http_fallback (   self,
  value 
)

def transferspec::TransferSpec::http_fallback (   self  ) 

Attempts to perform an HTTP transfer if a FASP transfer cannot be performed.

def transferspec::TransferSpec::http_fallback_port (   self,
  value 
)

def transferspec::TransferSpec::http_fallback_port (   self  ) 

The port where the Aspera HTTP server is servicing HTTP transfers.

Defaults to port 443 if a cipher is enabled, otherwise port 80.

def transferspec::TransferSpec::https_certificate_filename (   self,
  value 
)

def transferspec::TransferSpec::https_certificate_filename (   self  ) 

def transferspec::TransferSpec::https_key_filename (   self,
  value 
)

def transferspec::TransferSpec::https_key_filename (   self  ) 

def transferspec::TransferSpec::https_proxy (   self,
  value 
)

def transferspec::TransferSpec::https_proxy (   self  ) 

def transferspec::TransferSpec::ignore_host_key (   self,
  value 
)

def transferspec::TransferSpec::ignore_host_key (   self  ) 

def transferspec::TransferSpec::keepalive (   self,
  value 
)

def transferspec::TransferSpec::keepalive (   self  ) 

If true, transfer in persistent mode.

def transferspec::TransferSpec::lock_min_rate (   self,
  value 
)

def transferspec::TransferSpec::lock_min_rate (   self  ) 

Prevents the user from changing the minimum rate during a transfer.

def transferspec::TransferSpec::lock_rate_policy (   self,
  value 
)

def transferspec::TransferSpec::lock_rate_policy (   self  ) 

Prevents the user from changing the rate policy during a transfer.

def transferspec::TransferSpec::lock_target_rate (   self,
  value 
)

def transferspec::TransferSpec::lock_target_rate (   self  ) 

Prevents the user from changing the target rate during a transfer.

def transferspec::TransferSpec::min_rate_cap_kbps (   self,
  value 
)

def transferspec::TransferSpec::min_rate_cap_kbps (   self  ) 

def transferspec::TransferSpec::min_rate_kbps (   self,
  value 
)

def transferspec::TransferSpec::min_rate_kbps (   self  ) 

The minimum transfer rate, in Kbps.

def transferspec::TransferSpec::multi_session (   self,
  value 
)

def transferspec::TransferSpec::multi_session (   self  ) 

def transferspec::TransferSpec::multi_session_threshold (   self,
  value 
)

def transferspec::TransferSpec::multi_session_threshold (   self  ) 

set threshold for files that will be considered for multiple sessions.

def transferspec::TransferSpec::overwrite_policy (   self,
  value 
)

def transferspec::TransferSpec::overwrite_policy (   self  ) 

def transferspec::TransferSpec::partial_file_suffix (   self,
  value 
)

def transferspec::TransferSpec::partial_file_suffix (   self  ) 

def transferspec::TransferSpec::paths (   self,
  value 
)

def transferspec::TransferSpec::paths (   self  ) 

A list of the file and directory paths to transfer.

def transferspec::TransferSpec::preserve_times (   self,
  value 
)

def transferspec::TransferSpec::preserve_times (   self  ) 

Preserve file timestamps.

Default: false.

def transferspec::TransferSpec::proxy (   self,
  value 
)

def transferspec::TransferSpec::proxy (   self  ) 

The URL of the proxy server.

def transferspec::TransferSpec::rate_policy (   self,
  value 
)

def transferspec::TransferSpec::rate_policy (   self  ) 

The congestion control behavior to use when sharing bandwidth.

Allowed values: high: When sharing bandwidth, transfer at twice the rate of a transfer using a fair policy. fair (default value): Share bandwidth equally with other traffic. low: Use only un-utilized bandwidth. fixed: Transfer at the target rate, regardless of the actual network capacity. Do not share bandwidth. The fixed policy can decrease transfer performance and cause problems on the target storage.

def transferspec::TransferSpec::rate_policy_allowed (   self,
  value 
)

def transferspec::TransferSpec::rate_policy_allowed (   self  ) 

The most aggressive rate policy that is allowed for the transfer.

See rate_policy for values.

def transferspec::TransferSpec::remote_access_key (   self,
  value 
)

def transferspec::TransferSpec::remote_access_key (   self  ) 

Remote access key for the transfer.

def transferspec::TransferSpec::remote_host (   self,
  value 
)

def transferspec::TransferSpec::remote_host (   self  ) 

The fully qualified domain name or IP address of the transfer server.

def transferspec::TransferSpec::remote_password (   self,
  value 
)

def transferspec::TransferSpec::remote_password (   self  ) 

The password to use when authentication is set to "password".

def transferspec::TransferSpec::remote_user (   self,
  value 
)

def transferspec::TransferSpec::remote_user (   self  ) 

The username to use for authentication.

For password authentication.

def transferspec::TransferSpec::report_skipped_files (   self,
  value 
)

def transferspec::TransferSpec::report_skipped_files (   self  ) 

def transferspec::TransferSpec::resume (   self,
  value 
)

def transferspec::TransferSpec::resume (   self  ) 

def transferspec::TransferSpec::rexmsg_size (   self,
  value 
)

def transferspec::TransferSpec::rexmsg_size (   self  ) 

def transferspec::TransferSpec::save_before_override (   self,
  value 
)

def transferspec::TransferSpec::save_before_override (   self  ) 

def transferspec::TransferSpec::server_access_key (   self,
  value 
)

def transferspec::TransferSpec::server_access_key (   self  ) 

The access key ID of the access key that is provided to the remote node, if any.

def transferspec::TransferSpec::server_cluster_id (   self,
  value 
)

def transferspec::TransferSpec::server_cluster_id (   self  ) 

def transferspec::TransferSpec::server_token_user_id (   self,
  value 
)

def transferspec::TransferSpec::server_token_user_id (   self  ) 

If the remote node provides a token, the username associated with the token.

def transferspec::TransferSpec::source_root (   self,
  value 
)

def transferspec::TransferSpec::source_root (   self  ) 

The source root directory of the files.

def transferspec::TransferSpec::source_root_id (   self,
  value 
)

def transferspec::TransferSpec::source_root_id (   self  ) 

The file ID of the source root directory.

Required when using Bearer token auth for the source node.

def transferspec::TransferSpec::ssh_port (   self,
  value 
)

def transferspec::TransferSpec::ssh_port (   self  ) 

The server's TCP port that is listening for SSH connections.

FASP initiates transfers through SSH. Default is 33001

def transferspec::TransferSpec::sshfp (   self,
  value 
)

def transferspec::TransferSpec::sshfp (   self  ) 

The node's SSH fingerprint, if it is configured in the node's aspera.conf.

def transferspec::TransferSpec::target_rate_cap_kbps (   self,
  value 
)

def transferspec::TransferSpec::target_rate_cap_kbps (   self  ) 

Limit the transfer rate that the user can adjust the target and minimum rates to.

def transferspec::TransferSpec::target_rate_kbps (   self,
  value 
)

def transferspec::TransferSpec::target_rate_kbps (   self  ) 

The desired speed of the transfer.

If there is competing network traffic, FASP may share this bandwidth, depending on the rate_policy. By default, server-side target rate settings will be used. Will respect both local- and server-side target rate caps if set.

def transferspec::TransferSpec::target_rate_percentage (   self,
  value 
)

def transferspec::TransferSpec::target_rate_percentage (   self  ) 

def transferspec::TransferSpec::toJson (   self  ) 

def transferspec::TransferSpec::token (   self,
  value 
)

def transferspec::TransferSpec::token (   self  ) 

Used for token-based authorization, which involves the server-side application generating a token that gives the client rights to transfer a predetermined set of files.

def transferspec::TransferSpec::vlink_id (   self,
  value 
)

def transferspec::TransferSpec::vlink_id (   self  ) 

The ID of the virtual link (bandwidth control) that is applied to the transfer.


The documentation for this class was generated from the following file:
Generated on 22 Aug 2018 for COS Aspera Library 0.9 API by  doxygen 1.4.7