Generic Plugin Parameters

The following XenServer Plugin parameters effect any type of Job (Backup, Estimation, or Restore).

url=<address>: specifies the XenServer API url address used for operations. This parameter is optional. If omitted the parameter will be assembled from server=… and port=… parameters defined below. You have to define the one of url or server parameters to connect to the XenServer API.
server=<address>: specifies the XenServer API address used for operations. This parameter is optional if url=… parameter above is defined. This is the address used in xe command as -s <address> parameter during restore in legacy mode.
port=<number>: specifies the XenServer API port used for operations. The value of the parameter have to be in range 1..65536. Invalid value will abort the job. This parameter is optional. If omitted the default 80/http access will be used. This is the value used in xe command as -p <number> parameter during restore in legacy mode.
user=<string>: specifies the user name used to access the XenServer API. This parameter is required. This is the value used in xe command as -u <string> parameter during restore in legacy mode.
password=<string>: specifies the password used to access the XenServer API. This parameter is optional if passfile=… is provided else it is required. This is the value used in xe command as -pw <string> parameter during restore in legacy mode. It is advised to use the passfile= option for more security.
passfile=<string>: specifies a file local to the File Daemon that contains the password for the user name. This parameter is optional if password=… is provided else it is required. This is the value used in xe command as -pwf <string> parameter during restore in legacy mode.
abort_on_error[=<0 or 1>]: specifies whether or not the plugin should abort it’s execution if a fatal error happens during Backup, Estimation or Restore. This parameter is optional. The default value is 0.
ignore_ssl[=<0 or 1>]: specifies whether or not the plugin should ignore SSL certificate checking when connecting to XenServer API. This parameter is optional. The default value is 0. With NBD-SSL configuration this parameter is not needed.
certfile=<string>: Enable NBD-SSL communication during backup and use the specified file as the client certificate for TLS authentication to the server. This parameter is optional.
cacertfile=<string>: Enable NBD-SSL communication during backup and use the specified file as the CA certificate for TLS authentication to the server. This parameter is optional.
keyfile=<string>: Enable NBD-SSL communication during backup and use the specified file as the private key for the client cerificate. This parameter is optional.
tlshostname=<string>: Enable NBD-SSL communication during backup and use the specified hostname for the TLS context. If not specified, the hostname used to connect to the server will be used. This parameter is optional even if NBD-SSL connection is desired and normally it is not needed, but if you get any ‘tls hostname not matching’ kind of error, set a hostname here that is accepted in your TLS certificate CN values, as the behavior of the underlying NBD tools can vary among different environments.

Important

certfile, cacertfile, keyfile and tlshostname are available since Bacula Enterprise 18.0.4.