ConVirt EnterpriseMain Page | About | Help | FAQ | Special pages | Log in

Printable version | Disclaimers | Privacy policy

3 x Installation

From ConVirt Enterprise


1 ConVirt Enterprise / ConVirt Enterprise Cloud Installation

Setting up the ConVirt Enterprise or ConVirt Enterprise Cloud environment involves:

Before you start, please review these pre-requisites to ensure your environment is ready for ConVirt.

Deployment Architecture
3 0 deployment.png

1.1 CMS Appliance Installation

The CMS appliance is a turnkey instance of the ConVirt Management Server, and is primarily used during the Trial process. If you plan to deploy to your production environment or customize the CMS, you will likely want to use the software installation instructions below.

Please review these pre-requisites before starting the installation process to ensure your environment is ready for ConVirt.

1.1.1 Set Up ConVirt Management Server Appliance

Install the ConVirt Management Server (CMS) as a Linux virtual appliance:

  1. Download the CMS appliance to your host server
    • Use the link you received in the Trial email from Convirture.
    • Use the file type appropriate for your platform
      • .ova for VMware environments
      • .gz for KVM/Xen environments (raw disk image)
      • for Hyper-V environments
  2. Deploy, start and connect to the CMS virtual appliance
    1. Start/connect on Xen
      1. Use the appliance xen config file information from here CMS Xen Trial Config, save it as a file named "cms" (no extension), and make the following change:
        • Change the path in the disk parameter to wherever you unpacked the CMS-disk1.img appliance file
        • Change the bridge name in the vif entry to the appropriate bridge for your network (in this example, its set to "br0")
        • Optionally, you can also change the "name" value in the config file
      2. Start the appliance using the config file name
        xm create cms
      3. Get the vnc port
        • Use xm list to get the DOMID of the appliance
        xenstore-read /local/domain/DOMID/console/vnc-port
      4. Connect to the appliance using vncviewer
        • Use the port obtained from previous command
        vncviewer :PORT_NO
    2. Start/connect on KVM
      1. Start the appliance using the following command
        • Change the path to the location where you created the CMS-disk.img disk
        qemu-system-x86_64 -hda "/mnt/storage/vm_disks/CMS-disk.img" -net "nic,vlan=0,macaddr=00:16:3e:20:d4:44" -net "user,vlan=0" -std-vga "" -boot "c" -m "2048" -vnc ":25" -name "convirt_appliance" -smp "2" -redir tcp:2222::22 -redir tcp:8888::8091 -daemonize
        /usr/libexec/qemu-kvm -hda "/mnt/storage/vm_disks/CMS-disk.img" -net "nic,vlan=0,macaddr=00:16:3e:20:d4:44" -net "user,vlan=0" -boot "c" -m "2048" -vnc ":25" -name "convirt_appliance" -smp "2" -redir tcp:2222::22 -redir tcp:8888::8091 -daemonize
      2. Connect to the appliance using vncviewer
        • Note that in the above command port :25 is used
        vncviewer :25
    3. Start/connect on Hyper-V
      • unzip the appliance to get the .vhd disk.
      • If you want to use the command line, open PowerShell as administrator on Host A and enter the following commands:
      New-VM -Name CMS -MemoryStartupBytes 4096MB -VHDPath <path_to_appliance_disk> -SwitchName hv-switch0
      Get-VM -Name CMS | Set-VM -ProcessorCount 2
      Get-VM -Name CMS | Start-VM
      • If you want to use Hyper-V Manager, use the following attributes:
        • Name = CMS
        • RAM = 4GB
        • Virtual CPU =2
        • Disk = use <path_to_appliance_disk>
        • Network = "hv-switch0"
      • Connect to the CMS virtual appliance console via Hyper-V Manager.
    4. Start/connect on VMware
      • Use the normal .OVA flow for importing a VMware appliance
      • Connect to the CMS virtual appliance console.
  3. Log in to the CMS virtual appliance - the credentials are:
    • user : cms
    • password : convirt
  4. Find the IP address of the appliance to use in your browser
    • Run ifconfig to find the IP assigned to the CMS appliance
    sudo ifconfig eth0
  5. Open the CMS in your browser and activate the license
    • Start Firefox browser on another machine on the network
    • Using the IP address your discovered above, type in the url http://ip-address:8091
      • Troubleshooting - if the CMS does not come up in your browser, make sure that it is setup and running on the CMS appliance correctly:
        • Go into the CMS appliance and setup the CMS
          cd convirt-enterprise
          ./convirt-ctl setup
        • Start the CMS
          ./convirt-ctl start
        • Open the CMS in your browser at http://ip-address:8091
      • Go to License Activation section to activate the deployment.
  6. If you wish to connect to Hyper-V VMs follow below steps
    • Edit following entries in development.ini
      vi ~/convirt-enterprise/convirt/web/convirt/development.ini
      • Configure following entry for posh server. For more details on how to configure posh server click here.
        poshserver_url=http://<posh server IP>:8080

