cloud_backup.get_instance¶
Returns instance matching id. If id is not found, Validation error is raised.
Please see query method documentation for options.
No Additional Items
Tuple Validation
Parameter 1: id
id
Type: integerParameter 2: options
options
Type: object Default: {}No Additional Properties
Relationships
Type: boolean Default: trueExtend
Default: nullExtend Context
Default: nullPrefix
Default: nullExtra
Type: object Default: {}Order By
Type: array of string Default: []No Additional Items
Each item of this array must be:
Select
Type: array Default: []No Additional Items
Each item of this array must be:
No Additional Items
Each item of this array must be:
Count
Type: boolean Default: falseGet
Type: boolean Default: falseOffset
Type: integer Default: 0Limit
Type: integer Default: 0Force Sql Filters
Type: boolean Default: falseCloudBackupEntry
Type: objectNo Additional Properties
Description
Type: string Default: ""The name of the task to display in the UI
Path
Type: stringThe local path to back up beginning with /mnt
or /dev/zvol
Cloud credentials to use for each backup
Attributes
Type: objectAdditional information for each backup, e.g. bucket name
Cron schedule dictating when the task should run
Pre Script
Type: string Default: ""A Bash script to run immediately before every backup
Post Script
Type: string Default: ""A Bash script to run immediately after every backup if it succeeds
Snapshot
Type: boolean Default: falseWhether to create a temporary snapshot of the dataset before every backup
Include
Type: array of string Default: []Paths to pass to restic backup --include
Each item of this array must be:
Must be at least 1
characters long
Exclude
Type: array of string Default: []Paths to pass to restic backup --exclude
Each item of this array must be:
Must be at least 1
characters long
Args
Type: string Default: ""(Slated for removal)
Enabled
Type: boolean Default: trueCan enable/disable the task
Password
Type: stringPassword for the remote repository
Must be at least 1
characters long
Keep Last
Type: integerHow many of the most recent backup snapshots to keep after each backup
Value must be strictly greater than 0
Transfer Setting
Type: enum (of string) Default: "DEFAULT"DEFAULT:
- pack size given by $RESTIC_PACK_SIZE
(default 16 MiB)
- read concurrency given by $RESTIC_READ_CONCURRENCY
(default 2 files)
PERFORMANCE:
- pack size = 29 MiB
- read concurrency given by $RESTIC_READ_CONCURRENCY
(default 2 files)
FAST_STORAGE:
- pack size = 58 MiB
- read concurrency = 100 files
Must be one of:
- "DEFAULT"
- "PERFORMANCE"
- "FAST_STORAGE"
Absolute Paths
Type: boolean Default: falseWhether to preserve absolute paths in each backup (cannot be set when snapshot=True
)
Id
Type: integerJob
Information regarding the task's job state, e.g. progress
Locked
Type: booleanA locked task cannot run
Required roles: CLOUD_BACKUP_READ