Skip to Content
Browse documentation

backupctl — Command Reference

List, search, download or restore backups registered in the Eenos backup catalog.

List, search, download or restore backups registered in the Eenos backup catalog.

Requirements

Run as root on the Eenos server. A configured backup catalog and storage access. Use a real catalog backup ID for download/restore; an archive pathname is not a backup ID.

Usage

The following example uses the operation described below; replace example identities and paths before use:

/usr/local/eenos/scripts/backupctl --list

Arguments and options

Argument / optionUsage and meaning
-l, --listFlag. List all backups
-s, --searchValue: key_word. Search on backup database. You can use the keywords like schedule id, pool id, eenos user name
-r, --restoreValue: backup_id. Restore a backup ID
-do, --downloadValue: backup_id. Download backup from backup ID
--fullFlag. Restore full account. This is default option
--homeFlag. Restore home directory
--domainValue: DOMAIN. Restore a website content
--emailValue: EMAIL. Restore an email account
--mysqldbValue: MYSQLDB. Restore a MySQL database
--pgsqldbValue: PGSQLDB. Restore a PgSQL database
--mongodbValue: MONGODB. Restore a MongoDB database
--fileValue: FILE. Restore a single file. The file path need to be relative to homedir Example : public_html/foo/fun.php
--dirValue: DIR. Restore a folder. The directory path need to be relative to homedir Example : public_html/foo
-st, --savetoValue: path_to_store. A folder location to download and store the backup
-d, --demonFlag. Run restore as daemon service

-h, --help displays this parser's help. Selectors in the same mutually exclusive group cannot be combined. The installed version remains authoritative for available options.

Operational effects

List/search read the catalog. Download writes a backup locally and can connect to remote storage. Restore changes account data; --demon detaches restore work. Unlike restoreacct, this parser requires an explicit restore scope with --restore, even though its help calls --full the default.

Examples after reviewing a real backup ID:

/usr/local/eenos/scripts/backupctl --search exampleuser
/usr/local/eenos/scripts/backupctl --download BACKUP_ID --saveto /backup
/usr/local/eenos/scripts/backupctl --restore BACKUP_ID --full

Choose one main operation and at most one restore scope. Use an existing --saveto directory; otherwise the implementation falls back to its configured restore directory.

Verify the result

Check the reported download/restore path and logs. A successful download is not a completed restore.

Check operation output and the relevant service/application state. Several legacy wrappers exit successfully after logging a handler failure, so a zero shell exit status alone is not proof of completion.

Back to Backup & Restore · All command-line tools