Page tree
Skip to end of metadata
Go to start of metadata


Overview

The transfer and restore process uses several WHM API functions. This document explains the relationship between these API functions and the order in which to call them.

Transfer and restore process

This document expands upon the Account Transfer and Account Restore documentation. We recommend the following workflow during the transfer and restore process:

  1. Plan the transfer session. For more information, read the Plan session documentation.
  2. Create the transfer session. For more information, read the Create session documentation.
  3. Check the transfer session. For more information, read the Check session documentation.
  4. Queue the transfer item. For more information, read the Queue the transfer item documentation.
  5. Start the transfer session. For more information, read the Start the transfer session documentation.
  6. Monitor the transfer session. For more information, read the Monitor session documentation.

You can pause and restart an active transfer session throughout the transfer process.

Plan the transfer session

Pull information from the system to discover the type of information that you need to properly set it up.

FunctionsDescription
available_transfer_modules This function lists the available transfer modules. This allows you to add sessions into these modules.
transfer_module_schema This function displays the transfer module schema. This allows you to format the input parameters for the items that you want to transfer.

Start the transfer session

Create, check, queue, then start the transfer session.

FunctionDescription

create_remote_user_transfer_session

or

create_remote_root_transfer_session

These functions create remote transfer sessions. These provide the credentials to log in to the remote server.
retrieve_transfer_session_remote_analysis This function performs an analysis on a transfer session. This provides you with a list of accounts that the system will transfer and how much space they will use on the remote server.
validate_system_user This function validates whether you can create a system account on the remote server. This helps you avoid account name conflicts.
enqueue_transfer_item This function allows you to add accounts and packages (transfer items) to the transfer queue.
start_transfer_session This function starts the transfer session.

Monitor the transfer session

Check the state of the transfer session.

You can use the following functions at any stage of the transfer and restore process:

FunctionDescription
get_transfer_session_state This function checks the status of a transfer session.
fetch_transfer_session_log This function displays a transfer session log.

Pause and restart the transfer session

Pause and restart an active transfer session (for example, if your server loses power).

You can use the following functions to pause and restart an active transfer session:

FunctionDescription
pause_transfer_session This function pauses an active transfer session.
start_transfer_session This function restarts a transfer session.