See also Command reference.
There are many variations of this command. Regardless of which variation of the command is used, UBOS generally performs the following actions:
It suspends the Site(s) affected by the backup, and temporarily replaces them with a placeholder page.
"retentionpolicy" : "keep", "retentionbucket" : "name"
The actual backup performed depends on the type of AppConfigItem. For example, a MySQL database will be dumped, and the resulting dump will be backed up.
The individually exported items, and certain meta-data are assembled in a UBOS Backup format file.
UBOS resumes the Site(s) and removes the placeholder page.
If the user requested encryption of the backup, the entire backup file will be encrypted with GPG.
Depending on the data transfer protocol specified, the resulting file will either be moved into the desired location on the local device, or transferred over the network to a remote host with the specified host and parameters.
This command must be run as root (sudo ubos-admin backup).