Parallels Operations Automation 5.4

Transcription

2 Parallels IP Holdings GmbH c/o Parallels International GmbH Vordergasse 59 CH-Schaffhausen Switzerland Phone: Fax: Copyright Parallels IP Holdings GmbH and its affiliates. All rights reserved. Distribution of this work or derivative of this work in any form is prohibited unless prior written permission is obtained from the copyright holder. { Patented technology protected by U.S.Patents 7,328,225; 7,325,017; 7,293,033; 7,099,948; 7,076,633. Patents pending in the U.S.} Product and service names mentioned herein are the trademarks of their respective owners. Parallels Operations Automation is a registered trademark of Parallels.

3 Contents Preface... 6 Documentation Conventions... 6 Typographical Conventions...6 General Conventions...8 Feedback... 8 Introduction... 9 Definitions, Acronyms, and Abbreviations... 9 Acronyms and Abbreviations...9 Definitions References Objects Parallels Operations Automation Management Node Service Node Service Template Parallels Business Automation Service Plan Source System Source Server External Service Template Mapping External Service Template to Parallels Operations Automation Service Templates and/or Parallels Business Automation Service Plans... 13

4 Migration Agent Migration Manager Migration Flows Source Server Registration Accounts Verification Accounts and Subscriptions Migration Content Publishing (Migration) Verification Flow in Details System Requirements Migrated Objects in XML Form Common Types Used in XML Documents 'ExtIdentifier' Data Type ' Address' Data Type 'DisableState' Attribute Group 'Domains' Data Type 'AccountType' Data Type 'ServiceTemplates' Data Type 'HostingSubscription', 'DomainRegSubscription' and 'ResourceSubscription' Data Types 'AccountAttributes' Attribute Group 'CompanyName' Data Type Source System (Platform) XML Root Element and XML Namespaces 'Account' Element Account XML Root Element and XML Namespaces 'Account' Element 'ContactInfo' Data Type 'Phone' Data Type 'Address' Data Type 'BillingInfo' Data Type 'PaymentTools' Data Type 'Members' Data Type 'SubscriptionsEx' Data Type Services XML Root Element and XML Namespaces... 52

5 Hosted Service Users Domain Parking Microsoft IIS Microsoft Exchange DNS Databases Pure DSN Qmail Apache Migration Agents Development Overview Agents Manifest Root Element and XML Namespaces Agent's Features SSH Connection Settings Developing Agent for Linux-based Source System Overview Command Line Interface Developing Agent for Windows-based Source System Migration Framework Service Interface AgentModule Interface Linux-Based Hosting: List of Supported Features by Migration Manager Windows-Based Hosting: List of Supported Features by Migration Manager Deploying Migration Framework Exchange Migration: Preparing, Configuration and Post-Migration Steps Preparing for MS SQL Migration Registering/Upgrading/Unregistering Custom Migration Agent in POA Sample XSL Transformation Instructions Platform XSLT Account XSLT Services XSLT Using Action Scripts Index

6 C HAPTER 1 Preface In This Chapter Documentation Conventions...6 Feedback...8 Documentation Conventions Before you start using this guide, it is important to understand the documentation conventions used in it. Typographical Conventions The following kinds of formatting in the text identify special information. Formatting convention Type of Information Example Special Bold Items you must select, such as menu options, command buttons, or items in a list. Titles of modules, sections, and subsections. Navigate to the QoS tab. Read the Basic Administration module.

7 Preface Italics Important Used to emphasize the importance of a point, to introduce a term or to designate a command line placeholder, which is to be replaced with a real name or value. An important note provides information that is essential to the completion of a task. Users can disregard information in a note and still complete a task, but they should not disregard an important note. These are the so-called shared VEs. To destroy a VE, type vzctl destroy VEid. Important: The device drivers installed automatically during Setup are required by your system. If you remove one of these drivers, your system may not work properly. Note Monospace Preformatted Preformatted Bold CAPITALS KEY+KEY A note with the heading Note indicates neutral or positive information that emphasizes or supplements important points of the main text. A note supplies information that may apply only in special cases for example, memory limitations, equipment configurations, or details that apply to specific versions of a program. The names of commands, files, and directories. On-screen computer output in your command-line sessions; source code in XML, C++, or other programming languages. What you type, contrasted with on-screen computer output. Note: If Windows prompts you for a network password at startup, your network is already set up and you can skip this section. Use vzctl start to start a VE. Saved parameters for VE 101 # rpm V virtuozzorelease Names of keys on the keyboard. SHIFT, CTRL, ALT Key combinations for which the user must press and hold down one key and then press another. CTRL+P, ALT+F4 7

