0% found this document useful (0 votes)
216 views182 pages

Red Hat Virtualization-4.1-Virtual Machine Management Guide-en-US PDF

Uploaded by

Aung Aung
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
216 views182 pages

Red Hat Virtualization-4.1-Virtual Machine Management Guide-en-US PDF

Uploaded by

Aung Aung
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 182

Red Hat Virtualization 4.

Virtual Machine Management Guide

Managing Virtual Machines in Red Hat Virtualization

Last Updated: 2018-06-29


Red Hat Virtualization 4.1 Virtual Machine Management Guide
Managing Virtual Machines in Red Hat Virtualization

Red Hat Virtualization Documentation Team


Red Hat Customer Content Services
[email protected]
Legal Notice
Copyright © 2018 Red Hat.

This document is licensed by Red Hat under the Creative Commons Attribution-
ShareAlike 3.0 Unported License. If you distribute this document, or a modified version
of it, you must provide attribution to Red Hat, Inc. and provide a link to the original. If
the document is modified, all Red Hat trademarks must be removed.

Red Hat, as the licensor of this document, waives the right to enforce, and agrees not to
assert, Section 4d of CC-BY-SA to the fullest extent permitted by applicable law.

Red Hat, Red Hat Enterprise Linux, the Shadowman logo, JBoss, OpenShift, Fedora, the
Infinity logo, and RHCE are trademarks of Red Hat, Inc., registered in the United States
and other countries.

Linux ® is the registered trademark of Linus Torvalds in the United States and other
countries.

Java ® is a registered trademark of Oracle and/or its affiliates.

XFS ® is a trademark of Silicon Graphics International Corp. or its subsidiaries in the


United States and/or other countries.

MySQL ® is a registered trademark of MySQL AB in the United States, the European


Union and other countries.

Node.js ® is an official trademark of Joyent. Red Hat Software Collections is not formally
related to or endorsed by the official Joyent Node.js open source or commercial project.

The OpenStack ® Word Mark and OpenStack logo are either registered
trademarks/service marks or trademarks/service marks of the OpenStack Foundation, in
the United States and other countries and are used with the OpenStack Foundation's
permission. We are not affiliated with, endorsed or sponsored by the OpenStack
Foundation, or the OpenStack community.

All other trademarks are the property of their respective owners.

Abstract
This guide describes the installation, configuration, and administration of virtual
machines in Red Hat Virtualization.
Table of Contents

Table of Contents
.CHAPTER
. . . . . . . 1.
. . INTRODUCTION
............................................................4
.........
1.1. AUDIENCE 4
1.2. SUPPORTED VIRTUAL MACHINE OPERATING SYSTEMS 4
1.3. VIRTUAL MACHINE PERFORMANCE PARAMETERS 4
1.4. INSTALLING SUPPORTING COMPONENTS ON CLIENT MACHINES 5

.CHAPTER
. . . . . . . 2.
. . INSTALLING
. . . . . . . . . .LINUX
. . . . .VIRTUAL
. . . . . . . MACHINES
......................................7
.........
2.1. CREATING A LINUX VIRTUAL MACHINE 7
2.2. STARTING THE VIRTUAL MACHINE 9
2.3. SUBSCRIBING TO THE REQUIRED ENTITLEMENTS 11
2.4. INSTALLING GUEST AGENTS AND DRIVERS 12

.CHAPTER
. . . . . . . 3.
. . INSTALLING
. . . . . . . . . .WINDOWS
. . . . . . . . VIRTUAL
. . . . . . . MACHINES
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
..........
3.1. CREATING A WINDOWS VIRTUAL MACHINE 16
3.2. STARTING THE VIRTUAL MACHINE USING THE RUN ONCE OPTION 18
3.3. INSTALLING GUEST AGENTS AND DRIVERS 19

. . . . . . . . 4.
CHAPTER . . ADDITIONAL
. . . . . . . . . . CONFIGURATION
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
..........
4.1. CONFIGURING SINGLE SIGN-ON FOR VIRTUAL MACHINES 25
4.2. CONFIGURING USB DEVICES 30
4.3. CONFIGURING MULTIPLE MONITORS 32
4.4. CONFIGURING CONSOLE OPTIONS 33
4.5. CONFIGURING A WATCHDOG 42
4.6. CONFIGURING VIRTUAL NUMA 47
4.7. CONFIGURING RED HAT SATELLITE ERRATA MANAGEMENT FOR A VIRTUAL MACHINE 48
4.8. CONFIGURING HEADLESS VIRTUAL MACHINES 49

.CHAPTER
. . . . . . . 5.
. . EDITING
. . . . . . .VIRTUAL
. . . . . . .MACHINES
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
..........
5.1. EDITING VIRTUAL MACHINE PROPERTIES 51
5.2. EDITING IO THREADS 52
5.3. NETWORK INTERFACES 52
5.4. VIRTUAL DISKS 54
5.5. HOT PLUGGING VIRTUAL MEMORY 59
5.6. HOT PLUGGING VCPUS 61
5.7. PINNING A VIRTUAL MACHINE TO MULTIPLE HOSTS 62
5.8. CHANGING THE CD FOR A VIRTUAL MACHINE 63
5.9. SMART CARD AUTHENTICATION 64

.CHAPTER
. . . . . . . 6.
. . ADMINISTRATIVE
. . . . . . . . . . . . . .TASKS
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
..........
6.1. SHUTTING DOWN A VIRTUAL MACHINE 66
6.2. SUSPENDING A VIRTUAL MACHINE 66
6.3. REBOOTING A VIRTUAL MACHINE 66
6.4. REMOVING A VIRTUAL MACHINE 67
6.5. CLONING A VIRTUAL MACHINE 67
6.6. UPDATING VIRTUAL MACHINE GUEST AGENTS AND DRIVERS 67
6.7. VIEWING RED HAT SATELLITE ERRATA FOR A VIRTUAL MACHINE 69
6.8. VIRTUAL MACHINES AND PERMISSIONS 69
6.9. SNAPSHOTS 73
6.10. HOST DEVICES 78
6.11. AFFINITY GROUPS 80
6.12. EXPORTING AND IMPORTING VIRTUAL MACHINES AND TEMPLATES 82
6.13. MIGRATING VIRTUAL MACHINES BETWEEN HOSTS 99
6.14. IMPROVING UPTIME WITH VIRTUAL MACHINE HIGH AVAILABILITY 106

1
Virtual Machine Management Guide

6.15. OTHER VIRTUAL MACHINE TASKS 108

.CHAPTER
. . . . . . . 7.
. . TEMPLATES
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
...........
7.1. SEALING VIRTUAL MACHINES IN PREPARATION FOR DEPLOYMENT AS TEMPLATES 115
7.2. CREATING A TEMPLATE 117
7.3. EDITING A TEMPLATE 118
7.4. DELETING A TEMPLATE 118
7.5. EXPORTING TEMPLATES 119
7.6. IMPORTING TEMPLATES 120
7.7. TEMPLATES AND PERMISSIONS 121
7.8. USING CLOUD-INIT TO AUTOMATE THE CONFIGURATION OF VIRTUAL MACHINES 124
7.9. USING SYSPREP TO AUTOMATE THE CONFIGURATION OF VIRTUAL MACHINES 127
7.10. CREATING A VIRTUAL MACHINE BASED ON A TEMPLATE 129
7.11. CREATING A CLONED VIRTUAL MACHINE BASED ON A TEMPLATE 130

APPENDIX A. REFERENCE: SETTINGS IN ADMINISTRATION PORTAL AND USER PORTAL


. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132
WINDOWS ...........
A.1. EXPLANATION OF SETTINGS IN THE NEW VIRTUAL MACHINE AND EDIT VIRTUAL MACHINE
WINDOWS 132
A.2. EXPLANATION OF SETTINGS IN THE NEW NETWORK INTERFACE AND EDIT NETWORK INTERFACE
WINDOWS 159
A.3. EXPLANATION OF SETTINGS IN THE NEW VIRTUAL DISK AND EDIT VIRTUAL DISK WINDOWS
161
A.4. EXPLANATION OF SETTINGS IN THE NEW TEMPLATE WINDOW 168
A.5. EXPLANATION OF SETTINGS IN THE RUN ONCE WINDOW 170

. . . . . . . . .B.
APPENDIX . .VIRT-SYSPREP
. . . . . . . . . . . .OPERATIONS
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178
...........

2
Table of Contents

3
Virtual Machine Management Guide

CHAPTER 1. INTRODUCTION
A virtual machine is a software implementation of a computer. The Red Hat Virtualization
environment enables you to create virtual desktops and virtual servers.

Virtual machines consolidate computing tasks and workloads. In traditional computing


environments, workloads usually run on individually administered and upgraded servers.
Virtual machines reduce the amount of hardware and administration required to run the
same computing tasks and workloads.

1.1. AUDIENCE
Most virtual machine tasks in Red Hat Virtualization can be performed in both the User
Portal and Administration Portal. However, the user interface differs between each portal,
and some administrative tasks require access to the Administration Portal. Tasks that can
only be performed in the Administration Portal will be described as such in this book. Which
portal you use, and which tasks you can perform in each portal, is determined by your level
of permissions. Virtual machine permissions are explained in Section 6.8, “Virtual Machines
and Permissions”.

IMPORTANT

As a technology preview a link to the new VM Portal is available on the Red


Hat Virtualization Welcome Page. The VM Portal provides the same
functionality that is currently available in the Basic tab of the current User
Portal. In a future release theUser Portal will be deprecated and replaced
by the VM Portal. The VM Portal is a Technology Preview feature only.
Technology Preview features are not supported with Red Hat production
service level agreements (SLAs), might not be functionally complete, and Red
Hat does not recommend using them for production. These features provide
early access to upcoming product features, enabling customers to test
functionality and to provide feedback during the development process.

The User Portal's user interface is described in the Introduction to the User Portal.

The Administration Portal's user interface is described in the Introduction to the


Administration Portal.

The creation and management of virtual machines through the Red Hat Virtualization REST
API is documented in the REST API Guide.

1.2. SUPPORTED VIRTUAL MACHINE OPERATING SYSTEMS


For information on the operating systems that can be virtualized as guest operating
systems in Red Hat Virtualization, see https://access.redhat.com/articles/973163.

1.3. VIRTUAL MACHINE PERFORMANCE PARAMETERS


For more information on the parameters that Red Hat Virtualization virtual machines can
support see Red Hat Enterprise Linux technology capabilities and limitsand Virtualization
limits for Red Hat Enterprise Virtualization.

4
CHAPTER 1. INTRODUCTION

1.4. INSTALLING SUPPORTING COMPONENTS ON CLIENT


MACHINES

1.4.1. Installing Console Components


A console is a graphical window that allows you to view the start up screen, shut down
screen, and desktop of a virtual machine, and to interact with that virtual machine in a
similar way to a physical machine. In Red Hat Virtualization, the default application for
opening a console to a virtual machine is Remote Viewer, which must be installed on the
client machine prior to use.

1.4.1.1. Installing Remote Viewer on Red Hat Enterprise Linux

The Remote Viewer application provides users with a graphical console for connecting to
virtual machines. Once installed, it is called automatically when attempting to open a SPICE
session with a virtual machine. Alternatively, it can also be used as a standalone
application. Remote Viewer is included in the virt-viewer package provided by the base Red
Hat Enterprise Linux Workstation and Red Hat Enterprise Linux Server repositories.

Procedure 1.1. Installing Remote Viewer on Linux

1. Install the virt-viewer package:

# yum install virt-viewer

2. Restart your browser for the changes to take effect.

You can now connect to your virtual machines using either the SPICE protocol or the VNC
protocol.

1.4.1.2. Installing Remote Viewer on Windows

The Remote Viewer application provides users with a graphical console for connecting to
virtual machines. Once installed, it is called automatically when attempting to open a SPICE
session with a virtual machine. Alternatively, it can also be used as a standalone
application.

Procedure 1.2. Installing Remote Viewer on Windows

1. Open a web browser and download one of the following installers according to the
architecture of your system.

Virt Viewer for 32-bit Windows:

https://your-manager-fqdn/ovirt-engine/services/files/spice/virt-
viewer-x86.msi

Virt Viewer for 64-bit Windows:

https://your-manager-fqdn/ovirt-engine/services/files/spice/virt-
viewer-x64.msi

2. Open the folder where the file was saved.

5
Virtual Machine Management Guide

3. Double-click the file.

4. Click Run if prompted by a security warning.

5. Click Yes if prompted by User Account Control.

Remote Viewer is installed and can be accessed via Remote Viewer in the VirtViewer
folder of All Programs in the start menu.

1.4.2. Installing usbdk on Windows


usbdk is a driver that enables remote-viewer exclusive access to USB devices on
Windows operating systems. Installing usbdk requires Administrator privileges. Note that
the previously supported USB Clerk option has been deprecated and is no longer
supported.

Procedure 1.3. Installing usbdk on Windows

1. Open a web browser and download one of the following installers according to the
architecture of your system.

usbdk for 32-bit Windows:

https://[your manager's address]/ovirt-


engine/services/files/spice/usbdk-x86.msi

usbdk for 64-bit Windows:

https://[your manager's address]/ovirt-


engine/services/files/spice/usbdk-x64.msi

2. Open the folder where the file was saved.

3. Double-click the file.

4. Click Run if prompted by a security warning.

5. Click Yes if prompted by User Account Control.

6
CHAPTER 2. INSTALLING LINUX VIRTUAL MACHINES

CHAPTER 2. INSTALLING LINUX VIRTUAL MACHINES


This chapter describes the steps required to install a Linux virtual machine:

1. Create a blank virtual machine on which to install an operating system.

2. Add a virtual disk for storage.

3. Add a network interface to connect the virtual machine to the network.

4. Install an operating system on the virtual machine. See your operating system's
documentation for instructions.

Red Hat Enterprise Linux 6: https://access.redhat.com/documentation/en-


US/Red_Hat_Enterprise_Linux/6/html/Installation_Guide/index.html

Red Hat Enterprise Linux 7: https://access.redhat.com/documentation/en-


US/Red_Hat_Enterprise_Linux/7/html/Installation_Guide/index.html

Red Hat Enterprise Linux Atomic Host 7:


https://access.redhat.com/documentation/en/red-hat-enterprise-linux-atomic-
host/7/single/installation-and-configuration-guide/

5. Register the virtual machine with the Content Delivery Network and subscribe to the
relevant entitlements.

6. Install guest agents and drivers for additional virtual machine functionality.

When all of these steps are complete, the new virtual machine is functional and ready to
perform tasks.

2.1. CREATING A LINUX VIRTUAL MACHINE


Create a new virtual machine and configure the required settings.

Procedure 2.1. Creating Linux Virtual Machines

1. Click the Virtual Machines tab.

2. Click the New VM button to open the New Virtual Machine window.

7
Virtual Machine Management Guide

Figure 2.1. The New Virtual Machine Window

3. Select a Linux variant from the Operating System drop-down list.

4. Enter a Name for the virtual machine.

5. Add storage to the virtual machine. Attach or Create a virtual disk under Instance
Images.

Click Attach and select an existing virtual disk.

Click Create and enter a Size(GB) and Alias for a new virtual disk. You can
accept the default settings for all other fields, or change them if required. See
Section A.3, “Explanation of Settings in the New Virtual Disk and Edit Virtual Disk
Windows” for more details on the fields for all disk types.

6. Connect the virtual machine to the network. Add a network interface by selecting a
vNIC profile from the nic1 drop-down list at the bottom of theGeneral tab.

7. Specify the virtual machine's Memory Size on the System tab.

8. Choose the First Device that the virtual machine will boot from on theBoot
Options tab.

9. You can accept the default settings for all other fields, or change them if required.
For more details on all fields in the New Virtual Machine window, see Section A.1,
“Explanation of Settings in the New Virtual Machine and Edit Virtual Machine
Windows”.

10. Click OK.

8
CHAPTER 2. INSTALLING LINUX VIRTUAL MACHINES

The new virtual machine is created and displays in the list of virtual machines with a status
of Down. Before you can use this virtual machine, you must install an operating system and
register with the Content Delivery Network.

2.2. STARTING THE VIRTUAL MACHINE

2.2.1. Starting a Virtual Machine

Procedure 2.2. Starting Virtual Machines

1. Click the Virtual Machines tab and select a virtual machine with a status ofDown.

2. Click the run ( ) button.

Alternatively, right-click the virtual machine and select Run.

The Status of the virtual machine changes toUp, and the operating system installation
begins. Open a console to the virtual machine if one does not open automatically.

NOTE

A virtual machine will not start on a host that the CPU is overloaded on. By
default, a host's CPU is considered overloaded if it has a load of more than
80% for 5 minutes but these values can be changed using scheduling policies.
See Scheduling Policies in the Administration Guide for more information.

2.2.2. Opening a Console to a Virtual Machine


Use Remote Viewer to connect to a virtual machine.

Procedure 2.3. Connecting to Virtual Machines

1. Install Remote Viewer if it is not already installed. See Section 1.4.1, “Installing
Console Components”.

2. Click the Virtual Machines tab and select a virtual machine.

3. Click the console button or right-click the virtual machine and select Console. A
console.vv file will be downloaded. Click on the file and a console window will
automatically open for the virtual machine.

NOTE

You can configure the system to automatically connect to a virtual machine.


See Section 2.2.4, “Automatically Connecting to a Virtual Machine”.

2.2.3. Opening a Serial Console to a Virtual Machine


Access a virtual machine's serial console from the command line, instead of opening a
console from the Administration Portal or the User Portal. The serial console is emulated
through VirtIO channels, using SSH and key pairs, and does not require direct access to the
Manager; the Manager acts as a proxy for the connection, provides information about

9
Virtual Machine Management Guide

virtual machine placement, and stores the authentication keys. You can add public keys for
each user from either the Administration Portal or the User Portal. You can access serial
consoles for only those virtual machines for which you have appropriate permissions.

IMPORTANT

To access the serial console of a virtual machine, the user must have the
UserVmManager, SuperUser, or UserInstanceManager permission on that
virtual machine. These permissions must be explicitly defined per user; it is not
enough to assign these permissions for Everyone.

The serial console is accessed via TCP port 2222 on the Manager. This port is opened during
engine-setup on new installations. The serial console relies on theovirt-vmconsole
package and the ovirt-vmconsole-proxy on the Manager, and the ovirt-vmconsole package
and the ovirt-vmconsole-host package on virtualization hosts. These packages are installed
by default on new installations. To install the packages on existing installations, reinstall the
host. See Reinstalling Hosts in the Administration Guide.

Procedure 2.4. Connecting to a Virtual Machine Serial Console

1. On the client machine from which you will access the virtual machine serial console,
generate an SSH key pair. The Manager supports standard SSH key types. For
example, generate an RSA key:

# ssh-keygen -t rsa -b 2048 -C "admin@internal" -f


.ssh/serialconsolekey

This command generates a public key and a private key.

2. In the Administration Portal or the User Portal, click the name of the signed-in user
on the header bar, and then click Options to open the Edit Options window.

3. In the User's Public Key text field, paste the public key of the client machine that
will be used to access the serial console.

4. Click the Virtual Machines tab and select a virtual machine.

5. Click Edit.

6. In the Console tab of the Edit Virtual Machine window, select the Enable
VirtIO serial console check box.

7. On the client machine, connect to the virtual machine's serial console:

a. If a single virtual machine is available, this command connects the user to that
virtual machine:

# ssh -t -p 2222 ovirt-vmconsole@MANAGER_IP


Red Hat Enterprise Linux Server release 6.7 (Santiago)
Kernel 2.6.32-573.3.1.el6.x86_64 on an x86_64
USER login:

If more than one virtual machine is available, this command lists the available
virtual machines:

10
CHAPTER 2. INSTALLING LINUX VIRTUAL MACHINES

# ssh -t -p 2222 ovirt-vmconsole@MANAGER_IP


1. vm1 [vmid1]
2. vm2 [vmid2]
3. vm3 [vmid3]
> 2
Red Hat Enterprise Linux Server release 6.7 (Santiago)
Kernel 2.6.32-573.3.1.el6.x86_64 on an x86_64
USER login:

Enter the number of the machine to which you want to connect, and press
Enter.

b. Alternatively, connect directly to a virtual machine using its unique identifier or


its name:

# ssh -t -p 2222 ovirt-vmconsole@MANAGER_IP --vm-id vmid1

# ssh -t -p 2222 ovirt-vmconsole@MANAGER_IP --vm-name vm1

IMPORTANT

If the serial console session is disconnected abnormally, a TCP timeout occurs.


You will be unable to reconnect to the virtual machine's serial console until the
timeout period expires.

2.2.4. Automatically Connecting to a Virtual Machine


Once you have logged in, you can automatically connect to a single running virtual
machine. This can be configured from the Options window.

Procedure 2.5. Automatically Connecting to a Virtual Machine

1. Click the name of the signed-in user on the header bar then click Options to open
the Edit Options window.

2. Click the Connect Automatically check box.

3. Click OK.

The next time you log into the User Portal, if you have only one running virtual machine,
you will automatically connect to that machine.

2.3. SUBSCRIBING TO THE REQUIRED ENTITLEMENTS


To install packages signed by Red Hat you must register the target system to the Content
Delivery Network. Then, use an entitlement from your subscription pool and enable the
required repositories.

Procedure 2.6. Subscribing to the Required Entitlements Using Subscription


Manager

1. Register your system with the Content Delivery Network, entering your Customer
Portal user name and password when prompted:

11
Virtual Machine Management Guide

# subscription-manager register

2. Locate the relevant subscription pools and note down the pool identifiers.

# subscription-manager list --available

3. Use the pool identifiers located in the previous step to attach the required
entitlements.

# subscription-manager attach --pool=pool_id

4. Disable all existing repositories:

# subscription-manager repos --disable=*

5. When a system is subscribed to a subscription pool with multiple repositories, only


the main repository is enabled by default. Others are available, but disabled. Enable
any additional repositories:

# subscription-manager repos --enable=repository

6. Ensure that all packages currently installed are up to date:

# yum update

2.4. INSTALLING GUEST AGENTS AND DRIVERS

2.4.1. Red Hat Virtualization Guest Agents and Drivers


The Red Hat Virtualization guest agents and drivers provide additional information and
functionality for Red Hat Enterprise Linux and Windows virtual machines. Key features
include the ability to monitor resource usage and gracefully shut down or reboot virtual
machines from the User Portal and Administration Portal. Install the Red Hat Virtualization
guest agents and drivers on each virtual machine on which this functionality is to be
available.

Table 2.1. Red Hat Virtualization Guest Drivers

Driver Description Works on

virtio-net Paravirtualized network driver Server and Desktop.


provides enhanced
performance over emulated
devices like rtl.

12
CHAPTER 2. INSTALLING LINUX VIRTUAL MACHINES

Driver Description Works on

virtio-block Paravirtualized HDD driver Server and Desktop.


offers increased I/O
performance over emulated
devices like IDE by optimizing
the coordination and
communication between the
guest and the hypervisor. The
driver complements the
software implementation of
the virtio-device used by the
host to play the role of a
hardware device.

virtio-scsi Paravirtualized iSCSI HDD Server and Desktop.


driver offers similar
functionality to the virtio-
block device, with some
additional enhancements. In
particular, this driver supports
adding hundreds of devices,
and names devices using the
standard SCSI device naming
scheme.

virtio-serial Virtio-serial provides support Server and Desktop.


for multiple serial ports. The
improved performance is used
for fast communication
between the guest and the
host that avoids network
complications. This fast
communication is required for
the guest agents and for
other features such as
clipboard copy-paste between
the guest and the host and
logging.

virtio-balloon Virtio-balloon is used to Server and Desktop.


control the amount of
memory a guest actually
accesses. It offers improved
memory over-commitment.
The balloon drivers are
installed for future
compatibility but not used by
default in Red Hat
Virtualization.

qxl A paravirtualized display Server and Desktop.


driver reduces CPU usage on
the host and provides better
performance through reduced
network bandwidth on most
workloads.

Table 2.2. Red Hat Virtualization Guest Agents and Tools

13
Virtual Machine Management Guide

Guest agent/tool Description Works on

ovirt-guest-agent- Allows the Red Hat Server and Desktop.


common Virtualization Manager to
receive guest internal events
and information such as IP
address and installed
applications. Also allows the
Manager to execute specific
commands, such as shut
down or reboot, on a guest.

On Red Hat Enterprise Linux


6 and later guests, the ovirt-
guest-agent-common installs
tuned on your virtual
machine and configures it to
use an optimized, virtualized-
guest profile.

spice-agent The SPICE agent supports Server and Desktop.


multiple monitors and is
responsible for client-mouse-
mode support to provide a
better user experience and
improved responsiveness
than the QEMU emulation.
Cursor capture is not needed
in client-mouse-mode. The
SPICE agent reduces
bandwidth usage when used
over a wide area network by
reducing the display level,
including color depth,
disabling wallpaper, font
smoothing, and animation.
The SPICE agent enables
clipboard support allowing cut
and paste operations for both
text and images between
client and guest, and
automatic guest display
setting according to client-
side settings. On Windows
guests, the SPICE agent
consists of vdservice and
vdagent.

rhev-sso An agent that enables users Desktop.


to automatically log in to their
virtual machines based on the
credentials used to access the
Red Hat Virtualization
Manager.

2.4.2. Installing the Guest Agents and Drivers on Red Hat Enterprise
Linux

14
CHAPTER 2. INSTALLING LINUX VIRTUAL MACHINES

The Red Hat Virtualization guest agents and drivers are installed on Red Hat Enterprise
Linux virtual machines using the ovirt-guest-agent package provided by the Red Hat
Virtualization Agent repository.

Procedure 2.7. Installing the Guest Agents and Drivers on Red Hat Enterprise
Linux

1. Log in to the Red Hat Enterprise Linux virtual machine.

2. Enable the Red Hat Virtualization Agent repository:

For Red Hat Enterprise Linux 6

# subscription-manager repos --enable=rhel-6-server-rhv-4-agent-


rpms

For Red Hat Enterprise Linux 7

# subscription-manager repos --enable=rhel-7-server-rh-common-


rpms

3. Install the ovirt-guest-agent-common package and dependencies:

# yum install ovirt-guest-agent-common

4. Start and enable the service:

For Red Hat Enterprise Linux 6

# service ovirt-guest-agent start


# chkconfig ovirt-guest-agent on

For Red Hat Enterprise Linux 7

# systemctl start ovirt-guest-agent.service


# systemctl enable ovirt-guest-agent.service

5. Start and enable the qemu-ga service:

For Red Hat Enterprise Linux 6

# service qemu-ga start


# chkconfig qemu-ga on

For Red Hat Enterprise Linux 7

# systemctl start qemu-guest-agent.service


# systemctl enable qemu-guest-agent.service

The guest agent now passes usage information to the Red Hat Virtualization Manager. The
Red Hat Virtualization agent runs as a service called ovirt-guest-agent that you can
configure via the ovirt-guest-agent.conf configuration file in the /etc/ directory.

15
Virtual Machine Management Guide

CHAPTER 3. INSTALLING WINDOWS VIRTUAL


MACHINES
This chapter describes the steps required to install a Windows virtual machine:

1. Create a blank virtual machine on which to install an operating system.

2. Add a virtual disk for storage.

3. Add a network interface to connect the virtual machine to the network.

4. Attach the virtio-win.vfd diskette to the virtual machine so that VirtIO-optimized


device drivers can be installed during the operating system installation.

5. Install an operating system on the virtual machine. See your operating system's
documentation for instructions.

6. Install guest agents and drivers for additional virtual machine functionality.

When all of these steps are complete, the new virtual machine is functional and ready to
perform tasks.

3.1. CREATING A WINDOWS VIRTUAL MACHINE


Create a new virtual machine and configure the required settings.

Procedure 3.1. Creating Windows Virtual Machines

1. You can change the default virtual machine name length with the engine-config
tool. Run the following command on the Manager machine:

# engine-config --set MaxVmNameLength=integer

2. Click the Virtual Machines tab.

3. Click New VM to open the New Virtual Machine window.

16
CHAPTER 3. INSTALLING WINDOWS VIRTUAL MACHINES

Figure 3.1. The New Virtual Machine Window

4. Select a Windows variant from the Operating System drop-down list.

5. Enter a Name for the virtual machine.

6. Add storage to the virtual machine. Attach or Create a virtual disk under Instance
Images.

Click Attach and select an existing virtual disk.

Click Create and enter a Size(GB) and Alias for a new virtual disk. You can
accept the default settings for all other fields, or change them if required. See
Section A.3, “Explanation of Settings in the New Virtual Disk and Edit Virtual Disk
Windows” for more details on the fields for all disk types.

7. Connect the virtual machine to the network. Add a network interface by selecting a
vNIC profile from the nic1 drop-down list at the bottom of theGeneral tab.

8. Specify the virtual machine's Memory Size on the System tab.

9. Choose the First Device that the virtual machine will boot from on theBoot
Options tab.

10. You can accept the default settings for all other fields, or change them if required.
For more details on all fields in the New Virtual Machine window, see Section A.1,
“Explanation of Settings in the New Virtual Machine and Edit Virtual Machine
Windows”.

11. Click OK.

17
Virtual Machine Management Guide

The new virtual machine is created and displays in the list of virtual machines with a status
of Down. Before you can use this virtual machine, you must install an operating system and
VirtIO-optimized disk and network drivers.

3.2. STARTING THE VIRTUAL MACHINE USING THE RUN


ONCE OPTION

3.2.1. Installing Windows on VirtIO-Optimized Hardware


Install VirtIO-optimized disk and network device drivers during your Windows installation by
attaching the virtio-win.vfd diskette to your virtual machine. These drivers provide a
performance improvement over emulated device drivers.

Use the Run Once option to attach the diskette in a one-off boot different from theBoot
Options defined in the New Virtual Machine window. This procedure presumes that you
added a Red Hat VirtIO network interface and a disk that uses theVirtIO interface to
your virtual machine.

NOTE

The virtio-win.vfd diskette is placed automatically on ISO storage domains


that are hosted on the Manager server. An administrator must manually
upload it to other ISO storage domains using the engine-iso-uploader tool.

Procedure 3.2. Installing VirtIO Drivers during Windows Installation

1. Click the Virtual Machines tab and select a virtual machine.

2. Click Run Once.

3. Expand the Boot Options menu.

4. Select the Attach Floppy check box, and select virtio-win.vfd from the drop-
down list.

5. Select the Attach CD check box, and select the required Windows ISO from the
drop-down list.

6. Move CD-ROM to the top of the Boot Sequence field.

7. Configure the rest of your Run Once options as required. See Section A.5,
“Explanation of Settings in the Run Once Window” for more details.

8. Click OK.

The Status of the virtual machine changes toUp, and the operating system installation
begins. Open a console to the virtual machine if one does not open automatically.

Windows installations include an option to load additional drivers early in the installation
process. Use this option to load drivers from the virtio-win.vfd diskette that was
attached to your virtual machine as A:. For each supported virtual machine architecture
and Windows version, there is a folder on the disk containing optimized hardware device
drivers.

18
CHAPTER 3. INSTALLING WINDOWS VIRTUAL MACHINES

3.2.2. Opening a Console to a Virtual Machine


Use Remote Viewer to connect to a virtual machine.

Procedure 3.3. Connecting to Virtual Machines

1. Install Remote Viewer if it is not already installed. See Section 1.4.1, “Installing
Console Components”.

2. Click the Virtual Machines tab and select a virtual machine.

3. Click the console button or right-click the virtual machine and select Console.

4. If the connection protocol is set to SPICE, a console window will automatically


open for the virtual machine.

If the connection protocol is set to VNC, a console.vv file will be downloaded.


