cloudsync.sync_onetime

Run cloud sync task without creating it.

Type: object

Call parameters

Type: array
No Additional Items

Tuple Validation

Parameter 1: cloud_sync_sync_onetime

cloud_sync_sync_onetime

Type: object
No Additional Properties

description

Description

Type: string Default: ""

The name of the task to display in the UI

path Required

Path

Type: string

The local path to back up beginning with /mnt or /dev/zvol

credentials Required

Credentials

Type: integer

ID of the cloud credential

attributes Required

Attributes

Type: object

Additional information for each backup, e.g. bucket name

schedule

CloudCron

Type: object

Cron schedule dictating when the task should run

No Additional Properties

minute

Minute

Type: string Default: "00"

hour

Hour

Type: string Default: "*"

"00" - "23"

dom

Dom

Type: string Default: "*"

"1" - "31"

month

Month

Type: string Default: "*"

"1" (January) - "12" (December)

dow

Dow

Type: string Default: "*"

"1" (Monday) - "7" (Sunday)

pre_script

Pre Script

Type: string Default: ""

A Bash script to run immediately before every backup

post_script

Post Script

Type: string Default: ""

A Bash script to run immediately after every backup if it succeeds

snapshot

Snapshot

Type: boolean Default: false

Whether to create a temporary snapshot of the dataset before every backup

include

Include

Type: array of string

Paths to pass to restic backup --include

No Additional Items

Each item of this array must be:

Type: string

Must be at least 1 characters long

exclude

Exclude

Type: array of string

Paths to pass to restic backup --exclude

No Additional Items

Each item of this array must be:

Type: string

Must be at least 1 characters long

args

Args

Type: string Default: ""

(Slated for removal)

enabled

Enabled

Type: boolean Default: true

Can enable/disable the task

bwlimit

Bwlimit

Type: array of object
No Additional Items

Each item of this array must be:

CloudSyncBwlimit

Type: object
No Additional Properties

time Required

Time

Type: string

bandwidth Required

Bandwidth

Any of

• Option 1
• Option 2

Type: integer

Value must be strictly greater than 0

Type: null

transfers

Transfers

Default: null

Any of

• Option 1
• Option 2

Type: integer

Value must be strictly greater than 0

Type: null

direction Required

Direction

Type: enum (of string)

Must be one of:

• "PUSH"
• "PULL"

transfer_mode Required

Transfer Mode

Type: enum (of string)

Must be one of:

• "SYNC"
• "COPY"
• "MOVE"

encryption

Encryption

Type: boolean Default: false

filename_encryption

Filename Encryption

Type: boolean Default: false

encryption_password

Encryption Password

Type: string Default: ""

encryption_salt

Encryption Salt

Type: string Default: ""

create_empty_src_dirs

Create Empty Src Dirs

Type: boolean Default: false

follow_symlinks

Follow Symlinks

Type: boolean Default: false

Parameter 2: cloud_sync_sync_onetime_options

cloud_sync_sync_onetime_options

Type: object
No Additional Properties

dry_run

Dry Run

Type: boolean Default: false

Return value

Result

Type: null

Required roles: CLOUD_SYNC_WRITE