Note

You are viewing the documentation for an older release of Interworx (6.x). To see documentation for the current generally available release of Interworx, click here: 7.13.

How to: Import Interworx Hosting Accounts¶

Import a Single Account¶

Import Through NodeWorx¶

If you prefer to use the web interface, follow the steps below.

Click the SiteWorx > Import menu item.

Click the Import Single Account button.

Choose from the list of available resellers in the dropdown labeled Reseller ID.

Click the Choose File button for a Local Backup File or the Use a file already on the system link for a Remote Backup File.

Choose Local Backup File if you have a backup file saved on your computer’s hard drive.
Choose Remote Backup File if you have a backup file saved on the server. You will need to type in the fully-qualified path to the file. For example, if you have a backup file named testaccount.tar.gz in /tmp/backups/, you would enter: /tmp/backups/testaccount.tar.gz

Choose the control panel from which this backup was created from the dropdown labeled Control Panel Type. For example, choose InterWorx Control Panel (all) if this backup was created by InterWorx Control Panel.

Choose from the list of available IP addresses in the dropdown labeled IP Address. If the backup was created in InterWorx, IP addresses may be assigned manually at this point.

Select a database server from the appropriate dropdown.

Click the Next button.

If there is already an existing SiteWorx account with the same domain name you will be asked to confirm. Click the Import button to finish.

Import Through CLI¶

The command line backup interface is less user-friendly, but you have a lot more options at your disposal. Using the command line interface is most useful when you want to automate (e.g., via CRON) the creation of SiteWorx account backups.

You should be familiar with the Linux command line to use this method.

SSH into the server
su to the iworx system user. You may need to switch to the root user first (if you’re not already logged in as the root user) and then switch to the iworx user.

The command you will be running is, as the iworx user: /home/interworx/bin/import.pex has several command line parameters:

Parameter

Description

–archive=file

Path and filename of backup file to import.

–ip-address=ip-address

IP address to use for the imported account. The IP address must be a valid shared or unused dedicated IP address. inifile is also a valid input for this parameter when importing a SiteWorx account (uses old IP found inside backup).

–control-panel=cptype

Indicates the control panel from which this backup was created. Valid values:

siteworx
cpanel
plesk
directadmin
ensim

Parameter	Description
–force	Tells import.pex to force the restore which will delete any existing SiteWorx account, without a confirmation prompt, before restore proceeds. This is necessary when trying to revert to an older state of a SiteWorx account from a backup.
–reseller-id=id number	Tells import.pex to assign the account to a particular reseller account. If this parameter isn’t used the account will be assigned to the NodeWorx administrator.
–create-reseller	Tells import.pex to create the reseller that’s stored in the backup file. If the reseller in the backup file already exists, the account will automatically be imported under this reseller.

The usage of the import command can be reviewed by running import.pex without parameters.

To restore SiteWorx backup file /tmp/backup.tar.gz with a prompt to confirm deletion of the existing SiteWorx account:

[iworx@test-box ~]$ /home/interworx/bin/import.pex --archive=/tmp/backup.tar.gz --control-panel=siteworx --ip-address=inifile

To restore SiteWorx backup file /tmp/backup.tar.gz without a prompt to confirm deletion of the existing SiteWorx account:

[iworx@test-box ~]$ /home/interworx/bin/import.pex --archive=/tmp/backup.tar.gz --control-panel=siteworx --ip-address=inifile --force

Import Multiple Accounts From a Remote Server¶

Click the SiteWorx > Import menu item.

Click the Import Mass Transfer button.

In the Hostname: field, enter the hostname of the remote server from which you want to migrate.

In the Root User: field, enter the root user of the remote server from which you want to migrate.

In the Password: field, enter the password for the root user you entered above.

Click the Query Accounts button.

You will now see a list of accounts on the remote server, with a checkbox next to each account.

Mark the checkboxes next to accounts you would like to migrate.

Select the destination Reseller you want to use for each migrated account from the Reseller column. If the remote reseller doesn’t already exist on the destination server, you will have the option to import the remote reseller. If the reseller in the backup file already exists, the account will automatically be imported under this reseller.

Select the IP Address you want to use for each migrated account from the IP Address column.

There are also “Advanced Options” dropdowns at the top of each group of accounts, allowing you to quickly and easily set options for all the accounts in the list. For example, choosing an IP Address in the Advanced Options section will select that IP for all accounts.

A Storage Used column will appear, indicating the approximate amount of disk space the account is using on the remote server.

A Type option will appear for each account, allowing you to choose either a “Full Import” or “Structure-Only Import”. Structure-only imports are much smaller and faster than full imports, but only import SiteWorx account related information (such as quotas, usernames, passwords, etc) and not actual data (such as website data files, database data, and email files). Structure-only is especially useful when mass-transferring large accounts, since large accounts can take a considerable amount of time to mass-transfer.

Select Import … from the drop-down list at the bottom of the table.

You will now see a list of the accounts you chose to mass transfer, along with a status for each account under the Import Status column.

In Progress - Account is currently being backed up, transferred over from the remote server, and imported into InterWorx Control Panel.
Pending - Account is waiting for import process to begin.
Success - Import of account succeeded.
Failure - Import of account failed. A message that indicates possible reasons for failure will appear beneath the Failure box.

The page will automatically reload after a certain interval to update the import status of each account.

When the mass transfer process is complete, all accounts will either have a Success or Failure status in the Import Status column.

Note: If you leave this page, the mass account transfers will still continue in the background. However, if you return to this page, you will no longer be able to see the status of any of the accounts.

Troubleshooting:¶

If you get a Permission Denied error after clicking the Query Accounts button on the first Mass Account Transfer page, check the following:

You have entered the correct root password.
You have entered the correct root username.
Double check that the remote server allows the root user to SSH in. You can verify this by trying to SSH into the remote server as the root user.

Import a Single Account from Plesk 9+¶

Click the SiteWorx > Import menu item.

Click the Import from Plesk button.

Click the Choose File button for a Local Backup File or the Use a file already on the system link for a Remote Backup File.

Choose Local Backup File if you have a backup file saved on your computer’s hard drive.
Choose Remote Backup File if you have a backup file saved on the server. You will need to type in the fully-qualified path to the file. For example, if you have a backup file named testaccount.tar.gz in /tmp/backups/, you would enter: /tmp/backups/testaccount.tar.gz

Choose from the list of available resellers in the dropdown labeled Reseller.

Enter the Client Email in the labeled text field.

Choose from the list of available IP addresses in the dropdown labeled IP Address.

Select a database server from the subsequent dropdown.

Click the Continue button.

If there is already an existing SiteWorx account with the same domain name you will be asked to confirm. Click the Import button to finish.