| Watch Folders and the Aspera Watch Service |
179
Field
Description
Default
target directory. The target directory must be within the docroot or
restriction set for the user running asperawatchd.
location type
Set
"type"
to
"REMOTE"
for the remote server. For push Watch
Folders the remote server is the "target", for pull Watch Folders the
remote server is the "source". One endpoint must be remote and one
must be local. Local-to-local and remote-to-remote Watch Folders
are not supported.
"REMOTE"
is assumed if
"host"
is
specified.
"LOCAL"
is assumed if
"REMOTE"
or
"host"
is not
specified.
host
The host IP address, DNS, hostname, or URL of the remote file
system.
Required
. The host can be specified with an IPv4 or IPv6
address. The preferred format for IPv6 addresses is x:x:x:x:x:x:x:x,
where each of the eight x is a hexadecimal number of up to 4 hex
digits. Zone IDs (for example, %eth0) can be appended to the IPv6
address.
N/A
port
The port to use for authentication to the remote file system. By
default, if the authentication type is
SSH
, then the SSH port for the
ascp
process (the value for
tcp_port
in the "transport" section)
is used. If the authentication type is
NODE_BASIC
, 9092 is used.
For Shares, IBM Aspera Transfer Cluster Manager, or IBM Aspera
on Cloud endpoints, enter 443.
If authentication
type is
SSH
, then
default is the value
for
tcp_port
in the
"transport" section
(default: 22). If
authentication type is
NODE_BASIC
, then
default is 9092.
authentication type
How Watch Folders authenticates to the remote server. Valid values
are
SSH
or
NODE_BASIC
.
For
SSH
, authenticate with a transfer user's username and password,
or specify the username and the path to their SSH private key file.
For
NODE_BASIC
, authenticate with a Node API username and
password, Shares credentials, or an access key ID and secret.
Sample JSON syntax for each authentication type is provided
following this table.
NODE_BASIC
user
The username for authentication.
Required
. Depending on the
type of authentication, it is the transfer user's username, Node API
username, Shares username, or access key ID.
N/A
pass
The password for authentication. Depending on the type of
authentication, it is the transfer user's password, the Node API user's
password, the Shares user's password, or the access key secret.
Required
for SSH authentication if "keypath" is not specified
N/A
keypath
For SSH authentication with an SSH key, the path to the transfer
user's SSH private key file.
Required
for SSH authentication if "pass" is not specified
N/A
fingerprint
The SSH fingerprint of the remote server. Aspera strongly
recommends using SSH fingerprint for security. If the fingerprint
does not match that of the server, the transfer fails with the error
N/A
