How to Import a Single Account

Prerequisites

Last Updated for InterWorx-CP version 2.1.0

The server must have at least one SiteWorx account on the system.

Purpose

From the NodeWorx interface administrators will be able backups of SiteWorx accounts, both partial backups and full backups.

Procedure - NodeWorx Web Interface

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

Click on the SiteWorx menu if it is not already expanded.
Click on the ♦ Import submenu if it is not already expanded.
Click on the ◊ Single Account item.
You should now be looking at the Single Account Import controls in the main content area.
Click the radio button next to Local Backup File or the radio button next to Remote Backup File.
1. Choose Local Backup File if you have a backup file saved on your computer’s hard drive. Click the Browse button and choose the backup file.
2. 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-CP (all) if this backup was created by InterWorx-CP.
Choose from the list of available resellers in the dropdown labeled Reseller
Choose from the list of available IP addresses in the dropdown labeled IP Address.
Click the Import 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.

Procedure - Command Line Interface

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:

[iworx@test-box ~]$ /home/interworx/bin/import.pex

import.pex has several command line parameters:

Required 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 IP address.
`--control-panel=cptype`	Indicates the control panel from which this backup was created. Valid values: siteworx cpanel plesk directadmin ensim
Optional Parameters
Parameter	Description
`--force`	Tells `import.pex` to force the restore which will delete any existing SiteWorx account, without a confirmation prompt, before restore proceeds.
`--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. Note: this option is only valid for SiteWorx 3.0+ backups

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