Options

Scan Plugin Options

Options	Required	Default	Info	Example
client <val>	Yes		Bacula Director Client resource name	--client 127.0.0.1-fd
parameter <val>	No		Plugin object parameter name.	--parameter vm
plugin <val>	Yes		Bacula Plugin name	--plugin vsphere
plugin_option <val>…	Yes		Plugin options	--plugin_option use_sudo
uuid <val>	No	client:plugin	UUID of the execution	--uuid 03Mars23
exclude <val>…	No		Pattern for object exclusion	--exclude "test.*"
include <val>…	No		Pattern for object inclusion	--include "test.*"
object-exclude <val>…	No		String for object exclusion	--object-exclude "test"
object-include <val>…	No		String for object inclusion	--object-include "test"
commit_and_reload	No	No	Apply the new configuration to the Director	--commit_and_reload
directive <val>…	No		Bacula Director Job directive	--directive Priority=10
fileset <val>	No	F_%c_%p_%v	Bacula Director FileSet name template	--fileset database-%v
fs_option <val>…	No		Bacula Director FileSet Option directive	--fs_option signature=md5
hook <val>	No		Execute a script for each new/old object	--hook /scripts/editfstab
job <val>	No	J_%c_%p_%v	Bacula Director Job name template	--job database-%v
jobdefs <val>	Yes		Bacula Director JobDefs resource name	--jobdefs BackupsToDisk
remove_jobs	No	No	Remove resources that are no longer necessary	--remove_jobs
scan_option <val>…	No		Use a specific set of plugin option for the scan	--scan_option user=root
use_uuid	No	No	Use object UUID in the FileSet Plugin command	--use_uuid

Options in the table with a … can be used multiple times on the command line. Other options for the format output and the command line parsing are available with the --help option.

The parameter option shouldn’t be required. If it is not the case, contact Bacula Systems Support.

The plugin_option parameter can be used as many times as you wish, with all the options you should have configured for the plugin specified in the plugin parameter. Check the specific documentation for the plugin to correctly setup the plugin_option values. They should be similar to the ones you use in the plugin line in the FileSet resource for the plugin.

The JobDefs is used to ease the configuration of the new Jobs created by the Scan Plugin.

JobDefs {
   Name = BackupsToDisk
   Type = Backup
   Pool = DiskBackup365
   Level = Incremental
   Messages = Default
   Storage = DiskAutochanger
   MaximumConcurrentJobs = 5
}

Specific options can be added with the --directive** parameter, e.g.:

--directive Priority=10 --directive MaximumRunTime=5h

By default, when an object is no longer available (like if a virtual machine is deleted), the Scan Plugin will disable the corresponding Job. With the --remove_job option, the Job and the Fileset can be deleted from the configuration.

The --job and --fileset parameters can use the following shortcuts:

• %c : Client name

• %p : Plugin name

• %v : Object name

Example:

--job %c-%p-%v --fileset fileset-%p-%v

The Scan Plugin will automatically adjust the name if the result string is too long or already exists.

See also

• Go back to Scan Plugin Installation

• Go back to Scan Plugin Usage

• Go to Scan Plugin Examples

Go back to the main Automatic Object Integration (Scan Plugin) page.