Organization of This Guide
Chapter 2, About Virtuozzo Templates, introduces you to the concept of Parallels Virtuozzo OS and application templates. Chapter 3, Creating Application Template, provides information on how to create your own application templates using the Virtuozzo Template Creation wizard. Chapter 4, Managing Templates, centers on all those operations you can perform on your application templates using Parallels Management Console and the Virtuozzo Template Creation wizard.
Documentation Conventions
Before you start using this guide, it is important to understand the documentation conventions used in it. For information on specialized terms used in the documentation, see the glossary at the end of this document. Typographical Conventions The following kinds of formatting in the text identify special information.

Formatting convention

Preformatted
Type of Information On-screen computer output in your command-line sessions; source code in XML, C++, or other programming languages. What you type, as contrasted with onscreen computer output. The names of commands, files, and directories. Designates a command line placeholder, which is to be replaced with a real name or value. All elements of the graphical user interface (GUI): menu items, menu options, menu buttons, etc. Titles of chapters, subsections. sections, and

Example

Saved parameters for Container 101

Preformatted Bold

C:\Documents and Settings\Administrator> vzlist
Moonscape Monospace Italics Special Bold
Use vzctl start to start a Container. To delete a Container, delete CT_ID. Go to the Resources tab. type vzctl
Read the Basic Administration chapter. Host Operating System is an operating system installed on the Hardware Node. SHIFT, CTRL, ALT CTRL+P, ALT+F4

Italics CAPITALS KEY+KEY

Used to emphasize the importance of a point or to introduce a term. Names of keys on the keyboard. Key combinations for which the user must press and hold down one key and then press another.
General Conventions Be aware of the following conventions used in this book. Chapters 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 (") and singlequotes (') exactly as shown.

Getting Help

In addition to this guide, there are a number of other resources shipped with Virtuozzo Containers 4.0 which can help you use the product more effectively. These resources include: Manuals: Parallels Virtuozzo Containers Evaluation Guide. This guide is destined to introduce you to the main features of Virtuozzo Containers 4.0 and to its underlying technology, to help you set up an environment for evaluating the Virtuozzo major features, and to suggest the relevant procedures for this evaluation. Parallels Virtuozzo Containers for Linux Installation Guide. This guide provides exhaustive information on the process of installing, configuring, and deploying your Virtuozzo system. As distinct from the given guide, it contains a more detailed description of all the operations needed to install and set Virtuozzo Containers 4.0 to work including planning the structure of your Virtuozzo network, performing the Virtuozzo Containers unattended installation, etc. Besides, it does not include the description of any Container-related operations. Parallels Virtuozzo Containers for Linux User's Guide. This guide provides comprehensive information on Virtuozzo Containers 4.0 covering the necessary theoretical conceptions as well as all practical aspects of working with Parallels Virtuozzo Containers. However, it does not deal with the process of installing and configuring your Parallels Virtuozzo system. Parallels Virtuozzo Containers for Linux Templates Management Guide. This guide is meant to provide complete information on Virtuozzo templates - an exclusive Parallels Virtuozzo technology allowing you to efficiently deploy standard Linux applications inside your Containers and to greatly save the Hardware Node resources (physical memory, disk space, etc.). Parallels Virtuozzo Containers for Linux Reference Guide. This guide is a complete reference on all Virtuozzo configuration files and Hardware Node command-line utilities. Help systems: Parallels Management Console Help. This help system provides detailed information on Parallels Management Console - a graphical user interface tool for managing Virtuozzo Hardware Nodes and their Containers. Parallels Infrastructure Manager Online Help. This help system shows you how to work with Parallels Infrastructure Manager - a tool providing you with the ability to manage Virtuozzo Hardware Nodes and their Containers with the help of a standard Web browser on any platform. Parallels Power Panel Online Help. This help system deals with Parallels Power Panel - a means for administering individual Containers through a common Web browser on any platform.

Understanding Templates Basics
The 'Virtuozzo Templates' technology provides a way of sharing resources among lots of Containers, thus, enabling huge savings in terms of disk space and memory. For example, when you install an OS or application template on the Hardware Node, Virtuozzo Containers 4.0 creates the X:\vz\Templates\<template_name> folder containing all template-related files (where X:\vz denotes the folder you specified during the Virtuozzo Containers installation for storing all Container data). Note: All basic OS templates (i.e. Windows Server 2003 with Service Pack 1 and Windows Server 2003 with Service Pack 2) are installed into the X:\vz\Templates\w2k3 folder irrespective of their names. When a Container based on the given OS template is created or the given application template is added to an existing Container, the Container contains only special links to real files in the X:\vz\Templates\<template_name> folder (for application and OS templates) and the system partition on the Node storing the Windows Server 2003 system files (for OS templates only). These links occupy very little space on the hard disk and are situated in the so-called private area of the Container (the corresponding folder is X:\vz\private\<Container_ID>). Along with links to the necessary OS or application files, the Container private area also contains the copy-on-write area. This area stores the information about those changes that the Container makes to the template files during its lifecycle and, therefore, is almost empty for all newly created Containers. When a Container is started, its private area is mounted as Virtuozzo File System (VZFS) to the X:\vz\private\<Container_ID>\root folder. This folder is seen as the root folder from within the Container. And, which is the pivot of it all, thanks to the VZFS, the links of the Container private area are seen as real files there. Note: The contents of the X:\vz\root\<Container_ID> and X:\vz\private\<Container_ID>\root folders can be accessed for running or mounted Containers only.

Template Lifecycle

Any template of any kind should be created first. You can create a template using the Virtuozzo Template Creation wizard. In addition, a number of already created templates are shipped by Parallels with Virtuozzo Containers 4.0. Note: The current version of Virtuozzo Containers allows you to create application templates only. Then, the template should be installed on the Hardware Node. You can install OS and application templates with the help of Parallels Management Console, Parallels Infrastructure Manager, or using the vzpkgdeploy -i command. The OS template that has been installed on the Hardware Node can be used as the basis for creating new Containers with the help of Parallels Management Console, Parallels Infrastructure Manager, or the vzctl create command. In their turn, any of the installed application templates can be added to any number of Containers using the same Virtuozzo tools or the vzpkgadd utility. Any application template may be modified according to your needs using the Virtuozzo Template Creation wizard. A template update may be created for any of the application templates installed on the Hardware Node using the Virtuozzo Template Creation wizard. Any application template or application update may be removed from the Container with the help of Parallels Management Console, Parallels Infrastructure Manager, or using the vzpkgrm utility. Finally, a template that is not used by any Container may be completely removed from the Hardware Node using Parallels Management Console, Parallels Infrastructure Manager, or the vzpkgdeploy -u command.

CHAPTER 3

You may wish to use special software inside your Containers to perform a specific task or function, such as word-processing, creating spreadsheets, generating graphics, sending and receiving electronic mail, etc. However, installing an application inside every Container where you wish to use it may be a time-consuming operation and require many megabytes of disk space inside each Container. At the same time, adding an application to your Containers by using the technology of Virtuozzo templates helps you avoid these problems: Thanks to the fact that the real application files are written to the Hardware Node hard disk only once, gigabytes of disk space are saved that would be lost if the application were installed separately into each and every Container. The application is loaded only once into the Node memory, so memory savings are also tangible.
Launching Virtuozzo Template Creation Wizard... 15 Creating Template From Installed Application Data.. 16 Creating Template From Manually Added Data.. 26
Launching Virtuozzo Template Creation Wizard
Before you can start making use of the benefits provided by the 'Virtuozzo Templates' technology, you should first create one or more application templates. Virtuozzo Containers 4.0 provides you with a special wizard for creating Virtuozzo application templates. The Virtuozzo Template Creation wizard will guide you through the process, gather all the necessary information, and make an application template for you. In order to invoke the wizard, select Programs --> Parallels --> Parallels Virtuozzo Containers --> Virtuozzo Template Creation Wizard on the Windows Start menu. After you have launched the wizard, you will be presented with the Welcome to Virtuozzo Template Creation Wizard window:
Figure 2: Template Creation Wizard - Welcome Screen In this window you can choose one of the following types of the application template creation: Select the Create a template on the basis of an installed application radio button to create your application template on the basis of the corresponding application installed in a special temporary Container and customized, if necessary. In this case only the files and registry settings that will result from the application installation inside the temporary Container will be included in the template.

Figure 5: Template Creation Wizard - Making Final Preparations In this window you can use the Edit registry and Edit files buttons to review and edit the registry entries and files that are meant for making the application template. You can also make use of the Let wizard remove unnecessary registry entries from template and Let wizard remove unnecessary files from template check boxes. These check boxes, if selected, let the Virtuozzo Template Creation Wizard look through and analyze all registry settings and folders/files resulted from the application files installation inside the Container and to be used for the application template creation. As a result of this operation, the wizard may select one or several registry entries and/or folders/files which are, in its opinion, of no use for the template or may even cause the template to malfunction and exclude them from the template creation process. You can easily find out what registry entries and folder/files will not be included in the template by clicking the Edit registry and Edit files buttons, respectively, and exploring the contents of the displayed windows. Unnecessary and suspicious files and folders will be marked red and the folders containing them - reddish. For example:
Figure 6: Template Creation Wizard - Viewing Files/Folders to Remove If you do not wish to exclude any registry settings and folders/files from the template creation, just clear the corresponding check boxes on the Create Template screen and click Next. On the next step of the wizard, you should provide additional information on the template being created:
Figure 7: Template Creation Wizard - Providing Template Information First of all, you are prompted to review and configure, if necessary, the basic information on the template. To this effect, select the Basic Information folder in the left part of the Specify Template Information window and fill in the following fields:

Field Name name

Description Mandatory. The name to be assigned to the template. You can type any alphanumeric identifier that you consider reasonable for the template and that will be used to refer to this template when performing all templaterelated operations (e.g. installing the template on the Node or adding it to a Container). Optional. The type of the template being created: OS: should be indicated when creating OS templates; App: should be indicated when making application templates; MUI: should be indicated when making the Multilingual User Interface MUI) pack of the Windows Server 2003 (x64 Edition) OS.