Click on the file and a console window will automatically open for the virtual
machine.

NOTE

You can configure the system to automatically connect to a virtual machine.


See Section 2.2.4, “Automatically Connecting to a Virtual Machine”.

3.3. INSTALLING GUEST AGENTS AND DRIVERS

3.3.1. Red Hat Virtualization Guest Agents and Drivers


The Red Hat Virtualization guest agents and drivers provide additional information and
functionality for Red Hat Enterprise Linux and Windows virtual machines. Key features
include the ability to monitor resource usage and gracefully shut down or reboot virtual
machines from the User Portal and Administration Portal. Install the Red Hat Virtualization
guest agents and drivers on each virtual machine on which this functionality is to be
available.

Table 3.1. Red Hat Virtualization Guest Drivers

Driver Description Works on

virtio-net Paravirtualized network driver Server and Desktop.


provides enhanced
performance over emulated
devices like rtl.

19
Virtual Machine Management Guide

Driver Description Works on

virtio-block Paravirtualized HDD driver Server and Desktop.


offers increased I/O
performance over emulated
devices like IDE by optimizing
the coordination and
communication between the
guest and the hypervisor. The
driver complements the
software implementation of
the virtio-device used by the
host to play the role of a
hardware device.

virtio-scsi Paravirtualized iSCSI HDD Server and Desktop.


driver offers similar
functionality to the virtio-
block device, with some
additional enhancements. In
particular, this driver supports
adding hundreds of devices,
and names devices using the
standard SCSI device naming
scheme.

virtio-serial Virtio-serial provides support Server and Desktop.


for multiple serial ports. The
improved performance is used
for fast communication
between the guest and the
host that avoids network
complications. This fast
communication is required for
the guest agents and for
other features such as
clipboard copy-paste between
the guest and the host and
logging.

virtio-balloon Virtio-balloon is used to Server and Desktop.


control the amount of
memory a guest actually
accesses. It offers improved
memory over-commitment.
The balloon drivers are
installed for future
compatibility but not used by
default in Red Hat
Virtualization.

qxl A paravirtualized display Server and Desktop.


driver reduces CPU usage on
the host and provides better
performance through reduced
network bandwidth on most
workloads.

20
CHAPTER 3. INSTALLING WINDOWS VIRTUAL MACHINES

Table 3.2. Red Hat Virtualization Guest Agents and Tools

Guest agent/tool Description Works on

ovirt-guest-agent- Allows the Red Hat Server and Desktop.


common Virtualization Manager to
receive guest internal events
and information such as IP
address and installed
applications. Also allows the
Manager to execute specific
commands, such as shut
down or reboot, on a guest.

On Red Hat Enterprise Linux


6 and later guests, the ovirt-
guest-agent-common installs
tuned on your virtual
machine and configures it to
use an optimized, virtualized-
guest profile.

spice-agent The SPICE agent supports Server and Desktop.


multiple monitors and is
responsible for client-mouse-
mode support to provide a
better user experience and
improved responsiveness
than the QEMU emulation.
Cursor capture is not needed
in client-mouse-mode. The
SPICE agent reduces
bandwidth usage when used
over a wide area network by
reducing the display level,
including color depth,
disabling wallpaper, font
smoothing, and animation.
The SPICE agent enables
clipboard support allowing cut
and paste operations for both
text and images between
client and guest, and
automatic guest display
setting according to client-
side settings. On Windows
guests, the SPICE agent
consists of vdservice and
vdagent.

rhev-sso An agent that enables users Desktop.


to automatically log in to their
virtual machines based on the
credentials used to access the
Red Hat Virtualization
Manager.

3.3.2. Installing the Guest Agents and Drivers on Windows


The Red Hat Virtualization guest agents and drivers are installed on Windows virtual

21
Virtual Machine Management Guide

machines using the rhev-tools-setup.iso ISO file, which is provided by therhev-guest-


tools-iso package installed as a dependency to the Red Hat Virtualization Manager. ThisISO
file is located in /usr/share/rhev-guest-tools-iso/rhev-tools-setup.iso on the
system on which the Red Hat Virtualization Manager is installed.

NOTE

The rhev-tools-setup.iso ISO file is automatically copied to the default ISO


storage domain, if any, when you run engine-setup, or must be manually
uploaded to an ISO storage domain.

NOTE

Updated versions of the rhev-tools-setup.iso ISO file must be manually


attached to running Windows virtual machines to install updated versions of
the tools and drivers. If the APT service is enabled on virtual machines, the
updated ISO files will be automatically attached.

NOTE

If you install the guest agents and drivers from the command line or as part of
a deployment tool such as Windows Deployment Services, you can append the
options ISSILENTMODE and ISNOREBOOT to RHEV-toolsSetup.exe to silently
install the guest agents and drivers and prevent the machine on which they
have been installed from rebooting immediately after installation. The
machine can then be rebooted later once the deployment process is complete.

D:\RHEV-toolsSetup.exe ISSILENTMODE ISNOREBOOT

Procedure 3.4. Installing the Guest Agents and Drivers on Windows

1. Log in to the virtual machine.

2. Select the CD Drive containing the rhev-tools-setup.iso file.

3. Double-click RHEV-toolsSetup.

4. Click Next at the welcome screen.

5. Follow the prompts on the RHEV-Tools InstallShield Wizard window. Ensure all
check boxes in the list of components are selected.

22
CHAPTER 3. INSTALLING WINDOWS VIRTUAL MACHINES

Figure 3.2. Selecting All Components of Red Hat Virtualization Tools for
Installation

6. Once installation is complete, select Yes, I want to restart my computer now


and click Finish to apply the changes.

The guest agents and drivers now pass usage information to the Red Hat Virtualization
Manager and allow you to access USB devices, single sign-on into virtual machines and
other functionality. The Red Hat Virtualization guest agent runs as a service called RHEV
Agent that you can configure using therhev-agent configuration file located in C:\Program
Files\Redhat\RHEV\Drivers\Agent.

3.3.3. Automating Guest Additions on Windows Guests with Red Hat


Virtualization Application Provisioning Tool(APT)
Red Hat Virtualization Application Provisioning Tool (APT) is a Windows service that can be
installed on Windows virtual machines and templates. When the APT service is installed and
running on a virtual machine, attached ISO files are automatically scanned. When the
service recognizes a valid Red Hat Virtualization guest tools ISO, and no other guest tools
are installed, the APT service installs the guest tools. If guest tools are already installed,
and the ISO image contains newer versions of the tools, the service performs an automatic
upgrade. This procedure assumes you have attached the rhev-tools-setup.iso ISO file to
the virtual machine.

Procedure 3.5. Installing the APT Service on Windows

1. Log in to the virtual machine.

23
Virtual Machine Management Guide

2. Select the CD Drive containing the rhev-tools-setup.iso file.

3. Double-click RHEV-Application Provisioning Tool.

4. Click Yes in the User Account Control window.

5. Once installation is complete, ensure the Start RHEV-apt Service check box is
selected in the RHEV-Application Provisioning Tool InstallShield Wizard
window, and click Finish to apply the changes.

Once the APT service has successfully installed or upgraded the guest tools on a virtual
machine, the virtual machine is automatically rebooted; this happens without confirmation
from the user logged in to the machine. The APT Service will also perform these operations
when a virtual machine created from a template that has the APT Service already installed
is booted for the first time.

NOTE

The RHEV-apt service can be stopped immediately after install by clearing


the Start RHEV-apt Service check box. You can stop, start, or restart the
service at any time using the Services window.

24
CHAPTER 4. ADDITIONAL CONFIGURATION

CHAPTER 4. ADDITIONAL CONFIGURATION

4.1. CONFIGURING SINGLE SIGN-ON FOR VIRTUAL


MACHINES
Configuring single sign-on, also known as password delegation, allows you to automatically
log in to a virtual machine using the credentials you use to log in to the User Portal. Single
sign-on can be used on both Red Hat Enterprise Linux and Windows virtual machines.

IMPORTANT

If single sign-on to the User Portal is enabled, single sign-on to virtual


machines will not be possible. With single sign-on to the User Portal enabled,
the User Portal does not need to accept a password, thus the password cannot
be delegated to sign in to virtual machines.

4.1.1. Configuring Single Sign-On for Red Hat Enterprise Linux


Virtual Machines Using IPA (IdM)
To configure single sign-on for Red Hat Enterprise Linux virtual machines using GNOME and
KDE graphical desktop environments and IPA (IdM) servers, you must install the ovirt-guest-
agent package on the virtual machine and install the packages associated with your
window manager.

IMPORTANT

The following procedure assumes that you have a working IPA configuration
and that the IPA domain is already joined to the Manager. You must also
ensure that the clocks on the Manager, the virtual machine and the system on
which IPA (IdM) is hosted are synchronized using NTP.

Procedure 4.1. Configuring Single Sign-On for Red Hat Enterprise Linux Virtual
Machines

1. Log in to the Red Hat Enterprise Linux virtual machine.

2. Enable the required repository:

For Red Hat Enterprise Linux 6

# subscription-manager repos --enable=rhel-6-server-rhv-4-agent-


rpms

For Red Hat Enterprise Linux 7

# subscription-manager repos --enable=rhel-7-server-rh-common-


rpms

3. Download and install the guest agent packages:

# yum install ovirt-guest-agent-common

25
Virtual Machine Management Guide

4. Install the single sign-on packages:

# yum install ovirt-guest-agent-pam-module


# yum install ovirt-guest-agent-gdm-plugin

5. Install the IPA packages:

# yum install ipa-client

6. Run the following command and follow the prompts to configure ipa-client and join
the virtual machine to the domain:

# ipa-client-install --permit --mkhomedir

NOTE

In environments that use DNS obfuscation, this command should be:

# ipa-client-install --domain=FQDN --server==FQDN

7. For Red Hat Enterprise Linux 7.2 and later, run:

# authconfig --enablenis --update

NOTE

Red Hat Enterprise Linux 7.2 has a new version of the System Security
Services Daemon (SSSD) which introduces configuration that is
incompatible with the Red Hat Virtualization Manager guest agent
single sign-on implementation. The command will ensure that single
sign-on works.

8. Fetch the details of an IPA user:

# getent passwd IPA_user_name

This will return something like this:

some-ipa-user:*:936600010:936600001::/home/some-ipa-user:/bin/sh

You will need this information in the next step to create a home directory for some-
ipa-user.

9. Set up a home directory for the IPA user:

a. Create the new user's home directory:

# mkdir /home/some-ipa-user

b. Give the new user ownership of the new user's home directory:

26
CHAPTER 4. ADDITIONAL CONFIGURATION

# chown 935500010:936600001 /home/some-ipa-user

Log in to the User Portal using the user name and password of a user configured to use
single sign-on and connect to the console of the virtual machine. You will be logged in
automatically.

4.1.2. Configuring Single Sign-On for Red Hat Enterprise Linux


Virtual Machines Using Active Directory
To configure single sign-on for Red Hat Enterprise Linux virtual machines using GNOME and
KDE graphical desktop environments and Active Directory, you must install the ovirt-guest-
agent package on the virtual machine, install the packages associated with your window
manager and join the virtual machine to the domain.

IMPORTANT

The following procedure assumes that you have a working Active Directory
configuration and that the Active Directory domain is already joined to the
Manager. You must also ensure that the clocks on the Manager, the virtual
machine and the system on which Active Directory is hosted are synchronized
using NTP.

Procedure 4.2. Configuring Single Sign-On for Red Hat Enterprise Linux Virtual
Machines

1. Log in to the Red Hat Enterprise Linux virtual machine.

2. Enable the Red Hat Virtualization Agent repository:

For Red Hat Enterprise Linux 6

# subscription-manager repos --enable=rhel-6-server-rhv-4-agent-


rpms

For Red Hat Enterprise Linux 7

# subscription-manager repos --enable=rhel-7-server-rh-common-


rpms

3. Download and install the guest agent packages:

# yum install ovirt-guest-agent-common

4. Install the single sign-on packages:

# yum install ovirt-guest-agent-gdm-plugin

5. Install the Samba client packages:

# yum install samba-client samba-winbind samba-winbind-clients

27
Virtual Machine Management Guide

6. On the virtual machine, modify the /etc/samba/smb.conf file to contain the


following, replacing DOMAIN with the short domain name andREALM.LOCAL with the
Active Directory realm:

[global]
workgroup = DOMAIN
realm = REALM.LOCAL
log level = 2
syslog = 0
server string = Linux File Server
security = ads
log file = /var/log/samba/%m
max log size = 50
printcap name = cups
printing = cups
winbind enum users = Yes
winbind enum groups = Yes
winbind use default domain = true
winbind separator = +
idmap uid = 1000000-2000000
idmap gid = 1000000-2000000
template shell = /bin/bash

7. Join the virtual machine to the domain:

net ads join -U user_name

8. Start the winbind service and ensure it starts on boot:

For Red Hat Enterprise Linux 6

# service winbind start


# chkconfig winbind on

For Red Hat Enterprise Linux 7

# systemctl start winbind.service


# systemctl enable winbind.service

9. Verify that the system can communicate with Active Directory:

a. Verify that a trust relationship has been created:

# wbinfo -t

b. Verify that you can list users:

# wbinfo -u

c. Verify that you can list groups:

# wbinfo -g

28
CHAPTER 4. ADDITIONAL CONFIGURATION

10. Configure the NSS and PAM stack:

a. Open the Authentication Configuration window:

# authconfig-tui

b. Select the Use Winbind check box, select Next and press Enter.

c. Select the OK button and press Enter.

Log in to the User Portal using the user name and password of a user configured to use
single sign-on and connect to the console of the virtual machine. You will be logged in
automatically.

4.1.3. Configuring Single Sign-On for Windows Virtual Machines


To configure single sign-on for Windows virtual machines, the Windows guest agent must
be installed on the guest virtual machine. The RHEV Guest Tools ISO file provides this
agent. If the RHEV-toolsSetup.iso image is not available in your ISO domain, contact your
system administrator.

Procedure 4.3. Configuring Single Sign-On for Windows Virtual Machines

1. Select the Windows virtual machine. Ensure the machine is powered up.

2. Click Change CD.

3. Select RHEV-toolsSetup.iso from the list of images.

4. Click OK.

5. Click the Console icon and log in to the virtual machine.

6. On the virtual machine, locate the CD drive to access the contents of the guest
tools ISO file and launch RHEV-ToolsSetup.exe. After the tools have been installed,
you will be prompted to restart the machine to apply the changes.

Log in to the User Portal using the user name and password of a user configured to use
single sign-on and connect to the console of the virtual machine. You will be logged in
automatically.

4.1.4. Disabling Single Sign-on for Virtual Machines


The following procedure explains how to disable single sign-on for a virtual machine.

Procedure 4.4. Disabling Single Sign-On for Virtual Machines

1. Select a virtual machine and click Edit.

2. Click the Console tab.

3. Select the Disable Single Sign On check box.

4. Click OK.

29
Virtual Machine Management Guide

4.2. CONFIGURING USB DEVICES


A virtual machine connected with the SPICE protocol can be configured to connect directly
to USB devices.

The USB device will only be redirected if the virtual machine is active and in focus. USB
redirection can be manually enabled each time a device is plugged in or set to
automatically redirect to active virtual machines in the SPICE client menu.

IMPORTANT

Note the distinction between the client machine and guest machine. The client
is the hardware from which you access a guest. The guest is the virtual
desktop or virtual server which is accessed through the User Portal or
Administration Portal.

4.2.1. Using USB Devices on Virtual Machines


USB redirection Enabled mode allows KVM/SPICE USB redirection for Linux and Windows
virtual machines. Virtual (guest) machines require no guest-installed agents or drivers for
native USB. On Red Hat Enterprise Linux clients, all packages required for USB redirection
are provided by the virt-viewer package. On Windows clients, you must also install the
usbdk package. Enabled USB mode is supported on the following clients and guests:

Client

Red Hat Enterprise Linux 7.1 and later

Red Hat Enterprise Linux 6.0 and later

Windows 10

Windows 8

Windows 7

Windows 2008

Windows 2008 Server R2

Guest

Red Hat Enterprise Linux 7.1 and later

Red Hat Enterprise Linux 6.0 and later

Windows 7

Windows XP

Windows 2008

30
CHAPTER 4. ADDITIONAL CONFIGURATION

NOTE

If you have a 64-bit architecture PC, you must use the 64-bit version of Internet
Explorer to install the 64-bit version of the USB driver. The USB redirection will
not work if you install the 32-bit version on a 64-bit architecture. As long as
you initially install the correct USB type, you then can access USB redirection
from both 32 and 64-bit browsers.

4.2.2. Using USB Devices on a Windows Client


The usbdk driver must be installed on the Windows client for the USB device to be
redirected to the guest. Ensure the version of usbdk matches the architecture of the client
machine. For example, the 64-bit version of usbdk must be installed on 64-bit Windows
machines.

Procedure 4.5. Using USB Devices on a Windows Client

1. When the usbdk driver is installed, select a virtual machine that has been
configured to use the SPICE protocol.

2. Ensure USB support is set to Enabled:

1. Click Edit.

2. Click the Console tab.

3. Select Enabled from the USB Support drop-down list.

4. Click OK.

3. Click the Console Options button and select the Enable USB Auto-Share check
box.

4. Start the virtual machine and click the Console button to connect to that virtual
machine. When you plug your USB device into the client machine, it will
automatically be redirected to appear on your guest machine.

4.2.3. Using USB Devices on a Red Hat Enterprise Linux Client


The usbredir package enables USB redirection from Red Hat Enterprise Linux clients to
virtual machines. usbredir is a dependency of the virt-viewer package, and is automatically
installed together with that package.

Procedure 4.6. Using USB devices on a Red Hat Enterprise Linux client

1. Click the Virtual Machines tab and select a virtual machine that has been
configured to use the SPICE protocol.

2. Ensure USB support is set to Enabled:

1. Click Edit.

2. Click the Console tab.

3. Select Enabled from the USB Support drop-down list.

31
Virtual Machine Management Guide

4. Click OK.

3. Click the Console Options button and select the Enable USB Auto-Share check
box.

4. Start the virtual machine and click the Console button to connect to that virtual
machine. When you plug your USB device into the client machine, it will
automatically be redirected to appear on your guest machine.

4.3. CONFIGURING MULTIPLE MONITORS

4.3.1. Configuring Multiple Displays for Red Hat Enterprise Linux


Virtual Machines
A maximum of four displays can be configured for a single Red Hat Enterprise Linux virtual
machine when connecting to the virtual machine using the SPICE protocol.

1. Start a SPICE session with the virtual machine.

2. Open the View drop-down menu at the top of the SPICE client window.

3. Open the Display menu.

4. Click the name of a display to enable or disable that display.

NOTE

By default, Display 1 is the only display that is enabled on starting a


SPICE session with a virtual machine. If no other displays are enabled,
disabling this display will close the session.

4.3.2. Configuring Multiple Displays for Windows Virtual Machines


A maximum of four displays can be configured for a single Windows virtual machine when
connecting to the virtual machine using the SPICE protocol.

1. Click the Virtual Machines tab and select a virtual machine.

2. With the virtual machine in a powered-down state, click Edit.

3. Click the Console tab.

4. Select the number of displays from the Monitors drop-down list.

NOTE

This setting controls the maximum number of displays that can be


enabled for the virtual machine. While the virtual machine is running,
additional displays can be enabled up to this number.

5. Click Ok.

6. Start a SPICE session with the virtual machine.

32
CHAPTER 4. ADDITIONAL CONFIGURATION

7. Open the View drop-down menu at the top of the SPICE client window.

8. Open the Display menu.

9. Click the name of a display to enable or disable that display.

NOTE

By default, Display 1 is the only display that is enabled on starting a


SPICE session with a virtual machine. If no other displays are enabled,
disabling this display will close the session.

4.4. CONFIGURING CONSOLE OPTIONS

4.4.1. Console Options


Connection protocols are the underlying technology used to provide graphical consoles for
virtual machines and allow users to work with virtual machines in a similar way as they
would with physical machines. Red Hat Virtualization currently supports the following
connection protocols:

SPICE
Simple Protocol for Independent Computing Environments (SPICE) is the recommended
connection protocol for both Linux virtual machines and Windows virtual machines. To open
a console to a virtual machine using SPICE, use Remote Viewer.

VNC
Virtual Network Computing (VNC) can be used to open consoles to both Linux virtual
machines and Windows virtual machines. To open a console to a virtual machine using VNC,
use Remote Viewer or a VNC client.

RDP
Remote Desktop Protocol (RDP) can only be used to open consoles to Windows virtual
machines, and is only available when you access a virtual machines from a Windows
machine on which Remote Desktop has been installed. Before you can connect to a
Windows virtual machine using RDP, you must set up remote sharing on the virtual machine
and configure the firewall to allow remote desktop connections.

NOTE

SPICE is not currently supported on virtual machines running Windows 8. If a


Windows 8 virtual machine is configured to use the SPICE protocol, it will
detect the absence of the required SPICE drivers and automatically fall back to
using RDP.

4.4.1.1. Accessing Console Options

You can configure several options for opening graphical consoles for virtual machines, such
as the method of invocation and whether to enable or disable USB redirection.

Procedure 4.7. Accessing Console Options

33
Virtual Machine Management Guide

1. Select a running virtual machine.

2. Open the Console Options window.

In the Administration Portal, right-click the virtual machine and click Console
Options.

In the User Portal, click the Edit Console Options button.

Figure 4.1. The User Portal Edit Console Options Button

NOTE

Further options specific to each of the connection protocols, such as the


keyboard layout when using the VNC connection protocol, can be configured in
the Console tab of the Edit Virtual Machine window.

4.4.1.2. SPICE Console Options

When the SPICE connection protocol is selected, the following options are available in the
Console Options window.

34
CHAPTER 4. ADDITIONAL CONFIGURATION

Figure 4.2. The Console Options window

Console Invocation

Auto: The Manager automatically selects the method for invoking the console.

Native client: When you connect to the console of the virtual machine, a file
download dialog provides you with a file that opens a console to the virtual machine
via Remote Viewer.

SPICE HTML5 browser client (Tech preview): When you connect to the console
of the virtual machine, a browser tab is opened that acts as the console.

SPICE Options

Map control-alt-del shortcut to ctrl+alt+end: Select this check box to map


the Ctrl+Alt+Del key combination to Ctrl+Alt+End inside the virtual machine.

Enable USB Auto-Share: Select this check box to automatically redirect USB
devices to the virtual machine. If this option is not selected, USB devices will
connect to the client machine instead of the guest virtual machine. To use the USB
device on the guest machine, manually enable it in the SPICE client menu.

35
Virtual Machine Management Guide

Open in Full Screen: Select this check box for the virtual machine console to
automatically open in full screen when you connect to the virtual machine. Press
SHIFT+F11 to toggle full screen mode on or off.

Enable SPICE Proxy: Select this check box to enable the SPICE proxy.

Enable WAN options: Select this check box to set the parameters
WANDisableEffects and WANColorDepth to animation and 16 bits respectively on
Windows virtual machines. Bandwidth in WAN environments is limited and this
option prevents certain Windows settings from consuming too much bandwidth.

4.4.1.3. VNC Console Options

When the VNC connection protocol is selected, the following options are available in the
Console Options window.

Figure 4.3. The Console Options window

Console Invocation

Native Client: When you connect to the console of the virtual machine, a file
download dialog provides you with a file that opens a console to the virtual machine
via Remote Viewer.

36
CHAPTER 4. ADDITIONAL CONFIGURATION

noVNC: When you connect to the console of the virtual machine, a browser tab is
opened that acts as the console.

VNC Options

Map control-alt-delete shortcut to ctrl+alt+end: Select this check box to


map the Ctrl+Alt+Del key combination to Ctrl+Alt+End inside the virtual
machine.

4.4.1.4. RDP Console Options

When the RDP connection protocol is selected, the following options are available in the
Console Options window.

Figure 4.4. The Console Options window

Console Invocation

Auto: The Manager automatically selects the method for invoking the console.

Native client: When you connect to the console of the virtual machine, a file
download dialog provides you with a file that opens a console to the virtual machine
via Remote Desktop.

37
Virtual Machine Management Guide

RDP Options

Use Local Drives: Select this check box to make the drives on the client machine
accessible on the guest virtual machine.

4.4.2. Remote Viewer Options

4.4.2.1. Remote Viewer Options

When you specify the Native client console invocation option, you will connect to virtual
machines using Remote Viewer. The Remote Viewer window provides a number of options
for interacting with the virtual machine to which it is connected.

Figure 4.5. The Remote Viewer connection menu

Table 4.1. Remote Viewer Options

Option Hotkey

38
CHAPTER 4. ADDITIONAL CONFIGURATION

Option Hotkey

File
Screenshot: Takes a screen capture
of the active window and saves it in a
location of your specification.

USB device selection: If USB


redirection has been enabled on your
virtual machine, the USB device
plugged into your client machine can
be accessed from this menu.

Quit: Closes the console. The hot key


for this option is Shift+Ctrl+Q .

View
Full screen : Toggles full screen
mode on or off. When enabled, full
screen mode expands the virtual
machine to fill the entire screen. When
disabled, the virtual machine is
displayed as a window. The hot key for
enabling or disabling full screen is
SHIFT+F11.

Zoom: Zooms in and out of the console


window. Ctrl++ zooms in, Ctrl+-
zooms out, and Ctrl+0 returns the
screen to its original size.

Automatically resize: Tick to


enable the guest resolution to
automatically scale according to the
size of the console window.

Displays: Allows users to enable and


disable displays for the guest virtual
machine.

39
Virtual Machine Management Guide

Option Hotkey

Send key
Ctrl+Alt+Del: On a Red Hat
Enterprise Linux virtual machine, it
displays a dialog with options to
suspend, shut down or restart the
virtual machine. On a Windows virtual
machine, it displays the task manager
or Windows Security dialog.

Ctrl+Alt+Backspace: On a Red Hat


Enterprise Linux virtual machine, it
restarts the X sever. On a Windows
virtual machine, it does nothing.

Ctrl+Alt+F1

Ctrl+Alt+F2

Ctrl+Alt+F3

Ctrl+Alt+F4

Ctrl+Alt+F5

Ctrl+Alt+F6

Ctrl+Alt+F7

Ctrl+Alt+F8

Ctrl+Alt+F9

Ctrl+Alt+F10

Ctrl+Alt+F11

Ctrl+Alt+F12

Printscreen : Passes the


Printscreen keyboard option to the
virtual machine.

Help The About entry displays the version details


of Virtual Machine Viewer that you are using.

Release Cursor from Virtual Machine SHIFT+F12

4.4.2.2. Remote Viewer Hotkeys

You can access the hotkeys for a virtual machine in both full screen mode and windowed
mode. If you are using full screen mode, you can display the menu containing the button
for hotkeys by moving the mouse pointer to the middle of the top of the screen. If you are
using windowed mode, you can access the hotkeys via the Send key menu on the virtual
machine window title bar.

40
CHAPTER 4. ADDITIONAL CONFIGURATION

NOTE

If vdagent is not running on the client machine, the mouse can become
captured in a virtual machine window if it is used inside a virtual machine and
the virtual machine is not in full screen. To unlock the mouse, press
Shift+F12.

4.4.2.3. Manually Associating console.vv Files with Remote Viewer

If you are prompted to download a console.vv file when attempting to open a console to a
virtual machine using the native client console option, and Remote Viewer is already
installed, then you can manually associate console.vv files with Remote Viewer so that
Remote Viewer can automatically use those files to open consoles.

Procedure 4.8. Manually Associating console.vv Files with Remote Viewer

1. Start the virtual machine.

2. Open the Console Options window.

In the Administration Portal, right-click the virtual machine and click Console
Options.

In the User Portal, click the Edit Console Options button.

Figure 4.6. The User Portal Edit Console Options Button

3. Change the console invocation method to Native client and click OK.

4. Attempt to open a console to the virtual machine, then click Save when prompted to
open or save the console.vv file.

5. Navigate to the location on your local machine where you saved the file.

6. Double-click the console.vv file and select Select a program from a list of
installed programs when prompted.

7. In the Open with window, select Always use the selected program to open
this kind of file and click the Browse button.

8. Navigate to the C:\Users\[user name]\AppData\Local\virt-viewer\bin


directory and select remote-viewer.exe.

9. Click Open and then click OK.

When you use the native client console invocation option to open a console to a virtual
machine, Remote Viewer will automatically use the console.vv file that the Red Hat
Virtualization Manager provides to open a console to that virtual machine without
prompting you to select the application to use.

41
Virtual Machine Management Guide

4.5. CONFIGURING A WATCHDOG

4.5.1. Adding a Watchdog Card to a Virtual Machine


You can add a watchdog card to a virtual machine to monitor the operating system's
responsiveness.

Procedure 4.9. Adding Watchdog Cards to Virtual Machines

1. Click the Virtual Machines tab and select a virtual machine.

2. Click Edit.

3. Click the High Availability tab.

4. Select the watchdog model to use from the Watchdog Model drop-down list.

5. Select an action from the Watchdog Action drop-down list. This is the action that
the virtual machine takes when the watchdog is triggered.

6. Click OK.

4.5.2. Installing a Watchdog


To activate a watchdog card attached to a virtual machine, you must install the watchdog
package on that virtual machine and start the watchdog service.

Procedure 4.10. Installing Watchdogs

1. Log in to the virtual machine on which the watchdog card is attached.

2. Install the watchdog package and dependencies:

# yum install watchdog

3. Edit the /etc/watchdog.conf file and uncomment the following line:

watchdog-device = /dev/watchdog

4. Save the changes.

5. Start the watchdog service and ensure this service starts on boot:

Red Hat Enterprise Linux 6:

# service watchdog start


# chkconfig watchdog on

Red Hat Enterprise Linux 7:

# systemctl start watchdog.service


# systemctl enable watchdog.service

42
CHAPTER 4. ADDITIONAL CONFIGURATION

4.5.3. Confirming Watchdog Functionality


Confirm that a watchdog card has been attached to a virtual machine and that the
watchdog service is active.


WARNING

This procedure is provided for testing the functionality of watchdogs only


and must not be run on production machines.

Procedure 4.11. Confirming Watchdog Functionality

1. Log in to the virtual machine on which the watchdog card is attached.

2. Confirm that the watchdog card has been identified by the virtual machine:

# lspci | grep watchdog -i

3. Run one of the following commands to confirm that the watchdog is active:

Trigger a kernel panic:

# echo c > /proc/sysrq-trigger

Terminate the watchdog service:

# kill -9 `pgrep watchdog`

The watchdog timer can no longer be reset, so the watchdog counter reaches zero after a
short period of time. When the watchdog counter reaches zero, the action specified in the
Watchdog Action drop-down menu for that virtual machine is performed.

4.5.4. Parameters for Watchdogs in watchdog.conf


The following is a list of options for configuring the watchdog service available in the
/etc/watchdog.conf file. To configure an option, you must uncomment that option and
restart the watchdog service after saving the changes.

NOTE

For a more detailed explanation of options for configuring the watchdog


service and using the watchdog command, see the watchdog man page.

Table 4.2. watchdog.conf variables

43
Virtual Machine Management Guide

Variable name Default Value Remarks

ping N/A An IP address that the watchdog


attempts to ping to verify whether
that address is reachable. You can
specify multiple IP addresses by
adding additional ping lines.

interface N/A A network interface that the


watchdog will monitor to verify the
presence of network traffic. You can
specify multiple network interfaces
by adding additional interface
lines.

file /var/log/mes A file on the local system that the


sages watchdog will monitor for changes.
You can specify multiple files by
adding additional file lines.

change 1407 The number of watchdog intervals


