Creating User Migration XMLs in H-Sphere

Last modified: 27 Dec 2007

WARNING: This documentation covers Parallels H-Sphere versions up to 3.1. For the latest up-to-date Parallels H-Sphere documentation, please proceed to the official Parallels site.

This document explains how to create XML files with H-Sphere reseller and end user data for migration to a different H-Sphere cluster.

User info can be obtained and formatted with the UsersInfoExtractor utility executed under Control Panel user.

In H-Sphere versions earlier than 2.5, UsersInfoExtractor extracts resellers together with their end users into a single XML file. See Creating User Migration XMLs in H-Sphere (before 2.5).

Starting with version 2.5, UsersInfoExtractor extracts resellers into the migrate_resellers.xml, and their end users separately into migrate_users.xml.

UsersInfoExtractor runs with the following parameters:

• -resellers - extracts only resellers into the migrate_resellers.xml file:

  java psoft.hsphere.migrator.UsersInfoExtractor [-force] -resellers OPTIONS

  where OPTIONS include:

  • -resellersbynames - extract listed resellers:
    

    java psoft.hsphere.migrator.UsersInfoExtractor [-force] -resellers -resellersbynames <RESELLER-1> ... <RESELLER-N>

  • -resellersfromfile - extract resellers listed in a plain text file:
    

    java psoft.hsphere.migrator.UsersInfoExtractor [-force] -resellers -resellersfromfile /home/resellers.txt

  • -usersbynames - extract resellers for listed individual users:
    

    java psoft.hsphere.migrator.UsersInfoExtractor [-force] -resellers -usersbynames <USERNAME-1> ... <USERNAME-N>

  • -usersfromfile - extract resellers for individual users listed in a plain text file:
    

    java psoft.hsphere.migrator.UsersInfoExtractor [-force] -resellers -usersfromfile /home/users.txt

  • -usersbylserver - extract resellers for all users located on a specified logical server:
    

    java psoft.hsphere.migrator.UsersInfoExtractor [-force] -resellers -usersbylserver <LSERVER_ID>

• -users - extracts end users into the migrate_users.xml file. This option is meant by default if both -resellers and -users options are omitted in the command:

java psoft.hsphere.migrator.UsersInfoExtractor [-force] [-users] OPTIONS

where OPTIONS include:

• -usersbynames - extract listed end users by usernames:
  

  java psoft.hsphere.migrator.UsersInfoExtractor [-force] -users -usersbynames <USERNAME-1> ... <USERNAME-N>

• -usersfromfile - extract users by usernames listed in a plain text file:
  

  java psoft.hsphere.migrator.UsersInfoExtractor [-force] -users -usersfromfile /home/users.txt

• -resellersbynames - extract users that belong to listed resellers:
  

  java psoft.hsphere.migrator.UsersInfoExtractor [-force] -users -resellersbynames <RESELLER-1> ... <RESELLER-N>

• -resellersfromfile - extract users that belong to resellers listed in a plain text file:
  

  java psoft.hsphere.migrator.UsersInfoExtractor [-force] -users -resellersfromfile /home/resellers.txt

• -usersbylserver - extract users located on a certain logical server:
  

  java psoft.hsphere.migrator.UsersInfoExtractor [-force] -users -usersbylserver <LSERVER_ID>

Use the force parameter to ignore errors. Error messages will be written to migrate_errors.log.

Important: Note that you must specify user and reseller names, not ids!

Important: If you are migrating master admin's end users, you just extract them into migrate_users.xml without extracting master admin as reseller.

See also:
Sample xml file with reseller data   |   Sample xml file with end user data
Sample dtd file for resellers   |   Explanations to dtd file for resellers
Sample dtd file for end users   |   Explanations to dtd file for end users