The other folders in the Specify Template Information window allow you to configure the following template configuration settings: Select the Provided Applications folder and specify the names of the applications which will be installed inside the Container together with the application template being created. Select the Required Applications folder and indicate the names of the applications which will have dependencies with the template you are creating and which should be pre-installed inside the Container to successfully add the template to this Container. Select the Conflicting Applications folder and enter the names of the applications which may have conflicts with the template and needed to be removed from the Container before adding the template to this Container. The process of working with the three aforementioned folders is identical and described below: To add a new application to any folder, click the. button in the right part of the Specify Template Information window:
Figure 9: Template Creation Wizard - Entering Information on Application In the displayed window, you can do the following: In the Application Name field, specify the name of the application that will be provided/required by or conflict with the template being created. Select one or several check boxes to include the following information in the template: a Application vendor: this check box, if selected, allows you to specify the information on the application vendor by following the 'click here to enter the application vendor' link at the bottom of the window and typing the necessary information in the Vendor field. Application version: this check box, if selected, allows you to specify the information on the version of the template that will provide/require or conflict with the application by following the 'click here to enter the application version' link at the bottom of the window, typing the template version in the Version number field, and selecting one of the radio buttons under this field.
Vendor version: this check box, if selected, allows you to specify the information on the application version by following the 'click here to enter the vendor version' link at the bottom of the window and typing the right application version in the Vendor field.
To configure the parameters of any existing application, click the application name and, in the displayed window, change the corresponding parameters as shown above. To remove an application from a folder, select the name of the application to be deleted and click the Remove button. On the next step of the wizard, you can change the operations to be performed inside a Container after removing the updated application template from the Container.

Figure 12: Template Creation Wizard - Specifying Container ID and Template Name In this window you should provide information in the following fields: Container ID: specify the ID of the Container where the application files and registry entries are stored which will be used for the template creation. If they are stored on the Hardware Node itself, you should specify 0 as the value of this field. Note: Make sure the Container where the application files and registry entries are located is running; otherwise, you will be warned with a message informing you that the corresponding Container is currently stopped. Template name: choose an arbitrary name for the resulting file that will contain the template; you can type any alphanumeric identifier that you consider reasonable for the template file. When you are ready, click the Next button.
In the Specify Application Data window, you should specify what application files and registry entries are to be added to the application template:
Figure 13: Template Creation Wizard - Adding Files and Registry Entries In this window you can do the following: Click the Add files button to open the Template configuration window where you can choose the application files out of which the application template will be created. You may select any number of files with any extensions (.exe,.vbs,.txt, etc.). After you have chosen the needed files, click on the Save button in the Template configuration window to confirm your selection. Click the Add reg_keys button to open the Template configuration window where you can select those registry entries that will be added to the application template. After you have chosen the needed entries, click on the Save button in the Template configuration window to confirm your selection. After you have selected the necessary files and registry entries and clicked the Next button, the Create Template window is shown:
Figure 14: Template Creation Wizard - Making Final Preparations In this window you can use the Edit registry and Edit files buttons to review and edit the registry entries and files that you selected on the previous step of the wizard and are meant for making the application template. You can also make use of the Let wizard remove unnecessary registry entries from template and Let wizard remove unnecessary files from template check boxes. These check boxes, if selected, let the Virtuozzo Template Creation Wizard look through and analyze all registry settings and folders/files to be used for the application template creation. As a result of this operation, the wizard may select one or several registry entries and/or folders/files which are, in its opinion, of no use for the template or may even cause the template to malfunction and exclude them from the template creation process. You can easily find out what registry entries and folder/files will not be included in the template by clicking the Edit registry and Edit files buttons, respectively, and exploring the contents of the displayed windows. Unnecessary and suspicious files and folders will be marked red and the folders containing them - reddish. For example:

Figure 21: Virtuozzo Containers Autoinstaller - Selecting Mode c On the Parallels Virtuozzo Containers Components screen, expand Virtuozzo Containers 4.0 for Windows x86 --> OS Language Packs --> English and select Available; then click Next:
Figure 22: Virtuozzo Containers Autoinstaller - Choosing Components to Download
On the Download Information screen, click Download.
4 After the download is finished, locate the w2k3en_SP2_x86.ex_ file in the X:\vz\download folder and change its extension to.exe. 5 Double-click the w2k3en_SP2_x86.exe file to produce w2k3sp2_std_<template_version>_en_x86.efd OS template. the
6 Copy the resulting template to the X:\vz\Templates\__cache folder on the Hardware Node (where X:\vz denotes the folder storing all the data used by your Containers: private areas, installed templates, patches, logs, etc.). 7 Remove the Windows Server 2003 SP1 OS template currently installed on the Node using the vzpkgdeploy utility. For example, you can do this as follows:
X:\.\Administrator>vzpkgdeploy -u windows_2003_std_sp1-<template_version>
Note: There can be only one basic OS template (either Windows Server 2003 with SP1 or Windows Server 2003 with SP2) installed on your Node at the same time. 8 Install the Windows Server 2003 SP2 OS template by running the following command on the Node:
X:\.\Administrator>vzpkgdeploy -i w2k3sp2_std_<template_version>_en_x86
9 Upgrade the operating system on your Node to Windows Server 2003 Service Pack 2. You can follow the following link to download Service Pack 2: http://www.microsoft.com/downloads/details.aspx?FamilyId=95AC1610-C232-4644-B828C55EEC605D55&displaylang=en. 10 Reboot the Hardware Node. Notes: 1. You must follow the order of the operations described above; otherwise, your Containers may become broken. 2. Do not start any of your Containers until you complete the upgrade. After it has been successfully installed on the Node, the SP2 template can be accessed by the windows_2003_std_sp2-<template_version> name or the w2k3 alias and used for creating Containers running the Windows Server 2003 operating system with Service Pack 2. Detailed information on how to create new Containers is provided in the Operations on Containers chapter of the Parallels Virtuozzo Containers User's Guide.
Installing Windows Server 2003 R2 OS Template
The Windows Server 2003 R2 OS template is used for creating Containers running the Windows Server 2003 operating system with R2. To be able to create Containers with this OS, the Windows Server 2003 R2 operating system and the corresponding Windows Server 2003 R2 OS template (e.g. the English R2 OS template if you are running the English version of Windows Server 2003 R2) should be installed on your Hardware Node. The current version of Virtuozzo Containers allows you to create Containers running the following versions of Windows Server 2003 R2 (both 32-bit and 64-bit): English (Standard, Enterprise, and Datacenter Editions); French (Standard and Enterprise Editions); German (Standard and Enterprise Editions); Spanish (Standard and Enterprise Editions); Italian (Standard and Enterprise Editions); Simplified Chinese (Standard and Enterprise Editions); Traditional Chinese (Standard and Enterprise Editions); Korean (Standard and Enterprise Editions); Japanese (Standard and Enterprise Editions). If your server is running the Windows Server 2003 R2 operating system, the appropriate Windows Server 2003 R2 OS template is automatically installed on it during the Virtuozzo Containers 4.0 installation. So, you do not need to perform any additional operations to start creating Containers on its basis. If this is not the case (e.g. you upgraded your system to R2 after the Virtuozzo Containers installation), you should install the R2 OS template manually. Let us assume that you wish to create Containers running the 32-bit English version of Windows Server 2003 R2 (Standard Edition), however, do not have the English R2 OS template installed. In this case you should perform the following operations to install this template on the Hardware Node: 1 Make sure that your Node is running the 32-bit English version of Windows Server 2003 R2.