after which the watchdog checks for
changes to files. A change line must
be specified on the line directly after
each file line, and applies to the
file line directly above that
change line.

max-load-1 24 The maximum average load that the


virtual machine can sustain over a
one-minute period. If this average is
exceeded, then the watchdog is
triggered. A value of 0 disables this
feature.

max-load-5 18 The maximum average load that the


virtual machine can sustain over a
five-minute period. If this average is
exceeded, then the watchdog is
triggered. A value of 0 disables this
feature. By default, the value of this
variable is set to a value
approximately three quarters that of
max-load-1.

44
CHAPTER 4. ADDITIONAL CONFIGURATION

Variable name Default Value Remarks

max-load-15 12 The maximum average load that the


virtual machine can sustain over a
fifteen-minute period. If this average
is exceeded, then the watchdog is
triggered. A value of 0 disables this
feature. By default, the value of this
variable is set to a value
approximately one half that of max-
load-1 .

min-memory 1 The minimum amount of virtual


memory that must remain free on
the virtual machine. This value is
measured in pages. A value of 0
disables this feature.

repair-binary /usr/sbin/re The path and file name of a binary


pair file on the local system that will be
run when the watchdog is triggered.
If the specified file resolves the
issues preventing the watchdog
from resetting the watchdog
counter, then the watchdog action is
not triggered.

test-binary N/A The path and file name of a binary


file on the local system that the
watchdog will attempt to run during
each interval. A test binary allows
you to specify a file for running user-
defined tests.

test-timeout N/A The time limit, in seconds, for which


user-defined tests can run. A value
of 0 allows user-defined tests to
continue for an unlimited duration.

temperature-device N/A The path to and name of a device


for checking the temperature of the
machine on which the watchdog
service is running.

45
Virtual Machine Management Guide

Variable name Default Value Remarks

max-temperature 120 The maximum allowed temperature


for the machine on which the
watchdog service is running. The
machine will be halted if this
temperature is reached. Unit
conversion is not taken into account,
so you must specify a value that
matches the watchdog card being
used.

admin root The email address to which email


notifications are sent.

interval 10 The interval, in seconds, between


updates to the watchdog device. The
watchdog device expects an update
at least once every minute, and if
there are no updates over a one-
minute period, then the watchdog is
triggered. This one-minute period is
hard-coded into the drivers for the
watchdog device, and cannot be
configured.

logtick 1 When verbose logging is enabled for


the watchdog service, the
watchdog service periodically writes
log messages to the local system.
The logtick value represents the
number of watchdog intervals after
which a message is written.

realtime yes Specifies whether the watchdog is


locked in memory. A value of yes
locks the watchdog in memory so
that it is not swapped out of
memory, while a value of no allows
the watchdog to be swapped out of
memory. If the watchdog is swapped
out of memory and is not swapped
back in before the watchdog counter
reaches zero, then the watchdog is
triggered.

priority 1 The schedule priority when the value


of realtime is set to yes.

46
CHAPTER 4. ADDITIONAL CONFIGURATION

Variable name Default Value Remarks

pidfile /var/run/sys The path and file name of a PID file


logd.pid that the watchdog monitors to see if
the corresponding process is still
active. If the corresponding process
is not active, then the watchdog is
triggered.

4.6. CONFIGURING VIRTUAL NUMA


In the Administration Portal, you can configure virtual NUMA nodes on a virtual machine
and pin them to physical NUMA nodes on a host. The host’s default policy is to schedule
and run virtual machines on any available resources on the host. As a result, the resources
backing a large virtual machine that cannot fit within a single host socket could be spread
out across multiple NUMA nodes, and over time may be moved around, leading to poor and
unpredictable performance. Configure and pin virtual NUMA nodes to avoid this outcome
and improve performance.

Configuring virtual NUMA requires a NUMA-enabled host. To confirm whether NUMA is


enabled on a host, log in to the host and run numactl --hardware. The output of this
command should show at least two NUMA nodes. You can also view the host's NUMA
topology in the Administration Portal by selecting the host from the Hosts tab and clicking
NUMA Support. This button is only available when the selected host has at least two NUMA
nodes.

Procedure 4.12. Configuring Virtual NUMA

1. Click the Virtual Machines tab and select a virtual machine.

2. Click Edit.

3. Click the Host tab.

4. Select the Specific Host(s) radio button and select a host from the list. The
selected host must have at least two NUMA nodes.

5. Select Do not allow migration from the Migration Options drop-down list.

6. Enter a number into the NUMA Node Count field to assign virtual NUMA nodes to the
virtual machine.

7. Select Strict, Preferred, or Interleave from the Tune Mode drop-down list. If the
selected mode is Preferred, the NUMA Node Count must be set to 1.

8. Click NUMA Pinning.

47
Virtual Machine Management Guide

Figure 4.7. The NUMA Topology Window

9. In the NUMA Topology window, click and drag virtual NUMA nodes from the box on
the right to host NUMA nodes on the left as required, and click OK.

10. Click OK.

NOTE

If you do not pin the virtual NUMA node to a host NUMA node, the system
defaults to the NUMA node that contains the host device's memory-mapped
I/O (MMIO), provided that there are one or more host devices and all of those
devices are from a single NUMA node.

4.7. CONFIGURING RED HAT SATELLITE ERRATA


MANAGEMENT FOR A VIRTUAL MACHINE
In the Administration Portal, you can configure a virtual machine to display the available
errata. The virtual machine needs to be associated with a Red Hat Satellite server to show
available errata.

Red Hat Virtualization 4.1 supports errata management with Red Hat Satellite 6.1.

The following prerequisites apply:

The host that the virtual machine runs on also needs to be configured to receive
errata information from Satellite. See Configuring Satellite Errata Management for a
Host in the Administration Guide for more information.

The virtual machine must have the ovirt-guest-agent package installed. This
package allows the virtual machine to report its host name to the Red Hat
Virtualization Manager. This allows the Red Hat Satellite server to identify the virtual
machine as a content host and report the applicable errata. For more information on
installing the ovirt-guest-agent package see Section 2.4.2, “Installing the Guest
Agents and Drivers on Red Hat Enterprise Linux” for Red Hat Enterprise Linux virtual

48
CHAPTER 4. ADDITIONAL CONFIGURATION

machines and Section 3.3.2, “Installing the Guest Agents and Drivers on Windows”
for Windows virtual machines.

IMPORTANT

Virtual machines are identified in the Satellite server by their FQDN. This
ensures that an external content host ID does not need to be maintained in
Red Hat Virtualization.

Procedure 4.13. Configuring Red Hat Satellite Errata Management

NOTE

The virtual machine must be registered to the Satellite server as a content


host and have the katello-agent package installed.

For more information on how to configure a host registration see Configuring a


Host for Registration in the Red Hat Satellite User Guide and for more
information on how to register a host and install the katello-agent package see
Registration in the Red Hat Satellite User Guide

1. Click the Virtual Machines tab and select a virtual machine.

2. Click Edit.

3. Click the Foreman/Satellite tab.

4. Select the required Satellite server from the Provider drop-down list.

5. Click OK.

4.8. CONFIGURING HEADLESS VIRTUAL MACHINES


You can configure a headless virtual machine when it is not necessary to access the
machine via a graphical console. This headless machine will run without graphical and
video devices. This can be useful in situations where the host has limited resources, or to
comply with virtual machine usage requirements such as real-time virtual machines.

Headless virtual machines can be administered via a Serial Console, SSH, or any other
service for command line access. Headless mode is applied via the Console tab, which is
available from the cluster level when creating or editing virtual machines and machine
pools, and when editing templates. It is also available when creating or editing instance
types.

If you are creating a new headless virtual machine, you can use the Run Once window to
access the virtual machine via a graphical console for the first run only. See Section A.5,
“Explanation of Settings in the Run Once Window” for more details.

Prerequisites

If you are editing an existing virtual machine, and the Red Hat Virtualization guest
agent has not been installed, note the machine's IP prior to selecting Headless
Mode.

49
Virtual Machine Management Guide

Before running a virtual machine in headless mode, the GRUB configuration for this
machine must be set to console mode otherwise the guest operating system's boot
process will hang. To set console mode, comment out the spashimage flag in the
GRUB menu configuration file:

#splashimage=(hd0,0)/grub/splash.xpm.gz serial --unit=0 --


speed=9600 --parity=no --stop=1 terminal --timeout=2 serial

NOTE

Restart the virtual machine if it is running when selecting the Headless Mode
option.

Procedure 4.14. Configuring a Headless Virtual Machine

1. Click the Virtual Machines tab and select a virtual machine.

2. Click Edit.

3. Click the Console tab.

4. Select Headless Mode. All other fields in theGraphical Console section are
disabled.

5. Optionally, select Enable VirtIO serial console to enable comunicating with the
virtual machine via serial console. This is higly recommended.

6. Reboot the virtual machine if it is running. See Section 6.3, “Rebooting a Virtual
Machine”.

50
CHAPTER 5. EDITING VIRTUAL MACHINES

CHAPTER 5. EDITING VIRTUAL MACHINES

5.1. EDITING VIRTUAL MACHINE PROPERTIES


Changes to storage, operating system, or networking parameters can adversely affect the
virtual machine. Ensure that you have the correct details before attempting to make any
changes. Virtual machines can be edited while running, and some changes (listed in the
procedure below) will be applied immediately. To apply all other changes, the virtual
machine must be shut down and restarted.

Procedure 5.1. Editing Virtual Machines

1. Select the virtual machine to be edited.

2. Click Edit.

3. Change settings as required.

Changes to the following settings are applied immediately:

Name

Description

Comment

Optimized for (Desktop/Server)

Delete Protection

Network Interfaces

Memory Size (Edit this field to hot plug virtual memory. SeeSection 5.5, “Hot
Plugging Virtual Memory”.)

Virtual Sockets (Edit this field to hot plug CPUs. See Section 5.6, “Hot Plugging
vCPUs”.)

Use custom migration downtime

Highly Available

Priority for Run/Migration queue

Disable strict user checking

Icon

4. Click OK.

5. If the Next Start Configuration pop-up window appears, click OK.

Changes from the list in step 3 are applied immediately. All other changes are applied
when you shut down and restart your virtual machine. Until then, an orange icon ( )
appears as a reminder of the pending changes.

51
Virtual Machine Management Guide

5.2. EDITING IO THREADS


If a virtual machine has more than one disk, you can enable or change the number of IO
threads to improve performance.

Procedure 5.2. Editing IO Threads

1. Select the virtual machine to be edited.

2. Click Edit.

3. Click the Resource Allocation tab.

4. Select the IO Threads Enabled check box. Red Hat recommends using the default
number of IO threads, which is 1.

5. Click OK.

6. Click the Reboot icon to restart the virtual machine.

If you increased the number of IO threads, you must reactivate the disks so that the
disks will be remapped according to the correct number of controllers:

a. Click the Shutdown icon to stop the virtual machine.

b. Click the Disks tab in the details pane.

c. Select each disk and click Deactivate.

d. Select each disk and click Activate.

e. Click the Run icon to start the virtual machine.

You can view the IO threads by clicking Vm Devices in the details pane.

The assignment of disks to controllers displays only in the XML, not in the Administration
Portal.

Procedure 5.3. Viewing Disk Controller Assignment

1. Log in to the host machine.

2. Use the dumpxml command to view the mapping of disks to controllers:

# virsh -r dumpxml virtual_machine_name

5.3. NETWORK INTERFACES

5.3.1. Adding a New Network Interface


You can add multiple network interfaces to virtual machines. Doing so allows you to put
your virtual machine on multiple logical networks.

Procedure 5.4. Adding Network Interfaces to Virtual Machines

52
CHAPTER 5. EDITING VIRTUAL MACHINES

1. Click the Virtual Machines tab and select a virtual machine.

2. Click the Network Interfaces tab in the details pane.

3. Click New.

Figure 5.1. New Network Interface window

4. Enter the Name of the network interface.

5. Use the drop-down lists to select the Profile and the Type of the network interface.
The Profile and Type drop-down lists are populated in accordance with the profiles
and network types available to the cluster and the network interface cards available
to the virtual machine.

6. Select the Custom MAC address check box and enter a MAC address for the network
interface card as required.

7. Click OK.

The new network interface is listed in the Network Interfaces tab in the details pane of
the virtual machine. The Link State is set to Up by default when the network interface
card is defined on the virtual machine and connected to the network.

For more details on the fields in the New Network Interface window, see Section A.2,
“Explanation of Settings in the New Network Interface and Edit Network Interface
Windows”.

5.3.2. Editing a Network Interface


In order to change any network settings, you must edit the network interface. This
procedure can be performed on virtual machines that are running, but some actions can be
performed only on virtual machines that are not running.

Procedure 5.5. Editing Network Interfaces

53
Virtual Machine Management Guide

Procedure 5.5. Editing Network Interfaces

1. Click the Virtual Machines tab and select a virtual machine.

2. Click the Network Interfaces tab in the details pane and select the network
interface to edit.

3. Click Edit.

4. Change settings as required. You can specify the Name, Profile, Type, and Custom
MAC address. See Section 5.3.1, “Adding a New Network Interface”.

5. Click OK.

5.3.3. Hot Plugging a Network Interface


You can hot plug network interfaces. Hot plugging means enabling and disabling devices
while a virtual machine is running.

NOTE

The guest operating system must support hot plugging network interfaces.

Procedure 5.6. Hot Plugging Network Interfaces

1. Click the Virtual Machines tab and select a virtual machine.

2. Click the Network Interfaces tab in the details pane and select the network
interface to hot plug.

3. Click Edit.

4. Set the Card Status to Plugged to enable the network interface, or set it to
Unplugged to disable the network interface.

5. Click OK.

5.3.4. Removing a Network Interface

Procedure 5.7. Removing Network Interfaces

1. Click the Virtual Machines tab and select a virtual machine.

2. Click the Network Interfaces tab in the details pane and select the network
interface to remove.

3. Click Remove.

4. Click OK.

5.4. VIRTUAL DISKS

5.4.1. Adding a New Virtual Disk


You can add multiple virtual disks to a virtual machine.

54
CHAPTER 5. EDITING VIRTUAL MACHINES

Image is the default type of disk. You can also add aDirect LUN disk or a Cinder
(OpenStack Volume) disk. Image disk creation is managed entirely by the Manager.Direct
LUN disks require externally prepared targets that already exist.Cinder disks require
access to an instance of OpenStack Volume that has been added to the Red Hat
Virtualization environment using the External Providers window; see Adding an
OpenStack Volume (Cinder) Instance for Storage Management for more information.
Existing disks are either floating disks or shareable disks attached to virtual machines.

Procedure 5.8. Adding Disks to Virtual Machines

1. Click the Virtual Machines tab and select a virtual machine.

2. Click the Disks tab in the details pane.

3. Click New.

Figure 5.2. The New Virtual Disk Window

4. Use the appropriate radio buttons to switch between Image, Direct LUN, or Cinder.
Virtual disks added in the User Portal can only be Image disks. Direct LUN and
Cinder disks can be added in the Administration Portal.

5. Enter a Size(GB), Alias, and Description for the new disk.

6. Use the drop-down lists and check boxes to configure the disk. See Section A.3,
“Explanation of Settings in the New Virtual Disk and Edit Virtual Disk Windows” for
more details on the fields for all disk types.

7. Click OK.

55
Virtual Machine Management Guide

The new disk appears in the details pane after a short time.

5.4.2. Attaching an Existing Disk to a Virtual Machine


Floating disks are disks that are not associated with any virtual machine.

Floating disks can minimize the amount of time required to set up virtual machines.
Designating a floating disk as storage for a virtual machine makes it unnecessary to wait
for disk preallocation at the time of a virtual machine's creation.

Floating disks can be attached to a single virtual machine, or to multiple virtual machines if
the disk is shareable. Each virtual machine that uses the shared disk can use a different
disk interface type.

Once a floating disk is attached to a virtual machine, the virtual machine can access it.

Procedure 5.9. Attaching Virtual Disks to Virtual Machines

1. Click the Virtual Machines tab and select a virtual machine.

2. Click the Disks tab in the details pane.

3. Click Attach.

Figure 5.3. The Attach Virtual Disks Window

4. Select one or more virtual disks from the list of available disks and select the
required interface from the Interface drop-down.

56
CHAPTER 5. EDITING VIRTUAL MACHINES

5. Click OK.

NOTE

No Quota resources are consumed by attaching virtual disks to, or detaching


virtual disks from, virtual machines.

5.4.3. Extending the Available Size of a Virtual Disk


You can extend the available size of a virtual disk while the virtual disk is attached to a
virtual machine. Resizing a virtual disk does not resize the underlying partitions or file
systems on that virtual disk. Use the fdisk utility to resize the partitions and file systems
as required. See How to Resize a Partition using fdisk for more information.

Procedure 5.10. Extending the Available Size of Virtual Disks

1. Click the Virtual Machines tab and select a virtual machine.

2. Click the Disks tab in the details pane and select the disk to edit.

3. Click Edit.

4. Enter a value in the Extend size by(GB) field.

5. Click OK.

The target disk's status becomes locked for a short time, during which the drive is resized.
When the resizing of the drive is complete, the status of the drive becomes OK.

5.4.4. Hot Plugging a Virtual Disk


You can hot plug virtual disks. Hot plugging means enabling or disabling devices while a
virtual machine is running.

NOTE

The guest operating system must support hot plugging virtual disks.

Procedure 5.11. Hot Plugging Virtual Disks

1. Click the Virtual Machines tab and select a virtual machine.

2. Click the Disks tab in the details pane and select the virtual disk to hot plug.

3. Click Activate to enable the disk, or click Deactivate to disable the disk.

4. Click OK.

5.4.5. Removing a Virtual Disk from a Virtual Machine

Procedure 5.12. Removing Virtual Disks From Virtual Machines

1. Click the Virtual Machines tab and select a virtual machine.

57
Virtual Machine Management Guide

2. Click the Disks tab in the details pane and select the virtual disk to remove.

3. Click Deactivate.

4. Click OK.

5. Click Remove.

6. Optionally, select the Remove Permanently check box to completely remove the
virtual disk from the environment. If you do not select this option - for example,
because the disk is a shared disk - the virtual disk will remain in the Disks resource
tab.

7. Click OK.

If the disk was created as block storage, for example iSCSI, and the Wipe After Delete
check box was selected when creating the disk, you can view the log file on the host to
confirm that the data has been wiped after permanently removing the disk. See Settings to
Wipe Virtual Disks After Deletion in the Administration Guide.

If the disk was created as block storage, for example iSCSI, and the Discard After
Delete check box was selected on the storage domain before the disk was removed, a
blkdiscard command is called on the logical volume when it is removed and the
underlying storage is notified that the blocks are free. See Setting Discard After Delete for a
Storage Domain in the Administration Guide. A blkdiscard is also called on the logical
volume when a virtual disk is removed if the virtual disk is attached to at least one virtual
machine with the Enable Discard check box selected.

5.4.6. Importing a Disk Image from an Imported Storage Domain


Import floating virtual disks from an imported storage domain using the Disk Import tab of
the details pane.

This procedure requires access to the Administration Portal

NOTE

Only QEMU-compatible disks can be imported into the Manager.

Procedure 5.13. Importing a Disk Image

1. Select a storage domain that has been imported into the data center.

2. In the details pane, click Disk Import.

3. Select one or more disk images and click Import to open the Import Disk(s)
window.

4. Select the appropriate Disk Profile for each disk.

5. Click OK to import the selected disks.

5.4.7. Importing an Unregistered Disk Image from an Imported


Storage Domain
Import floating virtual disks from a storage domain using the Disk Import tab of the details

58
CHAPTER 5. EDITING VIRTUAL MACHINES

pane. Floating disks created outside of a Red Hat Virtualization environment are not
registered with the Manager. Scan the storage domain to identify unregistered floating
disks to be imported.

This procedure requires access to the Administration Portal

NOTE

Only QEMU-compatible disks can be imported into the Manager.

Procedure 5.14. Importing a Disk Image

1. Select a storage domain that has been imported into the data center.

2. Right-click the storage domain and select Scan Disks so that the Manager can
identify unregistered disks.

3. In the details pane, click Disk Import.

4. Select one or more disk images and click Import to open the Import Disk(s)
window.

5. Select the appropriate Disk Profile for each disk.

6. Click OK to import the selected disks.

5.5. HOT PLUGGING VIRTUAL MEMORY


You can hot plug virtual memory. Hot plugging means enabling or disabling devices while a
virtual machine is running. Each time memory is hot plugged, it appears as a new memory
device in the Vm Devices tab in the details pane, up to a maximum of 16 available slots.
When the virtual machine is restarted, these devices are cleared from the Vm Devices tab
without reducing the virtual machine's memory, allowing you to hot plug more memory
devices. If the hot plug fails (for example, if there are no more available slots), the memory
increase will be applied when the virtual machine is restarted.

IMPORTANT

This feature is currently not supported for the self-hosted engine Manager
virtual machine.

IMPORTANT

Hot unplugging virtual memory is not currently supported in Red Hat


Virtualization.

Procedure 5.15. Hot Plugging Virtual Memory

1. Click the Virtual Machines tab and select a running virtual machine.

2. Click Edit.

3. Click the System tab.

59
Virtual Machine Management Guide

4. Increase the Memory Size by entering the total amount required. Memory can be
added in multiples of 256 MB. By default, the maximum memory allowed for the
virtual machine is set to 4x the memory size specified. Though the value is changed
in the user interface, the maximum value is not hot plugged, and you will see the
pending changes icon. To avoid that, you can change the maximum memory back
to the original value.

5. Click OK.

This action opens the Pending Virtual Machine changes window, as some values
such as maxMemorySizeMb and minAllocatedMem will not change until the virtual
machine is restarted. However, the hot plug action is triggered by the change to the
Memory Size value, which can be applied immediately.

Figure 5.4. Hot Plug Virtual Memory

6. Click OK.

The virtual machine's Defined Memory is updated in the General tab in the details pane.
You can see the newly added memory device in the Vm Devices tab in the details pane.

60
CHAPTER 5. EDITING VIRTUAL MACHINES

5.6. HOT PLUGGING VCPUS


You can hot plug vCPUs. Hot plugging means enabling or disabling devices while a virtual
machine is running.

IMPORTANT

Hot unplugging a vCPU is only supported if the vCPU was previously hot
plugged. A virtual machine's vCPUs cannot be hot unplugged to less vCPUs
than it was originally created with.

The following prerequisites apply:

The virtual machine's Operating System must be explicitly set in the New Virtual
Machine or Edit Virtual Machine window.

The virtual machine's operating system must support CPU hot plug. See the table
below for support details.

Windows virtual machines must have the guest agents installed. See Section 3.3.2,
“Installing the Guest Agents and Drivers on Windows”.

Procedure 5.16. Hot Plugging vCPUs

1. Click the Virtual Machines tab and select a running virtual machine.

2. Click Edit.

3. Click the System tab.

4. Change the value of Virtual Sockets as required.

5. Click OK.

Table 5.1. Operating System Support Matrix for vCPU Hot Plug

Operating System Version Architecture Hot Plug Hot Unplug


Supported Supported

Red Hat Enterprise x86 Yes Yes


Linux Atomic Host 7

Red Hat Enterprise x86 Yes Yes


Linux 6.3+

Red Hat Enterprise x86 Yes Yes


Linux 7.0+

Red Hat Enterprise PPC64 Yes Yes


Linux 7.3+

Microsoft Windows All x86 No No


Server 2008

61
Virtual Machine Management Guide

Operating System Version Architecture Hot Plug Hot Unplug


Supported Supported

Microsoft Windows Standard, Enterprise x64 No No


Server 2008

Microsoft Windows Datacenter x64 Yes No


Server 2008

Microsoft Windows All x86 No No


Server 2008 R2

Microsoft Windows Standard, Enterprise x64 No No


Server 2008 R2

Microsoft Windows Datacenter x64 Yes No


Server 2008 R2

Microsoft Windows All x64 Yes No


Server 2012

Microsoft Windows All x64 Yes No


Server 2012 R2

Microsoft Windows Standard, Datacenter x64 Yes No


Server 2016

Microsoft Windows 7 All x86 No No

Microsoft Windows 7 Starter, Home, Home x64 No No


Premium,
Professional

Microsoft Windows 7 Enterprise, Ultimate x64 Yes No

Microsoft Windows All x86 Yes No


8.x

Microsoft Windows All x64 Yes No


8.x

Microsoft Windows All x86 Yes No


10

Microsoft Windows All x64 Yes No


10

5.7. PINNING A VIRTUAL MACHINE TO MULTIPLE HOSTS


Virtual machines can be pinned to multiple hosts. Multi-host pinning allows a virtual
machine to run on a specific subset of hosts within a cluster, instead of one specific host or
all hosts in the cluster. The virtual machine cannot run on any other hosts in the cluster

62
CHAPTER 5. EDITING VIRTUAL MACHINES

even if all of the specified hosts are unavailable. Multi-host pinning can be used to limit
virtual machines to hosts with, for example, the same physical hardware configuration.

A virtual machine that is pinned to multiple hosts cannot be live migrated, but in the event
of a host failure, any virtual machine configured to be highly available is automatically
restarted on one of the other hosts to which the virtual machine is pinned.

NOTE

High availability is not supported for virtual machines that are pinned to a
single host.

Procedure 5.17. Pinning Virtual Machines to Multiple Hosts

1. Click the Virtual Machines tab and select a virtual machine.

2. Click Edit.

3. Click the Host tab.

4. Select the Specific Host(s) radio button under Start Running On and select two
or more hosts from the list.

5. Select Do not allow migration from the Migration Options drop-down list.

6. Click the High Availability tab.

7. Select the Highly Available check box.

8. Select Low, Medium, or High from the Priority drop-down list. When migration is
triggered, a queue is created in which the high priority virtual machines are
migrated first. If a cluster is running low on resources, only the high priority virtual
machines are migrated.

9. Click OK.

5.8. CHANGING THE CD FOR A VIRTUAL MACHINE


You can change the CD accessible to a virtual machine while that virtual machine is
running.

NOTE

You can only use ISO files that have been added to theISO domain of the
virtual machine's cluster.

Procedure 5.18. Changing the CD for a Virtual Machine

1. Click the Virtual Machines tab and select a running virtual machine.

2. Click Change CD.

3. Select an option from the drop-down list:

63
Virtual Machine Management Guide

Select an ISO file from the list to eject the CD currently accessible to the virtual
machine and mount that ISO file as a CD.

Select [Eject] from the list to eject the CD currently accessible to the virtual
machine.

4. Click OK.

5.9. SMART CARD AUTHENTICATION


Smart cards are an external hardware security feature, most commonly seen in credit
cards, but also used by many businesses as authentication tokens. Smart cards can be used
to protect Red Hat Virtualization virtual machines.

Procedure 5.19. Enabling Smart Cards

1. Ensure that the smart card hardware is plugged into the client machine and is
installed according to manufacturer's directions.

2. Click the Virtual Machines tab and select a virtual machine.

3. Click Edit.

4. Click the Console tab and select the Smartcard enabled check box.

5. Click OK.

6. Connect to the running virtual machine by clicking the Console icon. Smart card
authentication is now passed from the client hardware to the virtual machine.

IMPORTANT

If the Smart card hardware is not correctly installed, enabling the Smart card
feature will result in the virtual machine failing to load properly.

Procedure 5.20. Disabling Smart Cards

1. Click the Virtual Machines tab and select a virtual machine.

2. Click Edit.

3. Click the Console tab, and clear the Smartcard enabled check box.

4. Click OK.

Procedure 5.21. Configuring Client Systems for Smart Card Sharing

1. Smart cards may require certain libraries in order to access their certificates. These
libraries must be visible to the NSS library, which spice-gtk uses to provide the
smart card to the guest. NSS expects the libraries to provide the PKCS #11
interface.

2. Make sure that the module architecture matches spice-gtk/remote-viewer's


architecture. For instance, if you have only the 32b PKCS #11 library available, you
must install the 32b build of virt-viewer in order for smart cards to work.

64
CHAPTER 5. EDITING VIRTUAL MACHINES

Procedure 5.22. Configuring RHEL clients with CoolKey Smart Card Middleware

CoolKey Smart Card middleware is a part of Red Hat Enterprise Linux. Install the
Smart card support group. If the Smart Card Support group is installed on a Red
Hat Enterprise Linux system, smart cards are redirected to the guest when Smart
Cards are enabled. The following command installs the Smart card support group:

# yum groupinstall "Smart card support"

Procedure 5.23. Configuring RHEL clients with Other Smart Card Middleware

Register the library in the system's NSS database. Run the following command as
root:

# modutil -dbdir /etc/pki/nssdb -add "module name" -libfile


/path/to/library.so

Procedure 5.24. Configuring Windows Clients

Red Hat does not provide PKCS #11 support to Windows clients. Libraries that
provide PKCS #11 support must be obtained from third parties. When such libraries
are obtained, register them by running the following command as a user with
elevated privileges:

modutil -dbdir %PROGRAMDATA%\pki\nssdb -add "module name" -libfile


C:\Path\to\module.dll

65
Virtual Machine Management Guide

CHAPTER 6. ADMINISTRATIVE TASKS

6.1. SHUTTING DOWN A VIRTUAL MACHINE

Procedure 6.1. Shutting Down a Virtual Machine

1. Click the Virtual Machines tab and select a running virtual machine.

2. Click the shut down ( ) button.

Alternatively, right-click the virtual machine and select Shutdown.

3. Optionally in the Administration Portal, enter a Reason for shutting down the virtual
machine in the Shut down Virtual Machine(s) confirmation window. This allows
you to provide an explanation for the shutdown, which will appear in the logs and
when the virtual machine is powered on again.

NOTE

The virtual machine shutdown Reason field will only appear if it has
been enabled in the cluster settings. For more information, see
Explanation of Settings and Controls in the New Cluster and Edit Cluster
Windows in the Administration Guide.

4. Click OK in the Shut down Virtual Machine(s) confirmation window.

The virtual machine shuts down gracefully and the Status of the virtual machine changes
to Down.

6.2. SUSPENDING A VIRTUAL MACHINE


Suspending a virtual machine is equal to placing that virtual machine into Hibernate mode.

Procedure 6.2. Suspending a Virtual Machine

1. Click the Virtual Machines tab and select a running virtual machine.

2. Click the Suspend ( ) button.

Alternatively, right-click the virtual machine and select Suspend.

The Status of the virtual machine changes toSuspended.

6.3. REBOOTING A VIRTUAL MACHINE

Procedure 6.3. Rebooting a Virtual Machine

1. Click the Virtual Machines tab and select a running virtual machine.

2. Click the Reboot ( ) button.

66
CHAPTER 6. ADMINISTRATIVE TASKS

Alternatively, right-click the virtual machine and select Reboot.

3. Click OK in the Reboot Virtual Machine(s) confirmation window.

The Status of the virtual machine changes toReboot In Progress before returning to Up.

6.4. REMOVING A VIRTUAL MACHINE

IMPORTANT

The Remove button is disabled while virtual machines are running; you must
shut down a virtual machine before you can remove it.

Procedure 6.4. Removing Virtual Machines

1. Click the Virtual Machines tab and select the virtual machine to remove.

2. Click Remove.

3. Optionally, select the Remove Disk(s) check box to remove the virtual disks
attached to the virtual machine together with the virtual machine. If the Remove
Disk(s) check box is cleared, then the virtual disks remain in the environment as
floating disks.

4. Click OK.

6.5. CLONING A VIRTUAL MACHINE


You can clone virtual machines without having to create a template or a snapshot first.

IMPORTANT

The Clone VM button is disabled while virtual machines are running; you must
shut down a virtual machine before you can clone it.

Procedure 6.5. Cloning Virtual Machines

