Backup Parameters

Enterprise

Bacula Enterprise Only

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

Important

Remember to read the Best Practices chapter common for all of our hypervisor plugins.

Openstack Backup Parameters

Parameter

Values

Default

Description

neutron_backup

<Yes or No>

No

Specify if the job should look for network related items to backup.

neutron_network_backup

<Yes or No>

Yes

Specify if the job should look for Neutron networks to backup.

neutron_subnet_backup

<Yes or No>

Yes

Specify if the job should look for Neutron subnetworks to backup.

nova_flavor_backup

<Yes or No>

No

Specify if the job should look for all Nova flavors to backup. The flavors for the Nova servers included in the backup are also included regardless this option is set or not.

glance_image_backup

<Yes or No>

No

Specify if the job should look for Glance images to backup.

image

<image name>

Specifies the name of a single image to back up, regardless of other include/exclude rules.

image_include

<Java Regexp>

Specifies a list of images names to back up. Uses Java-compatible regular expressions.

image_exclude

<Java Regexp>

Specifies a list of images names to exclude from backup. Uses Java-compatible regular expression.

nova_server_backup

<Yes or No>

Yes

Specify if the job should look for all Nova servers to backup. The flavors for the Nova servers included in the backup are also included regardless the nova_flavor_backup option is set or not.

server

<server name>

Specifies the name of a single Nova server to back up, regardless of other include/exclude rules.

server_include

<Java Regexp>

Specifies a set of Nova servers names to back up. Uses Java-compatible regular expressions.

server_exclude

<Java Regexp>

Specifies a set of Nova servers names to exclude from backup. Uses Java-compatible regular expression.

server_volume_exclude_regex

<Java Regexp>

Specifies a set of Nova servers volume names to exclude from backup. Uses Java-compatible regular expression.

server_volume_exclude_uuid

<server volume uuid>

Specifies a set of Nova servers volume UUIDs to exclude from backup.

server_volume_exclude_non_bootable

<Yes or No>

No

Specifies whether Nova servers not bootable volume should be excluded from backup.

cross_project

<project name>

Specifies the name of a single Keystone project to back up, regardless of other include/exclude rules.

tags

<tag>

Specifies a list of tags that a Nova server and its Glance image must have in order to be considered backup candidates. The tags option can be specified multiple times, for example: tags=<tag1> tags=<tag2> .... The selected Nova server(s) must match all tags specified in the plugin configuration line.

cross_project_include

<Java Regexp>

Specifies a set of Keystone project names to back up. Uses Java-compatible regular expressions.

cross_project_exclude

<Java Regexp>

Specifies a set of Keystone project names to exclude from backup. Uses Java-compatible regular expression.

cinder_volume_backup

<Yes or No>

No

Specify if the job should look for Cinder volumes not attached to any Nova server.

volume

<volume name>

Specifies the name of a single volume to back up, regardless of other include/exclude rules.

volume_include

<Java Regexp>

Specifies a set of volumes names to back up. Uses Java-compatible regular expressions.

volume_exclude

<Java Regexp>

Specifies a set of volumes names to exclude from the backup. Uses Java-compatible regular expressions.

volume_backup_block_size

<Positive Interger>

4194240

Specifies the size of block to back up. This should be a multiple of 65535 (Bacula maximum block size).

volume_backup_sha_algorithm

Hash function

SHA-256

Hash algorithm to use for block backup. Default value is SHA-256 as it is guarantee to be present on all systems.

Important

When performing cross project backup and restore, password authentication must be used as the plugin needs permission to all projects in the OpenStack cloud.

Important Notes

  • The use of regular expressions in the parameters include= and exclude= must be a Java compatible regular expression.

  • In order to be backed up, servers/images/volumes must match the include=... predicate and not match the exclude=.... However, any item that matches the <server|image|volume>=... options will be backed up regardless of the include/exclude specifications.

  • By default all items match the include predicate and not the exclude. Therefore, if none of the parameters <server|image|volume>=..., include=... and exclude=... are provided, all available elements hosted in the OpenStack environment will be backed up. On the other hand, if the parameter <server|image|volume>=... is specified, all elements will no longer match the include predicate. This means that if only <server|image|volume>=... parameter is specified, no other items will be backed up.

  • For any service, if any field from <element>_include=..., <element>_exclude=... or <element>=... is specified, the plugin will issue a backup for said service regardless of the value of <service>_<element>_backup=....

Note

The Nova servers is the only service where the backup of all Nova servers is enabled by default.

See Fileset Examples for examples of include/exclude/element setups.

See also

Previous articles:

Next articles:

Go back to: Configuration.