| Watch Folders and the Aspera Watch Service |
198
Field
Description
Default
Required
for SSH authentication if "keypath" is not specified
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
watchd identifier The daemon associated with the Watch Service that is used to monitor
the file system. Optional. Required only when you want to use a Watch
Service that is run by a user who is not associated with the Node API user
or access key. Use to specify the daemon on the remote host if it is not
xfer
.
N/A
scan_period
The time between file system scans of the watches (from end of one
to start of the next). These scans are independent of the snapshot
minimum interval and snapshot minimum changes to ensure that changes
are identified. To never scan (asperawatchd relies entirely on file
notifications), set to "infinite". On file systems without file notifications,
such as object storage, mounted storage (NFS), Solaris, AIX, and Isilon,
file system scans triggered by the scan period are used to detect file
changes. In this case, set the scan period to frequently scan for changes.
On operating systems that support file notifications (Linux, Windows,
macOS), asperawatchd uses the file notifications as the primary means
for detecting changes, and the scan period serves as a backup. In this
case, the default value of 30 minutes is usually acceptable and no change
is necessary. To never scan, and rely entirely on file notifications, set to
infinite
.
For pull Watch Folders, file systems scans that are triggered by
scan_period are the sole means for detecting changes in the source
directory.
Lower scan periods detect changes faster but can result in greater resource
consumption, particularly for object storage.
Note:
The value for scan period cannot be empty, otherwise the
configuration is rejected.
30m
Save the configuration file. The path to the configuration file is used in the next step.
7.
Start the Watch Folder.
# curl -k --user
node_api_user
:
node_api_password
-H "X-
aspera-WF-version:2017_10_23" -X POST -d @
path/to/json_file
https://
host
:
node_api_port
/v3/watchfolders
By default, the API port is 9092.
Note:
The header
"X-aspera-WF-version:2017_10_23"
is required when submitting POST, PUT, and
GET requests to /v3/watchfolders on servers that are version 3.8.0 or newer. This enables Watch Folders to parse
the JSON "source" and "target" objects in the format that was introduced in version 3.8.0.
For example:
# curl -k --user watchfolder_admin:XF324cd28 -H "X-aspera-
WF-version:2017_10_23" -X POST -d @/watchfolder_conf.json
https://198.51.100.22:9092/v3/watchfolders
{
"id": "b394d0ee-1cda-4f0d-b785-efdc6496c585"