1. Click the Virtual Machines tab and select the virtual machine to clone.

2. Click Clone VM.

3. Enter a Clone Name for the new virtual machine.

4. Click OK.

6.6. UPDATING VIRTUAL MACHINE GUEST AGENTS AND


DRIVERS

6.6.1. Updating the Guest Agents and Drivers on Red Hat Enterprise
Linux

67
Virtual Machine Management Guide

Update the guest agents and drivers on your Red Hat Enterprise Linux virtual machines to
use the latest version.

Procedure 6.6. Updating the Guest Agents and Drivers on Red Hat Enterprise
Linux

1. Log in to the Red Hat Enterprise Linux virtual machine.

2. Update the ovirt-guest-agent-common package:

# yum update ovirt-guest-agent-common

3. Restart the service:

For Red Hat Enterprise Linux 6

# service ovirt-guest-agent restart

For Red Hat Enterprise Linux 7

# systemctl restart ovirt-guest-agent.service

6.6.2. Updating the Guest Agents and Drivers on Windows


The guest tools comprise software that allows Red Hat Virtualization Manager to
communicate with the virtual machines it manages, providing information such as the IP
addresses, memory usage, and applications installed on those virtual machines. The guest
tools are distributed as an ISO file that can be attached to guests. ThisISO file is packaged
as an RPM file that can be installed and upgraded from the machine on which the Red Hat
Virtualization Manager is installed.

Procedure 6.7. Updating the Guest Agents and Drivers on Windows

1. On the Red Hat Virtualization Manager, update the Red Hat Virtualization Guest
Tools to the latest version:

# yum update -y rhev-guest-tools-iso*

2. Upload the ISO file to your ISO domain, replacing [ISODomain] with the name of your
ISO domain:

engine-iso-uploader --iso-domain=[ISODomain] upload /usr/share/rhev-


guest-tools-iso/rhev-tools-setup.iso

NOTE

The rhev-tools-setup.iso file is a symbolic link to the most recently


updated ISO file. The link is automatically changed to point to the
newest ISO file every time you update the rhev-guest-tools-iso
package.

3. In the Administration or User Portal, if the virtual machine is running, use the

68
CHAPTER 6. ADMINISTRATIVE TASKS

Change CD button to attach the latestrhev-tools-setup.iso file to each of your


virtual machines. If the virtual machine is powered off, click the Run Once button
and attach the ISO as a CD.

4. Select the CD Drive containing the updated ISO and execute the RHEV-
ToolsSetup.exe file.

6.7. VIEWING RED HAT SATELLITE ERRATA FOR A VIRTUAL


MACHINE
Errata for each virtual machine can be viewed after the Red Hat Virtualization virtual
machine has been configured to receive errata information from the Red Hat Satellite
server.

For more information on configuring a virtual machine to display available errata see
Section 4.7, “Configuring Red Hat Satellite Errata Management for a Virtual Machine”

Procedure 6.8. Viewing Red Hat Satellite Errata

1. Click the Virtual Machines tab and select a virtual machine.

2. Click Errata tab in the details pane.

6.8. VIRTUAL MACHINES AND PERMISSIONS

6.8.1. Managing System Permissions for a Virtual Machine


As the SuperUser, the system administrator manages all aspects of the Administration
Portal. More specific administrative roles can be assigned to other users. These restricted
administrator roles are useful for granting a user administrative privileges that limit them
to a specific resource. For example, a DataCenterAdmin role has administrator privileges
only for the assigned data center with the exception of the storage for that data center,
and a ClusterAdmin has administrator privileges only for the assigned cluster.

A UserVmManager is a system administration role for virtual machines in a data center. This
role can be applied to specific virtual machines, to a data center, or to the whole virtualized
environment; this is useful to allow different users to manage certain virtual resources.

The user virtual machine administrator role permits the following actions:

Create, edit, and remove virtual machines.

Run, suspend, shutdown, and stop virtual machines.

NOTE

You can only assign roles and permissions to existing users.

Many end users are concerned solely with the virtual machine resources of the virtualized
environment. As a result, Red Hat Virtualization provides several user roles which enable
the user to manage virtual machines specifically, but not other resources in the data
center.

69
Virtual Machine Management Guide

6.8.2. Virtual Machines Administrator Roles Explained


The table below describes the administrator roles and privileges applicable to virtual
machine administration.

Table 6.1. Red Hat Virtualization System Administrator Roles

Role Privileges Notes

DataCenterAdmin Data Center Administrator Possesses administrative


permissions for all objects
underneath a specific data
center except for storage.

ClusterAdmin Cluster Administrator Possesses administrative


permissions for all objects
underneath a specific cluster.

NetworkAdmin Network Administrator Possesses administrative


permissions for all operations
on a specific logical network.
Can configure and manage
networks attached to virtual
machines. To configure port
mirroring on a virtual machine
network, apply the
NetworkAdmin role on the
network and the
UserVmManager role on the
virtual machine.

6.8.3. Virtual Machine User Roles Explained


The table below describes the user roles and privileges applicable to virtual machine users.
These roles allow access to the User Portal for managing and accessing virtual machines,
but they do not confer any permissions for the Administration Portal.

Table 6.2. Red Hat Virtualization System User Roles

Role Privileges Notes

UserRole Can access and use virtual Can log in to the User Portal
machines and pools. and use virtual machines and
pools.

70
CHAPTER 6. ADMINISTRATIVE TASKS

Role Privileges Notes

PowerUserRole Can create and manage Apply this role to a user for
virtual machines and the whole environment with
templates. the Configure window, or for
specific data centers or
clusters. For example, if a
PowerUserRole is applied on a
data center level, the
PowerUser can create virtual
machines and templates in
the data center. Having a
PowerUserRole is equivalent
to having the VmCreator,
DiskCreator , and
TemplateCreator roles.

UserVmManager System administrator of a Can manage virtual machines


virtual machine. and create and use
snapshots. A user who creates
a virtual machine in the User
Portal is automatically
assigned the UserVmManager
role on the machine.

UserTemplateBasedVm Limited privileges to only use Level of privilege to create a


Templates. virtual machine by means of a
template.

VmCreator Can create virtual machines in This role is not applied to a


the User Portal. specific virtual machine; apply
this role to a user for the
whole environment with the
Configure window. When
applying this role to a cluster,
you must also apply the
DiskCreator role on an
entire data center, or on
specific storage domains.

VnicProfileUser Logical network and network If the Allow all users to


interface user for virtual use this Network option
machines. was selected when a logical
network is created,
VnicProfileUser
permissions are assigned to
all users for the logical
network. Users can then
attach or detach virtual
machine network interfaces to
or from the logical network.

6.8.4. Assigning Virtual Machines to Users

71
Virtual Machine Management Guide

If you are creating virtual machines for users other than yourself, you have to assign roles
to the users before they can use the virtual machines. Note that permissions can only be
assigned to existing users. See Users and Roles in the Red Hat Virtualization Administration
Guide for details on creating user accounts.

The User Portal supports three default roles: User, PowerUser and UserVmManager.
However, customized roles can be configured via the Administration Portal. The default
roles are described below.

A User can connect to and use virtual machines. This role is suitable for desktop
end users performing day-to-day tasks.

A PowerUser can create virtual machines and view virtual resources. This role is
suitable if you are an administrator or manager who needs to provide virtual
resources for your employees.

A UserVmManager can edit and remove virtual machines, assign user permissions,
use snapshots and use templates. It is suitable if you need to make configuration
changes to your virtual environment.

When you create a virtual machine, you automatically inherit UserVmManager privileges.
This enables you to make changes to the virtual machine and assign permissions to the
users you manage, or users who are in your Identity Management (IdM) or RHDS group.
See Administration Guide for more information.

Procedure 6.9. Assigning Permissions to Users

1. Click the Virtual Machines tab and select a virtual machine.

2. Click the Permissions tab on the details pane.

3. Click Add.

4. Enter a name, or user name, or part thereof in the Search text box, and click Go. A
list of possible matches display in the results list.

5. Select the check box of the user to be assigned the permissions.

6. Select UserRole from the Role to Assign drop-down list.

7. Click OK.

The user's name and role display in the list of users permitted to access this virtual
machine.

72
CHAPTER 6. ADMINISTRATIVE TASKS

NOTE

If a user is assigned permissions to only one virtual machine, single sign-on


(SSO) can be configured for the virtual machine. With single sign-on enabled,
when a user logs in to the User Portal, and then connects to a virtual machine
through, for example, a SPICE console, users are automatically logged in to
the virtual machine and do not need to type in the user name and password
again. Single sign-on can be enabled or disabled on a per virtual machine
basis. See Section 4.1, “Configuring Single Sign-On for Virtual Machines”for
more information on how to enable and disable single sign-on for virtual
machines.

6.8.5. Removing Access to Virtual Machines from Users

Procedure 6.10. Removing Access to Virtual Machines from Users

1. Click the Virtual Machines tab and select a virtual machine.

2. Click the Permissions tab on the details pane.

3. Click Remove. A warning message displays, asking you to confirm removal of the
selected permissions.

4. To proceed, click OK. To abort, click Cancel.

6.9. SNAPSHOTS

6.9.1. Creating a Snapshot of a Virtual Machine


A snapshot is a view of a virtual machine's operating system and applications on any or all
available disks at a given point in time. Take a snapshot of a virtual machine before you
make a change to it that may have unintended consequences. You can use a snapshot to
return a virtual machine to a previous state.

Procedure 6.11. Creating a Snapshot of a Virtual Machine

1. Click the Virtual Machines tab and select a virtual machine.

2. Click the Snapshots tab in the details pane and clickCreate.

73
Virtual Machine Management Guide

Figure 6.1. Create snapshot

3. Enter a description for the snapshot.

4. Select Disks to include using the check boxes.

NOTE

If no disks are selected, a partial snapshot of the virtual machine,


without a disk, is created. You can preview this snapshot to view the
configuration of the virtual machine. Note that committing a partial
snapshot will result in a virtual machine without a disk.

5. Use the Save Memory check box if you want to include the virtual machine's memory
in the snapshot.

6. Click OK.

The virtual machine's operating system and applications on the selected disk(s) are stored
in a snapshot that can be previewed or restored. The snapshot is created with a status of
Locked, which changes to Ok. When you click on the snapshot, its details are shown on the
General, Disks, Network Interfaces, and Installed Applications tabs in the right side-
pane of the details pane.

6.9.2. Using a Snapshot to Restore a Virtual Machine

74
CHAPTER 6. ADMINISTRATIVE TASKS

A snapshot can be used to restore a virtual machine to its previous state.

Procedure 6.12. Using Snapshots to Restore Virtual Machines

1. Click the Virtual Machines tab and select a virtual machine.

2. Click the Snapshots tab in the details pane to list the available snapshots.

3. Select a snapshot to restore in the left side-pane. The snapshot details display in
the right side-pane.

4. Click the drop-down menu beside Preview to open the Custom Preview Snapshot
window.

Figure 6.2. Custom Preview Snapshot

5. Use the check boxes to select the VM Configuration, Memory, and disk(s) you want
to restore, then click OK. This allows you to create and restore from a customized
snapshot using the configuration and disk(s) from multiple snapshots.

75
Virtual Machine Management Guide

Figure 6.3. The Custom Preview Snapshot Window

The status of the snapshot changes to Preview Mode. The status of the virtual
machine briefly changes to Image Locked before returning to Down.

6. Start the virtual machine; it runs using the disk image of the snapshot.

7. Click Commit to permanently restore the virtual machine to the condition of the
snapshot. Any subsequent snapshots are erased.

Alternatively, click the Undo button to deactivate the snapshot and return the virtual
machine to its previous state.

6.9.3. Creating a Virtual Machine from a Snapshot


You have created a snapshot from a virtual machine. Now you can use that snapshot to
create another virtual machine.

Procedure 6.13. Creating a virtual machine from a snapshot

1. Click the Virtual Machines tab and select a virtual machine.

2. Click the Snapshots tab in the details pane to list the available snapshots.

3. Select a snapshot in the list displayed and click Clone.

4. Enter the Name and Description for the virtual machine.

76
CHAPTER 6. ADMINISTRATIVE TASKS

Figure 6.4. Clone a Virtual Machine from a Snapshot

5. Click OK.

After a short time, the cloned virtual machine appears in the Virtual Machines tab in the
navigation pane with a status of Image Locked. The virtual machine will remain in this state
until Red Hat Virtualization completes the creation of the virtual machine. A virtual
machine with a preallocated 20 GB hard drive takes about fifteen minutes to create.
Sparsely-allocated virtual disks take less time to create than do preallocated virtual disks.

When the virtual machine is ready to use, its status changes from Image Locked to Down in
the Virtual Machines tab in the navigation pane.

6.9.4. Deleting a Snapshot


You can delete a virtual machine snapshot and permanently remove it from your Red Hat
Virtualization environment. This operation is only supported on a running virtual machine.

77
Virtual Machine Management Guide

IMPORTANT

When you delete a snapshot from an image chain, ensure there is enough free
space in the storage domain to temporarily accommodate both the original
volume and the newly merged volume. Otherwise, snapshot deletion will fail
and you will need to export and re-import the volume to remove snapshots.
This is due to the data from the two volumes being merged in the resized
volume and the resized volume growing to accommodate the total size of the
two merged images.

If the snapshot being deleted is contained in a base image, the volume


subsequent to the volume containing the snapshot being deleted is
extended to include the base volume.

If the snapshot being deleted is contained in a QCOW2 (thin


provisioned), non-base image hosted on internal storage, the successor
volume is extended to include the volume containing the snapshot
being deleted.

Procedure 6.14. Deleting a Snapshot

1. Click the Virtual Machines tab and select a virtual machine.

2. Click the Snapshots tab in the details pane to list the snapshots for that virtual
machine.

Figure 6.5. Snapshot List

3. Select the snapshot to delete.

4. Click Delete.

5. Click OK.

NOTE

If the deletion fails, fix the underlying problem (for example, a failed host, an
inaccessible storage device, or even a temporary network issue) and try again.

6.10. HOST DEVICES

6.10.1. Adding a Host Device to a Virtual Machine

78
CHAPTER 6. ADMINISTRATIVE TASKS

Virtual machines can be directly attached to the host devices for improved performance if a
compatible host has been configured for direct device assignment. Host devices are
devices that are physically plugged into the host, including SCSI (for example tapes, disks,
changers), PCI (for example NICs, GPUs, and HBAs), and USB (for example mice, cameras,
and disks).

Procedure 6.15. Adding Host Devices to a Virtual Machine

1. Select a virtual machine and click the Host Devices tab in the details pane to list
the host devices already attached to this virtual machine. A virtual machine can
only have devices attached from the same host. If a virtual machine has attached
devices from one host, and you attach a device from another host, the attached
devices from the previous host will be automatically removed.

Attaching host devices to a virtual machine requires the virtual machine to be in a


Down state. If the virtual machine is running, the changes will not take effect until
after the virtual machine has been shut down.

2. Click Add device to open the Add Host Devices window.

3. Use the Pinned Host dropdown menu to select a host.

4. Use the Capability dropdown menu to list thepci, scsi, or usb_device host
devices.

5. Select the check boxes of the devices to attach to the virtual machine from the
Available Host Devices pane and click the directional arrow button to transfer
these devices to the Host Devices to be attached pane, creating a list of the
devices to attach to the virtual machine.

6. When you have transferred all desired host devices to the Host Devices to be
attached pane, click OK to attach these devices to the virtual machine and close the
window.

These host devices will be attached to the virtual machine when the virtual machine is next
powered on.

6.10.2. Removing Host Devices from a Virtual Machine


Remove a host device from a virtual machine to which it has been directly attached using
the details pane of the virtual machine.

If you are removing all host devices directly attached to the virtual machine in order to add
devices from a different host, you can instead add the devices from the desired host, which
will automatically remove all of the devices already attached to the virtual machine.

Procedure 6.16. Removing a Host Device from a Virtual Machine

1. Select the virtual machine and click the Host Devices tab in the details pane to list
the host devices attached to the virtual machine.

2. Select the host device to detach from the virtual machine, or hold Ctrl to select
multiple devices, and click Remove device to open the Remove Host Device(s)
window.

3. Click OK to confirm and detach these devices from the virtual machine.

79
Virtual Machine Management Guide

6.10.3. Pinning a Virtual Machine to Another Host


You can use the Host Devices tab in the details pane of a virtual machine to pin it to a
specific host.

If the virtual machine has any host devices attached to it, pinning it to another host will
automatically remove the host devices from the virtual machine.

Procedure 6.17. Pinning a Virtual Machine to a Host

1. Select a virtual machine and click the Host Devices tab in the details pane.

2. Click Pin to another host to open the Pin VM to Host window.

3. Use the Host drop-down menu to select a host.

4. Click OK to pin the virtual machine to the selected host.

6.11. AFFINITY GROUPS


Virtual machine affinity allows you to define sets of rules that specify whether certain
virtual machines run together on the same host or hosts in a group, or run separately on
different hosts. This allows you to create advanced workload scenarios for addressing
challenges such as strict licensing requirements, workloads demanding high availability,
and failover and failback for disaster recovery.

Virtual machine affinity is applied to virtual machines by adding virtual machines to one or
more affinity groups. An affinity group is a group of two or more virtual machines for which
a set of identical parameters and conditions apply. These parameters include positive (run
together) affinity that ensures the virtual machines in an affinity group run on the same
host or hosts in a group, and negative (run independently) affinity that ensures the virtual
machines in an affinity group run on different hosts.

IMPORTANT

Affinity groups will only take effect when the VmAffinityGroups or


VmToHostsAffinityGroups filter module or weights module is enabled in the
scheduling policy applied to clusters in which affinity groups are defined. The
two modules are complementary and can be used together. For more
information about scheduling policies see Scheduling Policies in the
Administration Guide.

A further set of conditions can then be applied to these parameters in the associated
scheduling policy.

Hard enforcement - ensures that virtual machines in the affinity group run on a
specified host or hosts in a group regardless of external conditions. The filter
modules in the scheduling policy implement hard enforcement.

Soft enforcement - indicates a preference for virtual machines in an affinity group to


run on the specified host or hosts in a group when possible. The the weights
modules in the scheduling policy implement soft enforcement.

80
CHAPTER 6. ADMINISTRATIVE TASKS

The combination of an affinity group, its parameters, and its conditions is known as an
affinity policy. Affinity policies are applied to running virtual machines immediately, without
having to restart.

NOTE

Affinity groups are applied to virtual machines on the cluster level. When a
virtual machine is moved from one cluster to another, that virtual machine is
removed from all affinity groups in the source cluster.

6.11.1. Creating an Affinity Group


You can create new affinity groups in the Administration Portal.

Procedure 6.18. Creating Affinity Groups

1. Click the Virtual Machines tab and select a virtual machine.

2. Click the Affinity Groups tab in the details pane.

3. Click New.

4. Enter a Name and Description for the affinity group.

5. From the VM Affinity Rule drop-down, select Positive to apply positive affinity or
Negative to apply negative affinity. Select Disable to disable the affinity rule.

6. Select the Enforcing check box to apply hard enforcement, or ensure this check
box is cleared to apply soft enforcement.

7. Use the drop-down list to select the virtual machines to be added to the affinity
group. Use the + and - buttons to add or remove additional virtual machines.

8. Click OK.

6.11.2. Editing an Affinity Group

Procedure 6.19. Editing Affinity Groups

1. Click the Virtual Machines tab and select a virtual machine.

2. Click the Affinity Groups tab in the details pane.

3. Click Edit.

4. Change the VM Affinity Rule drop-down and Enforcing check box to the
preferred values and use the + and - buttons to add or remove virtual machines to
or from the affinity group.

5. Click OK.

6.11.3. Removing an Affinity Group

Procedure 6.20. Removing Affinity Groups

81
Virtual Machine Management Guide

1. Click the Virtual Machines tab and select a virtual machine.

2. Click the Affinity Groups tab in the details pane.

3. Click Remove.

4. Click OK.

The affinity policy that applied to the virtual machines that were members of that affinity
group no longer applies.

6.12. EXPORTING AND IMPORTING VIRTUAL MACHINES AND


TEMPLATES

NOTE

The export storage domain is deprecated. Storage data domains can be


unattached from a data center and imported to another data center in the
same environment, or in a different environment. Virtual machines, floating
virtual disks, and templates can then be uploaded from the imported storage
domain to the attached data center. See the Importing Existing Storage
Domains section in the Red Hat Virtualization Administration Guide for
information on importing storage domains.

Virtual machines and templates stored in Open Virtual Machine Format (OVF) can be
exported from and imported to data centers in the same or different Red Hat Virtualization
environment. Virtual machines stored in an Open Virtual Appliance (OVA) file can be
imported to data centers.

To export or import virtual machines and templates, an active export domain must be
attached to the data center containing the virtual machine or template to be exported or
imported. An export domain acts as a temporary storage area containing two directories for
each exported virtual machine or template. One directory contains the OVF files for the
virtual machine or template. The other directory holds the disk image or images for the
virtual machine or template.

There are three stages to exporting and importing virtual machines and templates:

1. Export the virtual machine or template to an export domain.

2. Detach the export domain from one data center, and attach it to another. You can
attach it to a different data center in the same Red Hat Virtualization environment,
or attach it to a data center in a separate Red Hat Virtualization environment that is
managed by another installation of the Red Hat Virtualization Manager.

NOTE

An export domain can only be active in one data center at a given


time. This means that the export domain must be attached to either
the source data center or the destination data center.

3. Import the virtual machine or template into the data center to which the export
domain is attached.

82
CHAPTER 6. ADMINISTRATIVE TASKS

When you export or import a virtual machine or template, properties including basic details
such as the name and description, resource allocation, and high availability settings of that
virtual machine or template are preserved. Specific user roles and permissions, however,
are not preserved during the export process. If certain user roles and permissions are
required to access the virtual machine or template, they will need to be set again after the
virtual machine or template is imported.

You can also use the V2V feature to import virtual machines from other virtualization
providers, such as Xen or VMware, or import Windows virtual machines. V2V converts
virtual machines so that they can be hosted by Red Hat Virtualization. For more information
on installing and using V2V, see Converting Virtual Machines from Other Hypervisors to
KVM with virt-v2v.

IMPORTANT

Virtual machines must be shut down before being exported or imported.

6.12.1. Exporting a Virtual Machine to the Export Domain


Export a virtual machine to the export domain so that it can be imported into a different
data center. Before you begin, the export domain must be attached to the data center that
contains the virtual machine to be exported.


WARNING

The virtual machine must be shut down before being exported.

Procedure 6.21. Exporting a Virtual Machine to the Export Domain

1. Click the Virtual Machines tab and select a virtual machine.

2. Click Export.

3. Optionally select the following check boxes:

Force Override: overrides existing images of the virtual machine on the export
domain.

Collapse Snapshots: creates a single export volume per disk. This option
removes snapshot restore points and includes the template in a template-based
virtual machine, and removes any dependencies a virtual machine has on a
template. For a virtual machine that is dependent on a template, either select
this option, export the template with the virtual machine, or make sure the
template exists in the destination data center.

83
Virtual Machine Management Guide

NOTE

When you create a virtual machine from a template, two storage


allocation options are available under New Virtual Machine →
Resource Allocation → Storage Allocation.

If Clone was selected, the virtual machine is not dependent on


the template. The template does not have to exist in the
destination data center.

If Thin was selected, the virtual machine is dependent on the


template, so the template must exist in the destination data
center or be exported with the virtual machine. Alternatively,
select the Collapse Snapshots check box to collapse the
template disk and virtual disk into a single disk.

To check which option was selected, select a virtual machine and


click the General tab in the details pane.

4. Click OK.

The export of the virtual machine begins. The virtual machine displays in the Virtual
Machines results list with an Image Locked status while it is exported. Depending on the
size of your virtual machine hard disk images, and your storage hardware, this can take up
to an hour. Use the Events tab to view the progress. When complete, the virtual machine
has been exported to the export domain and displays on the VM Import tab of the export
domain's details pane.

6.12.2. Importing a Virtual Machine into the Destination Data Center


You have a virtual machine on an export domain. Before the virtual machine can be
imported to a new data center, the export domain must be attached to the destination data
center.

Procedure 6.22. Importing a Virtual Machine into the Destination Data Center

1. Click the Storage tab, and select the export domain in the results list. The export
domain must have a status of Active.

2. Select the VM Import tab in the details pane to list the available virtual machines to
import.

3. Select one or more virtual machines to import and click Import.

84
CHAPTER 6. ADMINISTRATIVE TASKS

Figure 6.6. Import Virtual Machine

4. Select the Default Storage Domain and Cluster.

5. Select the Collapse Snapshots check box to remove snapshot restore points and
include templates in template-based virtual machines.

6. Click the virtual machine to be imported and click on the Disks sub-tab. From this
tab, you can use the Allocation Policy and Storage Domain drop-down lists to
select whether the disk used by the virtual machine will be thinly provisioned or
preallocated, and can also select the storage domain on which the disk will be
stored. An icon is also displayed to indicate which of the disks to be imported acts as
the boot disk for that virtual machine.

7. Click OK to import the virtual machines.

The Import Virtual Machine Conflict window opens if the virtual machine exists
in the virtualized environment.

85
Virtual Machine Management Guide

Figure 6.7. Import Virtual Machine Conflict Window

8. Choose one of the following radio buttons:

Don't import

Import as cloned and enter a unique name for the virtual machine in theNew
Name field.

9. Optionally select the Apply to all check box to import all duplicated virtual
machines with the same suffix, and then enter a suffix in the Suffix to add to
the cloned VMs field.

10. Click OK.

IMPORTANT

During a single import operation, you can only import virtual machines that
share the same architecture. If any of the virtual machines to be imported
have a different architecture to that of the other virtual machines to be
imported, a warning will display and you will be prompted to change your
selection so that only virtual machines with the same architecture will be
imported.

6.12.3. Importing a Virtual Machine from a VMware Provider


Import virtual machines from a VMware vCenter provider to your Red Hat Virtualization
environment. You can import from a VMware provider by entering its details in the Import
Virtual Machine(s) window during each import operation, or you can add the VMware
provider as an external provider, and select the preconfigured provider during import
operations. To add an external provider, see Adding a VMware Instance as a Virtual Machine
Provider.

86
CHAPTER 6. ADMINISTRATIVE TASKS

Red Hat Virtualization uses V2V to import VMware virtual machines. For OVA files, the only
disk format Red Hat Virtualization supports is VMDK.

The virt-v2v package must be installed on at least one host (referred to in this procedure as
the proxy host). The virt-v2v package is available by default on Red Hat Virtualization Hosts
(RHVH) and is installed on Red Hat Enterprise Linux hosts as a dependency of VDSM when
added to the Red Hat Virtualization environment. Red Hat Enterprise Linux hosts must be
Red Hat Enterprise Linux 7.2 or later.

NOTE

The virt-v2v package is not available on the ppc64le architecture and these
hosts cannot be used as proxy hosts.

IMPORTANT

An import operation can only include virtual machines that share the same
architecture. If any virtual machine to be imported has a different
architecture, a warning will display and you will be prompted to change your
selection to include only virtual machines with the same architecture.

NOTE

If the import fails, refer to the relevant log file in /var/log/vdsm/import/ and
to /var/log/vdsm/vdsm.log on the proxy host for details.

Procedure 6.23. Importing a Virtual Machine from VMware

1. Shut down the virtual machine. Starting the virtual machine through VMware during
the import process can result in data corruption.

2. In the Virtual Machines tab, click Import to open the Import Virtual
Machine(s) window.

87
Virtual Machine Management Guide

Figure 6.8. The Import Virtual Machine(s) Window

3. Select VMware from the Source list.

4. If you have configured a VMware provider as an external provider, select it from the
External Provider list. Verify that the provider credentials are correct. If you did
not specify a destination data center or proxy host when configuring the external
provider, select those options now.

5. If you have not configured a VMware provider, or want to import from a new VMware
provider, provide the following details:

a. Select from the list the Data Center in which the virtual machine will be
available.

b. Enter the IP address or fully qualified domain name of the VMware vCenter
instance in the vCenter field.

c. Enter the IP address or fully qualified domain name of the host from which the
virtual machines will be imported in the ESXi field.

d. Enter the name of the data center and the cluster in which the specified ESXi
host resides in the Data Center field.

e. If you have exchanged the SSL certificate between the ESXi host and the
Manager, leave Verify server's SSL certificate checked to verify the ESXi
host's certificate. If not, uncheck the option.

88
CHAPTER 6. ADMINISTRATIVE TASKS

f. Enter the Username and Password for the VMware vCenter instance. The user
must have access to the VMware data center and ESXi host on which the virtual
machines reside.

g. Select a host in the chosen data center with virt-v2v installed to serve as the
Proxy Host during virtual machine import operations. This host must also be
able to connect to the network of the VMware vCenter external provider.

h. Click Load to list the virtual machines on the VMware provider that can be
imported.

i. Select one or more virtual machines from the Virtual Machines on Source list,
and use the arrows to move them to the Virtual Machines to Import list.

NOTE

If a virtual machine's network device uses the driver type e1000 or


rtl8139, the virtual machine will use the same driver type after it
has been imported to Red Hat Virtualization.

If required, you can change the driver type to VirtIO manually after
the import. To change the driver type after a virtual machine has
been imported, see Section 5.3.2, “Editing a Network Interface”. If
the network device uses driver types other than e1000 or rtl8139,
the driver type is changed to VirtIO automatically during the import.
The Attach VirtIO-drivers check box allows the VirtIO drivers to
be injected into the imported virtual machine files so that when the
driver is changed to VirtIO, the device will be properly detected by
the operating system.

6. Click Next.

a. Select the Cluster in which the virtual machines will reside.

b. Select a CPU Profile for the virtual machines.

c. Select the Collapse Snapshots check box to remove snapshot restore points
and include templates in template-based virtual machines.

d. Select the Clone check box to change the virtual machine name and MAC
addresses, and clone all disks, removing all snapshots. If a virtual machine
appears with a warning symbol beside its name or has a tick in the VM in
System column, you must clone the virtual machine and change its name.

e. Select each virtual machine to be imported and click the Disks sub-tab. Use the
Allocation Policy and Storage Domain lists to select whether the disk used
by the virtual machine will be thinly provisioned or preallocated, and select the
storage domain on which the disk will be stored. An icon displays to indicate
which imported disk will be the boot disk for that virtual machine.

f. If you selected the Clone check box, change the name of the virtual machine in
the General sub-tab.

7. Click OK to import the virtual machines.

89
Virtual Machine Management Guide

The CPU type of the virtual machine must be the same as the CPU type of the cluster into
which it is being imported.

Procedure 6.24. Viewing a Cluster's CPU Type

1. Click the Cluster tab.

2. Select a cluster.

3. Click Edit.

4. Click the General tab.

Procedure 6.25. Configuring a Virtual Machine's CPU Type

1. Click the Virtual Machines tab.

2. Select the virtual machine.

3. Click Edit.

4. Click the System tab.

5. Click the Advanced Parameters arrow.

6. Specify the Custom CPU Type.

6.12.4. Importing an OVA File from VMware


Import an Open Virtual Appliance (OVA) file to your Red Hat Virtualization environment. You
can import from a VMware host by entering its details in the Import Virtual Machine(s)
window during each import operation, or you can add the VMware provider as an external
provider, and select the preconfigured provider during import operations. To add an
external provider, see Adding a VMware Instance as a Virtual Machine Provider.

IMPORTANT

The OVA file format must be TAR.

Currently, OVA files can only be imported from a VMware host. KVM and Xen
are not supported.

Procedure 6.26. Importing an OVA File

