Skip to content

F OpenNebula/one#7167: Backup freeze options #481

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tinova merged 1 commit into from
Dec 17, 2025
Merged

F OpenNebula/one#7167: Backup freeze options #481

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions content/product/cluster_configuration/backup_system/veeam.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -228,6 +228,7 @@ The configuration file can be found at ``/etc/one/ovirtapi-server.yml``. You sho
* ``one_xmlrpc``: Address of the OpenNebula Front-end. Please do not include any prefixes such as ``http://``, only the IP address itself is needed.
* ``endpoint_port``: Port used by the OpenNebula RPC endpoint (defaults to 2633).
* ``public_ip``: Address that Veeam is going to use to communicate with the ovirtapi server.
* ``backup_freeze``: (Optional) Controls which filesystem freeze mode OpenNebula requests when performing backups initiated via the oVirtAPI/Veeam integration. Valid values are `NONE`, `AGENT`, and `SUSPEND`. For details on each mode see the Backup Modes section in the backup guide: [Backup Modes]({{% relref "../../../product/virtual_machines_operation/virtual_machine_backups/operations/#backup-modes" %}}).

{{< alert title="Important" color="success" >}}
You may see the 5554 port in the ``public_ip`` variable in the default settings, this is no longer needed so avoid using it. Leave only the IP address in the variable, no port needed.
Expand Down
10 changes: 10 additions & 0 deletions content/product/virtual_machines_operation/virtual_machine_backups/operations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,16 @@ In order to save space in the backup system, RAW disk backups are converted and

Before making backups you need to configure some aspects of the backup process (e.g., the backup mode). This can be done for VM templates or Virtual Machines.

### Backup Modes

OpenNebula provides three `FS_FREEZE` modes to control how the guest filesystem is handled before taking a backup. Choose the mode that best fits your workload and guest OS capabilities:

- **NONE**: Do not attempt any filesystem freeze. This is the fastest option and requires no guest-side support, but backups may only be crash-consistent (the same as powering off the VM abruptly). Use when guest-agent support is unavailable or when minimal disruption is required.

- **AGENT**: Use the guest agent to handle the filesystem inside the guest prior to backup. On Linux this typically uses the qemu guest agent or fsfreeze to freeze filesystems; on Windows the guest agent triggers the Volume Shadow Copy Service (VSS) to create application and filesystem-consistent snapshots (in this case VSS needs to be properly configured). `AGENT` is the recommended option when you need stronger consistency and the guest supports it.

- **SUSPEND**: Suspend (pause) the VM at the hypervisor level for the brief period of the backup pre-step. This guarantees a consistent on-disk state without relying on guest tools, but it pauses all guest activity and may impact running services.

### Virtual Machine Templates

You can configure backups in the VM Template, so every VM created will have a preconfigured backup setup. The following example shows a VM template with incremental backups configured:
Expand Down