(cloudstack-documentation) branch main updated: Add information on backup and restore timeouts (#675)

[we...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

weizhouapache pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/cloudstack-documentation.git


The following commit(s) were added to refs/heads/main by this push:
     new ba872970 Add information on backup and restore timeouts (#675)
ba872970 is described below

commit ba87297029658783cecfa9c46ecb3cf07825fdf0
Author: Tony <dr...@users.noreply.github.com>
AuthorDate: Tue Sep 1 12:57:22 2026 +0200

    Add information on backup and restore timeouts (#675)
    
    * Add information on backup and restore timeouts
    
    * Add information on state of backup after a timeout.
---
 source/adminguide/backup_and_recovery.rst | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)

diff --git a/source/adminguide/backup_and_recovery.rst b/source/adminguide/backup_and_recovery.rst
index f07e6649..51d9ffd7 100644
--- a/source/adminguide/backup_and_recovery.rst
+++ b/source/adminguide/backup_and_recovery.rst
@@ -317,3 +317,28 @@ the backup size, although the actual backup size may be less than the size use t
    :alt: Select Zone when creating Instance from Backup
    :width: 700px
 
+Configuring Backup and Restore Timeouts
+---------------------------------------
+
+The default timeout for backup and restore commands is 3600 seconds (1 hour). 
+For large Instances or slower backup repositories, backup and restore operations may take longer than this timeout.
+
+The timeout for individual commands can be configured using the `commands.timeout` global setting. 
+This setting accepts comma-separated key-value pairs, where the key is the command name and the value is the timeout in seconds.
+
+For example, to configure a timeout of two hours for both backup and restore operations, add:
+
+`TakeBackupCommand=7200,RestoreBackupCommand=7200`
+
+The Management Server must be restarted after changing the `commands.timeout` setting.
+
+The configured timeout can be verified in the Management Server log. For example:
+
+`Wait time setting on org.apache.cloudstack.backup.TakeBackupCommand is 7200 seconds`
+
+.. note::
+The command timeout determines how long the Management Server waits for the operation to complete. 
+Timing out the command does not necessarily terminate the underlying backup or restore operation on the hypervisor. 
+For example, with the NAS Backup & Recovery plugin on KVM, the corresponding libvirt operation may continue after the command times out on the Management Server. 
+The finished backup will not be tracked by CloudStack in this case and as such won't be cleaned up by a configured rotation.
+