Figure 32: Template Creation Wizard - Entering Template Uninstall Information The Specify Template Uninstall Information screen allows you to customize the operations to be performed when uninstalling the template by doing the following: Clear the Use Default check box and then clear the check boxes of the applications to be preserved during the application removal. Clear the Use Default check box, select the Customize the commands to be executed. check box, and edit the commands to be executed during the template removal from the Container to meet your demands. While customizing the commands, please make sure that all the commands do not require any user interaction during their execution.
Click the Next button for the changes applied to your template to come into effect. However, before you can start using the newly created template, you should remove the original template from the Hardware Node and install the modified template on it by means of Parallels Management Console or the vzpkgdeploy utility. Please consult the Uploading and Installing New Virtuozzo Templates on Hardware Node section (p. 33) and Parallels Virtuozzo Containers for Windows Reference Guide, respectively, to learn how you can install your application templates on the Node.
Creating and Installing Application Template Updates
Sometimes, you may need to update one or more application templates installed on your Hardware Node. This may happen, for example, in case the distribution vendor provides a new version of some application. If it is added from a template to certain Containers, this application should be updated to the new version in these Containers. The easiest way to do it is to create the corresponding template update, install it on the Hardware Node, and add it to the needed Containers. All these operations can be performed with the help of the Virtuozzo Template Creation wizard. In the process of creating a template update, the wizard completes the following tasks: Notes: 1. The functionality of creating application templates is available since update 5 of Parallels Virtuozzo Containers 4.0. You can check the number of the latest Parallels Virtuozzo update installed on your Node by opening Control Panel, double-clicking Add or Remove Programs, and navigating to the latest Virtuozzo Containers update in the Currently installed programs table. If you have update 5 installed, it will be shown as Parallels Virtuozzo Containers 4.0 update 400005. If you do not have this update installed, please refer to the Keeping Your Virtuozzo Containers System Up-to-Date chapter of the Parallels Virtuozzo Containers 4.0 User's Guide to learn how you can do it. 2. Currently, the Virtuozzo Template Creation wizard enables you to create application template updates only. 1 Installs the original template and all its previous updates, if any, inside a temporary Container and stores the Container state after the template installation.

2 Tracks and records all the changes in the temporary Container registry settings and files resulting from installing the new version of your application inside this Container. 3 Saves the collected changes into a special file containing all the template update-related information and installs it on the Hardware Node, if necessary. In order to invoke the wizard, select Programs --> Parallels --> Parallels Virtuozzo Containers --> Virtuozzo Template Creation Wizard on the Windows Start menu. You will be presented with the Welcome to Virtuozzo Template Creation Wizard window where you should select the Create an update for an existing template radio button and click Next to proceed with the template update creation. On the first step of the wizard, you are asked to select the application template for which you wish to create a new update:
Figure 33: Template Creation Wizard - Selecting Templates The left pane of the Select Template window lists all the application templates currently installed on the Hardware Node. To select the template for preparing an update, select its name and click the Add button. The template will be moved to the right pane of the displayed window. If you already have one or more application template updates installed on your Node, they are also shown in the left pane and must be added to the right pane in the order of their creation. To move the template or any of its updates back to the left pane, select the template or template update name in the right pane and click Remove. Note: You can create an update for one application template at a time. If you wish to create updates for several application templates, you should run the Virtuozzo Template Creation wizard several times. After selecting the required template and its updates, click Next to display the Specify Container Settings window:
Figure 34: Template Creation Wizard - Defining Container Settings In this window you are prompted to set the parameters for a special Container which is automatically created by the wizard for the period necessary for making the template update. After the template update has been successfully created and copied to the Hardware Node, the temporary Container will be removed from the Hardware Node (unless the Do not remove Container after template creation check box is selected). The fields you should fill in on the Specify Container Settings screen are explained below: In the CT ID field, specify the ID to be assigned to the temporary Container. Make sure that the Container with the specified ID does not exist on your Node. Otherwise, you will be warned with a message asking you to choose another Container ID. In the CT disk space limit field, type the amount of disk space to be allocated to the temporary Container, in megabytes. Make sure that the size of the template, all its updates, and the installation files of the updated application does not exceed the size of the specified disk space. Otherwise, a warning will be displayed notifying you that the allocated disk space is not enough and must be increased. Select the Do not remove Container after template creation check box to leave the temporary Container intact after the template update creation. In the CT IP address field, enter the IP address (it should be unique within your network) to be assigned to the temporary Container. You should specify a valid IP address to be able to connect to the Container via RDP at a later time. Indicate a DNS server that the temporary Container is supposed to use in the DNS server field or select the Use DNS server of Hardware Node check box under the DNS server field to set the same DNS server as the one used by the Hardware Node.

Figure 36: Template Creation Wizard - Making Final Preparations
In this window you can use the Edit registry and Edit files buttons to review and edit the registry entries and files that are meant for making the template update. You can also make use of the Let wizard remove unnecessary registry entries from template and Let wizard remove unnecessary files from template check boxes. These check boxes, if selected, let the Virtuozzo Template Creation wizard look through and analyze all registry settings and folders/files to be used for the template update creation. As a result of this operation, the wizard may select one or several registry entries and/or folders/files which are, in its opinion, of no use for the template update or may even cause the template update to malfunction and exclude them from the template update creation process. You can easily find out what registry entries and folder/files will not be included in the template update by clicking the Edit registry and Edit files buttons, respectively, and exploring the contents of the displayed windows. Unnecessary and suspicious files and folders will be marked red and the folders containing them - reddish. For example:
Figure 37: Template Creation Wizard - Viewing Files/Folders to Remove If you do not wish to exclude any registry settings and folders/files from the template update creation, just clear the corresponding check boxes on the Create Template screen and click Next. On the next step of the wizard, you can review and configure, if necessary, a number of additional template update parameters:
Figure 38: Template Creation Wizard - Providing Template Update Information All template update parameters that you can configure on this screen are explained in the Creating Template From Manually Added Data section (p. 26) in detail. Note: By default, the Required Applications folder contains the template for which the new update is intended and all its previous updates. You can add any other templates or applications to this folder, but you are not recommended to remove any of the already present templates. Otherwise, the updated application may not work properly. On the next step of the wizard, you can change the operations to be performed inside a Container after removing the template update from this Container.
Figure 39: Template Creation Wizard - Template Update Uninstall Information The Specify Template Uninstall Information screen allows you to customize the operations to be performed when uninstalling the template update by doing the following: Clear the Use Default check box and then clear the check boxes of the applications to be preserved during the template update removal. Clear the Use Default check box, select the Customize the commands to be executed. check box, and edit the commands to be executed during the template update removal from the Container to meet your demands. While customizing the commands, please make sure that all the commands do not require any user interaction during their execution. Click Next to start creating the template update. The next step of the wizard allows you to install the template update on the Hardware Node:

