/usr/bin/jetapps --help
The JetApps CLI has the following options:
Option | Description | Flag |
---|---|---|
list | List all installed and available jetapps packages | -l / --list
|
list-installed | List all installed jetapps packages | -d / --list-installed
|
info | Print information about jetapps package | -i {package} / --info {package}
|
install | Install a jetapps package on your system | -s {package} {tier} / --install {package} {tier}
|
update | Update a jetapps package on your system | -u {package} / --update {package}
|
chtier | Change a jetapps package tier | -t {package} {newTier} / --chtier {package} {newTier}
|
chupdate | Change a jetapps package auto update status | -p {package} {yes/no} / --chupdate {package} {yes/no}
|
remove | Remove a jetapps package from your system | -r {package} / --remove {package}
|
version | Print jetapps cli tool version | -v / --version
|
help | Print the help screen to the terminal | -h / --help
|
/usr/bin/jetbackup5 --pkgacct {ACCOUNT} [options]
The pkgacct command accepts the following options:
Option | Description | Example |
---|---|---|
{ACCOUNT} | REQUIRED: The username of the account you wish to backup. | jetbackup5 --pkgacct user1
|
-oSkip | Give the backup items of the account that you do NOT want to include in the backup.
|
-oSkip config,homedir
|
/usr/bin/jetbackup5 --restorepkg {PKG_PATH} [options]
Option | Description | Example |
---|---|---|
{PKG_PATH} | REQUIRED: The absolute path to the .tar.gz backup of the account you wish to restore. | jetbackup5 --restorepkg /PATH/TO/TAR/jetbackup-acct.tar.gz
|
-oOwner | Set the new owner manually, Default Owner. | -oOwner {USERNAME}
|
-oPackage | Set the new package manually, Default Package. | -oPackage {PACKAGE_NAME}
|
-oMerge | Merge backup data with live account data, Default No | -oMerge {Yes/No}
|
-oTerminate | Terminate account before restore Default No (only if account exists) | -oTerminate {Yes/No}
|
-oReseller | Set the account as reseller, Default No (only if account is orphan or -oTerminate provided) | -oReseller {Yes/No}
|
-oSuspend | Set the account as susepended after the restore, Default No. | -oSuspend {Yes/No}
|
-oIP | Set the new IP Address manually, Default IP. | -oIP {IP_ADDR}
|
/usr/local/jetapps/usr/jetbackup5/exports/
directory./usr/local/jetapps/usr/jetbackup5/dailyexports/{EXPORT_FILE}
directory./usr/bin/jetbackup5 --export
/usr/bin/jetbackup5 --import {PATH/TO/EXPORT_FILE}
Note: Kindly reindex all destinations after importing the exported .tar.gz file.
The JB Config export does not include snapshot data.
Option | Description | Example |
---|---|---|
{PATH/TO/EXPORT_FILE} | REQUIRED FOR IMPORT: The absolute path to the .tar.gz JB Config export file. | jetbackup5 --import /PATH/TO/TAR/jetbackup5_export_XXXXXXXXXX.tar.gz
|
The jb5login script generates a single-use session login URL for the active ssh user.
/usr/bin/jb5login
To create a single-use session login URL for a specific user, use the following:
/usr/bin/jetbackup5api -F panelAPI -D "call=createUserSession&user={USERNAME}"