1.2 Using Docker image from Docker hub

1.2.1 Create convirt-enterprise docker container

You can do this by running single command given below to download the image, create and start the container.
$ sudo docker run -d -p 8091:8091 --name cms-trial accelerite/convirt-enterprise
Alternatively, you can execute the following separate steps:
$ sudo docker pull accelerite/convirt-enterprise
$ sudo docker create -p 8091:8091 -p 6900-6999:6900-6999 --name cms-trial accelerite/convirt-enterprise /bin/bash -c "/home/cms/"
$ sudo docker start cms-trial

1.2.2 Setup and run ConVirt for the first time

Log on to the container.
$ sudo docker exec -it cms-trial bash
Run ConVirt setup script.
# /script/appliance/rc.local
Type "exit" or press ^D to come out of this shell.

1.2.3 Starting and stopping the container

After first time setup and run, you can start and stop the container using the followings commands:

$ sudo docker start cms-trial $ sudo docker stop cms-trial

1.2.4 Using ConVirt product

Once you start the container, use ConVirt product from a web browser by accessing the following URL:
Where docker-host is the host on which the docker container is running.
You will see license activation screen for the first time. Use information from trial email sent to fill in customer id and related information to activate your trial.
Note: ConVirt 3.4.6 allows users to access virtual machines through proxy. It supports console access for KVM, Xen, VMware and Hyper-V platforms. However, ConVirt 3.4.6 docker trial container does not support Hyper-V proxy at the moment.

1.3 License Activation

    • When the CMS opens, the License Management dialog will come up, so you can activate your trial license
    Licensemgmt licenseactivate.jpg
  1. Activate your Trial license
    • In the License Management-Activate License dialog, select the "Trial" radio button
    • Paste your Customer ID into the Customer ID text box
      • You received this ID in your ConVirt Trial Credentials email
    • Select "Activate" at the bottom of the dialog box
      • The CMS will connect to Convirture's license server
    • You should receive an alert "License applied successfully - Click OK to restart ConVirt". Click OK.
    Lic applied success.jpg
    • You should receive an alert "License activated successfully and ConVirt restarted - Click OK to login". Click OK.
    Lic activated success.jpg
    • You should see the Login panel for the CMS - login using the default credentials:
      • user : admin
      • password : admin

1.4 CMS Software Download and Installation

Convirt Enterprise 3.0 is currently supported for the following platforms:

If you would like to have ConVirt Enterprise for other distributions, please contact us using Contact Us page and let us know the exact Linux distribution, version and python version (python -V).

Follow the distribution specific instructions to get up and running within minutes. Once finished, please follow instruction in the section above "License Activation"

Ubuntu Distribution

Installation Instructions (Here is a Command Cheat Sheet )

CentOS/RHEL Distribution

Installation Instructions (Here is a Command Cheat Sheet )

SLES Distribution

Installation Instructions ((Here is a Command Cheat Sheet )

Retrieved from ""

This page has been accessed 60,055 times. This page was last modified on 25 February 2016, at 18:50.


Main page
Recent changes
Random page
View source
Editing help
This page
Discuss this page
New section
Printable version
Page history
What links here
Related changes
My pages
Log in / create account
Special pages
New pages
File list