Figure 40: Template Creation Wizard - Installing Update Template Each new template update should be installed on the Node before it can be applied to your Containers. Click Next to install the template update on your Hardware Node right after its creation. If you do not wish to install the template update at the moment, clear the Install template on Hardware Node check box and click Next. You will be able to install it later on by means of Parallels Management Console or the vzpkgdeploy utility. Please consult the Uploading and Installing New Virtuozzo Templates on Hardware Node section (p. 33) and Parallels Virtuozzo Containers for Windows Reference Guide, respectively, to learn how you can install templates and their updates on your Node. The last screen of the wizard informs you that the template update has been successfully created and enables you to change the default location of the template update. By default, it is placed to the X:\vz\Templates\__cache folder on the Hardware Node where X denotes the disk drive set for storing Virtuozzo program files. You can change this location by selecting the Save the template to another location check box and specifying the path to the desired folder in the field provided. However, if you plan to install the template update on this Node, you should save it to the default folder. Click Finish to exit the wizard. Note: The information you specify during the template update creation is stored in a special XML file and used when performing certain operations on the template update. For example, it is used when you add the template to a Container. In this case Virtuozzo Containers 4.0 checks if the Container meets all the conditions set for the template update in its XML file (e.g. whether all the required templates and templates updates you indicated in the Required Applications folder on the Specify Template Information screen are installed inside the Container).

Listing Templates

You may want to list the templates installed on the Hardware Node. They may be already used or not used by certain Containers. To list templates in Parallels Management Console, it is sufficient to choose the Templates item under the corresponding Hardware Node name and select either the OS Templates or Application Templates tab to see a list of the OS or application templates installed on the Node, respectively. For example:
Figure 41: Management Console - Listing Templates To see the templates used by a particular Container, double-click the needed Container in the Container list in the right pane to open this Container management window, and then again choose the Templates item and click the OS Templates or Application Templates tab in the left pane of the new window. In the command line, you can use the vzpkgls utility to list the templates installed on the Hardware Node and applied to your Containers. Detailed information on this utility can be found in the Parallels Virtuozzo Containers Reference Guide.

Adding Templates to Single Container
After you have installed a number of application templates on the Hardware Node, you may add them to any number of Containers. To successfully add a template to a Container, this Container should be running. Parallels Management Console provides you with a special wizard Virtuozzo Template Installation Wizard - allowing you to easily add an application template to a particular Container on your Hardware Node. To invoke the wizard: 1 Open a list of Containers in the Management Console main window by selecting the Virtuozzo Containers item in the Hardware Node tree.
2 Right-click the Container (it must be running) where you wish to add the template and select Templates --> Add/Update Virtuozzo Templates on the context menu.
Figure 42: Management Console - Adding Template to Single Container In the Choose Virtuozzo Templates to Install window, you should select one or more templates to be added to the Container. This window is divided into two parts:
The table in the top part of the window lists all the templates compatible with the given Container. You can view all the templates (both compatible and incompatible with the Container) currently installed on the Hardware Node by clearing the Show only the templates compatible with the OS template of the Container check box. To schedule a template for installation, select its check box in the table and click Next. You can also make use of the Select All/Deselect All buttons to select/deselect all the listed templates at once. The table at the bottom of the window displays the information on the Container where the selected template is to be added:
Column Name Container OS Parent Node Already Installed Compatible Available Description The name assigned to the Container. The OS template the Container is based on. The Hardware Node where the Container is residing. Indicates whether the selected template is already installed inside the Container. Indicates whether the Container is compatible with the selected template. Indicates whether the selected template is installed on the Hardware Node where the given Container is hosted. This option is relevant only for those Containers that reside on Hardware Nodes belonging to a Virtuozzo Group. In this case if the selected template is marked as unavailable (i.e. 'No' is displayed in the column), it means that the template is installed on another Node in the Virtuozzo Group and cannot be added to the Container.

Removing Application Templates From Container
Parallels Management Console allows you to remove an application template from a Container. To this effect, you should: 1 Open a list of Containers in the Management Console main window by selecting the Virtuozzo Containers item under the corresponding Hardware Node name.
2 Double-click the name of the Container wherefrom you want to delete a template to open the Container Manager. 3 Select the Templates item in the main tree of the opened Container Manager and click the Application Templates tab to see a list application templates currently applied to the Container. 4 Right-click the application template you wish to delete and select the Delete option on the context menu:
Figure 45: Management Console - Removing Application Templates From Container 5 In the Remove Virtuozzo Template window, confirm your decision by clicking the Remove button. You can also select the Forced removal check box to force the template deletion from the Container. Besides, you can use the Virtuozzo vzpkgrm utility to remove application templates from Containers. Detailed information on the vzpkgrm utility can be found in the Parallels Virtuozzo Containers Reference Guide.
Removing Template From Hardware Node
Virtuozzo Containers 4.0 allows you to remove those OS and application templates that are not needed any more. To this effect, you should perform the following operations: 1 Select the Templates item under the corresponding Hardware Node name in the Parallels Management Console main tree.
2 Click on either the Application Templates or OS Templates tab to display a list of all application or OS templates installed on the Node, respectively. 3 Right-click the template you wish to delete in the right pane and select the Delete option on the context menu:
Figure 46: Management Console - Removing Template From Hardware Node Please keep in mind that you cannot remove the templates currently applied to one or more Containers on the Hardware Node. 4 In the Remove Virtuozzo Template window, confirm your decision by clicking the Remove button. You can also select the Forced removal check box to force the template deletion from the Hardware Node.

Glossary

Application template is a template used to install a set of applications in Containers. See also Template. Container (or regular Container) is a virtual private server, which is functionally identical to an isolated standalone server, with its own IP addresses, processes, files, its own users database, its own configuration files, its own applications, system libraries, and so on. Containers share one Hardware Node and one OS kernel. However, they are isolated from each other. A Container is a kind of sandbox for processes and users. Container 0 and Container 1 are used to designate the Hardware Node and the Service Container, respectively. Container 0 is used to designate a Hardware Node where the Virtuozzo Containers software is installed. Container 1 is used to designate the Service Container. Hardware Node (or Node) is a server where the Virtuozzo Containers software is installed for hosting Containers. Sometimes, it is marked as Container 0. Host Operating System (or Host OS) is an operating system installed on the Hardware Node. MAC address stands for Media Access Control address, a hardware address that uniquely identifies each Node in a network. The MAC layer interfaces directly with the network media. Consequently, each different type of network media requires a different MAC layer. OS template (or Operating System template) is used to create new Containers with a preinstalled operating system. See also Template. Parallels Infrastructure Manager (or Infrastructure Manager) is a tool designed for managing Hardware Nodes and all Containers residing on them with the help of a standard Web browser on any platform. Parallels Management Console (or Management Console) is a Virtuozzo Containers management and monitoring tool with graphical user interface. It is used to control individual Hardware Nodes and their Containers. Management Console is cross-platform and runs on both Microsoft Windows and Linux workstations. Parallels Power Panel is a means for administering personal Containers with the help of a standard Web browser (Internet Explorer, Mozilla, etc.) on any platform. Parallels Virtuozzo Containers (or Virtuozzo Containers) is a complete server automation and virtualization solution allowing you to create multiple isolated Containers on a single physical server to share hardware, licenses, and management effort with maximum efficiency. Private area is a part of the file system where Container files that are not shared with other Containers are stored.

Parallels

Parallels Virtuozzo Containers for Windows

Reference Guide

Version 4.0
Copyright 1999-2008 Parallels Software International Inc.
ISBN: N/A Parallels Holdings Ltd. 13755 Sunrise Valley Drive Suite 600 Herndon, VA 20171 USA Tel: +1 (703) Fax: +1 (703) 1999-2008 Parallels Holdings Ltd. 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.

Contents

