Plugin Options

Enterprise

Bacula Enterprise Only

This solution is only available for Bacula Enterprise. For subscription inquiries, please reach out to sales@baculasystems.com.

  • database=<glob> Specifies the name of the databases to backup. This parameter is optional. By default, all databases (except tempdb) will be backed up.

  • include=<glob> Specifies the names of databases to backup. It is possible to specify the include parameter multiple times on the plugin command line.

    If a database that was explicitly specified is not found, a warning or error message will be printed to the Job report. The abort_on_error option is adhered to.

  • exclude=<glob> Specifies the names of databases to exclude from the backup. It is possible to specify the exclude parameter multiple times on the plugin command line.

  • user=<str> The username used to connect to the MSSQL instance. If the user is part of a domain, please also specify the domain parameter below. If no domain is specified the user parameter will refer to a local account. This parameter is optional, and if not set, the bacula-fd service account will be used to connect to the MSSQL instance.

  • domain=<str> The domain of the user used to connect to the MSSQL instance. This parameter is optional. If not set and no user is set, the bacula-fd service account will be used to connect to the MSSQL instance. If not set and a user is set, the user is assumed to be a local account.

  • password=<str> The password used to connect to the MSSQL instance. This parameter is optional, and if set, the password might be printed in various places such as status client output, job log or debug messages.

  • passfile=<file> The file where the password can be found. This parameter is optional. The plugin will use the first line (limited to 127 characters) as the connection password.

  • authtype=[windows | server] The authentication type used to connect to the MSSQL instance. This parameter is optional. By default the Windows authentication type is used.

  • instance=<str> The instance name used to connect to the MSSQL instance. This parameter is optional. By default, the instance name is “MSSQLSERVER”.

    Attention

    New in Bacula Enterprise 12.8.0

    Multiple instance parameters are allowed.

  • Attention

    New in Bacula Enterprise 12.8.0

    all_instances This parameter is optional. If set, the MSSQL plugin will list and backup all instances defined on the SQL Server. The same authentication settings should be available on each instance.

  • hostname=<str> This parameter is optional. If set, the hostname string will be used in the Server connection string of the ODBC driver. If not set, the plugin will configure automatically the ODBC driver to use (localdb) or (local). This advanced option might be used in conjunction with the instance option, often, it is necessary to specify “.” as hostname parameter. Ex: instance=MYINSTANCE hostname=.

  • abort_on_error By default, if the plugin is not able to reach the MSSQL instance, or to find an explicitly named database, an error will be generated and the job will continue. Some users might prefer to abort the Job, which will happen if this option is set.

  • copyonly[=incremental|all] A copy-only backup is a MSSQL backup that is independent of the sequence of conventional MSSQL backups. The next Differential or Transaction Log (Incremental) backup will not use it. If the incremental option is set, only Transaction Log (Incremental) backups will use the option. The last Incremental job will contain all the information necessary to perform a point in time recovery.

  • fullbackup Force the level of the MSSQL backup. If specified in the plugin command line, a job can run with the incremental level for standard files, and the databases backed up with the plugin will always be backed up like with a Full backup. (Available since 8.4.11)

  • skipreadonly Skip read only databases when the backup level is incremental (BACKUP LOG) and the last modification/creation time for tables and views is prior to the last backup. By default, read only databases are upgraded to Full. (Available since 8.6.20)

  • dblayout Store each database layout as a RestoreObject in the Bacula Catalog with a Full backup. The layout can be displayed in bconsole with list restoreobjects command. (Available since 8.6.20)

  • lock_timeout=<int> Use the SET LOCK_TIMEOUT before issuing queries. (Available since 8.6.20)

  • buffercount=<int> Specifies the total number of I/O buffers to be used for the backup operation. You can specify any positive integer; however, large numbers of buffers might cause “out of memory” errors because of inadequate virtual address space in the Sqlservr.exe process. This parameter is optional and the default value is 10.

  • blocksize=<bytes> Specifies the physical block size, in bytes. The supported sizes are 512, 1024, 2048, 4096, 8192, 16384, 32768, and 65536 (64 KB) bytes. This parameter is optional and the default is 65536.

  • maxtransfersize=<bytes> Specifies the largest unit of transfer in bytes to be used between the MSSQL Server and the backup media. The possible values are multiples of 65536 bytes (64 KB) ranging up to 4194304 bytes (4 MB). This parameter is optional and the default is 65536.

  • connection_string=<str> Specifies the ODBC connection string. This parameter is optional.

  • checksum=<No/Yes>

    Available since Bacula Enterprise 8.11.6

    Use the WITH CHECKSUM option in the backup query. This parameter is optional and the default is no.

  • driver=<str>

    Available since Bacula Enterprise 10.2.3

    The driver name used in the ODBC connection string. Default is SQL Server. If the connection_string option is set, it will overwrite this option.

  • target_backup_recovery_models=<str>

    Available since Bacula Enterprise 10.2.4

    Only the databases with the specified recovery model are backuped. The other databases are skipped with warning. The parameter should be on of the following:

    • SIMPLE

    • FULL

    • BULK_LOGGED

  • simple_recovery_models_incremental_action=<str>

    Available since Bacula Enterprise 10.2.4

    Specifies the behavior when incremental backup is requested over a simple recovery model database from the following parameters:

    • make_full : The incremental backup is automatically upgraded to full.

    • ignore_with_error : The backup is skipped with an error (the error translated to a warning at the job level).

    • ignore : The backup is skipped silently.

See also

Previous articles:

Next articles:

Go back to: MSSQL VDI: Configuration.