Appendix / Report References |
Database Field | Description | Table |
---|---|---|
args_attempted | Number of items specifically selected by the user (either in GUI or command line). | $TBL_TRANSFER_SESSIONS |
args_completed | Out of the number of arguments attempted, the number completed successfully. | $TBL_TRANSFER_SESSIONS |
aspera_version | Aspera product version for the node machine. | $TBL_NODES |
avg_loss_pct | Average packet loss over the network, which is calculated as a percentage. | $TBL_TRANSFER_SESSIONS |
avg_rate | Average transfer rate in bits per second. | $TBL_TRANSFERS, $TBL_TRANSFER_SESSIONS |
bytes_config | The number of contiguous bytes that have been transferred to the destination. | $TBL_TRANSFER_SESSION_FILES, $TBL_FILES |
bytes_lost | Number of bytes sent by source for a particular file, but never received by destination, or never written to disk. | $TBL_TRANSFERS, $TBL_TRANSFER_SESSIONS, $TBL_TRANSFER_SESSION_FILES, $TBL_FILES |
bytes_pretransfer | If the server is configured to do so, calculates size of the transfer before the transfer starts. On the server, this corresponds to the "pre-calculate job size" setting. | $TBL_TRANSFERS, $TBL_TRANSFER_SESSIONS |
bytes_remaining | Total bytes waiting to be sent over the network to the destination. | $TBL_TRANSFERS, $TBL_TRANSFER_SESSIONS |
bytes_transferred | Total bytes successfully received over the network by the destination. | $TBL_TRANSFERS, $TBL_TRANSFER_SESSIONS, $TBL_TRANSFER_SESSION_FILES, $TBL_FILES |
bytes_written | Total bytes successfully received over the network by the destination, plus bytes skipped for data already present at the destination. | $TBL_TRANSFERS, $TBL_TRANSFER_SESSIONS, $TBL_TRANSFER_SESSION_FILES, $TBL_FILES |
cipher | Encryption algorithm. | $TBL_TRANSFERS, $TBL_TRANSFER_SESSIONS |
client_console_ip | The client's IP address from the perspective of the Aspera Console application (advanced / debugging field). | $TBL_TRANSFER_SESSIONS |
client_err_code | Error code reported by the client. | $TBL_TRANSFER_SESSION_FILES, $TBL_TRANSFER_SESSIONS |
client_err_desc | Error code description reported by the client. | $TBL_TRANSFER_SESSION_FILES, $TBL_TRANSFER_SESSIONS |
client_external_fasp_port | The client's UDP port from the perspective of the server (advanced / debugging field). | $TBL_TRANSFER_SESSIONS |
client_external_ip | The client's IP address from the perspective of the server (advanced / debugging
field). Note: If the client is a managed node and the server is not, then this
field is null.
|
$TBL_TRANSFER_SESSIONS |
client_file_basename | File's basename from client's point-of-view. | $TBL_TRANSFER_SESSION_FILES, $TBL_FILES |
client_file_extension | File's extension from client's point-of-view. | $TBL_TRANSFER_SESSION_FILES, $TBL_FILES |
client_file_fullpath | File's full path from the client's point-of-view. | $TBL_TRANSFER_SESSION_FILES, $TBL_FILES |
client_file_index | Arbitrary, unique number assigned to each file within a transfer session (on the client). | $TBL_TRANSFER_SESSION_FILES |
client_ip | IP address of the transfer initiator (use for general purpose). | $TBL_TRANSFER_SESSIONS |
client_node_id | ID number assigned to the client node. | $TBL_TRANSFER_SESSIONS |
client_node_uuid | Universally, unique ID number assigned to the client node. | $TBL_TRANSFER_SESSIONS |
client_status | Either the file status (running, completed, error) or the session status reported by
the client. Note: In some cases, client and server can see different statuses
(for example, canceled versus error).
|
$TBL_TRANSFER_SESSION_FILES, $TBL_TRANSFER_SESSIONS |
client_user | Client-side username. Null for all transfers, except for transfers initiated by the Console. | $TBL_TRANSFERS, $TBL_TRANSFER_SESSIONS |
contact | Contact assigned by Console. This can be a Console user name, a Faspex user name, SSH account, or customized value obtained from a transfer cookie. Examples: "admin (console)", "aspera (ssh)", "michael (faspex)" | $TBL_TRANSFERS, $TBL_TRANSFER_SESSIONS |
cookie | Custom identifying text attached to a transfer session. This text is used by the Console to identify and name transfers. | $TBL_TRANSFERS, $TBL_TRANSFER_SESSIONS |
dest_endpoint_id | ID number assigned to the destination endpoint. | $TBL_TRANSFER_SESSIONS |
dest_file_basename | File's basename from destination's point-of-view. | $TBL_FILES |
dest_file_extension | File's extension from destination's point-of-view. | $TBL_FILES |
dest_file_fullpath | File's full path from the destination's point-of-view. | $TBL_FILES |
dest_ip | IP address of transfer destination (use for general purpose). | $TBL_TRANSFER_SESSIONS |
dest_node_id | ID number assigned to the destination node. | $TBL_TRANSFER_SESSIONS |
dest_path | The file path on the destination machine. | $TBL_TRANSFERS, $TBL_TRANSFER_SESSIONS |
dest_user | If upload, dest_user is the server user. If download, dest_user is client user (NULL, unless initiated from Console). For everyday purposes, recommend using contact field instead. | $TBL_TRANSFERS, $TBL_TRANSFER_SESSIONS |
dirs_pretransfer | If the server is configured to do so, calculates number of directories to be transferred. Only calculated if "pre-calculate job size" setting is turned on. | $TBL_TRANSFERS, $TBL_TRANSFER_SESSIONS |
dirscans_completed | Number of directory scans completed. | $TBL_TRANSFER_SESSIONS |
err_desc | Error message for transfer or file, if any. | $TBL_TRANSFER_SESSION_FILES, $TBL_TRANSFER_SESSIONS |
fallback_protocol | If the transfer has been configured to retry using the HTTP fallback protocol, then this field will report "http." If not, will be NULL. | $TBL_TRANSFER_SESSIONS |
file_basename | Name of the file, without its path (for example, "my_file.txt," rather than "C:\temp\my_file.txt") | $TBL_TRANSFER_SESSION_FILES, $TBL_FILES |
file_extension | Portion of the filename after the last period (.) | $TBL_TRANSFER_SESSION_FILES, $TBL_FILES |
file_fullpath | Full path to the file. | $TBL_TRANSFER_SESSION_FILES, $TBL_FILES |
files_attempted | Number of files attempted to be sent over the network. | $TBL_TRANSFERS, $TBL_TRANSFER_SESSIONS |
files_complete | Number of files successfully verified at destination, that is, the number of files actually transferred + number of files that were already at destination. | $TBL_TRANSFERS, $TBL_TRANSFER_SESSIONS |
files_failed | Number of files that failed to transfer. | $TBL_TRANSFERS, $TBL_TRANSFER_SESSIONS |
files_pretransfer | If the server is configured to do so, calculates number of files to be transferred. Only calculated if "pre-calculate job size" setting is turned on. | $TBL_TRANSFERS, $TBL_TRANSFER_SESSIONS |
files_skipped | Number of files skipped. | $TBL_TRANSFERS, $TBL_TRANSFER_SESSIONS |
filescans_completed | The number of file scans completed. | $TBL_TRANSFERS, $TBL_TRANSFER_SESSIONS |
hostname | The local name of the node machine (which is only filled in for managed nodes). Note that a node machine will be called "localhost" if it hasn't been previously named. | $TBL_NODES |
id | Unique integer ID assigned by the Console (used as an internal field). | $TBL_NODES, $TBL_TRANSFERS, $TBL_TRANSFER_SESSIONS, $TBL_TRANSFER_SESSION_FILES, $TBL_FILES |
initiated_by_source | Identifies an "upload." If this field is equal to 1, then whoever started the transfer is uploading. | $TBL_TRANSFERS, $TBL_TRANSFER_SESSIONS, $TBL_TRANSFER_SESSION_FILES, $TBL_FILES |
last_client_ip | The client's IP address from the last session of a multiple session transfer. | $TBL_TRANSFERS |
last_client_node_id | ID number assigned to the client node during the last session of a multiple session transfer. | $TBL_TRANSFERS |
last_dest_ip | The destination's IP address from the last session of a multiple session transfer. | $TBL_TRANSFERS |
last_dest_node_id | ID number assigned to the destination node during the last session of a multiple session transfer. | $TBL_TRANSFERS |
last_err_desc | Error description from the last session of a multiple session transfer. | $TBL_TRANSFERS, $TBL_FILES |
last_network_delay | The lag on the network (RTT, measured in milliseconds) from the last session of a multiple session transfer. | $TBL_TRANSFERS |
last_restarted_at | The last date/time that the node machine was restarted (for managed node's only). | $TBL_NODES |
last_retry_timeout | The number of seconds that the server waited to try again (after a failure), during the last session of a multiple transfer session. | $TBL_TRANSFERS |
last_server_ip | The server's IP address from the last session of a multiple session transfer. | $TBL_TRANSFERS |
last_server_node_id | ID number assigned to the server node during the last session of a multiple session transfer. | $TBL_TRANSFERS |
last_source_ip | The source's IP address from the last session of a multiple session transfer. | $TBL_TRANSFERS |
last_source_node_id | ID number assigned to the source node during the last session of a multiple session transfer. | $TBL_TRANSFERS |
last_transfer_session_file_id | ID number assigned to the file during the last transfer session. | $TBL_FILES |
last_transport | Transport mechanism ("fasp2" for Aspera protocol, "http" for fallback protocol) from the last session of a multiple session transfer. | $TBL_TRANSFERS |
max_rate | Maximum transfer rate. | $TBL_TRANSFERS, $TBL_TRANSFER_SESSIONS |
min_rate | Minimum transfer rate. | $TBL_TRANSFERS, $TBL_TRANSFER_SESSIONS |
mkdirs_attempted | Number of directories that were attempted to be created at the destination. | $TBL_TRANSFER_SESSIONS |
mkdirs_failed | Number of directories that failed to be created at the destination. | $TBL_TRANSFER_SESSIONS |
mkdirs_passed | Number of directories that were created successfully at the destination. | $TBL_TRANSFER_SESSIONS |
name cf | Human-readable name assigned to a transfer. This name may have been keyed in by the user or automatically set by an application. | $TBL_NODES, $TBL_TRANSFERS, $TBL_TRANSFER_SESSIONS |
network_delay | Lag on the network (RTT), which is measured in milliseconds. | $TBL_TRANSFER_SESSIONS |
operation | Either upload or download from the perspective of the client (the initiator). Upload if pushing; download if pulling. | $TBL_TRANSFERS, $TBL_TRANSFER_SESSIONS |
os | The node machine's Operating System. | $TBL_NODES |
os_version | The version of the node machine's Operating System. | $TBL_NODES |
paths_attempted | The total number of files and directories attempted. | $TBL_TRANSFER_SESSIONS |
paths_excluded | The number of files and directories that were not transferred because of an exclusion rules. | $TBL_TRANSFER_SESSIONS |
paths_failed | The number of files and directories that failed to transfer. A failure is counted if the sender was unable to read a source file or the destination was unable to write the file. | $TBL_TRANSFER_SESSIONS |
paths_irreg | This is the total number of special files (for example, nodes, pipes, memory mapped files, page files or /proc files). These files are never transferred. | $TBL_TRANSFER_SESSIONS |
pct_complete | Percent (%) of transfer that has been completed. NULL if the node is server is not configured to pre-calculate job size. | $TBL_TRANSFERS, $TBL_TRANSFER_SESSIONS |
pretransfer_stats_changed | Between one attempt to the next (retries and sync), whether or not the size of the transfer has changed (grew or reduced in size). | $TBL_TRANSFERS |
primary_address | The node's actual IP address (which has been keyed into the Console interface). | $TBL_NODES |
priority | Normal or high (only valid when the policy if adaptive). | $TBL_TRANSFERS, $TBL_TRANSFER_SESSIONS |
reported_by_both_sides | Database logger added information to the Console from both ends of the transfer (both source and destination are managed nodes and both are sending data back to the database). | $TBL_TRANSFERS |
reported_by_server | If this field is equal to 1, then Console received data from the server node. If this field is equal to 0, then the server was not a managed node or failed to log. | $TBL_TRANSFER_SESSION_FILES, $TBL_FILES |
reported_policy | High, fixed, adaptive or trickle. | $TBL_TRANSFER_SESSIONS |
reported_priority | Normal or high (only valid when the policy if adaptive). | $TBL_TRANSFER_SESSIONS |
retry_timeout | After a transfer fails, the number of seconds the server will wait before trying again. | $TBL_TRANSFER_SESSIONS |
seconds_remaining | Seconds remaining for the file transfer. | $TBL_TRANSFERS, $TBL_TRANSFER_SESSIONS |
server_console_ip | Internal IP address of the server (inputted into the nodes page inside Console). Note that this field is primarily used for testing. | $TBL_TRANSFER_SESSIONS |
server_err_code | Error code reported by the server. | $TBL_TRANSFER_SESSION_FILES, $TBL_TRANSFER_SESSIONS |
server_err_desc | Error code description reported by the server. | $TBL_TRANSFER_SESSION_FILES, $TBL_TRANSFER_SESSIONS |
server_external_fasp_port | External fasp (UDP) port of the server. Note that this field is primarily used for testing. | $TBL_TRANSFER_SESSIONS |
server_external_ip | External IP address of the server. Note that this field is primarily used for testing. | $TBL_TRANSFER_SESSIONS |
server_file_basename | File's basename from server's point-of-view. | $TBL_TRANSFER_SESSION_FILES, $TBL_FILES |
server_file_extension | File's extension from server's point-of-view. | $TBL_TRANSFER_SESSION_FILES, $TBL_FILES |
server_file_fullpath | File's full path from the server's point-of-view. | $TBL_TRANSFER_SESSION_FILES, $TBL_FILES |
server_file_index | Arbitrary, unique number assigned to each file within a transfer session (on the server) | $TBL_TRANSFER_SESSION_FILES |
server_ip | IP address of transfer server. | $TBL_TRANSFER_SESSIONS |
server_node_id | ID assigned to the server node. | $TBL_TRANSFER_SESSIONS |
server_node_uuid | Universally, unique ID assigned to the server node. | $TBL_TRANSFER_SESSIONS |
server_status | Either the file status (running, completed, error) or the session status reported by the server. Note that in some cases, client and server can see different statuses (for example, canceled versus error). | $TBL_TRANSFER_SESSION_FILES, $TBL_TRANSFER_SESSIONS |
server_user | SSH account specified when the transfer starts (should always be displayed). | $TBL_TRANSFERS, $TBL_TRANSFER_SESSIONS |
session_count | Number of sessions required for the transfer. Note: Hot folders can span many
sessions.
|
$TBL_TRANSFERS |
session_file_count | Number of sessions required to send a particular file. | $TBL_FILES |
session_id | ID assigned to transfer session. | $TBL_TRANSFER_SESSION_FILES, $TBL_TRANSFER_SESSIONS |
size | Size of the file in bytes. | $TBL_TRANSFER_SESSION_FILES, $TBL_FILES |
size_changed | The change in file size from one transfer attempt to another. | $TBL_FILES |
soap_active_sessions | Number of transfer sessions running on the node. | $TBL_NODES |
source_endpoint_id | ID assigned to the source endpoint. | $TBL_TRANSFER_SESSIONS |
source_file_basename | File's basename from source's point-of-view. | $TBL_FILES |
source_file_extension | File's extension from source's point-of-view. | $TBL_FILES |
source_file_fullpath | File's full path from the source's point-of-view. | $TBL_FILES |
source_ip | IP address of transfer source. | $TBL_TRANSFER_SESSIONS |
source_node_id | ID assigned to the source node. | $TBL_TRANSFER_SESSIONS |
source_paths | File paths on the source machine. | $TBL_TRANSFERS, $TBL_TRANSFER_SESSIONS |
source_paths_changed | Between one transfer attempt to the next, whether or not the file source paths have changed. | $TBL_TRANSFERS |
source_user | If upload, source_user is the client user. If download, source_user is server user. | $TBL_TRANSFERS, $TBL_TRANSFER_SESSIONS |
ssh_port | Node machine's SSH port. | $TBL_NODES |
ssh_tunnel_port | Node machine's SSH tunnel port. | $TBL_NODES |
start_byte | Displays the point at which data from the file started transferring to the destination (relevant if some of the file has already been transferred). If the file has already been transferred to the destination, then the start byte equals the total file size. | $TBL_TRANSFER_SESSION_FILES, $TBL_FILES |
started_at | Date and time that a transfer or file started. | $TBL_TRANSFERS, $TBL_TRANSFER_SESSIONS, $TBL_TRANSFER_SESSION_FILES, $TBL_FILES |
started_via | The name of the application (Aspera or custom) that is responsible for initiating the transfer (for example, aspera.scp, aspera.sync, etc.). | $TBL_TRANSFERS, $TBL_TRANSFER_SESSIONS |
status | Status of transfer or file (for example, "running," "completed," "canceled" or "error"). | $TBL_TRANSFERS, $TBL_TRANSFER_SESSIONS, $TBL_TRANSFER_SESSION_FILES, $TBL_FILES |
stopped_at | Date and time that a transfer or file stopped (value is blank if transfer or file is still active). | $TBL_TRANSFERS, $TBL_TRANSFER_SESSIONS, $TBL_TRANSFER_SESSION_FILES, $TBL_FILES |
target_rate | Target transfer rate. | $TBL_TRANSFERS, $TBL_TRANSFER_SESSIONS |
tmp_actual_rate | Reserved for future use. | $TBL_TRANSFERS, $TBL_TRANSFER_SESSIONS |
tmp_actual_rate_calculated_at | Reserved for future use. | $TBL_TRANSFERS, $TBL_TRANSFER_SESSIONS |
tmp_loss_pct | Reserved for future use. | $TBL_TRANSFER_SESSIONS |
token | Security token used for the transfer (note that this depends on whether or not the application that started the transfer is configured to use tokens). | $TBL_TRANSFERS, $TBL_TRANSFER_SESSIONS |
transfer_file_id | Corresponds to the file ID field | $TBL_TRANSFER_SESSION_FILES |
transfer_id | Corresponds to ID field. | $TBL_TRANSFER_SESSIONS, $TBL_FILES |
transfer_session_id | Corresponds to transfer session ID field | $TBL_TRANSFER_SESSION_FILES |
transfer_uuid | Universally, unique ID that is used to identify the transfer as a whole. May contain multiple sessions and is generated by application that started the transfer. Generally only populated by transfers started by Console. | $TBL_TRANSFERS, $TBL_TRANSFER_SESSIONS |
transport | fasp2 for Aspera protocol, "http" for fallback protocol | $TBL_TRANSFER_SESSIONS |
type | Managed or unmanaged node. | $TBL_NODES |
udp_port | Node machine's UDP port. | $TBL_NODES |
use_ssh_tunnel | Set up an SSH tunnel for database logging (for managed nodes only). | $TBL_NODES |
usecs | Length of the transfer session (in milliseconds). Not authoritative (use only for transfer sessions and transfers). | $TBL_TRANSFERS, $TBL_TRANSFER_SESSIONS, $TBL_TRANSFER_SESSION_FILES, $TBL_FILES |
uuid | Universally, unique identifier that is generated on the node when installing Aspera software (for managed nodes only) | $TBL_NODES |