8 Preface General Conventions Be aware of the following conventions used in this book. Modules in this guide are divided into sections, which, in turn, are subdivided into subsections. For example, Documentation Conventions is a section, and General Conventions is a subsection. When following steps or using examples, be sure to type double-quotes ("), left singlequotes (`), and right single-quotes (') exactly as shown. The key referred to as RETURN is labeled ENTER on some keyboards. Commands in the directories included into the PATH variable are used without absolute path names. Steps that use commands in other, less common, directories show the absolute paths in the examples. Feedback If you have found a mistake in this guide, or if you have suggestions or ideas on how to improve this guide, please send your feedback using the online form at Please include in your report the guide's title, chapter and section titles, and the fragment of text in which you have found an error. 8

9 C HAPTER 2 Introduction This guide describes the methods of migrating the objects from external hosting systems to Parallels Operations Automation. It provides an overview of migration terms and acronyms as well as diagrams, development rules and hints, and the samples of migration agents with the comments. In This Chapter Definitions, Acronyms, and Abbreviations...9 References...10 Definitions, Acronyms, and Abbreviations The following definitions, acronyms, and abbreviations are used throughout the document: Acronyms and Abbreviations Acronym/Abbreviation POA PBA - E MA MM MM CP NS CCP MN ST PPM Expansion Parallels Operations Automation Parallels Business Automation - Enterprise Migration Agent Migration Manager Migration Manager Control Panel Name server Parallels Operations Automation Customer Control Panel Parallels Operations Automation Management Node Parallels Operations Automation Service Template Parallels Operations Automation Package Manager

10 Introduction Definitions Definition OpenAPI SSH Description XML-RPC extension for interacting with Parallels Operations Automation/Parallels Business Automation - Enterprise A set of standards and an associated network protocol that allows establishing a secure channel between a local and a remote computer. It uses public-key cryptography to authenticate the remote computer and (optionally) to allow the remote computer to authenticate the user Source Server See the Source System section (on page 13). Source System See the Source Server section (on page 13). Protective Subscription Migration API Migration Framework Expired Subscription, which should be migrated to Parallels Operations Automation/Parallels Business Automation - Enterprise. The protective time interval is defined by the migration settings for each registered source server in MM. If a Subscription is expired after the protective time interval, it will not be migrated. See the Accounts Verification section (on page 19). Set of well-defined XML structures that describe services, tools and SDK, which allows to simplify the third-party migration agents development. Special environment where Migration Agents for Windows-based source systems are executed. It provides the Web service interface (see the Migration Framework Service Interface section (on page 147)) for communication with Migration Manager. References The following documents are referenced elsewhere in this document: [1] - Parallels Operations Automation Provider s Guide [2] - Parallels Operations Automation Subscriber s Guide [3] - Parallels Business Automation Getting Started Guides [4] - Parallels Operations Automation Migration Manager 2.0 User s Guide [5] - Parallels Business Automation Resellers Guide XML Schema used by Migration Manager for validating XML documents is available after installing MM SC package and is stored in <POA_ROOT>/share/migration/xsd/. 10

11 C HAPTER 3 Objects This chapter describes the objects, involved in the migration process, and their roles in migrating of data as accurate and safe as possible. In This Chapter Parallels Operations Automation...12 Parallels Business Automation...12 Source System...13 Migration Agent...14 Migration Manager...14

12 Objects Parallels Operations Automation Parallels Operations Automation is a multi-server management and control system for both UNIX and Windows-based web hosts. The system is intended for web hosting companies of any size - data centers and Internet service providers (ISPs). Management Node Parallels Operations Automation Management Node (MN) is a core of the system - centralized control point for all components. The core includes a set of components, which delivers services to end-users and manages distributed services across service nodes. Refer to [1]. Service Node Service Node is a dedicated hardware node (server) that provides one or more system/custom services. For example, the mail service Service Node provides , antispam and/or anti-virus services. Refer to [1]. Service Template Service Template is a list of resources with defined usage limits. Service Templates contain information that must be provided to the system so that the system can automatically provision services to customers. Without Service Templates, each resource would have to be provisioned on a customer account manually. Service Templates can be used to automatically provision resources and services on millions of customer accounts. Refer to [1] and [2]. Parallels Business Automation Parallels Business Automation (PBA) is used to manage user s sales and billing operations. PBA supports all business tasks related to creating and selling Service Plans. Parallels Business Automation is fully integrated with both Parallels Operations Automation and the built-in online store that is included in the installation package. Refer to [3]. Service Plan 12

13 Objects Service Plan is a commercial offer of computer resources and services. When customers buy Service Plans, they reserve rights to use a certain amount of hosting resources and services at a certain rate over a certain period of time, usually starting from the day of purchase. Purchasing a Service Plan is equivalent to subscribing to the services listed in the plan. Refer to [3]. Source System Under the term Source System we assume the entire hosting (and billing) platform. It may have or not have the central control server (similar to Parallels Operations Automation MN), several servers (similar to Parallels Operations Automation Service Nodes) or only one server. Source Server Under the term Source Server we assume a host where a hosting system is deployed (Source System) and Migration Agent resides. In case of a distributed source system, it may be a Management Node (core). External Service Template External Service Template is a set of services offered to customers by some hosting automation system. Some source systems may not have Service Templates as the special entities intended for grouping and limiting resources (services) to be offered to the end-user. In this case, MA should create a virtual Service Template, associate the necessary Subscription with this template and store it in the XML document. Mapping External Service Template to Parallels Operations Automation Service Templates and/or Parallels Business Automation Service Plans The following details should be specified for each class of external Service Templates: Parallels Operations Automation Service Template (will be used for providing hosting services); Parallels Business Automation Service Plan (will be used for creating Subscriptions in the billing system).. 13

14 Objects Migration Agent Migration Agent is a set of simple programs or/and scripts intended for collecting information from the source system in a strictly defined XML form (XML documents). Migration Agents are separated by the type of operating system. Linux-based migration agents are implemented as the command-line tools and MM communicates with such agent via SSH protocol. Windows-based migration agents are implemented as.net dynamicallyloaded libraries ( assemblies ) and MM uses SOAP over HTTP to communicate with them. For more information, refer to the Migration Agents Development section (on page 142). Migration Manager The structure of the MM is represented on the figure below: 14

15 Objects Account Provisioning Engine is a part of MM, responsible for creation customer accounts in Parallels Operations Automation and Parallels Business Automation. The following data will be migrated: Logins and passwords [2]. Administrative/technical/billing contact information. Company address. Current balance (used by the billing system only) [3]. Payment tools (used by the billing system only) [3]. Subscription Provisioning Engine is a part of MM, responsible for recreation Subscriptions in Parallels Operations Automation and/or Parallels Business Automation. The following data will be migrated: Subscription creation date. Expiration date. Login/password to registrar (only for domains). Subscription period (certain time interval within the Subscription is valid). Billing period - Parallels Business Automation collects statistics on the daily resource usage and bills a customer for provided services once in a billing period [3]. Subscription fee. Setup fee. Renewal fee (only for domains). Transfer fee (only for domains). Refund period. Non-refundable amount. Last billing date. Next billing date. See [3, 5] for more details. Service Provisioning Engine is a part of MM responsible for processing information on domain services contained in the XML document (see Appendix A (on page 149) and Appendix B (on page 155) for a complete list of the supported services), and recreating it in POA. Agent Communicator is a part of MM responsible for communication with MA. System Core is a core of MM. 15

16 Objects On the figure below the way of communication between POA, PBA - E and source servers is shown. Migration Manager uses the SSH protocol to communicate with MA and to deliver the content. Figure 1: Intercommunications Note: The SSH protocol is suitable for UNIX-like operating systems, but not for Microsoft Windows 2000/2003/XP operating systems. For migrating a billing-related data (for example, the domain registration Subscription or Subscription for some resource), MM uses OpenAPI to deliver the data into PBA - E. 16

17 Objects Figure 2: Deployment of Migration Components 17

18 C HAPTER 4 Migration Flows Migration flow consists of four phases: 1 Source server registration, 2 Accounts verification, 3 Accounts and Subscriptions migration, 4 Content publishing (migration). In This Chapter Source Server Registration Accounts Verification Accounts and Subscriptions Migration Content Publishing (Migration) Verification Flow in Details... 22

19 C HAPTER 5 Source Server Registration During this phase, MA will be installed, the source server(s) will be registered, the migration settings will be configured, reseller account(s) will be associated and mappings for all external Service Templates will be defined. Figure 3: Source Server Registration Accounts Verification During this phase, MM checks accounts and all own Subscriptions and determines, which of them can be migrated and which are not.

20 Migration Flows Figure 4: Accounts Verification Accounts and Subscriptions Migration During this phase, MM migrates customer account(s) and all Subscriptions. 20

21 Migration Flows 21

22 Migration Flows Figure 5: Accounts and Subscription Migration Content Publishing (Migration) During this phase, MM makes content backups, transfers them to the appropriate service nodes and restores them. Figure 6: Content Publishing Verification Flow in Details Verification process is intended for preliminary checking data before migrating it to the system. 22

23 Migration Flows Verification process is applied only to Account or Subscription. The process consists of 3 phases: Customer account verification, Verification of corresponding reseller's account(s), Verification of all customers Subscriptions. Customer's account cannot be migrated if the reseller's account or customer's account itself did not successfully pass verification. Subscription cannot be migrated if the corresponding account and its owner (reseller's account) did not successfully pass verification. Object being verified Verification result Conditions How to resolve issues Reseller account Verified Always, if no one condition defined for the Verification failed status is not truth. Reseller account Verification failed Parent account (reseller's or provider's) is not migrated yet. One should associate the corresponding reseller's account with already created in the system reseller's account. Reseller's account is not associated with any reseller existing in the system. One should associate given reseller's account with already created in the system reseller's account. One or more own Subscriptions did not pass the verification. One should check and resolve verification issues for all Subscriptions (or mark Subscription(s) as not selected for migration ). 23

24 Migration Flows Object being verified Verification result Conditions How to resolve issues Customer account Verified Always, if no one condition defined for the Verification failed status is not truth. Customer account Verification failed Parent account (reseller's or provider's) is not migrated. One should associate corresponding reseller's account with already created in the system reseller's account. One or more own Subscriptions did not pass verification. One should check and resolve verification issues for all Subscriptions (or mark Subscription(s) as not selected for migration ). Subscription Verified Always, if no one condition defined for the Verification failed status is not truth. Subscription Verification failed Owner account did not pass verification. External Service Template is not mapped. Wrong creation and expiration dates. Creation and expiration dates are not defined until the Service Plan is defined for corresponding Service Template mapping. Disabling date for disabled Subscription is out of protection period ranges. One should check and resolve verification issues for owner account. One should configure a Service Template mapping before migrating Subscriptions. One should fix corresponding MA and update information about the entire source server. One should fix corresponding MA and update information about the entire source server or remove mapping to Service Plan. If such Subscriptions are to be migrated, one should expand ranges for protection period or turn off protection period at all. 24

25 Migration Flows Object being verified Verification result Conditions How to resolve issues Disabling date for disabled Subscription is not defined. If such Subscriptions are to be migrated, one should turn off protection period for corresponding a source server. 25

26 C HAPTER 6 System Requirements UNIX/Linux: Perl version 5.6 and higher, MIME::Base64 perl module (refer to TCP port 22 (SSH) on a source server. Win32:.NET Framework 1.1, TCP port 9091 (for HTTP listener) on a source server.

27 C HAPTER 7 Migrated Objects in XML Form In This Chapter Common Types Used in XML Documents...27 Source System (Platform) XML...35 Account XML...38 Services XML...52 Common Types Used in XML Documents This section describes common data types that are used in several XML documents (refer to the Common.xsd). 'ExtIdentifier' Data Type This type is used for storing MA identifiers for entities of any kind. <xsd:simpletype name="extidentifier"> <xsd:restriction base="xsd:string"> <xsd:minlength value="1"/> <xsd:maxlength value="255"/> </xsd:restriction> </xsd:simpletype> XML schema: ' Address' Data Type This type is used for storing any address. <xsd:simpletype name=" address"> <xsd:restriction base="xsd:token"> <xsd:maxlength value="400"/> <xsd:pattern value="\c+@\c+"/> </xsd:restriction> </xsd:simpletype> XML schema:

28 'DisableState' Attribute Group This attribute group contains information about disabling of some entity. <xsd:attributegroup name="disablestate"> <xsd:attribute name="disabled" type="xsd:boolean" use="optional" default="false" /> <xsd:attribute name="disabledate" type="xsd:datetime" use="optional" /> </xsd:attributegroup> Element/Attribute Default Value Available Description XML schema: disabled * false 2.8 Shows if entity is disabled or not. disabledate * 2.8 Date of entity disabling 'Domains' Data Type Data of this type contains collection of domain names. <xsd:simpletype name="domainname"> <xsd:restriction base="xsd:token"> <xsd:pattern value=".+"/> </xsd:restriction> </xsd:simpletype> <xsd:complextype name="domains"> <xsd:element name="domain" type="domainname" maxoccurs="unbounded"/> Element/Attribute Default Value Available Description domain 2.8 Domain name. XML schema: 28

29 'AccountType' Data Type This data type describes the type of the account. Accounts can be of the following types: provider, reseller, customer. <xsd:simpletype name="accounttype"> <xsd:restriction base="xsd:token"> <xsd:enumeration value="provider"/> <xsd:enumeration value="reseller"/> <xsd:enumeration value="customer"/> </xsd:restriction> </xsd:simpletype> XML schema: 29

30 'ServiceTemplates' Data Type Data of this type contains collection of external Service Templates. ServiceTemplate structure describes the external Service Template (Plan) on a source system. Note: This is meaningful only for provider and reseller accounts. <xsd:complextype name="servicetemplatebase" abstract="true"> <xsd:element name="name" type="xsd:token"/> <xsd:element name="description" type="xsd:string" minoccurs="0"/> <xsd:attribute name="id" type="extidentifier" use="required"/> XML schema: <xsd:complextype name="hostingservicetemplate"> <xsd:complexcontent> <xsd:extension base="servicetemplatebase"/> </xsd:complexcontent> <xsd:complextype name="domainregservicetemplate"> <xsd:complexcontent> <xsd:extension base="servicetemplatebase"> <xsd:element name="tld" type="xsd:token"/> </xsd:extension> </xsd:complexcontent> <xsd:complextype name="resourceservicetemplate"> <xsd:complexcontent> <xsd:extension base="servicetemplatebase"/> </xsd:complexcontent> <xsd:complextype name="servicetemplates"> <xsd:choice maxoccurs="unbounded"> <xsd:element name="hostingservicetemplate" type="hostingservicetemplate"/> <xsd:element name="domainregservicetemplate" type="domainregservicetemplate"/>  <xsd:element name="resourceservicetemplate" type="resourceservicetemplate"/> </xsd:choice> Element/Attribute Default Value Available Description hostingservicet emplate 2.9 External hosting Service Template description. 30

31 Element/Attribute Default Value Available Description domainregserv icetemplate resourceservice Template 2.9 External domain registration service template description. 2.9 Reserved, currently not used. name 2.8 External Service Template name. Will be displayed in MM CP. description * 2.8 External Service Template 2.8 Identifier of external Service Template on a source system. For details, refer to the ExtIdentifier Data Type section (on page 27). tld 2.9 Top level domain name of the external domain registration Service Template. 31

32 'HostingSubscription', 'DomainRegSubscription' and 'ResourceSubscription' Data Types These data types represent the basic information about the Subscriptions of the corresponding types. The ResourceSubscription data type is reserved and currently is not used. XML schema: <xsd:complextype name="subscriptionbase" abstract="true"> <xsd:element name="creationdate" type="xsd:datetime" minoccurs="0"/> <xsd:element name="expirationdate" type="xsd:datetime" minoccurs="0"/> <xsd:attribute name="id" type="extidentifier" use="required"/> <xsd:attribute name="servicetemplateid" type="extidentifier" use="required"/> <xsd:attributegroup ref="disablestate" /> <xsd:attribute name="destinationid" type="xsd:positiveinteger" use="optional"/> <xsd:complextype name="hostingsubscription"> <xsd:complexcontent> <xsd:extension base="subscriptionbase"> <xsd:element name="domains" type="domains" minoccurs="0"/> </xsd:extension> </xsd:complexcontent> <xsd:complextype name="domainregsubscription"> <xsd:complexcontent> <xsd:extension base="subscriptionbase"> <xsd:element name="domain" type="domainname"/>  <xsd:element name="login" type="xsd:normalizedstring" minoccurs="0" /> <xsd:element name="password" type="xsd:normalizedstring" minoccurs="0" /> </xsd:extension> </xsd:complexcontent> <xsd:complextype name="resourcesubscription"> <xsd:complexcontent> <xsd:extension base="subscriptionbase"/> </xsd:complexcontent> Element/Attribute Default Available Description Value creationdate * 2.8 Subscription creation date. expirationdate * 2.8 Subscription expiration date. If a Subscription is too old, it will not be migrated. 32

33 Element/Attribute Default Value Available Description domains (HostingSubscription) * 2.8 Domains list. This information will be only shown in MM CP. For details about the Domains type, see the Domains Data Type section (on page 2.8 External ID of a Subscription. For details about external IDs, see the ExtIdentifier Data Type section (on page 2.8 External ID of a Subscription s Service Template. DisableState attribute group domain (DomainRegSubscripti on) login (DomainRegSubscripti on) password (DomainRegSubscripti on) For details about external IDs, refer to the ExtIdentifier Data Type section (on page 27). 2.8 State of a Subscription. See the DisableState Attribute Group section (on page 28) for details. 2.9 Registered domains name. * 2.9 Registrar login. * 2.9 Registrar password. 33

34 'AccountAttributes' Attribute Group This attribute group contains the account attributes. <xsd:attributegroup name="accountattributes"> <xsd:attribute name="id" type="extidentifier" use="required"/> <xsd:attribute name="type" type="accounttype" use="optional" default="customer"/> <xsd:attributegroup ref="disablestate" /> <xsd:attribute name="destinationid" type="xsd:positiveinteger" use="optional"/> </xsd:attributegroup> Element/Attribute Default Value Available Description XML 2.8 Account external ID. For details about external IDs, see the ExtIdentifier Data Type section (on page * customer 2.8 Account type. See the AccountType Data Type section for details. DisableState attribute group 2.8 State of a Subscription. See the DisableState Attribute Group section (on page 28) for details. 'CompanyName' Data Type This type is used for storing company's names. <xsd:simpletype name="companyname"> <xsd:restriction base="xsd:token"> <xsd:minlength value="1"/> <xsd:maxlength value="400"/> </xsd:restriction> </xsd:simpletype> XML schema: 34

35 Source System (Platform) XML Source system (or Platform) XML document is created by MA during collecting information about the entire source server (MA registration). See the Platform.xsd document for details. Root Element and XML Namespaces The table below contains the target namespace and namespaces required for XML parser to validate XML document (see the XML sample below). Namespace xmlns:mm=" xmlns:xsi= xsi:schemalocation= Platform.xsd XML schema below defines the response element as the root element of XML document. <xsd:complextype name="platform"> <xsd:element name="name"> <xsd:simpletype> <xsd:restriction base="xsd:normalizedstring"> <xsd:minlength value="1"/> <xsd:maxlength value="24"/> </xsd:restriction> </xsd:simpletype> <xsd:element name="version"> <xsd:simpletype> <xsd:restriction base="xsd:normalizedstring"> <xsd:minlength value="1"/> <xsd:maxlength value="8"/> </xsd:restriction> </xsd:simpletype> <xsd:element name="account" type="platformaccount"/> <xsd:element name="response"> <xsd:complextype> <xsd:element name="platform" type="platform"/> XML schema: Values of the name and version elements will be shown in MM CP after the successful source server s registration. 35

36 Element/Attribute Default Value Available Description response 2.8 Agent s response. platform 2.8 Platform information. name 2.8 Source system name and version. version 2.8 account 2.8 Provider s account description. For details, refer to the Account Element section (on page 36); the next section in the Guide. <?xml version='1.0' encoding="utf-8"?> <mm:response xmlns:mm=" xmlns:xsi=" xsi:schemalocation=" Platform.xsd"> <platform> <name>sample platfrom</name> <version>1.0</version> <account id="1" type="provider"> </account> </platform> </mm:response> 'Account' Element Example: The Account element groups information about provider/resellers, or customers. It contains the list of external Service Templates (for provider or resellers), and Subscriptions, as well as the address to send notifications about migration process to and the company name. XML schema: <xsd:complextype name="platformaccount"> <xsd:element name="companyname" type="companyname"/> <xsd:element name=" " type=" address" minoccurs="0"/> <xsd:element name="servicetemplates" type="servicetemplates" minoccurs="0"/> <xsd:element name="subscriptions" type="subscriptions" minoccurs="0"/> <xsd:element name="accounts" type="platformaccounts" minoccurs="0"/> <xsd:attributegroup ref="accountattributes"/> <xsd:complextype name="platformaccounts"> <xsd:element name="account" type="platformaccount" maxoccurs="unbounded"/> The first account in the document is always the provider s account. It must be declared with explicitly defined attribute type= provider. 36

37 Element/Attribute Default Value Available Description companyname 2.8 Account s company name. Will be shown in MM CP. CompanyName type is described in the "CompanyName" Data Type section (on page 34). * 2.8 address to send notifications to about the process of migration. Address data type is described in the " Address" Data Type (on page 27) section. servicetemplates * 2.8 Describes external Service Templates on the source system. Meaningful only for provider or resellers accounts. See the "ServiceTemplates" Data Type section (on page 30) for details. subscriptions * 2.8 Account s Subscriptions. See the "Subscriptions" Data Type section (on page 32) for details. accounts * 2.8 Accounts owned by a current account (provider or reseller). AccountAttributes attribute group 2.8 Account attributes. For details see the "AccountAttributes" Attribute Group section (on page 34). <account id="1" type="provider"> <companyname>sample company</companyname> <servicetemplates> </servicetemplates> <subscriptions> </subscriptions> <accounts>  </accounts> </account> Example: 37

38 Account XML The account XML document is generated by the MA when it is requested by MM. This document contains detailed information about the account: contact information, billing/payment information, staff members, and so on. If the information in the Account document differs from the information in the Platform XML document, then it is considered that the account on the source system was updated and all information about the account stored in MM is to be updated. See the Account.xsd document. Root Element and XML Namespaces The table below contains the target namespace and namespaces required for XML parser to validate XML document (see XML sample below). Namespace xmlns:mm=" xmlns:xsi= xsi:schemalocation= Account.xsd XML schema below defines the response element as the root element of XML document. XML schema: <?xml version="1.0" encoding="utf-8"?> <xsd:schema xmlns:xsd=" xmlns=" targetnamespace=" elementformdefault="qualified" attributeformdefault="unqualified"> <xsd:element name= response > <xsd:complextype> <xsd:element name="account" type="accountex" minoccurs= 0 /> </xsd:complextype If there is no the account element in the document, then it means that an account was deleted from the source system. If an account was not deleted, its info is stored in the account element. Details about this element see in the "Account" Element section (on page 36). 38 Example: <?xml version='1.0' encoding="utf-8"?> <mm:response xmlns:mm=" xmlns:xsi=" xsi:schemalocation=" Account.xsd"> <account id="sampleaccount"> </account>

39 </mm:response> 39

40 'Account' Element The account element contains the detailed information about a particular account. XML schema: <xsd:complextype name="accountex"> <xsd:complexcontent> <xsd:element name="companyname" type="companyname"/> <xsd:element name="admincontactinfo" type="contactinfo"/> <xsd:element name="billingcontactinfo" type="contactinfo" minoccurs="0"/> <xsd:element name="techcontactinfo" type="contactinfo" minoccurs="0"/> <xsd:element name="companyaddress" type="address" minoccurs="0"/> <xsd:element name="billinginfo" type="billinginfo" minoccurs="0"/> <xsd:element name="paymenttools" type="paymenttools" minoccurs="0"/> <xsd:element name="staffmembers" type="members" minoccurs="0"/> <xsd:element name="servicetemplates" type="servicetemplates" minoccurs="0"/> <xsd:element name="subscriptions" type="subscriptionsex" minoccurs="0"/> <xsd:attributegroup ref="accountattributes"/> </xsd:complexcontent> Element/Attribute Default Value Available Description companyname 2.8 Account's Company name. Will be shown in MM CP; refer to [4]. For details about the CompanyName data type, refer to the CompanyName Data Type section (on page 34). admincontactinfo 2.8 Administrative contact info. For details about the ContactInfo data type, refer to the ContactInfo Data Type section. billingcontactinfo * 2.8 Billing contact info. If this element is omitted, the Administrative contact is used. For details about the ContactInfo data type, refer to the ContactInfo Data Type section. techcontactinfo * 2.8 Technical contact info. If this element is omitted, the Administrative contact is used. For details about the ContactInfo data type, refer to the ContactInfo Data Type section. companyaddress * 2.8 Company address. For details on the Address data type, refer to the Address Data Type section (on page 44). billinginfo * 2.8 Billing information. For details about this data type, refer to the BillingInfo Data Type section (on page 45). paymenttools * 2.8 Contains information about the payment tools. For details about this data type, refer to the PaymentTools Data Type section (on page 45). 40

41 Element/Attribute Default Value Available Description staffmembers * 2.8 Contains information about the staff members. For details, see the Members Data Type section. servicetemplates * 2.8 Describes the Service Templates (or Server Plans) of the external system. Meaningful only for provider or resellers accounts. For details, refer to the Service Templates Data Type section (on page 30). subscriptions * 2.8 The account's Subscriptions. For more detail, read about the HostingSubscription, DomainRegSubscription and ResourceSubscription Data Types (on page 32) and SubscriptionsEx Data Type (on page 50). 41

42 'ContactInfo' Data Type This data type contains contact information. <xsd:complextype name="contactinfo"> <xsd:element name="title" type="xsd:string" minoccurs="0"/> <xsd:element name="firstname" type="xsd:string" minoccurs="0"/> <xsd:element name="middlename" type="xsd:string" minoccurs="0"/> <xsd:element name="lastname" type="xsd:string" minoccurs="0"/> <xsd:element name=" " type=" address" minoccurs="0"/> <xsd:element name="phone" type="phone" minoccurs="0"/> <xsd:element name="fax" type="phone" minoccurs="0"/> <xsd:element name="mobilephone" type="phone" minoccurs="0"/> Element/Attribute Default Value Available Description XML schema: title * 2.8 Person's title firstname * 2.8 Person's first name middlename * 2.8 Person's middle name lastname * 2.8 Person's last name * 2.8 address phone * 2.8 Phone number. fax * 2.8 Fax number. mobilephone * 2.8 Mobile phone number. For details, see the Phone Data Type section (on page 43). For details, see the Phone Data Type section (on page 43). For details, see the Phone Data Type section (on page 43). 42

43 'Phone' Data Type This type contains a phone number. <xsd:complextype name="phone"> <xsd:element name="countrycode" type="xsd:string" minoccurs="0"/> <xsd:element name="areacode" type="xsd:string" minoccurs="0"/> <xsd:element name="phonenumber" type="xsd:string"/> <xsd:element name="extnumber" type="xsd:string" minoccurs="0"/> Element/Attribute Default Value Available Description XML schema: countrycode Country code. areacode * Area code. phonenumber Phone number. extnumber * Extension number. 43

44 'Address' Data Type This type contains an address. XML schema: <xsd:complextype name="address"> <xsd:element name="address1" type="xsd:string" minoccurs="0"/> <xsd:element name="address2" type="xsd:string" minoccurs="0"/> <xsd:element name="zipcode" minoccurs="0"> <xsd:simpletype> <xsd:restriction base="xsd:string"> <xsd:maxlength value="12"/> </xsd:restriction> </xsd:simpletype> <xsd:element name="city" minoccurs="0"> <xsd:simpletype> <xsd:restriction base="xsd:string"> <xsd:maxlength value="64"/> </xsd:restriction> </xsd:simpletype> <xsd:element name="country" minoccurs="0"> <xsd:simpletype> <xsd:restriction base="xsd:string"> <xsd:maxlength value="2"/> </xsd:restriction> </xsd:simpletype> <xsd:element name="state" minoccurs="0"> <xsd:simpletype> <xsd:restriction base="xsd:string"> <xsd:maxlength value="32"/> </xsd:restriction> </xsd:simpletype> Element/Attribute Default Value Available Description address1 * 2.8 Address 1 address2 * 2.8 Address 2 zipcode * 2.8 Zip code city * 2.8 City country * 2.8 Country (2 letters abbreviation). 44

45 Element/Attribute Default Value Available Description state * 2.8 State 'BillingInfo' Data Type This type contains billing information. <xsd:complextype name="billinginfo"> <xsd:element name="balance" type="xsd:decimal" minoccurs="0"/> Element/Attribute Default Value Available Description XML schema: balance * 2.8 Account s billing balance. 'PaymentTools' Data Type This type contains information about account s payment tools. XML schema: <xsd:complextype name="paymenttools"> <xsd:element name="creditcard" type="creditcard" maxoccurs="unbounded"/> Element/Attribute Default Value Available Description creditcard 2.8 Credit card info. See the "CreditCard" Data Type section for details. 45

46 'CreditCard' Data Type This type is used for describing credit cards. <xsd:complextype name="creditcard"> <xsd:element name="cardnumber" type="xsd:string"/> <xsd:element name="expirationdate" type="expirationdate"/> <xsd:element name="paymentsystem" type="paymentsystem"/> <xsd:element name="cvv" type="xsd:integer" minoccurs="0"/> <xsd:element name="useforautopayments" type="xsd:boolean" minoccurs="0" default="false"/> <xsd:element name="cardholder" type="xsd:string" minoccurs="0"/> <xsd:element name=" " type=" address" minoccurs="0"/> <xsd:element name="address" type="address" minoccurs="0"/> <xsd:element name="phone" type="phone" minoccurs="0"/> <xsd:element name="fax" type="phone" minoccurs="0"/> Element/Attribute Default Value Available Description cardnumber 2.8 Credit card number expirationdate 2.8 Credit card expiration date. paymentsystem 2.8 Payment system. XML schema: For details, see the ExpirationDate Data Type section (on page 47). For details, see the PaymentSystem Data Type section (on page 47). cvv * 2.8 The card verification value code useforautopayments * false 2.8 Indicates whether the card should be used for auto-payments, or not cardholder * 2.8 Card holder's name * 2.8 Card holder's . For details, see the Address Data Type section (on page 27). address * 2.8 Card holder's address. phone * 2.8 Card holder's phone. For details about the Address data type, refer to the Address Data Type section (on page 44). For details about the Phone data type, refer to the Phone Data Type section (on page 43). 46

47 Element/Attribute Default Value Available Description fax * 2.8 Card holder's fax. For details about this data type, refer to the Phone Data Type section (on page 43). 'ExpirationDate' Data Type Describes the expiration date. <xsd:complextype name="expirationdate"> <xsd:element name="year" type="xsd:gyear"/> <xsd:element name="month"> <xsd:simpletype> <xsd:restriction base="xsd:integer"> <xsd:mininclusive value="1"/> <xsd:maxinclusive value="12"/> </xsd:restriction> </xsd:simpletype> Element/Attribute Default Value Available Description XML schema: year 2.8 Expiration year. month 2.8 Expiration month. 'PaymentSystem' Data Type The definition of the payment system type. The following types are supported: Visa, Amex, MasterCard, Disc and DC. <xsd:simpletype name="paymentsystem"> <xsd:restriction base="xsd:string"> <xsd:enumeration value="visa"/> <xsd:enumeration value="amex"/> <xsd:enumeration value="mastercard"/> <xsd:enumeration value="disc"/> <xsd:enumeration value="dc"/> </xsd:restriction> </xsd:simpletype> XML schema: 47

48 'Members' Data Type This type contains information about Staff Members. Note: Only one Staff Member is supported currently. <xsd:complextype name="member"> <xsd:element name="contactinfo" type="contactinfo" minoccurs="0"/> <xsd:element name="address" type="address" minoccurs="0"/> <xsd:element name="login" type="xsd:string"/> <xsd:element name="password" type="password" minoccurs="0"/> <xsd:complextype name="members"> <xsd:element name="member" type="member"/> Element/Attribute Default Value Available Description XML schema: member 2.8 Contains information about Staff Members contactinfo * 2.8 Member's contact information. address * 2.8 Member's address. login 2.8 Member's login. password * 2.8 Member's password. For details about this data type, refer to the ContactInfo Data Type section (on page 42). For details about this data type, refer to the Address Data Type section (on page 44). Note: Only plain passwords are supported. For details, see the Password Data Type section (on page 49). 48

49 'Password' Data Type This type contains the password information <xsd:complextype name="password"> <xsd:simplecontent> <xsd:extension base="xsd:string"> <xsd:attribute name="type" use="required"> <xsd:simpletype> <xsd:restriction base="xsd:token"> <xsd:enumeration value="plain"/> <xsd:enumeration value="md5"/> <xsd:enumeration value="sha1"/> <xsd:enumeration value="des"/> <xsd:enumeration value="mysql"/> <xsd:enumeration value="qmail"/> </xsd:restriction> </xsd:simpletype> </xsd:attribute> </xsd:extension> </xsd:simplecontent> Element/Attribute Default Value Available Description XML 2.8 Password type. 49

50 'SubscriptionsEx' Data Type This type contains extended information about subscriptions: HostingSubscriptionEx, DomainRegSubscriptionEx, ResourceSubscriptionEx. ResourceSubscriptionEx is reserved and is not currently used. For more information, see sections HostingSubscription, DomainRegSubscription and ResourceSubscription Data Types (on page 32). XML schema: <xsd:complextype name="hostingsubscriptionex"> <xsd:complexcontent> <xsd:extension base="hostingsubscription"> <xsd:group ref="subscriptionexfields"/> </xsd:extension> </xsd:complexcontent> <xsd:complextype name="domainregsubscriptionex"> <xsd:complexcontent> <xsd:extension base="domainregsubscription"> <xsd:group ref="subscriptionexfields"/> </xsd:extension> </xsd:complexcontent>  <xsd:complextype name="resourcesubscriptionex"> <xsd:complexcontent> <xsd:extension base="resourcesubscription"> <xsd:group ref="subscriptionexfields"/> </xsd:extension> </xsd:complexcontent> <xsd:complextype name="subscriptionsex"> <xsd:choice maxoccurs="unbounded"> <xsd:element name="hostingsubscription" type="hostingsubscriptionex"/> <xsd:element name="domainregsubscription" type="domainregsubscriptionex"/>  <xsd:element name="resourcesubscription" type="resourcesubscriptionex"/> </xsd:choice> Element/Attribute Default Value Available Description hostingsubscription * 2.9 Hosting subscription domainregsubscription * 2.9 Domain registration subscription resourcesubscription * 2.9 Reserved and not currently used 50

51 'SubscriptionExFields' Data Type This type contains billing-related Subscription fields. XML schema: <xsd:group name="subscriptionexfields"> <xsd:element name="subscriptionperiod" type="timeperiod" minoccurs="0" /> <xsd:element name="billingperiod" type="timeperiod" minoccurs="0" /> <xsd:element name="subscrfee" type="xsd:decimal" default="0" minoccurs="0"/> <xsd:element name="renewal" type="xsd:decimal" default="0" minoccurs="0"/> <xsd:element name="transferfee" type="xsd:decimal" default="0" minoccurs="0"/> <xsd:element name="nonrefundableamt" type="xsd:decimal" default="0" minoccurs="0"/> <xsd:element name="refundperiod" type="xsd:integer" default="0" minoccurs="0"/> <xsd:element name="setupfee" type="xsd:decimal" default="0" minoccurs="0"/> <xsd:element name="billday" type="xsd:integer" minoccurs="0"/> <xsd:element name="nextbilldate" type="xsd:date" minoccurs="0"/> <xsd:element name="lastbilldate" type="xsd:date" minoccurs="0"/> </xsd:group> Element/Attribute Default Value Available Description subscriptionperiod * 2.9 Subscription period billingperiod * 2.9 Billing period subscrfee * 2.9 Subscription fee renewal * 2.9 Renewal fee transferfee * 2.9 Transfer fee nonrefundableamt * 2.9 Non-refundable amount refundperiod * 2.9 Refund period setupfee * 2.9 Setup fee billday * 2.9 Ignored. Left for backward compatibility. nextbilldate * 2.9 Next bill date lastbilldate * 2.9 Last bill date 51

52 Services XML Root Element and XML Namespaces The table below contains the target namespace and namespaces required for XML parser to validate XML document (see the XML sample below). Namespace xmlns:services= xmlns:xsi= xsi:schemalocation= Services.xsd XML schema below defines element response as the root element of XML document. <?xml version= 1.0 encoding= UTF-8?> <xsd:schema xmlns:xsd=" xmlns=" targetnamespace= " elementformdefault="qualified" attributeformdefault="unqualified"> 52 XML schema: <xsd:element name="response"> <xsd:complextype>  <xsd:element name="services" type="services" minoccurs="0"/> <xsd:complextype name= Services > <xsd:element name= users type= ServiceUsers minoccurs= 0 />  <xsd:element name= parking type= Parking minoccurs= 0 /> <xsd:element name= apache type= Apache minoccurs= 0 maxoccurs= unbounded /> <xsd:element name= iis type= IIS minoccurs= 0 maxoccurs= unbounded />  <xsd:element name= qmail type= QMail minoccurs= 0 /> <xsd:element name= exchange type= Exchange minoccurs= 0 /> <xsd:element name= databases type= Databases minoccurs= 0 /> <xsd:element name= dns type= DNS minoccurs= 0 /> Example:

53 <?xml version= 1.0 encoding= UTF-8?> <services:response xmlns= xmlns:xsi= xsi:schemalocation= Services.xsd > <services> <users> </users> <iis> </iis> </services> </services:response> 53

54 Customer Services on Subdomains This section depicts the migration details on the customer services on subdomains. <xsd:complextype name="servicedomain" abstract="true"> <xsd:element name="name" type="xsd:token"/> <xsd:attribute name="parent" type="xsd:token" use="optional" default=""/> <xsd:attribute name="enabled" type="xsd:boolean" use="optional" default="true"/> Element/Attribute Default Available Description Value name Domain or subdomain * Parent domain name. XML schema: Required only if a customer service should be provided on subdomain. From DNS point of view, it means that the service-specific DNS records should be created within the domain zone. New DNS zone will be created if a parent is missing or * true Indicates if a domain hosting should be in the active or inactive state. See also the DNS section. RESTRICTION: It is not applicable for subdomains (for example, when attribute is defined). In the Example 1, a customer service (for example, IIS, Apache or Qmail) will be created for the parked.mydomain.com subdomain. In the Example 2, a customer service will be provided for the hosting.mydomain.com 3rd level domain. The Example 3 - are invalid because the mail.mydomain.com subdomain can be created in the DNS zone of the mydomain.org domain. 54 <domain parent="mydomain.com"> <name>parked.mydomain.com</name> </domain> <domain> <name>hosting.mydomain.com</name> </domain> <domain parent="mydomain.org"> <name>mail.mydomain.com</name> Example 1: Example 2: Example 3:

55 </domain> 55

56 Hosted Service Users Generic Structure This section describes the structures and recommendations for Hosted Service Users migration. For more information about Hosted Service Users refer to [1] and [2]. The XML schema below declares container users with the ServiceUsers type: XML schema: <xsd:complextype name="serviceusers"> <xsd:element name="domains" minoccurs="0"> <xsd:complextype> <xsd:element name="domain" type="hsudomain" maxoccurs="unbounded"/> <xsd:element name="user" type="serviceuser" maxoccurs="unbounded"/> For declaring concrete Hosted Service User attributes (for example, logon information, contacts) the following XML schema should be used: <xsd:complextype name="serviceuser"> <xsd:element name="login" type="serviceuserlogin"/> <xsd:element name="password" type="password" minoccurs="0"> <xsd:simpletype> <xsd:restriction base="xsd:string"> <xsd:maxlength value="128"/> </xsd:restriction> </xsd:simpletype> <xsd:element name="displayname"> <xsd:simpletype> <xsd:restriction base="xsd:string"> <xsd:maxlength value="256"/> </xsd:restriction> </xsd:simpletype> <xsd:element name="contactinfo" type="contactinformation" minoccurs="0"/> <xsd:attribute name="disabled" type="xsd:boolean" use="optional" default="false"/> <xsd:simpletype name="serviceuserlogin"> <xsd:restriction base="xsd:string"> <xsd:maxlength value="256"/> <xsd:pattern </xsd:restriction> </xsd:simpletype> XML schema: 56

57 Element/Attribute Default Value Available Description login Logon credentials. password * generated if not specified Note: It is strongly recommended to define the login for a newly created Hosted Service User in the following form: <prefix>@<domain.name> Refer to [1], [2] and see the example below. displayname Defines the string value that will be used as a userfriendly name for a newly created Hosted Service User entity. contactinfo Complex structure for defining a contact information. For details, refer to the Contact Information Structure section (on page * false Indicates that the entity will be or will not be in the active state. If it true - it means that all services associated with a given Hosted Service User will be turned off. Refer to [1] and [2] details. <users> <user> <login>[email protected]</login> <password>jz231</password> <displayname>john Smith</displayName> </user> </users> Contact Information Structure <xsd:complextype name="contactinformation"> <xsd:element name="city" minoccurs="0"> <xsd:simpletype> <xsd:restriction base="xsd:normalizedstring"> <xsd:maxlength value="256"/> </xsd:restriction> </xsd:simpletype> <xsd:element name="country" minoccurs="0"> <xsd:simpletype> <xsd:restriction base="xsd:normalizedstring"> <xsd:maxlength value="128"/> </xsd:restriction> </xsd:simpletype> <xsd:element name="countryabbr" minoccurs="0"> <xsd:simpletype> <xsd:restriction base="xsd:token"> <xsd:maxlength value="4"/> </xsd:restriction> </xsd:simpletype> Example: XML schema: 57

58 58 <xsd:element name="state" minoccurs="0"> <xsd:simpletype> <xsd:restriction base="xsd:normalizedstring"> <xsd:maxlength value="128"/> </xsd:restriction> </xsd:simpletype> <xsd:element name="street" minoccurs="0"> <xsd:simpletype> <xsd:restriction base="xsd:string"> <xsd:maxlength value="128"/> </xsd:restriction> </xsd:simpletype> <xsd:element name="zipcode" minoccurs="0"> <xsd:simpletype> <xsd:restriction base="xsd:token"> <xsd:maxlength value="12"/> </xsd:restriction> </xsd:simpletype> <xsd:element name="description" minoccurs="0"> <xsd:simpletype> <xsd:restriction base="xsd:string"> <xsd:maxlength value="1024"/> </xsd:restriction> </xsd:simpletype> <xsd:element name="firstname" minoccurs="0"> <xsd:simpletype> <xsd:restriction base="xsd:normalizedstring"> <xsd:maxlength value="1024"/> </xsd:restriction> </xsd:simpletype> <xsd:element name="lastname" minoccurs="0"> <xsd:simpletype> <xsd:restriction base="xsd:normalizedstring"> <xsd:maxlength value="1024"/> </xsd:restriction> </xsd:simpletype> <xsd:element name="initials" minoccurs="0"> <xsd:simpletype> <xsd:restriction base="xsd:normalizedstring"> <xsd:maxlength value="6"/> </xsd:restriction> </xsd:simpletype> <xsd:element name="title" minoccurs="0"> <xsd:simpletype> <xsd:restriction base="xsd:normalizedstring"> <xsd:maxlength value="256"/> </xsd:restriction> </xsd:simpletype> <xsd:element name="pobox" minoccurs="0"> <xsd:simpletype> <xsd:restriction base="xsd:string"> <xsd:maxlength value="256"/> </xsd:restriction>

59 </xsd:simpletype> <xsd:element name="office" minoccurs="0"> <xsd:simpletype> <xsd:restriction base="xsd:string"> <xsd:maxlength value="1024"/> </xsd:restriction> </xsd:simpletype> <xsd:element name="phone" type="phonestring" minoccurs="0"/> <xsd:element name="fax" type="phonestring" minoccurs="0"/> <xsd:element name="ipphone" type="phonestring" minoccurs="0"/> <xsd:element name="mobile" type="phonestring" minoccurs="0"/> <xsd:element name="pager" type="phonestring" minoccurs="0"/> <xsd:element name="homephone" type="phonestring" minoccurs="0"/> <xsd:element name="department" minoccurs="0"> <xsd:simpletype> <xsd:restriction base="xsd:normalizedstring"> <xsd:maxlength value="256"/> </xsd:restriction> </xsd:simpletype> <xsd:element name="company" minoccurs="0"> <xsd:simpletype> <xsd:restriction base="xsd:normalizedstring"> <xsd:maxlength value="512"/> </xsd:restriction> </xsd:simpletype> <xsd:element name="notes" minoccurs="0"> <xsd:simpletype> <xsd:restriction base="xsd:string"> <xsd:maxlength value="4000"/> </xsd:restriction> </xsd:simpletype> <xsd:element name="webpage" minoccurs="0"> <xsd:simpletype> <xsd:restriction base="xsd:anyuri"> <xsd:maxlength value="4000"/> </xsd:restriction> </xsd:simpletype> <xsd:element name=" " type=" string" minoccurs="0"/> <xsd:element name="contact " type=" string" minoccurs="0"/> <xsd:simpletype name="phonestring"> <xsd:restriction base="xsd:string"> <xsd:maxlength value="132"/> <xsd:pattern value="[0-9]{1,3}#[0-9]{0,32}#[0-9]{1,32}#[0-9]{0,32}"/> </xsd:restriction> </xsd:simpletype> 59

60 Element/Attribute Default Value Available Description city * Defines the city property in the contacts. country * Defines the country property in the contacts. countryabbr * Defines the country abbreviation in the contacts. 60 RESTRICTION: Maximum 4 letters. state * Defines the state property in the contacts. street * Defines the street property in the contacts. zipcode * Defines the zip code property in the contacts. description * Defines the description in the contacts. RESTRICTION: Maximum 1024 symbols. firstname * Defines the first name property in the contacts. lastname * Defines the last name property in the contacts. initials * Defines the initials property in the contacts. title * Defines the title property in the contacts. pobox * Defines the post office box (P.O.Box) property in the contacts. office * Defines the office property in the contacts. phone * Defines the phone property in the contacts. Note: All phone numbers are represented in the following form: [<country code>] #[<area code>] #<number>#[<ext>] fax * Defines the fax property in the contacts. ipphone * Defines the IP Phone number property in the contacts. mobile * Defines the mobile phone number property in the contacts. pager * Defines the pager number property in the contacts. homephone * Defines the home phone property in the contacts. department * Defines the department property in the contacts. company * Defines the company name property in the contacts. notes * Defines the notes property in the contacts. RESTRICTION: Maximum 4000 symbols. webpage * Defines the Web page URL property in the contacts.

61 Element/Attribute Default Value Available Description * 2.8 Defines the property in the contacts. contact * 2.9 Defines the Contact property in the contacts. Complete Sample <users> <user> <login>[email protected]</login> <displayname>john Smith</displayName> <contactinfo> <city>new York</city> <country>usa</country> <countryabbr>us</countryabbr> <firstname>john</firstname> <lastname>smith</lastname> <mobile>1#721# #</mobile> <company>myhosting, Inc.</company> </contactinfo> </user> </users> 61

62 Domain Parking <xsd:complextype name="parking"> <xsd:element name="domain" minoccurs="1" maxoccurs="unbounded"> <xsd:complextype> <xsd:complexcontent> <xsd:extension base="servicedomain"> <xsd:choice minoccurs="0"> <xsd:element name="singlepage" type="xsd:base64binary"/> <xsd:element name="stdforwarding" type="xsd:normalizedstring"/> <xsd:element name="frameforwarding" type="xsd:normalizedstring"/> </xsd:choice> </xsd:extension> </xsd:complexcontent> Element/Attribute Default Available Description Value XML schema: domain Defines configuration for a parked domain. 62 name Domain/subdomain name. See the Customer Services on Subdomains section. singlepage * Base64-encoded content of page for single page parking. See [2]. stdforwarding * Standard forwarding mode. All HTTP requests will be redirected to URL specified in the element s body. frameforwarding * Frame forwarding mode. All HTTP requests will be redirected to URL specified in the element s body. If no one of the singlepage, stdforwarding and frameforwarding elements is specified, a domain parking will be provided according to the default configuration in vendor s Service Template. See [1] and [2]. <parking> <domain> <name>mydomain.com</name> <stdforwarding> </domain> Example:

63 </parking> 63

64 Microsoft IIS Webspace Structure <xsd:complextype name= IIS > <xsd:element name= domains minoccurs= 0 > <xsd:complextype> <xsd:element name= domain type= IISDomain maxoccurs= unbounded />  <xsd:group ref= IISGlobalSettings /> <xsd:group ref= ContentID /> <xsd:attribute name= useexclusiveapppool type= xsd:boolean use= optional default= false /> <xsd:attribute name="webspaceid" type="xsd:token" use="optional"/> Element/Attribute Default Value Available Description XML schema: domains * List of IIS * false Creates an exclusive or using a shared application pool for IIS web services during * IIS webspace identifier. Used for DSN configuring. See the DSN Migration Support section. The example below shows the simplest way to provide a webspace with instance access URL on the exclusive application pool. 64 <iis useexclusiveapppool= true > </iis> <xsd:group name= IISGlobalSettings > <xsd:element name= features type= IISFeatures minoccurs= 0 /> <xsd:element name= tunings type= IISPerformanceTunings minoccurs= 0 /> <xsd:element name= contentmanagement type= IISContentManagement minoccurs= 0 /> <xsd:element name= DefaultDocuments minoccurs= 0 > <xsd:complextype> <xsd:element name= document type= xsd:token maxoccurs= unbounded /> Example: XML schema:

65 <xsd:element name= ErrorHandlers minoccurs= 0 > <xsd:complextype> <xsd:element name= handler type= IISErrorHandler maxoccurs= unbounded /> <xsd:element name= MIMEAssociations minoccurs= 0 > <xsd:complextype> <xsd:element name= mime type= IISMIMEAssociation maxoccurs= unbounded /> </xsd:group> <xsd:complextype name= IISPerformanceTunings > <xsd:all> <xsd:element name= maxconnections type= xsd:unsignedlong minoccurs= 0 /> <xsd:element name= maxbandwidth type= xsd:unsignedlong minoccurs= 0 /> <xsd:element name= connectiontimeout type= xsd:unsignedlong minoccurs= 0 /> <xsd:element name= connectionkeepalive type= xsd:boolean minoccurs= false /> </xsd:all> <xsd:complextype name= IISErrorHandler > <xsd:element name= code type= xsd:unsignedshort /> <xsd:element name= subcode type= xsd:unsignedshort /> <xsd:element name= location type= xsd:normalizedstring /> <xsd:attribute name= type use= required > <xsd:simpletype> <xsd:restriction base= xsd:token > <xsd:enumeration value= default /> <xsd:enumeration value= file /> </xsd:restriction> </xsd:simpletype> </xsd:attribute> <xsd:complextype name= IISMIMEAssociation > <xsd:element name= extension type= xsd:token /> <xsd:element name= type type= xsd:token /> 65

66 Element/Attribute Default Value Available Description features * Special features (extensions) that will be turned on for the entire webspace (like PHP extension, SSI or Perl). tunings * Global parameters that affect the performance. maxconnections * use global value maxbandwidth * use global value connectiontimeout * use global value Maximum amount of simultaneous connections to IIS web service Maximum bandwidth Connection timeout. connectionkeepalive * false Turns on the keep alive option. contentmanagement * Defines the ways for content management (FTP access, online FileManager, FrontPage extension parameters). DefaultDocuments * Overrides the list of default documents and processing orders. document Default document name (for example, Default.htm or index.html). ErrorHandlers * Configures error handlers. handler Error handler configuration. code Error code. subcode Error sub code. location Relative location of a custom error page. IGNORED for the default Type of error handler: default or file (see the location element). MIMEAssociations * Custom MIME types. extension Custom extension (w/o leading dots). 66 type MIME type. <xsd:complextype name= IISFeatures > <xsd:all>  <xsd:element name= ASP type= xsd:boolean minoccurs= 0 /> <xsd:element name= ASP.NET type= xsd:boolean minoccurs= 0 /> <xsd:element name= ASP.NET2 type= xsd:boolean minoccurs= 0 /> <xsd:element name= SSI type= xsd:boolean minoccurs= 0 /> XML schema:

67 <xsd:element name= PHP type= xsd:boolean minoccurs= 0 /> <xsd:element name= Perl type= xsd:boolean minoccurs= 0 /> <xsd:element name= ColdFusion minoccurs= 0 > <xsd:complextype> <xsd:simplecontent> <xsd:extension base= xsd:boolean > <xsd:attribute name= version > <xsd:simpletype> <xsd:restriction base= xsd:unsignedshort > <xsd:enumeration value= 6 /> <xsd:enumeration value= 7 /> </xsd:restriction> </xsd:simpletype> </xsd:attribute> </xsd:extension> </xsd:simplecontent> <xsd:element name= ISAPIRewrite type= xsd:boolean minoccurs= 0 /> </xsd:all> Element/Attribute Default Value Available Description ASP * false Enables ASP extension. ASP.NET * false Enables ASP.NET extension. ASP.NET2 * false Enables ASP.NET2 extension. SSI * false Enables SSI extension. PHP * false Enables PHP5 module. Perl * false Enables ActivePerl module. ColdFusion * disabled Enables ColdFusion Activates CF version 6 or version 7 module ISAPIRewrite * false Enables ISAPI Rewrite extension. The sample below demonstrates the way for configuring a webspace on the shared application pool with activated ASP and ISAPIRewrite extensions. <iis> <features> <ASP>true</ASP> <ISAPIRewrite>true</ISAPIRewrite> </features> </iis> Example: 67

68 Content Management <xsd:complextype name="iiscontentmanagement"> <xsd:all> <xsd:element name="frontpage" type="iisfrontpage" minoccurs="0"/> <xsd:element name="ftp" type="iisftp" minoccurs="0"/> <xsd:element name="filemanager" type="iisfilemanager" minoccurs="0"/> </xsd:all> <xsd:complextype name="iisfilemanager"> <xsd:element name="onwebspace" minoccurs="0"> <xsd:complextype> <xsd:element name="password" type="xsd:normalizedstring" minoccurs="0"/> <xsd:element name="users" minoccurs="0"> <xsd:complextype> <xsd:element name="user" maxoccurs="unbounded"> <xsd:complextype> <xsd:element name="domains" type="domainlist"/> <xsd:attribute name="login" type="serviceuserlogin" use="required"/> <xsd:complextype name="iisftp"> <xsd:element name="onwebspace" minoccurs="0"> <xsd:complextype> <xsd:element name="password" type="xsd:normalizedstring" minoccurs="0"/> <xsd:element name="users" minoccurs="0"> <xsd:complextype> <xsd:element name="user" maxoccurs="unbounded"> <xsd:complextype> <xsd:element name="domains" type="domainlist"/> <xsd:attribute name="login" type="serviceuserlogin" use="required"/> 68 XML schema:

69 <xsd:complextype name="iisfrontpage"> <xsd:choice> <xsd:element name="onwebspace" minoccurs="0"> <xsd:complextype> <xsd:element name="password" type="xsd:normalizedstring" minoccurs="0"/> <xsd:attribute name="isauthoringenabled" type="xsd:boolean" use="optional" default="false"/> <xsd:element name="users" minoccurs="0"> <xsd:complextype> <xsd:element name="user" maxoccurs="unbounded"> <xsd:complextype> <xsd:element name="domains"> <xsd:complextype> <xsd:element name="domain"> <xsd:complextype> <xsd:simplecontent> <xsd:extension base="domainname"> <xsd:attribute name="isauthoringenabled" type="xsd:boolean" use="optional" default="false"/> </xsd:extension> </xsd:simplecontent> <xsd:attribute name="login" type="serviceuserlogin" use="required"/> </xsd:choice> <xsd:simpletype name="domainname"> <xsd:restriction base="xsd:token"> <xsd:pattern value=".+"/> </xsd:restriction> </xsd:simpletype> <xsd:complextype name="domainlist"> <xsd:element name="domain" type="domainname" maxoccurs="unbounded"/> 69

70 Element/ Attribute 70 Default Value Available Description frontpage * disabled FrontPage extension. Note: FrontPage extension can t be activated both for the entire webspace and for a website(s). See [1] and [2]. onwebspace * disabled 2.9 FrontPage on extension on the whole webspace password * generate if not specified 2.9 Password for FrontPage access. Note: Login is created during provisioning and can t be * false 2.9 If true then the authoring option turns on. users * 2.9 FrontPage extension for HSU, on site level. user 2.9 FrontPage configuration for the single user. login 2.9 HSU login to configure FrontPage for. domains 2.9 List of domains to enable FrontPage for a current user. - domain 2.9 Domain name. Site on this domain will be managed by FrontPage. d * false 2.9 If true then the authoring option turns on. ftp * disabled FTP access configuration. onwebspace * disabled 2.9 FTP access on entire webspace. password * generate if not specified 2.9 Password for FTP access. Note: Login is created during provisioning and can t be changed. users * 2.9 Enable FTP access for specific HSU user 2.9 FTP configuration for single user. login 2.9 HSU login to configure FTP for. domains 2.9 List of domains to enable FTP for a current user. - domain 2.9 Domain name. FTP access for a website on this domain will be enabled for a current service user. filemanager * disabled File Manager access configuration. onwebspace * disabled 2.9 File manager access on the entire webspace.

71 Element/ Attribute Default Value password * generate if not specified Available Description 2.9 Password for File Manager access. Note: Login is created during provisioning and can t be changed. users * 2.9 Enable File Manager access for specific HSU user 2.9 Describes File Manager configuration for a single user. login 2.9 HSU login to configure File Manager for. domains 2.9 List of domains to enable File Manager for a current user. - domain 2.9 Domain name. File Manager access for a website on this domain will be enabled for a current service user. 71

72 Website Structure The following structure is used for configuring a website on some customer s domain. <xsd:complextype name="iisdomain"> <xsd:complexcontent> <xsd:extension base="servicedomain"> <xsd:element name="website" type="iiswebsite" minoccurs="0"/> <xsd:attributegroup ref="iisdomainipattr"/> </xsd:extension> </xsd:complexcontent> <xsd:attributegroup name="iisdomainipattr"> <xsd:attribute name="onexclusiveip" type="xsd:boolean" use="optional" default="false"/> <xsd:attribute name="ipassigmentpolicy" use="optional" default="new"> <xsd:simpletype> <xsd:restriction base="xsd:token"> <xsd:enumeration value="share"/> <xsd:enumeration value="new"/> </xsd:restriction> </xsd:simpletype> </xsd:attribute> </xsd:attributegroup> Element/Attribute Default Available Description Value name Domain/subdomain name. XML schema: See the Customer Services on Subdomains section. website * Configures website settings on the * false Indicates that domain should be provisioned on the exclusive IP * new Possible values are: new or share. Defines either a new exclusive IP address is to be acquired from the IP pool or an exclusive IP address should be shared between several websites within a single webspace. If the attribute is set to share, Migration Manager will look for already acquired IP address and assign it to a website. If the attribute is set to new, Migration Manager will try to allocate new IP address (even if another IP address was already allocated for a webspace). The attribute will be ignored if attribute is not true. 72

73 The example below shows how the mydomain.com and sub1.mydomain.com domains should be attached to a webspace. <iis> <domains> <domain> <name>mydomain.com</name> </domain> <domain onexclusiveip= true IPAssigmentPolicy = share parent= mydomain.com > <name>sub1.mydomain.com</name> </domain> </domains> </iis> Configuring IIS Website <xsd:complextype name= IISWebSite > <xsd:element name= rootdirectorypath type= xsd:normalizedstring minoccurs= 0 /> <xsd:group ref= ContentID /> <xsd:element name= permissions type= IISVirtualDirectoryPerm minoccurs= 0 /> <xsd:element name= auth type= IISVirtualDirectoryAuth minoccurs= 0 /> <xsd:element name= virtualdirectories minoccurs= 0 > <xsd:complextype> <xsd:element name= virtualdirectory type= IISVirtualDirectory maxoccurs= unbounded /> <xsd:element name="usersservices" minoccurs="0"> <xsd:complextype> <xsd:element name="userservices" type="iisuserservices" maxoccurs="unbounded"/> <xsd:element name="scriptsextensions" type="iiscustomscriptsextensions" minoccurs="0"/> Example: XML schema: <xsd:complextype name="iiscustomscriptsextensions"> <xsd:element name="mapping" maxoccurs="unbounded"> <xsd:complextype> <xsd:element name="ext"> <xsd:simpletype> <xsd:restriction base="xsd:token"> <xsd:maxlength value="16"/> <xsd:pattern value="[\p{l}\p{n}]+"/> </xsd:restriction> </xsd:simpletype> 73

74 <xsd:element name="engine" type="iismappingengine"/> <xsd:simpletype name="iismappingengine"> <xsd:restriction base="xsd:token"> <xsd:enumeration value="asp"/> <xsd:enumeration value="asp.net"/> <xsd:enumeration value="asp.net2"/> <xsd:enumeration value="perl"/> <xsd:enumeration value="php"/> <xsd:enumeration value="ssi"/> </xsd:restriction> </xsd:simpletype> <xsd:complextype name= IISVirtualDirectoryPerm > <xsd:all> <xsd:element name= sourceaccess type= xsd:boolean minoccurs= 0 default= false /> <xsd:element name= read type= xsd:boolean minoccurs= 0 default= true /> <xsd:element name= write type= xsd:boolean minoccurs= 0 default= false /> <xsd:element name= browse type= xsd:boolean minoccurs= 0 default= false /> <xsd:element name= execution minoccurs= 0 default= ScriptsOnly > <xsd:simpletype> <xsd:restriction base= xsd:normalizedstring > <xsd:enumeration value= None /> <xsd:enumeration value= ScriptsOnly /> <xsd:enumeration value= ScriptsAndExec /> </xsd:restriction> </xsd:simpletype> </xsd:all> <xsd:complextype name= IISVirtualDirectoryAuth > <xsd:all> <xsd:element name= anonymous type= xsd:boolean minoccurs= 0 default= true /> <xsd:element name= digest type= xsd:boolean minoccurs= 0 default= false /> <xsd:element name= basic type= xsd:boolean minoccurs= 0 default= true /> <xsd:element name= windows type= xsd:boolean minoccurs= 0 default= false /> </xsd:all> Element/ Default Value Available Description Attribute 74

75 Element/ Attribute Default Value Available Description rootdirectorypath * Path up to the root of a website (relative to the entire webspace). If missing, the domain name (or sub domain name) will be used. permissions * Defines access permissions to the websites root. See [2]. sourceaccess * false Allows access to the source code. read * true Allows read permission. write * false Allows write permission. browse * false Allows browse permission. execution * ScriptsOnly Possible values: None ScriptsOnly ScriptsAndExec auth * Defines user authorization methods. See [1] and [2]. anonymous * true Allows anonymous access. digest * false Allows digest auth. basic * true Allows basic auth. windows * false Allows native auth. virtualdirectories * Configures virtual directories. scriptsextensions * Defines custom application extensions. mapping Maps extension to an application. Note: Mapping won t be applied (skipped) if the extension can not be remapped (forbidden by provider), if extensions customizations are not allowed (by the provide) for a certain application. ext Custom extension without leading dot. 75

76 Element/ Attribute Default Value Available Description engine Possible applications: ASP ASP.NET ASP.NET2 Perl PHP SSI SWRewrite The example below configures a website on the mydomain.org domain. The FrontPage access and FTP access to the website will be activated for the [email protected] service user. 76 <iis> <domains> <domain> <name>mydomain.org</name> <website> <permissions> <browse>true</browse> </permissions> <usersservices> <userservices> <login>[email protected]</login> <frontpage isauthoringenabled= false /> <ftp/> </userservices> </usersservices> <scriptsextensions> <mapping> <ext>ph</ext> <engine>php</engine> </mapping> </scriptsextensions> </website> </domain> </domains> </iis> Virtual Directories <xsd:complextype name= IISVirtualDirectory > <xsd:element name= name type= xsd:token /> <xsd:element name= description type= xsd:string minoccurs= 0 /> Example: XML schema:

77 <xsd:element name= type > <xsd:complextype> <xsd:choice> <xsd:element name= physical > <xsd:complextype> <xsd:element name= path type= xsd:normalizedstring /> <xsd:group ref= ContentID /> <xsd:element name= permissions type= IISVirtualDirectoryPerm minoccurs= 0 /> <xsd:element name= auth type= IISVirtualDirectoryAuth minoccurs= 0 /> <xsd:element name= redirect > <xsd:complextype> <xsd:element name= url type= xsd:normalizedstring /> <xsd:element name= auth type= IISVirtualDirectoryAuth minoccurs= 0 /> </xsd:choice> Element/Attribute Default Value Available Description name Virtual directory name. description * Some textual description. type Hosting type ( physical or redirect ). physical path Path to the root of a virtual directory (relative to website). permissions * See the Website Structure (on page 72) section. auth * See the Website Structure (on page 72) section. redirect url URL to redirect to. auth * See the Website Structure (on page 72) section. 77

78 Content The Migration Manager supports two methods of IIS websites content migration: 1 All websites are migrated at once within the webspace archives. In this case, the Migration Agent should explicitly define the rootdirectorypath element for all websites. 2 Each website is migrated in a separate archive. Migration Agent is responsible for excluding the following files or/and directories from a tar ball archive: _vti* (all FrontPage directories) Below is the sample of archive with the website content: $ tar -tf content_9776.tar././default.asp./resume.htm./images/./images/logo.jpeg 78

79 Complete Sample <?xml version="1.0" encoding="windows-1252"?> <services:response xmlns:services=" xmlns:xsi=" xsi:schemalocation= " Services.xsd"> <services> <users> <user> <displayname>john Smith</displayName> <contactinfo> <city>new York</city> <country>usa</country> <countryabbr>us</countryabbr> <firstname>john</firstname> <lastname>smith</lastname> <mobile>1#321# #</mobile> <company>myhosting, Inc</company> </contactinfo> </user> </users> <iis useexclusiveapppool="false"> <domains> <domain onexclusiveip="false"> <name>centz-one.com</name> <website> <contentid>centz-one.com:content</contentid> <permissions> <browse>true</browse> </permissions> <virtualdirectories> <virtualdirectory> <name>vd1</name> <description>virtual Directory #1</description> <type> <physical> <path>/dirs/vd1/</path> <permissions> <browse>true</browse> <execution>none</execution> </permissions> </physical> </type> </virtualdirectory> </virtualdirectories> </website> </domain> </domains> <features> <ASP>true</ASP> <ASP.NET2>false</ASP.NET2> <SSI>true</SSI> </features> <tunings> <connectionkeepalive>false</connectionkeepalive> </tunings> <contentmanagement> <filemanager /> 79

80 <ftp> <password>se*6%rt</password> </ftp> </contentmanagement> <DefaultDocuments> <document>index.html</document> <document>default.htm</document> </DefaultDocuments> <MIMEAssociations> <mime> <extension>dxt</extension> <type>text/plain</type> </mime> </MIMEAssociations> </iis> </services> </services:response> 80

81 Microsoft Exchange Some preparation steps are required before migrating the custom data from Hosted Exchange. Refer to the Appendix Preparing for Exchange Migration: Deployment and Configuration. Generic Structure <xsd:complextype name= Exchange > <xsd:element name= domains minoccurs= 0 > <xsd:complextype> <xsd:element name= domain type= Exchange Domain maxoccurs= unbounded /> <xsd:element name= mailboxes minoccurs= 0 > <xsd:complextype> <xsd:element name= mailbox type= Exchang box maxoccurs= unbounded /> <xsd:element name= contacts minoccurs= 0 > <xsd:complextype> <xsd:element name= contact type= ExchangeContact maxoccurs= unbounded /> <xsd:element name= maillists minoccurs= 0 > <xsd:complextype> <xsd:element name= maillist type= Exchang list maxoccurs= unbounded /> <xsd:element name= publicfolders minoccurs= 0 > <xsd:complextype> <xsd:element name= publicfolder type= ExchangePublicFolder minoccurs= 0 maxoccurs= unbounded /> <xsd:element name= mailenabledpublicfolder type= Exchang EnabledPublicFolder minoccurs= 0 maxoccurs= unbounded /> XML schema: 81

82 Element/Attribute Default Value Available Description domains * List of mail-enabled domains. mailboxes * List of Microsoft Exchange mailboxes. contacts * List of Microsoft Exchange contacts. maillists * List of Microsoft Exchange distribution lists. publicfolders * List of Microsoft Exchange public folders. Registering Mail-Enabled Domains <xsd:complextype name= Exchange Domain > <xsd:complexcontent> <xsd:extension base= ServiceDomain >  <xsd:element name= enabled type= xsd:boolean default= true minoccurs= 0 /> </xsd:extension> </xsd:complexcontent> Element/Attribute Default Value Available Description XML schema: name Name of domain/sub domain to be registered in Microsoft Exchange. For details, see the Customer Services on Subdomains section (on page 54). The XML sample below configures Microsoft Exchange hosting for 2 domains: domain1.com and domain2.com and for the mymail.domain3.com subdomain. <exchange> <domains> <domain> <name>domain1.com</name> </domain> <domain enabled= false > <name>domain2.com</name> </domain> <domain parent= mydomain3.com > <name>mymail.domain3.com</name> </domain> </domains> </exchange> Example: 82

83 Microsoft Exchange Mailbox Configuration XML schema: <xsd:complextype name= Exchang box > <xsd:element name= alias type= ExchangeAliasShort /> <xsd:element name= quota type= xsd:unsignedlong /> <xsd:element name="serviceuserlogin" type="serviceuserlogin"/> <xsd:element name="windowslogin" minoccurs="0"> <xsd:simpletype> <xsd:restriction base="xsd:normalizedstring"> <xsd:maxlength value="64"/> <xsd:pattern value="[^/\\\[\]:;\ \. ]+"/> </xsd:restriction> </xsd:simpletype> <xsd:element name= localeid type= xsd:unsignedshort minoccurs= 0 /> <xsd:element name= protocols type= ExchangeProtocolSettings minoccurs= 0 /> <xsd:element name= limits type= ExchangeMaiboxLimits minoccurs= 0 /> <xsd:element name= addresses type= Exchange sList /> <xsd:element name= forwarding type= ExchangeForwarding minoccurs= 0 /> <xsd:element name= autoresponder type= ExchangeAutoresponder minoccurs= 0 /> <xsd:group ref= ContentID /> <xsd:attributegroup ref= Exchang EntityAttrs /> <xsd:attributegroup name= Exchang EntityAttrs > <xsd:attribute name= distinguishedname type= xsd:normalizedstring use= required /> <xsd:attribute name= showinaddressbook type= xsd:boolean use= required /> <xsd:attribute name= enabled type= xsd:boolean use= optional default= true /> </xsd:attributegroup> <xsd:simpletype name="serviceuserlogin"> <xsd:restriction base="xsd:normalizedstring"> <xsd:maxlength value="256"/> <xsd:pattern value="\c+@\c+"/> </xsd:restriction> </xsd:simpletype> Element/Attribute Default Value Available Description 83

84 Element/Attribute Default Value Available Description alias Mailbox alias: should be unique within the Hosted Exchange Subscription. Restriction: Matches to pattern: [a-za-z0-9\s_\.]+ Maximum 64 symbols. quota Maximal mailbox size in KB. windowslogin 2.9 System account name of a mailbox owner. serviceuserlogin 2.9 Service user login of mailbox owner. localeid * An identifier of the locale to be used for creating initial structure of mailbox folders. This parameter will be used for mailbox content migration by the Microsoft ExMerge tool. protocols * (all protocols are in disable state by default) The complete list of locate IDs can be found at Configuration of Microsoft Exchange protocols. limits * Configuration of mailbox limits. addresses Primary s address and aliases. forwarding * Enables forwarding for incoming messages. autoresponder * Not supported yet. Note: Only one address can be Mailbox identifier: should be unique within XML document (transient attribute). Used for referencing to a mailbox from distribution lists and mail-enabled public Shows/hides a mailbox in the Outlook s address * true Enables/disables a mailbox. Configuring Microsoft Exchange Protocols on the Exchange Mailbox 84 <xsd:complextype name= ExchangeProtocolSettings > <xsd:all>  <xsd:element name= pop3 type= xsd:boolean minoccurs= 0 /> XML schema:

85 <xsd:element name= imap4 type= xsd:boolean minoccurs= 0 /> <xsd:element name= owa type= xsd:boolean minoccurs= 0 /> <xsd:element name= mapi type= xsd:boolean minoccurs= 0 /> <xsd:element name= activesync type= xsd:boolean minoccurs= 0 /> </xsd:all> Element/Attribute Default Value Available Description pop3 * false Enables/disables POP3 access to a mailbox. imap4 * false Enables/disables IMAP4 access to a mailbox. owa * false Enables/disables Outlook Web Access. mapi * false Enables/disables Messaging Application Programming Interface (the heart of Microsoft s messaging programs). activesync * false Enables/disables synchronization with Microsoft for Windows Mobile program and other Windows CEbased devices. Defining Exchange Mailbox Limits <xsd:complextype name= ExchangeMaiboxLimits > <xsd:all> <xsd:element name= sendlimit type= xsd:unsignedlong minoccurs= 0 /> <xsd:element name= warninglimit type= xsd:unsignedlong minoccurs= 0 /> <xsd:element name= maxincomingitemsize type= xsd:unsignedlong minoccurs= 0 /> <xsd:element name= maxoutgoingitemsize type= xsd:unsignedlong minoccurs= 0 /> <xsd:element name= maxrecipientsnumber type= xsd:unsignedlong minoccurs= 0 /> <xsd:element name= messageretentionperiod type= xsd:unsignedlong minoccurs= 0 /> </xsd:all> Element/Attribute Default Available Value Description XML schema: sendlimit * Prohibits to send new messages, if the current mailbox size is more than sendlimit value (in KB). warninglimit * Warns when the current mailbox size is bigger than the warninglimit value (in KB). maxincomingitemsize * Maximum size of incoming message (in KB). maxoutgoingitemsize * Maximum size of outgoing message (in KB). 85

86 Element/Attribute Default Value Available Description maxrecipientsnumber * Maximum number of recipients. messageretentionperiod * Retention period for deleted messages (measured in days). Exchange Mailbox Addresses <xsd:complextype name= Exchange sList > <xsd:element name= primary address type= String /> <xsd:element name= address type= String minoccurs= 0 maxoccurs= unbounded /> <xsd:simpletype name= String > <xsd:restriction base= xsd:normalizedstring > <xsd:maxlength value= 400 /> <xsd:pattern value= \c+@\c+ /> </xsd:restriction> </xsd:simpletype> Element/Attribute Default Value Available Description XML schema: primary address Primary address. address * aliases. The underlying XML defines the Box1 mailbox with the [email protected] primary e- mail address. The mailbox is hidden (it will not be shown in Outlook s address book). Example: <mailbox showinaddressbook= false distinguishedname= mbox1 > <alias>box1</alias> <quota>5000</quota> <user> <login>[email protected]</login> <password>hjg*&gk_lg</password> <displayname>mail Box 1</displayName> </user> <localeid>1041</localeid>  <protocols> <pop3>true</pop3> <mapi>true</mapi> </protocols> < addresses> <primary address>[email protected] </primary address> </ addresses> </mailbox> 86

87 Configuring Mail Forwarding <xsd:complextype name= ExchangeForwarding > <xsd:element name= forwardto type= ExchangeForwarding maxoccurs= unbounded /> <xsd:attribute name= leavemessagecopy type= xsd:boolean use= optional default= false /> <xsd:complextype name= ExchangeForwarding > <xsd:element name= address type= String /> Element/Attribute Default Value Available Description XML * false Saves copy in a mailbox. forwardto * address (specified by the address element) used for forwarding to. <forwarding leavemessagecopy= false > <forwardto> <address>[email protected]</address> </forwardto> </forwarding> Example: 87

88 Microsoft Exchange Contact Configuration <xsd:complextype name= ExchangeContact > <xsd:element name= alias type= ExchangeAliasLong /> <xsd:element name= target address type= String /> <xsd:element name= displayname minoccurs= 0 > <xsd:simpletype> <xsd:restriction base= xsd:normalizedstring > <xsd:maxlength value= 256 /> </xsd:restriction> </xsd:simpletype> <xsd:element name= contactinfo type= ContactInformation minoccurs= 0 /> <xsd:attributegroup ref= Exchang EntityAttrs /> <xsd:attributegroup name= Exchang EntityAttrs > <xsd:attribute name= distinguishedname type= xsd:normalizedstring use= required /> <xsd:attribute name= showinaddressbook type= xsd:boolean use= required /> <xsd:attribute name= enabled type= xsd:boolean use= optional default= true /> </xsd:attributegroup> Element/Attribute Default Available Description Value XML schema: alias Contact s alias: should be unique within Hosted Exchange Subscription. 88 Restriction: Marches to pattern: [a-za-z0-9\s_\.]+ Maximum 64 symbols. target address address. displayname * Display name of the contact (in the address book). Restriction: Maximum 256 symbols. contactinfo * Contact details. See the Contact Information Structure section (on page 57) for more Contact identifier should be unique within XML document (transient attribute). Used for referencing to a contact from distribution lists and mail-enabled public Shows/hides a contact in the Outlook s address book.

89 Element/Attribute Default Value Available * Ignored for contact. <contact distinguishedname= cn1 showinaddressbook= true > <alias>contact 1</alias> <target address>[email protected] </target address> <displayname>john Smith</displayName> </contact> Example: 89

90 Microsoft Exchange Distribution List Configuration <xsd:complextype name= Exchang list > <xsd:element name= alias type= ExchangeAliasLong /> <xsd:element name= displayname minoccurs= 0 > <xsd:simpletype> <xsd:restriction base= xsd:normalizedstring > <xsd:maxlength value= 256 /> </xsd:restriction> </xsd:simpletype> <xsd:element name= addresses type= Exchange sList /> <xsd:element name= security type= Exchang listSecurity minoccurs= 0 /> <xsd:element name= members minoccurs= 0 > <xsd:complextype> <xsd:element name= member type= Exchang listMember maxoccurs= unbounded /> <xsd:attributegroup ref= Exchang EntityAttrs /> Element/Attribute Default Value Available Description XML schema: alias Alias for a distribution list (mail list): should be unique within Hosted Exchange Subscription. Restriction: Matches to patten: [a-za-z0-9\s_\.]+ Maximum 64 symbols. displayname * Display name of mail list (in the address book). Restriction: Maximum 256 symbols. addresses Primary addresses and aliases (the same as for mailbox). See the Microsoft Exchange Mailbox Configuration (on page 83) section. security * Security configuration. members * List of mail list members. 90

91 Element/Attribute Default Value Available Mail list:identifier should be unique within XML document (transient attribute). Used for referencing to a mail list (distribution list) from another distribution lists and mail-enabled public folders. See sections Microsoft Exchange Distribution List Configuration and Microsoft Exchange Public Folder Shows/hides the list in the Outlook s address * Ignore for mail lists. Configuring Mail List Security <xsd:complextype name= Exchang listSecurity > <xsd:all> <xsd:element name= ismembershipvisible type= xsd:boolean default= true minoccurs= 0 /> <xsd:element name= acceptmailfrom type= ExchangeSenderRestriction default= Everyone minoccurs= 0 /> </xsd:all> <xsd:simpletype name= ExchangeSenderRestriction > <xsd:restriction base= xsd:token > <xsd:enumeration value= Everyone /> <xsd:enumeration value= Organization /> <xsd:enumeration value= Members /> </xsd:restriction> </xsd:simpletype> Element/Attribute Default Available Description Value XML schema: ismembershipvisible * true Shows/hides members of a mail list. acceptmailfrom * Everyone Mail acceptance policy. Restriction: Everyone/Organization/Members Adding New members to a Mail List. <xsd:complextype name= Exchang listMember > <xsd:attribute name= distinguishedname type= xsd:normalizedstring use= required /> XML schema: 91

92 Element/Attribute Default Value Available Member of mail list. <maillists> <maillist showinaddressbook= true distinguishedname= list1 > <alias>distribution List 1</alias> < addresses> </primary address> </ addresses> <security> <acceptmailfrom>members</acceptmailfrom> </security> <members> <member distinguishedname= mbox1 /> <member distinguishedname= cn1 /> </members> </maillist> </maillists> Mail entity identifier (mailbox, mail list, contact or public folder) declared within XML document. Example: 92

93 Microsoft Exchange Public Folder Configuration <xsd:complextype name= ExchangePublicFolder > <xsd:group ref= ExchangePublicFolderBase /> <xsd:group ref= ContentID /> <xsd:attribute name= distinguishedname type= xsd:normalizedstring use= optional /> <xsd:attribute name= enabled type= xsd:boolean use= optional default= true /> <xsd:complextype name= Exchang EnabledPublicFolder > <xsd:group ref= ExchangePublicFolderBase /> <xsd:element name= addresses type= Exchange sList /> <xsd:group ref= ContentID /> <xsd:attributegroup ref= Exchang EntityAttrs /> <xsd:group name= ExchangePublicFolderBase > <xsd:element name= name > <xsd:simpletype> <xsd:restriction base= xsd:normalizedstring > <xsd:maxlength value= 256 /> </xsd:restriction> </xsd:simpletype> <xsd:element name= quota type= xsd:unsignedlong /> <xsd:element name= itemtype type= ExchangePublicFolderItemsType /> <xsd:element name= defaultrole type= ExchangePublicFolderRole default= Reviewer minoccurs= 0 /> <xsd:element name= limits type= ExchangePublicFolderLimits minoccurs= 0 /> <xsd:element name= permissions minoccurs= 0 > <xsd:complextype> <xsd:element name= permission type= ExchangePublicFolderPermission maxoccurs= unbounded /> </xsd:group> <xsd:simpletype name= ExchangePublicFolderItemsType > <xsd:restriction base= xsd:token > <xsd:enumeration value= Mail /> <xsd:enumeration value= Contact /> <xsd:enumeration value= Appointment /> <xsd:enumeration value= Note /> <xsd:enumeration value= Task /> <xsd:enumeration value= Journal /> </xsd:restriction> </xsd:simpletype> XML schema: 93

94 <xsd:simpletype name= ExchangePublicFolderRole > <xsd:restriction base= xsd:token > <xsd:enumeration value= None /> <xsd:enumeration value= Reviewer /> <xsd:enumeration value= Contributor /> <xsd:enumeration value= Non-Editing Author /> <xsd:enumeration value= Author /> <xsd:enumeration value="publishing Author"/ <xsd:enumeration value= Editor /> <xsd:enumeration value="publishing Editor"/> <xsd:enumeration value="owner"/> </xsd:restriction> </xsd:simpletype> Element/Attribute Default Available Description Value name Name of public folder. Restrictions: Maximal length Matches to pattern - see the XML schema above. quota Maximal public folder size in KB. itemtype Type of the stored items in a public folder. Possible values are: Mail/Contact/Appointment/ Note/Task/Journal defaultrole * Reviewer A default role for all mailbox users on the public folder. Possible values are: None/Reviewer/Contributor /Non-Editing Author/Author/Editor limits * Public folder limits. permissions * List of permissions. addresses APPLIED ONLY TO MAIL-ENABLED PUBLIC FOLDERS. Primary addresses and aliases (the same as for mailbox). See the Microsoft Exchange Mailbox Configuration (on page 83) Public folder identifier: should be unique within XML document (transient attribute). Used for referencing to a public folder from distribution lists and other mail-enabled public folders. 94

95 Element/Attribute Default Value Available APPLIED ONLY TO MAIL-ENABLED PUBLIC FOLDERS. Shows/hides a mail-enabled public folder in the Outlook s address * Ignored for public folder. Public Folder Limits <xsd:complextype name= ExchangePublicFolderLimits > <xsd:all> <xsd:element name= maxitemsize type= xsd:unsignedlong minoccurs= 0 /> <xsd:element name= warninglimit type= xsd:unsignedlong minoccurs= 0 /> </xsd:all> Element/Attribute Default Available Description Value XML schema: maxitemsize * Maximal size of the public folder item (in KB). warninglimit * Prohibits to post new items to the folder if the current size is more than the warninglimit level (in KB). Public Folder Access Permissions <xsd:complextype name= ExchangePublicFolderPermission > <xsd:element name= distinguishedname type= xsd:normalizedstring /> <xsd:element name= role type= ExchangePublicFolderRole /> <xsd:simpletype name= ExchangePublicFolderRole > <xsd:restriction base= xsd:token > <xsd:enumeration value= None /> <xsd:enumeration value= Reviewer /> <xsd:enumeration value= Contributor /> <xsd:enumeration value= Non-Editing Author /> <xsd:enumeration value= Author /> <xsd:enumeration value= Editor /> </xsd:restriction> </xsd:simpletype> Element/Attribute Default Available Description Value XML schema: 95

96 Element/Attribute Default Value Available Reference to a public folder consumer. Mail entity identifier (mailbox, mail list, contact or public folder) declared within XML document. role Role of public folder consumer. Possible values are: None/Reviewer/Contributor /Non-Editing Author/Author/Editor <publicfolders> <publicfolder> <name>contactpf</name> <quota>2500</quota> <itemtype>contact</itemtype> <permissions> <permission> <distinguishedname>mbox1</distinguishedname> <role>editor</role> </permission> </permissions> </publicfolder> <publicfolder> <name>journalpf</name> <quota>5000</quota> <itemtype>journal</itemtype> <permissions> <permission> <distinguishedname>mbox1</distinguishedname> <role>none</role> </permission> </permissions> </publicfolder> <mailenabledpublicfolder distinguishedname= pf2 showinaddressbook= true > <name>mailpf</name> <quota>5000</quota> <itemtype>mail</itemtype> <permissions> <permission> <distinguishedname>list1</distinguishedname> <role>contributor</role> </permission> </permissions> < addresses> <primary address>[email protected] </primary address> </ addresses> </mailenabledpublicfolder> </publicfolders> Example: 96

97 DNS Zone Configuration <xsd:complextype name= DNS > <xsd:element name= domain maxoccurs= unbounded > <xsd:complextype> <xsd:complexcontent> <xsd:extension base= ServiceDomain > <xsd:element name= zonemanagementability type= xsd:boolean default= false minoccurs= 0 /> <xsd:element name= owner type= xsd:string minoccurs= 0 /> <xsd:element name= settings type= DNSSettings minoccurs= 0 /> <xsd:element name= records type= DNSRecords minoccurs= 0 /> </xsd:extension> </xsd:complexcontent> <xsd:complextype name= DNSSettings > <xsd:all>  <xsd:element name= expire type= xsd:unsignedlong minoccurs= 0 /> <xsd:element name= minttl type= xsd:unsignedlong minoccurs= 0 /> <xsd:element name= refresh type= xsd:unsignedlong minoccurs= 0 /> <xsd:element name= retry type= xsd:unsignedlong minoccurs= 0 />  <xsd:element name= admin type= xsd:normalizedstring minoccurs= 0 /> </xsd:all> Element/Attribute Default Value Available Description XML schema: domain Domain configuration. name Domain s name. 97

98 Element/Attribute Default Value Available * true Indicates if a corresponding DNS zone should be in active or in inactive state after migration. See also the Customer Services on Subdomains * 2.8 If this attribute is specified, then a domain is considered to be a subdomain of a domain with the name equal to the value of this attribute. Otherwise, a domain is considered not to be a subdomain zonemanagementability * false Allows managing DNS records from CCP. This field is invalid (and is ignored) for subdomains. See [1] and [2] for more details. owner * Setup zone s owner (shown in CCP only). This field is mandatory for domains and is invalid (and is ignored) for subdomains. settings * Zone specific settings. This field is invalid (and is ignored) for sub-domains. expire * used service default value Indicates when the zone data is no longer authoritative. Measured in seconds. minttl * used service default value refresh * used service default value Minimal time-to-alive (TTL). Measured in seconds Indicates the time when the secondary will try to refresh the zone from the master. Measured in seconds. retry * used service default value It defines the time between retries. If the secondary fails to contact the master then refresh has expired. Measured in seconds. 98 admin * address of a person responsible for this zone (stored in DNS zone). records * Custom records. If zonemanagementability is not enabled, custom DNS records will not be created. Note: All custom records will be merged with automatically created ones by DNS records and will stay in the inactive state after provisioning. Example:

99 <dns> <domain> <name>mydomain.com</name> <zonemanagementability>true</zonemanagementability> <settings> <expire> </expire> <minttl>3600</minttl> <refresh>14400</refresh> <retry>20000</retry> </settings> </domain> </dns> 99

100 Records <xsd:complextype name= DNSRecords > <xsd:element name= mx type= DNS_MX minoccurs= 0 maxoccurs= unbounded /> <xsd:element name= ns type= DNS_NS minoccurs= 0 maxoccurs= unbounded /> <xsd:element name= cname type= DNS_CNAME minoccurs= 0 maxoccurs= unbounded /> <xsd:element name= a type= DNS_A minoccurs= 0 maxoccurs= unbounded /> <xsd:complextype name= DNS_MX > <xsd:complexcontent> <xsd:extension base= DNS_COMMON > <xsd:element name= preference type= xsd:unsignedshort /> </xsd:extension> </xsd:complexcontent> <xsd:complextype name= DNS_NS > <xsd:complexcontent> <xsd:extension base= DNS_COMMON /> </xsd:complexcontent> <xsd:complextype name= DNS_CNAME > <xsd:complexcontent> <xsd:extension base= DNS_COMMON /> </xsd:complexcontent> <xsd:complextype name= DNS_A > <xsd:complexcontent> <xsd:extension base= DNS_COMMON /> </xsd:complexcontent> <xsd:complextype name= DNS_COMMON abstract= true > <xsd:element name= prefix type= xsd:token /> <xsd:element name= data type= xsd:token /> <xsd:element name= ttl type= xsd:unsignedlong minoccurs= 0 /> <xsd:attribute name="forceactive" type="xsd:boolean" default="false" use="optional"/> Element/Attribute Default Value Available Description 100 mx * MX record. XML schema: prefix Record s prefix. The "canonical" DNS record (a record with a final dot) is also supported.

101 Element/Attribute Default Value Available Description data Data related to record. ttl * used service default value Time-to-alive. Measured in seconds. preference MX -specific field. ns * NS record. prefix Record s prefix. data Data related to record. ttl * used service default value Time-to-alive. Measured in seconds. cname * CNAME record. prefix Record s prefix. data Data related to record. ttl * used service default value Time-to-alive. a * A record. Measured in seconds. prefix Record s prefix. data Data related to record. ttl * used service default (common attribute) Time-to-alive. Measured in seconds. * false Specifies whether a migrated record should be active in POA. Note: if forceactive is false and a record with such hostname already exists in POA, the current record will not be migrated. If forceactive is true, the record will be migrated anyway. Databases Some preparation steps are required before migrating custom databases to Parallels Operations Automation. See the Preparing for Microsoft SQL Migration Appendix. 101

102 Generic Structure At present time, Migration API allows you to migrate (create custom database and restore its content) customer databases from MySQL 3.x-4.x server, PostgreSQL 7.x-8.x server, Microsoft MS SQL 7/2000/2005 Server and MS Access DSN. <xsd:complextype name= Databases > <xsd:element name= pgsql type= Databases_SQL minoccurs= 0 maxoccurs= unbounded /> <xsd:element name= mysql type= Databases_SQL minoccurs= 0 maxoccurs= unbounded /> <xsd:element name= mssql type= Databases_MSSQL minoccurs= 0 maxoccurs= unbounded /> <xsd:element name= msaccess type= Databases_MSAccess minoccurs= 0 maxoccurs= unbounded /> Element/Attribute Default Value Available Description XML schema: pgsql * Migration information about PostgreSQL customer databases. mysql * Migration information about MySQL customer databases. mssql * Migration information about Microsoft MS SQL customer databases. msaccess * MS Access DSN migration support. 102

103 Database Configuration <xsd:complextype name= Databases_SQL > <xsd:group ref= Databases_Common /> <xsd:element name= accesshosts type= Databases_AccessHosts minoccurs= 0 /> <xsd:complextype name= Databases_MSSQL > <xsd:group ref= Databases_Common /> <xsd:element name= dataquota type= xsd:positiveinteger /> <xsd:element name= logquota type= xsd:positiveinteger /> <xsd:group name= Databases_Common > <xsd:element name= name type= xsd:token /> <xsd:element name= users type= Databases_Users /> <xsd:element name= dsn type= Databases_DSN minoccurs= 0 maxoccurs= unbounded /> <xsd:element name= contentid type= xsd:normalizedstring minoccurs= 0 /> </xsd:group> <xsd:complextype name= Databases_AccessHosts > <xsd:element name= host type= xsd:token maxoccurs= unbounded /> Element/Attribute Default Value Available Description XML schema: name Original name of a database. Note: Database name will be extended during provisioning with unique prefix. users List of database users. At least on user should be specified. dsn * Database Source Names (DSN). See section contentid * Reference to database s content. For PostgreSQL databases, the content must be generated using the. tar format (see " F" option of the pg_dump). accesshosts * List of external hosts which should have an access to a customer database. Note: Applicable only to MySQL and PostgreSQL customer databases. 103

104 Element/Attribute Default Value Available Description dataquota 2.8 Database data quota (measured in KB). Note: Applicable only to Microsoft SQL databases. If the value of the quota is less than 4096 (4MB), Migration Manager automatically increases the quota up to 4MB. logquota 2.8 Database transaction log quota (measured in KB). accesshosts * List of access hosts. Note: Applicable only to Microsoft SQL databases. If the value of the quota is less than 4096 (4MB), Migration Manager automatically increases the quota up to 4MB. host IP addresses or host name. 104

105 Database Users <xsd:complextype name= Databases_Users > <xsd:element name= user type= Databases_User maxoccurs= unbounded /> <xsd:element name= defaultuser type= xsd:token /> <xsd:complextype name= Databases_User > <xsd:element name= login type= xsd:token /> <xsd:element name= password minoccurs= 0 > <xsd:complextype> <xsd:simplecontent> <xsd:extension base= xsd:token > <xsd:attribute name= encrypted type= xsd:boolean default= false use= optional /> </xsd:extension> </xsd:simplecontent> Element/Attribute Default Value Available Description XML schema: user Database user. Login User name. Password * Password. Note: 1. User name will be extended during provisioning with the unique prefix. 2. The maximum length of the extended login (together with the prefix) is as follows for different database types: - MySQL: 16 characters - PostgreSQL: 63 characters - MS SQL: 128 characters The optional indicates if the password is in plain or in encrypted form. Note: Encrypted passwords for MS SQL and PostgreSQL databases are not supported. defaultuser Reference (by login) to the already defined database user. This user will be used by Web-based database management tools such as phpmysql, phppgsql or mylittleadmin. 105

106 <mysql> <name>testmydb1</name> <users> <user> <login>mylogin1</login> <password>&hj8)h</password> </user> <user> <login>mylogin2</login> <password>h&^j0)&</password> </user> <defaultuser>mylogin2</defaultuser> </users> <dsn> <webspaceid>ws12</webspaceid> <source>mysource</source> </dsn> <contentid>db:mysql:testmydb1</contentid> <accesshosts> <host> </host> </accesshosts> </mysql> Example: DSN Migration Support DSN (Database Source Name) is a special data source identifier used to describe a connection to a database. In Parallels Operations Automation, DSN is tightly integrated with a webspace (IIS webspace), so it can t be created without referencing on the already existing webspace. <xsd:complextype name= Databases_DSN > <xsd:element name= webspaceid type= xsd:token /> <xsd:element name= source type= xsd:token maxoccurs= unbounded /> Element/ Default Value Available Description Attribute webspaceid Reference to a webspace. XML schema: source DSN identifier. Note: Identifier will be extended with unique prefix (dsnxx_) during provisioning. 106

107 Content The content (database dump) for a custom database is to be stored by a Migration Agent as single file (not in the tar ball archive). The recommended ways for dumping custom databases: PostgreSQL databases: Database owner should be skipped. All privileges should be skipped. Binary data (BLOB) should be included in the dump. Custom format dump. $ pg_dump Fc o x b h [database_server] [database_name] > dump MySQL databases: Quote names (tables, columns) option should be used. Quick rows retrieving mode should be enabled. $ mysqldump Q q h [database_server] [database_name] > dump Microsoft SQL databases. Use MSSQL DMO (Distributed Managed Objects) for dumping custom databases. See the link for more details. Database dump file should be stored in a file with the.bak extension and without paths in a tar ball archive. Microsoft Access databases. Microsoft Access database file (*.mdb) should be stored (without paths) by a Migration Agent as a tar ball archive. Pure DSN Generic Structure At present time, Migration API allows to migrate MS Access DSN. All details are depicted in the underlying section. <xsd:complextype name="dsns"> <xsd:element name="msaccess" type="dsns_msaccess" minoccurs="0" maxoccurs="unbounded" /> Element/Attribute Default Value Available Description XML schema: 107

108 Element/Attribute Default Value Available Description msaccess * MS Access DSN migration support. 108

109 Microsoft Access DSN Migration Support <xsd:complextype name= Databases_MSAccess > <xsd:element name= webspaceid type= xsd:token /> <xsd:element name= dsnname type= xsd:token /> <xsd:element name= relativepath > <xsd:complextype> <xsd:simplecontent> <xsd:extension base= xsd:normalizedstring > <xsd:attribute name= prefix default= private use= optional > <xsd:simpletype> <xsd:restriction base= xsd:token > <xsd:enumeration value= wwwroot /> <xsd:enumeration value= private /> </xsd:restriction> </xsd:simpletype> </xsd:attribute> </xsd:extension> </xsd:simplecontent> <xsd:element name= user minoccurs= 0 > <xsd:complextype> <xsd:element name= login type= xsd:token /> <xsd:element name= password type= xsd:token /> <xsd:element name= contentid type= xsd:normalizedstring /> Element/Attribute Default Value Available Description XML schema: webspaceid Reference to a webspace. dsnname DSN identifier. Note: Identifier will be extended with unique prefix (dsnxx_) during provisioning. relativepath Relative path to MDB file (relative to directory specified * private Defines root directory path for MDB files. Possible values: private and wwwroot. User * Defines DSN user(s). login DSN user name. password DSN user password. contentid Reference to content. 109

110 In the next example, custom DSN msaccess1 will be created on the webspace1. MDB file will be migrated to \private\msaccess1.mdb. <databases> <msaccess> <webspaceid>webspace1</webspaceid> <dsnname>msaccess1</dsnname> <relativepath>msaccess1.mdb</relativepath> <contentid>db:msaccess:msaccess1.mdb</contentid> </msaccess> </databases> Example: In this example, MS Access database file will be moved to the \wwwroot\dbs\db1.mdb directory. <databases> <msaccess> <webspaceid>webspace1</webspaceid> <dsnname>msaccess2</dsnname> <relativepath prefix= wwwroot >dbs\db1.mdb</relativepath> <contentid>db:msaccess:db1.mdb</contentid> </msaccess> </databases> Qmail Migration API v2 supports the following Qmail features: mail-enabled domains, mailboxes, mail groups, mail lists, catch-all ability. Example: 110

111 Generic Structure <xsd:complextype name= Qmail > <xsd:element name= domains > <xsd:complextype> <xsd:element name= domain type= QmailDomain maxoccurs= unbounded /> <xsd:element name= mailnames minoccurs= 0 > <xsd:complextype> <xsd:element name= mailname type= Qmail_Mailname maxoccurs= unbounded /> <xsd:element name= maillists minoccurs= 0 > <xsd:complextype> <xsd:element name= maillist type= Qmail_Maillist maxoccurs= unbounded /> <xsd:element name= unresolved minoccurs= 0 > <xsd:complextype> <xsd:choice> <xsd:element name= bounce type= xsd:normalizedstring /> <xsd:element name= catchto type= String /> </xsd:choice> Element/Attribute Default Value Available Description XML schema: domains 2.7 List of mail-enabled domains. mailnames * 2.7 List of mailboxes and mail groups. See the Qmail Mailbox Configuration section (on page 113). maillists * 2.7 Mail lists. See the Qmail Mail List Configuration section (on page 119). unresolved * 2.7 Catch-all ability configuration. See the Catching Unresolved Mail section (on page 122). 111

112 Mail-Enabled Domains <xsd:complextype name= QmailDomain > <xsd:complexcontent> <xsd:extension base= ServiceDomain /> </xsd:complexcontent> Element/Attribute Default Value Available Description XML schema: name 2.7 Mail domain/subdomain name. See the Customer Services on Subdomains section (on page 54). In the next example, Qmail mail hosting will be provided for the mymail.com domain and for the qmail.mydomain.org subdomain. <qmail> <domains> <domain parent= mydomain.org > <name>qmail.mydomain.org</name> </domain> <domain> <name>mymail.com</name> </domain> </domains> </qmail> Example: 112

113 Qmail Mailbox Configuration <xsd:complextype name="qmail_mailname"> <xsd:group ref="qmail_address"/> <xsd:element name="serviceuserlogin" type="serviceuserlogin"/> <xsd:element name="mailbox" minoccurs="0"> <xsd:complextype> <xsd:element name="quota" type="xsd:positiveinteger" minoccurs="0"/> <xsd:group ref="contentid"/> <xsd:element name="forwarding" type="qmailforwarding" minoccurs="0"/> <xsd:element name="autoresponders" minoccurs="0"> <xsd:complextype> <xsd:element name="autoresponder" type="qmailautoresponder" maxoccurs="unbounded"/> <xsd:element name="antivirus" type="qmailantivirus" minoccurs="0"/> <xsd:element name="antispam" type="qmailantispam" minoccurs="0"/> <xsd:attribute name="enabled" type="xsd:boolean" default="true" use="optional"/> <xsd:group name="qmail_address"> <xsd:choice> <xsd:element name=" address" type=" string"/> <xsd:element name="localaddress" type=" localstring"/> </xsd:choice> </xsd:group> Element/Attribute Default Value Available Description XML schema: address 2.7 address in the form: Create the <local_part> mail name on the <mail_domain> domain. Only one of the address and localaddress elements should be used in the same time. localaddress 2.7 Local part of the address. Create the <local_part> mail name on all registered mail domains. Only one of the address and localaddress elements should be used in the same time. 113

114 Element/Attribute Default Value Available Description serviceuserlogin 2.9 Reference to the mailname's Service User (it should be defined in the "Users" section). mailbox * 2.7 Mailbox store configuration. quota * 2.7 Mailbox maximum size (in KB). Default value (from the corresponding Service Template) will be used if the quota element is missing. contentid * 2.7 Reference to a mailbox content. password * 2.7 Mailbox password. See the Qmail: Content section (on page 123). Will be generated during provisioning. If the mailbox parameter is not defined, the password will be ignored. forwarding * 2.7 Forwarding configuration for inbound messages. autoresponders * 2.7 Auto responders. antivirus * 2.7 Antivirus protection configuration. antispam * 2.7 Antispam filtering * 2.7 Reserved but not used. Mail forwarding configuration. <xsd:complextype name= QmailForwarding > <xsd:element name= address type= String maxoccurs= unbounded /> <xsd:attribute name= enabled type= xsd:boolean default= true use= optional /> Element/Attribute Default Value Available Description XML schema: address 2.7 Forwards inbound messages to this * true 2.7 Indicates if the mail forwarding is enabled/ disabled. In the next example, all incoming messages will be forwarded to the [email protected] and [email protected] addresses: <forwarding enabled= true > 114 Example:

115 </forwarding> Auto-Responder Configuration XML schema: <xsd:complextype name= QmailAutoresponder > <xsd:element name= name type= xsd:normalizedstring /> <xsd:element name= trigger type= QmailAutoresponderTrigger /> <! not supported yet --> <xsd:element name= encoding minoccurs= 0 /> <xsd:choice> <xsd:element name= forward type= String /> <xsd:element name= reply > <xsd:complextype> <xsd:element name= replyto type= String minoccurs= 0 /> <xsd:element name= subject type= xsd:normalizedstring minoccurs= 0 /> <xsd:element name= message > <xsd:complextype> <xsd:simplecontent> <xsd:extension base= xsd:string > <xsd:attribute name= type default= plain use= optional > <xsd:simpletype> <xsd:restriction base= xsd:token > <xsd:enumeration value= plain /> <! not supported yet --> <xsd:enumeration value= html /> </xsd:restriction> </xsd:simpletype> </xsd:attribute> </xsd:extension> </xsd:simplecontent> </xsd:choice> <xsd:attribute name= enabled type= xsd:boolean default= true use= optional /> Element/Attribute Default Value Available Description name 2.7 Auto responder display name. trigger 2.7 always 2.7 Triggers the auto-responder every time when a new message arrives. filtersubject 2.7 Triggers the auto-responder if a subject contains the given pattern. 115

116 Element/Attribute Default Value Available Description 116 filterbody 2.7 Triggers the auto-responder if the body contains the given pattern. forward 2.7 address to which the incoming requests are forwarded. Note, that forwarding will be carried out by the auto-responder only if the decision to respond, based on the information specified by the auto-responder settings, was made. reply 2.7 replyto * 2.7 Alters reply-to address. subject * 2.7 Uses the subject as subject for a reply message. message 2.7 Message s * true 2.7 Indicates that auto-responder is in the active or inactive state. In the example below, the My Vacations auto-responder will forward all incoming messages, which contains in their bodies the New question: string to the [email protected] address. <autoresponder enabled= true > <name>my Vacations</name> <trigger> <filterbody>new question:</filterbody> </trigger> <forward>[email protected]</forward> </autoresponder> Mailbox Antivirus Protection <xsd:complextype name= QmailAntivirus > <xsd:all> <xsd:element name= incoming type= xsd:boolean default= true minoccurs= 0 /> <xsd:element name= outgoing type= xsd:boolean default= false minoccurs= 0 /> <xsd:element name= notifysender type= xsd:boolean default= false minoccurs= 0 /> <xsd:element name= notifyrecipient type= xsd:boolean default= false minoccurs= 0 /> </xsd:all> Element/ Default Value Available Description Attribute Example: XML schema: incoming * true 2.7 Checks all incoming messages against virus threat.

117 Element/ Attribute Default Value Available Description outgoing * false 2.7 Checks all outgoing messages against virus threat. notifysender * false 2.7 Notifies message sender about detected virus threat. notifyrecipient * false 2.7 Notifies message recipient about detected virus threat. In the next example, all incoming and outgoing messages will be checked against viruses, and only the sender should be notified about the threat. <antivirus> <incoming>true</incoming> <outgoing>true</outgoing> <notifysender>true</notifysender> <notifyrecipient>false</notifyrecipient> </antivirus> Mailbox Spam Protection <xsd:complextype name= QmailAntispam > <xsd:element name= mode default= personal minoccurs= 0 > <xsd:simpletype> <xsd:restriction base= xsd:token > <xsd:enumeration value= disabled /> <xsd:enumeration value= personal /> <xsd:enumeration value= personal and global /> </xsd:restriction> </xsd:simpletype> <xsd:element name= hits type= xsd:positiveinteger default= 7 minoccurs= 0 /> <xsd:element name= action default= delete minoccurs= 0 > <xsd:simpletype> <xsd:restriction base= xsd:string > <xsd:enumeration value= delete /> <xsd:enumeration value= mark /> <xsd:enumeration value= mark and modify subject /> </xsd:restriction> </xsd:simpletype> <xsd:element name= spamsubjectmark type= xsd:normalizedstring minoccurs= 0 /> <xsd:element name= whitelist type= QmailAntiSpamList minoccurs= 0 /> <xsd:element name= blacklist type= QmailAntiSpamList minoccurs= 0 /> <xsd:complextype name= QmailAntiSpamList > <xsd:element name= pattern type= xsd:normalizedstring Example: XML schema: 117

118 maxoccurs= unbounded /> Element/Attribute Default Value Available Description mode * personal 2.7 Spam filter mode. Supported modes: disabled disables filtering. Personal uses only custom-defined rules for Spam filtering. Personal and global uses custom- and vendordefined rules for Spam filtering. hits * The score required before a mail is considered as a spam. action * delete 2.7 Spam filters action. Supported actions: delete drops a message. Mark marks a message as a spam. Mark and modify subject marks a message as a spam and changes the subject. spamsubjectmark * 2.7 Uses the custom spam label in a message subject. whitelist * 2.7 List of the white addresses. pattern 2.7 blacklist * 2.7 List of the black addresses. pattern 2.7 In the XML sample below, it is specified that a message will be treated as spam if it has at least 11 score points or if sender s address matches to the *@yahooo.com pattern. The subject for such messages will be extended with the custom label {_SPAM_}. <antispam> <mode>personal</mode> <hits>11</hits> <action>mark and modify subject</action> <spamsubjectmark>{_spam_}</spamsubjectmark> <blacklist> <pattern>*@yahooo.com</pattern> </blacklist> </antispam> Example: 118

119 Qmail Mail List Configuration <xsd:complextype name= Qmail_Maillist > <xsd:group ref= Qmail_Address /> <xsd:element name= adminpassword type= Password minoccurs= 0 /> <xsd:element name= approvepassword type= Password minoccurs= 0 /> <xsd:element name= sender type= LocalString minoccurs= 0 /> <xsd:element name= whoaccess > <xsd:simpletype> <xsd:restriction base= xsd:token > <xsd:enumeration value= open /> <xsd:enumeration value= list /> <xsd:enumeration value= closed /> </xsd:restriction> </xsd:simpletype> <xsd:element name= intro type= Qmail_String64 minoccurs= 0 /> <xsd:element name= info type= Qmail_String64 minoccurs= 0 /> <xsd:element name= owners type= Qmail_ AddressList minoccurs= 0 /> <xsd:element name= approvers type= Qmail_ AddressList minoccurs= 0 /> <xsd:element name= members type= Qmail_ AddressList minoccurs= 0 /> <xsd:element name= antivirus type= QmailAntivirus minoccurs= 0 /> <! Type for backward compatibility. If base64 attribute is set, then content is treated as base64-encoded data, otherwise it s considered plain string --> <xsd:complextype name= Qmail_String64 > <xsd:simplecontent> <xsd:extension base= xsd:string > <xsd:attribute name= base64 type= xsd:boolean default= false use= optional /> </xsd:extension> </xsd:simplecontent> <xsd:complextype name= Qmail_ AddressList > <xsd:element name= address type= String maxoccurs= unbounded /> XML schema: 119

120 Element/Attribute Default Value Available Description address 2.7 See the Qmail Mailbox Configuration section (on page 113). localaddress 2.7 See the Qmail Mailbox Configuration section (on page 113). adminpassword * 2.7 Password, which allows an owner to handle the administration list. If the field is empty, the password will be automatically 2.7 Only plain passwords are supported. approvepassword * 2.7 This is a password used to approve postings in the moderated list. If the field is empty, the password will be automatically 2.7 Only plain passwords are supported. sender * 2.7 Used to identify from whom the message comes. If the field is empty, the sender will be automatically generated in the <listname>-owner form. whoaccess 2.7 open allows anyone access. closed disables the open command. list allows only list members access. intro 2.7 Welcome message. Can be * false 2.7 Indicates if the message body is base64- encoded. info 2.7 About message. Can be * false 2.7 Indicates if the message body is base64- encoded. owners * 2.7 The list of the mail list owners ( addresses). address 2.7 address. approvers * 2.7 List of mail list approvers ( addresses). address 2.7 address. members * 2.7 List of mail list members ( addresses). address 2.7 address. 120

121 Element/Attribute Default Value Available Description antivirus * 2.7 Antivirus protection configuration. See the Qmail Mailbox Configuration section (on page 113), the Mailbox Antivirus Protection paragraph. Note, that checking for outgoing messages is not supported. Corresponding element will be ignored. In the next example the [email protected] mail list will be created and two addresses will be registered as mail list members. <maillists> <maillist> < address>[email protected]</ address> <approvepassword type= plain >ytrewq11</approvepassword> <sender>sender-list1-dev</sender> <whoaccess>list</whoaccess> <intro>intro: this is sample mail list.</intro> <info base64= true > SW5mbzogdGhpcyBpcyBzYW1wbGUgbWFpbCBsaXN0Lg== </info> <members> < address>[email protected]</ address> < address>[email protected]</ address> </members> </maillist> </maillists> Example: 121

122 Catching Unresolved Mail <xsd:element name= unresolved minoccurs= 0 > <xsd:complextype> <xsd:choice> <xsd:element name= bounce type= xsd:normalizedstring /> <xsd:element name= catchto type= String /> </xsd:choice> XML schema: Element/Attribute Default Value Available Description bounce 2.7 Reply with a bounce phrase. catchto 2.7 Forwards all unresolved mail to a given address. <unresolved> <bounce>sample bounce phrase.</bounce> </unresolved> Example: 122

123 Content Migration Manager supports only the Maildir mailbox content format. Migration Agents should dump original mailbox content in a tar ball archive. The tar ball archive name should have the.tar extension. Migration Agent is responsible for converting original mailbox format to the Maildir format if necessary. The sample of archive with the mailbox content: $ tar tf content_1234.tar././tmp/./cur/./new/./new/ m56751p1349v ei e.mail.provider.com, S=496 It is possible to migrate IMAP folders, but after migration a customer should be re-subscribed to all IMAP folders. $ ls la./maildir drwx mailnames qmail 4096 Oct 8 00:18 cur drwx mailnames qmail 4096 Oct 20 00:36.F1 drwx mailnames qmail 4096 Oct 20 00:36.F2 drwx mailnames qmail 4096 Oct 20 00:36.F2.SF1 drwx mailnames qmail 4096 Oct 8 00:18 new drwx mailnames qmail 4096 Oct 20 00:36 tmp Note: Migration Manager does not support the mail lists archives migration. Apache Migration API supports the following Apache features: websites on Apache, webspace on the shared or exclusive IP address, turning on PHP, CGI, WAP, SSI and SSL features on the entire webspace, content management tools: FrontPage extension, File Manager and FTP, hotlink protection, MIME types configuration, protected directories, custom error handlers, custom application extensions. 123

124 124

125 Webspace Structure <xsd:complextype name= Apache > <xsd:element name= domains minoccurs= 0 > <xsd:complextype> <xsd:element name= domain type= ApacheDomain maxoccurs= unbounded /> <xsd:group ref= ApacheGlobalSettings /> <xsd:group ref= ApacheWebspaceContent /> <xsd:attribute name= onexclusiveip type= xsd:boolean default= false use= optional /> <xsd:group name= ApacheGlobalSettings > <xsd:element name= features type= ApacheFeatures minoccurs= 0 /> <xsd:element name= contentmanagement type= ApacheGlobalCM minoccurs= 0 /> <xsd:element name= customerrors type= ApacheErrors minoccurs= 0 /> <xsd:element name= mimeassociations type= ApacheMIME minoccurs= 0 /> <xsd:element name= handlers type= ApacheHandlers minoccurs= 0 /> <xsd:element name= hotlink type= ApacheHotlink minoccurs= 0 /> <xsd:element name= blocked type= ApacheAccessRestriction minoccurs= 0 /> <xsd:element name= protected type= ApacheProtectedDirs minoccurs= 0 /> </xsd:group> <xsd:group name= ApacheWebspaceContent > <xsd:group ref= ApacheWebSiteContent /> <xsd:element name= sslcertificatecontentid type= xsd:normalizedstring minoccurs= 0 /> <xsd:element name= sslcacertificatecontentid type= xsd:normalizedstring minoccurs= 0 /> </xsd:group> <xsd:group name= ApacheWebSiteContent > <xsd:element name= httpcontentid type= xsd:normalizedstring minoccurs= 0 /> <xsd:element name= httpscontentid type= xsd:normalizedstring minoccurs= 0 /> <xsd:element name= scriptcontentid type= xsd:normalizedstring minoccurs= 0 /> </xsd:group> XML schema: 125

126 Element/Attribute Default Value Available * false 2.7 Indicates if a webspace should be provided on the shared or exclusive IP address. domains 2.7 List of websites on the domains. features * 2.7 Allows Apache features configuration, like PHP, CGI, SSI, SSL or WAP on a webspace. contentmanagement * 2.7 Allows the content management tools configuration. customerrors * 2.7 List of custom error handlers. mimeassociations * 2.7 List of custom MIME types. handlers * 2.7 List of custom application extensions. hotlink * 2.7 Hotlink protection options. blocked * 2.7 Access restrictions. protected * 2.7 List of protected Web-directories. httpcontentid * 2.7 Defines a reference to the webspace directory content (accessed by HTTP). See the Content section (on page 140). httpscontentid * 2.7 Defines a reference to the webspace directory content (accessed by HTTPS). See the Content section (on page 140). scriptcontentid * 2.7 Defines a reference to the webspace CGI- BIN directory content. See the Content section (on page 140). sslcertificatecontentid * 2.7 Defines a reference to a self-signed certificate. See the Content section (on page 140). RESTRICTION: The webspace must be provisioned on the exclusive IP address and SSL option must be turned on. Otherwise the migration process will fail. sslcacertificatecontentid * 2.7 Defines reference to a CA certificate. See the Content section (on page 140). RESTRICTION: The webspace must be provisioned on the exclusive IP address and SSL option must be turned on. Otherwise the migration process will fail. 126

127 In the example bellow, Apache physical hosting will be provided on a webspace with shared IP address for two sites: one for the mydomain.com domain and another for the apache.mydocs.com subdomain. <apache onexclusiveip= false > <domains> <domain> <name>mydomain.com</name> </domain> <domain parent= mydocs.org > <name>apache.mydocs.com</name> </domain> </domains> </apache> Example: 127

128 Webspace Configuration Webspace Features Configuration <xsd:complextype name= ApacheFeatures > <xsd:element name= ssl type= xsd:boolean default= false minoccurs= 0 /> <xsd:element name= cgi type= xsd:boolean default= false minoccurs= 0 /> <xsd:element name= ssi type= xsd:boolean default= false minoccurs= 0 /> <xsd:element name= php type= PHPFeature default= false minoccurs= 0 maxoccurs= unbounded /> <xsd:element name= wap type= xsd:boolean default= false minoccurs= 0 /> <xsd:element name= webstatistics type= xsd:boolean default= false minoccurs= 0 /> <xsd:complextype name= PHPFeature > <xsd:simplecontent> <xsd:extension base= xsd:boolean > <xsd:attribute name= version type= xsd:positiveinteger use= optional default= 5 /> </xsd:extension> </xsd:simplecontent> XML schema: Element/Attribute Default Value Available Description ssl * false 2.7 Enables SSL support. cgi * false 2.7 Enables CGI support. Ssi * false 2.7 Enables SSI support. php * false 2.7 Enables PHP support. * Supported versions: 4 and 5. wap * false 2.7 Activates WAP support. webstatistics * false 2.7 Activates Webalizer tool. In the example below, CGI, SSH and PHP 4 features will be activated on a webspace. <features> <ssl>false</ssl> <cgi>true</cgi> <ssi>true</ssi> <php version= 4 >true</php> <webstatistics>false</webstatistics> </features> Example:

129 Configuring Content Management Tools <xsd:complextype name= ApacheGlobalCM > <xsd:all> <xsd:element name= frontpage type= ApacheFrontPage minoccurs= 0 /> <xsd:element name= ftp type= Apache_FTPaccess minoccurs= 0 /> <xsd:element name= filemanager type= xsd:boolean default= false minoccurs= 0 /> <xsd:element name= logmanager minoccurs= 0 > <xsd:complextype> <xsd:element name= password type= xsd:normalizedstring minoccurs= 0 /> </xsd:all> XML schema: Element/Attribute Default Value Available Description frontpage * 2.7 Configures FrontPage extension on a webspace. See details below. Warning: FrontPage extension cannot be activated both for the entire webspace and for some website (domain) only. ftp * 2.7 Enables FTP access. See details below. filemanager * false 2.7 Activates Web-based File Manager on a webspace. logmanager * 2.7 Configures FTP access to Apache log files. password * 2.7 FTP password. <xsd:complextype name= ApacheFrontPage > <xsd:all> <xsd:element name= ssl type= xsd:boolean default= false minoccurs= 0 /> <xsd:element name= auth minoccurs= 0 > <xsd:complextype> <xsd:element name= login type= xsd:token /> <xsd:element name= password type= Password minoccurs= 0 /> </xsd:all> Note: should never be used. XML schema: 129

130 Element/Attribute Default Value Available Description ssl * false 2.7 Enables SSL support. 130 Note: This option will be ignored if SSL support is not enabled on a webspace. See the Website Structure section (on page 125). auth * 2.7 Activates FrontPage authoring. login 2.7 FrontPage user name password * 2.7 FrontPage user password. <xsd:complextype name= Apache_FTPaccess > <xsd:element name= users minoccurs= 0 > <xsd:complextype> <xsd:element name= admin minoccurs= 0 > <xsd:complextype> <xsd:element name= login type= xsd:token /> <xsd:element name= password type= Password minoccurs= 0 /> <xsd:element name= user minoccurs= 0 maxoccurs= unbounded > <xsd:complextype> <xsd:element name= login type= xsd:token /> <xsd:element name= password type= Password minoccurs= 0 /> <xsd:element name= location > <xsd:simpletype> <xsd:restriction base= xsd:token > <xsd:enumeration value= httpdocs /> <xsd:enumeration value= httpsdocs /> <xsd:enumeration value= cgi-bin /> </xsd:restriction> </xsd:simpletype> <xsd:element name= path type= xsd:token default= minoccurs= 0 /> <xsd:group ref= ContentID /> The password will be generated during the migration. RESTRICTION: Only plain password type is supported. XML schema:

131 <xsd:attribute name= onexclusiveip type= xsd:boolean default= false use= optional /> Element/Attribute Default Value Available * false 2.7 Indicates if a FTP service is to be provided on a shared or exclusive IP address. users * 2.7 List of FTP users. admin * 2.7 Administrative FTP access to an entire webspace. login 2.7 FTP user name. password * 2.7 FTP password. If it is missing, it will be generated automatically during migration. user * 2.7 Custom FTP user. login 2.7 FTP user name. password * 2.7 FTP password. Note: The final FTP user name will be formed as <generated_unique_prefix>.login. If it is missing, it will be generated automatically during migration. location 2.7 Defines FTP directory location. Possible values: httpdocs, httpsdocs and cgibin. path * 2.7 Defines FTP root directory under a certain location (see the previous element). contentid * 2.7 Defines reference to FTP content. In the next XML sample, FTP service will be provisioned in shared environment; the adm8 FTP user will have full access to a webspace. The usr FTP user will have an access only to the httpdocs/documents/guides/ directory. <ftp onexclusiveip= false > <users> <admin> <login>adm8</login> </admin> <user> Example: 131

132 <login>usr</login> <password type= plain >my_ftplogin</password> <location>httpdocs</location> <path>/documents/guides</path> </user> </users> </ftp> Configuring Custom Error Handlers <xsd:complextype name= ApacheErrors > <xsd:element name= error maxoccurs= unbounded > <xsd:complextype> <xsd:element name= code type= xsd:integer /> <xsd:choice> <xsd:element name= off /> <xsd:element name= message type= xsd:string /> <xsd:element name= file type= xsd:normalizedstring /> <xsd:element name= url type= xsd:normalizedstring /> </xsd:choice> XML schema: Element/Attribute Default Value Available Description error 2.7 Defines a custom error handler. code 2.7 HTTP error code identifier. Only the following error codes can be customized: 400, 403, 404 and 500. Other custom error codes will be ignored. Note: Only one of possible actions can be assigned to a code (off, message, file or url). See the elements below. off 2.7 Disables error handler which was assigned by default. message 2.7 Defines custom error message. file 2.7 Shows custom error document. The document should be addresses relatively to a website. url 2.7 Redirects to a given URL. 132

133 In the next example, HTTP 502 error handler will be turned off, HTTP 500 error handler will forward requests to the URL, HTTP 404 error handler will return custom message and HTTP 400 error handler will return custom file from /httpdocs/errors/400.html or /httpsdocs/errors/400.html. <customerrors> <error> <code>502</code> <off /> </error> <error> <code>500</code> <url> </error> <error> <code>404</code> <message>===> NOT FOUND <===</message> </error> <error> <code>400</code> <file>/errors/400.html</file> </error> </customerrors> Custom MIME Types Configuration <xsd:complextype name= ApacheMIME > <xsd:element name= mime maxoccurs= unbounded > <xsd:complextype> <xsd:element name= ext type= xsd:token maxoccurs= unbounded /> <xsd:element name= type type= xsd:token /> Example: XML schema: Element/Attribute Default Value Available Description mime 2.7 Custom MIME type. ext 2.7 Extensions (without leading dots). type <mimeassociations> <mime> <ext>xa</ext> <type>application/vnd.xara</type> </mime> MIME type definition. Example: 133

134 <mime> <ext>sml</ext> <ext>sg</ext> <type>text/sgml</type> </mime> </mimeassociations> Configuring Custom Application Extensions <xsd:complextype name= ApacheHandlers > <xsd:element name= handler maxoccurs= unbounded > <xsd:complextype> <xsd:element name= ext type= xsd:token maxoccurs= unbounded /> <xsd:element name= action > <xsd:simpletype> <xsd:restriction base= xsd:string > <xsd:enumeration value= send-as-is /> <xsd:enumeration value= cgi-script /> <xsd:enumeration value= imap-file /> <xsd:enumeration value= server-info /> <xsd:enumeration value= server-parsed /> <xsd:enumeration value= server-status /> <xsd:enumeration value= type-map /> </xsd:restriction> </xsd:simpletype> XML schema: Element/Attribute Default Value Available Description handler 2.7 Custom application extension. ext 2.7 Extensions (without leading dots). action 2.7 An application handler. Possible values are: send-as-is cgi-script imap-file server-info server-parsed server-status type-map 134

135 <handlers> <handler> <ext>doc</ext> <ext>tex</ext> <action>send-as-is</action> </handler> <handler> <ext>sif</ext> <action>server-info</action> </handler> <handler> <ext>exe</ext> <action>cgi-script</action> </handler> <handler> <ext>info</ext> <action>server-status</action> </handler> <handler> <ext>ssp</ext> <action>server-parsed</action> </handler> </handlers> Example: Configuring the Hot Linking Protection <xsd:complextype name= ApacheHotlink > <xsd:element name= enabled type= xsd:boolean default= true minoccurs= 0 /> <xsd:element name= allowurl type= xsd:normalizedstring minoccurs= 0 maxoccurs= unbounded /> <xsd:element name= denyext type= xsd:token minoccurs= 0 maxoccurs= unbounded /> <xsd:element name= redirect type= xsd:normalizedstring minoccurs= 0 /> XML schema: Element/Attribute Default Value Available Description enabled * true 2.7 Enables hotlink protection. allowurl * 2.7 Allows referrers (URLs). denyext * 2.7 Document s extensions which are forbidden for hot linking. redirect * 2.7 Redirects request to a given URL if the hot linking is detected. <hotlink> <enabled>true</enabled> <allowurl> <denyext>tif</denyext> Example: 135

136 <denyext>bmp</denyext> <redirect> </hotlink> Configuring Access Restrictions to Websites <xsd:complextype name= ApacheAccessRestriction > <xsd:element name= mask type= xsd:token maxoccurs= unbounded /> XML schema: Element/Attribute Default Value Available Description mask 2.7 Block access for a given client. The client(s) will be matched by a certain IP address, host name, or by a pattern. <blocked> <mask> *.*</mask> <mask>*.mydomain.com</mask> </blocked> Password Protected Web-Directories Example: <xsd:complextype name= ApacheProtectedDirs > <xsd:element name= dir maxoccurs= unbounded > <xsd:complextype> <xsd:element name= name type= xsd:token /> <xsd:element name= description type= xsd:string minoccurs= 0 /> <xsd:element name= ssl type= xsd:boolean default= false minoccurs= 0 /> <xsd:element name= users minoccurs= 0 > <xsd:complextype> <xsd:element name= user maxoccurs= unbounded > <xsd:complextype> <xsd:element name= login type= xsd:token /> <xsd:element name= password type= Password minoccurs= 0 /> XML schema: 136

137 Element/Attribute Default Value Available Description dir 2.7 Protected Web-directory configuration. name 2.7 Protected directory name. description * 2.7 Description. ssl * false 2.7 Enables SSL support. users * 2.7 List of users. user 2.7 Directory user. login 2.7 User name. password * 2.7 User password. <protected> <dir> <name>private</name> <description>private directory.</description> <ssl>false</ssl> <users> <user> <login>editor</login> <password type= plain >autr</password> </user> </users> </dir> </protected> Restriction: If the ssl option is turned on, the SSL support on the webspace must be turned on. Otherwise, a given Web-directory will be skipped during migration. Restriction: Only a plain password type is supported. Example: 137

138 Websites Configuration <xsd:complextype name= ApacheDomain > <xsd:complexcontent> <xsd:extension base= ServiceDomain > <xsd:element name= website type= ApacheWebsite minoccurs= 0 /> </xsd:extension> </xsd:complexcontent> <xsd:complextype name= ApacheWebsite > <xsd:element name= rootdirectorypath type= xsd:normalizedstring minoccurs= 0 /> <xsd:element name= frontpage type= ApacheFrontPage minoccurs= 0 /> <xsd:group ref= ApacheWebSiteContent /> XML schema: Element/Attribute Default Value Available Description name 2.7 Domain name, subdomain name or the wildcard subdomain name. 138 See also the Customer Services on Subdomains section (on page 54). Wildcard subdomain name should be formed as *.<parent_domain>. attribute should be defined as <parent_domain>. website * 2.7 Defines a website. rootdirectorypath * 2.7 Path to the root of a website (relative to the entire webspace). If it is missing, the IDN form of a domain name will be used. frontpage * 2.7 Enables FrontPage extension for a certain website. See the Content Management Tools subsection in the Webspace Configuration section (on page 128). Restriction: FrontPage extension on a website can t be activated if it is already activated on the entire webspace.

139 Element/Attribute Default Value Available Description httpcontentid * 2.7 Defines a reference to website content (accessed by HTTP). httpscontentid * 2.7 Defines a reference to website content (accessed by HTTPS). scriptcontentid * 2.7 Defines a reference to the website CGI-BIN directory. See also the description for the rootdirectorypath * false 2.7 Ignores a website root directory and places CGI-scripts in the root of cgi-bin directory. <domain> <name>mydomain.com</name> <website> <rootdirectorypath>/my_domain</rootdirectorypath> <httpcontentid>site::mydomain.com</httpcontentid> <scriptcontentid>scripts::mydomain.com</scriptcontentid> </website> </domain> Example: 139

140 Content Migration Manager supports two strategies of Apache websites content migration: 1 All websites are migrated at once inside the webspace archives. In this case, the Migration Agent should explicitly define the rootdirectorypath element for all websites. 2 Each website is migrated in a separate archive. 140 Note: In this case, some items can be migrated only as a webspace content because they will be addressed via instant access URL:. Webspace content is splitted on 5 parts: Documents accessed by HTTP protocol (document's root is the vhost/<uniqid>/webspace/httpdocs/ directory). Documents accessed by HTTPS protocol (document's root is the vhost/<uniqid>/webspace/httpsdocs/ directory). CGI-scripts (scripts root directory: vhost/<uniqid>/webspace/cgi-bin/). CA certificate. Self-signed certificate. Note: CA certificates and Self-signed certificates can be migrated only if the SSL support is activated and the webspace is provided on the exclusive IP address. Certificates. Custom certificates: public and private parts should be stored by a Migration Agent as a single file (not in a Tarball archive). A webspace may include zero or more websites. Website content is splitted on 3 parts: Documents accessed by HTTP protocol (placed under the vhost/<uniqid>/webspace/httpdocs/ directory). Documents accessed by HTTPS protocol (placed under the vhost/<uniqid>/webspace/httpsdocs/ directory). CGI-scripts (placed under the vhost/<uniqid>/webspace/cgi-bin/) Migration Agent is responsible for splitting a source website on two or three parts. Each part should be delivered as Tarball archive. The Tarball archive name should have the.tar extension. Migration Agent is responsible for excluding the following files or/and directories from a Tarball archive:.htaccess

141 .htpasswd _vti* (all FrontPage directories) The sample of the archive with a website content: $ tar tf content_4353.tar././index.html./about.html./images/./images/photo.png The sample of archive with CGI-scripts: $ tar tf content_4332.tar././test.cgi./counter.cgi 141

142 C HAPTER 8 Migration Agents Development In This Chapter Overview Agents Manifest Developing Agent for Linux-based Source System Developing Agent for Windows-based Source System Overview Migration Agents are divided into two types: custom and native. The latter type is developed by Parallels Operations Automation. The agent package consists of two parts: the Tarball with all agents files named agent.tar and the manifest file with meta-info about the agent named agent.manifest. When the agent is being registered in the Migration Manager, the following actions are performed: 1 Migration Manager looks for agents files (the Tarball and manifest) in the user-specified directory. 2 Migration Manager parses the agent's manifest, validates it and stores info about the agent into DB. In case of error on any registration step, the whole transaction is safely rolled back. Unlike native agents the custom agents are not distributed in PPM packages. That s why they cannot be deployed using POA package manager. To register the custom agent, find instructions in the Appendix F (on page 175) (Registering Custom Migration Agent in POA). Agents Manifest The Agent manifest is an XML document.

143 Migration Agents Development Root Element and XML Namespaces The table below contains the target namespace and namespaces required for XML parser to validate XML document (see the XML sample below). Namespace xmlns= xmlns:xsi= xsi:schemalocation= AgentManifest.xsd XML schema below defines the manifest element as the root element of the agent manifest XML document (see the AgentManifest.xsd). <?xml version="1.0" encoding="utf-8"?> <xsd:schema xmlns=" xmlns:xsd=" targetnamespace=" elementformdefault="qualified" attributeformdefault="unqualified"> XML schema: <xsd:simpletype name="sourcesystemname"> <xsd:restriction base="xsd:token"> <xsd:maxlength value="128"/> <xsd:pattern value="[a-za-z]{1}[a-za-z0-9\._]*[a-za-z0-9]{1}"/> </xsd:restriction> </xsd:simpletype> <xsd:simpletype name="version"> <xsd:restriction base="xsd:token"> <xsd:maxlength value="128"/> <xsd:pattern value="[0-9]+\.[0-9]+\.[0-9]+"/> </xsd:restriction> </xsd:simpletype> <xsd:complextype name="connectionsettings"> <xsd:choice> <xsd:element name="ssh" type="sshconnectionsettings"/> <xsd:element name="webservice"/> </xsd:choice> <xsd:simpletype name="readme"> <xsd:restriction base="xsd:string"> <xsd:maxlength value="512"/> </xsd:restriction> </xsd:simpletype> <xsd:complextype name="migrationagent"> <xsd:element name="sourcesystem" type="sourcesystemname"/> <xsd:element name="version" type="version"/> <xsd:element name="connectionsettings" type="connectionsettings"/> <xsd:element name="features" type="agentfeatures" minoccurs="0"/> <xsd:element name="platformtransformation" type="xsd:string" minoccurs="0"/> <xsd:element name="accounttransformation" type="xsd:string" minoccurs="0"/> <xsd:element name="servicestransformation" type="xsd:string" minoccurs="0"/> <xsd:element name="readme" type="readme" minoccurs="0"/> 143

144 Migration Agents Development <xsd:element name="migrationagent" type="migrationagent"/> </xsd:schema> Element/Attribute Default Value Available Description sourcesystem 2.8 Source system name. The value of this element will be used as Migration Agent unique identifier. version 2.8 Agent s version. connectionsettings 2.8 Connection settings using for communicating with the Migration Agent on the source server. Child of this node depends on the connection type. 144 Supported connection types are: ssh or webservice. ssh 2.8 Indicates that SSH protocol should be used to communicate with the agent. See the SSH Connection Settings section (on page 145). webservice 2.8 Indicates that the agent should be deployed and accessed as a web-service. features * 2.8 Agent s features description. See the Agent s Features section (on page 145). platformtransformation * 2.8 XSL transformation to apply to Platform XML documents before process them (see the Platform XSLT section (on page 178)). accounttransformation * 2.8 XSL transformation to apply to Account XML documents before process them (see the Account XSLT section (on page 178)). servicestransformation * 2.8 XSL transformation to apply to Services XML documents before process them (see the Services XSLT section (on page 178)). readme * 2.8 Reserved but not supported yet. <?xml version="1.0" encoding="utf-8"?> <migrationagent xmlns=" xmlns:xsi=" xsi:schemalocation= " AgentManifest.xsd"> <sourcesystem>samplesourcesystem</sourcesystem> <version>1.1.8</version> <connectionsettings> <ssh> <executable>agent.pl</executable> </ssh> </connectionsettings> <features> <disablesubscriptions>true</disablesubscriptions> </features> </migrationagent> Example:

145 Migration Agents Development Agent's Features XML schema: <xsd:complextype name="agentfeatures"> <xsd:element name="disablesubscriptions" type="xsd:boolean" minoccurs="0" default="false"/> Element/Attribute Default Value Available Description disablesubscriptions * false 2.8 Indicates whether the agent can disable original Subscriptions on the source system after migrating them to the system. SSH Connection Settings <xsd:simpletype name="relativepath"> <xsd:restriction base="xsd:normalizedstring"> <xsd:maxlength value="256"/> </xsd:restriction> </xsd:simpletype> <xsd:complextype name="sshconnectionsettings"> <xsd:element name="executable" type="relativepath"/> XML schema: Element/Attribute Default Value Available Description executable 2.8 Path to the Migration Agent executable file. 145

146 Migration Agents Development Developing Agent for Linux-based Source System Overview Migration Agent for Linux-based source system is a set of files. When Migration Manager installs the agent on the source system, it just unpacks the Tarball to some directory on a source system. When MM needs to call the agent, it executes the file specified as agent s executable (see the Agents Manifest section (on page 142) for details), which must have executable permission bit for owner set. Command Line Interface Migration Agent execution should provide the following command-line interface: Argument --extract=what --disable=what --account-id=id --subscription-id=id --content-id=id --id=id --file=file Description Extracts information from the source system: platform get source system XML document. account get account XML document (--account-id must be specified). services get services XML (--subscription-id must be specified). content collect content (--subscription-id and --content-id must be specified). Disables some entity on the source system, for example: Subscription disable Subscription on original system after it was migrated. This may be not implemented if the disablesubscriptions agent feature is not declared (see the Agent s Features section (on page 145) for details). Subscription ID must be specified using the --id parameter Specifies an ID of the corresponding entity. Specifies an ID. Specifies output file. If this argument is omitted, the stdout should be used. 146

147 Migration Agents Development Developing Agent for Windows-based Source System Migration Framework Service Interface Migration Framework service exports the Web Service interface, which is used by Migration Manager for communication with agents. Interface methods and structures are described below. enum Status {OK, FAILED, WARNING} ArchiveInfo { string accessurl; int size; // size in KB } ErrorInfo { Status status; string errorcode; // unified error/warning code string message; // error/warning message } CollectResult { ErrorInfo errstatus; ArchiveInfo archiveinfo; } // Invokes agent module registration and deployment. // Module is passed as base64 encoded raw binary data. ErrorInfo installagent(string platformid, string rawdata) // Invokes upgrade of the registered agent module. // Module is passed as base64 encoded raw binary data. ErrorInfo upgradeagent(string platformid, string rawdata) // Invokes agent module removal and unregistering. ErrorInfo uninstallagent(string platformid) // Collect platform info and publish it. // Returns status (succeeded, failed) and URL of the archive. CollectResult getplatform(string platformid) // Collect info about services for the specified subscription and // publish it. // Returns status (succeeded, failed) and URL of the archive. CollectResult getservices( string subscriptionid, string platformid) // Collect content by ID. Returns status and archive info. CollectResult getcontent( string subscriptionid, string contentid, 147

148 Migration Agents Development string platformid) // Disable subscriptions on source platform. ErrorInfo disablesubscription( string subscriptionid, string platformid) // Remove file created earlier during info collecting // fileurl - URL to the file to remove (URL from ArchiveInfo) ErrorInfo removefile(string fileurl) AgentModule Interface Migration Agents for Windows are implemented as.net assemblies. Each agent must implement methods of the following interface: // reserved, not used currently ResponsibilityInfo { string moduleid; // usually contains platform name } // DataSource is a structure that represents info storage // It is defined in the AgentModule SDK assembly interface AgentModule { // reserved, not used currently (no need of implementation) ResponsibilityInfo getresponsibilityinfo(); // returns DataSource for the platform info XML DataSource getplatform(); // acountid external ID of the source system account // returns DataSource for the account info XML DataSource getaccount( string accountid); // subscriptionid external ID of the source system subscription // returns DataSource for the services info XML DataSource getservices( string subscriptionid); // subscriptionid - external ID of the source system subscription // contentid - ID of the content // returns ContentDataSource for the content archive DataSource getcontent( string subscriptionid, string contentid); // disables subscriptions (on the source system) with IDs // specified // method is optional (if agent does not support this method an // exception should be thrown when the method is called) void disablesubscription( string subscriptionid); } 148

149 Linux-Based Hosting: List of Supported Features by Migration Manager A PPENDIX A Linux-Based Hosting: List of Supported Features by Migration Manager Note: Features listed in this section are provided by Migration API version 1.0 only. Feature Migrated objects Properties Comments Domain parking Single page-based parking (a.k.a. onepage website) Parking with URLforwarding Parking with vendor s URL forwarding One-page website is the service where customer can have a website on his parked domain but with only one page. DNS DNS zone Custom DNS records DNS zone: owner zone-specific parameters: expiration time, min. TTL, refresh period, retry period Custom DNS records: A-records CNAME-records NS-records MX-records

150 Linux-Based Hosting: List of Supported Features by Migration Manager Feature Migrated objects Properties Comments Mail (qmail with clustering support) Mailboxes Mail groups Mail lists Auto responders AntiVirus/AntiSpam configurations Mail boxes and groups: on-all-domains option mailbox quota mail forwarding to several addresses (enable/disable flag on all group) Mail groups: mailbox quota is ignored, because physically mail box isn t exist Catch-all configuration Mail lists: Mail lists: on-all-domains option sender s address password AntiSpam feature not available Archives aren t migrated password for approving information message introduction message access levels: open list closed list of owner addresses list of member addresses list of approver addresses Auto responder: action triggers: always filter body filter subject responder s subject and message body reply-to field customization address for forwarding to enable/disable flag on particular auto responder AntiVirus: scan incoming mail (on/off) scan outgoing mail (on/off) send notification about

151 Linux-Based Hosting: List of Supported Features by Migration Manager Feature Migrated objects Properties Comments FTP (ProFTPD-based hosting) FTP service on shared IP-address FTP service on exclusive IP-address Custom FTP-users Content (files accessed through FTP)

152 Linux-Based Hosting: List of Supported Features by Migration Manager Feature Migrated objects Properties Comments Web (Apache-based hosting) WWW-service on shared IP-address WWW-service on exclusive IP-address Error Messages: error code actions: off Error Messages: several error codes may be specified SSL extension default message file CGI extension url SSI extension WAP extension PHP extension Web statistics Mime-Types: mime type identifier (string) list of extensions FrontPage extension Customized Handlers: Add-On domains list of extensions actions: Sub domains send-as-is cgi-script Error Messages customization imap-file server-info MIME-Type customization server-parsed server-status map-type Custom action handlers List of blocked IPaddresses Hotlinks Protected directories Hotlinks: redirect URL list of allowed URLs list of denied extensions Content (files accessed through Web-service) Protected directories: directory name textual description SSL (on/off) list of users (login/password )

153 Linux-Based Hosting: List of Supported Features by Migration Manager Feature Migrated objects Properties Comments Databases MySQL PostgreSQL Custom database users List of access hosts Content of databases Log Manager File Manager Credentials: login password Old statistics isn t migrated. Access to entire web space through special Webapplication

154

155 Windows-Based Hosting: List of Supported Features by Migration Manager A PPENDIX B Windows-Based Hosting: List of Supported Features by Migration Manager Note: Features listed in the table below are provided by Migration API version 2.0 only. Feature Migrated objects Properties Comments Hosted Service Users Logon credentials Contact information Logon credentials: login/password display name See [1] and [2] for more information. Domain Parking parked domains web page content for Single Page Parking URL customization for standardand frame-forwarding modes.

156 Windows-Based Hosting: List of Supported Features by Migration Manager Feature Migrated objects Properties Comments IIS (physical hosting) web space websites virtual directories content Web space: application pool: shared exclusive list of extensions: ASP ASP.NET ASP.NET2 SSI PHP (version 5) ActivePerl ColdFusion (version6 or 7) ISAPIRewrite error handling MIME types default documents content management: FrontPage FTP access File Manager performance options: max. connections max. bandwidth connection timeout keep alive option for connection Websites: IP address: shared exclusive virtual directories (physical hosting or redirect) permissions on root directory and per-virtual directory authorization methods ( basic, digest or windows ) on root directory and per-virtual directory FrontPage extension per website See [1] and [2] for more information.

157 Windows-Based Hosting: List of Supported Features by Migration Manager Feature Migrated objects Properties Comments Exchange (mail hosting) Exchange 2000/2003: Mail Boxes Distribution Lists Contacts Public Folders Mail Box Content Public Folder Content Mailboxes: primary address and aliases quota size limits (warning limit, max item size etc.) protocols (OWA, POP3, IMAP4, MAPI and ActiveSync) forwarding for incoming messages to single address show/hide in address book option Distribution Lists: primary address and aliases list members security configuration (membership visibility option and mail acceptance rule) display name show/hide in address book option Contacts: target address display name show/hide in address book option contact details Public Folders: name quota size type: Mail, Contact, Appointment, Note, Task and Journal permissions limits (warning limit, max item size limit) show/hide in address book option

158 Windows-Based Hosting: List of Supported Features by Migration Manager Feature Migrated objects Properties Comments DNS (domain hosting) DNS zone Custom DNS records DNS zone: owner zone-specific parameters: expiration time, min. TTL, refresh period, retry period Custom DNS records: A-records CNAME-records NS-records MX-records Databases MySQL 3.x-4.x customer databases PostgreSQL 7.x- 8.x customer databases MS SQL 7/2000/2005 customer databases Database Users Content MySQL/PostgreSQL customer databases: database users content access host list MS SQL customer databases: database users content

159 Deploying Migration Framework A P PENDIX C Deploying Migration Framework POA Migration Framework is distributed as an MSI script (pkg/migrationframework/installer_migfrm.msi) inside POA Migration product. 1 Install the Framework on the Management Node of a source system, which is going to be migrated in POA. Note: If you are going to use domain account (not the local one) for migration the running service/website, you must run installation under the account with the Domain Administrator privileges (not the Local Administrator).

160 Deploying Migration Framework Click Next. 2 Browse the destination folder or use the default (recommended).

161 Deploying Migration Framework Click Next to continue. 3 Choose the type of the web service installation. Note: IIS installation type will not be available if IIS (minimum version is 6.0) with WWW service and ASP.NET components is not installed.

162 Deploying Migration Framework click Next button. 4 Select an IP address and TCP port (it is recommended to use the default value).

163 Deploying Migration Framework Click the Next button. 5 Specify credentials for Migration Framework service. It is recommended to use an account from the Local Administrators group or from the Domain Administrators group. Enter the User Name with Windows domain name (for a local user choose a computer name as a domain name) and enter the password. Click the Next button.

164 Deploying Migration Framework 6 Click Install.

165 7 Click Finish. Deploying Migration Framework

166 Deploying Migration Framework Known Issues Error occurs during platform registration. Precondition: Agent uses Jet Text CSV database source. Synopsis: The following error occurs during the platform registration: Migration agent failed while executing command getplatformxml with error code #ErrorDuringPlatformInfoCollecting: No value given for one or more required parameters Resolution: The reason of this error may be a wrong delimiter that is used for Jet Text sources. Ensure that the registry value HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Jet\4.0\Engines\Text\Format is CSVDelimited. Error occurs during attempt to communicate with Migration Framework Symptom: When trying to load the page (locally from server where Migration Framework is installed) name>:9091/ccws.asmx the following error is shown: Configuration Error Description: An error occurred during the processing of a configuration file required to service this request. Please review the specific error details below and modify your configuration file appropriately. Parser Error Message: It is an error to use a section registered as allowdefinition='machineonly' beyond machine.config. Source Error: Line 54: running under AppPool identity account. Line 55: --> Line 56: <identity impersonate="false" username="" password=""/> Line 57: Line 58: <authorization> Cause: ISP has changed the 'allowdefinition' attribute of the section to MachineOnly value in the machine.config file. Resolution: Edit the C:\WINDOWS\Microsoft.NET\Framework\v \CONFIG\machine.config file.

167 Find the 'section' tag with name="identity" and set its allowdefinition attribute to "MachineToApplication". Deploying Migration Framework

168

169 Exchange Migration: Preparing, Configuration and Post-Migration Steps A PPENDIX D Exchange Migration: Preparing, Configuration and Post-Migration Steps Configuring Source Exchange Servers The migration of Exchange service is performed using the Microsoft Exchange Mailbox Merge program (Exmerge.exe). For additional information about this utility, refer to and To configure the source Exchange servers for migration, it is necessary to perform the following steps: Install the Parallels Operations Automation Migration Framework on the source server (on the host that will be specified in the agent registration form). Delegate the Exchange Full Administrator role and grant full access to Exchange Mailbox Storage to the account which the Migration Framework service will run under (further referred to as Account). Install the Microsoft Exchange Mailbox Merge Program (Exmerge.exe) on each backend Exchange server. To delegate the Account the Exchange Full Administrator role, do the following: 1 Open Exchange System Manager (Start -> All Programs -> Microsoft Exchange -> System Manager). 2 Right-click on the Exchange organization name (the top menu item) and select Delegate control. The Exchange Administration Delegation Wizard opens. Click Next. 3 On the next screen of the wizard, click Add. 4 From the Role list, select the Exchange Full Administrator role. 5 Near the Group or User field, click Browse. On the screen that opens, enter the Account name. Click OK. You can also locate the Account in the list of existing users, computers and groups (click Advanced > Account name > OK). 6 Click OK on the Delegate Control screen. 7 Back in the Exchange Administration Delegation Wizard, click Next and then click Finish. To grant the Account full access to the Mailbox Storage, perform these steps:

170 Exchange Migration: Preparing, Configuration and Post-Migration Steps 1 Open Exchange System Manager and go to Administrative Groups -> First Administrative Group -> Servers -> Source back-end server name -> Source Storage Group. 2 Right-click on the Mailbox Store belonging to the Group and select Properties. 3 Go to the Security tab. 4 From the Group or user names list, select the group the Account belongs to (e.g. Domain Admins, as Account must be a member of this group). In the Permissions for Administrator list in the lower part of the screen, make sure that the Full control permission is allowed (the Allow checkbox is selected, and the Deny checkbox is cleared). Click OK. If this permission is denied (the Deny option is selected) do the following: a Click Advanced. b On the Permissions tab, in the Permissions Entries list, find the Deny entry for Full control permission for the Domain Admins group. Click on the Edit button. c Select the Allow checkbox box next to the Full control permission. d Click OK. If the required group is not in the list, click Add and enter the group name (or use the Advanced button to locate the group) and then click OK. 5 Repeat Steps 1-3 for Mailbox Stores belonging to each back-end Exchange server. To install the Microsoft Exmerge tool on your back-end Exchange servers, perform these steps: 1 Download the Exmerge archive from DCDF-47DC-96DA-1C12D67327D5. 2 Unpack and place the Exmerge.exe file into the <Exchange directory>\bin directory (typically C:\Program Files\Exchsrvr\bin) of each back-end Exchange server. Configuring POA Hosted Exchange Servers Make sure that the pem_admin account has Send As and Receive As permissions on target POA Mailbox Stores: 1 Open Exchange System Manager (Start -> All Programs -> Microsoft Exchange -> System Manager). 2 Go to Administrative Groups -> First Administrative Group -> Servers -> Back-end server -> Storage Group. 3 Right-click on the Mailbox Store belonging to the group and select Properties. 4 Go to the Security tab. 5 From the Group or user names list, select the pem_admin account.

171 Exchange Migration: Preparing, Configuration and Post-Migration Steps 6 In the Permissions for Administrator list in the lower part of the screen, make sure that the Send As and Receive As permissions are not denied for this account (the Allow checkbox for these permissions is selected, and the Deny checkbox is cleared). If the permissions are denied (the Deny option is selected), do the following: a Click Advanced. b On the Permissions tab, in the Permissions Entries list, find the Deny entry for Send As permission of the pem_admin account. Click on the Edit button. c Select the Allow checkbox box next to the Send As and Receive As permissions. d Click OK. 7 Click OK on the Mailbox Store Properties screen. 8 Repeat Steps 2-7 for each target POA Mailbox Store. Grant full access to the Public Folder Store for the Domain Admins group: 1 Open Exchange System Manager (Start -> All Programs -> Microsoft Exchange -> System Manager). 2 Go to Administrative Groups -> First Administrative Group -> Servers -> Back-end server name -> Storage Group. 3 Right-click on the Public Folder Store and select Properties. 4 Go to the Security tab. 5 From the Group or user names list, select Domain Admins. 6 Make sure that the Full control option in the Permissions list is selected (the Allow checkbox is selected, and the Deny checkbox is cleared). If not, perform Step 6 of the procedure above. Repeat Steps 1-6 for each back-end Exchange server. Post-Migration Steps After the migration is finished, revoke the Send As and Receive As permissions on target Mailbox Stores from the pem_admin account: 1 Open Exchange System Manager (Start -> All Programs -> Microsoft Exchange -> System Manager). 2 Go to Administrative Groups -> First Administrative Group -> Servers -> Back-end server -> Storage Group. 3 Right-click on the Mailbox Store belonging to the group and select Properties. 4 Go to the Security tab. 5 From the Group or user names list, select the pem_admin account. 6 Click Advanced at the bottom of the screen.

172 Exchange Migration: Preparing, Configuration and Post-Migration Steps 7 In the Permission entries list, select the Allow operations for Send As and Receive As permissions set for the pem_admin account. Hold the CTRL key to select several operations at once. 8 Click Remove to revoke the permissions. 9 Click on OK on the current screen, and then on the next screen. 10 Repeat Steps 2-8 for each target Mailbox Store. Revoke full access permission to Public Folder Store from the Domain Admins group on each Exchange back-end server by performing a similar procedure. Remove the Exmerge.exe file from the <Exchange directory>\bin directories on back-end Exchange hosts.

173 Preparing for MS SQL Migration A PPENDIX E Preparing for MS SQL Migration Download Microsoft SQL Server 2005 Backward Compatibility Components (Feature Pack for Microsoft SQL Server November 2005) ( and install it on the host with the Migration Agent. Install POA PPM package other-win <arch>-sqldmo-<version> on each POA node with POA PPM package service-win <arch>-mssql-<version> installed.

174

175 Registering/Upgrading/Unregistering Custom Migration Agent in POA A PPENDIX F Registering/Upgrading/Unregistering Custom Migration Agent in POA To register custom migration agent in POA, do the following: 1 Upload the agent.tar and agent.manifest files to the POA management node and place them both in one directory (it is strongly recommended to create separate directory for each custom agent). 2 Log in to POA MN via SSH or RDP (in case of Win MN). Execute the following command: $ $PLESK_ROOT/bin/mm_ctl -f $PLESK_ROOT/etc/pleskd.props agent registercustom <agent-path> Where $PLESK_ROOT is a path to the directory where POA is installed, and <agent-path> is the absolute path (without ending slash/backslash) to the directory with agent.tar and agent.manifest files. To upgrade custom migration agent registered earlier, do the following: 1 Upload the agent.tar and agent.manifest files to the POA management node and place them both in one directory (it is strongly recommended to create separate directory for each custom agent version). 2 Log in to POA MN via SSH or RDP (in case of Win MN). 3 Execute the following command: $ $PLESK_ROOT/bin/mm_ctl -f $PLESK_ROOT/etc/pleskd.props agent upgradecustom <agent_id> <agent-path> Where $PLESK_ROOT is a path to the the directory where POA is installed, the <agent_id> is the agent identifier obtained during agent registration (can be seen in POA PCP at Top > System Director > Migration Manager > Agents as internal ID) and the <agent-path> is the absolute path (without ending slash/backslash) to the directory with agent.tar and agent.manifest files. To unregister custom migration agent registered earlier, do the following: 1 Log in to POA MN via SSH or RDP (in case of Win MN). 2 Execute the following command:

176 Registering/Upgrading/Unregistering Custom Migration Agent in POA $ $PLESK_ROOT/bin/mm_ctl -f $PLESK_ROOT/etc/pleskd.props agent upgradecustom <agent_id> Where $PLESK_ROOT is a path to the directory where POA is installed, the <agent_id> is the agent identifier obtained during agent registration (can be seen in POA PCP at Top > System Director > Migration Manager > Agents as internal ID) and the <agent-path> is the absolute path (without ending slash/backslash) to directory with agent.tar and agent.manifest files. Note: Internal identifiers are hidden by default. To make them visible in POA PCP go to Top > System Director > Migration Manager > Settings > Control Panel settings and set Show internal identifiers option to Visible.

177 Sample XSL Transformation Instructions A PPENDIX G Sample XSL Transformation Instructions In This Appendix Platform XSLT Account XSLT Services XSLT...178

178 Sample XSL Transformation Instructions Platform XSLT The following transformation instruction drops the domainregsubscription nodes from Platform XML: <?xml version="1.0" encoding="utf-8"?> <xsl:stylesheet xmlns=" xmlns:xsl=" xmlns:xsi=" version="1.0" >  <xsl:output method="xml" indent="yes" encoding="utf-8" /> <xsl:strip-space elements="*"/> <xsl:template node()"> <xsl:copy> <xsl:apply-templates node()" /> </xsl:copy> </xsl:template>  <xsl:template match="domainregsubscription"/> </xsl:stylesheet> Account XSLT The following transformation instruction sets zipcode value to '12345': <?xml version="1.0" encoding="utf-8"?> <xsl:stylesheet xmlns=" xmlns:xsl=" xmlns:xsi=" version="1.0" >  <xsl:output method="xml" indent="yes" encoding="utf-8" /> <xsl:strip-space elements="*"/> <xsl:template node()"> <xsl:copy> <xsl:apply-templates node()" /> </xsl:copy> </xsl:template>  <xsl:template match="zipcode"> <zipcode>12345</zipcode> </xsl:template> </xsl:stylesheet> Services XSLT The following transformation instruction removes the qmail node from Services XML: <?xml version="1.0" encoding="utf-8"?> <xsl:stylesheet

179 xmlns=" xmlns:xsl=" xmlns:xsi=" version="1.0" >  <xsl:output method="xml" indent="yes" encoding="utf-8" /> <xsl:strip-space elements="*"/> <xsl:template node()"> <xsl:copy> <xsl:apply-templates node()" /> </xsl:copy> </xsl:template>  <xsl:template match="qmail"/> </xsl:stylesheet> Sample XSL Transformation Instructions

180

181 Using Action Scripts A PPENDIX H Using Action Scripts Migration Manager is able to execute action scripts during migration of Accounts, Subscriptions, and content. These scripts can be used to perform additional actions during migration, for example: sending the notification messages, updating content of the migrated Webspaces, and so on. Scripts are executed on the POA Management Node. The table below provides the detailed information about the supported action scripts and their input parameters. Script Name Description Script Parameters accountstarting accountfinished accountfailed This script is executed before the migration of Account. This script is executed after the migration of Account. This script is executed when the migration of Account is failed. MM_PLATFORM_ID - ID of source platform. MM_PLATFORM_NAME - Name of source platform. MM_ACCOUNT_ID - Account ID in the source platform. POA_ACCOUNT_ID - Account ID in POA. MM_PLATFORM_ID - ID of source platform. MM_PLATFORM_NAME - Name of source platform. MM_ACCOUNT_ID - Account ID in the source platform. POA_ACCOUNT_ID - Account ID in POA. MM_PLATFORM_ID - ID of source platform. MM_PLATFORM_NAME - Name of source platform. MM_ACCOUNT_ID - Account ID in the source platform. ERROR_MESSAGE - Error message that contains a reason of problem. POA_ACCOUNT_ID - Account ID in POA.

182 Using Action Scripts subscriptionstarting subscriptionfinished subscriptionfailed This script is executed before the migration of Subscription. This script is executed after the migration of Subscription. This script is executed when the migration of Subscription is failed. MM_PLATFORM_ID - ID of source platform. MM_PLATFORM_NAME - Name of source platform. MM_SUBSCRIPTION_ID - Subscription ID in the source platform. POA_SUBSCRIPTION_ID - Subscription ID in POA. MM_PLATFORM_ID - ID of source platform. MM_PLATFORM_NAME - Name of source platform. MM_SUBSCRIPTION_ID - Subscription ID in the source platform. POA_SUBSCRIPTION_ID - Subscription ID in POA. MM_PLATFORM_ID - ID of source platform. MM_PLATFORM_NAME - Name of source platform. MM_SUBSCRIPTION_ID - Subscription ID in the source platform. ERROR_MESSAGE - Error message that contains a reason of problem. POA_SUBSCRIPTION_ID - Subscription ID in POA.

183 Using Action Scripts contentstarting contentfinished This script is executed before the migration of content. This script is executed after the migration of content. MM_PLATFORM_ID - ID of source platform. MM_PLATFORM_NAME - Name of source platform. POA_SUBSCRIPTION_ID - Subscription ID in POA. MM_CONTENT_ID - Content ID in the source platform. CONTENT_OWNER_ID - Content owner's ID in the source platform. CONTENT_OPERATION - Operation type. There are the following options: collect - Content is collected in the source platform. deliver - Content is delivered from the source platform to POA. restore - Content is placed on the POA servers. MM_PLATFORM_ID - ID of source platform. MM_PLATFORM_NAME - Name of source platform. POA_SUBSCRIPTION_ID - Subscription ID in POA. MM_CONTENT_ID - Content ID in the source platform. CONTENT_OWNER_ID - Content owner's ID in the source platform. CONTENT_OPERATION - Operation type. There are the following options: collect - Content is collected in the source platform. deliver - Content is delivered from the source platform to POA. restore - Content is placed on the POA servers. Note: In this case a value of the CONTENT_OPERATION parameter is the restore.

184 Using Action Scripts contentfailed This script is executed when the migration of content is failed. MM_PLATFORM_ID - ID of source platform. MM_PLATFORM_NAME - Name of source platform. POA_SUBSCRIPTION_ID - Subscription ID in POA. MM_CONTENT_ID - Content ID in the source platform. CONTENT_OWNER_ID - Content owner's ID in the source platform. CONTENT_OPERATION - Operation type. There are the following options: collect - Content is collected in the source platform. deliver - Content is delivered from the source platform to POA. restore - Content is placed on the POA servers. ERROR_MESSAGE - Error message that contains a reason of problem. The action scripts should be placed on the POA Management Node, in the POA_INSTALLATION_DIRECTORY/share/migration2/customActions/ directory (POA_INSTALLATION_DIRECTORY is /usr/local/pem/ on Linux or C:\Program Files\SWsoft\PEM\ on Windows). For Linux-based Management Node the action script should use the.sh extension and for Windows-based Management Node the actions scripts should use the.bat extension. Notes: 1. The POA_INSTALLATION_DIRECTORY/share/migration2/customActions/ directory contains the templates of the action scripts (files having the.tmpl extension). 2. In the action scripts the positional arguments are used. The values of the input parameters are passed from Migration Manager to the scripts in the predefined order. The names of the input parameters are not passed by Migration Manager. 3. If action script fails, migration is aborted.

185 Index Index ' 'Account' Element - 36, 40 A Account XML - 38 Account XSLT ' 'AccountAttributes' Attribute Group - 34 A Accounts and Subscriptions Migration - 20 Accounts Verification - 19 ' 'AccountType' Data Type - 29 A Acronyms and Abbreviations - 9 ' 'Address' Data Type - 44 A AgentModule Interface Agent's Features Agents Manifest Apache ' 'BillingInfo' Data Type - 45 C Catching Unresolved Mail Command Line Interface Common Types Used in XML Documents - 27 ' 'CompanyName' Data Type - 34 C Complete Sample - 61, 79 Contact Information Structure - 57 ' 'ContactInfo' Data Type - 42 C Content - 78, 107, 123, 140 Content Management - 68 Content Publishing (Migration) - 22 ' 'CreditCard' Data Type - 46 C Customer Services on Subdomains - 54 D Database Configuration Database Users Databases Definitions - 10 Definitions, Acronyms, and Abbreviations - 9 Deploying Migration Framework Developing Agent for Linux-based Source System Developing Agent for Windows-based Source System ' 'DisableState' Attribute Group - 28 D DNS - 97 Documentation Conventions - 6 Domain Parking - 62 ' 'Domains' Data Type - 28

186 Index D DSN Migration Support ' ' Address' Data Type - 27 E Exchange Migration Preparing, Configuration and Post- Migration Steps ' 'ExpirationDate' Data Type - 47 E External Service Template - 13 ' 'ExtIdentifier' Data Type - 27 F Feedback - 8 G General Conventions - 8 Generic Structure - 56, 81, 102, 107, 111 H Hosted Service Users - 56 ' 'HostingSubscription', 'DomainRegSubscription' and 'ResourceSubscription' Data Types - 32 I Introduction - 9 L Linux-Based Hosting List of Supported Features by Migration Manager M Management Node - 12 Mapping External Service Template to Parallels Operations Automation Service Templates and/or Parallels Business Automation Service Plans - 13 ' 'Members' Data Type - 48 M Microsoft Access DSN Migration Support Microsoft Exchange - 81 Microsoft Exchange Contact Configuration - 88 Microsoft Exchange Distribution List Configuration - 90 Microsoft Exchange Mailbox Configuration - 83 Microsoft Exchange Public Folder Configuration - 93 Microsoft IIS - 64 Migrated Objects in XML Form - 27 Migration Agent - 14 Migration Agents Development Migration Flows - 18 Migration Framework Service Interface Migration Manager - 14 O Objects - 11 Overview - 142, 146 P Parallels Business Automation - 12 Parallels Operations Automation - 12 ' 'Password' Data Type - 49 'PaymentSystem' Data Type - 47 'PaymentTools' Data Type - 45 'Phone' Data Type - 43 P Platform XSLT Preface - 6 Preparing for MS SQL Migration Pure DSN - 107

187 Index Q Qmail Qmail Mail List Configuration Qmail Mailbox Configuration R Records References - 10 Registering/Upgrading/Unregistering Custom Migration Agent in POA Root Element and XML Namespaces - 35, 38, 52, 143 S Sample XSL Transformation Instructions Service Node - 12 Service Plan - 12 Service Template - 12 Services XML - 52 Services XSLT ' 'ServiceTemplates' Data Type - 30 S Source Server - 13 Source Server Registration - 19 Source System - 13 Source System (Platform) XML - 35 SSH Connection Settings ' 'SubscriptionExFields' Data Type - 51 'SubscriptionsEx' Data Type - 50 S System Requirements - 26 T Typographical Conventions - 6 U Using Action Scripts V Verification Flow in Details - 22 Virtual Directories - 76 W Website Structure - 72 Websites Configuration Webspace Configuration Webspace Structure - 64, 125 Windows-Based Hosting List of Supported Features by Migration Manager Z Zone Configuration - 97