Конфигурационный файл /opt/rubackup/etc/rb_module_ovirt.conf

# Symbol "#" at the beginning of the line treats as a comment
# "#" in the middle of the line treats as a parameter value
# So please do not use comments in one line with parameter
#
# oVirt engine FQDN
engine <fqdn>
# Authentication grant type.
# Default value: password
grant_type password
username <username>
password <password>
ca_info	<path to a certificate>
# Maximum time allowed for http request (from start to end) in seconds.
# Default value: 1
timeout 20
#
# The mechanism used (backend) to upload the disk to the server.
# Possible values: file or nbd
# Default: file
disk_upload_mechanism file
#
# Set this flag to 'yes' if there is a need to assign a VM backup task the RuBackup client
# which is running on the same host as the target VM.
#If set 'no' the backup task will be assigned the RuBackup client node used for backup rule creation.
#Default value: yes
backup_vm_from_native_host yes
#
# Specifies the maximum single disk upload timeout in minutes. Default: 25 minutes. Min 1 minute
disk_upload_timeout 25
# Specifies the maximum single disk download timeout in minutes. Default: 25 minutes. Min 1 minute
disk_download_timeout 25
#
# RuBackup module creates oVirt ImageTransfer in order to download or upload disk data.
# Parameter 'image_transfer_timeout' specifies the amount of time in seconds
# the module will wait the ImageTransfer goes to state "transferring".
# If this timeout is reached but the ImageTransfer is not in 'transferring' state
# corresponding backup or restore task will end with error.
# Possible values: [1, 3600]
# Default value: 300
image_transfer_timeout 300
#
# oVirt ImageTransfer inactivity_timeout in seconds. Default: 60 seconds. Min 5 seconds, max 500 seconds
imagetransfer_inactivity_timeout 60
#
# When backup via oVirt REST API is done and VM disks are dumped
# RuBackup module initiates finalizing the ImageTransfer.
# After that it waits while the the ImageTransfer reaches state 'finished_success'.
# Parameter 'image_transfer_finalize_timeout' specifies the amount of time in seconds
# the module will wait the ImageTransfer is finalized.
# If this timeout is reached but the ImageTransfer is not in 'finished_success'
# state a Warning is added to the module log.
# Further ovirt backup finalizing can also fail due to this.
# Possible values: [1, 3600]
# Default value: 300
image_transfer_finalize_timeout 300
#
# Try using the module if the platform version is not compatible with RuBackup. Default: no
allow_work_with_incompatible_versions no
#
# Turn on debug of REST requests
# Possible values: yes, no. Default no
curl_verbose no
#
# Set this flag to 'yes' if there is a need to make a VM backup by means of the platform (oVirt REST API)
# Possible values: yes, no
# Default value: no
backup_using_ovirt_api no
#
# Set this flag to 'yes' if there is a need to remove all VM checkpoints at full backup task.
# The flag is applicable only if 'backup_using_ovirt_api' is set to 'yes'.
# Possible values: yes, no
# Default value: no
remove_vm_checkpoints_at_full_backup no
#
# When the 'backup_using_ovirt_api' is set to 'yes', RuBackup module initiates backup
# of a VM using oVirt REST API. After that it waits while the backup reaches state 'ready'.
# Parameter 'platform_side_backup_timeout' specifies the amount of time in seconds
# the module will wait the backup is ready.
# If this timeout is reached but the backup is not in 'ready' state
# corresponding backup task will end with error.
# Possible values: [1, 72000] seconds
# Default value: 7200 seconds
platform_side_backup_timeout 7200
#
# When backup via oVirt REST API is ready and VM disks are dumped
# RuBackup module initiates finalizing the backup.
# After that it waits while the backup reaches state 'succeeded'.
# Parameter 'backup_finalize_timeout' specifies the amount of time in seconds
# the module will wait the backup succeeded.
# If this timeout is reached but the backup is not in 'succeeded'
# state a Warning is added to the module log.
# Possible values: [1, 3600]
# Default value: 300
backup_finalize_timeout 300
#
# If this flag is set (value 'yes') the RuBackup module cancels active VM ImageTransfers
#  and finalizes VM Backup(s) before start of a new Backup.
# This behavior is applicable only when 'backup_using_ovirt_api' is set to 'yes'.
# Possible values: yes, no
# Default value: no
clean_vm_operations_before_new_backup no
#
# Enable interaction with centralized secret repositories
# Possible values: yes, no. Default: no
use_secret_storage no
#
# When a VM snapshot is being created, it can fail if some internal
# operations of oVirt are not finished yet. The module is waiting for
# successful snapshot creation during 'create_vm_snapshot_timeout' seconds.
# If a timeout is reached, the task will fail. To mitigate this,
# increase the value of the parameter
# Applicable only for restore of copies created with backup_using_ovirt_api=yes.
# Possible values: [1, 3600] seconds
# Default value: 300  seconds
create_vm_snapshot_timeout 300
#
# To fix the oVirt VM snapshot creation issue, a timeout should be applied between snapshot creations.
# Applicable only for restore of copies created with backup_using_ovirt_api=yes.
# Possible values: [60, 3600] seconds
# Default value: 60 seconds
inter_snapshots_creation_timeout 60
#
# When a VM snapshot is deleting, it can fail if some internal
# operations of oVirt are not finished yet. The module is waiting for
# successful snapshot deletion during 'delete_vm_snapshot_timeout' seconds.
# If a timeout is reached, the task will fail. To mitigate this, increase
# the value of the parameter.
# Applicable only for restore of copies created with backup_using_ovirt_api=yes.
# Possible values: [1, 3600] seconds
# Default value: 300 seconds
delete_vm_snapshot_timeout 300
#
# During a restore operation, a VM's disk/snapshot can be busy because
# it is processed by oVirt. This parameter is used to set amount of time
# (in seconds) to wait while the disk/snapshot becomes available.
# If a timeout is reached, the task will fail. To mitigate this, increase
# the value of the parameter.
# Applicable only for restore of copies created with backup_using_ovirt_api=yes.
# Possible values: [1, 3600] seconds
# Default value: 300 seconds
disk_snapshot_wait_unlock_timeout 300
#
# During a backup/restore operation, a VM's disk/snapshot can be busy because
# it is processed by oVirt. This parameter is used to set amount of time
# (in seconds) to wait while the disk/snapshot will be ready for transfer operation.
# If a timeout is reached, the task will fail. To mitigate this, increase
# the value of the parameter.
# Possible values: [1, 3600] seconds
# Default value: 300 seconds
disk_snapshot_transfer_timeout 300
#
# Amount of parallel workers for REST requests
# Applicable only for requests of VMs list.
# min 1, max 100, default 1
curl_workers 1
#
# Number of oVirt elements that every worker requests at once
# Applicable only for requests of VMs list.
# min 25, max 10000, default 1000
curl_page_size 1000
#
# Set this flag to 'yes' if there is a need to download only non-zero disk extents for backup.
# The flag is applicable only if 'backup_using_ovirt_api' is set to 'yes'.
# Possible values: yes, no
# Default value: yes
backup_only_nonzero_extents yes