The transfer_account_as_user Script

Valid for versions 94 through the latest version

Version:

94


Last modified: April 13, 2021

Overview

The /usr/local/cpanel/scripts/transfer_account_as_user script transfers a cPanel account from a remote (source) server to the local server. When you run the script, it authenticates as the cPanel account on the remote server.

Important:

Run the script

To run this script on the command line, use the following format:

/usr/local/cpanel/scripts/transfer_account_as_user [options]

Options

Use the following options with this script:

Options Description Example
--host Required
The remote (source) hostname or IP address.
--host=example.com
--user Required
The name of the cPanel account to transfer from the remote server to the local server.
--user=username
--enqueue Pass a parameter to the WHM API 1 enqueue_transfer_item function. You can use this option multiple times. --enqueue=mail_location=.local
--help  Print the script’s help information. --help
--session  Pass a parameter to the WHM API 1 function create_remote_user_transfer_session. You can use this option multiple times. --session=unrestricted_restore=1

Additional Documentation