1. Copy the OVA file to a host in your cluster, in a file system location such as
/var/tmp.

NOTE

The location can be a local directory or a remote nfs mount, as long as


it has sufficient space and is accessible to the qemu user (UID 36).

2. Ensure that the OVA file has permissions allowing read/write access to the qemu user
(UID 36) and the kvm group (GID 36):

90
CHAPTER 6. ADMINISTRATIVE TASKS

# chown 36:36 path_to_OVA_file/file.OVA

3. In the Virtual Machines tab, click Import to open the Import Virtual
Machine(s) window.

a. Select VMware Virtual Appliance (OVA) from the Source list.

b. Select a host from the Host list. This will be the same host that you exported
from the VMware provider.

c. In the Path box, specify the path of the OVA file.

d. Click Load to list the virtual machines that can be imported.

e. Select one or more virtual machines from the Virtual Machines on Source list,
and use the arrows to move them to the Virtual Machines to Import list.

4. Click Next.

a. Select the Target Cluster where the virtual machines will reside.

b. Select the CPU Profile for the virtual machines.

c. Select the Allocation Policy for the virtual machines.

d. Optionally, select the Attach VirtIO-Drivers check box and select the
appropriate image on the list to add VirtIO drivers.

e. Click each virtual machine you will be importing. On the General sub-tab, select
the Operating System.

f. On the Network Interfaces sub-tab, select the Network Name and Profile
Name.

g. Click the Disks sub-tab to view the Alias, Virtual Size and Actual Size of
the virtual machine.

5. Click OK to import the virtual machines.

6.12.5. Importing a Virtual Machine from a Xen Host


Import virtual machines from Xen on Red Hat Enterprise Linux 5 to your Red Hat
Virtualization environment. Red Hat Virtualization uses V2V to import QCOW2 or RAW
virtual machine disk formats.

The virt-v2v package must be installed on at least one host (referred to in this procedure as
the proxy host). The virt-v2v package is available by default on Red Hat Virtualization Hosts
(RHVH) and is installed on Red Hat Enterprise Linux hosts as a dependency of VDSM when
added to the Red Hat Virtualization environment. Red Hat Enterprise Linux hosts must be
Red Hat Enterprise Linux 7.2 or later.

91
Virtual Machine Management Guide


WARNING

If you are importing a Windows virtual machine from a Xen host and you
are using VirtIO devices, install the VirtIO drivers before importing the
virtual machine. If the drivers are not installed, the virtual machine may
not boot after import.

The VirtIO drivers can be installed from the virtio-win.iso or the rhev-
tools-setup.iso. See Section 3.3.2, “Installing the Guest Agents and
Drivers on Windows” for details.

If you are not using VirtIO drivers, review the configuration of the virtual
machine after import, and before first boot to ensure that VirtIO devices
are not being used.

NOTE

The virt-v2v package is not available on the ppc64le architecture and these
hosts cannot be used as proxy hosts.

IMPORTANT

An import operation can only include virtual machines that share the same
architecture. If any virtual machine to be imported has a different
architecture, a warning will display and you will be prompted to change your
selection to include only virtual machines with the same architecture.

NOTE

If the import fails, refer to the relevant log file in /var/log/vdsm/import/ and
to /var/log/vdsm/vdsm.log on the proxy host for details.

Procedure 6.27. Importing a Virtual Machine from Xen

1. Shut down the virtual machine. Starting the virtual machine through Xen during the
import process can result in data corruption.

2. Enable public key authentication between the proxy host and the Xen host:

a. Log in to the proxy host and generate SSH keys for the vdsm user.

# sudo -u vdsm ssh-keygen

b. Copy the vdsm user's public key to the Xen host.

# sudo -u vdsm ssh-copy-id [email protected]

c. Log in to the Xen host to verify that the login works correctly.

92
CHAPTER 6. ADMINISTRATIVE TASKS

# sudo -u vdsm ssh [email protected]

3. Log in to the Administration Portal. In the Virtual Machines tab, click Import to
open the Import Virtual Machine(s) window.

Figure 6.9. The Import Virtual Machine(s) Window

4. Select the Data Center that contains the proxy host.

5. Select XEN (via RHEL) from the Source drop-down list.

6. Optionally, select a Xen provider External Provider from the drop-down list. The
URI will be pre-filled with the correct URI. See Adding a Xen Host as a Virtual
Machine Provider in the Administration Guide for more information.

7. Enter the URI of the Xen host. The required format is pre-filled; you must replace
<hostname> with the host name of the Xen host.

8. Select the proxy host from the Proxy Host drop-down list.

9. Click Load to list the virtual machines on the Xen host that can be imported.

10. Select one or more virtual machines from the Virtual Machines on Source list,
and use the arrows to move them to the Virtual Machines to Import list.

93
Virtual Machine Management Guide

NOTE

Due to current limitations, Xen virtual machines with block devices do


not appear in the Virtual Machines on Source list. They must be
imported manually. See Importing a Block-Based Virtual Machine from
a Xen Host.

11. Click Next.

12. Select the Cluster in which the virtual machines will reside.

13. Select a CPU Profile for the virtual machines.

14. Use the Allocation Policy and Storage Domain lists to select whether the disk
used by the virtual machines will be thinly provisioned or preallocated, and select
the storage domain on which the disk will be stored.

NOTE

The target storage domain must be a file-based domain. Due to current


limitations, specifying a block-based domain causes the V2V operation
to fail.

15. If a virtual machine appears with a warning symbol beside its name, or has a tick in
the VM in System column, select the Clone check box to clone the virtual machine.

NOTE

Cloning a virtual machine changes its name and MAC addresses and
clones all of its disks, removing all snapshots.

16. Click OK to import the virtual machines.

The CPU type of the virtual machine must be the same as the CPU type of the cluster into
which it is being imported. See Viewing CPU Type of Cluster and Configuring CPU Type of
Virtual Machine for details.

Procedure 6.28. Importing a Block-Based Virtual Machine from a Xen Host

1. Enable public key authentication between the proxy host and the Xen host:

a. Log in to the proxy host and generate SSH keys for the vdsm user.

# sudo -u vdsm ssh-keygen

b. Copy the vdsm user's public key to the Xen host.

# sudo -u vdsm ssh-copy-id [email protected]

c. Log in to the Xen host to verify that the login works correctly.

# sudo -u vdsm ssh [email protected]

94
CHAPTER 6. ADMINISTRATIVE TASKS

2. Attach an export domain. See Attaching an Existing Export Domain to a Data Center
in the Administration Guide for details.

3. On the proxy host, copy the virtual machine from the Xen host:

# virt-v2v-copy-to-local -ic xen+ssh://[email protected]


vmname

4. Convert the virtual machine to libvirt XML and move the file to your export domain:

# virt-v2v -i libvirtxml vmname.xml -o rhev -of raw -os


storage.example.com:/exportdomain

5. In the Administration Portal, click Storage, select the export domain, and click VM
Import in the details pane to verify that the virtual machine is in your export
domain.

6. Import the virtual machine into the destination data domain. See Section 6.12.2,
“Importing a Virtual Machine into the Destination Data Center” for details.

6.12.6. Importing a Virtual Machine from a KVM Host


Import virtual machines from KVM to your Red Hat Virtualization environment. Red Hat
Virtualization converts KVM virtual machines to the correct format before they are
imported. You must enable public key authentication between the KVM host and at least
one host in the destination data center (this host is referred to in the following procedure
as the proxy host).

If the import fails, refer to /var/log/vdsm/vdsm.log, and the relevant log file in
/var/log/vdsm/import/ on the proxy host for details.


WARNING

If you are importing a Windows virtual machine from a KVM host and you
are using VirtIO devices, install the VirtIO drivers before importing the
virtual machine. If the drivers are not installed, the virtual machine may
not boot after import.

The VirtIO drivers can be installed from the virtio-win.iso or the rhev-
tools-setup.iso. See Section 3.3.2, “Installing the Guest Agents and
Drivers on Windows” for details.

If you are not using VirtIO drivers, review the configuration of the virtual
machine after import, and before first boot to ensure that VirtIO devices
are not being used.

95
Virtual Machine Management Guide

IMPORTANT

An import operation can only include virtual machines that share the same
architecture. If any virtual machine to be imported has a different
architecture, a warning will display and you will be prompted to change your
selection to include only virtual machines with the same architecture.

Procedure 6.29. Importing a Virtual Machine from KVM

1. Shut down the virtual machine. Starting the virtual machine through KVM during the
import process can result in data corruption.

2. Enable public key authentication between the proxy host and the KVM host:

a. Log in to the proxy host and generate SSH keys for the vdsm user.

# sudo -u vdsm ssh-keygen

b. Copy the vdsm user's public key to the KVM host. The proxy host'sknown_hosts
file will also be updated to include the host key of the KVM host.

# sudo -u vdsm ssh-copy-id [email protected]

c. Log in to the KVM host to verify that the login works correctly.

# sudo -u vdsm ssh [email protected]

3. Log in to the Administration Portal. In the Virtual Machines tab, click Import to
open the Import Virtual Machine(s) window.

96
CHAPTER 6. ADMINISTRATIVE TASKS

Figure 6.10. The Import Virtual Machine(s) Window

4. Select the Data Center that contains the proxy host.

5. Select KVM (via Libvirt) from the Source drop-down list.

6. Optionally, select a KVM provider External Provider from the drop-down list. The
URI will be pre-filled with the correct URI. See Adding a KVM Host as a Virtual
Machine Provider in the Administration Guide for more information.

7. Enter the URI of the KVM host in the following format:

qemu+ssh://[email protected]/system

8. Keep the Requires Authentication check box selected.

9. Enter root in the Username field.

10. Enter the Password of the KVM host's root user.

11. Select the Proxy Host from the drop-down list.

12. Click Load to list the virtual machines on the KVM host that can be imported.

13. Select one or more virtual machines from the Virtual Machines on Source list,
and use the arrows to move them to the Virtual Machines to Import list.

97
Virtual Machine Management Guide

14. Click Next.

15. Select the Cluster in which the virtual machines will reside.

16. Select a CPU Profile for the virtual machines.

17. Optionally, select the Collapse Snapshots check box to remove snapshot restore
points and include templates in template-based virtual machines.

18. Optionally, select the Clone check box to change the virtual machine name and
MAC addresses, and clone all disks, removing all snapshots. If a virtual machine
appears with a warning symbol beside its name or has a tick in the VM in System
column, you must clone the virtual machine and change its name.

19. Click on each virtual machine to be imported and click on the Disks sub-tab. Use
the Allocation Policy and Storage Domain lists to select whether the disk used
by the virtual machine will be thin provisioned or preallocated, and select the
storage domain on which the disk will be stored. An icon is also displayed to indicate
which of the disks to be imported acts as the boot disk for that virtual machine. See
Virtual Disk Storage Allocation Policies in the Technical Reference for more
information.

NOTE

The target storage domain must be a file-based domain. Due to current


limitations, specifying a block-based domain causes the operation to
fail.

20. If you selected the Clone check box, change the name of the virtual machine in the
General sub-tab.

21. Click OK to import the virtual machines.

The CPU type of the virtual machine must be the same as the CPU type of the cluster into
which it is being imported. See Viewing CPU Type of Cluster and Configuring CPU Type of
Virtual Machine for details.

6.12.7. Importing a Red Hat KVM Guest Image


You can import a Red Hat-provided KVM virtual machine image. This image is a virtual
machine snapshot with a preconfigured instance of Red Hat Enterprise Linux installed.

You can configure this image with the cloud-init tool, and use it to provision new virtual
machines. This eliminates the need to install and configure the operating system and
provides virtual machines that are ready for use.

Procedure 6.30. Importing a Red Hat KVM Guest Image

1. Download the most recent KVM virtual machine image from the Download Red Hat
Enterprise Linux list, in the Product Software tab.

2. Upload the virtual machine image using the Manager or the REST API. See
Uploading a Disk Image to a Storage Domain in the Administration Guide.

98
CHAPTER 6. ADMINISTRATIVE TASKS

3. Create a new virtual machine and attach the uploaded disk image to it. See
Section 2.1, “Creating a Linux Virtual Machine”.

4. Optionally, use cloud-init to configure the virtual machine. See Section 7.8, “Using
Cloud-Init to Automate the Configuration of Virtual Machines” for details.

5. Optionally, create a template from the virtual machine. You can generate new
virtual machines from this template. See Chapter 7, Templates for information about
creating templates and generating virtual machines from templates.

6.13. MIGRATING VIRTUAL MACHINES BETWEEN HOSTS


Live migration provides the ability to move a running virtual machine between physical
hosts with no interruption to service. The virtual machine remains powered on and user
applications continue to run while the virtual machine is relocated to a new physical host.
In the background, the virtual machine's RAM is copied from the source host to the
destination host. Storage and network connectivity are not altered.

6.13.1. Live Migration Prerequisites


Live migration is used to seamlessly move virtual machines to support a number of
common maintenance tasks. Ensure that your Red Hat Virtualization environment is
correctly configured to support live migration well in advance of using it.

At a minimum, for successful live migration of virtual machines to be possible:

The source and destination host should both be members of the same cluster,
ensuring CPU compatibility between them.

NOTE

Live migrating virtual machines between different clusters is generally


not recommended. The currently only supported use case is
documented at https://access.redhat.com/articles/1390733.

The source and destination host must have a status of Up.

The source and destination host must have access to the same virtual networks and
VLANs.

The source and destination host must have access to the data storage domain on
which the virtual machine resides.

There must be enough CPU capacity on the destination host to support the virtual
machine's requirements.

There must be enough RAM on the destination host that is not in use to support the
virtual machine's requirements.

The migrating virtual machine must not have the cache!=none custom property set.

In addition, for best performance, the storage and management networks should be split to
avoid network saturation. Virtual machine migration involves transferring large amounts of
data between hosts.

99
Virtual Machine Management Guide

Live migration is performed using the management network. Each live migration event is
limited to a maximum transfer speed of 30 MBps, and the number of concurrent migrations
supported is also limited by default. Despite these measures, concurrent migrations have
the potential to saturate the management network. It is recommended that separate logical
networks are created for storage, display, and virtual machine data to minimize the risk of
network saturation.

Additional Prerequisites for Virtual Machines with SR-IOV-Enabled vNICs

Virtual machines with vNICs that are directly connected to a virtual function (VF) of an SR-
IOV-enabled host NIC have additional requirements for successful migration:

There must be an available VF on the destination host.

The vNIC profile for the passthrough vNIC must have Passthrough and Migratable
selected. See Enabling Passthrough on a vNIC Profile in the Administration Guide for
more information.

The virtual machine must have a backup VirtIO vNIC, in addition to the
passthrough vNIC, to maintain the virtual machine's network connection during
migration.

Both vNICs must be added as slaves under an active-backup bond on the virtual
machine, with the passthrough vNIC as the primary interface. See Configure
Network Bonding in the Red Hat Enterprise Linux Networking Guide for more
information.

6.13.2. Optimizing Live Migration


Live virtual machine migration can be a resource-intensive operation. The following two
options can be set globally for every virtual machine in the environment, at the cluster
level, or at the individual virtual machine level to optimize live migration.

The Auto Converge migrations option allows you to set whether auto-convergence is
used during live migration of virtual machines. Large virtual machines with high workloads
can dirty memory more quickly than the transfer rate achieved during live migration, and
prevent the migration from converging. Auto-convergence capabilities in QEMU allow you
to force convergence of virtual machine migrations. QEMU automatically detects a lack of
convergence and triggers a throttle-down of the vCPUs on the virtual machine.

The Enable migration compression option allows you to set whether migration
compression is used during live migration of the virtual machine. This feature uses Xor
Binary Zero Run-Length-Encoding to reduce virtual machine downtime and total live
migration time for virtual machines running memory write-intensive workloads or for any
application with a sparse memory update pattern.

Both options are disabled globally by default.

Procedure 6.31. Configuring Auto-convergence and Migration Compression for


Virtual Machine Migration

1. Configure the optimization settings at the global level:

a. Enable auto-convergence at the global level:

# engine-config -s DefaultAutoConvergence=True

100
CHAPTER 6. ADMINISTRATIVE TASKS

b. Enable migration compression at the global level:

# engine-config -s DefaultMigrationCompression=True

c. Restart the ovirt-engine service to apply the changes:

# systemctl restart ovirt-engine.service

2. Configure the optimization settings at the cluster level:

a. Select a cluster.

b. Click Edit.

c. Click the Migration Policy tab.

d. From the Auto Converge migrations list, select Inherit from global
setting, Auto Converge, or Don't Auto Converge.

e. From the Enable migration compression list, select Inherit from global
setting, Compress, or Don't Compress.

3. Configure the optimization settings at the virtual machine level:

a. Select a virtual machine.

b. Click Edit.

c. Click the Host tab.

d. From the Auto Converge migrations list, select Inherit from cluster
setting, Auto Converge, or Don't Auto Converge.

e. From the Enable migration compression list, select Inherit from cluster
setting, Compress, or Don't Compress.

6.13.3. Guest Agent Hooks


Hooks are scripts that trigger activity within a virtual machine when key events occur:

Before migration

After migration

Before hibernation

After hibernation

The hooks configuration base directory is /etc/ovirt-guest-agent/hooks.d on Linux


systems and C:\Program Files\Redhat\RHEV\Drivers\Agent on Windows systems.

Each event has a corresponding subdirectory: before_migration and after_migration,


before_hibernation and after_hibernation. All files or symbolic links in that directory
will be executed.

101
Virtual Machine Management Guide

The executing user on Linux systems is ovirtagent. If the script needs root permissions,
the elevation must be executed by the creator of the hook script.

The executing user on Windows systems is the System Service user.

6.13.4. Automatic Virtual Machine Migration


Red Hat Virtualization Manager automatically initiates live migration of all virtual machines
running on a host when the host is moved into maintenance mode. The destination host for
each virtual machine is assessed as the virtual machine is migrated, in order to spread the
load across the cluster.

The Manager automatically initiates live migration of virtual machines in order to maintain
load balancing or power saving levels in line with scheduling policy. While no scheduling
policy is defined by default, it is recommended that you specify the scheduling policy which
best suits the needs of your environment. You can also disable automatic, or even manual,
live migration of specific virtual machines where required.

6.13.5. Preventing Automatic Migration of a Virtual Machine


Red Hat Virtualization Manager allows you to disable automatic migration of virtual
machines. You can also disable manual migration of virtual machines by setting the virtual
machine to run only on a specific host.

The ability to disable automatic migration and require a virtual machine to run on a
particular host is useful when using application high availability products, such as Red Hat
High Availability or Cluster Suite.

Procedure 6.32. Preventing Automatic Migration of Virtual Machine

1. Click the Virtual Machines tab and select a virtual machine.

2. Click Edit.

102
CHAPTER 6. ADMINISTRATIVE TASKS

Figure 6.11. The Edit Virtual Machine Window

3. Click the Host tab.

4. Use the Start Running On radio buttons to specify whether the virtual machine
should run on any host in the cluster, or a specific host or group of hosts.


WARNING

Explicitly assigning a virtual machine to one specific host and


disabling migration is mutually exclusive with Red Hat
Virtualization high availability. Virtual machines that are assigned
to one specific host can only be made highly available using third
party high availability products like Red Hat High Availability. This
restriction does not apply to virtual machines that are assigned to
multiple specific hosts.

IMPORTANT

If the virtual machine has host devices directly attached to it, and a
different host is specified, the host devices from the previous host will
be automatically removed from the virtual machine.

103
Virtual Machine Management Guide

5. Select Allow manual migration only or Do not allow migration from the
Migration Options drop-down list.

6. Optionally, select the Use custom migration downtime check box and specify a
value in milliseconds.

7. Click OK.

6.13.6. Manually Migrating Virtual Machines


A running virtual machine can be live migrated to any host within its designated host
cluster. Live migration of virtual machines does not cause any service interruption.
Migrating virtual machines to a different host is especially useful if the load on a particular
host is too high. For live migration prerequisites, see Section 6.13.1, “Live Migration
Prerequisites”.

NOTE

When you place a host into maintenance mode, the virtual machines running
on that host are automatically migrated to other hosts in the same cluster.
You do not need to manually migrate these virtual machines.

NOTE

Live migrating virtual machines between different clusters is generally not


recommended. The currently only supported use case is documented at
https://access.redhat.com/articles/1390733.

Procedure 6.33. Manually Migrating Virtual Machines

1. Click the Virtual Machines tab and select a running virtual machine.

2. Click Migrate.

3. Use the radio buttons to select whether to Select Host Automatically or to


Select Destination Host, specifying the host using the drop-down list.

NOTE

When the Select Host Automatically option is selected, the system


determines the host to which the virtual machine is migrated
according to the load balancing and power management rules set up in
the scheduling policy.

4. Click OK.

During migration, progress is shown in the Migration progress bar. Once migration is
complete the Host column will update to display the host the virtual machine has been
migrated to.

6.13.7. Setting Migration Priority


Red Hat Virtualization Manager queues concurrent requests for migration of virtual
machines off of a given host. The load balancing process runs every minute. Hosts already

104
CHAPTER 6. ADMINISTRATIVE TASKS

involved in a migration event are not included in the migration cycle until their migration
event has completed. When there is a migration request in the queue and available hosts
in the cluster to action it, a migration event is triggered in line with the load balancing
policy for the cluster.

You can influence the ordering of the migration queue by setting the priority of each virtual
machine; for example, setting mission critical virtual machines to migrate before others.
Migrations will be ordered by priority; virtual machines with the highest priority will be
migrated first.

Procedure 6.34. Setting Migration Priority

1. Click the Virtual Machines tab and select a virtual machine.

2. Click Edit.

3. Select the High Availability tab.

4. Select Low, Medium, or High from the Priority drop-down list.

5. Click OK.

6.13.8. Canceling Ongoing Virtual Machine Migrations


A virtual machine migration is taking longer than you expected. You'd like to be sure where
all virtual machines are running before you make any changes to your environment.

Procedure 6.35. Canceling Ongoing Virtual Machine Migrations

1. Select the migrating virtual machine. It is displayed in the Virtual Machines


resource tab with a status of Migrating from.

2. Click Cancel Migration.

The virtual machine status returns from Migrating from to Up.

6.13.9. Event and Log Notification upon Automatic Migration of


Highly Available Virtual Servers
When a virtual server is automatically migrated because of the high availability function,
the details of an automatic migration are documented in the Events tab and in the engine
log to aid in troubleshooting, as illustrated in the following examples:

Example 6.1. Notification in the Events Tab of the Web Admin Portal

Highly Available Virtual_Machine_Name failed. It will be restarted automatically.

Virtual_Machine_Name was restarted on Host Host_Name

Example 6.2. Notification in the Manager engine.log

This log can be found on the Red Hat Virtualization Manager at /var/log/ovirt-
engine/engine.log:

105
Virtual Machine Management Guide

Failed to start Highly Available VM. Attempting to restart. VM Name:


Virtual_Machine_Name, VM Id:Virtual_Machine_ID_Number

6.14. IMPROVING UPTIME WITH VIRTUAL MACHINE HIGH


AVAILABILITY

6.14.1. What is High Availability?


High availability means that a virtual machine will be automatically restarted if its process
is interrupted. This happens if the virtual machine is terminated by methods other than
powering off from within the guest or sending the shutdown command from the Manager.
When these events occur, the highly available virtual machine is automatically restarted,
either on its original host or another host in the cluster.

High availability is possible because the Red Hat Virtualization Manager constantly monitors
the hosts and storage, and automatically detects hardware failure. If host failure is
detected, any virtual machine configured to be highly available is automatically restarted
on another host in the cluster. With storage domains V4 or later, virtual machines have the
additional capability to acquire a lease on a special volume on the storage, enabling a
virtual machine to start on another host even if the original host loses power. The
functionality also prevents the virtual machine from being started on two different hosts,
which may lead to corruption of the virtual machine disks.

With high availability, interruption to service is minimal because virtual machines are
restarted within seconds with no user intervention required. High availability keeps your
resources balanced by restarting guests on a host with low current resource utilization, or
based on any workload balancing or power saving policies that you configure. This ensures
that there is sufficient capacity to restart virtual machines at all times.

6.14.2. Why Use High Availability?


High availability is recommended for virtual machines running critical workloads.

High availability can ensure that virtual machines are restarted in the following scenarios:

When a host becomes non-operational due to hardware failure.

When a host is put into maintenance mode for scheduled downtime.

When a host becomes unavailable because it has lost communication with an


external storage resource.

A high availability virtual machine is automatically restarted, either on its original host or
another host in the cluster.

6.14.3. High Availability Considerations


A highly available host requires a power management device and its fencing parameters
configured. In addition, for a virtual machine to be highly available when its host becomes
non-operational, it needs to be started on another available host in the cluster. To enable
the migration of highly available virtual machines:

106
CHAPTER 6. ADMINISTRATIVE TASKS

Power management must be configured for the hosts running the highly available
virtual machines.

The host running the highly available virtual machine must be part of a cluster
which has other available hosts.

The destination host must be running.

The source and destination host must have access to the data domain on which the
virtual machine resides.

The source and destination host must have access to the same virtual networks and
VLANs.

There must be enough CPUs on the destination host that are not in use to support
the virtual machine's requirements.

There must be enough RAM on the destination host that is not in use to support the
virtual machine's requirements.

6.14.4. Configuring a Highly Available Virtual Machine


High availability must be configured individually for each virtual machine.

Procedure 6.36. Configuring a Highly Available Virtual Machine

1. Click the Virtual Machines tab and select a virtual machine.

2. Click Edit.

3. Click the High Availability tab.

107
Virtual Machine Management Guide

Figure 6.12. The High Availability Tab

4. Select the Highly Available check box to enable high availability for the virtual
machine.

5. Select the storage domain to hold the virtual machine lease, or select No VM Lease
to disable the functionality, from the Target Storage Domain for VM Lease drop-
down list. See Section 6.14.1, “What is High Availability?” for more information
about virtual machine leases.

IMPORTANT

This functionality is only available on storage domains that are V4 or


later.

6. Select Low, Medium, or High from the Priority drop-down list. When migration is
triggered, a queue is created in which the high priority virtual machines are
migrated first. If a cluster is running low on resources, only the high priority virtual
machines are migrated.

7. Click OK.

6.15. OTHER VIRTUAL MACHINE TASKS

6.15.1. Enabling SAP Monitoring


Enable SAP monitoring on a virtual machine through the Administration Portal.

108
CHAPTER 6. ADMINISTRATIVE TASKS

Procedure 6.37. Enabling SAP Monitoring on Virtual Machines

1. Click the Virtual Machines tab and select a virtual machine.

2. Click Edit.

3. Click the Custom Properties tab.

Figure 6.13. Enable SAP

4. Select sap_agent from the drop-down list. Ensure the secondary drop-down menu is
set to True.

If previous properties have been set, select the plus sign to add a new property rule
and select sap_agent.

5. Click OK.

6.15.2. Configuring Red Hat Enterprise Linux 5.4 and later Virtual
Machines to use SPICE
SPICE is a remote display protocol designed for virtual environments, which enables you to
view a virtualized desktop or server. SPICE delivers a high quality user experience, keeps
CPU consumption low, and supports high quality video streaming.

Using SPICE on a Linux machine significantly improves the movement of the mouse cursor
on the console of the virtual machine. To use SPICE, the X-Windows system requires

109
Virtual Machine Management Guide

additional QXL drivers. The QXL drivers are provided with Red Hat Enterprise Linux 5.4 and
later. Earlier versions are not supported. Installing SPICE on a virtual machine running Red
Hat Enterprise Linux significantly improves the performance of the graphical user interface.

NOTE

Typically, this is most useful for virtual machines where the user requires the
use of the graphical user interface. System administrators who are creating
virtual servers may prefer not to configure SPICE if their use of the graphical
user interface is minimal.

6.15.2.1. Installing and Configuring QXL Drivers

You must manually install QXL drivers on virtual machines running Red Hat Enterprise Linux
5.4 or later. This is unnecessary for virtual machines running Red Hat Enterprise Linux 6 or
Red Hat Enterprise Linux 7 as the QXL drivers are installed by default.

Procedure 6.38. Installing QXL Drivers

1. Log in to a Red Hat Enterprise Linux virtual machine.

2. Install the QXL drivers:

# yum install xorg-x11-drv-qxl

You can configure QXL drivers using either a graphical interface or the command line.
Perform only one of the following procedures.

Procedure 6.39. Configuring QXL drivers in GNOME

1. Click System.

2. Click Administration.

3. Click Display.

4. Click the Hardware tab.

5. Click Video Cards Configure.

6. Select qxl and click OK.

7. Restart X-Windows by logging out of the virtual machine and logging back in.

Procedure 6.40. Configuring QXL drivers on the command line:

1. Back up /etc/X11/xorg.conf:

# cp /etc/X11/xorg.conf /etc/X11/xorg.conf.$$.backup

2. Make the following change to the Device section of /etc/X11/xorg.conf:

Section "Device"
Identifier "Videocard0"

110
CHAPTER 6. ADMINISTRATIVE TASKS

Driver "qxl"
Endsection

6.15.2.2. Configuring a Virtual Machine's Tablet and Mouse to use SPICE

Edit the /etc/X11/xorg.conf file to enable SPICE for your virtual machine's tablet devices.

Procedure 6.41. Configuring a Virtual Machine's Tablet and Mouse to use SPICE

1. Verify that the tablet device is available on your guest:

# /sbin/lsusb -v | grep 'QEMU USB Tablet'

If there is no output from the command, do not continue configuring the tablet.

2. Back up /etc/X11/xorg.conf:

# cp /etc/X11/xorg.conf /etc/X11/xorg.conf.$$.backup

3. Make the following changes to /etc/X11/xorg.conf:

Section "ServerLayout"
Identifier "single head configuration"
Screen 0 "Screen0" 0 0
InputDevice "Keyboard0" "CoreKeyboard"
InputDevice "Tablet" "SendCoreEvents"
InputDevice "Mouse" "CorePointer"
EndSection

Section "InputDevice"
Identifier "Mouse"
Driver "void"
#Option "Device" "/dev/input/mice"
#Option "Emulate3Buttons" "yes"
EndSection

Section "InputDevice"
Identifier "Tablet"
Driver "evdev"
Option "Device" "/dev/input/event2"
Option "CorePointer" "true"
EndSection

4. Log out and log back into the virtual machine to restart X-Windows.

6.15.3. KVM virtual machine timing management


Virtualization poses various challenges for virtual machine time keeping. Virtual machines
which use the Time Stamp Counter (TSC) as a clock source may suffer timing issues as
some CPUs do not have a constant Time Stamp Counter. Virtual machines running without
accurate timekeeping can have serious affects on some networked applications as your
virtual machine will run faster or slower than the actual time.

111
Virtual Machine Management Guide

KVM works around this issue by providing virtual machines with a paravirtualized clock. The
KVM pvclock provides a stable source of timing for KVM guests that support it.

Presently, only Red Hat Enterprise Linux 5.4 and later virtual machines fully support the
paravirtualized clock.

Virtual machines can have several problems caused by inaccurate clocks and counters:

Clocks can fall out of synchronization with the actual time which invalidates sessions
and affects networks.

Virtual machines with slower clocks may have issues migrating.

These problems exist on other virtualization platforms and timing should always be tested.

IMPORTANT

The Network Time Protocol (NTP) daemon should be running on the host and
the virtual machines. Enable the ntpd service and add it to the default startup
sequence:

For Red Hat Enterprise Linux 6

# service ntpd start


# chkconfig ntpd on

For Red Hat Enterprise Linux 7

# systemctl start ntpd.service


# systemctl enable ntpd.service

Using the ntpd service should minimize the affects of clock skew in all cases.