Preface 5
About Parallels Virtuozzo Containers.... 6 About This Guide..... 7 Organization of This Guide.... 7 Documentation Conventions.... 8 Getting Help..... 9 Feedback...... 10
Configuring Parallels Virtuozzo Containers
Configuring Containers.... 11 Adding Custom Action Scripts.... 14
Parallels Virtuozzo Command Line Interface
vzctl..... 17 vzctl create..... 19 vzctl delete and vzctl destroy.... 20 vzctl mount and vzctl umount.... 21 vzctl start, vzctl stop, vzctl restart, and vzctl status... 21 vzctl set..... 22 vzctl exec, vzctl exec2, and vzctl enter.... 27 vzctl mountext and vzctl umountext... 28 vzctl partadd and vzctl partdel.... 29 vzctl reinstall..... 30 vzctl shrink.... 31 vzlist..... 31 vzlist Output Parameters and Their Specifiers... 32 vzquota..... 33 vzquota setlimit.... 34 vzquota stat and vzquota show.... 34 Licensing Utilities..... 35 vzlicload..... 35 vzlicview..... 35 Migration Utilities.... 36 vzmigrate..... 37 vzp2v..... 38 vzmlocal..... 39 Backing-Up Utilities..... 40 vzabackup..... 41 vzarestore..... 43 vzvssctl..... 44 Template Management Utilities.... 45 vzpkgls..... 45 vzpkgdeploy.... 45 vzpkgadd..... 46 vzpkgrm.... 46 Supplementary Tools..... 47 vzsveinstall.... 47 vzkeygen..... 47
vzcache..... 48 vzlscache..... 49 vzuncache..... 49 vznetcfg.... 50 vznetstat.... 51

Glossary Index

CHAPTER 1

Preface

In This Chapter
About Parallels Virtuozzo Containers... 6 About This Guide.... 7 Getting Help.... 9 Feedback.... 10
About Parallels Virtuozzo Containers
Parallels Virtuozzo Containers is a patented OS virtualization solution. Virtuozzo Containers 4.0 creates isolated partitions or Containers on a single physical server and OS instance to utilize hardware, software, data center and management effort with maximum efficiency. The basic Virtuozzo capabilities are: Intelligent Partitioning - Division of a server into as many as hundreds of Containers with full server functionality. Complete Isolation - Containers are secure and have full functional, fault and performance isolation. Dynamic Resource Allocation - CPU, memory, network, disk and I/O can be changed without rebooting. Mass Management - Suite of tools and templates for automated, multi-Container and multi-server administration. The diagram below represents a typical model of the Virtuozzo-based system structure:
Figure 1: Virtuozzo Containers OS Virtualization
The Parallels Virtuozzo OS virtualization model is streamlined for the best performance, management, and efficiency. At the base resides a standard Host operating system which can be either Windows or Linux. Next is the virtualization layer with a proprietary file system and a kernel service abstraction layer that ensure the isolation and security of resources between different Containers. The virtualization layer makes each Container appear as a standalone server. Finally, the Container itself houses the application or workload. The Parallels Virtuozzo OS virtualization solution has the highest efficiency and manageability making it the best solution for organizations concerned with containing the IT infrastructure and maximizing the resource utilization. The Parallels Virtuozzo complete set of management tools and unique architecture makes it the perfect solution for easily maintaining, monitoring, and managing virtualized server resources for consolidation and business continuity configurations.

About This Guide

This guide is a complete reference on all Parallels Virtuozzo Containers configuration files and Hardware Node command-line utilities. It familiarizes you with the way to configure Virtuozzo Containers 4.0 to meet your requirements and to perform various tasks by using the corresponding Virtuozzo command line utilities. The primary audience for this guide is anyone who is looking for an explanation of a particular configuration option, does not understand a Virtuozzo file format, needs help for a particular command, or is seeking for a command to perform a certain task.

Feedback

If you spot a typo in this guide, or if you have thought of a way to make this guide better, we would love to hear from you! The Parallels documentation forum is the ideal place for your comments and suggestions. It is regularly monitored by the members of the Parallels technical documentation department, so it is likely that you will receive a reply to your post before long. Note that new users will be asked to fill in a short registration form before being able to post. Registering will allow you to participate not only in the documentation forum discussions, but in all the other Parallels forums as well.

CHAPTER 2

This chapter provides information on the Parallels Virtuozzo configuration parameters. Besides, it explains how you can use your own custom action scripts to configure your Containers.
Configuring Containers.... 11 Adding Custom Action Scripts... 14

Configuring Containers

Each Container has its own configuration file which is stored in the X:\vz\Conf\ folder and has a name of CT_ID.conf. The parameters in the X:\vz\Conf\<CT_ID>.conf file are presented in the form of the PARAMETER="value" pattern. The main parameters defining the Container configuration can be subdivided into the following categories: miscellaneous, resource management, and networking parameters. Note: During the Virtuozzo Containers installation, the Conf subfolder is automatically created in the folder you specified for storing all Container configuration files. By default, the C:\vz\ folder is used. However, you might have defined another path for this folder. Miscellaneous parameters:
Parameter VzPrivate Description Default value
The path to the Container private area. You C:\vz\private\ specify the location of the Container private area by passing the --private path argument to the vzctl create command. This parameter is omitted if the Container private area is located in the C:\vz\private\ directory. The pseudo-random number used to uniquely identify the Container. GUIDs (Globally Unique Identifiers) are written using a four-byte word, 3 two-byte words, and a six-byte word, such as: {3F2504E0-4F89-11D3-9A0C0305E82C3301}

Autoboot

Specifies whether the Container should be started automatically on system startup. Virtuozzo automatically starts all Containers that have this value set to 1. Specifies whether the Container can be managed by the Container administrator using the offline services indicated in the OfflineServices parameter in this file provided the OfflineMgmt parameter in the C:\vz\Conf\0.conf file is set to "1". Overrides the OfflineServices parameter from the C:\vz\Conf\0.conf file. The services enumerated in this parameter can be used by the Container administrator for managing Containers, if the OfflineMgmt parameter in the C:\vz\Conf\0.conf file is set to "1". This is the name of the OS template the Container is based upon. Provides a list of application templates. You are not recommended to modify this parameter since it is used to track the history of the added templates. This parameter is omitted if no templates have been added to the Container. The path to the folder where the Windows Server 2003 system files for the given Container are located. In the current version of Virtuozzo, you cannot change the default path set during the Container creation. The type of the Container virtual disk drive. You can set the disk type to one of the following: plain: in this case the size of a virtual hard disk is fixed, i.e. all disk space is allocated during the virtual disk creation. sparse: in this case the size of a virtual hard disk is also fixed and disk space is allocated during the disk creation. However, an.efd file corresponding to a virtual hard disk can be regarded as a standard NTFS file supporting the 'sparse file' functionality. When the 'sparse file' functionality is enabled, the Host OS does not allocate hard drive space to an.efd file except in regions where it contains non-zero data. This allows you to make the disk space usage inside your Containers more efficient. compact: in this case you set only the maximal size of a virtual hard disk. A Container hard disk grows in size each time new data is written to the hard disk and can increase as large as the maximum size specified during the hard disk creation.

OfflineMgmt

OfflineServices

TEMPLATE TEMPLATES

WindowsDir

C:\WINDOWS

DISKTYPE
Resource management parameters control the amount of resources a Container can consume. All resources are described in the Managing Resources chapter of the Parallels Virtuozzo Containers User's Guide in detail; here is only a list of parameters that can be found in the C:\vz\Conf\<CT_ID>.conf file:
Parameter DiskQuota CpuUnits Description The total size of disk space that can be consumed by the Container, in 1-Kb blocks. The positive integer number that defines how much CPU time one Container will receive in comparison with the other Containers on the Hardware Node in case all the CPUs of the Node are fully used. The maximal number of processes the Container may create. Upon hitting this limit, the Container will not be able to start a new process or thread. The number of terminal sessions. This parameter is used to limit the number of simultaneous terminal sessions, i.e. the number of users that are allowed to connect to the Container at the same time thru MS TSC, RDP, etc. The size of private (or potentially private) memory that can be allocated by the Container, in bytes. The memory that is always shared among different applications is not included in this resource parameter. Setting this parameter to "1" enables the network browsing for the Container. The network browsing, if enabled, allows the Container administrator to view all the network servers and file sharing resources available on the Microsoft Windows network. By default, the network browsing is disabled. You can enable this feature for all Containers on your Node at once by setting this parameter to "1" in the C:\vz\Conf\0.conf file. Setting this parameter to "1" enables the Windows QoS packet scheduler for the Container. The QoS packet scheduler is used to regulate how much traffic an application inside your Container is allowed, thus enforcing the QoS parameters originally set for a particular application. By default, the QoS packet scheduler is disabled.
ProcessCountLi mit SessionCountLi mit CommittedMemor yLimit NetAllowBroadc asts

