The name of the task to display in the UI.
The local path to back up beginning with /mnt or /dev/zvol.
Cloud credentials to use for each backup.
No Additional PropertiesMust be at least 1 characters long
"AZUREBLOB" Must be at least 1 characters long
Must be at least 1 characters long
"" Must be at least 1 characters long
Must be at most 2083 characters long
"B2" Must be at least 1 characters long
Must be at least 1 characters long
"BOX" Must be at least 1 characters long
"DROPBOX" Must be at least 1 characters long
"FTP" Must be at least 1 characters long
Must be at least 1 characters long
"GOOGLE_CLOUD_STORAGE" Must be at least 1 characters long
"GOOGLE_DRIVE" Must be at least 1 characters long
"GOOGLE_PHOTOS" Must be at least 1 characters long
"HTTP" Must be at least 1 characters long
Must be at most 2083 characters long
"HUBIC" Must be at least 1 characters long
"MEGA" Must be at least 1 characters long
Must be at least 1 characters long
"ONEDRIVE" Must be at least 1 characters long
"PCLOUD" Must be at least 1 characters long
"S3" Must be at least 1 characters long
Must be at least 1 characters long
"SFTP" Must be at least 1 characters long
Must be at least 1 characters long
"STORJ_IX" Must be at least 1 characters long
Must be at least 1 characters long
Must be at least 1 characters long
Must be at most 2083 characters long
"OPENSTACK_SWIFT" Must be at least 1 characters long
Must be at least 1 characters long
Must be at least 1 characters long
"WEBDAV" Must be at least 1 characters long
Must be at most 2083 characters long
"YANDEX" Must be at least 1 characters long
Additional information for each backup, e.g. bucket name.
No Additional PropertiesMust be at least 1 characters long
Valid only for some providers. Use fewer transactions in exchange for more RAM. This may also speed up or slow down your transfer. See https://rclone.org/docs/#fast-list for more details.
Valid only for GOOGLECLOUDSTORAGE provider. Access checks should use bucket-level IAM policies. If you want to upload objects to a bucket with Bucket Policy Only set then you will need to set this.
Valid only for DROPBOX provider. Upload chunk size in MiB. Must fit in memory. Note that these chunks are buffered in memory and there might be a maximum of --transfers chunks in progress at once. Dropbox Business accounts can have monthly data transfer limits per team per month. By using larger chunk sizes you will decrease the number of data transfer calls used and you'll be able to transfer more data to your Dropbox Business account.
Value must be greater or equal to 5 and strictly lesser than 150
Valid only for GOOGLE_DRIVER provider. Allow files which return cannotDownloadAbusiveFile to be downloaded. If downloading a file returns the error "This file has been identified as malware or spam and cannot be downloaded" with the error code "cannotDownloadAbusiveFile" then enable this flag to indicate you acknowledge the risks of downloading the file and TrueNAS will download it anyway.
Valid only for S3 provider. S3 Region.
Valid only for S3 provider. Server-Side Encryption.
Valid only for S3 provider. The storage class to use.
Cron schedule dictating when the task should run.
No Additional Properties"00" - "23"
"1" - "31"
"1" (January) - "12" (December)
"1" (Monday) - "7" (Sunday)
A Bash script to run immediately before every backup.
A Bash script to run immediately after every backup if it succeeds.
Whether to create a temporary snapshot of the dataset before every backup.
Paths to pass to restic backup --include.
Must be at least 1 characters long
Paths to pass to restic backup --exclude.
Must be at least 1 characters long
(Slated for removal).
Can enable/disable the task.
Information regarding the task's job state, e.g. progress.
A locked task cannot run.
Schedule of bandwidth limits.
No Additional ItemsTime at which the bandwidth limit takes effect in 24-hour format.
"00:00"
"06:30"
"18:00"
"23:00"
Bandwidth limit in bytes per second (upload and download).
Value must be strictly greater than 0
Value must be strictly greater than 0
The name of the task to display in the UI.
The local path to back up beginning with /mnt or /dev/zvol.
Cloud credentials to use for each backup.
No Additional PropertiesMust be at least 1 characters long
"AZUREBLOB" Must be at least 1 characters long
Must be at least 1 characters long
"" Must be at least 1 characters long
Must be at most 2083 characters long
"B2" Must be at least 1 characters long
Must be at least 1 characters long
"BOX" Must be at least 1 characters long
"DROPBOX" Must be at least 1 characters long
"FTP" Must be at least 1 characters long
Must be at least 1 characters long
"GOOGLE_CLOUD_STORAGE" Must be at least 1 characters long
"GOOGLE_DRIVE" Must be at least 1 characters long
"GOOGLE_PHOTOS" Must be at least 1 characters long
"HTTP" Must be at least 1 characters long
Must be at most 2083 characters long
"HUBIC" Must be at least 1 characters long
"MEGA" Must be at least 1 characters long
Must be at least 1 characters long
"ONEDRIVE" Must be at least 1 characters long
"PCLOUD" Must be at least 1 characters long
"S3" Must be at least 1 characters long
Must be at least 1 characters long
"SFTP" Must be at least 1 characters long
Must be at least 1 characters long
"STORJ_IX" Must be at least 1 characters long
Must be at least 1 characters long
Must be at least 1 characters long
Must be at most 2083 characters long
"OPENSTACK_SWIFT" Must be at least 1 characters long
Must be at least 1 characters long
Must be at least 1 characters long
"WEBDAV" Must be at least 1 characters long
Must be at most 2083 characters long
"YANDEX" Must be at least 1 characters long
Additional information for each backup, e.g. bucket name.
No Additional PropertiesMust be at least 1 characters long
Valid only for some providers. Use fewer transactions in exchange for more RAM. This may also speed up or slow down your transfer. See https://rclone.org/docs/#fast-list for more details.
Valid only for GOOGLECLOUDSTORAGE provider. Access checks should use bucket-level IAM policies. If you want to upload objects to a bucket with Bucket Policy Only set then you will need to set this.
Valid only for DROPBOX provider. Upload chunk size in MiB. Must fit in memory. Note that these chunks are buffered in memory and there might be a maximum of --transfers chunks in progress at once. Dropbox Business accounts can have monthly data transfer limits per team per month. By using larger chunk sizes you will decrease the number of data transfer calls used and you'll be able to transfer more data to your Dropbox Business account.
Value must be greater or equal to 5 and strictly lesser than 150
Valid only for GOOGLE_DRIVER provider. Allow files which return cannotDownloadAbusiveFile to be downloaded. If downloading a file returns the error "This file has been identified as malware or spam and cannot be downloaded" with the error code "cannotDownloadAbusiveFile" then enable this flag to indicate you acknowledge the risks of downloading the file and TrueNAS will download it anyway.
Valid only for S3 provider. S3 Region.
Valid only for S3 provider. Server-Side Encryption.
Valid only for S3 provider. The storage class to use.
Cron schedule dictating when the task should run.
No Additional Properties"00" - "23"
"1" - "31"
"1" (January) - "12" (December)
"1" (Monday) - "7" (Sunday)
A Bash script to run immediately before every backup.
A Bash script to run immediately after every backup if it succeeds.
Whether to create a temporary snapshot of the dataset before every backup.
Paths to pass to restic backup --include.
Must be at least 1 characters long
Paths to pass to restic backup --exclude.
Must be at least 1 characters long
(Slated for removal).
Can enable/disable the task.
Information regarding the task's job state, e.g. progress.
A locked task cannot run.
Schedule of bandwidth limits.
No Additional ItemsTime at which the bandwidth limit takes effect in 24-hour format.
"00:00"
"06:30"
"18:00"
"23:00"
Bandwidth limit in bytes per second (upload and download).
Value must be strictly greater than 0
Value must be strictly greater than 0