docker.backup_to_pool

Create a backup of existing apps on target_pool.

This creates a backup of existing apps on the target_pool specified. If this is executed multiple times, in the next iteration it will incrementally backup the apps that have changed since the last backup.

Note: This will stop the docker service (which means current active apps will be stopped) and then start it again after snapshot has been taken of the current apps dataset.

This method is a job.

Type: object

Type: array
No Additional Items

Tuple Validation

Parameter 1: target_pool

target_pool

Type: string

Name of the storage pool to backup Docker data to.

Must be at least 1 characters long

Result

Type: null

Returns null when the pool backup is successfully started.


Required roles: DOCKER_WRITE