/scripts/pkgacct — Package a cPanel account

The syntax detailed in this document is for cPanel & WHM versions 11.28 and later. The syntax and parameters listed below will not work for older versions of cPanel & WHM.

You can use the pkgacct script to create a cpmove archive for a specified account. Once you have created the cpmove archive, you can transfer the account between servers.

Calling the script

To call this script, you will need to log into your server via SSH as the root user. Once you are logged in as root, you can execute the script by typing the following:

/scripts/pkgacct $user 

Important: In the example above $user is meant to stand for the username corresponding to the cPanel account you wish to package.

Once you issue this command, the pkgacct script will begin creating the cpmove archive from the account $user.

Please note:

• The account's username is the only required parameter, unless the --bincheck argument is used.
• If you wish to specify any arguments, you simply need to pass those arguments before $user. Most of the arguments you can use with this script are unordered. However, if you want to use --allow-override, you must pass it first (in the 0th position). You must always pass the $user and $destination variables last. Whenever the $destination variable is used, you must pass it in last place, after $user. For example:

/scripts/pkgacct --allow-override --skiphomedir --skipacctdb $user $destination

Remember: In the example above $user is meant to stand for the username corresponding to the cPanel account you wish to package. $destination is meant to stand for the directory in which you wish to store the cpmove archive.

Available arguments

The pkgacct script can accept the following arguments.

Parameter	Description	Input Type
$user	This variable is required whenever --bincheck is not used. When passing this variable, replace $user with the username corresponding to the cPanel account you wish to package.	string
$destination	This is an optional variable that allows you to specify the path to the directory in which you wish to store the cpmove archive. The $destination variable must follow the $user variable, e.g. /scripts/pkgacct $user $destination.	string
--allow-override	Causes the script to use instructions in /usr/local/cpanel/Whostmgr/Pkgacct/pkgacct, if any are present.	N/A
--bincheck	This parameter ensures that any scripts called by the cPanel binary will run. If successful, the script will print 'BinCheck ok'. When using this argument, you do not need to pass $user.	N/A
--version	The version of the archive being created.	string (See below for usage instructions.)
--mysql	The version of MySQL used by the account's databases.	string (See below for usage instructions.)
--use_backups	Causes the most recent backup to be converted into a cpmove archive. This option will speed up the process but may result in lost or old data.	N/A
--skiphomedir	This parameter will exclude the user's home directory from the archive. If the account will be transferred, the user's home directory can be moved with a faster protocol.	N/A
--incremental	When this parameter is used, only information that was not contained within the previous archive will be packaged. This parameter will not work if no cpmove archive is found.	N/A
--split	Causes the archive to be created in chunks. This will reduce the overall load on the system.	N/A
--nocompress	Passing this parameter will leave the resulting cpmove archive uncompressed.	N/A
--compress	This parameter can override the --nocompress argument if it is present. There is no reason to use this argument as archives are compressed by default.	N/A
--skipacctdb	This parameter prevents the account's databases from being included in the archive.	N/A
--userbackup	Allows the user to use the resulting cpmove archive as a backup for the account.	N/A
--backup	Causes the resulting archive to be used as an account's backup.	N/A

Using the --version and --mysql arguments

To use pkgacct 's --version and --mysql arguments, you will need to enter a space between the argument and the value you wish to pass to it. For example:

/scripts/pkgacct --version 2 --mysql 5.5.11 $user

Note: This information only applies to the --version and --mysql arguments. You simply need to pass the $user and $destination parameters to the script last.

Remember: In the example above $user is meant to stand for the username corresponding to the cPanel account you wish to package. $destination is meant to stand for the directory in which you wish to store the cpmove archive.