Skip to main content

backupctl

Tool to manage Eenos Scheduled Backups

Manage scheduled backups from the server command line.

Command :

/usr/local/eenos/scripts/backupctl

Command Options:

usage: backupctl [options]

Restore or Manage eenos scheduled backups.

Command(s):
  -l, --list            List all backups
  -s key_word, --search key_word
                        Search on backup database. You can use the keywords
                        like schedule id, pool id,  eenos user name
  -r backup_id, --restore backup_id
                        Restore a backup ID
  -do backup_id, --download backup_id
                        Download backup from backup ID

Restore Options:
  --full                Restore full account. This is default option
  --home                Restore home directory
  --domain DOMAIN       Restore a website content
  --email EMAIL         Restore an email account
  --mysqldb MYSQLDB     Restore a MySQL database
  --pgsqldb PGSQLDB     Restore a PgSQL database
  --mongodb MONGODB     Restore a MongoDB database
                         
  --file FILE           Restore a single file. The file path need to be
                        relative to homedir
                        Example : public_html/foo/fun.php
                         
  --dir DIR             Restore a folder. The directory path need to be
                        relative to homedir
                        Example : public_html/foo 

Download Option(s):
  -st path_to_store, --saveto path_to_store
                        A folder location to download and store the backup

Option(s):
  -h, --help            show this help message and exit
  -d, --demon           Run restore as daemon service

List All Backups

To list all available scheduled backups in the Eenos server, use the following command.

/usr/local/eenos/scripts/backupctl -l

Search Backups

/usr/local/eenos/scripts/backupctl -s  KEY_WORD

The KEY_WORD can be the backup ID, user name, backup type, owner, or storage pool name

Download Backup to Server

You can download a backup from the remote storage pool using the following command.

/usr/local/eenos/scripts/backupctl --download backup_id

The backup_id is the id of the backup. ( Eg:  13690965-40b4-47b3-9ef9-d535414c2fa6 )

Download Option

You can set a store location of the above-downloaded path using the  option  --saveto , sample command is as follows,

/usr/local/eenos/scripts/backupctl --download backup_id --saveto path_to_store

Where backup_id is the id of the backup and  path_to_store is a folder name in the server to store the downloaded backups.

Restore A Scheduled Backup

To restore a scheduled backup from the command line use the following command.

/usr/local/eenos/scripts/backupctl --restore backup_id

The backup_id is the id of the backup. ( Eg:  13690965-40b4-47b3-9ef9-d535414c2fa6 )

Restore Options

You can restore a backup fully or part of the backup. The following restore options are available.

  •   --full, Restore full account. This is the default option,
  •   --home,  Restore home directory
  •   --domain DOMAIN,  Restore a website content, where DOMAIN is the website  name
  •   --email EMAIL,      Restore an email account, where EMAIL is the email address.
  •   --mysqldb MYSQLDB,  Restore a MySQL database, where MYSQLDB is the MySQL database name.
  •   --pgsqldb PGSQLDB,   Restore a PgSQL database, where PGSQLDB is the PgSQL database name.
  •   --mongodb MONGODB,  Restore a MongoDB database, where MONGODB is the MongoDB database name.
Rune Restore in Server Background

You can run the restore option as a daemon service on the server background using the  following command  flag -d or --demon

Back to top