Estimate and Backup Plugin Parameters

These plugin parameters are relevant only for Backup and Estimation jobs:

container=<name-label>|<id>

specifies a Docker container to backup. Multiple container=... parameters are allowed. If container with name-label can not be found, then a single job error will be generated and the backup will proceed to the next container unless abort_on_error is set which will cause the backup job to be aborted. You can use Docker container names (name-label) or container id () to select required container to backup.

This parameter is optional.

image=<repository:tag>|<id>

specifies a Docker image to backup. Multiple image=... parameters are allowed. If image with repository:tag can not be found, then a single job error will be generated and the backup will proceed to the next image unless abort_on_error is set which will cause the backup job to be aborted. You can use Docker image repository and tag names (repository:tag) or image id () to select required image to backup. This parameter is optional.

include_container=<name-label-regex>

specifies a list of Docker container names to backup using regular expression syntax. All containers with names matching the regular expression provided will be selected for backup. Multiple include_container=… parameters may be provided.

If no containers are matching the name expression provided, the backup will proceed to the next parameter or finish successfully without backing up any containers. The abort_on_error parameter will not abort the job when no containers are found using name matching. This parameter is optional.

include_image=<repository-regex>

specifies a list of Docker image repository names to backup using regular expression syntax. All images with repository name matching the regular expression provided will be selected for backup. Multiple include_images=… parameters may be provided.

If no images are matching the repository name expression provided, the backup will proceed to the next parameter or finish successfully without backing up any images. The abort_on_error parameter will not abort the job when no images are found using repository name matching. This parameter is optional.

exclude_container=<name-label-regex>

specifies a list of a Docker container names which will be excluded from backup using regular expression matching. All containers with names matching the provided regular expression, and selected for backup using the include_container=… parameter will be excluded. This parameter does not affect any containers selected to be backed up using container=… parameter. Multiple exclude_container=… parameters may be provided. This parameter is optional.

exclude_image=<repository-regex>

specifies a list of a Docker image repository names which will be excluded from backup using regular expression matching. All images with repository names matching the provided regular expression, and selected for backup using the include_image=… parameter will be excluded. This parameter does not affect any images selected to be backed up using image=… parameter. Multiple exclude_image=… parameters may be provided. This parameter is optional.

volume=<name>

specifies the Docker volume to backup. Multiple volume=... parameters are allowed. If volume with name can not be found, then a single job error will be generated and the backup will proceed to the next volume unless abort_on_error is set which will cause the backup job to be aborted.

This parameter is optional.

allvolumes

specifies the automatic Docker volumes selection for backup for every container selected. You should configure a single allvolumes parameter if required.

This parameter is optional.

mode=<pause|nopause>

specifies the default backup mode for containers to use. The pause mode will generate backup using container pause commit which quiesce I/O operations during backup and allow to achieve a consistent backup with some possible downtime. The container will remain suspended during backup commit phase and will resume once the commit operation finishes. The nopause mode will commit container without quiesce I/O operations. This parameter is optional. If not set then pause mode will be used by default.

timeout=nn

specifies the default timeout for connecting to Bacula Archive container during volume backup. The default is 30 seconds if parameter is not specified. The value <nn> specifies a number of seconds how long plugin will wait. The value zero (0) is invalid.

This parameter is optional.

If none of the parameters container=…, image=…, include_container=… , include_image=…, and exclude=… are specified, all available containers and images on Docker will be backed up.