Parallels H-Sphere Documentation System Administrator Guide

 

DTD Structure Of End User XML Migration File

 
 

Related Docs:   Migrating Users Into H-Sphere User XML Tags Specification (for 2.5 +)

Last modified: 02 Aug 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.

 

Data Type Definitions

Here is the DTD structure defined in users.dtd:

<?xml version="1.0" encoding="UTF-8"?>

<!ELEMENT users (user+)>
<!ELEMENT user (account+)>
<!ELEMENT account (info+, odbc?, limits?, ftpsubaccounts?, crontab?, domain*, mysql?, mssql?, pgsql?)>
<!ELEMENT info (item+)>
<!ELEMENT item (#PCDATA)>
<!ELEMENT odbc (dsn_record+)>
<!ELEMENT dsn_record (driver_param*)>
<!ELEMENT driver_param (#PCDATA)>
<!ELEMENT limits (quota?, traffic?)>
<!ELEMENT ftpsubaccounts (subaccount+)>
<!ELEMENT crontab (command*)>
<!ELEMENT command (#PCDATA)>
<!ELEMENT quota (#PCDATA)>
<!ELEMENT traffic (#PCDATA)>
<!ELEMENT subaccount (#PCDATA)>
<!ELEMENT domain (mailservice?, webservice?, ftp?, subdomain*, aliases*, dns?)>
<!ELEMENT subdomain (mailservice?, webservice?, ftp?, subdomain*, aliases*, dns?)>
<!ELEMENT mailservice (autoresponder*, mailbox*, forward*, maillist*)*>
<!ELEMENT autoresponder (#PCDATA)>
<!ELEMENT mailbox (mailalias*)>
<!ELEMENT mailalias (#PCDATA)>
<!ELEMENT forward (subscriber+)>
<!ELEMENT maillist (subscriber*, moderator*, messagetrailer?)>
<!ELEMENT subscriber (#PCDATA)>
<!ELEMENT moderator (#PCDATA)>
<!ELEMENT messagetrailer (#PCDATA)>
<!ELEMENT aliases (alias+)>
<!ELEMENT alias (dns?, mailservice?)>
<!ELEMENT dns (record+)>
<!ELEMENT record (#PCDATA)>

<!ELEMENT mysql (mysqldatabase*, mysqluser*)>
<!ELEMENT mysqldatabase (#PCDATA)>
<!ELEMENT mysqluser (grant*)>
<!ELEMENT grant (#PCDATA)>

<!ELEMENT mssql (mssqldatabase*, mssqllogin*)>
<!ELEMENT mssqldatabase (mssqluser*)>
<!ELEMENT mssqluser (#PCDATA)>
<!ELEMENT mssqllogin (#PCDATA)>

<!ELEMENT pgsql (pgsqldatabase*, pgsqluser*)>
<!ELEMENT pgsqldatabase (#PCDATA)>
<!ELEMENT pgsqluser (#PCDATA)>

<!ELEMENT webservice (settings?, errorlog?, transferlog?, webalizer?, modlogan?, referrerlog?, agentlog?,
          urchin3?, urchin4?, cgi?, cgidir?, ismap?, mimetype?, php3?, ssi?, errordoc?, vhost_alias?,
          redirect_url?, directory_ind?, throttle?, mnogosearch?, phpbb?, frontpage?, asp?,
          asp_secured_license?, asp_net?, cf?, idomain_alias?, mssqlmanager?, empresa?, miva?, oscommerce?, ssl? )>
<!ELEMENT settings (#PCDATA)>
<!ELEMENT listitem (#PCDATA)>
<!ELEMENT mimelistitem (#PCDATA)>
<!ELEMENT frontpage (login+, password+)?>
<!ELEMENT cgi (cgilistitem+)>
<!ELEMENT cgidir (listitem+)>
<!ELEMENT cgilistitem (#PCDATA)>
<!ELEMENT ismap (listitem+)>
<!ELEMENT mimetype (mimelistitem+)>
<!ELEMENT php3 (listitem+)>
<!ELEMENT ssi (listitem+)>
<!ELEMENT errordoc (errordocitem+)>
<!ELEMENT errordocitem (#PCDATA)>
<!ELEMENT redirectitem (#PCDATA)>
<!ELEMENT errorlog (#PCDATA)>
<!ELEMENT transferlog (#PCDATA)>
<!ELEMENT webalizer (#PCDATA)>
<!ELEMENT modlogan (#PCDATA)>
<!ELEMENT referrerlog (#PCDATA)>
<!ELEMENT agentlog (#PCDATA)>
<!ELEMENT serveralias (#PCDATA)>
<!ELEMENT directory_ind (#PCDATA)>
<!ELEMENT mnogosearch (#PCDATA)>
<!ELEMENT throttle (#PCDATA)>
<!ELEMENT phpbb (#PCDATA)>
<!ELEMENT urchin3 (#PCDATA)>
<!ELEMENT urchin4 (#PCDATA)>
<!ELEMENT vhost_alias (listitem+)>
<!ELEMENT redirect_url (redirectitem+)>
<!ELEMENT asp (asp_secured+)>
<!ELEMENT asp_secured (#PCDATA)>
<!ELEMENT asp_net (#PCDATA)>
<!ELEMENT asp_secured_license (#PCDATA)>
<!ELEMENT login (#PCDATA)>
<!ELEMENT password (#PCDATA)>
<!ELEMENT cf (listitem+)>
<!ELEMENT idomain_alias (#PCDATA)>
<!ELEMENT mssqlmanager (#PCDATA)>
<!ELEMENT empresa (#PCDATA)>
<!ELEMENT miva (#PCDATA)>
<!ELEMENT oscommerce (#PCDATA)>

<!ELEMENT ssl (ssl_key, ssl_cert, ssl_chain?)>
<!ELEMENT ssl_key (#PCDATA)>
<!ELEMENT ssl_cert (#PCDATA)>
<!ELEMENT ssl_chain (#PCDATA)>

<!ELEMENT ftp (ftpvhost|winanonymous)>
<!ELEMENT ftpvhost (unixanonymous?, ftpdirectory*, ftpuser*)>
<!ELEMENT unixanonymous (#PCDATA)>
<!ELEMENT winanonymous (#PCDATA)>
<!ELEMENT ftpdirectory (vdiruser*)>
<!ELEMENT vdiruser (#PCDATA)>
<!ELEMENT ftpuser (#PCDATA)>

<!ATTLIST ftpvhost admin CDATA #REQUIRED>
<!ATTLIST ftpvhost server CDATA #REQUIRED>
<!ATTLIST ftpdirectory name CDATA #REQUIRED>
<!ATTLIST ftpdirectory read CDATA #REQUIRED>
<!ATTLIST ftpdirectory write CDATA #REQUIRED>
<!ATTLIST ftpdirectory list  CDATA #REQUIRED>
<!ATTLIST ftpdirectory forall CDATA #REQUIRED>
<!ATTLIST ftpuser login CDATA #REQUIRED>
<!ATTLIST ftpuser password CDATA #REQUIRED>
<!ATTLIST unixanonymous value (ON|OFF) #REQUIRED>
<!ATTLIST unixanonymous upload (ON|OFF) #REQUIRED>
<!ATTLIST winanonymous name   CDATA #REQUIRED>
<!ATTLIST winanonymous status CDATA #REQUIRED>
<!ATTLIST winanonymous upload CDATA #REQUIRED>
<!ATTLIST vdiruser name CDATA #REQUIRED>

<!ATTLIST user login CDATA #REQUIRED>
<!ATTLIST user password CDATA #REQUIRED>
<!ATTLIST user reseller CDATA "">

<!ATTLIST account suspended CDATA "">
<!ATTLIST account plan CDATA #REQUIRED>
<!ATTLIST account balance CDATA "">
<!ATTLIST account bpid CDATA "">
<!ATTLIST account startdate CDATA "">

<!ATTLIST info prefix CDATA #REQUIRED>
<!ATTLIST item name CDATA #REQUIRED>

<!ATTLIST subaccount login CDATA #REQUIRED>
<!ATTLIST subaccount password CDATA #REQUIRED>
<!ATTLIST subaccount homesuffix CDATA #REQUIRED>

<!ATTLIST domain name CDATA #REQUIRED>
<!ATTLIST domain ip CDATA "">
<!ATTLIST domain type CDATA "transfer">

<!ATTLIST subdomain name CDATA "">
<!ATTLIST mailservice catchall CDATA "">
<!ATTLIST mailbox name CDATA #REQUIRED>
<!ATTLIST mailbox password CDATA "">
<!ATTLIST mailbox description CDATA "The Mailbox">

<!ATTLIST forward name CDATA #REQUIRED>
<!ATTLIST subscriber email CDATA #REQUIRED>
<!ATTLIST moderator email CDATA #REQUIRED>
<!ATTLIST maillist name CDATA #REQUIRED>

<!ATTLIST mysqldatabase name CDATA #REQUIRED>
<!ATTLIST mysqldatabase description CDATA "">
<!ATTLIST mysqluser login CDATA #REQUIRED>
<!ATTLIST mysqluser password CDATA #REQUIRED>
<!ATTLIST grant privileges CDATA #REQUIRED>
<!ATTLIST grant on CDATA #REQUIRED>

<!ATTLIST mssqldatabase name CDATA #REQUIRED>
<!ATTLIST mssqldatabase quota CDATA #REQUIRED>
<!ATTLIST mssqldatabase owner CDATA #REQUIRED>
<!ATTLIST mssqluser login CDATA #REQUIRED>
<!ATTLIST mssqluser name CDATA #REQUIRED>
<!ATTLIST mssqllogin login CDATA #REQUIRED>
<!ATTLIST mssqllogin password CDATA #REQUIRED>

<!ATTLIST pgsqldatabase name CDATA #REQUIRED>
<!ATTLIST pgsqldatabase description CDATA "">
<!ATTLIST pgsqldatabase owner CDATA #REQUIRED>
<!ATTLIST pgsqluser name CDATA #REQUIRED>
<!ATTLIST pgsqluser password CDATA #REQUIRED>

<!ATTLIST alias name CDATA #REQUIRED>
<!ATTLIST alias dns CDATA "1">
<!ATTLIST alias mail CDATA "1">

<!ATTLIST mailalias name CDATA #REQUIRED>

<!ATTLIST autoresponder local CDATA #REQUIRED>
<!ATTLIST autoresponder subject CDATA #REQUIRED>

<!ATTLIST record name CDATA #REQUIRED>
<!ATTLIST record type CDATA #REQUIRED>
<!ATTLIST record ttl CDATA #REQUIRED>
<!ATTLIST record data CDATA #REQUIRED>
<!ATTLIST record pref CDATA "">

<!ATTLIST settings index (enabled|disabled|fancy) #REQUIRED>
<!ATTLIST settings symlink (enabled|disabled|owner) #IMPLIED>
<!ATTLIST settings ssi (enabled|disabled) #IMPLIED>
<!ATTLIST settings multiview (enabled|disabled) #IMPLIED>
<!ATTLIST settings iis_status (running|stopped) #IMPLIED>

<!ATTLIST errorlog value (ON|OFF) #REQUIRED>
<!ATTLIST transferlog value (ON|OFF) #REQUIRED>
<!ATTLIST webalizer value (ON|OFF) #REQUIRED>
<!ATTLIST modlogan value (ON|OFF) #REQUIRED>
<!ATTLIST referrerlog value (ON|OFF) #REQUIRED>
<!ATTLIST agentlog value (ON|OFF) #REQUIRED>
<!ATTLIST asp value (ON|OFF) #REQUIRED>
<!ATTLIST asp_net value (ON|OFF) #REQUIRED>
<!ATTLIST frontpage value (ON|OFF) #IMPLIED>
<!ATTLIST idomain_alias value (ON|OFF) #IMPLIED>
<!ATTLIST mssqlmanager value (ON|OFF) #IMPLIED>
<!ATTLIST empresa value (ON|OFF) #IMPLIED>
<!ATTLIST miva value (ON|OFF) #IMPLIED>
<!ATTLIST oscommerce value (ON|OFF) #IMPLIED>

<!ATTLIST ssl sitename CDATA "">
<!ATTLIST urchin3 value (ON|OFF) #REQUIRED>
<!ATTLIST urchin4 value (ON|OFF) #REQUIRED>
<!ATTLIST asp_secured value (ON|OFF) #REQUIRED>
<!ATTLIST asp_secured_license value (ON|OFF) #REQUIRED>
<!ATTLIST asp_secured_license orderid CDATA #IMPLIED>

<!ATTLIST cgilistitem ext CDATA #REQUIRED>
<!ATTLIST cgilistitem handler CDATA #IMPLIED>

<!ATTLIST mimelistitem ext CDATA #REQUIRED>
<!ATTLIST mimelistitem mime CDATA #REQUIRED>

<!ATTLIST errordocitem code CDATA #REQUIRED>
<!ATTLIST errordocitem message CDATA #REQUIRED>
<!ATTLIST errordocitem doctype CDATA #IMPLIED>

<!ATTLIST redirectitem urlpath CDATA #REQUIRED>
<!ATTLIST redirectitem protocol CDATA #REQUIRED>
<!ATTLIST redirectitem url CDATA #REQUIRED>
<!ATTLIST redirectitem status CDATA #IMPLIED>
<!ATTLIST redirectitem below CDATA #IMPLIED>
<!ATTLIST redirectitem exact CDATA #IMPLIED>
<!ATTLIST redirectitem perm CDATA #IMPLIED>

<!ATTLIST throttle type CDATA #REQUIRED>
<!ATTLIST throttle limit CDATA #REQUIRED>
<!ATTLIST throttle limitUn CDATA #IMPLIED>
<!ATTLIST throttle interval CDATA #REQUIRED>
<!ATTLIST throttle intervalUn CDATA #REQUIRED>

<!ATTLIST mnogosearch db CDATA #REQUIRED>
<!ATTLIST mnogosearch user CDATA #REQUIRED>

<!ATTLIST phpbb db CDATA #REQUIRED>
<!ATTLIST phpbb user CDATA #REQUIRED>

<!ATTLIST oscommerce db CDATA #REQUIRED>
<!ATTLIST oscommerce user CDATA #REQUIRED>

<!ATTLIST ssi exec CDATA #IMPLIED>

<!ATTLIST dsn_record driver-name CDATA #REQUIRED>
<!ATTLIST dsn_record dsn CDATA #REQUIRED>

<!ATTLIST driver_param name CDATA #REQUIRED>
<!ATTLIST driver_param value CDATA #REQUIRED>

<!ATTLIST crontab mailto CDATA #REQUIRED>

 

DTD Chart

The above structure may be represented graphically in the following chart:


                                users
                                 | ...
                                user
                                 | ...
                               account
           ___________________/  |  \ \___________________________________________________________________________
          /                  /   |   \                              \                \         \                  \
    ftpsubaccounts          /    |    \                              \              mssql      pgsql              ftp
      /...             mysql limits domain                           info          /   |       /  \              /   \
 subaccount            / |     / \      \                              |...       /... |...   /... \        ftpvhost winanonymous
                      /  | quota traffic \__________________________   |    mssqllogin | pgsqluser  |...    ___|__________
                     /   |               /\      \        \         \ item             |            |      /   |...       \...
              database mysqluser        /  \      \        \         \         mssqldatabase pgsqldatabase | ftpuser ftpdirectory
                        /              /   /\      \        \   ...   \             |                      |               |...
                      grant           /   /  \      \        \         \            |...              unixanonymous    vdiruser
                                     /   /    \      \        \         \        mssqluser
                           mailservice dns aliases webservice subdomain subdomain
                          /            /     | ...    |              \
           ______________/            /      |        |               \
          /\            |\         record  alias      |                \___________________________
         /  \           | \               /  \        |                      /\    \     \         \
        /    \          |  \             /... \...    |                     /  \    \     \         \
       /      \         |   \          dns mailservice|                    /   /\    \     \   ...   \
autoreponder mailbox forward maillist   |     |       |                   /   /  \    \     \         \
               |        |       |      ...   ...      |                  /   /    \    \     \         \
        mailalias  subscriber   |                     |         mailservice dns aliases \   subdomain subdomain
                   ____________/|                     |               |     |    |       \       |      |
                  /          /  |                     |              ...   ...  ... webservice  ...    ...
     messagetrailer subscriber moderator              |                                   |
                                                    __|__                                ...
          _________________________________________/  |  \______________________________________________________________
         /    |         |          |        |         |          |        |        |       |         \        \         \
 settings errorlog transferlog webalizer modlogan     |     referrerlog agentlog urchin3 urchin4 mssqlmanager phpbb     ssl (optional)
                                                      |                                                                 /|\
                                                      |                                                          ssl_key | ssl_chain (optional)
                                                    __|__                                                                |
      _____________________________________________/  |  \______________________________________________________       ssl_cert
     /        /       |        |        |             |   |       |        |         |            |        \    \
 frontpage cgi      cgidir   ismap   mimetype         |  php3    ssi    errordoc  vhost_alias redirect_url  \  directory_ind
   /  |     |...      |...     |...     |...          |   |...    |...     |...      |...         |...       \
login | cgilistitem listitem listitem mimelistitem    | listitem listitem listitem listitem  redirectitem   throttle
      |                                             __|__
  password  _______________________________________/     \_________________________________
           /    |          |              |     |             |           |       |        \
  mnogosearch  asp asp_secured_license asp_net  cf       domain_alias  empresa  miva  oscommerce
                |                              /...
            asp_secured                     listitem

 

Attributes Description

  • user:
    • login - user login
    • password - user password
    • reseller - reseller name (if no reseller, set reseller="admin" or omit this attribute)
  • account (see Preserving Billing Balance in Migrating Users guide):
    • plan - plan name
    • balance - account balance
    • bpid - billing period ID (see Preserving Billing Balance)
    • startdate - account start date
  • info (contact/billing signup information): (see the signup form fields description)
    • type="_ci_" (contact info) or type="_bi_" (billing info)
  • item (contact/billing info item):
    • name - name of the field in the signup form
  • domain:
    • name - domain name
    • ip - domain ip. If missing, the shared IP is used
    • type - domain type (see the domain fields description in User Signup Customization guide
  • subdomain:
    • name - subdomain name
  • mailservice (see Mailboxes):
    • catchall="<email_address> - if set, any email messages sent to a nonexistent account on your domain will be bounced to this address.
  • mailbox:
    • name - mailbox name
    • password - mailbox password
    • description - mailbox description, by default to be "The Mailbox"
      in 2.4.4: If it is set to FORWARD_ONLY, mailbox itself will not be created. This is done to allow to migrate "forward" without creating a mailbox for each forward (and storing email).
  • forward:
    • name - forward name
  • subscriber:
    • email - subscriber's email
  • moderator:
    • email - moderator's email
  • maillist:
    • name - mailing list name
  • mysqldatabase:
    • name - database name
    • description - database description
  • mysqluser:
    • login - login name
    • password - user password
  • grant:
    • privileges - user privileges
    • on - database name
  • alias:
    • name - alias name
    • dns = "1" - with dns zone
    • mail - if set to 1, mail domain alias is created in addition to web alias
  • mailalias:
    • name - name of the aliased object
  • autoresponder:
    • local - local email address;
    • subject - email subject
  • record (custom DNS record):
    • name - DNS record name
    • type - DNS record type (A, MX, CNAME)
    • ttl - time for the record to be refreshed in the provider's DNS cache, in seconds (usually, 86400 seconds, or 1 day)
    • data - the IP address fully qualified domain name will be mapped to
    • pref - MX record priority, in descending order: N, N-1, ..., 2, 1 (MX records only; empty otherwise)
  • settings (Web service settings):
    • index - index type of a web directory where index file is absent:
      index="disabled" - don't show web directory content;
      index="enabled" - show web directory content;
      index="fancy" - show directory content, with icons for directories and files of different content types
    • symlink - disabled/enabled/owner
    • ssi - disabled/enabled
    • multiview - disabled/enabled
    • iis_status - IIS server status (running/stopped)
  • ssl:
    • sitename - optional attribute (if set should contain website name, as specified in ssl certificate)
    ssl_key - private key
    ssl_cert - certificate
    ssl_chain - chain file (optional)
  • errorlog, transferlog, webalizer, modlogan, referrerlog, agentlog, asp, asp_net, asp_secured, urchin3, urchin4, idomain_alias, mssqlmanager, empresa, miva, oscommerce, frontpage:
    • value = "ON|OFF" (resource is on or off)
  • asp_secured_license:
    • value = "ON|OFF" (resource is on or off)
    • orderid - order idenfifier
  • cgilistitem:
    • ext - file extension
    • handler - extension handler (Perl)
  • mimelistitem:
    • ext - mime extension
    • mime - extension type
  • errordocitem:
    • code - error code (e.g., 404 - not found)
    • message - error message/url
    • doctype - document type (doctype="1" - redirect, doctype="0" - message)
  • redirectitem:
    • urlpath - redirect URI pathname
    • protocol - http, ftp, ...
    • url - redirect url
    • status - redirect status (permanent/temp/seeother/gone)
    • exact - exact URL entered above (for Windows)
    • below - directory below the given one (for Windows)
    • perm - permanent redirection for this resource (for Windows)
  • throttle (see Throttle Policy):
    • type - policy type
    • limit - limit on the volume
    • limitUn - limit units (Kilobytes/Megabytes/Gigabytes)
    • interval - time interval
    • intervalUn - interval units (sec/minutes/hours/days/weeks)
  • mnogosearch, phpbb, oscommerce - not implemented yet
  • mssqllogin:
    • login - login name
    • password - login password
  • mssqldatabase:
    • name - database name
    • quota - database quota
    • owner - owner name (mssqllogin)
  • mssqluser:
    • login - user login
    • name - user name
  • pgsqluser:
    • name - user name
    • password - user password
  • pgsqldatabase:
    • name - database name
    • description - database description
    • owner - owner name (pgsqluser)
  • winanonymous:
    • name - server name
    • status - server status
    • upload = "1|0" - FTP upload allowed/rejected
  • ftpvhost:
    • admin - admin email
    • server - server name
  • ftpdirectory:
    • name - directory name
    • read = "1|0" - enabled/disabled permission on reading the directory content
    • write = "1|0" - enabled/disabled permission to write to the directory
    • list ="1|0" - enabled/disabled permission to list files/dirs with ls command
    • forall ="1|0" - grant all permissions; overrides all other permission settings if is set to 1
  • ftpuser:
      login - ftp user login password - ftp user password
  • vdiruser (virtual FTP directory user):
    • name - user login name
  • unixanonymous:
    • value = "on|off" - resource enabled/disabled
    • upload = "on|off" - upload allowed/disallowed
  • subaccount (ftp subaccount):
  • login - user login
  • password - user password
  • homesuffix - FTP subaccount directory path, relative to the account's FTP home directory

Related Docs:   Migrating Users Into H-Sphere User XML Tags Specification (for 2.5 +)



© Copyright 2017. Parallels Holdings. All rights reserved.