The NTP servers you are trying to use must be operational and accessible to
your hosts and virtual machines.

Determining if your CPU has the constant Time Stamp Counter


Your CPU has a constant Time Stamp Counter if the constant_tsc flag is present. To
determine if your CPU has the constant_tsc flag run the following command:

$ cat /proc/cpuinfo | grep constant_tsc

If any output is given your CPU has the constant_tsc bit. If no output is given follow the
instructions below.

Configuring hosts without a constant Time Stamp Counter


Systems without constant time stamp counters require additional configuration. Power
management features interfere with accurate time keeping and must be disabled for virtual
machines to accurately keep time with KVM.

IMPORTANT

These instructions are for AMD revision F CPUs only.

112
CHAPTER 6. ADMINISTRATIVE TASKS

If the CPU lacks the constant_tsc bit, disable all power management features
(BZ#513138). Each system has several timers it uses to keep time. The TSC is not stable
on the host, which is sometimes caused by cpufreq changes, deep C state, or migration to
a host with a faster TSC. Deep C sleep states can stop the TSC. To prevent the kernel using
deep C states append "processor.max_cstate=1" to the kernel boot options in the
grub.conf file on the host:

term Red Hat Enterprise Linux Server (2.6.18-159.el5)


root (hd0,0)
kernel /vmlinuz-2.6.18-159.el5 ro root=/dev/VolGroup00/LogVol00 rhgb
quiet processor.max_cstate=1

Disable cpufreq (only necessary on hosts without the constant_tsc) by editing the
/etc/sysconfig/cpuspeed configuration file and change the MIN_SPEED and MAX_SPEED
variables to the highest frequency available. Valid limits can be found in the
/sys/devices/system/cpu/cpu*/cpufreq/scaling_available_frequencies files.

Using the engine-config tool to receive alerts when hosts drift out of sync.
You can use the engine-config tool to configure alerts when your hosts drift out of sync.

There are 2 relevant parameters for time drift on hosts: EnableHostTimeDrift and
HostTimeDriftInSec. EnableHostTimeDrift, with a default value of false, can be enabled
to receive alert notifications of host time drift. The HostTimeDriftInSec parameter is used
to set the maximum allowable drift before alerts start being sent.

Alerts are sent once per hour per host.

Using the paravirtualized clock with Red Hat Enterprise Linux virtual machines
For certain Red Hat Enterprise Linux virtual machines, additional kernel parameters are
required. These parameters can be set by appending them to the end of the /kernel line in
the /boot/grub/grub.conf file of the virtual machine.

NOTE

The process of configuring kernel parameters can be automated using the


ktune package

The ktune package provides an interactive Bourne shell script,fix_clock_drift.sh. When


run as the superuser, this script inspects various system parameters to determine if the
virtual machine on which it is run is susceptible to clock drift under load. If so, it then
creates a new grub.conf.kvm file in the /boot/grub/ directory. This file contains a kernel
boot line with additional kernel parameters that allow the kernel to account for and prevent
significant clock drift on the KVM virtual machine. After running fix_clock_drift.sh as
the superuser, and once the script has created the grub.conf.kvm file, then the virtual
machine's current grub.conf file should be backed up manually by the system
administrator, the new grub.conf.kvm file should be manually inspected to ensure that it is
identical to grub.conf with the exception of the additional boot line parameters, the
grub.conf.kvm file should finally be renamedgrub.conf, and the virtual machine should
be rebooted.

The table below lists versions of Red Hat Enterprise Linux and the parameters required for
virtual machines on systems without a constant Time Stamp Counter.

113
Virtual Machine Management Guide

Red Hat Enterprise Linux Additional virtual machine kernel


parameters

5.4 AMD64/Intel 64 with the paravirtualized Additional parameters are not required
clock

5.4 AMD64/Intel 64 without the paravirtualized notsc lpj=n


clock

5.4 x86 with the paravirtualized clock Additional parameters are not required

5.4 x86 without the paravirtualized clock clocksource=acpi_pm lpj=n

5.3 AMD64/Intel 64 notsc

5.3 x86 clocksource=acpi_pm

4.8 AMD64/Intel 64 notsc

4.8 x86 clock=pmtmr

3.9 AMD64/Intel 64 Additional parameters are not required

3.9 x86 Additional parameters are not required

114
CHAPTER 7. TEMPLATES

CHAPTER 7. TEMPLATES
A template is a copy of a virtual machine that you can use to simplify the subsequent,
repeated creation of similar virtual machines. Templates capture the configuration of
software, configuration of hardware, and the software installed on the virtual machine on
which the template is based. The virtual machine on which a template is based is known as
the source virtual machine.

When you create a template based on a virtual machine, a read-only copy of the virtual
machine's disk is created. This read-only disk becomes the base disk image of the new
template, and of any virtual machines created based on the template. As such, the
template cannot be deleted while any virtual machines created based on the template exist
in the environment.

Virtual machines created based on a template use the same NIC type and driver as the
original virtual machine, but are assigned separate, unique MAC addresses.

You can create a virtual machine directly from the Templates tab, as well as from the
Virtual Machines tab. In the Templates tab, right-click the required template and select
New VM. For more information on selecting the settings and controls for the new virtual
machine see Section A.1.1, “Virtual Machine General Settings Explained”.

7.1. SEALING VIRTUAL MACHINES IN PREPARATION FOR


DEPLOYMENT AS TEMPLATES
This section describes procedures for sealing Linux and Windows virtual machines. Sealing
is the process of removing all system-specific details from a virtual machine before creating
a template based on that virtual machine. Sealing is necessary to prevent the same details
from appearing on multiple virtual machines created based on the same template. It is also
necessary to ensure the functionality of other features, such as predictable vNIC order.

7.1.1. Sealing a Linux Virtual Machine for Deployment as a Template


A Linux virtual machine is sealed during the template creation process, by selecting the
Seal Template check box in the New Template window. See Section 7.2, “Creating a
Template” for details.

7.1.2. Sealing a Windows Virtual Machine for Deployment as a


Template
A template created for Windows virtual machines must be generalized (sealed) before
being used to deploy virtual machines. This ensures that machine-specific settings are not
reproduced in the template.

Sysprep is used to seal Windows templates before use.Sysprep generates a complete


unattended installation answer file. Default values for several Windows operating systems
are available in the /usr/share/ovirt-engine/conf/sysprep/ directory. These files act as
templates for Sysprep. The fields in these files can be copied, pasted, and altered as
required. This definition will override any values entered into the Initial Run fields of the
Edit Virtual Machine window.

The Sysprep file can be edited to affect various aspects of the Windows virtual machines
created from the template that the Sysprep file is attached to. These include the
provisioning of Windows, setting up the required domain membership, configuring the
hostname, and setting the security policy.

115
Virtual Machine Management Guide

Replacement strings can be used to substitute values provided in the default files in the
/usr/share/ovirt-engine/conf/sysprep/ directory. For example, "<Domain><!
[CDATA[$JoinDomain$]]></Domain>" can be used to indicate the domain to join.

7.1.2.1. Prerequisites for Sealing a Windows Virtual Machine

IMPORTANT

Do not reboot the virtual machine while Sysprep is running.

Before starting Sysprep, verify that the following settings are configured:

The Windows virtual machine parameters have been correctly defined.

If not, click Edit the Virtual Machines tab and enter the required information
in the Operating System and Cluster fields.

The correct product key has been defined in an override file on the Manager.

The override file must be created under /etc/ovirt-engine/osinfo.conf.d/, have


a filename that puts it after /etc/ovirt-engine/osinfo.conf.d/00-
defaults.properties, and ends in .properties. For example, /etc/ovirt-
engine/osinfo.conf.d/10-productkeys.properties. The last file will have
precedence and override any other previous file.

If not, copy the default values for your Windows operating system from /etc/ovirt-
engine/osinfo.conf.d/00-defaults.properties into the override file, and input
your values in the productKey.value and sysprepPath.value fields.

Example 7.1. Windows 7 Default Configuration Values

# Windows7(11, OsType.Windows, false),false


os.windows_7.id.value = 11
os.windows_7.name.value = Windows 7
os.windows_7.derivedFrom.value = windows_xp
os.windows_7.sysprepPath.value =
${ENGINE_USR}/conf/sysprep/sysprep.w7
os.windows_7.productKey.value =
os.windows_7.devices.audio.value = ich6
os.windows_7.devices.diskInterfaces.value.3.3 = IDE, VirtIO_SCSI,
VirtIO
os.windows_7.devices.diskInterfaces.value.3.4 = IDE, VirtIO_SCSI,
VirtIO
os.windows_7.devices.diskInterfaces.value.3.5 = IDE, VirtIO_SCSI,
VirtIO
os.windows_7.isTimezoneTypeInteger.value = false

7.1.2.2. Sealing a Windows 7, Windows 2008, or Windows 2012 Template

Seal a Windows 7, Windows 2008, or Windows 2012 template before using the template to
deploy virtual machines.

116
CHAPTER 7. TEMPLATES

Procedure 7.1. Sealing a Windows 7, Windows 2008, or Windows 2012 Template

1. Launch Sysprep from C:\Windows\System32\sysprep\sysprep.exe.

2. Enter the following information into Sysprep:

Under System Cleanup Action, select Enter System Out-of-Box-Experience


(OOBE).

Select the Generalize check box if you need to change the computer's system
identification number (SID).

Under Shutdown Options, select Shutdown.

3. Click OK to complete the sealing process; the virtual machine shuts down
automatically upon completion.

The Windows 7, Windows 2008, or Windows 2012 template is sealed and ready for
deploying virtual machines.

7.2. CREATING A TEMPLATE


Create a template from an existing virtual machine to use as a blueprint for creating
additional virtual machines.

When creating a template, you can choose the format of the disk: RAW or QCOW2. QCOW2
always implies that a disk is thin provisioned. RAW on file storage implies thin provisioned,
while RAW on block storage implies preallocated virtual disks.

Procedure 7.2. Creating a Template

1. Click the Virtual Machines tab and select the source virtual machine.

2. Ensure the virtual machine is powered down and has a status of Down.

3. Click Make Template. For more details on all fields in theNew Template window, see
Section A.4, “Explanation of Settings in the New Template Window”.

4. Enter a Name, Description, and Comment for the template.

5. Select the cluster with which to associate the template from the Cluster drop-down
list. By default, this is the same as that of the source virtual machine.

6. Optionally, select a CPU profile for the template from the CPU Profile drop-down
list.

7. Optionally, select the Create as a Template Sub Version check box, select a Root
Template, and enter a Sub Version Name to create the new template as a sub
template of an existing template.

8. In the Disks Allocation section, enter an alias for the disk in theAlias text field.
Select the disk format in the Format drop-down, the storage domain on which to
store the disk from the Target drop-down, and the disk profile in theDisk Profile
drop-down. By default, these are the same as those of the source virtual machine.

9. Select the Allow all users to access this Template check box to make the
template public.

117
Virtual Machine Management Guide

10. Select the Copy VM permissions check box to copy the permissions of the source
virtual machine to the template.

11. Select the Seal Template check box (Linux only) to seal the template.

NOTE

Sealing, which uses the virt-sysprep command, removes system-


specific details from a virtual machine before creating a template
based on that virtual machine. This prevents the original virtual
machine's details from appearing in subsequent virtual machines that
are created using the same template. It also ensures the functionality
of other features, such as predictable vNIC order. See Appendix B,
virt-sysprep Operations for more information.

12. Click OK.

The virtual machine displays a status of Image Locked while the template is being created.
The process of creating a template may take up to an hour depending on the size of the
virtual disk and the capabilities of your storage hardware. When complete, the template is
added to the Templates tab. You can now create new virtual machines based on the
template.

NOTE

When a template is made, the virtual machine is copied so that both the
existing virtual machine and its template are usable after template creation.

7.3. EDITING A TEMPLATE


Once a template has been created, its properties can be edited. Because a template is a
copy of a virtual machine, the options available when editing a template are identical to
those in the Edit Virtual Machine window.

Procedure 7.3. Editing a Template

1. Click the Templates tab and select a template.

2. Click Edit.

3. Change the necessary properties. Click Show Advanced Options and edit the
template's settings as required. The settings that appear in the Edit Template
window are identical to those in the Edit Virtual Machine window, but with the
relevant fields only. See Section A.1, “Explanation of Settings in the New Virtual
Machine and Edit Virtual Machine Windows” for details.

4. Click OK.

7.4. DELETING A TEMPLATE


If you have used a template to create a virtual machine using the thin provisioning storage
allocation option, the template cannot be deleted as the virtual machine needs it to
continue running. However, cloned virtual machines do not depend on the template they
were cloned from and the template can be deleted.

118
CHAPTER 7. TEMPLATES

Procedure 7.4. Deleting a Template

1. Click the Templates tab and select a template.

2. Click Remove.

3. Click OK.

7.5. EXPORTING TEMPLATES

7.5.1. Migrating Templates to the Export Domain

NOTE

The export storage domain is deprecated. Storage data domains can be


unattached from a data center and imported to another data center in the
same environment, or in a different environment. Virtual machines, floating
virtual disks, and templates can then be uploaded from the imported storage
domain to the attached data center. See the Importing Existing Storage
Domains section in the Red Hat Virtualization Administration Guide for
information on importing storage domains.

Export templates into the export domain to move them to another data domain, either in
the same Red Hat Virtualization environment, or another one. This procedure requires
access to the Administration Portal.

Procedure 7.5. Exporting Individual Templates to the Export Domain

1. Click the Templates tab and select a template.

2. Click Export.

3. Select the Force Override check box to replace any earlier version of the template
on the export domain.

4. Click OK to begin exporting the template; this may take up to an hour, depending on
the virtual disk size and your storage hardware.

Repeat these steps until the export domain contains all the templates to migrate before
you start the import process.

Click the Storage tab, select the export domain, and click the Template Import tab in the
details pane to view all exported templates in the export domain.

7.5.2. Copying a Template's Virtual Hard Disk


If you are moving a virtual machine that was created from a template with the thin
provisioning storage allocation option selected, the template's disks must be copied to the
same storage domain as that of the virtual disk. This procedure requires access to the
Administration Portal.

Procedure 7.6. Copying a Virtual Hard Disk

1. Click the Disks tab and select the template disk(s) to copy.

119
Virtual Machine Management Guide

2. Click Copy.

3. Select the Target data domain from the drop-down list(s).

4. Click OK.

A copy of the template's virtual hard disk has been created, either on the same, or a
different, storage domain. If you were copying a template disk in preparation for moving a
virtual hard disk, you can now move the virtual hard disk.

7.6. IMPORTING TEMPLATES

7.6.1. Importing a Template into a Data Center

NOTE

The export storage domain is deprecated. Storage data domains can be


unattached from a data center and imported to another data center in the
same environment, or in a different environment. Virtual machines, floating
virtual disks, and templates can then be uploaded from the imported storage
domain to the attached data center. See the Importing Existing Storage
Domains section in the Red Hat Virtualization Administration Guide for
information on importing storage domains.

Import templates from a newly attached export domain. This procedure requires access to
the Administration Portal.

Procedure 7.7. Importing a Template into a Data Center

1. Click the Storage tab and select the newly attached export domain.

2. Click the Template Import tab in the details pane and select a template.

3. Click Import.

4. Select the templates to import.

5. Use the drop-down lists to select the Destination Cluster and Storage domain.
Alter the Suffix if applicable.

Alternatively, clear the Clone All Templates check box.

6. Click OK to import templates and open a notification window. ClickClose to close


the notification window.

The template is imported into the destination data center. This can take up to an hour,
depending on your storage hardware. You can view the import progress in the Events tab.

Once the importing process is complete, the templates will be visible in the Templates
resource tab. The templates can create new virtual machines, or run existing imported
virtual machines based on that template.

7.6.2. Importing a Virtual Disk from an OpenStack Image Service as


a Template

120
CHAPTER 7. TEMPLATES

Virtual disks managed by an OpenStack Image Service can be imported into the Red Hat
Virtualization Manager if that OpenStack Image Service has been added to the Manager as
an external provider. This procedure requires access to the Administration Portal.

1. Click the Storage tab and select the OpenStack Image Service domain.

2. Click the Images tab in the details pane and select the image to import.

3. Click Import.

NOTE

If you are importing an image from a Glance storage domain, you have
the option of specifying the template name.

4. Select the Data Center into which the virtual disk will be imported.

5. Select the storage domain in which the virtual disk will be stored from the Domain
Name drop-down list.

6. Optionally, select a Quota to apply to the virtual disk.

7. Select the Import as Template check box.

8. Select the Cluster in which the virtual disk will be made available as a template.

9. Click OK.

The image is imported as a template and is displayed in the Templates tab. You can now
create virtual machines based on the template.

7.7. TEMPLATES AND PERMISSIONS

7.7.1. Managing System Permissions for a Template


As the SuperUser, the system administrator manages all aspects of the Administration
Portal. More specific administrative roles can be assigned to other users. These restricted
administrator roles are useful for granting a user administrative privileges that limit them
to a specific resource. For example, a DataCenterAdmin role has administrator privileges
only for the assigned data center with the exception of the storage for that data center,
and a ClusterAdmin has administrator privileges only for the assigned cluster.

A template administrator is a system administration role for templates in a data center.


This role can be applied to specific virtual machines, to a data center, or to the whole
virtualized environment; this is useful to allow different users to manage certain virtual
resources.

The template administrator role permits the following actions:

Create, edit, export, and remove associated templates.

Import and export templates.

121
Virtual Machine Management Guide

NOTE

You can only assign roles and permissions to existing users.

7.7.2. Template Administrator Roles Explained


The table below describes the administrator roles and privileges applicable to template
administration.

Table 7.1. Red Hat Virtualization System Administrator Roles

Role Privileges Notes

TemplateAdmin Can perform all operations on Has privileges to create,


templates. delete and configure a
template's storage domain
and network details, and to
move templates between
domains.

NetworkAdmin Network Administrator Can configure and manage


networks attached to
templates.

7.7.3. Template User Roles Explained


The table below describes the user roles and privileges applicable to using and
administrating templates in the User Portal.

Table 7.2. Red Hat Virtualization Template User Roles

Role Privileges Notes

TemplateCreator Can create, edit, manage and The TemplateCreator role


remove virtual machine is not applied to a specific
templates within assigned template; apply this role to a
resources. user for the whole
environment with the
Configure window.
Alternatively apply this role
for specific data centers,
clusters, or storage domains.

TemplateOwner Can edit and delete the The TemplateOwner role is


template, assign and manage automatically assigned to the
user permissions for the user who creates a template.
template. Other users who do not have
TemplateOwner permissions
on a template cannot view or
use the template.

122
CHAPTER 7. TEMPLATES

Role Privileges Notes

UserTemplateBasedVm Can use the template to Cannot edit template


create virtual machines. properties.

VnicProfileUser Logical network and network If the Allow all users to


interface user for templates. use this Network option
was selected when a logical
network is created,
VnicProfileUser
permissions are assigned to
all users for the logical
network. Users can then
attach or detach template
network interfaces to or from
the logical network.

7.7.4. Assigning an Administrator or User Role to a Resource


Assign administrator or user roles to resources to allow users to access or manage that
resource.

Procedure 7.8. Assigning a Role to a Resource

1. Use the resource tabs, tree mode, or the search function to find and select the
resource in the results list.

2. Click the Permissions tab in the details pane to list the assigned users, the user's
role, and the inherited permissions for the selected resource.

3. Click Add.

4. Enter the name or user name of an existing user into the Search text box and click
Go. Select a user from the resulting list of possible matches.

5. Select a role from the Role to Assign: drop-down list.

6. Click OK.

You have assigned a role to a user; the user now has the inherited permissions of that role
enabled for that resource.

7.7.5. Removing an Administrator or User Role from a Resource


Remove an administrator or user role from a resource; the user loses the inherited
permissions associated with the role for that resource.

Procedure 7.9. Removing a Role from a Resource

1. Use the resource tabs, tree mode, or the search function to find and select the
resource in the results list.

2. Click the Permissions tab in the details pane to list the assigned users, the user's
role, and the inherited permissions for the selected resource.

123
Virtual Machine Management Guide

3. Select the user to remove from the resource.

4. Click Remove. The Remove Permission window opens to confirm permissions


removal.

5. Click OK.

You have removed the user's role, and the associated permissions, from the resource.

7.8. USING CLOUD-INIT TO AUTOMATE THE CONFIGURATION


OF VIRTUAL MACHINES
Cloud-Init is a tool for automating the initial setup of virtual machines such as configuring
the host name, network interfaces, and authorized keys. It can be used when provisioning
virtual machines that have been deployed based on a template to avoid conflicts on the
network.

To use this tool, the cloud-init package must first be installed on the virtual machine. Once
installed, the Cloud-Init service starts during the boot process to search for instructions on
what to configure. You can then use options in the Run Once window to provide these
instructions one time only, or options in the New Virtual Machine, Edit Virtual Machine
and Edit Template windows to provide these instructions every time the virtual machine
starts.

7.8.1. Cloud-Init Use Case Scenarios


Cloud-Init can be used to automate the configuration of virtual machines in a variety of
scenarios. Several common scenarios are as follows:

Virtual Machines Created Based on Templates

You can use the Cloud-Init options in the Initial Run section of the Run Once
window to initialize a virtual machine that was created based on a template. This
allows you to customize the virtual machine the first time that virtual machine is
started.

Virtual Machine Templates

You can use the Use Cloud-Init/Sysprep options in the Initial Run tab of the
New Template and Edit Template windows to specify options for customizing
virtual machines created based on that template.

Virtual Machine Pools

You can use the Use Cloud-Init/Sysprep options in the Initial Run tab of the
New Pool window to specify options for customizing virtual machines taken from
that virtual machine pool. This allows you to specify a set of standard settings that
will be applied every time a virtual machine is taken from that virtual machine pool.
You can inherit or override the options specified for the template on which the
virtual machine is based, or specify options for the virtual machine pool itself.

7.8.2. Installing Cloud-Init


This procedure describes how to install Cloud-Init on a virtual machine. Once Cloud-Init is

124
CHAPTER 7. TEMPLATES

installed, you can create a template based on this virtual machine. Virtual machines
created based on this template can leverage Cloud-Init functions, such as configuring the
host name, time zone, root password, authorized keys, network interfaces, DNS service, etc
on boot.

Procedure 7.10. Installing Cloud-Init

1. Log on to the virtual machine.

2. Enable the required repositories:

Red Hat Enterprise Linux 6:

# subscription-manager repos --enable=rhel-6-server-rpms


# subscription-manager repos --enable=rhel-6-server-rh-common-
rpms

Red Hat Enterprise Linux 7:

# subscription-manager repos --enable=rhel-7-server-rpms


# subscription-manager repos --enable=rhel-7-server-rh-common-
rpms

3. Install the cloud-init package and dependencies:

# yum install cloud-init

7.8.3. Using Cloud-Init to Prepare a Template


As long as the cloud-init package is installed on a Linux virtual machine, you can use the
virtual machine to make a cloud-init enabled template. Specify a set of standard settings to
be included in a template as described in the following procedure or, alternatively, skip the
Cloud-Init settings steps and configure them when creating a virtual machine based on this
template.

NOTE

While the following procedure outlines how to use Cloud-Init when preparing a
template, the same settings are also available in the New Virtual Machine,
Edit Template, and Run Once windows.

Procedure 7.11. Using Cloud-Init to Prepare a Template

1. Click the Virtual Machines tab and select a virtual machine.

2. Click Edit.

3. Click the Initial Run tab and select the Use Cloud-Init/Sysprep check box.

4. Enter a host name in the VM Hostname text field.

5. Select the Configure Time Zone check box and select a time zone from theTime
Zone drop-down list.

125
Virtual Machine Management Guide

6. Expand the Authentication section and select the Use already configured
password check box to use the existing credentials, or clear that check box and
enter a root password in the Password and Verify Password text fields to specify a
new root password.

7. Enter any SSH keys to be added to the authorized hosts file on the virtual machine
in the SSH Authorized Keys text area.

8. Select the Regenerate SSH Keys check box to regenerate SSH keys for the virtual
machine.

9. Expand the Networks section and enter any DNS servers in the DNS Servers text
field.

10. Enter any DNS search domains in the DNS Search Domains text field.

11. Select the Network check box and use the+ and - buttons to add or remove
network interfaces to or from the virtual machine.

IMPORTANT

You must specify the correct network interface name and number (for
example, eth0, eno3, enp0s). Otherwise, the virtual machine's interface
connection will be up, but it will not have the cloud-init network
configuration.

12. Expand the Custom Script section and enter any custom scripts in theCustom
Script text area.

13. Click Ok.

14. Click Make Template and enter the fields as necessary.

15. Click Ok.

You can now provision new virtual machines using this template.

7.8.4. Using Cloud-Init to Initialize a Virtual Machine


Use Cloud-Init to automate the initial configuration of a Linux virtual machine. You can use
the Cloud-Init fields to configure a virtual machine's host name, time zone, root password,
authorized keys, network interfaces, and DNS service. You can also specify a custom script,
a script in YAML format, to run on boot. The custom script allows for additional Cloud-Init
configuration that is supported by Cloud-Init but not available in the Cloud-Init fields. For
more information on custom script examples, see Cloud config examples.

Procedure 7.12. Using Cloud-Init to Initialize a Virtual Machine

This procedure starts a virtual machine with a set of Cloud-Init settings. If the relevant
settings are included in the template the virtual machine is based on, review the settings,
make changes where appropriate, and click OK to start the virtual machine.

1. Click the Virtual Machines tab and select a virtual machine.

2. Click Run Once.

126
CHAPTER 7. TEMPLATES

3. Expand the Initial Run section and select the Cloud-Init check box.

4. Enter a host name in the VM Hostname text field.

5. Select the Configure Time Zone check box and select a time zone from theTime
Zone drop-down menu.

6. Select the Use already configured password check box to use the existing
credentials, or clear that check box and enter a root password in the Password and
Verify Password text fields to specify a new root password.

7. Enter any SSH keys to be added to the authorized hosts file on the virtual machine
in the SSH Authorized Keys text area.

8. Select the Regenerate SSH Keys check box to regenerate SSH keys for the virtual
machine.

9. Enter any DNS servers in the DNS Servers text field.

10. Enter any DNS search domains in the DNS Search Domains text field.

11. Select the Network check box and use the+ and - buttons to add or remove
network interfaces to or from the virtual machine.

IMPORTANT

You must specify the correct network interface name and number (for
example, eth0, eno3, enp0s). Otherwise, the virtual machine's interface
connection will be up, but it will not have the cloud-init network
configuration.

12. Enter a custom script in the Custom Script text area. Make sure the values
specified in the script are appropriate. Otherwise, the action will fail.

13. Click OK.

NOTE

To check if a virtual machine has Cloud-Init installed, select a virtual machine


and click the Applications sub-tab. Only shown if the guest agent is installed.

7.9. USING SYSPREP TO AUTOMATE THE CONFIGURATION


OF VIRTUAL MACHINES
Sysprep is a tool used to automate the setup of Windows virtual machines; for example,
configuring host names, network interfaces, authorized keys, set up users, or to connect to
Active Directory. Sysprep is installed with every version of Windows.

Red Hat Virtualization enhances Sysprep by exploiting virtualization technology to deploy


virtual workstations based on a single template. Red Hat Virtualization builds a tailored
auto-answer file for each virtual workstation.

Sysprep generates a complete unattended installation answer file. Default values for
several Windows operating systems are available in the /usr/share/ovirt-
engine/conf/sysprep/ directory. You can also create a customSysprep file and reference

127
Virtual Machine Management Guide

it from the the osinfo file in the /etc/ovirt-engine/osinfo.conf.d/ directory. These


files act as templates for Sysprep. The fields in these files can be copied and edited as
required. This definition will override any values entered into the Initial Run fields of the
Edit Virtual Machine window.

The override file must be created under /etc/ovirt-engine/osinfo.conf.d/, have a


filename that puts it after /etc/ovirt-engine/osinfo.conf.d/00-defaults.properties,
and ends in .properties. For example, /etc/ovirt-engine/osinfo.conf.d/10-
productkeys.properties. The last file will have precedence and override any other
previous file.

Copy the default values for your Windows operating system from /etc/ovirt-
engine/osinfo.conf.d/00-defaults.properties into the override file, and input your
values in the productKey.value and sysprepPath.value fields.

Example 7.2. Windows 7 Default Configuration Values

# Windows7(11, OsType.Windows, false),false


os.windows_7.id.value = 11
os.windows_7.name.value = Windows 7
os.windows_7.derivedFrom.value = windows_xp
os.windows_7.sysprepPath.value = ${ENGINE_USR}/conf/sysprep/sysprep.w7
os.windows_7.productKey.value =
os.windows_7.devices.audio.value = ich6
os.windows_7.devices.diskInterfaces.value.3.3 = IDE, VirtIO_SCSI, VirtIO
os.windows_7.devices.diskInterfaces.value.3.4 = IDE, VirtIO_SCSI, VirtIO
os.windows_7.devices.diskInterfaces.value.3.5 = IDE, VirtIO_SCSI, VirtIO
os.windows_7.isTimezoneTypeInteger.value = false

7.9.1. Configuring Sysprep on a Template


You can use this procedure to specify a set of standard Sysprep settings to include in the
template, alternatively you can configure the Sysprep settings when creating a virtual
machine based on this template.

Replacement strings can be used to substitute values provided in the default files in the
/usr/share/ovirt-engine/conf/sysprep/ directory. For example, "<Domain><!
[CDATA[$JoinDomain$]]></Domain>" can be used to indicate the domain to join.

IMPORTANT

Do not reboot the virtual machine while Sysprep is running.

Prerequisites

The Windows virtual machine parameters have been correctly defined.

If not, click Edit the Virtual Machines tab and enter the required information
in the Operating System and Cluster fields.

The correct product key has been defined in an override file on the Manager.

Procedure 7.13. Using Sysprep to Prepare a Template

128
CHAPTER 7. TEMPLATES

1. Build the Windows virtual machine with the required patches and layered software.

2. Seal the Windows virtual machine. See Section 7.1, “Sealing Virtual Machines in
Preparation for Deployment as Templates”

3. Create a template based on the Windows virtual machine. See Section 7.2,
“Creating a Template”

4. Update the Sysprep file with a text editor if additional changes are required.

You can now provision new virtual machines using this template.

7.9.2. Using Sysprep to Initialize a Virtual Machine


Use Sysprep to automate the initial configuration of a Windows virtual machine. You can
use the Sysprep fields to configure a virtual machine's host name, time zone, root
password, authorized keys, network interfaces, and DNS service.

Procedure 7.14. Using Sysprep to Initialize a Virtual Machine

This procedure starts a virtual machine with a set of Sysprep settings. If the relevant
settings are included in the template the virtual machine is based on, review the settings
and make changes where required.

1. Create a new Windows virtual machine based on a template of the required


Windows virtual machine. See Section 7.10, “Creating a Virtual Machine Based on a
Template”

2. Click the Virtual Machines tab and select the virtual machine.

3. Click Run Once.

4. Expand the Boot Options section, select the Attach Floppy check box, and select
the [sysprep] option.

5. Select the Attach CD check box and select the required Windows ISO from the
drop-down list.

6. Move the CD-ROM to the top of the Boot Sequence field.

7. Configure any further Run Once options as required. See Section A.5, “Explanation of
Settings in the Run Once Window” for more details.

8. Click OK.

7.10. CREATING A VIRTUAL MACHINE BASED ON A


TEMPLATE
Create a virtual machine from a template to enable the virtual machines to be pre-
configured with an operating system, network interfaces, applications and other resources.

129
Virtual Machine Management Guide

NOTE

Virtual machines created from a template depend on that template. This


means that you cannot remove a template from the Manager if a virtual
machine was created from that template. However, you can clone a virtual
machine from a template to remove the dependency on that template. See
Section 7.11, “Creating a Cloned Virtual Machine Based on a Template” for
more information.

When creating a virtual machine from a template, you can choose the format of the disk:
either RAW or QCOW2. If the Storage Allocation is Thin, the format of the disk will be
marked as QCOW2 and you will not be able to change it. If the Storage Allocation is
Clone, you can select either QCOW2 or RAW.

Procedure 7.15. Creating a Virtual Machine Based on a Template

1. Click the Virtual Machines tab.

2. Click New VM.

3. Select the Cluster on which the virtual machine will run.

4. Select a template from the Based on Template list.

5. Enter a Name, Description, and any Comments, and accept the default values
inherited from the template in the rest of the fields. You can change them if needed.

6. Click the Resource Allocation tab.

7. Select the Thin radio button in the Storage Allocation area.

8. Use the Target drop-down list to select the storage domain on which the virtual
machine's virtual disk will be stored.

9. Click OK.

The virtual machine is displayed in the Virtual Machines tab.

7.11. CREATING A CLONED VIRTUAL MACHINE BASED ON A


TEMPLATE
Cloned virtual machines are based on templates and inherit the settings of the template. A
cloned virtual machine does not depend on the template on which it was based after it has
been created. This means the template can be deleted if no other dependencies exist.

NOTE

If you clone a virtual machine from a template, the name of the template on
which that virtual machine was based is displayed in the General tab of the
Edit Virtual Machine window for that virtual machine. If you change the
name of that template, the name of the template in the General tab will also
be updated. However, if you delete the template from the Manager, the
original name of that template will be displayed instead.

130
CHAPTER 7. TEMPLATES

When creating a virtual machine from a template, you can choose the format of the disk:
either RAW or QCOW2. If the Storage Allocation is Thin, the format of the disk will be
marked as QCOW2 and you will not be able to change it. If the Storage Allocation is
Clone, you can select either QCOW2 or RAW.

Procedure 7.16. Cloning a Virtual Machine Based on a Template

1. Click the Virtual Machines tab.

2. Click New VM.

3. Select the Cluster on which the virtual machine will run.

4. Select a template from the Based on Template drop-down menu.

5. Enter a Name, Description and any Comments. You can accept the default values
inherited from the template in the rest of the fields, or change them if required.

6. Click the Resource Allocation tab.

7. Select the Clone radio button in the Storage Allocation area.

8. Select the disk format from the Format drop-down list. This affects the speed of the
clone operation and the amount of disk space the new virtual machine initially
requires.

Selecting QCOW2 results in a faster clone operation and provides optimized usage
of storage capacity. Disk space is allocated only as it is required. This is the
default selection.

Selecting Raw results in a slower clone operation and provides optimized virtual
machine read and write operations. All disk space requested in the template is
allocated at the time of the clone operation.

9. Use the Target drop-down menu to select the storage domain on which the virtual
machine's virtual disk will be stored.

10. Click OK.

NOTE

Cloning a virtual machine may take some time. A new copy of the template's
disk must be created. During this time, the virtual machine's status is first
Image Locked, then Down.

The virtual machine is created and displayed in the Virtual Machines tab. You can now
assign users to it, and can begin using it when the clone operation is complete.

131
Virtual Machine Management Guide

APPENDIX A. REFERENCE: SETTINGS IN


ADMINISTRATION PORTAL AND USER PORTAL
WINDOWS

A.1. EXPLANATION OF SETTINGS IN THE NEW VIRTUAL


MACHINE AND EDIT VIRTUAL MACHINE WINDOWS

A.1.1. Virtual Machine General Settings Explained


The following table details the options available on the General tab of the New Virtual
Machine and Edit Virtual Machine windows.

Table A.1. Virtual Machine: General Settings

Field Name Description

Cluster The name of the host cluster to which the


virtual machine is attached. Virtual machines
are hosted on any physical machine in that
cluster in accordance with policy rules.

Template The template on which the virtual machine is


based. This field is set to Blank by default,
which allows you to create a virtual machine
on which an operating system has not yet
been installed. Templates are displayed as
Name | Sub-version name (Sub-version
number). Each new version is displayed with a
number in brackets that indicates the relative
order of the version, with a higher number
indicating a more recent version.

The version name is displayed as base


version if it is the root template of the
template version chain.

When the virtual machine is stateless, there is


an option to select the latest version of the
template. This option means that anytime a
new version of this template is created, the
virtual machine is automatically recreated on
restart based on the latest template.

Operating System The operating system. Valid values include a


range of Red Hat Enterprise Linux and
Windows variants.

132
APPENDIX A. REFERENCE: SETTINGS IN ADMINISTRATION PORTAL AND USER PORTAL WINDOWS

Field Name Description

Instance Type The instance type on which the virtual


machine's hardware configuration can be
based. This field is set to Custom by default,
which means the virtual machine is not
connected to an instance type. The other
options available from this drop down menu
are Large, Medium , Small, Tiny, XLarge ,
and any custom instance types that the
Administrator has created.

Other settings that have a chain link icon next


to them are pre-filled by the selected instance
type. If one of these values is changed, the
virtual machine will be detached from the
instance type and the chain icon will appear
broken. However, if the changed setting is
restored to its original value, the virtual
machine will be reattached to the instance
type and the links in the chain icon will rejoin.

Optimized for The type of system for which the virtual


machine is to be optimized. There are two
options: Server , and Desktop; by default, the
field is set to Server . Virtual machines
optimized to act as servers have no sound
card, use a cloned disk image, and are not
stateless. In contrast, virtual machines
optimized to act as desktop machines do have
a sound card, use an image (thin allocation),
and are stateless.

Name The name of the virtual machine. The name


must be a unique name within the data center
and must not contain any spaces, and must
contain at least one character from A-Z or 0-9.
The maximum length of a virtual machine
name is 255 characters. The name can be re-
used in different data centers in the
environment.

VM ID The virtual machine ID. The virtual machine's


creator can set a custom ID for that virtual
machine. If no ID is specified during creation a
UUID will be automatically assigned. For both
custom and automatically-generated IDs,
changes are not possible after virtual machine
creation.

Description A meaningful description of the new virtual


machine.

Comment A field for adding plain text human-readable


comments regarding the virtual machine.

Affinity Labels Add or remove a selected Affinity Label .

133
Virtual Machine Management Guide

Field Name Description

Stateless Select this check box to run the virtual


machine in stateless mode. This mode is used
primarily for desktop virtual machines.
Running a stateless desktop or server creates
a new COW layer on the virtual machine hard
disk image where new and changed data is
stored. Shutting down the stateless virtual
machine deletes the new COW layer which
includes all data and configuration changes,
and returns the virtual machine to its original
state. Stateless virtual machines are useful
when creating machines that need to be used
for a short time, or by temporary staff.

Start in Pause Mode Select this check box to always start the virtual
machine in pause mode. This option is suitable
for virtual machines which require a long time
to establish a SPICE connection; for example,
virtual machines in remote locations.

Delete Protection Select this check box to make it impossible to


delete the virtual machine. It is only possible to
delete the virtual machine if this check box is
not selected.

Instance Images Click Attach to attach a floating disk to the


virtual machine, or click Create to add a new
virtual disk. Use the plus and minus buttons to
add or remove additional virtual disks.

Click Edit to reopen the Attach Virtual


Disks or New Virtual Disk window. This
button appears after a virtual disk has been
attached or created.

Instantiate VM network interfaces Add a network interface to the virtual machine


by picking a vNIC profile. by selecting a vNIC profile from the nic1 drop-
down list. Use the plus and minus buttons to
add or remove additional network interfaces.

A.1.2. Virtual Machine System Settings Explained


The following table details the options available on the System tab of the New Virtual
Machine and Edit Virtual Machine windows.

Table A.2. Virtual Machine: System Settings

Field Name Description

134
APPENDIX A. REFERENCE: SETTINGS IN ADMINISTRATION PORTAL AND USER PORTAL WINDOWS

Field Name Description

Memory Size The amount of memory assigned to the virtual


machine. When allocating memory, consider
the processing and storage needs of the
applications that are intended to run on the
virtual machine.

Maximum Memory The maximum amount of memory that can be


assigned to the virtual machine. Maximum
guest memory is also constrained by the
selected guest architecture and the cluster
compatibility level.

Total Virtual CPUs The processing power allocated to the virtual


machine as CPU Cores. Do not assign more
cores to a virtual machine than are present on
the physical host.

Virtual Sockets The number of CPU sockets for the virtual


machine. Do not assign more sockets to a
virtual machine than are present on the
physical host.

Cores per Virtual Socket The number of cores assigned to each virtual
socket.

Threads per Core The number of threads assigned to each core.


Increasing the value enables simultaneous
multi-threading (SMT). IBM POWER8 supports
up to 8 threads per core. For x86 (Intel and
AMD) CPU types, the recommended value is 1.

Custom Emulated Machine This option allows you to specify the machine
type. If changed, the virtual machine will only
run on hosts that support this machine type.
Defaults to the cluster's default machine type.

Custom CPU Type This option allows you to specify a CPU type. If
changed, the virtual machine will only run on
hosts that support this CPU type. Defaults to
the cluster's default CPU type.

135
Virtual Machine Management Guide

Field Name Description

Custom Compatibility Version The compatibility version determines which


features are supported by the cluster, as well
as, the values of some properties and the
emulated machine type. By default, the virtual
machine is configured to run in the same
compatibility mode as the cluster as the
default is inherited from the cluster. In some
situations the default compatibility mode
needs to be changed. An example of this is if
the cluster has been updated to a later
compatibility version but the virtual machines
have not been restarted. These virtual
machines can be set to use a custom
compatibility mode that is older than that of
the cluster. See Changing the Cluster
Compatibility Version in the Administration
Guide for more information.

Hardware Clock Time Offset This option sets the time zone offset of the
guest hardware clock. For Windows, this
should correspond to the time zone set in the
guest. Most default Linux installations expect
the hardware clock to be GMT+00:00.

Provide custom serial number policy This check box allows you to specify a serial
number for the virtual machine. Select either:

Host ID: Sets the host's UUID as the


virtual machine's serial number.

Vm ID: Sets the virtual machine's


UUID as its serial number.

Custom serial number: Allows you


to specify a custom serial number.

A.1.3. Virtual Machine Initial Run Settings Explained


The following table details the options available on the Initial Run tab of the New
Virtual Machine and Edit Virtual Machine windows. The settings in this table are only
visible if the Use Cloud-Init/Sysprep check box is selected, and certain options are only
visible when either a Linux-based or Windows-based option has been selected in the
Operating System list in the General tab, as outlined below.

Table A.3. Virtual Machine: Initial Run Settings

Field Name Operating Description


System

Use Cloud- Linux, Windows This check box toggles whether Cloud-Init or
Init/Sysprep Sysprep will be used to initialize the virtual
machine.

136
APPENDIX A. REFERENCE: SETTINGS IN ADMINISTRATION PORTAL AND USER PORTAL WINDOWS

Field Name Operating Description


System

VM Hostname Linux, Windows The host name of the virtual machine.

Domain Windows The Active Directory domain to which the


virtual machine belongs.

Organization Name Windows The name of the organization to which the


virtual machine belongs. This option
corresponds to the text field for setting the
organization name displayed when a machine
running Windows is started for the first time.

Active Directory OU Windows The organizational unit in the Active Directory


domain to which the virtual machine belongs.

Configure Time Zone Linux, Windows The time zone for the virtual machine. Select
this check box and select a time zone from the
Time Zone list.

Admin Password Windows The administrative user password for the


virtual machine. Click the disclosure arrow to
display the settings for this option.

Use already configured


password: This check box is
automatically selected after you
specify an initial administrative user
password. You must clear this check
box to enable the Admin Password
and Verify Admin Password fields
and specify a new password.

Admin Password : The administrative


user password for the virtual machine.
Enter the password in this text field
and the Verify Admin Password
text field to verify the password.

137
Virtual Machine Management Guide

Field Name Operating Description


System

Authentication Linux The authentication details for the virtual


machine. Click the disclosure arrow to display
the settings for this option.

Use already configured


password: This check box is
automatically selected after you
specify an initial root password. You
must clear this check box to enable
the Password and Verify Password
fields and specify a new password.

Password: The root password for the


virtual machine. Enter the password in
this text field and the Verify
Password text field to verify the
password.

SSH Authorized Keys : SSH keys to


be added to the authorized keys file of
the virtual machine. You can specify
multiple SSH keys by entering each
SSH key on a new line.

Regenerate SSH Keys : Regenerates


SSH keys for the virtual machine.

Custom Locale Windows Custom locale options for the virtual machine.
Locales must be in a format such as en-US.
Click the disclosure arrow to display the
settings for this option.

Input Locale: The locale for user


input.

UI Language : The language used for


user interface elements such as
buttons and menus.

System Locale: The locale for the


overall system.

User Locale : The locale for users.

138
APPENDIX A. REFERENCE: SETTINGS IN ADMINISTRATION PORTAL AND USER PORTAL WINDOWS

Field Name Operating Description


System

Networks Linux Network-related settings for the virtual


machine. Click the disclosure arrow to display
the settings for this option.

DNS Servers : The DNS servers to be


used by the virtual machine.

DNS Search Domains: The DNS


search domains to be used by the
virtual machine.

Network: Configures network


interfaces for the virtual machine.
Select this check box and click + or -
to add or remove network interfaces to
or from the virtual machine. When you
click + , a set of fields becomes visible
that can specify whether to use DHCP,
and configure an IP address, netmask,
and gateway, and specify whether the
network interface will start on boot.

Custom Script Linux Custom scripts that will be run on the virtual
machine when it starts. The scripts entered in
this field are custom YAML sections that are
added to those produced by the Manager, and
allow you to automate tasks such as creating
users and files, configuring yum repositories
and running commands. For more information
on the format of scripts that can be entered in
this field, see the Custom Script
documentation.

Sysprep Windows A custom Sysprep definition. The definition


must be in the format of a complete
unattended installation answer file. You can
copy and paste the default answer files in the
/usr/share/ovirt-
engine/conf/sysprep/ directory on the
machine on which the Red Hat Virtualization
Manager is installed and alter the fields as
required. See Chapter 7, Templates for more
information.

A.1.4. Virtual Machine Console Settings Explained


The following table details the options available on the Console tab of the New Virtual
Machine and Edit Virtual Machine windows.

Table A.4. Virtual Machine: Console Settings

139
Virtual Machine Management Guide

Field Name Description

Graphical Console Section

Headless Mode Select this check box if you do not a require a


graphical console for the virtual machine.

When selected, all other fields in the


Graphical Console section are disabled.
The Console Options in the Basic tab are
also disabled.

IMPORTANT

See Section 4.8, “Configuring


Headless Virtual Machines” for
more details and prerequisites
for using headless mode.

Video Type Defines the graphics device. QXL is the default


and supports both graphic protocols. VGA and
CIRRUS support only the VNC protocol.

Graphics protocol Defines which display protocol to use. SPICE is


the default protocol. VNC is an alternative
option. To allow both protocols select SPICE +
VNC.

VNC Keyboard Layout Defines the keyboard layout for the virtual
machine. This option is only available when
using the VNC protocol.

USB Support Defines SPICE USB redirection. This option is


only available for virtual machines using the
SPICE protocol. Select either:

Disabled - Creates a new USB


controller for the virtual machine. The
new USB controller is configured for
the guest operating system and cluster
version. It is defined in the osinfo-
defaults.properties configuration
file.

Enabled - Enables native KVM/SPICE


USB redirection for Linux and Windows
virtual machines. Virtual machines do
not require any in-guest agents or
drivers for native USB.

140
APPENDIX A. REFERENCE: SETTINGS IN ADMINISTRATION PORTAL AND USER PORTAL WINDOWS

Field Name Description

Console Disconnect Action Defines what happens when the console is


disconnected. This is only relevant with SPICE
and VNC console connections. This setting can
be changed while the virtual machine is
running but will not take effect until a new
console connection is established. Select
either:

No action - No action is taken.

Lock screen - This is the default


option. For all Linux machines and for
Windows desktops this locks the
currently active user session. For
Windows servers, this locks the
desktop and the currently active user.

Logout user - For all Linux machines


and Windows desktops, this logs out
the currently active user session. For
Windows servers, the desktop and the
currently active user are logged out.

Shutdown virtual machine -


Initiates a graceful virtual machine
shutdown.

Reboot virtual machine - Initiates


a graceful virtual machine reboot.

Monitors The number of monitors for the virtual


machine. This option is only available for
virtual desktops using the SPICE display
protocol. You can choose 1 , 2 or 4 . Note that
multiple monitors are not supported for
Windows 8 and Windows Server 2012 virtual
machines.

Smartcard Enabled Smart cards are an external hardware security


feature, most commonly seen in credit cards,
but also used by many businesses as
authentication tokens. Smart cards can be
used to protect Red Hat Virtualization virtual
machines. Tick or untick the check box to
activate and deactivate Smart card
authentication for individual virtual machines.

141
Virtual Machine Management Guide

Field Name Description

Single Sign On method Enabling Single Sign On allows users to sign


into the guest operating system when
connecting to a virtual machine from the User
Portal using the Guest Agent.

Disable Single Sign On - Select


this option if you do not want the
Guest Agent to attempt to sign into the
virtual machine.

Use Guest Agent - Enables Single


Sign On to allow the Guest Agent to
sign you into the virtual machine.

Disable strict user checking Click the Advanced Parameters arrow and
select the check box to use this option. With
this option selected, the virtual machine does
not need to be rebooted when a different user
connects to it.

By default, strict checking is enabled so that


only one user can connect to the console of a
virtual machine. No other user is able to open
a console to the same virtual machine until it
has been rebooted. The exception is that a
SuperUser can connect at any time and
replace a existing connection. When a
SuperUser has connected, no normal user
can connect again until the virtual machine is
rebooted.

Disable strict checking with caution, because


you can expose the previous user's session to
the new user.

Soundcard Enabled A sound card device is not necessary for all


virtual machine use cases. If it is for yours,
enable a sound card here.

Enable SPICE file transfer Defines whether a user is able to drag and
drop files from an external host into the virtual
machine's SPICE console. This option is only
available for virtual machines using the SPICE
protocol. This check box is selected by default.

Enable SPICE clipboard copy and Defines whether a user is able to copy and
paste paste content from an external host into the
virtual machine's SPICE console. This option is
only available for virtual machines using the
SPICE protocol. This check box is selected by
default.

Serial Console Section

142
APPENDIX A. REFERENCE: SETTINGS IN ADMINISTRATION PORTAL AND USER PORTAL WINDOWS

Field Name Description

Enable VirtIO serial console The VirtIO serial console is emulated through
VirtIO channels, using SSH and key pairs, and
allows you to access a virtual machine's serial
console directly from a client machine's
command line, instead of opening a console
from the Administration Portal or the User
Portal. The serial console requires direct
access to the Manager, since the Manager acts
as a proxy for the connection, provides
information about virtual machine placement,
and stores the authentication keys. Select the
check box to enable the VirtIO console on the
virtual machine.

A.1.5. Virtual Machine Host Settings Explained


The following table details the options available on the Host tab of the New Virtual
Machine and Edit Virtual Machine windows.

Table A.5. Virtual Machine: Host Settings

Field Name Sub-element Description

Start Running On Defines the preferred host on


which the virtual machine is
to run. Select either:

Any Host in
Cluster - The virtual
machine can start and
run on any available
host in the cluster.

Specific Host(s) -
The virtual machine
will start running on a
particular host in the
cluster. However, the
Manager or an
administrator can
migrate the virtual
machine to a different
host in the cluster
depending on the
migration and high-
availability settings of
the virtual machine.
Select the specific
host or group of hosts
from the list of
available hosts.

143
Virtual Machine Management Guide

Field Name Sub-element Description

Migration Options Migration mode Defines options to run and


migrate the virtual machine. If
the options here are not used,
the virtual machine will run or
migrate according to its
cluster's policy.

Allow manual and


automatic
migration - The
virtual machine can
be automatically
migrated from one
host to another in
accordance with the
status of the
environment, or
manually by an
administrator.

Allow manual
migration only -
The virtual machine
can only be migrated
from one host to
another manually by
an administrator.

Do not allow
migration - The
virtual machine
cannot be migrated,
either automatically or
manually.

144
APPENDIX A. REFERENCE: SETTINGS IN ADMINISTRATION PORTAL AND USER PORTAL WINDOWS

Field Name Sub-element Description

Use custom migration Defines the migration


policy convergence policy. If the
check box is left unselected,
the host determines the
policy.

Legacy - Legacy
behavior of 3.6
version. Overrides in
vdsm.conf are still
applied. The guest
agent hook
mechanism is
disabled.

Minimal downtime -
Allows the virtual
machine to migrate in
typical situations.
Virtual machines
should not experience
any significant
downtime. The
migration will be
aborted if virtual
machine migration
does not converge
after a long time
(dependent on QEMU
iterations, with a
maximum of 500
milliseconds). The
guest agent hook
mechanism is
enabled.

Suspend workload
if needed - Allows
the virtual machine to
migrate in most
situations, including
when the virtual
machine is running a
heavy workload.
Virtual machines may
experience a more
significant downtime.
The migration may
still be aborted for
extreme workloads.
The guest agent hook
mechanism is
enabled.

145
Virtual Machine Management Guide

Field Name Sub-element Description

Use custom migration This check box allows you to


downtime specify the maximum number
of milliseconds the virtual
machine can be down during
live migration. Configure
different maximum
downtimes for each virtual
machine according to its
workload and SLA
requirements. Enter 0 to use
the VDSM default value.

146
APPENDIX A. REFERENCE: SETTINGS IN ADMINISTRATION PORTAL AND USER PORTAL WINDOWS

Field Name Sub-element Description

Auto Converge Only activated with the


migrations Legacy migration policy.
Allows you to set whether
auto-convergence is used
during live migration of the
virtual machine. Large virtual
machines with high workloads
can dirty memory more
quickly than the transfer rate
achieved during live
migration, and prevent the
migration from converging.
Auto-convergence capabilities
in QEMU allow you to force
convergence of virtual
machine migrations. QEMU
automatically detects a lack of
convergence and triggers a
throttle-down of the vCPUs on
the virtual machine. Auto-
convergence is disabled
globally by default.

Select Inherit from


cluster setting to
use the auto-
convergence setting
that is set at the
cluster level. This
option is selected by
default.

Select Auto
Converge to override
the cluster setting or
global setting and
allow auto-
convergence for the
virtual machine.

Select Don't Auto


Converge to override
the cluster setting or
global setting and
prevent auto-
convergence for the
virtual machine.

147
Virtual Machine Management Guide

Field Name Sub-element Description

Enable migration Only activated with the


compression Legacy migration policy. The
option allows you to set
whether migration
compression is used during
live migration of the virtual
machine. This feature uses
Xor Binary Zero Run-Length-
Encoding to reduce virtual
machine downtime and total
live migration time for virtual
machines running memory
write-intensive workloads or
for any application with a
sparse memory update
pattern. Migration
compression is disabled
globally by default.

Select Inherit from


cluster setting to
use the compression
setting that is set at
the cluster level. This
option is selected by
default.

Select Compress to
override the cluster
setting or global
setting and allow
compression for the
virtual machine.

Select Don't
compress to override
the cluster setting or
global setting and
prevent compression
for the virtual
machine.

Pass-Through Host CPU This check box allows virtual


machines to take advantage
of the features of the physical
CPU of the host on which they
are situated. This option can
only be enabled when Do not
allow migration is
selected.

Configure NUMA NUMA Node Count The number of virtual NUMA


nodes to assign to the virtual
machine. If the Tune Mode is
Preferred, this value must
be set to 1 .

148
APPENDIX A. REFERENCE: SETTINGS IN ADMINISTRATION PORTAL AND USER PORTAL WINDOWS

Field Name Sub-element Description

Tune Mode The method used to allocate


memory.

Strict : Memory
allocation will fail if
the memory cannot
be allocated on the
target node.

Preferred: Memory
is allocated from a
single preferred node.
If sufficient memory is
not available, memory
can be allocated from
other nodes.

Interleave: Memory
is allocated across
nodes in a round-robin
algorithm.

NUMA Pinning Opens the NUMA Topology


window. This window shows
the host's total CPUs,
memory, and NUMA nodes,
and the virtual machine's
virtual NUMA nodes. Pin
virtual NUMA nodes to host
NUMA nodes by clicking and
dragging each vNUMA from
the box on the right to a
NUMA node on the left.

A.1.6. Virtual Machine High Availability Settings Explained


The following table details the options available on the High Availability tab of the New
Virtual Machine and Edit Virtual Machine windows.

Table A.6. Virtual Machine: High Availability Settings

Field Name Description

149
Virtual Machine Management Guide

Field Name Description

Highly Available Select this check box if the virtual machine is


to be highly available. For example, in cases of
host maintenance, all virtual machines are
automatically live migrated to another host. If
the host crashed and is in a non-responsive
state, only virtual machines with high
availability are restarted on another host. If
the host is manually shut down by the system
administrator, the virtual machine is not
automatically live migrated to another host.

Note that this option is unavailable if the


Migration Options setting in the Hosts
tab is set to either Allow manual
migration only or Do not allow
migration. For a virtual machine to be highly
available, it must be possible for the Manager
to migrate the virtual machine to other
available hosts as necessary.

Target Storage Domain for VM Lease Select the storage domain to hold a virtual
machine lease, or select No VM Lease to
disable the functionality. When a storage
domain is selected, it will hold a virtual
machine lease on a special volume that allows
the virtual machine to be started on another
host if the original host loses power or
becomes unresponsive.

This functionality is only available on storage


domain V4 or later.

Priority for Run/Migration queue Sets the priority level for the virtual machine
to be migrated or restarted on another host.

150
APPENDIX A. REFERENCE: SETTINGS IN ADMINISTRATION PORTAL AND USER PORTAL WINDOWS

Field Name Description

Watchdog Allows users to attach a watchdog card to a


virtual machine. A watchdog is a timer that is
used to automatically detect and recover from
failures. Once set, a watchdog timer
continually counts down to zero while the
system is in operation, and is periodically
restarted by the system to prevent it from
reaching zero. If the timer reaches zero, it
signifies that the system has been unable to
reset the timer and is therefore experiencing a
failure. Corrective actions are then taken to
address the failure. This functionality is
especially useful for servers that demand high
availability.

Watchdog Model : The model of watchdog


card to assign to the virtual machine. At
current, the only supported model is
i6300esb.

Watchdog Action: The action to take if the


watchdog timer reaches zero. The following
actions are available:

none - No action is taken. However,


the watchdog event is recorded in the
audit log.

reset - The virtual machine is reset


and the Manager is notified of the
reset action.

poweroff - The virtual machine is


immediately shut down.

dump - A dump is performed and the


virtual machine is paused.

pause - The virtual machine is paused,


and can be resumed by users.

A.1.7. Virtual Machine Resource Allocation Settings Explained


The following table details the options available on the Resource Allocation tab of the
New Virtual Machine and Edit Virtual Machine windows.

Table A.7. Virtual Machine: Resource Allocation Settings

Field Name Sub-element Description

151
Virtual Machine Management Guide

Field Name Sub-element Description

CPU Allocation CPU Profile The CPU profile assigned to


the virtual machine. CPU
profiles define the maximum
amount of processing
capability a virtual machine
can access on the host on
which it runs, expressed as a
percent of the total
processing capability
available to that host. CPU
profiles are defined on the
cluster level based on quality
of service entries created for
data centers.

CPU Shares Allows users to set the level of


CPU resources a virtual
machine can demand relative
to other virtual machines.

Low - 512

Medium - 1024

High - 2048

Custom - A custom
level of CPU shares
defined by the user.

152
APPENDIX A. REFERENCE: SETTINGS IN ADMINISTRATION PORTAL AND USER PORTAL WINDOWS

Field Name Sub-element Description

CPU Pinning topology Enables the virtual machine's


virtual CPU (vCPU) to run on a
specific physical CPU (pCPU)
in a specific host. The syntax
of CPU pinning is v#p[_v#p],
for example:

0#0 - Pins vCPU 0 to


pCPU 0.

0#0_1#3 - Pins vCPU


0 to pCPU 0, and pins
vCPU 1 to pCPU 3.

1#1-4,^2 - Pins vCPU


1 to one of the pCPUs
in the range of 1 to 4,
excluding pCPU 2.

In order to pin a virtual


machine to a host, you must
also select the following on
the Host tab:

Start Running On:


Specific

Migration
Options: Do not
allow migration

Pass-Through Host
CPU

If CPU pinning is set and you


change Start Running On:
Specific or Migration
Options: Do not allow
migration, a CPU pinning
topology will be lost
window appears when you
click OK.

Memory Allocation Physical Memory The amount of physical


Guaranteed memory guaranteed for this
virtual machine. Should be
any number between 0 and
the defined memory for this
virtual machine.

153
Virtual Machine Management Guide

Field Name Sub-element Description

Memory Balloon Device Enables the memory balloon


Enabled device for this virtual
machine. Enable this setting
to allow memory
overcommitment in a cluster.
Enable this setting for
applications that allocate
large amounts of memory
suddenly but set the
guaranteed memory to the
same value as the defined
memory. Use ballooning for
applications and loads that
slowly consume memory,
occasionally release memory,
or stay dormant for long
periods of time, such as
virtual desktops. See
Optimization Settings
Explained in the
Administration Guide for more
information.

IO Threads IO Threads Enabled Enables IO threads. Select this


check box to improve the
speed of disks that have a
VirtIO interface by pinning
them to a thread separate
from the virtual machine's
other functions. Improved disk
performance increases a
virtual machine's overall
performance. Disks with VirtIO
interfaces are pinned to an IO
thread using a round-robin
algorithm.

Num Of IO Threads Optionally enter a number


value to create multiple IO
threads, up to a maximum
value of 127. The default
value is 1.

Storage Allocation The Storage Allocation


option is only available when
the virtual machine is created
from a template.

Thin Provides optimized usage of


storage capacity. Disk space
is allocated only as it is
required. When selected, the
format of the disks will be
marked as QCOW2 and you
will not be able to change it.

154
APPENDIX A. REFERENCE: SETTINGS IN ADMINISTRATION PORTAL AND USER PORTAL WINDOWS

Field Name Sub-element Description

Clone Optimized for the speed of


guest read and write
operations. All disk space
requested in the template is
allocated at the time of the
clone operation. When
selected, you can select
either QCOW2 or RAW as the
disk format.

VirtIO-SCSI Enabled Allows users to enable or


disable the use of VirtIO-SCSI
on the virtual machines.

Disk Allocation The Disk Allocation


option is only available when
you are creating a virtual
machine from a template.

Alias An alias for the virtual disk. By


default, the alias is set to the
same value as that of the
template.

Virtual Size The total amount of disk


space that the virtual machine
based on the template can
use. This value cannot be
edited, and is provided for
reference only.

Format The format of the virtual disk.


The available options are
QCOW2 and Raw. If Thin is
selected in the Storage
Allocation section, then
QCOW2 will be automatically
selected and cannot be
changed.

Target The storage domain on which


the virtual disk is stored. By
default, the storage domain is
set to the same value as that
of the template.

Disk Profile The disk profile to assign to


the virtual disk. Disk profiles
are created based on storage
profiles defined in the data
centers.

A.1.8. Virtual Machine Boot Options Settings Explained

155
Virtual Machine Management Guide

The following table details the options available on the Boot Options tab of the New
Virtual Machine and Edit Virtual Machine windows

Table A.8. Virtual Machine: Boot Options Settings

Field Name Description

First Device After installing a new virtual machine, the new


virtual machine must go into Boot mode
before powering up. Select the first device that
the virtual machine must try to boot:

Hard Disk

CD-ROM

Network (PXE)

Second Device Select the second device for the virtual


machine to use to boot if the first device is not
available. The first device selected in the
previous option does not appear in the
options.

Attach CD If you have selected CD-ROM as a boot device,


tick this check box and select a CD-ROM image
from the drop-down menu. The images must
be available in the ISO domain.

Enable menu to select boot device Enables a menu to select the boot device.
After the virtual machine starts and connects
to the console, but before the virtual machine
starts booting, a menu displays that allows you
to select the boot device. This option should
be enabled before the initial boot to allow you
to select the required installation media.

A.1.9. Virtual Machine Random Generator Settings Explained


The following table details the options available on the Random Generator tab of the New
Virtual Machine and Edit Virtual Machine windows.

Table A.9. Virtual Machine: Random Generator Settings

Field Name Description

Random Generator enabled Selecting this check box enables a


paravirtualized Random Number Generator PCI
device (virtio-rng). This device allows entropy
to be passed from the host to the virtual
machine in order to generate a more
sophisticated random number. Note that this
check box can only be selected if the RNG
device exists on the host and is enabled in the
host's cluster.

156
APPENDIX A. REFERENCE: SETTINGS IN ADMINISTRATION PORTAL AND USER PORTAL WINDOWS

Field Name Description

Period duration (ms) Specifies the duration of a period in


milliseconds. If omitted, the libvirt default of
1000 milliseconds (1 second) is used. If this
field is filled, Bytes per period must be
filled also.

Bytes per period Specifies how many bytes are permitted to be


consumed per period.

Device source: The source of the random number generator.


This is automatically selected depending on
the source supported by the host's cluster.

/dev/urandom source - The Linux-


provided random number generator.

/dev/hwrng source - An external


hardware generator.

A.1.10. Virtual Machine Custom Properties Settings Explained


The following table details the options available on the Custom Properties tab of the New
Virtual Machine and Edit Virtual Machine windows.

Table A.10. Virtual Machine: Custom Properties Settings

Field Name Description Recommendations and


Limitations

sap_agent Enables SAP monitoring on -


the virtual machine. Set to
true or false.

sndbuf Enter the size of the buffer -


for sending the virtual
machine's outgoing data over
the socket. Default value is 0.

157
Virtual Machine Management Guide

Field Name Description Recommendations and


Limitations

vhost Disables vhost-net, which is vhost-net provides better


the kernel-based virtio performance than virtio-net,
network driver on virtual and if it is present, it is
network interface cards enabled on all virtual machine
attached to the virtual NICs by default. Disabling this
machine. To disable vhost, property makes it easier to
the format for this property is: isolate and diagnose
performance issues, or to
debug vhost-net errors; for
LogicalNetworkName:
example, if migration fails for
false virtual machines on which
vhost does not exist.
This will explicitly start the
virtual machine without the
vhost-net setting on the
virtual NIC attached to
LogicalNetworkName.

viodiskcache Caching mode for the virtio If viodiskcache is enabled, the


disk. writethrough writes virtual machine cannot be live
data to the cache and the migrated.
disk in parallel, writeback
does not copy modifications
from the cache to the disk,
and none disables caching.
See
https://access.redhat.com/solut
ions/2361311 for more
information about the
limitations of the
viodiskcache custom
property.


WARNING

Increasing the value of the sndbuf custom property results in increased


occurrences of communication failure between hosts and unresponsive
virtual machines.

A.1.11. Virtual Machine Icon Settings Explained


You can add custom icons to virtual machines and templates. Custom icons can help to
differentiate virtual machines in the User Portal. The following table details the options
available on the Icon tab of the New Virtual Machine and Edit Virtual Machine
windows.

Table A.11. Virtual Machine: Icon Settings

158
APPENDIX A. REFERENCE: SETTINGS IN ADMINISTRATION PORTAL AND USER PORTAL WINDOWS

Button Name Description

Upload Click this button to select a custom image to


use as the virtual machine's icon. The
following limitations apply:

Supported formats: jpg, png, gif

Maximum size: 24 KB

Maximum dimensions: 150px width,


120px height

Use default Click this button to set the operating system's


default image as the virtual machine's icon.

A.1.12. Virtual Machine Foreman/Satellite Settings Explained


The following table details the options available on the Foreman/Satellite tab of the New
Virtual Machine and Edit Virtual Machine windows

Table A.12. Virtual Machine:Foreman/Satellite Settings

Field Name Description

Provider If the virtual machine is running Red Hat


Enterprise Linux and the system is configured
to work with a Satellite server, select the name
of the Satellite from the list. This enables you
to use Satellite's content management feature
to display the relevant Errata for this virtual
machine. See Section 4.7, “Configuring Red
Hat Satellite Errata Management for a Virtual
Machine” for more details.

A.2. EXPLANATION OF SETTINGS IN THE NEW NETWORK


INTERFACE AND EDIT NETWORK INTERFACE WINDOWS
These settings apply when you are adding or editing a virtual machine network interface. If
you have more than one network interface attached to a virtual machine, you can put the
virtual machine on more than one logical network.

Table A.13. Network Interface Settings

Field Name Description

Name The name of the network interface. This text


field has a 21-character limit and must be a
unique name with any combination of
uppercase and lowercase letters, numbers,
hyphens, and underscores.

159
Virtual Machine Management Guide

Field Name Description

Profile The vNIC profile and logical network that the


network interface is placed on. By default, all
network interfaces are put on the ovirtmgmt
management network.

Type The virtual interface the network interface


presents to virtual machines.

rtl8139 and e1000 device drivers


are included in most operating
systems.

VirtIO is faster but requires VirtIO


drivers. Red Hat Enterprise Linux 5
and later include VirtIO drivers.
Windows does not include VirtIO
drivers, but they can be installed from
the guest tools ISO or virtual floppy
disk.

PCI Passthrough enables the vNIC


to be directly connected to a virtual
function (VF) of an SR-IOV-enabled
NIC. The vNIC will then bypass the
software network virtualization and
connect directly to the VF for direct
device assignment. The selected vNIC
profile must also have Passthrough
enabled.

Custom MAC address Choose this option to set a custom MAC


address. The Red Hat Virtualization Manager
automatically generates a MAC address that is
unique to the environment to identify the
network interface. Having two devices with the
same MAC address online in the same network
causes networking conflicts.

160
APPENDIX A. REFERENCE: SETTINGS IN ADMINISTRATION PORTAL AND USER PORTAL WINDOWS

Field Name Description

Link State Whether or not the network interface is


connected to the logical network.

Up: The network interface is located on


its slot.

When the Card Status is


Plugged, it means the network
interface is connected to a network
cable, and is active.

When the Card Status is


Unplugged, the network interface
will be automatically connected to
the network and become active.

Down: The network interface is located


on its slot, but it is not connected to
any network. Virtual machines will not
be able to run in this state.

Card Status Whether or not the network interface is


defined on the virtual machine.

Plugged: The network interface has


been defined on the virtual machine.

If its Link State is Up, it means


the network interface is connected
to a network cable, and is active.

If its Link State is Down, the


network interface is not connected
to a network cable.

Unplugged: The network interface is


only defined on the Manager, and is
not associated with a virtual machine.

If its Link State is Up, when the


network interface is plugged it will
automatically be connected to a
network and become active.

If its Link State is Down, the


network interface is not connected
to any network until it is defined
on a virtual machine.

A.3. EXPLANATION OF SETTINGS IN THE NEW VIRTUAL DISK


AND EDIT VIRTUAL DISK WINDOWS
Table A.14. New Virtual Disk and Edit Virtual Disk Settings: Image

161
Virtual Machine Management Guide

Field Name Description

Size(GB) The size of the new virtual disk in GB.

Alias The name of the virtual disk, limited to 40


characters.

Description A description of the virtual disk. This field is


recommended but not mandatory.

Interface The virtual interface the disk presents to


virtual machines. VirtIO is faster, but
requires drivers. Red Hat Enterprise Linux 5
and later include these drivers. Windows does
not include these drivers, but they can be
installed from the guest tools ISO or virtual
floppy disk. IDE devices do not require special
drivers.

The interface type can be updated after


stopping all virtual machines that the disk is
attached to.

Data Center The data center in which the virtual disk will
be available.

Storage Domain The storage domain in which the virtual disk


will be stored. The drop-down list shows all
storage domains available in the given data
center, and also shows the total space and
currently available space in the storage
domain.

162
APPENDIX A. REFERENCE: SETTINGS IN ADMINISTRATION PORTAL AND USER PORTAL WINDOWS

Field Name Description

Allocation Policy The provisioning policy for the new virtual


disk.

Preallocated allocates the entire


size of the disk on the storage domain
at the time the virtual disk is created.
The virtual size and the actual size of
a preallocated disk are the same.
Preallocated virtual disks take more
time to create than thinly provisioned
virtual disks, but have better read and
write performance. Preallocated virtual
disks are recommended for servers
and other I/O intensive virtual
machines. If a virtual machine is able
to write more than 1 GB every four
seconds, use preallocated disks where
possible.

Thin Provision allocates 1 GB at


the time the virtual disk is created and
sets a maximum limit on the size to
which the disk can grow. The virtual
size of the disk is the maximum limit;
the actual size of the disk is the space
that has been allocated so far. Thinly
provisioned disks are faster to create
than preallocated disks and allow for
storage over-commitment. Thinly
provisioned virtual disks are
recommended for desktops.

Disk Profile The disk profile assigned to the virtual disk.


Disk profiles define the maximum amount of
throughput and the maximum level of input
and output operations for a virtual disk in a
storage domain. Disk profiles are defined on
the storage domain level based on storage
quality of service entries created for data
centers.

Activate Disk(s) Activate the virtual disk immediately after


creation. This option is not available when
creating a floating disk.

Wipe After Delete Allows you to enable enhanced security for


deletion of sensitive material when the virtual
disk is deleted.

Bootable Allows you to enable the bootable flag on the


virtual disk.

Shareable Allows you to attach the virtual disk to more


than one virtual machine at a time.

163
Virtual Machine Management Guide

Field Name Description

Read Only Allows you to set the disk as read-only. The


same disk can be attached as read-only to one
virtual machine, and as rewritable to another.
This option is not available when creating a
floating disk.

Enable Discard Allows you to shrink a thinly provisioned disk


while the virtual machine is up. For block
storage, the underlying storage device must
support discard calls, and the option cannot be
used with Wipe After Delete unless the
underlying storage supports the
discard_zeroes_data property. For file storage,
the underlying file system and the block
device must support discard calls. If all
requirements are met, SCSI UNMAP commands
issued from guest virtual machines is passed
on by QEMU to the underlying storage to free
up the unused space.

The Direct LUN settings can be displayed in either Targets > LUNs or LUNs > Targets.
Targets > LUNs sorts available LUNs according to the host on which they are discovered,
whereas LUNs > Targets displays a single list of LUNs.

Table A.15. New Virtual Disk and Edit Virtual Disk Settings: Direct LUN

Field Name Description

Alias The name of the virtual disk, limited to 40


characters.

Description A description of the virtual disk. This field is


recommended but not mandatory. By default
the last 4 characters of the LUN ID is inserted
into the field.

The default behavior can be configured by


setting the
PopulateDirectLUNDiskDescriptionWit
hLUNId configuration key to the appropriate
value using the engine-config command.
The configuration key can be set to -1 for the
full LUN ID to be used, or 0 for this feature to
be ignored. A positive integer populates the
description with the corresponding number of
characters of the LUN ID.

164
APPENDIX A. REFERENCE: SETTINGS IN ADMINISTRATION PORTAL AND USER PORTAL WINDOWS

Field Name Description

Interface The virtual interface the disk presents to


virtual machines. VirtIO is faster, but
requires drivers. Red Hat Enterprise Linux 5
and later include these drivers. Windows does
not include these drivers, but they can be
installed from the guest tools ISO or virtual
floppy disk. IDE devices do not require special
drivers.

The interface type can be updated after


stopping all virtual machines that the disk is
attached to.

Data Center The data center in which the virtual disk will
be available.

Use Host The host on which the LUN will be mounted.


You can select any host in the data center.

Storage Type The type of external LUN to add. You can


select from either iSCSI or Fibre Channel.

Discover Targets This section can be expanded when you are


using iSCSI external LUNs and Targets >
LUNs is selected.

Address - The host name or IP address of the


target server.

Port - The port by which to attempt a


connection to the target server. The default
port is 3260.

User Authentication - The iSCSI server


requires User Authentication. The User
Authentication field is visible when you are
using iSCSI external LUNs.

CHAP user name - The user name of a user


with permission to log in to LUNs. This field is
accessible when the User Authentication
check box is selected.

CHAP password - The password of a user with


permission to log in to LUNs. This field is
accessible when the User Authentication
check box is selected.

Activate Disk(s) Activate the virtual disk immediately after


creation. This option is not available when
creating a floating disk.

Bootable Allows you to enable the bootable flag on the


virtual disk.

165
Virtual Machine Management Guide

Field Name Description

Shareable Allows you to attach the virtual disk to more


than one virtual machine at a time.

Read Only Allows you to set the disk as read-only. The


same disk can be attached as read-only to one
virtual machine, and as rewritable to another.
This option is not available when creating a
floating disk.

Enable Discard Allows you to shrink a thinly provisioned disk


while the virtual machine is up. With this
option enabled, SCSI UNMAP commands issued
from guest virtual machines is passed on by
QEMU to the underlying storage to free up the
unused space.

Enable SCSI Pass-Through Available when the Interface is set to


VirtIO-SCSI . Selecting this check box
enables passthrough of a physical SCSI device
to the virtual disk. A VirtIO-SCSI interface with
SCSI passthrough enabled automatically
includes SCSI discard support. Read Only is
not supported when this check box is selected.

When this check box is not selected, the


virtual disk uses an emulated SCSI device.
Read Only is supported on emulated VirtIO-
SCSI disks.

Allow Privileged SCSI I/O Available when the Enable SCSI Pass-
Through check box is selected. Selecting this
check box enables unfiltered SCSI Generic I/O
(SG_IO) access, allowing privileged SG_IO
commands on the disk. This is required for
persistent reservations.

Using SCSI Reservation Available when the Enable SCSI Pass-


Through and Allow Privileged SCSI I/O
check boxes are selected. Selecting this check
box disables migration for any virtual machine
using this disk, to prevent virtual machines
that are using SCSI reservation from losing
access to the disk.

Fill in the fields in the Discover Targets section and click Discover to discover the target
server. You can then click the Login All button to list the available LUNs on the target
server and, using the radio buttons next to each LUN, select the LUN to add.

Using LUNs directly as virtual machine hard disk images removes a layer of abstraction
between your virtual machines and their data.

The following considerations must be made when using a direct LUN as a virtual machine
hard disk image:

166
APPENDIX A. REFERENCE: SETTINGS IN ADMINISTRATION PORTAL AND USER PORTAL WINDOWS

Live storage migration of direct LUN hard disk images is not supported.

Direct LUN disks are not included in virtual machine exports.

Direct LUN disks are not included in virtual machine snapshots.

The Cinder settings form will be disabled if there are no available OpenStack Volume
storage domains on which you have permissions to create a disk in the relevant Data
Center. Cinder disks require access to an instance of OpenStack Volume that has been
added to the Red Hat Virtualization environment using the External Providers window;
see Adding an OpenStack Volume (Cinder) Instance for Storage Managementfor more
information.

Table A.16. New Virtual Disk and Edit Virtual Disk Settings: Cinder

Field Name Description

Size(GB) The size of the new virtual disk in GB.

Alias The name of the virtual disk, limited to 40


characters.

Description A description of the virtual disk. This field is


recommended but not mandatory.

Interface The virtual interface the disk presents to


virtual machines. VirtIO is faster, but
requires drivers. Red Hat Enterprise Linux 5
and later include these drivers. Windows does
not include these drivers, but they can be
installed from the guest tools ISO or virtual
floppy disk. IDE devices do not require special
drivers.

The interface type can be updated after


stopping all virtual machines that the disk is
attached to.

Data Center The data center in which the virtual disk will
be available.

Storage Domain The storage domain in which the virtual disk


will be stored. The drop-down list shows all
storage domains available in the given data
center, and also shows the total space and
currently available space in the storage
domain.

Volume Type The volume type of the virtual disk. The drop-
down list shows all available volume types.
The volume type will be managed and
configured on OpenStack Cinder.

Activate Disk(s) Activate the virtual disk immediately after


creation. This option is not available when
creating a floating disk.

167
Virtual Machine Management Guide

Field Name Description

Bootable Allows you to enable the bootable flag on the


virtual disk.

Shareable Allows you to attach the virtual disk to more


than one virtual machine at a time.

Read Only Allows you to set the disk as read-only. The


same disk can be attached as read-only to one
virtual machine, and as rewritable to another.
This option is not available when creating a
floating disk.

IMPORTANT

Mounting a journaled file system requires read-write access. Using the Read
Only option is not appropriate for virtual disks that contain such file systems
(e.g. EXT3, EXT4, or XFS).

A.4. EXPLANATION OF SETTINGS IN THE NEW TEMPLATE


WINDOW
The following table details the settings for the New Template window.

Table A.17. New Template Settings

Field Description/Action

Name The name of the template. This is the name by


which the template is listed in the Templates
tab in the Administration Portal and is
accessed via the REST API. This text field has a
40-character limit and must be a unique name
within the data center with any combination of
uppercase and lowercase letters, numbers,
hyphens, and underscores. The name can be
re-used in different data centers in the
environment.

Description A description of the template. This field is


recommended but not mandatory.

Comment A field for adding plain text, human-readable


comments regarding the template.

Cluster The cluster with which the template is


associated. This is the same as the original
virtual machines by default. You can select any
cluster in the data center.

168
APPENDIX A. REFERENCE: SETTINGS IN ADMINISTRATION PORTAL AND USER PORTAL WINDOWS

Field Description/Action

CPU Profile The CPU profile assigned to the template. CPU


profiles define the maximum amount of
processing capability a virtual machine can
access on the host on which it runs, expressed
as a percent of the total processing capability
available to that host. CPU profiles are defined
on the cluster level based on quality of service
entries created for data centers.

Create as a Template Sub Version Specifies whether the template is created as a


new version of an existing template. Select
this check box to access the settings for
configuring this option.

Root Template: The template under


which the sub template is added.

Sub Version Name: The name of the


template. This is the name by which
the template is accessed when
creating a new virtual machine based
on the template. If the virtual machine
is stateless, the list of sub versions will
contain a latest option rather than
the name of the latest sub version.
This option automatically applies the
latest template sub version to the
virtual machine upon reboot. Sub
versions are particularly useful when
working with pools of stateless virtual
machines.

169
Virtual Machine Management Guide

Field Description/Action

Disks Allocation Alias - An alias for the virtual disk used by


the template. By default, the alias is set to the
same value as that of the source virtual
machine.

Virtual Size - The total amount of disk


space that a virtual machine based on the
template can use. This value cannot be edited,
and is provided for reference only. This value
corresponds with the size, in GB, that was
specified when the disk was created or edited.

Format - The format of the virtual disk used


by the template. The available options are
QCOW2 and Raw. By default, the format is set
to Raw.

Target - The storage domain on which the


virtual disk used by the template is stored. By
default, the storage domain is set to the same
value as that of the source virtual machine.
You can select any storage domain in the
cluster.

Disk Profile - The disk profile to assign to


the virtual disk used by the template. Disk
profiles are created based on storage profiles
defined in the data centers.

Allow all users to access this Specifies whether a template is public or


Template private. A public template can be accessed by
all users, whereas a private template can only
be accessed by users with the
TemplateAdmin or SuperUser roles.

Copy VM permissions Copies explicit permissions that have been set


on the source virtual machine to the template.

Seal Template (Linux only) Specifies whether a template is sealed.


'Sealing' is an operation that erases all
machine-specific configurations from a
filesystem, including SSH keys, UDEV rules,
MAC addresses, system ID, and hostname. This
setting prevents a virtual machine based on
this template from inheriting the configuration
of the source virtual machine.

A.5. EXPLANATION OF SETTINGS IN THE RUN ONCE


WINDOW
The Run Once window defines one-off boot options for a virtual machine. For persistent boot
options, use the Boot Options tab in the New Virtual Machine window. The Run Once
window contains multiple sections that can be configured.

170
APPENDIX A. REFERENCE: SETTINGS IN ADMINISTRATION PORTAL AND USER PORTAL WINDOWS

The Boot Options section defines the virtual machine's boot sequence, running options,
and source images for installing the operating system and required drivers.

Table A.18. Boot Options Section

Field Name Description

Attach Floppy Attaches a diskette image to the virtual


machine. Use this option to install Windows
drivers. The diskette image must reside in the
ISO domain.

Attach CD Attaches an ISO image to the virtual machine.


Use this option to install the virtual machine's
operating system and applications. The CD
image must reside in the ISO domain.

Enable menu to select boot device Enables a menu to select the boot device.
After the virtual machine starts and connects
to the console, but before the virtual machine
starts booting, a menu displays that allows you
to select the boot device. This option should
be enabled before the initial boot to allow you
to select the required installation media.

Start in Pause Mode Starts and then pauses the virtual machine to
enable connection to the console. Suitable for
virtual machines in remote locations.

Predefined Boot Sequence Determines the order in which the boot


devices are used to boot the virtual machine.
Select Hard Disk, CD-ROM , or Network
(PXE), and use Up and Down to move the
option up or down in the list.

Run Stateless Deletes all data and configuration changes to


the virtual machine upon shutdown. This
option is only available if a virtual disk is
attached to the virtual machine.

The Linux Boot Options section contains fields to boot a Linux kernel directly instead of
through the BIOS bootloader.

Table A.19. Linux Boot Options Section

Field Name Description

kernel path A fully qualified path to a kernel image to boot


the virtual machine. The kernel image must be
stored on either the ISO domain (path name in
the format of iso://path-to-image ) or on
the host's local storage domain (path name in
the format of /data/images).

171
Virtual Machine Management Guide

Field Name Description

initrd path A fully qualified path to a ramdisk image to be


used with the previously specified kernel. The
ramdisk image must be stored on the ISO
domain (path name in the format of
iso://path-to-image ) or on the host's
local storage domain (path name in the format
of /data/images).

kernel parameters Kernel command line parameter strings to be


used with the defined kernel on boot.

The Initial Run section is used to specify whether to use Cloud-Init or Sysprep to initialize
the virtual machine. For Linux-based virtual machines, you must select the Use Cloud-Init
check box in the Initial Run tab to view the available options. For Windows-based virtual
machines, you must attach the [sysprep] floppy by selecting the Attach Floppy check
box in the Boot Options tab and selecting the floppy from the list.

The options that are available in the Initial Run section differ depending on the operating
system that the virtual machine is based on.

Table A.20. Initial Run Section (Linux-based Virtual Machines)

Field Name Description

VM Hostname The host name of the virtual machine. It is set


automatically to the name of the virtual
machine, but can be changed.

Configure Time Zone The time zone for the virtual machine. Select
this check box and select a time zone from the
Time Zone list.

Authentication The authentication details for the virtual


machine. Click the disclosure arrow to display
the settings for this option.

Authentication > User Name Creates a new user account on the virtual
machine. If this field is not filled in, the default
user is root.

Authentication > Use already This check box is automatically selected after
configured password you specify an initial root password. You must
clear this check box to enable the Password
and Verify Password fields and specify a
new password.

Authentication > Password The root password for the virtual machine.
Enter the password in this text field and the
Verify Password text field to verify the
password.

172
APPENDIX A. REFERENCE: SETTINGS IN ADMINISTRATION PORTAL AND USER PORTAL WINDOWS

Field Name Description

Authentication > SSH Authorized SSH keys to be added to the authorized keys
Keys file of the virtual machine.

Authentication > Regenerate SSH Regenerates SSH keys for the virtual machine.
Keys

Networks Network-related settings for the virtual


machine. Click the disclosure arrow to display
the settings for this option.

Networks > DNS Servers The DNS servers to be used by the virtual
machine.

Networks > DNS Search Domains The DNS search domains to be used by the
virtual machine.

Networks > Network Configures network interfaces for the virtual


machine. Select this check box and click + or -
to add or remove network interfaces to or from
the virtual machine. When you click + , a set of
fields becomes visible that can specify whether
to use DHCP, and configure an IP address,
netmask, and gateway, and specify whether
the network interface will start on boot.

Custom Script Custom scripts that will be run on the virtual


machine when it starts. The scripts entered in
this field are custom YAML sections that are
added to those produced by the Manager, and
allow you to automate tasks such as creating
users and files, configuring yum repositories
and running commands. For more information
on the format of scripts that can be entered in
this field, see the Custom Script
documentation.

Table A.21. Initial Run Section (Windows-based Virtual Machines)

Field Name Description

VM Hostname The host name of the virtual machine. It is set


automatically to the name of the virtual
machine, but can be changed.

Domain The Active Directory domain to which the


virtual machine belongs.

173
Virtual Machine Management Guide

Field Name Description

Organization Name The name of the organization to which the


virtual machine belongs. This option
corresponds to the text field for setting the
organization name displayed when a machine
running Windows is started for the first time.

Active Directory OU The organizational unit in the Active Directory


domain to which the virtual machine belongs.
The distinguished name must be provided. For
example CN=Users,DC=lab,DC=local

Configure Time Zone The time zone for the virtual machine. Select
this check box and select a time zone from the
Time Zone list.

Admin Password The administrative user password for the


virtual machine. Click the disclosure arrow to
display the settings for this option.

Admin Password > Use already This check box is automatically selected after
configured password you specify an initial administrative user
password. You must clear this check box to
enable the Admin Password and Verify
Admin Password fields and specify a new
password.

Admin Password > Admin Password The administrative user password for the
virtual machine. Enter the password in this
text field and the Verify Admin Password
text field to verify the password.

Custom Locale Locales must be in a format such as en-US.


Click the disclosure arrow to display the
settings for this option.

Custom Locale > Input Locale The locale for user input.

Custom Locale > UI Language The language used for user interface elements
such as buttons and menus.

Custom Locale > System Locale The locale for the overall system.

Custom Locale > User Locale The locale for users.

174
APPENDIX A. REFERENCE: SETTINGS IN ADMINISTRATION PORTAL AND USER PORTAL WINDOWS

Field Name Description

Sysprep A custom Sysprep definition. The definition


must be in the format of a complete
unattended installation answer file. You can
copy and paste the default answer files in the
/usr/share/ovirt-
engine/conf/sysprep/ directory on the
machine on which the Red Hat Virtualization
Manager is installed and alter the fields as
required. The definition will overwrite any
values entered in the Initial Run fields. See
Chapter 7, Templates for more information.

Domain The Active Directory domain to which the


virtual machine belongs. If left blank, the
value of the previous Domain field is used.

Alternate Credentials Selecting this check box allows you to set a


User Name and Password as alternative
credentials.

The System section enables you to define the supported machine type or CPU type.

Table A.22. System Section

Field Name Description

Custom Emulated Machine This option allows you to specify the machine
type. If changed, the virtual machine will only
run on hosts that support this machine type.
Defaults to the cluster's default machine type.

Custom CPU Type This option allows you to specify a CPU type. If
changed, the virtual machine will only run on
hosts that support this CPU type. Defaults to
the cluster's default CPU type.

The Host section is used to define the virtual machine's host.

Table A.23. Host Section

Field Name Description

Any host in cluster Allocates the virtual machine to any available


host.

Specific Host(s) Specifies a user-defined host for the virtual


machine.

175
Virtual Machine Management Guide

The Console section defines the protocol to connect to virtual machines.

Table A.24. Console Section

Field Name Description

Headless Mode Select this option if you do not require a


graphical console when running the machine
for the first time. See Section 4.8, “Configuring
Headless Virtual Machines” for more
information.

VNC Requires a VNC client to connect to a virtual


machine using VNC. Optionally, specify VNC
Keyboard Layout from the drop-down list.

SPICE Recommended protocol for Linux and Windows


virtual machines. Using SPICE protocol without
QXL drivers is supported for Windows 8 and
Server 2012 virtual machines; however,
support for multiple monitors and graphics
acceleration is not available for this
configuration.

Enable SPICE file transfer Determines whether you can drag and drop
files from an external host into the virtual
machine's SPICE console. This option is only
available for virtual machines using the SPICE
protocol. This check box is selected by default.

Enable SPICE clipboard copy and Defines whether you can copy and paste
paste content from an external host into the virtual
machine's SPICE console. This option is only
available for virtual machines using the SPICE
protocol. This check box is selected by default.

The Custom Properties section contains additional VDSM options for running virtual
machines.

Table A.25. Custom Properties Section

Field Name Description

sndbuf Enter the size of the buffer for sending the


virtual machine's outgoing data over the
socket.

vhost Enter the name of the host on which this


virtual machine should run. The name can
contain any combination of letters and
numbers.

mdev_type Enter the name of a mediated device type (for


example, GPU) supported by the host's kernel
to enable the host to work with the device.

176
APPENDIX A. REFERENCE: SETTINGS IN ADMINISTRATION PORTAL AND USER PORTAL WINDOWS

Field Name Description

viodiskcache Caching mode for the virtio disk.


writethrough writes data to the cache and
the disk in parallel, writeback does not copy
modifications from the cache to the disk, and
none disables caching. See
https://access.redhat.com/solutions/2361311
for more information about the limitations of
the viodiskcache custom property.

sap_agent Enables SAP monitoring on the virtual


machine. Set to true or false.

177
Virtual Machine Management Guide

APPENDIX B. VIRT-SYSPREP OPERATIONS


The virt-sysprep command removes system-specific details.

Only operations marked with * are performed during the template sealing process.

# virt-sysprep --list-operations
abrt-data * Remove the crash data generated by ABRT
bash-history * Remove the bash history in the guest
blkid-tab * Remove blkid tab in the guest
ca-certificates Remove CA certificates in the guest
crash-data * Remove the crash data generated by kexec-tools
cron-spool * Remove user at-jobs and cron-jobs
customize * Customize the guest
dhcp-client-state * Remove DHCP client leases
dhcp-server-state * Remove DHCP server leases
dovecot-data * Remove Dovecot (mail server) data
firewall-rules Remove the firewall rules
flag-reconfiguration Flag the system for reconfiguration
fs-uuids Change filesystem UUIDs
kerberos-data Remove Kerberos data in the guest
logfiles * Remove many log files from the guest
lvm-uuids * Change LVM2 PV and VG UUIDs
machine-id * Remove the local machine ID
mail-spool * Remove email from the local mail spool directory
net-hostname * Remove HOSTNAME in network interface configuration
net-hwaddr * Remove HWADDR (hard-coded MAC address) configuration
pacct-log * Remove the process accounting log files
package-manager-cache * Remove package manager cache
pam-data * Remove the PAM data in the guest
puppet-data-log * Remove the data and log files of puppet
rh-subscription-manager * Remove the RH subscription manager files
rhn-systemid * Remove the RHN system ID
rpm-db * Remove host-specific RPM database files
samba-db-log * Remove the database and log files of Samba
script * Run arbitrary scripts against the guest
smolt-uuid * Remove the Smolt hardware UUID
ssh-hostkeys * Remove the SSH host keys in the guest
ssh-userdir * Remove ".ssh" directories in the guest
sssd-db-log * Remove the database and log files of sssd
tmp-files * Remove temporary files
udev-persistent-net * Remove udev persistent net rules
user-account Remove the user accounts in the guest
utmp * Remove the utmp file
yum-uuid * Remove the yum UUID

178

You might also like