NetQoSPacketSc heduler

Note: In case you have enabled the QoS packet scheduler for a running Container, you should restart this Container for the changes to take effect.

Script Name vz-precreate.<ext> vz-postcreate.<ext> vz-premount.<ext> vz-postmount.<ext> vz-preunmount.<ext> vz-postmount.<ext> vz-prestart.<ext> vz-poststart.<ext> vz-prestop.<ext> vz-poststop.<ext> vz-preclone.<ext> vz-postclone.<ext> vz-prechangevpsid.<ext> Description This script is to be run before the Container creation. This script is to be run after the Container creation. This script is to be run before mounting the Container private area. This script is to be run after mounting the Container private area. This script is to be run before unmounting the Container private area. This script is to be run after unmounting the Container private area. This script is to be run before the Container start. This script is to be run after the Container start. This script is to be run before stopping the Container. This script is to be run after stopping the Container. This script is to be run before copying the Container. This script is to be run after copying the Container. This script is to be run before changing the Container ID.
vz-postchangevpsid.<ext> This script is to be run after changing the Container ID.
Note: All the scripts are executed in the Host OS context. You may specify scripts that will be applied to all Containers residing on the Hardware Node. To this effect, you should place your script to the C:\vz\Scripts\. In its turn, locating a script to the C:\vz\private\CT_ID\scripts\ directory allows you to set this script for executing in the given Container only (per-Container script). In the latter case, you may need to create the C:\vz\private\CT_ID\scripts\ directory manually since it is not created by creating a Container. When executed, any script takes only one parameter - the ID of the corresponding Container. Note: During the Virtuozzo Containers installation, the Scripts subdirectory is automatically created in the directory you specified for storing all Container configuration files. By default, the C:\vz\ directory is used. However, you might have defined another path for the directory. Let us assume you have created Container 101 with the private area located in the C:\vz\Private\101\ directory. And now you wish to write a script that will be executed each time after the Container start and display the number of events currently recorded in the Container System event log. To this effect, you should open Notepad or another text editor and write the following script code:
strComputer = "." Set objWMIService = GetObject("winmgmts:" _ & "{impersonationLevel=impersonate}!\\" & strComputer & "\root\cimv2") Set colLogFiles = objWMIService.ExecQuery _ ("Select * from Win32_NTEventLogFile where LogFileName='System'") For Each objLogFile in colLogFiles Wscript.Echo objLogFile.NumberOfRecords Next

After that, you should save the file with the vz-poststart.vbs name, create the scripts subdirectory in the C:\vz\Private\101\ directory, and place your script to this subdirectory. Make sure that the full path of the script is C:\vz\Private\101\scripts\vz-poststart.vbs. From this point on, the vzpoststart.vbs script will be executed every time you start Container 101. Note: By default, Virtuozzo is shipped with the vz-poststart.cmd script located in the C:\vz\Scripts\ directory. This script is needed for all Containers residing on the Hardware Node to perform certain operations necessary for Container error-free functioning. However, specifying your own per-Container scripts (i.e. scripts in the C:\vz\private\CT_ID\scripts\ directory) prevents the vz-poststart.cmd script from running. Therefore, you should make sure that each of your per-Container scripts calls the C:\vz\Scripts\vz-poststart.cmd script.

CHAPTER 3

