The view_transfer Script
Valid for versions 82 through the latest version
Version:
82
Last modified: August 15, 2022
Looking for this interface?
Your hosting provider can enable or disable this interface for resellers in WHM's Edit Reseller Nameservers and Privileges interface (WHM >> Home >> Resellers >> Edit Reseller Nameservers and Privileges).
Overview
The /usr/local/cpanel/bin/view_transfer
script lets you view the logs for a transfer or restore session. These logs include the sessions for transfers and restored backups run via WHM’s Transfer Tool interface (WHM » Home » Transfers » Transfer Tool). You can also restore backups with WHM’s Backup Restoration interface (WHM » Home » Backup » Backup Restoration) or by running the restorepkg
script.
You must run this script as the root
user.
- To view the previous sessions, use the
view_transfer
script with those sessions’ session IDs. You can also use WHM’s Review Transfers and Restores interface (WHM » Home » Transfers » Review Transfers and Restores). - The WHM API 1
fetch_transfer_session_log
function produces a similar output.
Run the script
To run this script on the command line, use the following format:
/usr/local/cpanel/bin/view_transfer sessionID [options]
In this example, sessionID
is a transfer session’s ID.
Options
Use the following options with this script:
Options |
Description | Example |
---|---|---|
sessionID |
Required. The transfer session’s ID. | 10138174noroo20210208141143HpwEjUkwe |
logfile |
A transfer session’s log file. When you use this option, the script prints the log file’s contents in a human-readable format. This option accepts the following log file formats:
|
item-TRANSFER_AccountRemoteUser_username |
--overview |
Only return an overview of the transfer’s progress. The script will not output the transfer’s progress status details.
Note:
This option does not change the script’s output if you run the script with a log file.
|
--overview |
Example
To view a transfer session ID and its log file’s contents, use the following format:
/usr/local/cpanel/bin/view_transfer 10138174noroo20210208141143HpwEjUkwe item-TRANSFER_AccountRemoteUser_username
The script’s output will resemble the following example:
|
|