cloudsync.sync_onetime ====================== Run cloud sync task without creating it. This method is a job. .. raw:: html
Cloud sync task configuration for one-time execution.
No Additional PropertiesThe name of the task to display in the UI.
The local path to back up beginning with /mnt or /dev/zvol.
ID of the cloud credential.
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.
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
Maximum number of parallel file transfers. null for default.
Value must be strictly greater than 0
Direction of the cloud sync operation.
PUSH: Upload local files to cloud storagePULL: Download files from cloud storage to local storageHow files are transferred between local and cloud storage.
SYNC: Synchronize directories (add new, update changed, remove deleted)COPY: Copy files without removing any existing filesMOVE: Move files (copy then delete from source)Whether to encrypt files before uploading to cloud storage.
Whether to encrypt filenames in addition to file contents.
Password for client-side encryption. Empty string if encryption is disabled.
Salt value for encryption key derivation. Empty string if encryption is disabled.
Whether to create empty directories in the destination that exist in the source.
Whether to follow symbolic links and sync the files they point to.
Options for the one-time sync operation.
No Additional PropertiesWhether to perform a dry run without making actual changes.
Returns null when the one-time sync operation is successfully started.