This chapter documents the utilities supported in the current version of Parallels Virtuozzo Containers for Windows. For every utility, all available command-line options are described. All the Parallels Virtuozzo utilities are supposed to be run on the Hardware Node by using the cmd.exe command interpreter, which can be opened by selecting Start --> Run and executing the cmd command. There are a number of regulations which should be observed while working in the command prompt window. One of such rules would be to enclose in quote marks any parameter consisting of two or more words (e.g. "C:\Program Files"). Please consult the Microsoft Command-line reference (http://www.microsoft.com/resources/documentation/windows/xp/all/proddocs/enus/ntcmds.mspx) to learn the rules of working in the command prompt window. The Virtuozzo command-line utilities can be subdivided into the following categories: general utilities, licensing utilities, Container migration utilities, Container backup utilities, template management utilities, and supplementary utilities. General utilities are intended for performing day-to-day maintenance tasks:
vzctl vzlist vzquota Utility to control Containers. Utility to view a list of Containers existing on the Node with additional information. Utility to control Virtuozzo disk quotas.
Licensing utilities allow loading new license files and viewing the state of the license:

vzlicview vzlicload Utility to show the Virtuozzo license status and parameters. Virtuozzo license loader.
Container migration utilities allow you to migrate Containers between Hardware Nodes or within one Hardware Node:
vzmigrate vzmlocal vzp2v Utility for migrating Containers to another Hardware Node. Utility for the local cloning or moving of the Containers. Utility for migrating physical servers to Containers on the Hardware Node.
Container backup utilities allow you to back up and restore the Container private areas, configuration files, and quota information:
vzabackup vzarestore vzvssctl Utility to back up Containers and to store them either on a local Node or on a special Backup Node. Utility to restore Containers backed up by using the vzabackup utility. Utility to suspend and resume the Container activity during the backup operation.
Template management utilities allow you to create new templates, install them on the Hardware Node, and perform various operations on them:
vzpkgls vzpkgdeploy vzpkgadd vzpkgrm Utility to get a list of templates available on the Hardware Node and in Containers. Utility to install/remove OS and application templates on/from the Hardware Node. Utility to add a new application template to a Container. Utility to remove a template from a Container.
Supplementary utilities perform a number of tasks and are used by other Virtuozzo utilities:
vzsveinstall vzkeygen vzcache vzlscache vzuncache Utility to create the Service Container on the Hardware Node. Utility to show the Hardware Node ID. Utility to cache common files across Containers. Utility to list the directories created by vzcache. Utility to detach a Container from its cache and copy the cached files back to the Container private area.
vzctl..... 17 vzlist.... 31 vzquota..... 33 Licensing Utilities..... 35 Migration Utilities..... 36 Backing-Up Utilities.... 40 Template Management Utilities.... 45 Supplementary Tools... 47
vzctl is the primary tool for Container management. To use it, you have to log in to the Hardware Node as the administrator. The syntax of vzctl is:
vzctl [--quite | --verbose] command CT_ID vzctl --version vzctl --help
Where command can be one of the following:
create delete destroy mount umount start stop Used to create a Container. Used to remove a Container. Like vzctl delete, this command is also used to remove a Container from the Hardware Node. Used to mount the Container private area. Used to unmount the Container private area. Starts a Container. Stops a Container.

vzctl mount and vzctl umount
These commands take no additional arguments:
vzctl mount <CT_ID> vzctl umount <CT_ID>
The first command mounts the Container private area to the Container root folder (for example, C:\vz\root\<CT_ID> on the Hardware Node) without starting it and the Container registry to the HKEY_LOCAL_MACHINE\<CT_ID> key in the registry of the Node. Normally you do not have to use this command as the vzctl start command mounts the Container private area and registry automatically. The vzctl umount command unmounts the Container private area and registry. Usually there is no need in using this command either, for vzctl stop unmounts the Container private area and registry automatically.
vzctl start, vzctl stop, vzctl restart, and vzctl status
These four commands have the same syntax and take no obligatory arguments:
vzctl vzctl vzctl vzctl start stop restart status <CT_ID> <CT_ID> <CT_ID> <CT_ID>
The first command is used to start a Container. It will set up all network interfaces, initialize the Container quota, if needed, etc. vzctl stop shuts the Container down. There are some commands that can be performed only after running the vzctl stop command (for example, vzctl delete). The vzctl restart <CT_ID> command consecutively performs the stopping and starting of the corresponding Container. The vzctl status command shows the current Container state. It outputs the following information: what IP address is assigned to the Container and whether the Container is running as in the example below:
C:\Documents and Settings\Administrator> vzctl status 101 CtId 101 exist unmounted down

vzctl set

This command is used for setting Container parameters. It has the following syntax:
vzctl set <CT_ID> <setting_name> <value> [ --save ]
An optional -save switch tells vzctl whether to save changes into the Container configuration file. Practically all Container settings can be changed dynamically without the necessity of the Container reboot (except for the -onboot and --psched options). The settings that can be passed to the vzctl set command are subdivided into the following categories: miscellaneous, networking, and resource management parameters. Miscellaneous settings:
--onboot yes|no This setting requires the -save switch. If you set it to yes, Virtuozzo will automatically start this Container on next system startup. This setting creates a new user with the specified password inside the Container, or changes the password of an already existing user. Omitting the user name (e.g. :2wse3rd) will change the password for the built-in Administrator account inside the Container, even though it was renamed for some reason or other. This setting enables/disables the direct managing of the Container thru a common Internet browser by means of Parallels Power Panel. To enable/disable the offline management feature for the Hardware Node and, therefore, for all Containers residing on it, you should set this parameter for the Container with ID 0. This setting allows you to grant access to any drive on the Hardware Node from inside a Container. Drive names must be specified in the X: form (e.g. C:, D:). This setting shuts down access to a drive on the Hardware Node granted by means of the --devadd setting. Drive name must be specified in the X: form (e.g. C:, D:). If set to yes, the Container ID string is displayed in the top right corner of the Container desktop helping you identify the ID of the Container you are currently logged in to. If set to no, the string is not shown on the Container desktop. By default, the Container ID string is displayed on the Container desktop. Please keep in mind that you should log off from the Container and log in to it anew for the changes to take effect. If set to yes, the Container hostname string is displayed in the top right corner of the Container desktop helping you identify the hostname of the Container you are currently logged in to. If set to no, the string is not shown on the Container desktop. By default, the hostname string is hidden from the Container desktop. Pleas keep in mind that you should log off from the Container and log in to it anew for the changes to take effect.

-s, --sort

Sort the Containers in the list by the specified parameter. If "-" is [-]parameter[.specifier] given before the name of the parameter, the sorting order is reversed. -h, --hosthame hostname_pattern -n, --name Display only those Containers that correspond to the specified hostname pattern. The following wildcards can be used: *. If used without any parameters, displays information on all the Containers on the Node together with their names. If you indicate the Container ID after this option, displays information including the Container name on the specified Container only.
-N, --name_filter Displays only the Container that corresponds to the specified name_pattern name pattern. -d, --description desc_pattern --quiet --verbose Displays only the Container whose description corresponds to the specified pattern. Disables logging to the display and to the log file. Sets the log level to the maximum possible value for this vzlist session.
vzlist Output Parameters and Their Specifiers
Some parameters that can be used after the -o and -s switches of the vzlist utility can be specified by the "dot+letter" combination following the parameter and denoting one of the following things:
Specifier.b.h Description The barrier on using the corresponding resource set for the given Container. The hard limit on using the corresponding resource set for the given Container.
The following parameters are available for using with the utility:
Parameter ctid hostname ip status numproc numsessions diskspace Output Column CTID HOSTNAME IP_ADDR STATUS NPROC SESSIONS DQBLOCKS Description The Container ID. The Container hostname. The Container IP address. Specifies whether the Container is running or stopped. The number of processes allowed. Can be used with the.b specifier. The number of terminal sessions opened to the Container. Can be used with the.b specifier. The total size of disk space consumed by the Container, in 1 Kb blocks. Can be used with the.h specifier defining the hard limit on using disk space.

cpuunits

CPUUNI
Allowed CPU power. This is a positive integer number that defines how much CPU time one Container will receive in comparison with the other Containers on the Hardware Node in case all the CPUs of the Node are fully used.

cpuguarantee

CPUGUARANTEE This is a positive integer number that determines the minimal guaranteed share of the CPU time, in per cent, the given Container is guaranteed to receive. CPULIMIT This is a positive number indicating the CPU time, in percent, the corresponding Container is not allowed to exceed. The size of private or potentially private memory that can be allocated to all applications inside the Container, in megabytes. Shared or potentially shared memory (e.g. memory mapped files) is not included in this resource parameter. Displays the OS and application templates applied to the Container. If the ctid parameter is not specified, all templates available on the Hardware Node are shown. The type of the Container virtual disk drive. It can be one of the following: plain, i.e. the size a virtual hard disk is fixed and all disk space is allocated during the virtual disk creation. compact: i.e. only the maximal size of a Container virtual hard disk is set. The Container hard disk grows in size each time new data is written to the hard disk and can increase as large as the maximum size specified during the hard disk creation.

vzmlocal

Moving/copying a Container within one and the same Hardware Node consists in changing/adding the Container ID, private area, and root paths. Thus, you may use the vzmlocal utility either to change the ID and/or the private area path and/or the root path of any existing Container(s) or to clone a Container, i.e. to create a complete copy of an existing Container with different ID and path. It has the following syntax:
vzmlocal <CT List> <CT List> = <source_CTID>:<dest_CTID>[:<dest_private>] [.] vzmlocal -C <CT List> <CT List> = <source_CTID>:<dest_CTID>[:<dest_private>] [.] vzmlocal --help
The options are the following:
-C, --copy -s, --fast-sid Clones the source Container instead of moving it. Allows you to speed up the process of cloning the Container.

-d, --destroy-source

Destroys the source Container after its cloning.
-n, --disable-network Disables offline management for the source Container after its cloning. -l, --skiplock --quiet --verbose --help Allows you to clone locked Containers. Disables logging to screen and to the log file. Sets log level to maximum possible value for this vzmlocal session. Displays the utility usage and exits.
You should specify the source Container ID (<source_CTID>) andthe destination Container ID (<dest_CTID>). Specifying the destination Container private area path (<dest_private>) is optional; it allows you to override the default path of X:\vz\private\<CT_ID>. For example, you can issue the following command to move Container 101 to Container 201, i.e. to change the Container ID from 101 to 201, and to locate the Container private area in the C:\MyCT folder on the Hardware Node:
C:\.\Administrator>vzlist -a CTID NPROC STATUS IP_ADDR HOSTNAME running 192.168.45.63 CTstopped 10.198.198.101 CT101 C:\.\Administrator>vzmlocal 101:201:C:\MyCT Command 'vzmlocal' is successfully finished
Note: In the current version of Virtuozzo Containers, you can change IDs of stopped Containers only.

Backing-Up Utilities

Any Container is defined by its private area and configuration parameters stored in the registry. Backing up these components allows you to restore the whole Container at any time in case the Container gets broken. The following subsections provide the complete reference on the Virtuozzo backup and restore utilities: vzabackup; vzarestore.

vzabackup

The vzabackup utility is used to create backups of separate Containers or whole Hardware Nodes. It can be run on: the Source Node where the Container to be backed up is residing; the Backup Node - a special Node intended for storing Container backups, or any other Virtuozzo-based physical server in your network. The only requirements that should be met to execute vzabackup is to have a server with Virtuozzo Containers 4.0 for Windows and the Parallels Agent software installed on it and to provide the network connectivity for this server to be able to establish connections to the Source and Backup Nodes, if necessary. The created Container backups are then stored on the Backup Node which can also be presented by any Node with running the Virtuozzo Containers and Parallels Agent software. The vzbackup utility has the following syntax:

vzabackup [BACKUP_OPTIONS] --node NODE1 [CT_OPTIONS].
The general backup options ([BACKUP_OPTIONS]) are the following:
-F, -I, --TFull -I, --Tinc --Tdiff -D backup_description -o, --rm-old --rm-tag backup_ID Force performing a full backup. Make an incremental backup or, if no full backups are available, a full backup. If this option is omitted, the full backup is created. Make a differential backup or, if no full backups are available, a full backup. If this option is omitted, the full backup is created. The description of the backup archive. Create a new backup and then remove the oldest backup of the specified Node/Container. Create a backup and then remove the backup with the specified ID. You can learn what ID is assigned to what Container backup using the -l and -f options of the vzarestore utility.

-C(Letter)

Indicates the level of compression for the resulting Container backup archive. In the current version of Virtuozzo, you can set this level to one of the following: n: create the Container backup without any compression. Using this level of compression may speed up the backing up time; however, it may significantly increase the size of the resulting backup file. g: compress the resulting backup with the normal level of compression. This is the default level of compression used to back up all Nodes/Containers. b: compress the resulting backup with the maximum level of compression. In this case the backup file size is the smallest; however, it may take much time to create the backups. The optimal data compression level depends on the type of files to be stored in the backup archive. For example, it is advisable to use the 'normal' and 'none' compression types if most of the files to be backed up are already compressed (e.g. the files with the.zip and.rar extensions) or can be compressed with a low degree of efficiency (e.g. all executable files with the.exe extension or image files with the.jpg,.jpeg., and.gif extensions).
If several Source Nodes are specified, back up these Nodes and/or their Containers simultaneously. If the option is omitted, the Nodes are backed up sequentially one after another. Force the process of backing up the Hardware Node(s)/Container(s). Can be used when backing up several HNs/Containers to continue the backup process even if some errors occur when creating a backup of a certain Node/Container. The IP address and the credentials of the Backup Node. Should be specified in the following form: USER[:PASSW]@IP_ADDRESS. If you do not indicate the password to log in to the Backup Node, you will be asked to do so during the vzbackup execution. If this option is omitted, vzbackup puts the created backup(s) to the backup folder on the Source Node (by default, this folder is X:\vz\Backups).

--force

--storage BACKUP_NODE

The IP address and the credentials of the Source Node. Should be specified in the following form: USER[:PASSW]@IP_ADDRESS. If you do not indicate the credentials to log in to the Source Node, you will be asked to do so during the vzbackup execution. You can omit this option when backing up particular Containers on the local Source Node (provided you are logged in to the Node as Administrator); in all other cases specifying the Source Node IP address and credentials is mandatory.

-q, --no-progress

Disables logging to the screen during the vzabackup operation.
The Container options ([CT_OPTIONS]) define the list of Containers to be backed up:
-e CT1. The Containers to back up on the Source Node. If this option is omitted, all Containers on the given Node will be backed up. Containers can be specified using both their IDs (e.g. 101 or 102) and their names (e.g. comp1 or comp2).

-x CT1.

The Containers that need not be backed up (Containers to exclude). If this option is omitted, all Containers on the given Source Node will be backed up. Containers can be specified using both their IDs (e.g. 101 or 102) and their names (e.g. comp1 or comp2). Only the specified files and folders will be included in the Container backup.
--include-files files_list
Note: If you create a Container backup using this option, you will be able to restore only separate files from the resulting Container backup, but not the Container as a whole.
--exclude-files files_list The path to the files and folders inside the Container to be excluded from the backup.

vzarestore

The vzarestore utility is used to manage Container backups: restore a Container or certain Container files/folders from the Container backup archive, list the backups existing on the Backup Node, remove backups, etc. vzarestore can be run on any Hardware Node provided this Node has the Parallels Agent software installed. The utility has the following syntax:
vzarestore [CT | -e <CT1,.> [-x <CT1,.>] ] [RESTORE_OPTIONS] [BACKUP_NODE] vzarestore -r,--remove <BACKUP_ID.> vzarestore -l,--list [LIST_OPTIONS] [BACKUP_NODE] vzarestore --browse BACKUP_ID [BROWSE_OPTIONS] [BACKUP_NODE] vzarestore --print-ve-config BACKUP_ID [BACKUP_NODE] vzarestore --help
The restore options are the following:
-e CT1,. The Containers to be restored on the Destination Node. Any Container can be specified using both its IDs (e.g. 101 or 102) and its names (e.g. comp1 or comp2). The Containers that need not be restored (the Containers to exclude). Any Container can be specified using both its IDs (e.g. 101 or 102) and its names (e.g. comp1 or comp2). The ID assigned to the Container backup. This ID can be used to manage the backup archive (e.g. to delete the Container backup from the Backup Node or restore the files from the Container backup with the specified ID). If this option is omitted, the latest Container backup is used. Do not stop on errors during the vzarestore execution. Can be used when you are restoring more than one Container. This option allows you to continue the restoring process if some errors occur when restoring a certain Container. Do not restore the Container configuration file. Can be used only if you are restoring a single Container.

-x CT1,.

-b BACKUP_ID

--skip-ve-config

Note: The Container configuration file is not changed when restoring separate Container files.
--files PATH_TO_FILES The full path to the files/folders inside the Container to be restored. This options is incompatible wit the -e and -x options.
--skip-locked -B --storage BACKUP_SERVER
Do not stop on errors even if some of the files to be restored are in the 'locked' state. Handle the values after the -e and -x options as backup IDs. The IP address and the credentials of the Backup Node. Can be specified in the following form: USER[:PASSW]@IP_ADDRESS. If this options is omitted, vzarestore looks for the Container backup on the local Node.
The options which can be used along with the --list option of vzarestore:
f, --full --latest -e CT1,. -B Display detailed information on the backed up Containers. Display the latest Container backup. Display the information on the backups for the specified Containers only. Handle values after the -e option as backup IDs.
Other options which can be used with vzarestore:
-d The path to the folder inside the Container backup archive whose contents is to be shown. This option can be used with the vzarestore --browse BACKUP_ID command only. Displays the parameters set in the Container configuration file at the moment of creating the backup with the specified backup ID. Removes the Container backup with the specified backup ID.
--print-ve-config BACKUP_ID -r, BACKUP_ID --remove

vzvssctl

The vzvssctl utility is used to suspend and resume the Container activity (e.g. during the backup operation). This utility has the following syntax:
vzvssctl -s [CT_ID] [.] vzvssctl -r [CT_ID] [.] vzvssctl --help
vzvssctl can be used with the following options:
-s -r --help, /? Suspends the Container activity. Resumes the Container activity. Displays the utility usage and exits.
Template Management Utilities
Template (or package set) is a set of original application files, repackaged for mounting over Virtuozzo File System. There are two types of templates in Virtuozzo: OS templates are used to create new Containers. A typical example of an OS template is the template containing the Windows Server 2003 distribution kit. An OS template cannot be installed into a Container, because any Container is already based on some OS template. Application templates can be installed into a Container after its creation; more than one application template may be installed in the same Container. Examples of application templates are the msde template, openssh template, or template with any other application (possibly more than one in single template) not included into the OS template for some reason.

-h, --help -f, --force --quiet --verbose Display the usage info and exit. Force template installation. Disables logging to the display and to the log file. Sets the log level to the maximum possible value for this vzpkgadd session.
A Container has to be running in order to apply a template to it.

vzpkgrm

This utility is used to uninstall an application template from a Container. It has the following syntax:
vzpkgrm [options] <CT_ID> PACKAGE[/VERSION].
This command will remove a template from the Container with the ID of <CT_ID>. You may specify a number of templates for uninstalling. You can use the following options with this command:
-h, --help -f, --force --quiet --verbose Display the usage info and exit. Force the template uninstallation from the specified Container. Disables logging to the display and to the log file. Sets the log level to the maximum possible value for this vzpkgrm session.
A Container has to be running in order to uninstall a template from it.

Supplementary Tools

vzsveinstall
This utility is used for the Service Container installation. The Service Container is needed for running the Parallels Agent software, which is used by Parallels Management Console and Parallels Infrastructure Manager. The syntax of this command is as follows:
vzsveinstall -s SCT_IP_Address [-t OS_Template] [-p] [-w] [-f]
This utility creates and starts the Service Container. This utility accepts the following options:
-h, --help -s <SCT_IP> -t <OS template> -p -w -u Displays the utility help. Required. The IP address to be assigned to the Service Container. Optional. OS template to use for the Service Container. By default, w2k3 is used. Optional. Reads the vzadmin password from the standard input. By default, it reads from the console. Optional. Allows to install the Parallels Infrastructure Manager application to the Service Container. Updates the Service Container.

vzkeygen

This utility is used to generate the Hardware Node ID to uniquely identify the Node. You should send your Node ID together with a Virtuozzo license request to the Parallels sales department to obtain a license for running Virtuozzo Containers 4.0. It has the following syntax:
vzkeygen [-n, --company-name NAME] [-o, --output-file FILENAME] vzkeygen [-h, --help]