Unique identifier for this cloud storage configuration.
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 PropertiesUnique identifier for the cloud credential.
Human-readable name for the cloud credential.
Must be at least 1 characters long
Cloud provider configuration including type and authentication details.
Cloud provider type identifier for Microsoft Azure Blob storage.
Specific value:"AZUREBLOB"
Azure Blob Storage account name for authentication.
Must be at least 1 characters long
Azure Blob Storage access key for authentication.
Must be at least 1 characters long
Custom Azure Blob Storage endpoint URL. Empty string for default endpoints.
""
Must be at least 1 characters long
Must be at most 2083 characters long
Cloud provider type identifier for Backblaze B2 storage.
Specific value:"B2"
Backblaze B2 account ID for authentication.
Must be at least 1 characters long
Backblaze B2 application key for authentication.
Must be at least 1 characters long
Cloud provider type identifier for Box cloud storage.
Specific value:"BOX"
Box OAuth application client ID.
Box OAuth application client secret.
Box OAuth access token for API authentication.
Must be at least 1 characters long
Cloud provider type identifier for Dropbox storage.
Specific value:"DROPBOX"
Dropbox OAuth application client ID.
Dropbox OAuth application client secret.
Dropbox OAuth access token for API authentication.
Must be at least 1 characters long
Cloud provider type identifier for FTP.
Specific value:"FTP"
FTP server hostname or IP address.
Must be at least 1 characters long
FTP server port number.
FTP username for authentication.
Must be at least 1 characters long
FTP password for authentication.
Cloud provider type identifier for Google Cloud Storage.
Specific value:"GOOGLE_CLOUD_STORAGE"
JSON service account credentials for Google Cloud Storage authentication.
Must be at least 1 characters long
Cloud provider type identifier for Google Drive.
Specific value:"GOOGLE_DRIVE"
OAuth client ID for Google Drive API access.
OAuth client secret for Google Drive API access.
OAuth access token for Google Drive authentication.
Must be at least 1 characters long
Google Drive team drive ID or empty string for personal drive.
Cloud provider type identifier for Google Photos.
Specific value:"GOOGLE_PHOTOS"
OAuth client ID for Google Photos API access.
OAuth client secret for Google Photos API access.
OAuth access token for Google Photos authentication.
Must be at least 1 characters long
Cloud provider type identifier for HTTP.
Specific value:"HTTP"
HTTP URL for file access.
Must be at least 1 characters long
Must be at most 2083 characters long
Cloud provider type identifier for Hubic.
Specific value:"HUBIC"
OAuth access token for Hubic authentication.
Must be at least 1 characters long
Cloud provider type identifier for MEGA.
Specific value:"MEGA"
MEGA username for authentication.
Must be at least 1 characters long
MEGA password for authentication.
Must be at least 1 characters long
Cloud provider type identifier for OneDrive.
Specific value:"ONEDRIVE"
OAuth client ID for OneDrive API access.
OAuth client secret for OneDrive API access.
OAuth access token for OneDrive authentication.
Must be at least 1 characters long
Type of OneDrive to access.
OneDrive drive identifier.
Cloud provider type identifier for pCloud.
Specific value:"PCLOUD"
OAuth client ID for pCloud API access.
OAuth client secret for pCloud API access.
OAuth access token for pCloud authentication.
Must be at least 1 characters long
pCloud hostname or empty string for default.
Cloud provider type identifier for S3-compatible storage.
Specific value:"S3"
S3 access key ID for authentication.
Must be at least 1 characters long
S3 secret access key for authentication.
Must be at least 1 characters long
S3-compatible endpoint URL or empty string for AWS S3.
S3 region or empty string for default.
Whether to skip region validation.
Whether to use AWS Signature Version 2.
Maximum number of parts for multipart uploads.
S3 provider. See cloudsync.credentials.s3_provider_choices for possible values.
If true use path style access if false use virtual hosted style.
Cloud provider type identifier for SFTP.
Specific value:"SFTP"
SFTP server hostname or IP address.
Must be at least 1 characters long
SFTP server port number.
SFTP username for authentication.
Must be at least 1 characters long
SFTP password for authentication or null for key-based auth.
SSH private key ID for authentication or null for password auth.
Cloud provider type identifier for Storj decentralized storage.
Specific value:"STORJ_IX"
Storj S3-compatible access key ID for authentication.
Must be at least 1 characters long
Storj S3-compatible secret access key for authentication.
Must be at least 1 characters long
Storj gateway endpoint URL for S3-compatible access.
Must be at least 1 characters long
Must be at most 2083 characters long
Cloud provider type identifier for OpenStack Swift storage.
Specific value:"OPENSTACK_SWIFT"
Swift username for authentication.
Must be at least 1 characters long
Swift password or API key for authentication.
Must be at least 1 characters long
Swift authentication URL endpoint.
Must be at least 1 characters long
Swift user ID for authentication.
Swift domain name for authentication.
Swift tenant name for multi-tenancy.
Swift tenant ID for multi-tenancy.
Swift tenant domain name.
Swift region name for geographic distribution.
Swift storage URL endpoint.
Swift authentication token for pre-authenticated access.
Swift application credential ID for authentication.
Swift application credential name for authentication.
Swift application credential secret for authentication.
Swift authentication API version.
0: Legacy auth1: TempAuth2: Keystone v2.03: Keystone v3null: Auto-detectSwift endpoint type to use.
public: Public endpoint (default)internal: Internal network endpointadmin: Administrative endpointnull: Use defaultCloud provider type identifier for WebDAV servers.
Specific value:"WEBDAV"
WebDAV server URL endpoint.
Must be at least 1 characters long
Must be at most 2083 characters long
WebDAV server vendor type for compatibility optimizations.
NEXTCLOUD: Nextcloud serverOWNCLOUD: ownCloud serverSHAREPOINT: Microsoft SharePointOTHER: Generic WebDAV serverWebDAV username for authentication.
WebDAV password for authentication.
Cloud provider type identifier for Yandex Disk storage.
Specific value:"YANDEX"
Yandex OAuth application client ID.
Yandex OAuth application client secret.
Yandex OAuth access token for API authentication.
Must be at least 1 characters long
Additional information for each backup, e.g. bucket name.
No Additional PropertiesName of the cloud storage bucket or container.
Must be at least 1 characters long
Path within the cloud storage bucket to use as the root directory for operations.
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.
Password for the remote repository.
Must be at least 1 characters long
How many of the most recent backup snapshots to keep after each backup.
Value must be strictly greater than 0
DEFAULT:
$RESTIC_PACK_SIZE (default 16 MiB)$RESTIC_READ_CONCURRENCY (default 2 files)PERFORMANCE:
$RESTIC_READ_CONCURRENCY (default 2 files)FAST_STORAGE:
Preserve absolute paths in each backup (cannot be set when snapshot=True).
Cache path. If not set, performance may degrade.
Maximum upload/download rate in KiB/s. Passed to restic --limit-upload on cloud_backup.sync and restic --limit-download on cloud_backup.restore. null indicates no rate limit will be imposed.
Can be overridden on a sync or restore call.
Value must be strictly greater than 0
Unique identifier for this cloud storage configuration.
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 PropertiesUnique identifier for the cloud credential.
Human-readable name for the cloud credential.
Must be at least 1 characters long
Cloud provider configuration including type and authentication details.
Cloud provider type identifier for Microsoft Azure Blob storage.
Specific value:"AZUREBLOB"
Azure Blob Storage account name for authentication.
Must be at least 1 characters long
Azure Blob Storage access key for authentication.
Must be at least 1 characters long
Custom Azure Blob Storage endpoint URL. Empty string for default endpoints.
""
Must be at least 1 characters long
Must be at most 2083 characters long
Cloud provider type identifier for Backblaze B2 storage.
Specific value:"B2"
Backblaze B2 account ID for authentication.
Must be at least 1 characters long
Backblaze B2 application key for authentication.
Must be at least 1 characters long
Cloud provider type identifier for Box cloud storage.
Specific value:"BOX"
Box OAuth application client ID.
Box OAuth application client secret.
Box OAuth access token for API authentication.
Must be at least 1 characters long
Cloud provider type identifier for Dropbox storage.
Specific value:"DROPBOX"
Dropbox OAuth application client ID.
Dropbox OAuth application client secret.
Dropbox OAuth access token for API authentication.
Must be at least 1 characters long
Cloud provider type identifier for FTP.
Specific value:"FTP"
FTP server hostname or IP address.
Must be at least 1 characters long
FTP server port number.
FTP username for authentication.
Must be at least 1 characters long
FTP password for authentication.
Cloud provider type identifier for Google Cloud Storage.
Specific value:"GOOGLE_CLOUD_STORAGE"
JSON service account credentials for Google Cloud Storage authentication.
Must be at least 1 characters long
Cloud provider type identifier for Google Drive.
Specific value:"GOOGLE_DRIVE"
OAuth client ID for Google Drive API access.
OAuth client secret for Google Drive API access.
OAuth access token for Google Drive authentication.
Must be at least 1 characters long
Google Drive team drive ID or empty string for personal drive.
Cloud provider type identifier for Google Photos.
Specific value:"GOOGLE_PHOTOS"
OAuth client ID for Google Photos API access.
OAuth client secret for Google Photos API access.
OAuth access token for Google Photos authentication.
Must be at least 1 characters long
Cloud provider type identifier for HTTP.
Specific value:"HTTP"
HTTP URL for file access.
Must be at least 1 characters long
Must be at most 2083 characters long
Cloud provider type identifier for Hubic.
Specific value:"HUBIC"
OAuth access token for Hubic authentication.
Must be at least 1 characters long
Cloud provider type identifier for MEGA.
Specific value:"MEGA"
MEGA username for authentication.
Must be at least 1 characters long
MEGA password for authentication.
Must be at least 1 characters long
Cloud provider type identifier for OneDrive.
Specific value:"ONEDRIVE"
OAuth client ID for OneDrive API access.
OAuth client secret for OneDrive API access.
OAuth access token for OneDrive authentication.
Must be at least 1 characters long
Type of OneDrive to access.
OneDrive drive identifier.
Cloud provider type identifier for pCloud.
Specific value:"PCLOUD"
OAuth client ID for pCloud API access.
OAuth client secret for pCloud API access.
OAuth access token for pCloud authentication.
Must be at least 1 characters long
pCloud hostname or empty string for default.
Cloud provider type identifier for S3-compatible storage.
Specific value:"S3"
S3 access key ID for authentication.
Must be at least 1 characters long
S3 secret access key for authentication.
Must be at least 1 characters long
S3-compatible endpoint URL or empty string for AWS S3.
S3 region or empty string for default.
Whether to skip region validation.
Whether to use AWS Signature Version 2.
Maximum number of parts for multipart uploads.
S3 provider. See cloudsync.credentials.s3_provider_choices for possible values.
If true use path style access if false use virtual hosted style.
Cloud provider type identifier for SFTP.
Specific value:"SFTP"
SFTP server hostname or IP address.
Must be at least 1 characters long
SFTP server port number.
SFTP username for authentication.
Must be at least 1 characters long
SFTP password for authentication or null for key-based auth.
SSH private key ID for authentication or null for password auth.
Cloud provider type identifier for Storj decentralized storage.
Specific value:"STORJ_IX"
Storj S3-compatible access key ID for authentication.
Must be at least 1 characters long
Storj S3-compatible secret access key for authentication.
Must be at least 1 characters long
Storj gateway endpoint URL for S3-compatible access.
Must be at least 1 characters long
Must be at most 2083 characters long
Cloud provider type identifier for OpenStack Swift storage.
Specific value:"OPENSTACK_SWIFT"
Swift username for authentication.
Must be at least 1 characters long
Swift password or API key for authentication.
Must be at least 1 characters long
Swift authentication URL endpoint.
Must be at least 1 characters long
Swift user ID for authentication.
Swift domain name for authentication.
Swift tenant name for multi-tenancy.
Swift tenant ID for multi-tenancy.
Swift tenant domain name.
Swift region name for geographic distribution.
Swift storage URL endpoint.
Swift authentication token for pre-authenticated access.
Swift application credential ID for authentication.
Swift application credential name for authentication.
Swift application credential secret for authentication.
Swift authentication API version.
0: Legacy auth1: TempAuth2: Keystone v2.03: Keystone v3null: Auto-detectSwift endpoint type to use.
public: Public endpoint (default)internal: Internal network endpointadmin: Administrative endpointnull: Use defaultCloud provider type identifier for WebDAV servers.
Specific value:"WEBDAV"
WebDAV server URL endpoint.
Must be at least 1 characters long
Must be at most 2083 characters long
WebDAV server vendor type for compatibility optimizations.
NEXTCLOUD: Nextcloud serverOWNCLOUD: ownCloud serverSHAREPOINT: Microsoft SharePointOTHER: Generic WebDAV serverWebDAV username for authentication.
WebDAV password for authentication.
Cloud provider type identifier for Yandex Disk storage.
Specific value:"YANDEX"
Yandex OAuth application client ID.
Yandex OAuth application client secret.
Yandex OAuth access token for API authentication.
Must be at least 1 characters long
Additional information for each backup, e.g. bucket name.
No Additional PropertiesName of the cloud storage bucket or container.
Must be at least 1 characters long
Path within the cloud storage bucket to use as the root directory for operations.
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.
Password for the remote repository.
Must be at least 1 characters long
How many of the most recent backup snapshots to keep after each backup.
Value must be strictly greater than 0
DEFAULT:
$RESTIC_PACK_SIZE (default 16 MiB)$RESTIC_READ_CONCURRENCY (default 2 files)PERFORMANCE:
$RESTIC_READ_CONCURRENCY (default 2 files)FAST_STORAGE:
Preserve absolute paths in each backup (cannot be set when snapshot=True).
Cache path. If not set, performance may degrade.
Maximum upload/download rate in KiB/s. Passed to restic --limit-upload on cloud_backup.sync and restic --limit-download on cloud_backup.restore. null indicates no rate limit will be imposed.
Can be overridden on a sync or restore call.
Value must be strictly greater than 0