Red Hat Enterprise Virtualization 3.3
Administrating Red Hat Enterprise Virtualization Environments.
Legal Notice
Copyright © 2014 Red Hat, Inc.
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, MetaMatrix, 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 book contains information and procedures relevant to Red Hat Enterprise Virtualization administrators.
- Preface
- 1. Using this Guide
- 2. Basics
- I. Administering the Resources
- 3. Data Centers
- 4. Clusters
- 5. Logical Networks
- 6. Hosts
- 7. Storage Domains
- 7.1. Understanding Storage Domains
- 7.2. Storage Metadata Versions in Red Hat Enterprise Virtualization
- 7.3. Preparing and Adding File-based Storage
- 7.4. Preparing and Adding Red Hat Storage (GlusterFS) Storage Domains
- 7.5. Adding POSIX Compliant File System Storage
- 7.6. Preparing and Adding Block-based Storage
- 7.7. Storage Tasks
- 7.8. Storage and Permissions
- 8. Virtual Machines
- 8.1. Introduction to Virtual Machines
- 8.2. Supported Virtual Machine Operating Systems
- 8.3. Virtual Machine Performance Parameters
- 8.4. Creating Virtual Machines
- 8.5. Using Virtual Machines
- 8.6. Shutting Down or Pausing Virtual Machines
- 8.7. Managing Virtual Machines
- 8.8. Virtual Machines and Permissions
- 8.9. Backing Up and Restoring Virtual Machines with Snapshots
- 8.10. Importing and Exporting Virtual Machines
- 8.11. Migrating Virtual Machines Between Hosts
- 8.12. Improving Uptime with Virtual Machine High Availability
- 8.13. Other Virtual Machine Tasks
- 9. Templates
- 10. Pools
- 11. Virtual Machine Disks
- 12. Red Hat Storage (GlusterFS) Volumes
- 13. External Providers
- 13.1. Introduction to External Providers in Red Hat Enterprise Virtualization
- 13.2. Enabling the Authentication of OpenStack Providers
- 13.3. Adding an External Provider
- 13.4. Removing an External Provider
- 13.5. Explanation of Settings and Controls in the Add Provider Window
- 13.6. Explanation of Settings and Controls in the Edit Provider Window
- II. Administering the Environment
- 14. Users and Roles
- 15. Quotas and Service Level Agreement Policy
- 15.1. Introduction to Quota
- 15.2. Shared Quota and Individually-defined Quota
- 15.3. Quota Accounting
- 15.4. Enabling and Changing a Quota Mode in a Data Center
- 15.5. Creating a New Quota Policy
- 15.6. Explanation of Quota Threshold Settings
- 15.7. Assigning a Quota to an Object
- 15.8. Using Quota to Limit Resources by User
- 15.9. Editing Quotas
- 15.10. Removing Quotas
- 15.11. Service-level Agreement Policy Enforcement
- 16. Event Notifications
- 17. Utilities
- 17.1. Renaming the Manager with the Ovirt Engine Rename Tool
- 17.2. Managing Domains with the Domain Management Tool
- 17.3. Editing the Configuration of the Red Hat Virtualization Manager with the Configuration Tool
- 17.4. Uploading Virtual Machine Images with the Image Uploader Tool
- 17.5. Editing USB Filters with the USB Filter Editor
- 17.6. Collecting Logs with the Log Collector Tool
- 17.7. Uploading ISO Files with the ISO Uploader Tool
- 17.8. Guest Drivers and Agents
- 18. Log Files
- 19. Updating the Red Hat Enterprise Virtualization Environment
- 20. Backups
- III. Gathering Information About the Environment
- A. Firewalls
- B. VDSM and Hooks
- B.1. VDSM
- B.2. VDSM Hooks
- B.3. Extending VDSM with Hooks
- B.4. Supported VDSM Events
- B.5. The VDSM Hook Environment
- B.6. The VDSM Hook Domain XML Object
- B.7. Defining Custom Properties
- B.8. Setting Custom Device Properties
- B.9. Setting Virtual Machine Custom Properties
- B.10. Evaluating Virtual Machine Custom Properties in a VDSM Hook
- B.11. Using the VDSM Hooking Module
- B.12. VDSM Hook Execution
- B.13. VDSM Hook Return Codes
- B.14. VDSM Hook Examples
- C. Red Hat Enterprise Virtualization User Interface Plugins
- D. Red Hat Enterprise Virtualization and SSL
- E. Red Hat Storage (GlusterFS) Terminology
- F. Using Search, Bookmarks, and Tags to Find Your Way Around
- G. Branding
- H. Revision History
1. Document Conventions
This manual uses several conventions to highlight certain words and phrases and draw attention to specific pieces of information.
1.1. Typographic Conventions
Four typographic conventions are used to call attention to specific words and phrases. These conventions, and the circumstances they apply to, are as follows.
Mono-spaced Bold
Used to highlight system input, including shell commands, file names and paths. Also used to highlight keys and key combinations. For example:
To see the contents of the filemy_next_bestselling_novelin your current working directory, enter thecat my_next_bestselling_novelcommand at the shell prompt and press Enter to execute the command.
The above includes a file name, a shell command and a key, all presented in mono-spaced bold and all distinguishable thanks to context.
Key combinations can be distinguished from an individual key by the plus sign that connects each part of a key combination. For example:
Press Enter to execute the command.Press Ctrl+Alt+F2 to switch to a virtual terminal.
The first example highlights a particular key to press. The second example highlights a key combination: a set of three keys pressed simultaneously.
If source code is discussed, class names, methods, functions, variable names and returned values mentioned within a paragraph will be presented as above, in
mono-spaced bold. For example:
File-related classes includefilesystemfor file systems,filefor files, anddirfor directories. Each class has its own associated set of permissions.
Proportional Bold
This denotes words or phrases encountered on a system, including application names; dialog-box text; labeled buttons; check-box and radio-button labels; menu titles and submenu titles. For example:
Choose → → from the main menu bar to launch Mouse Preferences. In the Buttons tab, select the Left-handed mouse check box and click to switch the primary mouse button from the left to the right (making the mouse suitable for use in the left hand).To insert a special character into a gedit file, choose → → from the main menu bar. Next, choose → from the Character Map menu bar, type the name of the character in the Search field and click . The character you sought will be highlighted in the Character Table. Double-click this highlighted character to place it in the Text to copy field and then click the button. Now switch back to your document and choose → from the gedit menu bar.
The above text includes application names; system-wide menu names and items; application-specific menu names; and buttons and text found within a GUI interface, all presented in proportional bold and all distinguishable by context.
Mono-spaced Bold Italic or Proportional Bold Italic
Whether mono-spaced bold or proportional bold, the addition of italics indicates replaceable or variable text. Italics denotes text you do not input literally or displayed text that changes depending on circumstance. For example:
To connect to a remote machine using ssh, typessh username@domain.nameat a shell prompt. If the remote machine isexample.comand your username on that machine is john, typessh john@example.com.Themount -o remount file-systemcommand remounts the named file system. For example, to remount the/homefile system, the command ismount -o remount /home.To see the version of a currently installed package, use therpm -q packagecommand. It will return a result as follows:package-version-release.
Note the words in bold italics above: username, domain.name, file-system, package, version and release. Each word is a placeholder, either for text you enter when issuing a command or for text displayed by the system.
Aside from standard usage for presenting the title of a work, italics denotes the first use of a new and important term. For example:
Publican is a DocBook publishing system.
1.2. Pull-quote Conventions
Terminal output and source code listings are set off visually from the surrounding text.
Output sent to a terminal is set in
mono-spaced roman and presented thus:
books Desktop documentation drafts mss photos stuff svn books_tests Desktop1 downloads images notes scripts svgs
Source-code listings are also set in
mono-spaced roman but add syntax highlighting as follows:
static int kvm_vm_ioctl_deassign_device(struct kvm *kvm,
struct kvm_assigned_pci_dev *assigned_dev)
{
int r = 0;
struct kvm_assigned_dev_kernel *match;
mutex_lock(&kvm->lock);
match = kvm_find_assigned_dev(&kvm->arch.assigned_dev_head,
assigned_dev->assigned_dev_id);
if (!match) {
printk(KERN_INFO "%s: device hasn't been assigned before, "
"so cannot be deassigned\n", __func__);
r = -EINVAL;
goto out;
}
kvm_deassign_device(kvm, match);
kvm_free_assigned_device(kvm, match);
out:
mutex_unlock(&kvm->lock);
return r;
}1.3. Notes and Warnings
Finally, we use three visual styles to draw attention to information that might otherwise be overlooked.
Note
Notes are tips, shortcuts or alternative approaches to the task at hand. Ignoring a note should have no negative consequences, but you might miss out on a trick that makes your life easier.
Important
Important boxes detail things that are easily missed: configuration changes that only apply to the current session, or services that need restarting before an update will apply. Ignoring a box labeled “Important” will not cause data loss but may cause irritation and frustration.
Warning
Warnings should not be ignored. Ignoring warnings will most likely cause data loss.
2. Getting Help and Giving Feedback
2.1. Do You Need Help?
If you experience difficulty with a procedure described in this documentation, visit the Red Hat Customer Portal at http://access.redhat.com. Through the customer portal, you can:
- search or browse through a knowledgebase of technical support articles about Red Hat products.
- submit a support case to Red Hat Global Support Services (GSS).
- access other product documentation.
Red Hat also hosts a large number of electronic mailing lists for discussion of Red Hat software and technology. You can find a list of publicly available mailing lists at https://www.redhat.com/mailman/listinfo. Click on the name of any mailing list to subscribe to that list or to access the list archives.
2.2. We Need Feedback!
If you find a typographical error in this manual, or if you have thought of a way to make this manual better, we would love to hear from you! Please submit a report in Bugzilla: http://bugzilla.redhat.com/ against the product Red Hat Enterprise Virtualization Manager.
When submitting a bug report, be sure to mention the manual's identifier: Guides-Admin
If you have a suggestion for improving the documentation, try to be as specific as possible when describing it. If you have found an error, please include the section number and some of the surrounding text so we can find it easily.
Chapter 1. Using this Guide
1.1. Administration Guide Prerequisites
You need a functioning Red Hat Enterprise Virtualization environment to use this guide. You can use the Red Hat Enterprise Virtualization Installation Guide or the Red Hat Enterprise Virtualization Quick Start Guide to install your environment and complete the initial configuration tasks.
A basic Red Hat Enterprise Virtualization environment has:
- at least one data center,
- at least one cluster,
- at least one host,
- at least one data storage domain,
- at least one logical network: the
rhevmmanagement network, - and at least one user: the internal
adminuser.
The Red Hat Enterprise Virtualization Administration Guide contains information about managing existing Red Hat Enterprise Virtualization environments. If your environment is missing one of the listed elements, please find the topic in this guide or in the Installation Guide or Quick Start Guide that describes how to add what your environment is missing.
1.2. Administration Guide Layout
In the Red Hat Enterprise Virtualization Administration Guide it is assumed that administrators want to perform actions on objects or with objects. For example, you want to add a new logical network to a cluster. "Add a new logical network" is an action, and "cluster" is an object.
The Red Hat Enterprise Virtualization Administration Guide uses objects to group content. The objects are ordered according to their likely order of usage by administrators. The objects are:
- Data Centers;
- Clusters;
- Networks;
- Hosts;
- Storage;
- Virtual Machines, Templates, and Pools;
- Users and Roles;
- Quotas;
- Monitoring, Reports, and Dashboards;
- Firewalls;
- VDSM and Hooks;
- Utilities; and
- Backups.
To use this guide, find the object you are interested in affecting, then find the action or task you want to perform.
1.3. Example Workflows
1.3.1. Administration Guide Example Workflows Overview
Example workflows can help you become comfortable with using the Red Hat Enterprise Virtualization Administration Guide. They are common tasks performed by administrators of Red Hat Enterprise Virtualization environments. Each workflow begins with a scenario, and then gives links to the tasks for each scenario in the order that they should be performed.
1.3.2. Administration Guide Example Workflow: New iSCSI Data Center
Your employer has purchased some new hypervisors and storage to add to your environment. All the hardware has been configured by your IT department. The storage is deployed as iSCSI storage. The hypervisors run Red Hat Enterprise Linux. The storage traffic is carried over a storage network separate from management traffic. Control over this hardware is delegated to one of your colleagues.
1.3.3. Administration Guide Example Workflow: Newly Virtualized Workload
You have recently virtualized an important workload. You need to maximize the uptime of the virtual machine it runs on. You clone the virtual machine to a template so that it is easy to re-provision if necessary. You hand control of the virtual machine and the cluster it runs on to another administrator.
1.3.4. Administration Guide Example Workflow: Template for Group Use
You have a group of users who want to provision virtual machines running Red Hat Enterprise Linux 6. You have to add an ISO storage domain and upload an ISO to it. You install Red Hat Enterprise Linux 6 on a virtual machine, and make a template out of it. You make the group template users.
Chapter 2. Basics
2.1. Introduction
- 2.1.1. Red Hat Enterprise Virtualization Architecture
- 2.1.2. Red Hat Enterprise Virtualization System Components
- 2.1.3. Red Hat Enterprise Virtualization Resources
- 2.1.4. Red Hat Enterprise Virtualization API Support Statement
- 2.1.5. SPICE
- 2.1.6. Administering and Maintaining the Red Hat Enterprise Virtualization Environment
2.1.1. Red Hat Enterprise Virtualization Architecture
A Red Hat Enterprise Virtualization environment consists of:
- Virtual machine hosts using the Kernel-based Virtual Machine (KVM).
- Agents and tools running on hosts including VDSM, QEMU, and libvirt. These tools provide local management for virtual machines, networks and storage.
- The Red Hat Enterprise Virtualization Manager; a centralized management platform for the Red Hat Enterprise Virtualization environment. It provides a graphical interface where you can view, provision and manage resources.
- Storage domains to hold virtual resources like virtual machines, templates, ISOs.
- A database to track the state of and changes to the environment.
- Access to an external Directory Server to provide users and authentication.
- Networking to link the environment together. This includes physical network links, and logical networks.
2.1.2. Red Hat Enterprise Virtualization System Components
The Red Hat Enterprise Virtualization version 3.3 environment consists of one or more hosts (either Red Hat Enterprise Linux 6.5 or later hosts or Red Hat Enterprise Virtualization Hypervisor 6.5 or later hosts) and at least one Red Hat Enterprise Virtualization Manager.
Hosts run virtual machines using KVM (Kernel-based Virtual Machine) virtualization technology.
The Red Hat Enterprise Virtualization Manager runs on a Red Hat Enterprise Linux 6 server and provides interfaces for controlling the Red Hat Enterprise Virtualization environment. It manages virtual machine and storage provisioning, connection protocols, user sessions, virtual machine images, and high availability virtual machines.
The Red Hat Enterprise Virtualization Manager is accessed through the Administration Portal using a web browser.
2.1.3. Red Hat Enterprise Virtualization Resources
The components of the Red Hat Enterprise Virtualization environment fall into two categories: physical resources, and logical resources. Physical resources are physical objects, such as host and storage servers. Logical resources are nonphysical groupings and processes, such as logical networks and virtual machine templates.
- Data Center - A data center is the highest level container for all physical and logical resources within a managed virtual environment. It is a collection of clusters, virtual machines, storage, and networks.
- Clusters - A cluster is a set of physical hosts that are treated as a resource pool for virtual machines. Hosts in a cluster share the same network infrastructure and storage. They form a migration domain within which virtual machines can be moved from host to host.
- Logical Networks - A logical network is a logical representation of a physical network. Logical networks group network traffic and communication between the Manager, hosts, storage, and virtual machines.
- Hosts - A host is a physical server that runs one or more virtual machines. Hosts are grouped into clusters. Virtual machines can be migrated from one host to another within a cluster.
- Storage Pool - The storage pool is a logical entity that contains a standalone image repository of a certain type, either iSCSI, Fibre Channel, NFS, or POSIX. Each storage pool can contain several domains, for storing virtual machine disk images, ISO images, and for the import and export of virtual machine images.
- Virtual Machines - A virtual machine is a virtual desktop or virtual server containing an operating system and a set of applications. Multiple identical virtual machines can be created in a Pool. Virtual machines are created, managed, or deleted by power users and accessed by users.
- Template - A template is a model virtual machine with predefined settings. A virtual machine that is based on a particular template acquires the settings of the template. Using templates is the quickest way of creating a large number of virtual machines in a single step.
- Virtual Machine Pool - A virtual machine pool is a group of identical virtual machines that are available on demand by each group member. Virtual machine pools can be set up for different purposes. For example, one pool can be for the Marketing department, another for Research and Development, and so on.
- Snapshot - A snapshot is a view of a virtual machine's operating system and all its applications at a point in time. It can be used to save the settings of a virtual machine before an upgrade or installing new applications. In case of problems, a snapshot can be used to restore the virtual machine to its original state.
- User Types - Red Hat Enterprise Virtualization supports multiple levels of administrators and users with distinct levels of permissions. System administrators can manage objects of the physical infrastructure, such as data centers, hosts, and storage. Users access virtual machines available from a virtual machine pool or standalone virtual machines made accessible by an administrator.
- Events and Monitors - Alerts, warnings, and other notices about activities help the administrator to monitor the performance and status of resources.
- Reports - A range of reports either from the reports module based on JasperReports, or from the data warehouse. Preconfigured or ad hoc reports can be generated from the reports module. Users can also generate reports using any query tool that supports SQL from a data warehouse that collects monitoring data for hosts, virtual machines, and storage.
2.1.4. Red Hat Enterprise Virtualization API Support Statement
Red Hat Enterprise Virtualization exposes a number of interfaces for interacting with the components of the virtualization environment. These interfaces are in addition to the user interfaces provided by the Red Hat Enterprise Virtualization Manager Administration, User, and Reports Portals. Many of these interfaces are fully supported. Some however are supported only for read access or only when your use of them has been explicitly requested by Red Hat Support.
Supported Interfaces for Read and Write Access
Direct interaction with these interfaces is supported and encouraged for both read and write access:
- Representational State Transfer (REST) API
- The REST API exposed by the Red Hat Enterprise Virtualization Manager is a fully supported interface for interacting with Red Hat Enterprise Virtualization Manager.
- Software Development Kit (SDK)
- The SDK provided by the rhevm-sdk package is a fully supported interface for interacting with Red Hat Enterprise Virtualization Manager.
- Command Line Shell
- The command line shell provided by the rhevm-cli package is a fully supported interface for interacting with the Red Hat Enterprise Virtualization Manager.
- VDSM Hooks
- The creation and use of VDSM hooks to trigger modification of virtual machines based on custom properties specified in the Administration Portal is supported on Red Hat Enterprise Linux virtualization hosts. The use of VDSM Hooks on virtualization hosts running Red Hat Enterprise Virtualization Hypervisor is not currently supported.
Supported Interfaces for Read Access
Direct interaction with these interfaces is supported and encouraged only for read access. Use of these interfaces for write access is not supported unless explicitly requested by Red Hat Support:
- Red Hat Enterprise Virtualization Manager History Database
- Read access to the Red Hat Enterprise Virtualization Manager history database using the database views specified in the Administration Guide is supported. Write access is not supported.
- Libvirt on Virtualization Hosts
- Read access to
libvirtusing thevirsh -rcommand is a supported method of interacting with virtualization hosts. Write access is not supported.
Unsupported Interfaces
Direct interaction with these interfaces is not supported unless your use of them is explicitly requested by Red Hat Support:
- The vdsClient Command
- Use of the
vdsClientcommand to interact with virtualization hosts is not supported unless explicitly requested by Red Hat Support. - Red Hat Enterprise Virtualization Hypervisor Console
- Console access to Red Hat Enterprise Virtualization Hypervisor outside of the provided text user interface for configuration is not supported unless explicitly requested by Red Hat Support.
- Red Hat Enterprise Virtualization Manager Database
- Direct access to and manipulation of the Red Hat Enterprise Virtualization Manager database is not supported unless explicitly requested by Red Hat Support.
Important
Red Hat Support will not debug user created scripts or hooks except where it can be demonstrated that there is an issue with the interface being used rather than the user created script itself. For more general information about Red Hat support policies see https://access.redhat.com/support/offerings/production/soc.html.
2.1.5. SPICE
The SPICE (Simple Protocol for Independent Computing Environments) protocol facilitates graphical connections to virtual machines. The SPICE protocol allows:
- video at more than 30 frames per second
- bidirectional audio (for softphones/IP phones)
- bidirectional video (for video telephony/video conferencing)
- connection to multiple monitors with a single virtual machine
- USB redirection from the client's USB port into the virtual machine
- connection to a proxy from outside of the network the hypervisor is attached to
2.1.6. Administering and Maintaining the Red Hat Enterprise Virtualization Environment
The Red Hat Enterprise Virtualization environment requires an administrator to keep it running. As an administrator, your tasks include:
- Managing physical and virtual resources such as hosts and virtual machines. This includes upgrading and adding hosts, importing domains, converting virtual machines created on foreign hypervisors, and managing virtual machine pools.
- Monitoring the overall system resources for potential problems such as extreme load on one of the hosts, insufficient memory or disk space, and taking any necessary actions (such as migrating virtual machines to other hosts to lessen the load or freeing resources by shutting down machines).
- Responding to the new requirements of virtual machines (for example, upgrading the operating system or allocating more memory).
- Managing customized object properties using tags.
- Managing searches saved as public bookmarks.
- Managing user setup and setting permission levels.
- Troubleshooting for specific users or virtual machines for overall system functionality.
- Generating general and specific reports.
2.2. Using the Administration Portal Graphical Interface
2.2.1. Red Hat Enterprise Virtualization Manager Client Requirements
Use a client with a supported web browser to access the Administration Portal, and the User Portal. The portals support the following clients and browsers:
- Mozilla Firefox 17, and later, on Red Hat Enterprise Linux is required to access both portals.
- Internet Explorer 8, and later, on Microsoft Windows is required to access the User Portal. Use the desktop version, not the touchscreen version of Internet Explorer 10.
- Internet Explorer 9, and later, on Microsoft Windows is required to access the Administration Portal. Use the desktop version, not the touchscreen version of Internet Explorer 10.
Install a supported SPICE client to access virtual machine consoles. Supported SPICE clients are available on the following operating systems:
- Red Hat Enterprise Linux 5.8+ (i386, AMD64 and Intel 64)
- Red Hat Enterprise Linux 6.2+ (i386, AMD64 and Intel 64)
- Red Hat Enterprise Linux 6.5+ (i386, AMD64 and Intel 64)
- Windows XP
- Windows XP Embedded (XPe)
- Windows 7 (x86, AMD64 and Intel 64)
- Windows 8 (x86, AMD64 and Intel 64)
- Windows Embedded Standard 7
- Windows 2008/R2 (x86, AMD64 and Intel 64)
- Windows Embedded Standard 2009
- Red Hat Enterprise Virtualization Certified Linux-based thin clients
Note
Check the Red Hat Enterprise Virtualization Manager Release Notes to see which SPICE features your client supports.
When you access the portal(s) using Mozilla Firefox the SPICE client is provided by the spice-xpi package, which you must manually install using
yum.
When you access the portal(s) using Internet Explorer the SPICE ActiveX control will automatically be downloaded and installed.
2.2.2. Graphical User Interface Elements
The Red Hat Enterprise Virtualization Administration Portal consists of contextual panes and menus and can be used in two modes, tree mode and flat mode. Tree mode allows you to browse the object hierarchy of a data center and is the recommended manner of operation. The elements of the GUI are shown in the diagram below.
User Interface Elements
Header
The Header bar contains the name of the current logged in user and the button. The button shows version information. The button allows you to configure user roles. The button provides a shortcut to the book you are reading now.
Search Bar
The Search bar allows you to build queries to find the resources that you need. Queries can be as simple as a list of all the hosts in the system, or much more complex. As you type each part of the search query, you are offered choices to assist you in building the search. The star icon can be used to save the search as a bookmark.
Resource Tabs
All resources, such as hosts and clusters, can be managed using the appropriate tab. Additionally, the Events tabs allow you to view events for each resource.The Administration Portal provides the following tabs: Data Centers, Clusters, Hosts, Storage, Disks, Virtual Machines, Pools, Templates, Users, and Events, and a Dashboard tab if you have installed the Data Warehouse and Reporting services.
Results List
Perform a task on an individual item, multiple items, or all the items in the results list, by selecting the item(s) and then clicking the relevant action button. Information on a selected item is displayed in the details pane.
Details Pane
The Details pane shows detailed information about a selected item in the results list. If multiple items are selected, the details pane displays information on the first selected item only.
Tree/Bookmarks/Tags Pane
The Tree pane displays a navigable hierarchy of the resources in the virtualized environment.Bookmarks are used to save frequently used or complicated searches for repeated use. Bookmarks can be added, edited, or removed.Tags are applied to groups of resources and are used to search for all resources associated with that tag.
Alerts/Events Pane
The Alerts tab lists all high severity events such as errors or warnings. The Events tab shows an audit of events for all resources. The Tasks tab lists the current running tasks. You can view this panel by clicking the maximize/ minimize button.
Important
The minimum supported resolution viewing the Administration Portal in a web browser is 1024x768. The Administration Portal will not render correctly when viewed at a lower resolution.
2.2.3. Tree Mode and Flat Mode
The Administration Portal provides two different modes for managing your resources: tree mode and flat mode. Tree mode displays resources in a hierarchical view per data center, from the highest level of the data center down to the individual virtual machine. Working in tree mode is highly recommended for most operations.
Flat mode allows you to search across data centers, or storage domains. It does not limit you to viewing the resources of a single hierarchy. For example, you may need to find all virtual machines that are using more than 80% CPU across clusters and data centers, or locate all hosts that have the highest utilization. Flat mode makes this possible. In addition, certain objects, such as Pools and Users are not in the data center hierarchy and can be accessed only in flat mode.
To access flat mode, click on the System item in the Tree pane on the left side of the screen. You are in flat mode if the Pools and Users resource tabs appear.
2.2.4. Using the Guide Me Facility
When setting up resources such as data centers and clusters, a number of tasks must be completed in sequence. The context-sensitive Guide Me window prompts for actions that are appropriate to the resource being configured. The Guide Me window can be accessed at any time by clicking the button on the resource toolbar.
2.2.5. Performing Searches in Red Hat Enterprise Virtualization
The Administration Portal enables the management of thousands of resources, such as virtual machines, hosts, users, and more. To perform a search, enter the search query (free-text or syntax-based) in the search bar. Search queries can be saved as bookmarks for future reuse, so you do not have to reenter a search query each time the specific search results are needed.
See Also:
2.2.6. Saving a Query String as a Bookmark
Summary
A bookmark can be used to remember a search query, and shared with other users.
Procedure 2.1. Saving a Query String as a Bookmark
- Enter the desired search query in the search bar and perform the search.
- Click the star-shaped button to the right of the search bar to open the New Bookmark window.
- Enter the Name of the bookmark.
- Edit the Search string field (if applicable).
- Click to save the query as a bookmark and close the window.
- The search query is saved and displays in the Bookmarks pane.
Result
You have saved a search query as a bookmark for future reuse. Use the Bookmark pane to find and select the bookmark.
Part I. Administering the Resources
Table of Contents
- 3. Data Centers
- 4. Clusters
- 5. Logical Networks
- 6. Hosts
- 7. Storage Domains
- 7.1. Understanding Storage Domains
- 7.2. Storage Metadata Versions in Red Hat Enterprise Virtualization
- 7.3. Preparing and Adding File-based Storage
- 7.4. Preparing and Adding Red Hat Storage (GlusterFS) Storage Domains
- 7.5. Adding POSIX Compliant File System Storage
- 7.6. Preparing and Adding Block-based Storage
- 7.7. Storage Tasks
- 7.8. Storage and Permissions
- 8. Virtual Machines
- 8.1. Introduction to Virtual Machines
- 8.2. Supported Virtual Machine Operating Systems
- 8.3. Virtual Machine Performance Parameters
- 8.4. Creating Virtual Machines
- 8.5. Using Virtual Machines
- 8.6. Shutting Down or Pausing Virtual Machines
- 8.7. Managing Virtual Machines
- 8.8. Virtual Machines and Permissions
- 8.9. Backing Up and Restoring Virtual Machines with Snapshots
- 8.10. Importing and Exporting Virtual Machines
- 8.11. Migrating Virtual Machines Between Hosts
- 8.12. Improving Uptime with Virtual Machine High Availability
- 8.13. Other Virtual Machine Tasks
- 9. Templates
- 10. Pools
- 11. Virtual Machine Disks
- 12. Red Hat Storage (GlusterFS) Volumes
- 13. External Providers
- 13.1. Introduction to External Providers in Red Hat Enterprise Virtualization
- 13.2. Enabling the Authentication of OpenStack Providers
- 13.3. Adding an External Provider
- 13.4. Removing an External Provider
- 13.5. Explanation of Settings and Controls in the Add Provider Window
- 13.6. Explanation of Settings and Controls in the Edit Provider Window
Chapter 3. Data Centers
3.1. Introduction to Data Centers
A data center is a logical entity that defines the set of resources used in a specific environment. A data center is considered a container resource, in that it is comprised of logical resources, in the form of clusters and hosts; network resources, in the form of logical networks and physical NICs; and storage resources, in the form of storage domains.
A data center can contain multiple clusters, which can contain multiple hosts; it can have multiple storage domains associated to it; and it can support multiple virtual machines on each of its hosts. A Red Hat Enterprise Virtualization environment can contain multiple data centers; the data center infrastructure allows you to keep these centers separate.
All data centers are managed from the single Administration Portal.
Red Hat Enterprise Virtualization creates a default data center during installation. It is recommended that you do not remove the default data center; instead, set up new appropriately named data centers.
3.2. The Storage Pool Manager (SPM)
The Storage Pool Manager (SPM) is a role given to one of the hosts in the data center enabling it to manage the storage domains of the data center. The SPM entity can be run on any host in the data center; the Red Hat Enterprise Virtualization Manager grants the role to one of the hosts. The SPM does not preclude the host from its standard operation; a host running as SPM can still host virtual resources.
The SPM entity controls access to storage by coordinating the metadata across the storage domains. This includes creating, deleting, and manipulating virtual disks (images), snapshots, and templates, and allocating storage for sparse block devices (on SAN). This is an exclusive responsibility: only one host can be the SPM in the data center at one time to ensure metadata integrity.
The Red Hat Enterprise Virtualization Manager ensures that the SPM is always available. The Manager moves the SPM role to a different host if the SPM host encounters problems accessing the storage. When the SPM starts, it ensures that it is the only host granted the role; therefore it will acquire a storage-centric lease. This process can take some time.
See Also:
3.3. SPM Priority
The SPM role uses some of a host's available resources. The SPM priority setting of a host alters the likelihood of the host being assigned the SPM role: a host with high SPM priority will be assigned the SPM role before a host with low SPM priority. Critical virtual machines on hosts with low SPM priority will not have to contend with SPM operations for host resources.
You can change a host's SPM priority by editing the host.
3.4. Using the Events Tab to Identify Problem Objects in Data Centers
The Events tab for a data center displays all events associated with that data center; events include audits, warnings, and errors. The information displayed in the results list will enable you to identify problem objects in your Red Hat Enterprise Virtualization environment.
The Events results list has two views: Basic and Advanced. Basic view displays the event icon, the time of the event, and the description of the events. Advanced view displays these also and includes, where applicable, the event ID; the associated user, host, virtual machine, template, data center, storage, and cluster; the Gluster volume, and the correlation ID.
3.5. Data Center Tasks
- 3.5.1. Creating a New Data Center
- 3.5.2. Explanation of Settings in the New Data Center and Edit Data Center Windows
- 3.5.3. Editing a Resource
- 3.5.4. Creating a New Logical Network in a Data Center or Cluster
- 3.5.5. Re-Initializing a Data Center: Recovery Procedure
- 3.5.6. Removing a Data Center
- 3.5.7. Force Removing a Data Center
3.5.1. Creating a New Data Center
Summary
This procedure creates a data center in your virtualization environment. The data center requires a functioning cluster, host, and storage domain to operate.
Note
The storage Type can be edited until the first storage domain is added to the data center. Once a storage domain has been added, the storage Type cannot be changed.
If you set the Compatibility Version as 3.1, it cannot be changed to 3.0 at a later time; version regression is not allowed.
Procedure 3.1. Creating a New Data Center
- Select the Data Centers resource tab to list all data centers in the results list.
- Click to open the New Data Center window.
- Enter the Name and Description of the data center.
- Select the storage Type, Compatibility Version, and Quota Mode of the data center from the drop-down menus.
- Click to create the data center and open the New Data Center - Guide Me window.
- The Guide Me window lists the entities that need to be configured for the data center. Configure these entities or postpone configuration by clicking the button; configuration can be resumed by selecting the data center and clicking the button.
Result
The new data center is added to the virtualization environment. It will remain Uninitialized until a cluster, host, and storage domain is configured for it; use Guide Me to configure these entities.
See Also:
3.5.2. Explanation of Settings in the New Data Center and Edit Data Center Windows
The table below describes the settings of a data center as displayed in the New Data Center and Edit Data Center windows. Invalid entries are outlined in orange when you click , prohibiting the changes being accepted. In addition, field prompts indicate the expected values or range of values.
Table 3.1. Data Center Properties
|
Field
|
Description/Action
|
|---|---|
|
Name
|
The name of the data center. This text field has a 40-character limit and must be a unique name with any combination of uppercase and lowercase letters, numbers, hyphens, and underscores.
|
|
Description
| The description of the data center. This field is recommended but not mandatory. |
|
Type
| The storage type. Choose one of
|
|
Compatibility Version
| The version of Red Hat Enterprise Virtualization. Choose one of:
|
|
Quota Mode
| Quota is a resource limitation tool provided with Red Hat Enterprise Virtualization. Choose one of:
|
3.5.3. Editing a Resource
Summary
Edit the properties of a resource.
Procedure 3.2. Editing a Resource
- Use the resource tabs, tree mode, or the search function to find and select the resource in the results list.
- Click to open the Edit window.
- Change the necessary properties and click .
Result
The new properties are saved to the resource. The Edit window will not close if a property field is invalid.
See Also:
3.5.4. Creating a New Logical Network in a Data Center or Cluster
Summary
Create a logical network and define its use in a data center, or in clusters in a data center.
Procedure 3.3. Creating a New Logical Network in a Data Center or Cluster
- Use the Data Centers or Clusters resource tabs, tree mode, or the search function to find and select a data center or cluster in the results list.
- Click the Logical Networks tab of the details pane to list the existing logical networks.
- From the Data Centers details pane, click to open the New Logical Network window.From the Clusters details pane, click to open the New Logical Network window.
- Enter a Name, Description and Comment for the logical network.
- In the Export section, select the Create on external provider check box to create the logical network on an external provider. Select the external provider from the External Provider drop-down list and enter a Network Label for the logical network.
- Select the Enable VLAN tagging, VM network and Override MTU to enable these options.
- From the Cluster tab, select the clusters to which the network will be assigned. You can also specify whether the logical network will be a required network.
- From the Profiles tab, add vNIC profiles to the logical network as required.
- Click OK.
Result
You have defined this logical network as a resource required by a cluster or clusters in the data center. You can now add this resource to the hosts in the cluster.
Note
When creating a new logical network or making changes to an existing logical network that is used as a display network, any running virtual machines that use that network must be rebooted before the network becomes available or the changes are applied.
3.5.5. Re-Initializing a Data Center: Recovery Procedure
Summary
This recovery procedure replaces the master data domain of your data center with a new master data domain; necessary in the event of data corruption of your master data domain. Re-initializing a data center allows you to restore all other resources associated with the data center, including clusters, hosts, and non-problematic storage domains.
You can import any backup or exported virtual machines or templates into your new master data domain.
Procedure 3.4. Re-Initializing a Data Center
- Click the Data Centers resource tab and select the data center to re-initialize.
- Ensure that any storage domains attached to the data center are in maintenance mode.
- Right-click the data center and select Re-Initialize Data Center from the drop-down menu to open the Data Center Re-Initialize window.
- The Data Center Re-Initialize window lists all available (detached; in maintenance mode) storage domains. Click the radio button for the storage domain you are adding to the data center.
- Select the Approve operation check box.
- Click to close the window and re-initialize the data center.
Result
The storage domain is attached to the data center as the master data domain and activated. You can now import any backup or exported virtual machines or templates into your new master data domain.
3.5.6. Removing a Data Center
Summary
An active host is required to remove a data center. Removing a data center will not remove the associated resources.
Procedure 3.5. Removing a Data Center
- Ensure the storage domains attached to the data center is in maintenance mode.
- Click the Data Centers resource tab and select the data center to remove.
- Click to open the Remove Data Center(s) confirmation window.
- Click .
Result
The data center has been removed.
3.5.7. Force Removing a Data Center
Summary
A data center becomes Non Responsive if the attached storage domain is corrupt or if the host becomes Non Responsive. You cannot Remove the data center under either circumstance.
Force Remove does not require an active host. It also permanently removes the attached storage domain.
It may be necessary to Destroy a corrupted storage domain before you can Force Remove the data center.
Procedure 3.6. Force Removing a Data Center
- Click the Data Centers resource tab and select the data center to remove.
- Click Force Remove to open the Force Remove Data Center confirmation window.
- Select the Approve operation check box.
- Click OK
Result
The data center and attached storage domain are permanently removed from the Red Hat Enterprise Virtualization environment.
3.6. Data Centers and Storage Domains
3.6.1. Attaching an Existing Data Domain to a Data Center
Prerequisites:
Summary
Data domains that are Unattached can be attached to a data center. The data domain must be of the same Storage Type as the data center.
Procedure 3.7. Attaching an Existing Data Domain to a Data Center
- Click the Data Centers resource tab and select the appropriate data center.
- Select the Storage tab in the details pane to list the storage domains already attached to the data center.
- Click to open the Attach Storage window.
- Select the check box for the data domain to attach to the data center. You can select multiple check boxes to attach multiple data domains.
- Click .
Result
The data domain is attached to the data center and is automatically activated.
3.6.2. Attaching an Existing ISO domain to a Data Center
Summary
An ISO domain that is Unattached can be attached to a data center. The ISO domain must be of the same Storage Type as the data center.
Only one ISO domain can be attached to a data center.
Procedure 3.8. Attaching an Existing ISO Domain to a Data Center
- Click the Data Centers resource tab and select the appropriate data center.
- Select the Storage tab in the details pane to list the storage domains already attached to the data center.
- Click to open the Attach ISO Library window.
- Click the radio button for the appropriate ISO domain.
- Click .
Result
The ISO domain is attached to the data center and is automatically activated.
3.6.3. Attaching an Existing Export Domain to a Data Center
Summary
An export domain that is Unattached can be attached to a data center.
Only one export domain can be attached to a data center.
Procedure 3.9. Attaching an Existing Export Domain to a Data Center
- Click the Data Centers resource tab and select the appropriate data center.
- Select the Storage tab in the details pane to list the storage domains already attached to the data center.
- Click to open the Attach Export Domain window.
- Click the radio button for the appropriate Export domain.
- Click .
Result
The Export domain is attached to the data center and is automatically activated.
3.6.4. Detaching a Storage Domain from a Data Center
Summary
Detaching a storage domain from a data center will stop the data center from associating with that storage domain. The storage domain is not removed from the Red Hat Enterprise Virtualization environment; it can be attached to another data center.
Data, such as virtual machines and templates, remains attached to the storage domain.
Note
The master storage, if it is the last available storage domain, cannot be removed.
Procedure 3.10. Detaching a Storage Domain from a Data Center
- Click the Data Centers resource tab and select the appropriate data center.
- Select the Storage tab in the details pane to list the storage domains attached to the data center.
- Select the storage domain to detach. If the storage domain is
Active, click to move the domain into maintenance mode. - Click to open the Detach Storage confirmation window.
- Click .
Result
You have detached the storage domain from the data center. It can take up to several minutes for the storage domain to disappear from the details pane.
3.6.5. Activating a Storage Domain from Maintenance Mode
Summary
Storage domains in maintenance mode must be activated to be used.
Procedure 3.11. Activating a Data Domain from Maintenance Mode
- Click the Data Centers resource tab and select the appropriate data center.
- Select the Storage tab in the details pane to list the storage domains attached to the data center.
- Select the appropriate storage domain and click .
Result
The storage domain is activated and can be used in the data center.
3.7. Data Centers and Permissions
3.7.1. Managing System Permissions for a Data Center
The system administrator, as the SuperUser, manages all aspects of the Administration Portal. More specific administrative roles can be assigned to other users. These restricted administrator roles are useful for empowering a user with certain administrative privileges that limit them to a specific resource: a DataCenterAdmin role has administrator privileges only for the assigned data center, a ClusterAdmin has administrator privileges only for the assigned cluster, a StorageAdmin has administrator privileges only for the assigned storage domain, and so forth.
A data center administrator is a system administration role for a specific data center only. This is useful in virtualized environments with multiple data center, where each data center requires a system administrator. The DataCenterAdmin role is a hierarchical model: a user assigned the data center administrator role for a data center can manage all objects in the data center. Use the button in the header bar to assign a data center administrator for all data centers in the environment.
The data center administrator role permits the following actions:
- Create and remove clusters associated with the data center;
- Add and remove hosts, virtual machines, and pools associated with the data center; and
- Edit user permissions for virtual machines associated with the data center.
Note
You can only assign roles and permissions to existing users.
You can change the system administrator of a data center by removing the existing system administrator and adding the new system administrator.
3.7.2. Data Center Administrator Roles Explained
Data Center Permission Roles
The table below describes the administrator roles and privileges applicable to data center administration.
Table 3.2. Red Hat Enterprise Virtualization System Administrator Roles
| Role | Privileges | Notes |
|---|---|---|
| DataCenterAdmin | Data Center Administrator | Can use, create, delete, manage all physical and virtual resources within a specific data center, including clusters, hosts, templates and virtual machines. |
| NetworkAdmin | Network Administrator | Can configure and manage the network of a particular data center. A network administrator of a data center inherits network permissions for virtual machines within the data center as well. |
3.7.3. Assigning an Administrator or User Role to a Resource
Summary
Assign administrator or user roles to resources to allow users to access or manage that resource.
Procedure 3.12. Assigning a Role to a Resource
- Use the resource tabs, tree mode, or the search function to find and select the resource in the results list.
- Click the tab of the details pane to list the assigned users, the user's role, and the inherited permissions for the selected resource.
- Click to open the Add Permission to User window.
- Enter the name or user name of an existing user into the Search text box and click . Select a user from the resulting list of possible matches.
- Select a role from the Role to Assign: drop-down menu.
- Click to assign the role and close the window.
Result
You have assigned a role to a user; the user now has the inherited permissions of that role enabled for that resource.
3.7.4. Removing an Administrator or User Role from a Resource
Summary
Remove an administrator or user role from a resource; the user loses the inherited permissions associated with the role for that resource.
Procedure 3.13. Removing a Role from a Resource
- Use the resource tabs, tree mode, or the search function to find and select the resource in the results list.
- Click the tab of the details pane to list the assigned users, the user's role, and the inherited permissions for the selected resource.
- Select the user to remove from the resource.
- Click . The Remove Permission window opens to confirm permissions removal.
- Click to remove the user role.
Result
You have removed the user's role, and the associated permissions, from the resource.
Chapter 4. Clusters
4.1. Introduction to Clusters
A cluster is a logical grouping of hosts that share the same storage domains and have the same type of CPU (either Intel or AMD). If the hosts have different generations of CPU models, they use only the features present in all models.
Each cluster in the system must belong to a data center, and each host in the system must belong to a cluster. Virtual machines are dynamically allocated to any host in a cluster and can be migrated between them, according to policies defined on the Clusters tab and in the Configuration tool during runtime. The cluster is the highest level at which power and load-sharing policies can be defined.
Clusters run virtual machines or Red Hat Storage Servers. These two purposes are mutually exclusive: A single cluster cannot support virtualization and storage hosts together.
The Red Hat Enterprise Virtualization platform installs a default cluster in the default data center by default during the installation process.
See Also:
4.2. Cluster Tasks
- 4.2.1. Creating a New Cluster
- 4.2.2. Explanation of Settings and Controls in the New Cluster and Edit Cluster Windows
- 4.2.3. Editing a Resource
- 4.2.4. Importing an Existing Red Hat Storage Cluster
- 4.2.5. Explanation of Settings in the Add Hosts Window
- 4.2.6. Setting Load and Power Management Policies for Hosts in a Cluster
- 4.2.7. Creating a New Logical Network in a Data Center or Cluster
- 4.2.8. Removing a Cluster
- 4.2.9. Designate a Specific Traffic Type for a Logical Network with the Manage Networks Window
- 4.2.10. Explanation of Settings in the Manage Networks Window
4.2.1. Creating a New Cluster
Prerequisites:
Summary
A data center can contain multiple clusters, and a cluster can contain multiple hosts. All hosts in a cluster must be of the same CPU type (Intel or AMD). It is recommended that you create your hosts before you create your cluster to ensure CPU type optimization. However, you can configure the hosts at a later time using the button.
Procedure 4.1. Creating a New Cluster
- Select the Clusters resource tab.
- Click to open the New Cluster window.
- Select the Data Center the cluster will belong to from the drop-down list.
- Enter the Name and Description of the cluster.
- Select the CPU Name and Compatibility Version from the drop-down lists. It is important to match the CPU processor family with the minimum CPU processor type of the hosts you intend to attach to the cluster, otherwise the host will be non-operational.
- Select either the Enable Virt Service or Enable Gluster Service radio box depending on whether the cluster should be populated with virtual machine hosts or Gluster-enabled nodes. Note that you cannot add Red Hat Enterprise Virtualization Hypervisor hosts to a Gluster-enabled cluster.
- Click the Optimization tab to select the memory page sharing threshold for the cluster, and optionally enable CPU thread handling and memory ballooning on the hosts in the cluster.
- Click the Cluster Policy tab to optionally configure a cluster policy, scheduler optimization settings, and enable trusted service for hosts in the cluster.
- Click the Resilience Policy tab to select the virtual machine migration policy.
- Click to create the cluster and open the New Cluster - Guide Me window.
- The Guide Me window lists the entities that need to be configured for the cluster. Configure these entities or postpone configuration by clicking the button; configuration can be resumed by selecting the cluster and clicking the button.
Result
The new cluster is added to the virtualization environment.
See Also:
4.2.2. Explanation of Settings and Controls in the New Cluster and Edit Cluster Windows
4.2.2.1. General Cluster Settings Explained
The table below describes the settings for the General tab in the New Cluster and Edit Cluster windows. Invalid entries are outlined in orange when you click OK, prohibiting the changes being accepted. In addition, field prompts indicate the expected values or range of values.
Table 4.1. General Cluster Settings
|
Field
|
Description/Action
|
|---|---|
|
Data Center
|
The data center that will contain the cluster.
|
|
Name
|
The name of the cluster. This text field has a 40-character limit and must be a unique name with any combination of uppercase and lowercase letters, numbers, hyphens, and underscores.
|
|
Description
| The description of the cluster. This field is recommended but not mandatory. |
|
CPU Name
| The CPU type of the cluster. Choose one of:
|
|
Compatibility Version
| The version of Red Hat Enterprise Virtualization. Choose one of:
|
|
Enable Virt Service
| If this radio button is selected, hosts in this cluster will be used to run virtual machines. |
|
Enable Gluster Service
| If this radio button is selected, hosts in this cluster will be used as Red Hat Storage Server nodes, and not for running virtual machines. You cannot add a Red Hat Enterprise Virtualization Hypervisor host to a cluster with this option enabled. |
|
Import existing gluster configuration
|
This check box is only available if the Enable Gluster Service radio button is selected. This option allows you to import an existing Gluster-enabled cluster and all its attached hosts to Red Hat Enterprise Virtualization Manager.
The following options are required for each host in the cluster that is being imported:
|
4.2.2.2. Optimization Settings Explained
Memory page sharing allows virtual machines to use up to 200% of their allocated memory by utilizing unused memory in other virtual machines. This process is based on the assumption that the virtual machines in your Red Hat Enterprise Virtualization environment will not all be running at full capacity at the same time, allowing unused memory to be temporarily allocated to a particular virtual machine.
CPU Thread Handling allows hosts to run virtual machines with a total number of processor cores greater than number of cores in the host. This is useful for non-CPU-intensive workloads, where allowing a greater number of virtual machines to run can reduce hardware requirements. It also allows virtual machines to run with CPU topologies that would otherwise not be possible, specifically if the number of guest cores is between the number of host cores and number of host threads.
The table below describes the settings for the Optimization tab in the New Cluster and Edit Cluster windows.
Table 4.2. Optimization Settings
|
Field
|
Description/Action
|
|---|---|
|
Memory Optimization
|
|
|
CPU Threads
|
Selecting the Count Threads As Cores check box allows hosts to run virtual machines with a total number of processor cores greater than the number of cores in the host.
The exposed host threads would be treated as cores which can be utilized by virtual machines. For example, a 24-core system with 2 threads per core (48 threads total) can run virtual machines with up to 48 cores each, and the algorithms to calculate host CPU load would compare load against twice as many potential utilized cores.
|
|
Memory Balloon
|
Selecting the Enable Memory Balloon Optimization check box enables memory overcommitment on virtual machines running on the hosts in this cluster. When this option is set, the Memory Overcommit Manager (MoM) will start ballooning where and when possible, with a limitation of the guaranteed memory size of every virtual machine.
To have a balloon running, the virtual machine needs to have a balloon device with relevant drivers. Each virtual machine in cluster level 3.2 and higher includes a balloon device, unless specifically removed. Each host in this cluster receives a balloon policy update when its status changes to
Up.
It is important to understand that in some scenarios ballooning may collide with KSM. In such cases MoM will try to adjust the balloon size to minimize collisions. Additionally, in some scenarios ballooning may cause sub-optimal performance for a virtual machine. Administrators are advised to use ballooning optimization with caution.
|
4.2.2.3. Resilience Policy Settings Explained
The resilience policy sets the virtual machine migration policy in the event of host failure. Virtual machines running on a host that unexpectedly shuts down or is put into maintenance mode are migrated to other hosts in the cluster; this migration is dependent upon your cluster policy.
Note
Virtual machine migration is a network-intensive operation. For instance, on a setup where a host is running ten or more virtual machines, migrating all of them can be a long and resource-consuming process. Therefore, select the policy action to best suit your setup. If you prefer a conservative approach, disable all migration of virtual machines. Alternatively, if you have many virtual machines, but only several which are running critical workloads, select the option to migrate only highly available virtual machines.
The table below describes the settings for the Resilience Policy tab in the New Cluster and Edit Cluster windows.
Table 4.3. Resilience Policy Settings
|
Field
|
Description/Action
|
|---|---|
|
Migrate Virtual Machines
|
Migrates all virtual machines in order of their defined priority.
|
|
Migrate only Highly Available Virtual Machines
|
Migrates only highly available virtual machines to prevent overloading other hosts.
|
|
Do Not Migrate Virtual Machines
| Prevents virtual machines from being migrated. |
4.2.2.4. Cluster Policy Settings Explained
Cluster policies allow you to specify the usage and distribution of virtual machines between available hosts. Define the cluster policy to enable automatic load balancing across the hosts in a cluster.
The table below describes the settings for the Edit Policy window.
Table 4.4. Cluster Policy Tab Properties
|
Field/Tab
|
Description/Action
|
|---|---|
|
None
|
Set the policy value to None to have no load or power sharing between hosts. This is the default mode.
|
|
Evenly_Distributed
|
Distributes the CPU processing load evenly across all hosts in the cluster. Additional virtual machines attached to a host will not start if that host has reached the defined Maximum Service Level.
|
|
Power_Saving
|
Distributes the CPU processing load across a subset of available hosts to reduce power consumption on underutilized hosts. Hosts with a CPU load below the low utilization value for longer than the defined time interval will migrate all virtual machines to other hosts so that it can be powered down. Additional virtual machines attached to a host will not start if that host has reached the defined high utilization value.
|
|
CpuOverCommitDurationMinutes
|
Sets the time (in minutes) that a host can run a CPU load outside of the defined utilization values before the cluster policy takes action. The defined time interval protects against temporary spikes in CPU load activating cluster policies and instigating unnecessary virtual machine migration. Maximum two characters.
|
|
HighUtilization
|
Expressed as a percentage. If the host runs with CPU usage at or above the high utilization value for the defined time interval, the Red Hat Enterprise Virtualization Manager migrates virtual machines to other hosts in the cluster until the host's CPU load is below the maximum service threshold.
|
|
LowUtilization
|
Expressed as a percentage. If the host runs below the low utilization value for the defined time interval, the Red Hat Enterprise Virtualization Manager will migrate virtual machines to other hosts in the cluster. The Manager will not power down the original host machine, which may negate any potential power saving. The original host must be powered down manually.
|
|
Enable Trusted Service
|
Enable integration with an OpenAttestation server. Before this can be enabled, use the
engine-config tool to enter the OpenAttestation server's details.
|
When a host's free memory drops below 20%, ballooning commands like
mom.Controllers.Balloon - INFO Ballooning guest:half1 from 1096400 to 1991580 are logged to /etc/vdsm/mom.conf. /etc/vdsm/mom.conf is the Memory Overcommit Manager log file.
4.2.3. Editing a Resource
Summary
Edit the properties of a resource.
Procedure 4.2. Editing a Resource
- Use the resource tabs, tree mode, or the search function to find and select the resource in the results list.
- Click to open the Edit window.
- Change the necessary properties and click .
Result
The new properties are saved to the resource. The Edit window will not close if a property field is invalid.
4.2.4. Importing an Existing Red Hat Storage Cluster
Summary
You can import a Red Hat Storage cluster and all hosts belonging to the cluster into Red Hat Enterprise Virtualization Manager.
When you provide details such as the IP address or host name and password of any host in the cluster, the
gluster peer status command is executed on that host through SSH, then displays a list of hosts that are a part of the cluster. You must manually verify the fingerprint of each host and provide passwords for them. You will not be able to import the cluster if one of the hosts in the cluster is down or unreachable. As the newly imported hosts do not have VDSM installed, the bootstrap script installs all the necessary VDSM packages on the hosts after they have been imported, and reboots them.
Important
Currently, a Red Hat Storage node can only be added to a cluster which has its compatibility level set to 3.1, 3.2, or 3.3.
Procedure 4.3. Importing an Existing Red Hat Storage Cluster to Red Hat Enterprise Virtualization Manager
- Select the Clusters resource tab to list all clusters in the results list.
- Click to open the New Cluster window.
- Select the Data Center the cluster will belong to from the drop-down menu.
- Enter the Name and Description of the cluster.
- Select the Enable Gluster Service radio button and the Import existing gluster configuration check box.The Import existing gluster configuration field is displayed only if you select Enable Gluster Service radio button.
- In the Address field, enter the hostname or IP address of any server in the cluster.The host Fingerprint displays to ensure you are connecting with the correct host. If a host is unreachable or if there is a network error, an error Error in fetching fingerprint displays in the Fingerprint field.
- Enter the Root Password for the server, and click OK.
- The Add Hosts window opens, and a list of hosts that are a part of the cluster displays.
- For each host, enter the Name and the Root Password.
- If you wish to use the same password for all hosts, select the Use a Common Password check box to enter the password in the provided text field.Click to set the entered password all hosts.Make sure the fingerprints are valid and submit your changes by clicking .
Result
The bootstrap script installs all the necessary VDSM packages on the hosts after they have been imported, and reboots them. You have now successfully imported an existing Red Hat Storage cluster into Red Hat Enterprise Virtualization Manager.
See Also:
4.2.5. Explanation of Settings in the Add Hosts Window
The Add Hosts window allows you to specify the details of the hosts imported as part of a Gluster-enabled cluster. This window appears after you have selected the Enable Gluster Service check box in the New Cluster window and provided the necessary host details.
Table 4.5. Add Gluster Hosts Settings
| Field | Description |
|---|---|
| Use a common password | Tick this check box to use the same password for all hosts belonging to the cluster. Enter the password in the Password field, then click the Apply button to set the password on all hosts. |
| Name | Enter the name of the host. |
| Hostname/IP | This field is automatically populated with the fully qualified domain name or IP of the host you provided in the New Cluster window. |
| Root Password | Enter a password in this field to use a different root password for each host. This field overrides the common password provided for all hosts in the cluster. |
| Fingerprint | The host fingerprint is displayed to ensure you are connecting with the correct host. This field is automatically populated with the fingerprint of the host you provided in the New Cluster window. |
4.2.6. Setting Load and Power Management Policies for Hosts in a Cluster
Summary
Cluster policies allow you to specify acceptable CPU usage values, both high and low, and what happens when those levels are reached. Define the cluster policy to enable automatic load balancing across the hosts in a cluster.
A host with CPU usage that exceeds the HighUtilization value will reduce its CPU processor load by migrating virtual machines to other hosts.
A host with CPU usage below its LowUtilization value will migrate all of its virtual machines to other hosts so it can be powered down until such time as it is required again.
Procedure 4.4. Setting Load and Power Management Policies for Hosts
- Use the resource tabs, tree mode, or the search function to find and select the cluster in the results list.
- Click the button to open the Edit Cluster window.
- Select one of the following policies:
- None
- Evenly_Distributed - Enter CPU utilization percentage at which virtual machines start migrating to other hosts in the HighUtilization text field.
- Power Saving - Enter the CPU utilization percentage below which the host will be considered under-utilized in the LowUtilization text field. Enter the CPU utilization percentage at which virtual machines start migrating to other hosts in the HighUtilization text field
- Specify the time interval in minutes at which the selected policy will be triggered in the CpuOverCommitDurationMinutes text field.
- If you are using an OpenAttestation server to verify your hosts, and have set up the server's details using the
engine-configtool, select the Enable Trusted Service check box. - Click .
Result
You have updated the cluster policy for the cluster.
4.2.7. Creating a New Logical Network in a Data Center or Cluster
Summary
Create a logical network and define its use in a data center, or in clusters in a data center.
Procedure 4.5. Creating a New Logical Network in a Data Center or Cluster
- Use the Data Centers or Clusters resource tabs, tree mode, or the search function to find and select a data center or cluster in the results list.
- Click the Logical Networks tab of the details pane to list the existing logical networks.
- From the Data Centers details pane, click to open the New Logical Network window.From the Clusters details pane, click to open the New Logical Network window.
- Enter a Name, Description and Comment for the logical network.
- In the Export section, select the Create on external provider check box to create the logical network on an external provider. Select the external provider from the External Provider drop-down list and enter a Network Label for the logical network.
- Select the Enable VLAN tagging, VM network and Override MTU to enable these options.
- From the Cluster tab, select the clusters to which the network will be assigned. You can also specify whether the logical network will be a required network.
- From the Profiles tab, add vNIC profiles to the logical network as required.
- Click OK.
Result
You have defined this logical network as a resource required by a cluster or clusters in the data center. You can now add this resource to the hosts in the cluster.
Note
When creating a new logical network or making changes to an existing logical network that is used as a display network, any running virtual machines that use that network must be rebooted before the network becomes available or the changes are applied.
See Also:
4.2.8. Removing a Cluster
Summary
Move all hosts out of a cluster before removing it.
Note
You cannot remove the Default cluster, as it holds the Blank template. You can however rename the Default cluster and add it to a new data center.
Procedure 4.6. Removing a Cluster
- Use the resource tabs, tree mode, or the search function to find and select the cluster in the results list.
- Ensure there are no hosts in the cluster.
- Click to open the Remove Cluster(s) confirmation window.
- Click
Result
The cluster is removed.
4.2.9. Designate a Specific Traffic Type for a Logical Network with the Manage Networks Window
Summary
Specify the traffic type for the logical network to optimize the network traffic flow.
Procedure 4.7. Assigning or Unassigning a Logical Network to a Cluster
- Use the Clusters resource tab, tree mode, or the search function to find and select the cluster in the results list.
- Select the Logical Networks tab in the details pane to list the logical networks assigned to the cluster.
- Click to open the Manage Networks window.
- Select appropriate check boxes.
- Click to save the changes and close the window.
Result
You have optimized the network traffic flow by assigning a specific type of traffic to be carried on a specific logical network.
Note
Networks offered by external providers cannot be used as display networks.
See Also:
4.2.10. Explanation of Settings in the Manage Networks Window
The table below describes the settings for the Manage Networks window.
Table 4.6. Manage Networks Settings
|
Field
|
Description/Action
|
|---|---|
|
Assign
|
Assigns the logical network to all hosts in the cluster.
|
|
Required
|
A logical network becomes operational when it is attached to an active NIC on all hosts in the cluster.
|
|
VM Network
| The logical network carries the virtual machine network traffic. |
|
Display Network
| The logical network carries the virtual machine SPICE and virtual network controller traffic. |
|
Migration Network
| The logical network carries virtual machine and storage migration traffic. |
4.3. Clusters and Permissions
4.3.1. Managing System Permissions for a Cluster
The system administrator, as the SuperUser, manages all aspects of the Administration Portal. More specific administrative roles can be assigned to other users. These restricted administrator roles are useful for empowering a user with certain administrative privileges that limit them to a specific resource: a DataCenterAdmin role has administrator privileges only for the assigned data center, a ClusterAdmin has administrator privileges only for the assigned cluster, and so forth.
A cluster administrator is a system administration role for a specific data center only. This is useful in data centers with multiple clusters, where each cluster requires a system administrator. The ClusterAdmin role is a hierarchical model: a user assigned the cluster administrator role for a cluster can manage all objects in the cluster. Use the button in the header bar to assign a cluster administrator for all clusters in the environment.
The cluster administrator role permits the following actions:
- Create and remove associated clusters;
- Add and remove hosts, virtual machines, and pools associated with the cluster; and
- Edit user permissions for virtual machines associated with the cluster.
Note
You can only assign roles and permissions to existing users.
You can also change the system administrator of a cluster by removing the existing system administrator and adding the new system administrator.
4.3.2. Cluster Administrator Roles Explained
Cluster Permission Roles
The table below describes the administrator roles and privileges applicable to cluster administration.
Table 4.7. Red Hat Enterprise Virtualization System Administrator Roles
| Role | Privileges | Notes |
|---|---|---|
| ClusterAdmin | Cluster Administrator |
Can use, create, delete, manage all physical and virtual resources in a specific cluster, including hosts, templates and virtual machines. Can configure network properties within the cluster such as designating display networks, or marking a network as required or non-required.
However, a ClusterAdmin does not have permissions to attach or detach networks from a cluster, to do so NetworkAdmin permissions are required.
|
| NetworkAdmin | Network Administrator | Can configure and manage the network of a particular cluster. A network administrator of a cluster inherits network permissions for virtual machines within the cluster as well. |
4.3.3. Assigning an Administrator or User Role to a Resource
Summary
Assign administrator or user roles to resources to allow users to access or manage that resource.
Procedure 4.8. Assigning a Role to a Resource
- Use the resource tabs, tree mode, or the search function to find and select the resource in the results list.
- Click the tab of the details pane to list the assigned users, the user's role, and the inherited permissions for the selected resource.
- Click to open the Add Permission to User window.
- Enter the name or user name of an existing user into the Search text box and click . Select a user from the resulting list of possible matches.
- Select a role from the Role to Assign: drop-down menu.
- Click to assign the role and close the window.
Result
You have assigned a role to a user; the user now has the inherited permissions of that role enabled for that resource.
4.3.4. Removing an Administrator or User Role from a Resource
Summary
Remove an administrator or user role from a resource; the user loses the inherited permissions associated with the role for that resource.
Procedure 4.9. Removing a Role from a Resource
- Use the resource tabs, tree mode, or the search function to find and select the resource in the results list.
- Click the tab of the details pane to list the assigned users, the user's role, and the inherited permissions for the selected resource.
- Select the user to remove from the resource.
- Click . The Remove Permission window opens to confirm permissions removal.
- Click to remove the user role.
Result
You have removed the user's role, and the associated permissions, from the resource.
4.4. Clusters and Gluster Hooks
- 4.4.1. Managing Gluster Hooks
- 4.4.2. Listing Hooks
- 4.4.3. Viewing the Content of Hooks
- 4.4.4. Enabling or Disabling Hooks
- 4.4.5. Refreshing Hooks
- 4.4.6. Resolving Conflicts
- 4.4.7. Resolving Missing Hook Conflicts
- 4.4.8. Resolving Content Conflicts
- 4.4.9. Resolving Status Conflicts
- 4.4.10. Resolving Content and Status Conflicts
- 4.4.11. Resolving Content, Status, and Missing Conflicts
- 4.4.12. Managing Gluster Sync
- 4.4.13. Importing Hosts to Clusters
- 4.4.14. Detaching Hosts from Clusters
4.4.1. Managing Gluster Hooks
Gluster hooks are volume lifecycle extensions. You can manage Gluster hooks from the Manager. The content of the hook can be viewed if the hook content type is Text.
Through the Manager, you can perform the following:
- View a list of hooks available in the hosts.
- View the content and status of hooks.
- Enable or disable hooks.
- Resolve hook conflicts.
4.4.2. Listing Hooks
Procedure 4.10. Listing a Hook
- Click the Cluster tab and select a cluster. A Gluster Hooks sub-tab displays, listing the hooks in the cluster.
- Click the Gluster Hooks sub-tab. The Gluster Hooks sub-tab lists the hooks in the cluster.
4.4.3. Viewing the Content of Hooks
Procedure 4.11. Viewing the Content of a Hook
- Click the Cluster tab and select a cluster. A Gluster Hooks sub-tab displays, listing the hooks in the cluster.
- Select a hook with content type Text and click . The Hook Content window displays with the content of the hook.
4.4.4. Enabling or Disabling Hooks
Procedure 4.12. Enabling or Disabling a Hook
- Click the Cluster tab and select a cluster. A Gluster Hooks sub-tab displays, listing the hooks in the cluster.
- Select a hook and click or . The hook is enabled or disabled on all nodes of the cluster.The status of hooks as either enabled or disabled updates and displays in the Gluster Hooks sub-tab.
4.4.5. Refreshing Hooks
By default, the Manager checks the status of installed hooks on all servers in the cluster and detects new hooks by running a periodic job every hour. You can refresh hooks manually by clicking the Sync button.
Procedure 4.13. Refreshing a Hook
- Click the Cluster tab and select a cluster. A Gluster Hooks sub-tab displays, listing the hooks in the cluster.
- Click . The hooks are synchronized and displayed.
4.4.6. Resolving Conflicts
The hooks are displayed in the Gluster Hooks sub-tab of the Cluster tab. Hooks causing a conflict are displayed with an exclamation mark. This denotes either that there is a conflict in the content or the status of the hook across the servers in the cluster, or that the hook script is missing in one or more servers. These conflicts can be resolved via the Manager. The hooks in the servers are periodically synchronized with engine database and the following conflicts can occur for the hooks:
- Content Conflict - the content of the hook is different across servers.
- Status Conflict - the status of the hook is different across servers.
- Missing Conflict - one or more servers of the cluster do not have the hook.
- Content + Status Conflict - both the content and status of the hook are different across servers.
- Content + Status + Missing Conflict - both the content and status of the hook are different across servers, or one or more servers of the cluster do not have the hook.
4.4.7. Resolving Missing Hook Conflicts
Procedure 4.14. Resolving a Missing Hook Conflict
- Click the Cluster tab and select a cluster. A Gluster Hooks sub-tab displays, listing the hooks in the cluster.
- Select a hook causing a conflict and click Resolve Conflicts. The Resolve Conflicts window displays.
- Select the option below to copy the hook to all servers:Copy the hook to all the servers
- Select the option below to remove the hook from all servers and the engine:Remove the missing hook
- Click OK. The conflict is resolved.
4.4.8. Resolving Content Conflicts
Procedure 4.15. Resolving a Content Conflict
- Click the Cluster tab and select a cluster. A Gluster Hooks sub-tab displays, listing the hooks in the cluster.
- Select the conflicted hook and click Resolve Conflicts. The Resolve Conflicts window displays.
- Select an option from the drop-down list:
- Select a server to copy the content of the hook from the selected server.Or
- Select Engine (Master) to copy the content of the hook from the engine copy.
Note
The content of the hook will be overwritten in all servers and in the engine. - Click OK. The conflict is resolved.
4.4.9. Resolving Status Conflicts
Procedure 4.16. Resolving a Status Conflict
- Click the Cluster tab and select a cluster. A Gluster Hooks sub-tab displays, listing the hooks in the cluster.
- Select the conflicted hook and click Resolve Conflicts. The Resolve Conflicts window displays.
- Set Hook Status to Enable or Disable.
- Click OK. The conflict is resolved.
4.4.10. Resolving Content and Status Conflicts
Procedure 4.17. Resolving a Content and Status Conflict
- Click the Cluster tab and select a cluster. A Gluster Hooks sub-tab displays, listing the hooks in the cluster.
- Select a hook causing a conflict and click Resolve Conflicts. The Resolve Conflicts window displays.
- Select an option from the drop-down list to resolve the content conflict:
- Select a server to copy the content of the hook from the selected server.Or
- Select Engine (Master) to copy the content of the hook from the engine copy.
Note
The content of the hook will be overwritten in all the servers and in the engine. - Set hook Status to Enable or Disable to resolve the status conflict.
- Click OK. The conflict is resolved.
4.4.11. Resolving Content, Status, and Missing Conflicts
Procedure 4.18. Resolving a Content, Status and Missing Conflict
- Click the Cluster tab and select a cluster. A Gluster Hooks sub-tab displays, listing the hooks in the cluster.
- Select the conflicted hook and click Resolve Conflicts. The Resolve Conflicts window displays.
- Select an option from the drop-down list to resolve the content conflict:
- Select a server to copy the content of the hook from the selected server.Or
- Select Engine (Master) to copy the content of the hook from the engine copy.
Note
The content of the hook will be overwritten in all the servers and in the engine. - Set Hook Status to Enable or Disable to resolve the status conflict.
- Select one of the options given below to resolve the missing hook conflict:
- Copy the hook to all the servers.
- Remove the missing hook.
- Click OK. The conflict is resolved.
4.4.12. Managing Gluster Sync
The Gluster Sync feature periodically fetches the latest cluster configuration from GlusterFS and syncs the same with the engine DB. This process can be performed through the Manager. When a cluster is selected, the user is provided with the option to import hosts or detach existing hosts from the selected cluster. You can perform Gluster Sync if there is a host in the cluster.
Note
The Manager continuously monitors if hosts are added to or removed from the storage cluster. If the addition or removal of a host is detected, an action item is shown in the General tab for the cluster, where you can either to choose to Import the host into or Detach the host from the cluster.
4.4.13. Importing Hosts to Clusters
Procedure 4.19. Importing a Host to a Cluster
- Click the Cluster tab and select a cluster. A General sub-tab is shown with the details of the cluster.
- In Action Items, click . The Add Servers window displays.
- Enter the Name and Root Password.
Note
Select Use a common password, enter the root password in the Root Password field and click to use a common password for all the hosts. - Click . The host is added to the cluster.
4.4.14. Detaching Hosts from Clusters
Procedure 4.20. Detaching a Host from a Cluster
- Click the Cluster tab and select a cluster. A General sub-tab is shown with the details of the cluster.
- In , click Detach. The window displays.
- Select the host to be detached. To force detach, select Force Detach.
- Click OK. The host is detached from the cluster.
Chapter 5. Logical Networks
5.1. Introduction to Logical Networks
A logical network is a named set of global network connectivity properties in your data center. When a logical network added to a host, it may be further configured with host-specific network parameters. Logical networks optimize network flow by grouping network traffic by usage, type, and requirements.
Logical networks allow both connectivity and segregation. You can create a logical network for storage communication to optimize network traffic between hosts and storage domains, a logical network specifically for all virtual machine traffic, or multiple logical networks to carry the traffic of groups of virtual machines.
The default logical network in all data centers is the management network called
rhevm. The rhevm network carries all traffic, until another logical network is created. It is meant especially for management communication between the Red Hat Enterprise Virtualization Manager and hosts.
A logical network is a data center level resource; creating one in a data center makes it available to the clusters in a data center. A logical network that has been designated a Required must be configured in all of a cluster's hosts before it is operational. Optional networks can be used by any host they have been added to.
Warning
Do not change networking in a data center or a cluster if any hosts are running as this risks making the host unreachable.
Important
If you plan to use Red Hat Enterprise Virtualization nodes to provide any services, remember that the services will stop if the Red Hat Enterprise Virtualization environment stops operating.
This applies to all services, but you should be especially aware of the hazards of running the following on Red Hat Enterprise Virtualization:
- Directory Services
- DNS
- Storage
See Also:
5.2. Port Mirroring
Port mirroring copies layer 3 network traffic on given a logical network and host to a virtual interface on a virtual machine. This virtual machine can be used for network debugging and tuning, intrusion detection, and monitoring the behavior of other virtual machines on the same host and logical network.
The only traffic copied is internal to one logical network on one host. There is no increase on traffic on the network external to the host; however a virtual machine with port mirroring enabled uses more host CPU and RAM than other virtual machines.
Enable and disable port mirroring by editing network interfaces on virtual machines.
Port mirroring requires an IPv4 IP address.
Important
You should be aware that enabling port mirroring reduces the privacy of any other network users.
5.3. Required Networks, Optional Networks, and Virtual Machine Networks
Red Hat Enterprise Virtualization 3.1 and higher distinguishes between required networks and optional networks.
Required networks must be applied to all hosts in a cluster for the cluster and network to be Operational. Logical networks are added to clusters as Required networks by default.
When a host's required network becomes non-operational, virtual machines running on that host are migrated to another host; the extent of this migration is dependent upon the chosen cluster policy. This is beneficial if you have machines running mission critical workloads.
When a non-required network becomes non-operational, the virtual machines running on the network are not migrated to another host. This prevents unnecessary I/O overload caused by mass migrations.
Optional networks are those logical networks that have not been explicitly declared Required networks. Optional networks can be implemented on only the hosts that use them. The presence or absence of these networks does not affect the Operational status of a host.
Use the button to change a network's Required designation.
Virtual machine networks (called a VM network in the user interface) are logical networks designated to carry only virtual machine network traffic. Virtual machine networks can be required or optional.
Note
A virtual machine with a network interface on an optional virtual machine network will not start on a host without the network.
5.4. VNIC Profiles and QoS
- 5.4.1. VNIC Profile Overview
- 5.4.2. Creating a VNIC Profile
- 5.4.3. Explanation of Settings in the VM Interface Profile Window
- 5.4.4. Removing a VNIC Profile
- 5.4.5. User Permissions for VNIC Profiles
- 5.4.6. QoS Overview
- 5.4.7. Adding QoS
- 5.4.8. Settings in the New Network QoS and Edit Network QoS Windows Explained
- 5.4.9. Removing QoS
5.4.1. VNIC Profile Overview
A Virtual Network Interface Card (VNIC) profile is a collection of settings that can be applied to individual virtual network interface cards in the Manager. VNIC profiles allow you to apply Network QoS profiles to a VNIC, enable or disable port mirroring, and add or remove custom properties. VNIC profiles offer an added layer of administrative flexibility in that permission to use (consume) these profiles can be granted to specific users. In this way, you can control the quality of service that different users receive from a given network.
Note
Starting with Red Hat Enterprise Virtualization 3.3, virtual machines now access logical networks only through VNIC profiles and cannot access a logical network if no VNIC profiles exist for that logical network. When you create a new logical network in the Manager, a VNIC profile of the same name as the logical network is automatically created under that logical network.
5.4.2. Creating a VNIC Profile
Summary
Create a Virtual Network Interface Controller (VNIC) profile to regulate network bandwidth for users and groups.
- Use the Networks resource tab, tree mode, or the search function to select a logical network in the results pane.
- Select the Profiles tab in the details pane to display available VNIC profiles. If you selected the logical network in tree mode, you can select the VNIC Profiles tab in the results pane.
- Click to open the VM Interface Profile window.
- Enter the Name and Description of the profile.
- Use the QoS drop-down menu to select the relevant Quality of Service policy to apply to the VNIC profile.
- Use the Port Mirroring and Allow all users to use this Profile check boxes to toggle these options.
- The custom device properties drop-down menu, which displays Please select a key... by default, will be active only if custom properties have been defined on the Manager. Use the drop-down menu to select the custom property, and the and buttons to add or remove custom properties.
- Click to save the profile and close the window.
Result
You have created a VNIC profile. Apply this profile to users and groups to regulate their network bandwidth.
5.4.3. Explanation of Settings in the VM Interface Profile Window
Table 5.1. VM Interface Profile Window
|
Field Name
|
Description
|
|---|---|
|
Network
|
A drop-down menu of the available networks to apply the VNIC profile.
|
|
Name
|
The name of the VNIC profile. This must be a unique name with any combination of uppercase and lowercase letters, numbers, hyphens, and underscores between 1 and 50 characters.
|
| Description |
The description of the VNIC profile. This field is recommended but not mandatory.
|
| QoS |
A drop-down menu of the available Network Quality of Service policies to apply to the VNIC profile. QoS policies regulate inbound and outbound network traffic of the VNIC.
|
| Port Mirroring |
A check box to toggle port mirroring. Port mirroring copies layer 3 network traffic on the logical network to a virtual interface on a virtual machine. It it not selected by default.
|
| Device Custom Properties |
A drop-down menu to select available custom properties to apply to the VNIC profile. Use the and buttons to add and remove properties respectively.
|
| Allow all users to use this Profile |
A check box to toggle the availability of the profile to all users in the environment. It is selected by default.
|
5.4.4. Removing a VNIC Profile
Summary
Remove a VNIC profile to delete it from your virtualized environment.
- Use the Networks resource tab, tree mode, or the search function to select a logical network in the results pane.
- Select the Profiles tab in the details pane to display available VNIC profiles. If you selected the logical network in tree mode, you can select the vNIC Profiles tab in the results pane.
- Select one or more profiles and click to open the Remove VM Interface Profile(s) window.
- Click to remove the profile and close the window.
Result
You have removed the VNIC profile.
5.4.5. User Permissions for VNIC Profiles
Summary
Configure user permissions to assign users to certain VNIC profiles. Assign the VnicProfileUser role to a user to enable them to use the profile. Restrict users from certain profiles by removing their permission for that profile.
- Use tree mode to select a logical network.
- Select the vNIC Profiles resource tab to display the VNIC profiles.
- Select the Permissions tab in the details pane to show the current user permissions for the profile.
- Use the button to open the Add Permission to User window, and the button to open the Remove Permission window, to affect user permissions for the VNIC profile.
Result
You have configured user permissions for a VNIC profile.
5.4.6. QoS Overview
Network QoS is a feature that allows you to create profiles for limiting both the inbound and outbound traffic of individual virtual NIC. With this feature, you can limit bandwidth in a number of layers, controlling the consumption of network resources.
Important
Network QoS is only supported on cluster compatibility version 3.3 and higher.
5.4.7. Adding QoS
Summary
Create a QoS profile to regulate network traffic when applied to a VNIC (Virtual Network Interface Controller) profile, also known as VM (Virtual Machine) Interface profile.
Procedure 5.1. Creating a QoS profile
- Use the Data Centers resource tab, tree mode, or the search function to display and select a data center in the results list.
- Select the Network QoS tab in the details pane to display the available QoS profiles.
- Click to open the New Network QoS window.
- Enter the Name of the profile.
- Enter the limits for the Inbound and Outbound network traffic.
- Click to save the changes and close the window.
Summary
You have created a QoS Profile that can be used in a VNIC (Virtual Network Interface Controller) profile, also known as VM (Virtual Machine) Interface profile.
5.4.8. Settings in the New Network QoS and Edit Network QoS Windows Explained
Network QoS settings allow you to configure bandwidth limits for both inbound and outbound traffic on three distinct levels.
Table 5.2. Network QoS Settings
|
Field Name
|
Description
|
|---|---|
|
Data Center
|
The data center to which the Network QoS policy is to be added. This field is configured automatically according to the selected data center.
|
|
Name
|
A name to represent the network QoS policy within the Manager.
|
|
Inbound
|
The settings to be applied to inbound traffic. Select or clear the Inbound check box to enable or disable these settings.
|
|
Outbound
|
The settings to be applied to outbound traffic. Select or clear the Outbound check box to enable or disable these settings.
|
5.4.9. Removing QoS
Summary
Remove a QoS profile from your virtualized environment.
Procedure 5.2. Removing a QoS profile
- Use the Data Centers resource tab, tree mode, or the search function to display and select a data center in the results list.
- Select the Network QoS tab in the details pane to display the available QoS profiles.
- Select the QoS profile to remove and click to open the Remove Network QoS window. This window will list what, if any, VNIC profiles are using the selected QoS profile.
- Click to save the changes and close the window.
Result
You have removed the QoS profile.
5.5. Logical Network Tasks
- 5.5.1. Creating a New Logical Network in a Data Center or Cluster
- 5.5.2. Explanation of Settings and Controls in the General Tab of the New Logical Network and Edit Logical Network Windows
- 5.5.3. Explanation of Settings and Controls in the Cluster Tab of the New Logical Network and Edit Logical Network Windows
- 5.5.4. Explanation of Settings and Controls in the Profiles Tab of the New Logical Network and Edit Logical Network Windows
- 5.5.5. Editing a Logical Network
- 5.5.6. Designate a Specific Traffic Type for a Logical Network with the Manage Networks Window
- 5.5.7. Explanation of Settings in the Manage Networks Window
- 5.5.8. Adding Multiple VLANs to a Single Network Interface Using Logical Networks
- 5.5.9. Using the Networks Tab
5.5.1. Creating a New Logical Network in a Data Center or Cluster
Summary
Create a logical network and define its use in a data center, or in clusters in a data center.
Procedure 5.3. Creating a New Logical Network in a Data Center or Cluster
- Use the Data Centers or Clusters resource tabs, tree mode, or the search function to find and select a data center or cluster in the results list.
- Click the Logical Networks tab of the details pane to list the existing logical networks.
- From the Data Centers details pane, click to open the New Logical Network window.From the Clusters details pane, click to open the New Logical Network window.
- Enter a Name, Description and Comment for the logical network.
- In the Export section, select the Create on external provider check box to create the logical network on an external provider. Select the external provider from the External Provider drop-down list and enter a Network Label for the logical network.
- Select the Enable VLAN tagging, VM network and Override MTU to enable these options.
- From the Cluster tab, select the clusters to which the network will be assigned. You can also specify whether the logical network will be a required network.
- From the Profiles tab, add vNIC profiles to the logical network as required.
- Click OK.
Result
You have defined this logical network as a resource required by a cluster or clusters in the data center. You can now add this resource to the hosts in the cluster.
Note
When creating a new logical network or making changes to an existing logical network that is used as a display network, any running virtual machines that use that network must be rebooted before the network becomes available or the changes are applied.
See Also:
5.5.2. Explanation of Settings and Controls in the General Tab of the New Logical Network and Edit Logical Network Windows
The table below describes the settings for the General tab of the New Logical Network and Edit Logical Network window.
Table 5.3. New Logical Network and Edit Logical Network Settings
|
Field Name
|
Description
|
|---|---|
|
Name
|
The name of the logical network. This text field has a 15-character limit and must be a unique name with any combination of uppercase and lowercase letters, numbers, hyphens, and underscores.
|
|
Description
|
The description of the logical network. This field is recommended but not mandatory.
|
|
Comment
|
A field for adding plain text, human-readable comments regarding the logical network.
|
|
Export
|
Allows you to export the logical network to an OpenStack Network Service that has been added to the Manager as an external provider.
External Provider - Allows you to select the external provider on which the logical network will be created.
Network Label - Allows you to specify the label of the logical network, such as
eth0.
|
|
Enable VLAN tagging
|
VLAN tagging is a security feature that gives all network traffic carried on the logical network a special characteristic. VLAN-tagged traffic cannot be read by interfaces that do not also have that characteristic. Use of VLANs on logical networks also allows a single network interface to be associated with multiple, differently VLAN-tagged logical networks. Enter a numeric value in the text entry field if VLAN tagging is enabled.
|
|
VM Network
|
Select this option if only virtual machines use this network. If the network is used for traffic that does not involve virtual machines, such as storage communications, do not select this check box.
|
|
Override MTU
|
Set a custom maximum transmission unit for the logical network. You can use this to match the MTU supported by your new logical network to the MTU supported by the hardware it interfaces with. Enter a numeric value in the text entry field if MTU override is enabled.
|
5.5.3. Explanation of Settings and Controls in the Cluster Tab of the New Logical Network and Edit Logical Network Windows
The table below describes the settings for the Cluster tab of the New Logical Network and Edit Logical Network window.
Table 5.4. New Logical Network and Edit Logical Network Settings
|
Field Name
|
Description
|
|---|---|
|
Attach/Detach Network to/from Cluster(s)
|
Allows you to attach or detach the logical network from clusters in the data center and specify whether the logical network will be a required network for individual clusters.
Name - the name of the cluster to which the settings will apply. This value cannot be edited.
Attach All - Allows you to attach or detach the logical network to or from all clusters in the data center. Alternatively, select or clear the Attach check box next to the name of each cluster to attach or detach the logical network to or from a given cluster.
Required All - Allows you to specify whether the logical network is a required network on all clusters. Alternatively, select or clear the Required check box next to the name of each cluster to specify whether the logical network is a required network for a given cluster.
|
5.5.4. Explanation of Settings and Controls in the Profiles Tab of the New Logical Network and Edit Logical Network Windows
The table below describes the settings for the Profiles tab of the New Logical Network and Edit Logical Network window.
Table 5.5. New Logical Network and Edit Logical Network Settings
|
Field Name
|
Description
|
|---|---|
|
vNIC Profiles
|
Allows you to specify one or more vNIC profiles for the logical network. You can add or remove a vNIC profile to or from the logical network by clicking the plus or minus button next to the vNIC profile. The first field is for entering a name for the vNIC profile.
Public - Allows you to specify whether the profile is available to all users.
QoS - Allows you to specify a network quality of service (QoS) profile to the vNIC profile.
|
5.5.5. Editing a Logical Network
Summary
Edit the settings of a logical network.
Procedure 5.4. Editing a Logical Network
- Use the Data Centers resource tab, tree mode, or the search function to find and select the data center of the logical network in the results list.
- Click the Logical Networks tab in the details pane to list the logical networks in the data center.
- Select a logical network and click to open the Edit Logical Network window.
- Edit the necessary settings.
- Click OK to save the changes.
Result
You have updated the settings of your logical network.
5.5.6. Designate a Specific Traffic Type for a Logical Network with the Manage Networks Window
Summary
Specify the traffic type for the logical network to optimize the network traffic flow.
Procedure 5.5. Assigning or Unassigning a Logical Network to a Cluster
- Use the Clusters resource tab, tree mode, or the search function to find and select the cluster in the results list.
- Select the Logical Networks tab in the details pane to list the logical networks assigned to the cluster.
- Click to open the Manage Networks window.
- Select appropriate check boxes.
- Click to save the changes and close the window.
Result
You have optimized the network traffic flow by assigning a specific type of traffic to be carried on a specific logical network.
Note
Networks offered by external providers cannot be used as display networks.
See Also:
5.5.7. Explanation of Settings in the Manage Networks Window
The table below describes the settings for the Manage Networks window.
Table 5.6. Manage Networks Settings
|
Field
|
Description/Action
|
|---|---|
|
Assign
|
Assigns the logical network to all hosts in the cluster.
|
|
Required
|
A logical network becomes operational when it is attached to an active NIC on all hosts in the cluster.
|
|
VM Network
| The logical network carries the virtual machine network traffic. |
|
Display Network
| The logical network carries the virtual machine SPICE and virtual network controller traffic. |
|
Migration Network
| The logical network carries virtual machine and storage migration traffic. |
5.5.8. Adding Multiple VLANs to a Single Network Interface Using Logical Networks
Summary
Multiple VLANs can be added to a single network interface to separate traffic on the one host.
Important
You must have created more than one logical network, all with the Enable VLAN tagging check box selected in the New Logical Network or Edit Logical Network windows.
Procedure 5.6. Adding Multiple VLANs to a Network Interface using Logical Networks
- Use the Hosts resource tab, tree mode, or the search function to find and select in the results list a host associated with the cluster to which your VLAN-tagged logical networks are assigned.
- Click the Network Interfaces tab in the details pane to list the physical network interfaces attached to the data center.
- Click to open the Setup Host Networks window.
- Drag your VLAN-tagged logical networks into the Assigned Logical Networks area next to the physical network interface. The physical network interface can have multiple logical networks assigned due to the VLAN tagging.
- Edit the logical networks by hovering your cursor over an assigned logical network and clicking the pencil icon to open the Edit Network window.If your logical network definition is not synchronized with the network configuration on the host, select the Sync network check box.Select a Boot Protocol from:Click OK.
- None,
- DHCP, or
- Static,Provide the IP and Subnet Mask.
- Select the Verify connectivity between Host and Engine check box to run a network check; this will only work if the host is in maintenance mode.
- Select the Save network configuration check box
- Click .
Add the logical network to each host in the cluster by editing a NIC on each host in the cluster. After this is done, the network will become operational
Result
You have added multiple VLAN-tagged logical networks to a single interface. This process can be repeated multiple times, selecting and editing the same network interface each time on each host to add logical networks with different VLAN tags to a single network interface.
See Also:
5.5.9. Using the Networks Tab
The Networks resource tab provides a central location for users to perform network-related operations and search for networks based on each network's property or association with other resources.
All networks in the Red Hat Enterprise Virtualization environment display in the results list of the Networks tab. The , and buttons allow you to create, change the properties of, and delete logical networks within data centers.
Click on each network name and use the Clusters, Hosts, Virtual Machines, Templates, and Permissions tabs in the details pane to perform functions including:
- Attaching or detaching the networks to clusters and hosts
- Removing network interfaces from virtual machines and templates
- Adding and removing permissions for users to access and manage networks
These functions are also accessible through each individual resource tab.
5.5.9.1. Importing Networks from External Providers
Summary
If an external provider offering networking services has been registered in the Manager, the networks provided by that provider can be imported into the Manager and used by virtual machines.
Procedure 5.7. Importing a Network
- Click on the Networks tab.
- Click the Import button. The Import Networks window appears.
- From the Network Provider drop-down list, select a provider. The networks offered by that provider are automatically discovered and display in the Provider Networks list.
- Select the network to import in the Provider Networks list and click the down arrow to move the network into the Networks to Import list.
- Click the Import button.
Result
The selected networks are imported and can now be used within the Manager.
Important
External provider discovery and importing are Technology Preview features. Technology Preview features are not fully supported under Red Hat Subscription Service Level Agreements (SLAs), may not be functionally complete, and are not intended for production use. However, these features provide early access to upcoming product innovations, enabling customers to test functionality and provide feedback during the development process.
5.5.9.2. Limitations to Importing Networks from External Providers
While networks offered by external providers can be imported into the Manager, the following limitations apply to their usage:
- Networks offered by external providers must be used as virtual machine networks.
- Networks offered by external providers cannot be used as display networks.
- The same network can be imported more than once, but only to different data centers.
- Networks offered by external providers cannot be edited in the Manager. This is because the management of such networks is the responsibility of the external providers.
- Port mirroring is not available for virtual NIC connected to networks offered by external providers.
- If a virtual machine uses a network offered by an external provider, that provider cannot be deleted from the Manager while the network is still in use by the virtual machine.
- Networks offered by external providers are non-required. As such, scheduling for clusters in which such networks have been imported will not take those networks into account during host selection. Moreover, it is the responsibility of the user to ensure the availability of the network on hosts in clusters in which such networks have been imported.
Important
External provider discovery and importing are Technology Preview features. Technology Preview features are not fully supported under Red Hat Subscription Service Level Agreements (SLAs), may not be functionally complete, and are not intended for production use. However, these features provide early access to upcoming product innovations, enabling customers to test functionality and provide feedback during the development process.
5.6. Logical Networks and Permissions
5.6.1. Managing System Permissions for a Network
The system administrator, as the SuperUser, manages all aspects of the Administration Portal. More specific administrative roles can be assigned to other users. These restricted administrator roles are useful for empowering a user with certain administrative privileges that limit them to a specific resource: a DataCenterAdmin role has administrator privileges only for the assigned data center, a HostAdmin has administrator privileges only for the assigned host, and so forth.
A network administrator is a system administration role that can be applied for a specific network, or for all networks on a data center, cluster, host, virtual machine, or template. A network user can perform limited administration roles, such as viewing and attaching networks on a specific virtual machine or template. You can use the Configure button in the header bar to assign a network administrator for all networks in the environment.
The network administrator role permits the following actions:
- Create, edit and remove networks;
- Edit the configuration of the network, including configuring port mirroring;
- Attach and detach networks from resources including clusters and virtual machines.
The user who creates a network is automatically assigned NetworkAdmin permissions on the created network. You can also change the administrator of a network by removing the existing administrator and adding the new administrator.
5.6.2. Network Administrator and User Roles Explained
Network Permission Roles
The table below describes the administrator and user roles and privileges applicable to network administration.
Table 5.7. Red Hat Enterprise Virtualization Network Administrator and User Roles
| Role | Privileges | Notes |
|---|---|---|
| NetworkAdmin | Network Administrator for data center, cluster, host, virtual machine, or template. The user who creates a network is automatically assigned NetworkAdmin permissions on the created network. | Can configure and manage the network of a particular data center, cluster, host, virtual machine, or template. A network administrator of a data center or cluster inherits network permissions for virtual pools within the cluster. To configure port mirroring on a virtual machine network, apply the NetworkAdmin role on the network and the UserVmManager role on the virtual machine. |
| NetworkUser | Logical network and network interface user for virtual machine and template. | Can attach or detach network interfaces from specific logical networks. |
5.6.3. Assigning an Administrator or User Role to a Resource
Summary
Assign administrator or user roles to resources to allow users to access or manage that resource.
Procedure 5.8. Assigning a Role to a Resource
- Use the resource tabs, tree mode, or the search function to find and select the resource in the results list.
- Click the tab of the details pane to list the assigned users, the user's role, and the inherited permissions for the selected resource.
- Click to open the Add Permission to User window.
- Enter the name or user name of an existing user into the Search text box and click . Select a user from the resulting list of possible matches.
- Select a role from the Role to Assign: drop-down menu.
- Click to assign the role and close the window.
Result
You have assigned a role to a user; the user now has the inherited permissions of that role enabled for that resource.
5.6.4. Removing an Administrator or User Role from a Resource
Summary
Remove an administrator or user role from a resource; the user loses the inherited permissions associated with the role for that resource.
Procedure 5.9. Removing a Role from a Resource
- Use the resource tabs, tree mode, or the search function to find and select the resource in the results list.
- Click the tab of the details pane to list the assigned users, the user's role, and the inherited permissions for the selected resource.
- Select the user to remove from the resource.
- Click . The Remove Permission window opens to confirm permissions removal.
- Click to remove the user role.
Result
You have removed the user's role, and the associated permissions, from the resource.
Chapter 6. Hosts
6.1. Introduction to Red Hat Enterprise Virtualization Hosts
Hosts, also known as hypervisors, are the physical servers on which virtual machines run. Full virtualization is provided by using a loadable Linux kernel module called Kernel-based Virtual Machine (KVM).
KVM can concurrently host multiple virtual machines running either Windows or Linux operating systems. Virtual machines run as individual Linux processes and threads on the host machine and are managed remotely by the Red Hat Enterprise Virtualization Manager. A Red Hat Enterprise Virtualization environment has one or more hosts attached to it.
Red Hat Enterprise Virtualization supports two methods of installing hosts. You can use the Red Hat Enterprise Virtualization Hypervisor installation media, or install hypervisor packages on a standard Red Hat Enterprise Linux installation.
Red Hat Enterprise Virtualization hosts take advantage of tuned profiles, which provide virtualization optimizations. For more information on tuned, please refer to the Red Hat Enterprise Linux 6.0 Performance Tuning Guide.
The Red Hat Enterprise Virtualization Hypervisor has security features enabled. Security Enhanced Linux (SELinux) and the iptables firewall are fully configured and on by default. The Manager can open required ports on Red Hat Enterprise Linux hosts when it adds them to the environment. For a full list of ports, see Virtualization Host Firewall Requirements.
A host is a physical 64-bit server with the Intel VT or AMD-V extensions running Red Hat Enterprise Linux 6.1 or later AMD64/Intel 64 version.
Important
Red Hat Enterprise Linux 5.4 and Red Hat Enterprise Linux 5.5 machines that belong to existing clusters are supported. Red Hat Enterprise Virtualization Guest Agent is now included in the
virtio serial channel. Any Guest Agents installed on Windows guests on Red Hat Enterprise Linux hosts will lose their connection to the Manager when the Red Hat Enterprise Linux hosts are upgraded from version 5 to version 6.
A physical host on the Red Hat Enterprise Virtualization platform:
- Must belong to only one cluster in the system.
- Must have CPUs that support the AMD-V or Intel VT hardware virtualization extensions.
- Must have CPUs that support all functionality exposed by the virtual CPU type selected upon cluster creation.
- Has a minimum of 2 GB RAM.
- Can have an assigned system administrator with system permissions.
Administrators can receive the latest security advisories from the Red Hat Enterprise Virtualization watch list. Subscribe to the Red Hat Enterprise Virtualization watch list to receive new security advisories for Red Hat Enterprise Virtualization products by email. Subscribe by completing this form:
See Also:
6.2. Red Hat Enterprise Virtualization Hypervisor Hosts
Red Hat Enterprise Virtualization Hypervisor hosts are installed using a special build of Red Hat Enterprise Linux with only the packages required to host virtual machines. They run stateless, not writing any changes to disk unless explicitly required to.
Red hat Enterprise Virtualization Hypervisor hosts can be added directly to, and configured by, the Red Hat Enterprise Virtualization Manager. Alternatively a host can be configured locally to connect to the Manager; the Manager then is only used to approve the host to be used in the environment.
Unlike Red Hat Enterprise Linux hosts, Red Hat Enterprise Virtualization Hypervisor hosts cannot be added to clusters that have been enabled for Gluster service for use as Red Hat Storage nodes.
Important
The Red Hat Enterprise Virtualization Hypervisor is a closed system. Use a Red Hat Enterprise Linux host if additional rpm packages are required for your environment.
6.3. Foreman Host Provider Hosts
Hosts provided by a Foreman host provider can also be used as virtualization hosts by the Red Hat Enterprise Virtualization Manager. After a Foreman host provider has been added to the Manager as an external provider, any hosts that it provides can be added to and used in Red Hat Enterprise Virtualization in the same way as Red Hat Enterprise Virtualization Hypervisor hosts and Red Hat Enterprise Linux hosts.
Important
Foreman host provider hosts are a Technology Preview feature. Technology Preview features are not fully supported under Red Hat Subscription Service Level Agreements (SLAs), may not be functionally complete, and are not intended for production use. However, these features provide early access to upcoming product innovations, enabling customers to test functionality and provide feedback during the development process.
6.4. Red Hat Enterprise Linux Hosts
You can use a standard Red Hat Enterprise Linux 6 installation on capable hardware as a host. Red Hat Enterprise Virtualization supports hosts running Red Hat Enterprise Linux 6 Server AMD64/Intel 64 version.
Adding a host can take some time, as the following steps are completed by the platform: virtualization checks, installation of packages, creation of bridge and a reboot of the host. Use the Details pane to monitor the hand-shake process as the host and management system establish a connection.
6.5. Host Tasks
- 6.5.1. Adding a Red Hat Enterprise Linux Host
- 6.5.2. Adding a Foreman Host Provider Host
- 6.5.3. Approving a Hypervisor
- 6.5.4. Explanation of Settings and Controls in the New Host and Edit Host Windows
- 6.5.5. Configuring Host Power Management Settings
- 6.5.6. Configuring Host Storage Pool Manager (SPM) Settings
- 6.5.7. Manually Selecting the SPM
- 6.5.8. Editing a Resource
- 6.5.9. Moving a Host to Maintenance Mode
- 6.5.10. Activating a Host from Maintenance Mode
- 6.5.11. Removing a Host
- 6.5.12. Customizing Hosts with Tags
6.5.1. Adding a Red Hat Enterprise Linux Host
Summary
A Red Hat Enterprise Linux host is based on a standard "basic" installation of Red Hat Enterprise Linux. The physical host must be set up before you can add it the Red Hat Enterprise Virtualization environment.
The Red Hat Enterprise Virtualization Manager logs into the host to perform virtualization capability checks, install packages, create a network bridge, and reboot the host. The process of adding a new host can take up to 10 minutes.
Procedure 6.1. Adding a Red Hat Enterprise Linux Host
- Click the Hosts resource tab to list the hosts in the results list.
- Click to open the New Host window.
- Use the drop-down menus to select the Data Center and Host Cluster for the new host.
- Enter the Name, Address, and SSH Port of the new host.
- Select an authentication method to use with the host.
- Enter the root user's password to use password authentication.
- Copy the key displayed in the SSH PublicKey field to
/root/.ssh/authorized_keyson the host to use public key authentication.
- You have now completed the mandatory steps to add a Red Hat Enterprise Linux host. Click the button to expand the advanced host settings.
- Optionally disable automatic firewall configuration.
- Optionally add a host SSH fingerprint to increase security. You can add it manually, or fetch it automatically.
- You can configure the Power Management and SPM using the applicable tabs now; however, as these are not fundamental to adding a Red Hat Enterprise Linux host, they are not covered in this procedure.
- Click to add the host and close the window.
Result
The new host displays in the list of hosts with a status of Installing. Once installation is complete, the status will update to Reboot. The host must be activated for the status to change to Up.
Note
You can view the progress of the installation in the details pane.
See Also:
6.5.2. Adding a Foreman Host Provider Host
Summary
The process for adding a Foreman host provider host is almost identical to that of adding a Red Hat Enterprise Linux host except for the method by which the host is identified in the Manager. The following procedure outlines how to add a host provided by a Foreman host provider.
Procedure 6.2. Adding a Foreman Host Provider Host
- Click the Hosts resource tab to list the hosts in the results list.
- Click to open the New Host window.
- Use the drop-down menus to select the Data Center and Host Cluster for the new host.
- Select the Use External Providers check box to display the options for adding a Foreman host provider host and select the external provider from which the host is to be added.
- Select the host to be added from the External Hosts drop-down list. Any details regarding the host that can be retrieved from the external provider are automatically set.
- Enter the Name, Address, and SSH Port of the new host.
- Select an authentication method to use with the host.
- Enter the root user's password to use password authentication.
- Copy the key displayed in the SSH PublicKey field to
/root/.ssh/authorized_hostson the host to use public key authentication.
- You have now completed the mandatory steps to add a Red Hat Enterprise Linux host. Click the drop-down button to show the advanced host settings.
- Optionally disable automatic firewall configuration.
- Optionally add a host SSH fingerprint to increase security. You can add it manually, or fetch it automatically.
- You can configure the Power Management and SPM using the applicable tabs now; however, as these are not fundamental to adding a Red Hat Enterprise Linux host, they are not covered in this procedure.
- Click to add the host and close the window.
Result
The new host displays in the list of hosts with a status of Installing. Once installation is complete, the status will update to Reboot. The host must be activated for the status to change to Up.
Note
You can view the progress of the installation in the details pane.
See Also:
6.5.3. Approving a Hypervisor
Summary
It is not possible to run virtual machines on a Hypervisor until the addition of it to the environment has been approved in Red Hat Enterprise Virtualization Manager.
Procedure 6.3. Approving a Hypervisor
- Log in to the Red Hat Enterprise Virtualization Manager Administration Portal.
- From the Hosts tab, click on the host to be approved. The host should currently be listed with the status of Pending Approval.
- Click the Approve button. The Edit and Approve Hosts dialog displays. You can use the dialog to set a name for the host, fetch its SSH fingerprint before approving it, and configure power management, where the host has a supported power management card. For information on power management configuration, see the Power Management chapter of the Red Hat Enterprise Virtualization Administration Guide.
- Click . If you have not configured power management you will be prompted to confirm that you wish to proceed without doing so, click .
Result
The status in the Hosts tab changes to Installing, after a brief delay the host status changes to Up.
See Also:
6.5.4. Explanation of Settings and Controls in the New Host and Edit Host Windows
6.5.4.1. Host General Settings Explained
These settings apply when editing the details of a host or adding new Red Hat Enterprise Linux hosts and Foreman host provider hosts.
The General settings table contains the information required on the General tab of the New Host or Edit Host window.
Table 6.1. General settings
|
Field Name
|
Description
|
|---|---|
|
Data Center
|
The data center to which the host belongs. Red Hat Enterprise Virtualization Hypervisor hosts can not be added to Gluster-enabled clusters.
|
|
Host Cluster
|
The cluster to which the host belongs.
|
|
Use External Providers
|
Select or clear this check box to view or hide options for adding hosts provided by external providers. Upon selection, a drop-down list of external providers that have been added to the Manager displays. The following options are also available:
|
|
Name
|
The name of the cluster. This text field has a 40-character limit and must be a unique name with any combination of uppercase and lowercase letters, numbers, hyphens, and underscores.
|
|
Comment
|
A field for adding plain text, human-readable comments regarding the host.
|
|
Address
|
The IP address, or resolvable hostname of the host.
|
|
Password
|
The password of the host's root user. This can only be given when you add the host, it cannot be edited afterwards.
|
|
SSH PublicKey
|
Copy the contents in the text box to the
/root/.known_hosts file on the host if you'd like to use the Manager's ssh key instead of using a password to authenticate with the host.
|
|
Automatically configure host firewall
|
When adding a new host, the Manager can open the required ports on the host's firewall. This is enabled by default. This is an Advanced Parameter.
|
|
SSH Fingerprint
|
You can the host's SSH fingerprint, and compare it with the fingerprint you expect the host to return, ensuring that they match. This is an Advanced Parameter.
|
6.5.4.2. Host Power Management Settings Explained
The Power Management settings table contains the information required on the Power Management tab of the New Host or Edit Host windows.
Table 6.2. Power Management Settings
|
Field Name
|
Description
|
|---|---|
|
Primary/ Secondary
|
Prior to Red Hat Enterprise Virtualization 3.2, a host with power management configured only recognized one fencing agent. Fencing agents configured on version 3.1 and earlier, and single agents, are treated as primary agents. The secondary option is valid when a second agent is defined.
|
|
Concurrent
|
Valid when there are two fencing agents, for example for dual power hosts in which each power switch has two agents connected to the same power switch.
|
|
Address
|
The address to access your host's power management device. Either a resolvable hostname or an IP address.
|
|
User Name
|
User account to access the power management device with. You may have to set up a user on the device, or use the default user.
|
|
Password
|
Password for the user accessing the power management device.
|
|
Type
|
The type of power management device in your host.
Choose one of the following:
|
|
Port
|
The port number used by the power management device to communicate with the host.
|
|
Options
|
Power management device specific options. Give these as 'key=value' or 'key', refer to the documentation of your host's power management device for the options available.
|
|
Secure
|
Tick this check box to allow the power management device to connect securely to the host. This can be done via ssh, ssl, or other authentication protocols depending on and supported by the power management agent.
|
|
Source
|
Specifies whether the host will search within its cluster or data center for a fencing proxy. Use the and buttons to change the sequence in which the resources are used.
|
6.5.4.3. SPM Priority Settings Explained
The SPM settings table details the information required on the SPM tab of the New Host or Edit Host window.
Table 6.3. SPM settings
|
Field Name
|
Description
|
|---|---|
|
SPM Priority
|
Defines the likelihood that the host will be given the role of Storage Pool Manager(SPM). The options are Low, Normal, and High priority, where Low priority means a reduced likelihood of the host being assigned the role of SPM, and High priority increases the likelihood. The default setting is Normal.
|
6.5.4.4. Host Console Settings Explained
The Console settings table details the information required on the Console tab of the New Host or Edit Host window.
Table 6.4. Console settings
|
Field Name
|
Description
|
|---|---|
|
Override display address
|
Select this check box to enable overriding the display addresses of the host. This feature is useful in a case where the hosts are defined by internal IP and are behind a NAT firewall. When a user connects to a virtual machine from outside of the internal network, instead of returning the private address of the host on which the virtual machine is running, a public IP or FQDN (which is resolved in the external network to the public IP) is returned.
|
|
Display address
|
The display address specified here will be used for all virtual machines running on this host. The address must be in the format of a fully qualified domain name or IP.
|
6.5.5. Configuring Host Power Management Settings
Summary
Configure your host power management device settings to perform host life-cycle operations (stop, start, restart) from the Administration Portal.
It is necessary to configure host power management in order to utilize host high availability and virtual machine high availability.
Important
Ensure that your host is in
maintenance mode before configuring power management settings. Otherwise, all running virtual machines on that host will be stopped ungracefully upon restarting the host, which can cause disruptions in production environments. A warning dialog will appear if you have not correctly set your host to maintenance mode.
Procedure 6.4. Configuring Power Management Settings
- Use the Hosts resource tab, tree mode, or the search function to find and select the host in the results list.
- Click to open the Edit Host window.
- Click the Power Management tab to display the Power Management settings.
- Select the Enable Power Management check box to enable the fields.
- The Primary option is selected by default if you are configuring a new power management device. If you are adding a new device, set it to Secondary.
- Select the Concurrent check box to enable multiple fence agents to be used concurrently.
- Enter the Address, User Name, and Password of the power management device into the appropriate fields.
- Use the drop-down menu to select the Type of power management device.
- Enter the Port number used by the power management device to communicate with the host.
- Enter the Options for the power management device. Use a comma-separated list of 'key=value' or 'key'.
- Select the Secure check box to enable the power management device to connect securely to the host.
- Click to ensure the settings are correct.
- Click to save your settings and close the window.
Result
You have configured the power management settings for the host. The Power Management drop-down menu is now enabled in the Administration Portal.
See Also:
6.5.6. Configuring Host Storage Pool Manager (SPM) Settings
Summary
The Storage Pool Manager (SPM) is a management role given to one of the hosts in a data center to maintain access control over the storage domains. The SPM must always be available, and the SPM role will be assigned to another host if the SPM host becomes unavailable. As the SPM role uses some of the host's available resources, it is important to prioritize hosts that can afford the resources.
The Storage Pool Manager (SPM) priority setting of a host alters the likelihood of the host being assigned the SPM role: a host with high SPM priority will be assigned the SPM role before a host with low SPM priority.
Procedure 6.5. Configuring SPM settings
- Use the Hosts resource tab, tree mode, or the search function to find and select the host in the results list.
- Click to open the Edit Host window.
- Click the SPM tab to display the SPM Priority settings.
- Use the radio buttons to select the appropriate SPM priority for the host.
- Click to save the settings and close the window.
Result
You have configured the SPM priority of the host.
6.5.7. Manually Selecting the SPM
Summary
The Storage Pool Manager (SPM) can be manually assigned to a host. This option is only available to valid hosts. Manually selecting the SPM will result in immediate preference for that host to be given the SPM role. If that host goes down, the SPM role will be passed to the next most preferred host.
Manually selecting the SPM is not permanent. If the host encounters problems, the Red Hat Enterprise Virtualization Manager will assign the role to another host, taking into account the SPM priority of the available hosts. Your chosen host will have no lingering precedence for the SPM role beyond its SPM priority.
Procedure 6.6. Manually Assigning SPM to a Host
- Use the Hosts resource tab, tree mode, or the search function to find and select the host in the results list.
- Right-click the host and, if applicable, select Select as SPM.
Result
The host will be given immediate preference for the SPM role.
See Also:
6.5.8. Editing a Resource
Summary
Edit the properties of a resource.
Procedure 6.7. Editing a Resource
- Use the resource tabs, tree mode, or the search function to find and select the resource in the results list.
- Click to open the Edit window.
- Change the necessary properties and click .
Result
The new properties are saved to the resource. The Edit window will not close if a property field is invalid.
See Also:
6.5.9. Moving a Host to Maintenance Mode
Summary
Many common maintenance tasks, including network configuration and deployment of software updates, require that hosts be placed into maintenance mode. When a host is placed into maintenance mode the Red Hat Enterprise Virtualization Manager attempts to migrate all running virtual machines to alternative hosts.
The normal prerequisites for live migration apply, in particular there must be at least one active host in the cluster with capacity to run the migrated virtual machines.
Procedure 6.8. Moving a Host to Maintenance Mode
- Use the Hosts resource tab, tree mode, or the search function to find and select the host in the results list.
- Click to open the Maintenance Host(s) confirmation window.
- Click to initiate maintenance mode.
Result:
All running virtual machines are migrated to alternative hosts. The Status field of the host changes to Preparing for Maintenance, and finally Maintenance when the operation completes successfully.
6.5.10. Activating a Host from Maintenance Mode
Summary
A host that has been placed into maintenance mode, or recently added to the environment, must be activated before it can be used.
Procedure 6.9. Activating a Host from Maintenance Mode
- Use the Hosts resource tab, tree mode, or the search function to find and select the host in the results list.
- Click .
Result
The host status changes to Unassigned, and finally Up when the operation is complete. Virtual machines can now run on the host.
6.5.11. Removing a Host
Summary
Remove a host from your virtualized environment.
Procedure 6.10. Removing a host
- Use the Hosts resource tab, tree mode, or the search function to find and select the host in the results list.
- Place the host into maintenance mode.
- Click to open the Remove Host(s) confirmation window.
- Select the Force Remove check box if the host is part of a Red Hat Storage cluster and has volume bricks on it, or if the host is non-responsive.
- Click .
Result
Your host has been removed from the environment and is no longer visible in the Hosts tab.
6.5.12. Customizing Hosts with Tags
Prerequisites:
Summary
You can use tags to store information about your hosts. You can then search for hosts based on tags.
Procedure 6.11. Customizing hosts with tags
- Use the Hosts resource tab, tree mode, or the search function to find and select the host in the results list.
- Click to open the Assign Tags window.
- The Assign Tags window lists all available tags. Select the check boxes of applicable tags.
- Click to assign the tags and close the window.
Result
You have added extra, searchable information about your host as tags.
6.6. Hosts and Networking
- 6.6.1. Refreshing Host Capabilities
- 6.6.2. Editing Host Network Interfaces and Adding Logical Networks to Hosts
- 6.6.3. Bonding Logic in Red Hat Enterprise Virtualization
- 6.6.4. Bonding Modes
- 6.6.5. Creating a Bond Device Using the Administration Portal
- 6.6.6. Example Uses of Custom Bonding Options with Host Interfaces
- 6.6.7. Saving a Host Network Configuration
- 6.6.8. Multiple Gateways
6.6.1. Refreshing Host Capabilities
Summary
When a network interface card is added to a host, the capabilities of the host must be refreshed to display that network interface card in the Manager.
Procedure 6.12. To Refresh Host Capabilities
- Use the resource tabs, tree mode, or the search function to find and select a host in the results list.
- Click the Refresh Capabilities button.
Result
The list of network interface cards in the Network Interfaces tab of the details pane for the selected host is updated. Any new network interface cards can now be used in the Manager.
6.6.2. Editing Host Network Interfaces and Adding Logical Networks to Hosts
Summary
You can change the settings of host network interfaces. Moving the rhevm management logical network between interfaces, and adding a newly created logical network to a network interface are common reasons to edit host networking.
Procedure 6.13. Editing Host Network Interfaces and Adding Logical Networks to Hosts
- Use the Hosts resource tab, tree mode, or the search function to find and select the host in the results.
- Click the Network Interfaces tab in the details pane to list the network interfaces attached to the host and their configurations.
- Click the button to open the Setup Host Networks window.
- Attach a logical network to a network interface by selecting and dragging a logical network into the Assigned Logical Networks area next to the network interface.Alternatively, right-click the logical network and select a network interface from the drop-down menu.
- Edit the logical networks by hovering your cursor over an assigned logical network and clicking the pencil icon to open the Edit Management Network window.If your logical network definition is not synchronized with the network configuration on the host, select the Sync network check box.Select a Boot Protocol from:Click OK.
- None,
- DHCP, or
- Static.If you have chosen Static, provide the IP, Subnet Mask, and the Gateway.
- Select the Verify connectivity between Host and Engine check box to run a network check; this will only work if the host is in maintenance mode.
- Select the Save network configuration check box if you want these network changes to be made persistent when the environment is rebooted.
- Click to implement the changes and close the window.
Result
You have assigned logical networks to network interfaces and configured the host network.
Note
If not all network interface cards for the host are displayed, click the Refresh Capabilities button to update the list of network interface cards available for that host.
6.6.3. Bonding Logic in Red Hat Enterprise Virtualization
The Red Hat Enterprise Virtualization Manager Administration Portal allows you to create bond devices using a graphical interface. There are several distinct bond creation scenarios, each with its own logic.
Two factors that affect bonding logic are:
- Are either of the devices already carrying logical networks?
- Are the devices carrying compatible logical networks? A single device cannot carry both VLAN tagged and non-VLAN tagged logical networks.
Table 6.5. Bonding Scenarios and Their Results
| Bonding Scenario | Result |
|---|---|
|
NIC + NIC
|
The Create New Bond window is displayed, and you can configure a new bond device.
If the network interfaces carry incompatible logical networks, the bonding operation fails until you detach incompatible logical networks from the devices forming your new bond.
|
|
NIC + Bond
|
The NIC is added to the bond device. Logical networks carried by the NIC and the bond are all added to the resultant bond device if they are compatible.
If the bond devices carry incompatible logical networks, the bonding operation fails until you detach incompatible logical networks from the devices forming your new bond.
|
|
Bond + Bond
|
If the bond devices are not attached to logical networks, or are attached to compatible logical networks, a new bond device is created. It contains all of the network interfaces, and carries all logical networks, of the component bond devices. The Create New Bond window is displayed, allowing you to configure your new bond.
If the bond devices carry incompatible logical networks, the bonding operation fails until you detach incompatible logical networks from the devices forming your new bond.
|
6.6.4. Bonding Modes
Red Hat Enterprise Virtualization supports the following common bonding modes:
- Mode 1 (active-backup policy) sets all interfaces to the backup state while one remains active. Upon failure on the active interface, a backup interface replaces it as the only active interface in the bond. The MAC address of the bond in mode 1 is visible on only one port (the network adapter), to prevent confusion for the switch. Mode 1 provides fault tolerance and is supported in Red Hat Enterprise Virtualization.
- Mode 2 (XOR policy) selects an interface to transmit packages to based on the result of an XOR operation on the source and destination MAC addresses modulo NIC slave count. This calculation ensures that the same interface is selected for each destination MAC address used. Mode 2 provides fault tolerance and load balancing and is supported in Red Hat Enterprise Virtualization.
- Mode 4 (IEEE 802.3ad policy) creates aggregation groups for which included interfaces share the speed and duplex settings. Mode 4 uses all interfaces in the active aggregation group in accordance with the IEEE 802.3ad specification and is supported in Red Hat Enterprise Virtualization.
- Mode 5 (adaptive transmit load balancing policy) ensures the outgoing traffic distribution is according to the load on each interface and that the current interface receives all incoming traffic. If the interface assigned to receive traffic fails, another interface is assigned the receiving role instead. Mode 5 is supported in Red Hat Enterprise Virtualization.
6.6.5. Creating a Bond Device Using the Administration Portal
Summary
You can bond compatible network devices together. This type of configuration can increase available bandwidth and reliability. You can bond multiple network interfaces, pre-existing bond devices, and combinations of the two.
A bond cannot carry both vlan tagged and non-vlan traffic.
Procedure 6.14. Creating a Bond Device using the Administration Portal
- Use the Hosts resource tab, tree mode, or the search function to find and select the host in the results list.
- Click the Network Interfaces tab in the details pane to list the physical network interfaces attached to the host.
- Click to open the Setup Host Networks window.
- Select and drag one of the devices over the top of another device and drop it to open the Create New Bond window. Alternatively, right-click the device and select another device from the drop-down menu.If the devices are incompatible, for example one is vlan tagged and the other is not, the bond operation fails with a suggestion on how to correct the compatibility issue.
- Select the Bond Name and Bonding Mode from the drop-down menus.Bonding modes 1, 2, 4, and 5 can be selected. Any other mode can be configured using the Custom option.
- Click to create the bond and close the Create New Bond window.
- Assign a logical network to the newly created bond device.
- Optionally choose to Verify connectivity between Host and Engine and Save network configuration.
- Click accept the changes and close the Setup Host Networks window.
Result:
Your network devices are linked into a bond device and can be edited as a single interface. The bond device is listed in the Network Interfaces tab of the details pane for the selected host.
Bonding must be enabled for the ports of the switch used by the host. The process by which bonding is enabled is slightly different for each switch; consult the manual provided by your switch vendor for detailed information on how to enable bonding.
6.6.6. Example Uses of Custom Bonding Options with Host Interfaces
You can create customized bond devices by selecting Custom from the Bonding Mode of the Create New Bond window. The following examples should be adapted for your needs. For a comprehensive list of bonding options and their descriptions, see the Linux Ethernet Bonding Driver HOWTO on Kernel.org.
Example 6.1. xmit_hash_policy
This option defines the transmit load balancing policy for bonding modes 2 and 4. For example, if the majority of your traffic is between many different IP addresses, you may want to set a policy to balance by IP address. You can set this load-balancing policy by selecting a Custom bonding mode, and entering the following into the text field:
mode=4, xmit_hash_policy=layer2+3
Example 6.2. ARP Monitoring
ARP monitor is useful for systems which can't or don't report link-state properly via ethtool. Set an
arp_interval on the bond device of the host by selecting a Custom bonding mode, and entering the following into the text field:
mode=1, arp_interval=1, arp_ip_target=192.168.0.2
Example 6.3. Primary
You may want to designate a NIC with higher throughput as the primary interface in a bond device. Designate which NIC is primary by selecting a Custom bonding mode, and entering the following into the text field:
mode=1, primary=eth0
6.6.7. Saving a Host Network Configuration
Summary
One of the options when configuring a host network is to save the configuration as you apply it, making the changes persistent.
Any changes made to the host network configuration will be temporary if you did not select the Save network configuration check box in the Setup Host Networks window.
Save the host network configuration to make it persistent.
Procedure 6.15. Saving a host network configuration
- Use the Hosts resource tab, tree mode, or the search function to find and select the host in the results list.
- Click the tab on the Details pane to list the NICs on the host, their address, and other specifications.
- Click the button.
- The host network configuration is saved and the following message is displayed on the task bar: "Network changes were saved on host [Hostname]."
Result
The host's network configuration is saved persistently and will survive reboots.
Note
Saving the host network configuration also updates the list of available network interfaces for the host. This behavior is similar to that of the Refresh Capabilities button.
6.6.8. Multiple Gateways
Summary
Users can define the gateway, along with the IP address and subnet mask, for a logical network. This is necessary when multiple networks exist on a host and traffic should be routed through the specified network, rather than the default gateway.
If multiple networks exist on a host and the gateways are not defined, return traffic will be routed through the default gateway, which may not reach the intended destination. This would result in users being unable to ping the host.
Red Hat Enterprise Virtualization 3.3 handles multiple gateways automatically whenever an interface goes up or down.
Procedure 6.16. Viewing or Editing the Gateway for a Logical Network
- Use the Hosts resource tab, tree mode, or the search function to find and select the host in the results list.
- Click the Network Interfaces tab in the details pane to list the network interfaces attached to the host and their configurations.
- Click the button to open the Setup Host Networks window.
- Hover your cursor over an assigned logical network and click the pencil icon to open the Edit Management Network window.
Result
The Edit Management Network window displays the network name, the boot protocol, and the IP, subnet mask, and gateway addresses. The address information can be manually edited by selecting a Static boot protocol.
6.7. Host Resilience
6.7.1. Host High Availability
The Red Hat Enterprise Virtualization Manager uses fencing to keep the hosts in a cluster responsive. A Non Responsive host is different from a Non Operational host. Non Operational hosts can be communicated with by the Manager, but have an incorrect configuration, for example a missing logical network. Non Responsive hosts cannot be communicated with by the Manager.
If a host with a power management device loses communication with the Manager, it can be fenced (rebooted) from the Administration Portal. All the virtual machines running on that host are stopped, and highly available virtual machines are started on a different host.
All power management operations are done using a proxy host, as opposed to directly by the Red Hat Enterprise Virtualization Manager. At least two hosts are required for power management operations.
Fencing allows a cluster to react to unexpected host failures as well as enforce power saving, load balancing, and virtual machine availability policies. You should configure the fencing parameters for your host's power management device and test their correctness from time to time.
Hosts can be fenced automatically using the power management parameters, or manually by right-clicking on a host and using the options on the menu. In a fencing operation, an unresponsive host is rebooted, and if the host does not return to an active status within a prescribed time, it remains unresponsive pending manual intervention and troubleshooting.
If the host is required to run virtual machines that are highly available, power management must be enabled and configured.
6.7.2. Power Management by Proxy in Red Hat Enterprise Virtualization
The Red Hat Enterprise Virtualization Manager does not communicate directly with fence agents. Instead, the Manager uses a proxy to send power management commands to a host power management device. The Manager uses VDSM to execute power management device actions, so another host in the environment is used as a fencing proxy.
You can select between:
- Any host in the same cluster as the host requiring fencing.
- Any host in the same data center as the host requiring fencing.
A viable fencing proxy host has a status of either UP or Maintenance.
6.7.3. Setting Fencing Parameters on a Host
The parameters for host fencing are set using the Power Management fields on the New Host or Edit Host windows. Power management enables the system to fence a troublesome host using an additional interface such as a Remote Access Card (RAC).
All power management operations are done using a proxy host, as opposed to directly by the Red Hat Enterprise Virtualization Manager. At least two hosts are required for power management operations.
Procedure 6.17. Setting fencing parameters on a host
- Use the Hosts resource tab, tree mode, or the search function to find and select the host in the results list.
- Click to open the Edit Host window.
- Click the Power Management tab.
- Select the Enable Power Management check box to enable the fields.
- The Primary option is selected by default if you are configuring a new power management device. If you are adding a new device, set it to Secondary.
- Select the Concurrent check box to enable multiple fence agents to be used concurrently.
- Enter the Address, User Name, and Password of the power management device.
- Select the power management device Type from the drop-down menu.
- Enter the Port number used by the power management device to communicate with the host.
- Enter the specific Options of the power management device. Use a comma-separated list of 'key=value' or 'key' entries.
- Click the button to test the power management device. Test Succeeded, Host Status is: on will display upon successful verification.
Warning
Power management parameters (userid, password, options, etc) are tested by Red Hat Enterprise Virtualization Manager only during setup and manually after that. If you choose to ignore alerts about incorrect parameters, or if the parameters are changed on the power management hardware without the corresponding change in Red Hat Enterprise Virtualization Manager, fencing is likely to fail when most needed. - Click to save the changes and close the window.
Result
You are returned to the list of hosts. Note that the exclamation mark next to the host's name has now disappeared, signifying that power management has been successfully configured.
6.7.4. Soft-Fencing Hosts
Sometimes a host becomes non-responsive due to an unexpected problem, and though VDSM is unable to respond to requests, the virtual machines that depend upon VDSM remain alive and accessible. In these situations, restarting VDSM returns VDSM to a responsive state and resolves this issue.
Red Hat Enterprise Virtualization 3.3 introduces "soft-fencing over SSH". Prior to Red Hat Enterprise Virtualization 3.3, non-responsive hosts were fenced only by external fencing devices. In Red Hat Enterprise Virtualization 3.3, the fencing process has been expanded to include "SSH Soft Fencing", a process whereby the Manager attempts to restart VDSM via SSH on non-responsive hosts. If the Manager fails to restart VDSM via SSH, the responsibility for fencing falls to the external fencing agent if an external fencing agent has been configured.
Soft-fencing over SSH works as follows. Fencing must be configured and enabled on the host, and a valid proxy host (a second host, in an UP state, in the data center) must exist. When the connection between the Manager and the host times out, the following happens:
- On the first network failure, the status of the host changes to "connecting".
- The Manager then makes three attempts to ask VDSM for its status, or it waits for an interval determined by the load on the host. The formula for determining the length of the interval is configured by the configuration values TimeoutToResetVdsInSeconds (the default is 60 seconds) + [DelayResetPerVmInSeconds (the default is 0.5 seconds)]*(the count of running vms on host) + [DelayResetForSpmInSeconds (the default is 20 seconds)] * 1 (if host runs as SPM) or 0 (if the host does not run as SPM). To give VDSM the maximum amount of time to respond, the Manager chooses the longer of the two options mentioned above (three attempts to retrieve the status of VDSM or the interval determined by the above formula).
- If the host does not respond when that interval has elapsed,
vdsm restartis executed via SSH. - If
vdsm restartdoes not succeed in re-establishing the connection between the host and the Manager, the status of the host changes toNon Responsiveand, if power management is configured, fencing is handed off to the external fencing agent.
Note
Soft-fencing over SSH can be executed on hosts that have no power management configured. This is distinct from "fencing": fencing can be executed only on hosts that have power management configured.
6.7.5. Using Host Power Management Functions
Prerequisites:
Summary
When power management has been configured for a host, you can access a number of options from the Administration Portal interface. While each power management device has its own customizable options, they all support the basic options to start, stop, and restart a host.
Procedure 6.18. Using Host Power Management Functions
- Use the Hosts resource tab, tree mode, or the search function to find and select the host in the results list.
- Click the Power Management drop-down menu.
- Select one of the following options:
- Restart: This option stops the host and waits until the host's status changes to
Down. When the agent has verified that the host is down, the highly available virtual machines are restarted on another host in the cluster. The agent then restarts this host. When the host is ready for use its status displays asUp. - Start: This option starts the host and lets it join a cluster. When it is ready for use its status displays as
Up. - Stop: This option powers off the host. Before using this option, ensure that the virtual machines running on the host have been migrated to other hosts in the cluster. Otherwise the virtual machines will crash and only the highly available virtual machines will be restarted on another host. When the host has been stopped its status displays as
Non-Operational.
Important
When two fencing agents are defined on a host, they can be used concurrently or sequentially. For concurrent agents, both agents have to respond to the Stop command for the host to be stopped; and when one agent responds to the Start command, the host will go up. For sequential agents, to start or stop a host, the primary agent is used first; if it fails, the secondary agent is used. - Selecting one of the above options opens a confirmation window. Click OK to confirm and proceed.
Result
The selected action is performed.
6.7.6. Manually Fencing or Isolating a Non Responsive Host
Summary
If a host unpredictably goes into a non-responsive state, for example, due to a hardware failure; it can significantly affect the performance of the environment. If you do not have a power management device, or it is incorrectly configured, you can reboot the host manually.
Warning
Do not use the Confirm host has been rebooted option unless you have manually rebooted the host. Using this option while the host is still running can lead to a virtual machine image corruption.
Procedure 6.19. Manually fencing or isolating a non-responsive host
- On the Hosts tab, select the host. The status must display as
non-responsive. - Manually reboot the host. This could mean physically entering the lab and rebooting the host.
- On the Administration Portal, right-click the host entry and select the button.
- A message displays prompting you to ensure that the host has been shut down or rebooted. Select the Approve Operation check box and click OK.
Result
You have manually rebooted your host, allowing highly available virtual machines to be started on active hosts. You confirmed your manual fencing action in the Administrator Portal, and the host is back online.
6.8. Hosts and Permissions
6.8.1. Managing System Permissions for a Host
The system administrator, as the SuperUser, manages all aspects of the Administration Portal. More specific administrative roles can be assigned to other users. These restricted administrator roles are useful for empowering a user with certain administrative privileges that limit them to a specific resource: a DataCenterAdmin role has administrator privileges only for the assigned data center, a HostAdmin has administrator privileges only for the assigned host, and so forth.
A host administrator is a system administration role for a specific host only. This is useful in clusters with multiple hosts, where each host requires a system administrator. You can use the Configure button in the header bar to assign a host administrator for all hosts in the environment.
The host administrator role permits the following actions:
- Edit the configuration of the host;
- Set up the logical networks; and
- Remove the host.
You can also change the system administrator of a host by removing the existing system administrator and adding the new system administrator.
6.8.2. Host Administrator Roles Explained
Host Permission Roles
The table below describes the administrator roles and privileges applicable to host administration.
Table 6.6. Red Hat Enterprise Virtualization System Administrator Roles
| Role | Privileges | Notes |
|---|---|---|
| HostAdmin | Host Administrator | Can configure, manage, and remove a specific host. Can also perform network-related operations on a specific host. |
6.8.3. Assigning an Administrator or User Role to a Resource
Summary
Assign administrator or user roles to resources to allow users to access or manage that resource.
Procedure 6.20. Assigning a Role to a Resource
- Use the resource tabs, tree mode, or the search function to find and select the resource in the results list.
- Click the tab of the details pane to list the assigned users, the user's role, and the inherited permissions for the selected resource.
- Click to open the Add Permission to User window.
- Enter the name or user name of an existing user into the Search text box and click . Select a user from the resulting list of possible matches.
- Select a role from the Role to Assign: drop-down menu.
- Click to assign the role and close the window.
Result
You have assigned a role to a user; the user now has the inherited permissions of that role enabled for that resource.
6.8.4. Removing an Administrator or User Role from a Resource
Summary
Remove an administrator or user role from a resource; the user loses the inherited permissions associated with the role for that resource.
Procedure 6.21. Removing a Role from a Resource
- Use the resource tabs, tree mode, or the search function to find and select the resource in the results list.
- Click the tab of the details pane to list the assigned users, the user's role, and the inherited permissions for the selected resource.
- Select the user to remove from the resource.
- Click . The Remove Permission window opens to confirm permissions removal.
- Click to remove the user role.
Result
You have removed the user's role, and the associated permissions, from the resource.
Chapter 7. Storage Domains
- 7.1. Understanding Storage Domains
- 7.2. Storage Metadata Versions in Red Hat Enterprise Virtualization
- 7.3. Preparing and Adding File-based Storage
- 7.4. Preparing and Adding Red Hat Storage (GlusterFS) Storage Domains
- 7.5. Adding POSIX Compliant File System Storage
- 7.6. Preparing and Adding Block-based Storage
- 7.7. Storage Tasks
- 7.8. Storage and Permissions
Red Hat Enterprise Virtualization uses a centralized storage system for virtual machine disk images, ISO files and snapshots. Storage networking can be implemented using:
Setting up storage is a prerequisite for a new data center because a data center cannot be initialized unless storage domains are attached and activated.
- Network File System (NFS)
- GlusterFS exports
- Other POSIX compliant file systems
- Internet Small Computer System Interface (iSCSI)
- Local storage attached directly to the virtualization hosts
- Fibre Channel Protocol (FCP)
- Parallel NFS (pNFS)
As a Red Hat Enterprise Virtualization system administrator, you need to create, configure, attach and maintain storage for the virtualized enterprise. You should be familiar with the storage types and their use. Read your storage array vendor's guides, and refer to the Red Hat Enterprise Linux Storage Administration Guide for more information on the concepts, protocols, requirements or general usage of storage.
The Red Hat Enterprise Virtualization platform enables you to assign and manage storage using the Administration Portal's Storage tab. The Storage results list displays all the storage domains, and the details pane shows general information about the domain.
Red Hat Enterprise Virtualization platform has three types of storage domains:
- Data Domain: A data domain holds the virtual hard disks and OVF files of all the virtual machines and templates in a data center. In addition, snapshots of the virtual machines are also stored in the data domain.The data domain cannot be shared across data centers, and the data domain must be of the same type as the data center. For example, a data center of a iSCSI type, must have an iSCSI data domain.You must attach a data domain to a data center before you can attach domains of other types to it.
- ISO Domain: ISO domains store ISO files (or logical CDs) used to install and boot operating systems and applications for the virtual machines. An ISO domain removes the data center's need for physical media. An ISO domain can be shared across different data centers.
- Export Domain: Export domains are temporary storage repositories that are used to copy and move images between data centers and Red Hat Enterprise Virtualization environments. Export domains can be used to backup virtual machines. An export domain can be moved between data centers, however, it can only be active in one data center at a time.
Important
Support for export storage domains backed by storage on anything other than NFS is being deprecated. While existing export storage domains imported from Red Hat Enterprise Virtualization 2.2 environments remain supported new export storage domains must be created on NFS storage.
Only commence configuring and attaching storage for your Red Hat Enterprise Virtualization environment once you have determined the storage needs of your data center(s).
Important
To add storage domains you must be able to successfully access the Administration Portal, and there must be at least one host connected with a status of
Up.
7.1. Understanding Storage Domains
A storage domain is a collection of images that have a common storage interface. A storage domain contains complete images of templates and virtual machines (including snapshots), or ISO files. A storage domain can be made of either block devices (SAN - iSCSI or FCP) or a file system (NAS - NFS, GlusterFS, or other POSIX compliant file systems).
On NFS, all virtual disks, templates, and snapshots are files.
On SAN (iSCSI/FCP), each virtual disk, template or snapshot is a logical volume. Block devices are aggregated into a logical entity called a volume group, and then divided by LVM (Logical Volume Manager) into logical volumes for use as virtual hard disks. See Red Hat Enterprise Linux Logical Volume Manager Administration Guide for more information on LVM.
Virtual disks can have one of two formats, either Qcow2 or RAW. The type of storage can be either Sparse or Preallocated. Snapshots are always sparse but can be taken for disks created either as RAW or sparse.
Virtual machines that share the same storage domain can be migrated between hosts that belong to the same cluster.
7.2. Storage Metadata Versions in Red Hat Enterprise Virtualization
Red Hat Enterprise Virtualization stores information about storage domains as metadata on the storage domains themselves. Each major release of Red Hat Enterprise Virtualization has seen improved implementations of storage metadata.
- V1 metadata (Red Hat Enterprise Virtualization 2.x series)Each storage domain contains metadata describing its own structure, and all of the names of physical volumes that are used to back virtual machine disk images.Master domains additionally contain metadata for all the domains and physical volume names in the storage pool. The total size of this metadata is limited to 2 kb, limiting the number of storage domains that can be in a pool.Template and virtual machine base images are read only.V1 metadata is applicable to NFS, iSCSI, and FC storage domains.
- V2 metadata (Red Hat Enterprise Virtualization 3.0)All storage domain and pool metadata is stored as logical volume tags rather than written to a logical volume. Metadata about virtual machine disk volumes is still stored in a logical volume on the domains.Physical volume names are no longer included in the metadata.Template and virtual machine base images are read only.V2 metadata is applicable to iSCSI, and FC storage domains.
- V3 metadata (Red Hat Enterprise Virtualization 3.1+)All storage domain and pool metadata is stored as logical volume tags rather than written to a logical volume. Metadata about virtual machine disk volumes is still stored in a logical volume on the domains.Virtual machine and template base images are no longer read only. This change enables live snapshots, live storage migration, and clone from snapshot.Support for unicode metadata is added, for non-English volume names.V3 metadata is applicable to NFS, GlusterFS, POSIX, iSCSI, and FC storage domains.
Note
Upgrades between metadata versions are automatic. If you've upgraded from Red Hat Enterprise Virtualization 3.0 to 3.1, your existing data centers are initially in 3.0 compatibility mode. When you upgrade your hosts and change your data center compatibility from 3.0 to 3.1, the storage metadata for your storage domains is automatically upgraded to version 3.
7.3. Preparing and Adding File-based Storage
7.3.1. Preparing NFS Storage
Summary
These steps must be taken to prepare an NFS file share on a server running Red Hat Enterprise Linux 6 for use with Red Hat Enterprise Virtualization.
Procedure 7.1. Preparing NFS Storage
Install nfs-utils
NFS functionality is provided by the nfs-utils package. Before file shares can be created, check that the package is installed by querying the RPM database for the system:$
rpm -qi nfs-utilsIf the nfs-utils package is installed then the package information will be displayed. If no output is displayed then the package is not currently installed. Install it usingyumwhile logged in as therootuser:#
yum install nfs-utilsConfigure Boot Scripts
To ensure that NFS shares are always available when the system is operational both thenfsandrpcbindservices must start at boot time. Use thechkconfigcommand while logged in asrootto modify the boot scripts.#
chkconfig --add rpcbind#chkconfig --add nfs#chkconfig rpcbind on#chkconfig nfs onOnce the boot script configuration has been done, start the services for the first time.#
service rpcbind start#service nfs startCreate Directory
Create the directory you wish to share using NFS.#
mkdir /exports/isoReplace /exports/iso with the name, and path of the directory you wish to use.Export Directory
To be accessible over the network using NFS the directory must be exported. NFS exports are controlled using the/etc/exportsconfiguration file. Each export path appears on a separate line followed by a tab character and any additional NFS options. Exports to be attached to the Red Hat Enterprise Virtualization Manager must have the read, and write, options set.To grant read, and write access to/exports/isousing NFS for example you add the following line to the/etc/exportsfile./exports/iso *(rw)
Again, replace /exports/iso with the name, and path of the directory you wish to use.Reload NFS Configuration
For the changes to the/etc/exportsfile to take effect the service must be told to reload the configuration. To force the service to reload the configuration run the following command asroot:#
service nfs reloadSet Permissions
The NFS export directory must be configured for read write access and must be owned by vdsm:kvm. If these users do not exist on your external NFS server use the following command, assuming that/exports/isois the directory to be used as an NFS share.#
chown -R 36:36 /exports/isoThe permissions on the directory must be set to allow read and write access to both the owner and the group. The owner should also have execute access to the directory. The permissions are set using thechmodcommand. The following command arguments set the required permissions on the/exports/isodirectory.#
chmod 0755 /exports/iso
Result
The NFS file share has been created, and is ready to be attached by the Red Hat Enterprise Virtualization Manager.
7.3.2. Attaching NFS Storage
Summary
An NFS type Storage Domain is a mounted NFS share that is attached to a data center. It is used to provide storage for virtualized guest images and ISO boot media. Once NFS storage has been exported it must be attached to the Red Hat Enterprise Virtualization Manager using the Administration Portal.
NFS data domains can be added to NFS data centers. You can add NFS, ISO, and export storage domains to data centers of any type.
Procedure 7.2. Attaching NFS Storage
- Click the resource tab to list the existing storage domains.
- Click to open the New Domain window.
- Enter the Name of the storage domain.
- Select the Data Center, Domain Function / Storage Type, and Use Host from the drop-down menus.If applicable, select the Format from the drop-down menu.
- Enter the Export Path to be used for the storage domain.The export path should be in the format of
192.168.0.10:/data or domain.example.com:/data - Click to enable further configurable settings. It is recommended that the values of these parameters not be modified.
Important
All communication to the storage domain is from the selected host and not directly from the Red Hat Enterprise Virtualization Manager. At least one active host must be attached to the chosen Data Center before the storage is configured. - Click OK to create the storage domain and close the window.
Result
The new NFS data domain is displayed on the Storage tab with a status of Locked while the disk prepares. It is automatically attached to the data center upon completion.
7.3.3. Preparing Local Storage
Summary
A local storage domain can be set up on a host. When you set up host to use local storage, the host automatically gets added to a new data center and cluster that no other hosts can be added to. Multiple host clusters require that all hosts have access to all storage domains, which is not possible with local storage. Virtual machines created in a single host cluster cannot be migrated, fenced or scheduled.
Important
On Red Hat Enterprise Virtualization Hypervisors the only path permitted for use as local storage is
/data/images. This directory already exists with the correct permissions on Hypervisor installations. The steps in this procedure are only required when preparing local storage on Red Hat Enterprise Linux virtualization hosts.
Procedure 7.3. Preparing Local Storage
- On the virtualization host, create the directory to be used for the local storage.
# mkdir -p /data/images
- Ensure that the directory has permissions allowing read/write access to the
vdsmuser (UID 36) andkvmgroup (GID 36).# chown 36:36 /data /data/images
# chmod 0755 /data /data/images
Result
Your local storage is ready to be added to the Red Hat Enterprise Virtualization environment.
7.3.4. Adding Local Storage
Summary
Storage local to your host has been prepared. Now use the Manager to add it to the host.
Adding local storage to a host in this manner causes the host to be put in a new data center and cluster. The local storage configuration window combines the creation of a data center, a cluster, and storage into a single process.
Procedure 7.4. Adding Local Storage
- Use the Hosts resource tab, tree mode, or the search function to find and select the host in the results list.
- Click Maintenance to place the host into maintenance mode.
- Click to open the Configure Local Storage window.
- Click the buttons next to the Data Center, Cluster, and Storage fields to configure and name the local storage domain.
- Set the path to your local storage in the text entry field.
- If applicable, select the Memory Optimization tab to configure the memory optimization policy for the new local storage cluster.
- Click to save the settings and close the window.
Result
Your host comes online in a data center of its own.
7.4. Preparing and Adding Red Hat Storage (GlusterFS) Storage Domains
- 7.4.1. Introduction to Red Hat Storage (GlusterFS) Volumes
- 7.4.2. Introduction to Red Hat Storage (GlusterFS) Bricks
- 7.4.3. Optimizing Red Hat Storage Volumes to Store Virtual Machine Images
- 7.4.4. Creating a Storage Volume
- 7.4.5. Explanation of Settings in the New Volume Window
- 7.4.6. Adding Bricks to a Volume
- 7.4.7. Explanation of Settings in the Add Bricks Window
7.4.1. Introduction to Red Hat Storage (GlusterFS) Volumes
Red Hat Storage volumes combine storage from more than one Red Hat Storage server into a single global namespace. A volume is a collection of bricks, where each brick is a mountpoint or directory on a Red Hat Storage Server in the trusted storage pool.
Most of the management operations of Red Hat Storage happen on the volume.
You can use the Administration Portal to create and start new volumes. You can monitor volumes in your Red Hat Storage cluster from the Volumes tab.
While volumes can be created and managed from the Administration Portal, bricks must be created on the individual Red Hat Storage nodes before they can be added to volumes using the Administration Portal
7.4.2. Introduction to Red Hat Storage (GlusterFS) Bricks
Bricks are the basic unit of storage in Red Hat Storage, and they are combined into volumes. Each brick is a directory or mountpoint. XFS is the recommended brick filesystem.
When adding a brick to a volume, the brick is expressed by combining a server address with export directory path in the following format: SERVER:EXPORT
For example: myhostname:/exports/myexportdir/
While volumes can be created using the Administration Portal, bricks must be manually created on Red Hat Storage nodes. Only after the directory structure is in place can bricks be added to volumes.
If your brick consists of a mounted device with an XFS filesystem as opposed to a directory in an XFS filesystem, consider making the mount permanent across reboots by adding it to the
/etc/fstab file.
7.4.3. Optimizing Red Hat Storage Volumes to Store Virtual Machine Images
Optimize a Red Hat Storage volume to store virtual machine images using the Administration Portal.
To optimize a volume for storing virtual machines, the Manager sets a number of virtualization-specific parameters for the volume.
Important
Red Hat Storage currently supports Red Hat Enterprise Virtualization 3.1 and above. All Gluster clusters and hosts must be attached to data centers which are compatible with versions higher than 3.0.
Volumes can be optimized to store virtual machines during creation by selecting the Optimize for Virt Store check box, or after creation using the button from the tab.
7.4.4. Creating a Storage Volume
Summary
You can create new volumes using the Administration Portal. When creating a new volume, you must specify the bricks that comprise the volume and specify whether the volume is to be distributed, replicated, or striped.
You must create brick directories or mountpoints before you can add them to volumes.
Important
It is recommended that you use replicated volumes, where bricks exported from different hosts are combined into a volume. Replicated volumes create copies of files across multiple bricks in the volume, preventing data loss when a host is fenced.
Procedure 7.5. Creating A Storage Volume
- Click the Volumes resource tab to list existing volumes in the results list.
- Click to open the New Volume window.
- Use the drop-down menus to select the Data Center and Volume Cluster.
- Enter the Name of the volume.
- Use the drop-down menu to select the Type of the volume.
- If active, select the appropriate Transport Type check box.
- Click the button to select bricks to add to the volume. Bricks must be created externally on the Red Hat Storage nodes.
- If active, use the Gluster, NFS, and CIFS check boxes to select the appropriate access protocols used for the volume.
- Enter the volume access control as a comma-separated list of IP addresses or hostnames in the Allow Access From field.You can use the * wildcard to specify ranges of addresses of IP addresses or hostnames.
- Select the Optimize for Virt Store option to set the parameters to optimize your volume for virtual machine storage. Select this if you intend to use this volume as a storage domain.
- Click to create the volume. The new volume is added and displays on the Volume tab.
Result
You've added a Red Hat Storage volume. You can now use it for storage.
7.4.5. Explanation of Settings in the New Volume Window
This table contains description of settings and options in the New Volume window.
Table 7.1.
| Setting Name | Description |
|---|---|
|
Data Center
|
The data center that the Red Hat Storage nodes hosting your new volume are a part of.
|
|
Volume Cluster
|
The cluster that the Red Hat Storage nodes hosting your new volume are a part of.
|
|
Name
|
The name of your new volume.
|
|
Type
|
The type of volume you are creating. Select one of:
|
|
Replica count
|
Number of replicas to keep of each stored item.
|
|
Stripe count
|
Number of bricks to stripe each file across.
|
|
Transport Type
|
The transport protocol used to communicate between Red Hat Storage nodes.
|
|
Bricks
|
Directories or mount points that will be combined into the new volume.
|
|
Access Protocols
|
Choose from:
|
|
Allow Access From
|
Specify hosts allowed to access the volume. Use a comma separated list of IP Addresses or hostnames, using the * as a wildcard to specify ranges.
|
|
Optimize for Virt Store
|
Set parameters on the volume to provide enhanced performance when used as virtual machine storage.
|
7.4.6. Adding Bricks to a Volume
Summary
You can expand your volumes by adding new bricks. You need to add at least one brick to a distributed volume, multiples of two bricks to replicated volumes, multiples of four bricks to striped volumes when expanding your storage space.
Procedure 7.6. Adding Bricks to a Volume
- On the Volumes tab on the navigation pane, select the volume to which you want to add bricks.
- Select the volume you want to add new bricks to. Click the tab from the Details pane.
- Click to open the Add Bricks window.
- Use the Server drop-down menu to select the server on which the brick resides.
- Enter the path of the Brick Directory. The directory must already exist.
- Click . The brick appears in the list of bricks in the volume, with server addresses and brick directory names.
- Click .
Result
The new bricks are added to the volume and the bricks display in the volume's Bricks tab.
7.4.7. Explanation of Settings in the Add Bricks Window
Table 7.2. Add Bricks Tab Properties
|
Field Name
|
Description
|
|---|---|
|
Volume Type
|
Displays the type of volume. This field cannot be changed, it was set when you created the volume.
|
|
Server
|
The server where the bricks are hosted.
|
| Brick Directory |
The brick direcory or mountpoint.
|
7.5. Adding POSIX Compliant File System Storage
Red Hat Enterprise Virtualization 3.1 and higher supports the use of POSIX (native) file systems for storage. POSIX file system support allows you to mount file systems using the same mount options that you would normally use when mounting them manually from the command line. This functionality is intended to allow access to storage not exposed using NFS, iSCSI, or FCP.
Any POSIX compliant filesystem used as a storage domain in Red Hat Enterprise Virtualization MUST support sparse files and direct I/O. The Common Internet File System (CIFS), for example, does not support direct I/O, making it incompatible with Red Hat Enterprise Virtualization.
Important
Do not mount NFS storage by creating a POSIX compliant file system Storage Domain. Always create an NFS Storage Domain instead.
7.5.1. Attaching POSIX Compliant File System Storage
Summary
You want to use a POSIX compliant file system that is not exposed using NFS, iSCSI, or FCP as a storage domain.
Procedure 7.7. Attaching POSIX Compliant File System Storage
- Click the Storage resource tab to list the existing storage domains in the results list.
- Click New Domain to open the New Domain window.
- Enter the Name for the storage domain.
- Select the Data Center to be associated with the storage domain. The Data Center selected must be of type POSIX (POSIX compliant FS). Alternatively, select
(none). - Select
Data / POSIX compliant FSfrom the Domain Function / Storage Type drop-down menu.If applicable, select the Format from the drop-down menu. - Select a host from the Use Host drop-down menu. Only hosts within the selected data center will be listed. The host that you select will be used to connect the storage domain.
- Enter the Path to the POSIX file system, as you would normally provide it to the
mountcommand. - Enter the VFS Type, as you would normally provide it to the
mountcommand using the-targument. Seeman mountfor a list of valid VFS types. - Enter additional Mount Options, as you would normally provide them to the
mountcommand using the-oargument. The mount options should be provided in a comma-separated list. Seeman mountfor a list of valid mount options. - Click OK to attach the new Storage Domain and close the window.
Result
You have used a supported mechanism to attach an unsupported file system as a storage domain.
7.5.2. Preparing pNFS Storage
Support for Parallel NFS (pNFS) as part of the NFS v4.1 standard is available as of Red Hat Enterprise Linux 6.4. The pNFS architecture improves the scalability of NFS, with possible improvements to performance. That is, when a server implements pNFS as well, a client is able to access data through multiple servers concurrently. The pNFS protocol supports three storage protocols or layouts: files, objects, and blocks. Red Hat Enterprise Linux 6.4 supports only the "files" layout type.
To enable support for pNFS functionality, use one of the following mount options on mounts from a pNFS-enabled server:
-o minorversion=1
or
-o v4.1
Set the permissions of the pNFS path so that Red Hat Enterprise Virtualization can access them:
# chown 36:36 [path to pNFS resource]
After the server is pNFS-enabled, the nfs_layout_nfsv41_files kernel is automatically loaded on the first mount. Verify that the module was loaded:
$lsmod | grep nfs_layout_nfsv41_files
Another way to verify a successful NFSv4.1 mount is with the mount command. The mount entry in the output should contain minorversion=1.
7.5.3. Attaching pNFS Storage
Summary
A pNFS type Storage Domain is a mounted pNFS share attached to a data center. It provides storage for virtualized guest images and ISO boot media. After you have exported pNFS storage, it must be attached to the Red Hat Enterprise Virtualization Manager using the Administration Portal.
Procedure 7.8. Attaching pNFS Storage
- Click the resource tab to list the existing storage domains.
- Click to open the New Domain window.
- Enter the Name of the storage domain.
- Select the Data Center, Domain Function / Storage Type, and Use Host from the drop-down menus.If applicable, select the Format from the drop-down menu.
- Enter the Export Path to be used for the storage domain.The export path should be in the format of
192.168.0.10:/dataordomain.example.com:/data - In the VFS Type field, enter
nfs4. - In the Mount Options field, enter
minorversion=1.Important
All communication to the storage domain comes from the selected host and not from the Red Hat Enterprise Virtualization Manager. At least one active host must be attached to the chosen Data Center before the storage is configured. - Click OK to create the storage domain and close the window.
Result
The new pNFS data domain is displayed on the Storage tab with a status of Locked while the disk prepares. It is automatically attached to the data center upon completion.
7.6. Preparing and Adding Block-based Storage
7.6.1. Preparing iSCSI Storage
Summary
These steps must be taken to export iSCSI storage device from a server running Red Hat Enterprise Linux 6 to use as a storage domain with Red Hat Enterprise Virtualization.
Procedure 7.9. Preparing iSCSI Storage
- Install the scsi-target-utils package using the
yumcommand as root on your storage server.# yum install -y scsi-target-utils
- Add the devices or files you want to export to the
/etc/tgt/targets.conffile. Here is a generic example of a basic addition to thetargets.conffile:<target iqn.YEAR-MONTH.com.EXAMPLE:SERVER.targetX> backing-store /PATH/TO/DEVICE1 # Becomes LUN 1 backing-store /PATH/TO/DEVICE2 # Becomes LUN 2 backing-store /PATH/TO/DEVICE3 # Becomes LUN 3 </target>Targets are conventionally defined using the year and month they are created, the reversed fully qualified domain that the server is in, the server name, and a target number. - Start the tgtd service.
# service tgtd start
- Make the tgtd start persistently across reboots.
# chkconfig tgtd on
- Open an iptables firewall port to allow clients to access your iSCSI export. By default, iSCSI uses port 3260. This example inserts a firewall rule at position 6 in the INPUT table.
# iptables -I INPUT 6 -p tcp --dport 3260 -j ACCEPT
- Save the iptables rule you just created.
# service iptables save
Result
You have created a basic iSCSI export. You can use it as an iSCSI data domain.
7.6.2. Adding iSCSI Storage
Summary
Red Hat Enterprise Virtualization platform supports iSCSI storage by creating a storage domain from a volume group made of pre-existing LUNs. Neither volume groups nor LUNs can be attached to more than one storage domain at a time.
For information regarding the setup and configuration of iSCSI on Red Hat Enterprise Linux, see the Red Hat Enterprise Linux Storage Administration Guide.
Note
You can only add an iSCSI storage domain to a data center that is set up for iSCSI storage type.
Procedure 7.10. Adding iSCSI Storage
- Click the Storage resource tab to list the existing storage domains in the results list.
- Click the button to open the New Domain window.
- Enter the Name of the new storage domain.
- Use the Data Center drop-down menu to select an iSCSI data center.If you do not yet have an appropriate iSCSI data center, select
(none). - Use the drop-down menus to select the Domain Function / Storage Type and the Format. The storage domain types that are not compatible with the chosen data center are not available.
- Select an active host in the Use Host field. If this is not the first data domain in a data center, you must select the data center's SPM host.
Important
All communication to the storage domain is via the selected host and not directly from the Red Hat Enterprise Virtualization Manager. At least one active host must exist in the system, and be attached to the chosen data center, before the storage is configured. - The Red Hat Enterprise Virtualization Manager is able to map either iSCSI targets to LUNs, or LUNs to iSCSI targets. The New Domain window automatically displays known targets with unused LUNs when iSCSI is selected as the storage type. If the target that you are adding storage from is not listed then you can use target discovery to find it, otherwise proceed to the next step.
iSCSI Target Discovery
- Click Discover Targets to enable target discovery options. When targets have been discovered and logged in to, the New Domain window automatically displays targets with LUNs unused by the environment.
Note
LUNs used externally to the environment are also displayed.You can use the Discover Targets options to add LUNs on many targets, or multiple paths to the same LUNs. - Enter the fully qualified domain name or IP address of the iSCSI host in the Address field.
- Enter the port to connect to the host on when browsing for targets in the Port field. The default is
3260. - If the Challenge Handshake Authentication Protocol (CHAP) is being used to secure the storage, select the User Authentication check box. Enter the CHAP user name and CHAP password.
- Click the button.
- Select the target to use from the discovery results and click the button.Alternatively, click the to log in to all of the discovered targets.
- Click the + button next to the desired target. This will expand the entry and display all unused LUNs attached to the target.
- Select the check box for each LUN that you are using to create the storage domain.
- Click to create the storage domain and close the window.
Result
The new iSCSI storage domain displays on the storage tab. This can take up to 5 minutes.
7.6.3. Adding FCP Storage
Summary
Red Hat Enterprise Virtualization platform supports SAN storage by creating a storage domain from a volume group made of pre-existing LUNs. Neither volume groups nor LUNs can be attached to more than one storage domain at a time.
Red Hat Enterprise Virtualization system administrators need a working knowledge of Storage Area Networks (SAN) concepts. SAN usually uses Fibre Channel Protocol (FCP) for traffic between hosts and shared external storage. For this reason, SAN may occasionally be referred to as FCP storage.
For information regarding the setup and configuration of FCP or multipathing on Red Hat Enterprise Linux, please refer to the Storage Administration Guide and DM Multipath Guide.
Note
You can only add an FCP storage domain to a data center that is set up for FCP storage type.
Procedure 7.11. Adding FCP Storage
- Click the resource tab to list all storage domains in the virtualized environment.
- Click to open the New Domain window.
- Enter the Name of the storage domain
- Use the Data Center drop-down menu to select an FCP data center.If you do not yet have an appropriate FCP data center, select
(none). - Use the drop-down menus to select the Domain Function / Storage Type and the Format. The storage domain types that are not compatible with the chosen data center are not available.
- Select an active host in the Use Host field. If this is not the first data domain in a data center, you must select the data center's SPM host.
Important
All communication to the storage domain is via the selected host and not directly from the Red Hat Enterprise Virtualization Manager. At least one active host must exist in the system, and be attached to the chosen data center, before the storage is configured. - The New Domain window automatically displays known targets with unused LUNs when Data / Fibre Channel is selected as the storage type. Select the LUN ID check box to select all of the available LUNs.
- Click OK to create the storage domain and close the window.
Result
The new FCP data domain displays on the tab. It will remain with a Locked status while it is being prepared for use. When ready, it is automatically attached to the data center.
7.6.4. Unusable LUNs in Red Hat Enterprise Virtualization
In certain circumstances, the Red Hat Enterprise Virtualization Manager will not allow you to use a LUN to create a storage domain or virtual machine hard disk.
- LUNs that are already part of the current Red Hat Enterprise Virtualization environment are automatically prevented from being used.
- LUNs that are already being used by the SPM host will also display as in use. You can choose to forcefully over ride the contents of these LUNs, but the operation is not guaranteed to succeed.
7.7. Storage Tasks
- 7.7.1. Importing Existing ISO or Export Storage Domains
- 7.7.2. Populating the ISO Storage Domain
- 7.7.3. Moving Storage Domains to Maintenance Mode
- 7.7.4. Editing a Resource
- 7.7.5. Activating Storage Domains
- 7.7.6. Removing a Storage Domain
- 7.7.7. Destroying a Storage Domain
- 7.7.8. Detaching the Export Domain
- 7.7.9. Attaching an Export Domain to a Data Center
7.7.1. Importing Existing ISO or Export Storage Domains
Summary
You have an ISO or export domain that you have been using with a different data center. You want to attach it to the data center you are using, and import virtual machines or use ISOs.
Procedure 7.12. Importing an Existing ISO or Export Storage Domain
- Click the resource tab to list all the available storage domains in the results list.
- Select the appropriate Domain Function / Storage Type from the following:
- ISO
- Export
The Domain Function / Storage Type determines the availability of the Format field. - Select the SPM host from the Use host drop-down menu.
Important
All communication to the storage domain is via the selected host and not from the Red Hat Enterprise Virtualization Manager. At least one host must be active and have access to the storage before the storage can be configured. - Enter the Export path of the storage. The export path can be either a static IP address or a resolvable hostname. For example,
192.168.0.10:/Images/ISOorstorage.demo.redhat.com:/exports/iso. - Click to import the domain and close the window.
- The storage domain is imported and displays on the Storage tab. The next step is to attach it to a data center. This is described later in this chapter, .
Result
You have imported your export or ISO domain to you data center. Attach it to a data center to use it.
7.7.2. Populating the ISO Storage Domain
Summary
An ISO storage domain is attached to a data center, ISO images must be uploaded to it. Red Hat Enterprise Virtualization provides an ISO uploader tool that ensures that the images are uploaded into the correct directory path, with the correct user permissions.
The creation of ISO images from physical media is not described in this document. It is assumed that you have access to the images required for your environment.
Procedure 7.13. Populating the ISO Storage Domain
- Copy the required ISO image to a temporary directory on the system running Red Hat Enterprise Virtualization Manager.
- Log in to the system running Red Hat Enterprise Virtualization Manager as the
rootuser. - Use the
engine-iso-uploadercommand to upload the ISO image. This action will take some time, the amount of time varies depending on the size of the image being uploaded and available network bandwidth.Example 7.1. ISO Uploader Usage
In this example the ISO imageRHEL6.isois uploaded to the ISO domain calledISODomainusing NFS. The command will prompt for an administrative user name and password. The user name must be provided in the form user name@domain.#
engine-iso-uploader--iso-domain=ISODomainuploadRHEL6.iso
Result
The ISO image is uploaded and appears in the ISO storage domain specified. It is also available in the list of available boot media when creating virtual machines in the data center which the storage domain is attached to.
7.7.3. Moving Storage Domains to Maintenance Mode
Summary
Detaching and removing storage domains requires that they be in maintenance mode. This is required to redesignate another data domain as the master data domain.
Editing domains and expanding iSCSI domains by adding more LUNs can only be done when the domain is active.
Important
Put any active ISO and export domains in maintenance mode using this procedure.
Procedure 7.14. Moving storage domains to maintenance mode
- Use the Storage resource tab, tree mode, or the search function to find and select the storage domain in the results list.
- Shut down and move all the virtual machines running on the storage domain.
- Click the Data Centers tab in the details pane.
- Click . The storage domain is deactivated and has an
Inactivestatus in the results list.
Result
You can now edit, detach, remove, or reactivate the inactive storage domains from the data center.
Note
You can also activate, detach and place domains into maintenance mode using the Storage tab on the details pane of the data center it is associated with.
7.7.4. Editing a Resource
Summary
Edit the properties of a resource.
Procedure 7.15. Editing a Resource
- Use the resource tabs, tree mode, or the search function to find and select the resource in the results list.
- Click to open the Edit window.
- Change the necessary properties and click .
Result
The new properties are saved to the resource. The Edit window will not close if a property field is invalid.
7.7.5. Activating Storage Domains
Summary
If you have been making changes to a data center's storage, you have to put storage domains into maintenance mode. Activate a storage domain to resume using it.
- Use the Storage resource tab, tree mode, or the search function to find and select the inactive storage domain in the results list.
- Click the Data Centers tab in the details pane.
- Select the appropriate data center and click .
Important
If you attempt to activate the ISO domain before activating the data domain, an error message displays and the domain is not activated.
Result
Your storage domain is active and ready for use.
7.7.6. Removing a Storage Domain
Summary
You have a storage domain in your data center that you want to remove from the virtualized environment.
Procedure 7.16. Removing a Storage Domain
- Use the Storage resource tab, tree mode, or the search function to find and select the appropriate storage domain in the results list.
- Move the domain into maintenance mode to deactivate it.
- Detach the domain from the data center.
- Click to open the Remove Storage confirmation window.
- Select a host from the list.
- Click to remove the storage domain and close the window.
Summary
The storage domain is permanently removed from the environment.
7.7.7. Destroying a Storage Domain
Summary
A storage domain encountering errors may not be able to be removed through the normal procedure. Destroying a storage domain will forcibly remove the storage domain from the virtualized environment without reference to the export directory.
When the storage domain is destroyed, you are required to manually fix the export directory of the storage domain before it can be used again.
Procedure 7.17. Destroying a Storage Domain
- Use the Storage resource tab, tree mode, or the search function to find and select the appropriate storage domain in the results list.
- Right-click the storage domain and select to open the Destroy Storage Domain confirmation window.
- Select the Approve operation check box and click to destroy the storage domain and close the window.
Result
The storage domain has been destroyed. Manually clean the export directory for the storage domain to recycle it.
7.7.8. Detaching the Export Domain
Summary
Detach the export domain from the data center to import the templates to another data center.
Procedure 7.18. Detaching an Export Domain from the Data Center
- Use the Storage resource tab, tree mode, or the search function to find and select the export domain in the results list.
- Click the Data Centers tab in the details pane and select the export domain.
- Click to put the export domain into maintenance mode.
- Click to open the Detach Storage confirmation window.
- Click to detach the export domain.
Result
The export domain has been detached from the data center, ready to be attached to another data center.
7.7.9. Attaching an Export Domain to a Data Center
Prerequisites:
Summary
Attach the export domain to a data center.
Procedure 7.19. Attaching an Export Domain to a Data Center
- Use the Storage resource tab, tree mode, or the search function to find and select the export domain in the results list.
- Click the Data Centers tab in the details pane.
- Click to open the Attach to Data Center window.
- Select the radio button of the appropriate data center.
- Click to attach the export domain.
Result
The export domain is attached to the data center and is automatically activated.
7.8. Storage and Permissions
7.8.1. Managing System Permissions for a Storage Domain
The system administrator, as the SuperUser, manages all aspects of the Administration Portal. More specific administrative roles can be assigned to other users. These restricted administrator roles are useful for empowering a user with certain administrative privileges that limit them to a specific resource: a DataCenterAdmin role has administrator privileges only for the assigned data center, a StorageAdmin has administrator privileges only for the assigned storage domain, and so forth.
A storage administrator is a system administration role for a specific storage domain only. This is useful in data centers with multiple storage domains, where each storage domain requires a system administrator. Use the Configure button in the header bar to assign a storage administrator for all storage domains in the environment.
The storage domain administrator role permits the following actions:
- Edit the configuration of the storage domain;
- Move the storage domain into maintenance mode; and
- Remove the storage domain.
Note
You can only assign roles and permissions to existing users.
You can also change the system administrator of a storage domain by removing the existing system administrator and adding the new system administrator.
7.8.2. Storage Administrator Roles Explained
Storage Domain Permission Roles
The table below describes the administrator roles and privileges applicable to storage domain administration.
Table 7.3. Red Hat Enterprise Virtualization System Administrator Roles
| Role | Privileges | Notes |
|---|---|---|
| StorageAdmin | Storage Administrator | Can create, delete, configure and manage a specific storage domain. |
| GlusterAdmin | Gluster Storage Administrator | Can create, delete, configure and manage Gluster storage volumes. |
7.8.3. Assigning an Administrator or User Role to a Resource
Summary
Assign administrator or user roles to resources to allow users to access or manage that resource.
Procedure 7.20. Assigning a Role to a Resource
- Use the resource tabs, tree mode, or the search function to find and select the resource in the results list.
- Click the tab of the details pane to list the assigned users, the user's role, and the inherited permissions for the selected resource.
- Click to open the Add Permission to User window.
- Enter the name or user name of an existing user into the Search text box and click . Select a user from the resulting list of possible matches.
- Select a role from the Role to Assign: drop-down menu.
- Click to assign the role and close the window.
Result
You have assigned a role to a user; the user now has the inherited permissions of that role enabled for that resource.
7.8.4. Removing an Administrator or User Role from a Resource
Summary
Remove an administrator or user role from a resource; the user loses the inherited permissions associated with the role for that resource.
Procedure 7.21. Removing a Role from a Resource
- Use the resource tabs, tree mode, or the search function to find and select the resource in the results list.
- Click the tab of the details pane to list the assigned users, the user's role, and the inherited permissions for the selected resource.
- Select the user to remove from the resource.
- Click . The Remove Permission window opens to confirm permissions removal.
- Click to remove the user role.
Result
You have removed the user's role, and the associated permissions, from the resource.
Chapter 8. Virtual Machines
- 8.1. Introduction to Virtual Machines
- 8.2. Supported Virtual Machine Operating Systems
- 8.3. Virtual Machine Performance Parameters
- 8.4. Creating Virtual Machines
- 8.5. Using Virtual Machines
- 8.6. Shutting Down or Pausing Virtual Machines
- 8.7. Managing Virtual Machines
- 8.8. Virtual Machines and Permissions
- 8.9. Backing Up and Restoring Virtual Machines with Snapshots
- 8.10. Importing and Exporting Virtual Machines
- 8.11. Migrating Virtual Machines Between Hosts
- 8.12. Improving Uptime with Virtual Machine High Availability
- 8.13. Other Virtual Machine Tasks
8.1. Introduction to Virtual Machines
A virtual machine is a software implementation of a computer. The Red Hat Enterprise 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.
8.2. Supported Virtual Machine Operating Systems
The operating systems that can be virtualized as guest operating systems in Red Hat Enterprise Virtualization are as follows:
Table 8.1. Operating systems that can be used as guest operating systems
| Operating System | Architecture | SPICE support |
|---|---|---|
|
Red Hat Enterprise Linux 3
|
32-bit, 64-bit
|
Yes
|
|
Red Hat Enterprise Linux 4
|
32-bit, 64-bit
|
Yes
|
|
Red Hat Enterprise Linux 5
|
32-bit, 64-bit
|
Yes
|
|
Red Hat Enterprise Linux 6
|
32-bit, 64-bit
|
Yes
|
|
SUSE Linux Enterprise Server 10 (select for the guest type in the user interface)
|
32-bit, 64-bit
|
No
|
|
SUSE Linux Enterprise Server 11 (SPICE drivers (QXL) are not supplied by Red Hat. However, the distribution's vendor may provide spice drivers as part of their distribution.)
|
32-bit, 64-bit
|
No
|
|
Ubuntu 12.04 (Precise Pangolin LTS)
|
32-bit, 64-bit
|
Yes
|
|
Ubuntu 12.10 (Quantal Quetzal)
|
32-bit, 64-bit
|
Yes
|
|
Ubuntu 13.04 (Raring Ringtail)
|
32-bit, 64-bit
|
No
|
|
Ubuntu 13.10 (Saucy Salamander)
|
32-bit, 64-bit
|
Yes
|
|
Windows XP Service Pack 3 and newer
|
32-bit
|
Yes
|
|
Windows 7
|
32-bit, 64-bit
|
Yes
|
|
Windows 8
|
32-bit, 64-bit
|
No
|
|
Windows Server 2003 Service Pack 2 and newer
| |
Yes
|
|
Windows Server 2003 R2
| |
Yes
|
|
Windows Server 2008
|
32-bit, 64-bit
|
Yes
|
|
Windows Server 2008 R2
|
64-bit
|
Yes
|
|
Windows Server 2012
|
64-bit
|
No
|
Of the operating systems that can be virtualized as guest operating systems in Red Hat Enterprise Virtualization, the operating systems that are supported by Global Support Services are as follows:
Table 8.2. Guest operating systems that are supported by Global Support Services
| Operating System | Architecture |
|---|---|
|
Red Hat Enterprise Linux 3
|
32-bit, 64-bit
|
|
Red Hat Enterprise Linux 4
|
32-bit, 64-bit
|
|
Red Hat Enterprise Linux 5
|
32-bit, 64-bit
|
|
Red Hat Enterprise Linux 6
|
32-bit, 64-bit
|
|
SUSE Linux Enterprise Server 10 (select for the guest type in the user interface)
|
32-bit, 64-bit
|
|
SUSE Linux Enterprise Server 11 (SPICE drivers (QXL) are not supplied by Red Hat. However, the distribution's vendor may provide spice drivers as part of their distribution.)
|
32-bit, 64-bit
|
|
Windows XP Service Pack 3 and newer
|
32-bit
|
|
Windows 7
|
32-bit, 64-bit
|
|
Windows 8
|
32-bit, 64-bit
|
|
Windows Server 2003 Service Pack 2 and newer
| |
|
Windows Server 2003 R2
| |
|
Windows Server 2008
|
32-bit, 64-bit
|
|
Windows Server 2008 R2
|
64-bit
|
|
Windows Server 2012
|
64-bit
|
Remote Desktop Protocol (RDP) is the default connection protocol for accessing Windows 8 and Windows 2012 guests from the user portal as Microsoft introduced changes to the Windows Display Driver Model that prevent SPICE from performing optimally.
Note
While Red Hat Enterprise Linux 3 and Red Hat Enterprise Linux 4 are supported, virtual machines running the 32-bit version of these operating systems cannot be shut down gracefully from the administration portal because there is no ACPI support in the 32-bit x86 kernel. To terminate virtual machines running the 32-bit version of Red Hat Enterprise Linux 3 or Red Hat Enterprise Linux 4, right-click the virtual machine and select the Power Off option.
Note
See http://www.redhat.com/resourcelibrary/articles/enterprise-linux-virtualization-support for information about up-to-date guest support.
8.3. Virtual Machine Performance Parameters
Red Hat Enterprise Virtualization virtual machines can support the following parameters:
Table 8.3. Supported virtual machine parameters
| Parameter | Number | Note |
|---|---|---|
| Virtualized CPUs | 160 | per virtual machine |
| Virtualized RAM | 2TB | For a 64 bit virtual machine |
| Virtualized RAM | 4GB | per 32 bit virtual machine. Note, the virtual machine may not register the entire 4GB. The amount of RAM that the virtual machine recognizes is limited by its operating system. |
| Virtualized storage devices | 8 | per virtual machine |
| Virtualized network interface controllers | 8 | per virtual machine |
| Virtualized PCI devices | 32 | per virtual machine |
8.4. Creating Virtual Machines
- 8.4.1. Creating a New Virtual Machine from an Existing Template
- 8.4.2. Creating a New Virtual Machine from a Blank Template
- 8.4.3. Explanation of Settings and Controls in the New Virtual Machine and Edit Virtual Machine Windows
- 8.4.4. Creating a Cloned Virtual Machine from an Existing Template
- 8.4.5. Completing the Configuration of a Virtual Machine by Defining Network Interfaces and Hard Disks
- 8.4.6. Installing a Guest Operating System onto a Virtual Machine
- 8.4.7. Installing Windows on VirtIO-optimized Hardware
- 8.4.8. Virtual Machine Run Once Settings Explained
8.4.1. Creating a New Virtual Machine from an Existing Template
Summary
You can use a template to create a virtual machine which has already been configured with virtual disks, network interfaces, an operating system, and applications.
A virtual machine created from a template depends on the template. You cannot remove a template from the environment if there are still virtual machines that were created from it. Cloning a virtual machine from a template removes the dependency on the template.
Procedure 8.1. Creating a New Virtual Machine from an Existing Template
- Click the Virtual Machines resource tab to list all the virtual machines in the results list.The icon to the right of the virtual machine name indicates whether it is a virtual server, a virtual machine, or a part of a virtual machine pool.
- Click the New VM button to open the New Virtual Machine window.
- Select the Data Center and Host Cluster on which the desktop is to run. Select an existing template from the Based on Template drop-down menu.
- Enter a suitable Name and Description, and accept the default values inherited from the template. You can change the rest of the fields if needed.
- Click OK.
Result
The virtual machine is created and displayed in the Virtual Machines list. You can now log on to your virtual machine and begin using it, or assign users to it.
See Also:
8.4.2. Creating a New Virtual Machine from a Blank Template
Summary
You can create a virtual machine using a blank template and configure all of its settings.
Procedure 8.2. Creating a New Virtual Machine from a Blank Template
- Click the resource tab to list all the virtual machines in the results list.The icon to the left of the virtual machine name indicates whether it is a virtual server, a virtual machine, or a part of a virtual machine pool.
- Click the button to open the New Virtual Machine window.
- On the General tab, you only need to fill in the Name and Operating System fields. You can accept the default settings for other fields, or change them if required.
- Alternatively, click the Initial Run, Console, Host, Resource Allocation, Boot Options, and Custom Properties tabs in turn to define options for your virtual machine.
- Click to create the virtual machine and close the window.
- The New Virtual Machine - Guide Me window opens. Use the Guide Me buttons to complete configuration or click to close the window.
Result
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, add at least one network interface and one virtual disk, and install an operating system.
8.4.3. Explanation of Settings and Controls in the New Virtual Machine and Edit Virtual Machine Windows
8.4.3.1. Virtual Machine General Settings Explained
These settings apply to adding or editing new virtual machines.
The Virtual Machine: General settings table details the information required on the General tab of the New Virtual Machine and Edit Virtual Machine windows.
Table 8.4. Virtual Machine: General Settings
|
Field Name
|
Description
|
|---|---|
|
Cluster
|
The name of the host cluster to which the virtual machine is attached. It can be hosted on any physical machine in the cluster depending on the policy rules.
|
|
Based on Template
|
Templates can be used to create a virtual machines from existing models. This field is set to Blank by default, which enables creating a virtual machine from scratch.
|
|
Operating System
|
The operating system. Valid values include a range of Red Hat Enterprise Linux and Windows variants.
|
|
Optimized for
|
The type of system for which the virtual machine is to be optimized. There are two options: Server, and Desktop, and the field is set to Server by default. 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 virtual machine. Names 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 64 characters.
|
|
Description
|
A meaningful description of the new virtual machine.
|
|
Comment
|
A field for adding plain text, human-readable comments regarding the virtual machine.
|
|
Stateless
|
Select this check box if the virtual machine is to run in stateless mode. The stateless 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, returning the virtual machine to its original state. This type of virtual machine is useful when creating virtual 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 VM 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 deletion of the virtual machine impossible. It is possible to delete the virtual machine only when this check box is not selected.
|
At the bottom of the General tab is a drop-down box that allows you to assign network interfaces to the new virtual machine. Use the plus and minus buttons to add or remove additional network interfaces.
8.4.3.2. Virtual Machine System Settings Explained
These settings apply to adding or editing new virtual machines.
The Virtual Machine: System settings table details the information required on the System tab of the New Virtual Machine and Edit Virtual Machine windows.
Table 8.5. Virtual Machine: System Settings
|
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 guest memory is 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.
|
|
Cores per Virtual Socket
|
The number of cores assigned to each virtual socket.
|
|
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.
|
8.4.3.3. Virtual Machine Initial Run Settings Explained
These settings apply to adding or editing new virtual machines.
The Virtual Machine: Initial Run settings table details the information required on the Initial Run tab of the New Virtual Machine and Edit Virtual Machine windows.
Table 8.6. Virtual Machine: Initial Run Settings
|
Field Name
|
Description
|
|---|---|
|
General - Time Zone
|
The time zone in which the virtual machine is to run. It is not necessarily the time zone for the physical host on which the virtual machine is running.
|
|
Windows - Domain
|
The domain in which the virtual machine is to run. This option is only available when Windows is selected as the operating system on the Virtual Machine - General tab.
|
8.4.3.4. Virtual Machine Console Settings Explained
These settings apply to adding new or editing existing virtual machines.
The Virtual Machine: Console settings table details the information required on the Console tab of the New Virtual Machine and Edit Virtual Machine windows.
Table 8.7. Virtual Machine: Console Settings
|
Field Name
|
Description
|
|---|---|
|
Protocol
|
Defines the display protocol to be used. SPICE is the recommended protocol for Linux and Windows virtual machines, excepting Windows 8 and Windows Server 2012. Optionally, select VNC for Linux virtual machines. A VNC client is required to connect to a virtual machine using the VNC protocol.
|
|
VNC Keyboard Layout
|
Defines the keyboard layout for the virtual machine. This option is only available when using the VNC protocol.
|
|
USB Support
|
Defines whether USB devices can be used on the virtual machine. This option is only available for virtual machines using the SPICE protocol. Select either:
|
|
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. Since Windows 8 and Windows Server 2012 virtual machines do not support the SPICE protocol, they do not support multiple monitors.
|
|
Smartcard Enabled
|
Smartcards are an external hardware security feature, most commonly seen in credit cards, but also used by many businesses as authentication tokens. Smartcards can be used to protect Red Hat Enterprise Virtualization virtual machines. Tick or untick the check box to activate and deactivate Smartcard authentication for individual virtual machines.
|
|
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 soundcard device is not necessary for all virtual machine use cases. If it is for yours, enable a soundcard here.
|
|
VirtIO Console Device Enabled
|
The VirtIO console device is a console over VirtIO transport for communication between the host userspace and guest userspace. It has two parts: device emulation in QEMU that presents a virtio-pci device to the guest, and a guest driver that presents a character device interface to userspace applications. Tick the check box to attach a VirtIO console device to your virtual machine.
|
8.4.3.5. Virtual Machine Host Settings Explained
These settings apply to adding or editing new virtual machines.
The Virtual Machine: Host settings table details the information required on the Host tab of the New Virtual Machine and Edit Virtual Machine windows.
Table 8.8. Virtual Machine: Host Settings
|
Field Name
|
Description
|
|---|---|
|
Start Running On
|
Defines the preferred host on which the virtual machine is to run. Select either:
|
|
Migration Options
|
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.
The Use Host CPU 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 Allow manual migration only or Do not allow migration are selected.
|
8.4.3.6. Virtual Machine High Availability Settings Explained
These settings apply to adding or editing new server virtual machines.
The Virtual Machine: High Availability settings table details the information required on the High Availability tab of the New Virtual Machine and Edit Virtual Machine windows.
Table 8.9. Virtual Machine: High Availability Settings
|
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 or failure, the virtual machine will be automatically moved to or re-launched on another host. If the host is manually shut down by the system administrator, the virtual machine is not automatically moved 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 No 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.
|
|
Priority for Run/Migration queue
|
Sets the priority level for the virtual machine to be migrated or restarted on another host.
|
|
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:
|
8.4.3.7. Virtual Machine Resource Allocation Settings Explained
These settings apply to adding or editing new virtual machines.
The Virtual Machine: Resource Allocation settings table details the information required on the Resource Allocation tab of the New Virtual Machine and Edit Virtual Machine windows.
Table 8.10. Virtual Machine: Resource Allocation Settings
|
Field Name
|
Sub-element
|
Description
|
|---|---|---|
|
CPU Allocation
|
CPU Shares
|
Allows users the set the level of CPU resources a virtual machine can demand relative to other virtual machines.
|
|
CPU Pinning topology
|
Enables the virtual machine's virtual CPU (vCPU) to run on a specific physical CPU (pCPU) in a specific host. This option is not supported if the virtual machine's cluster compatibility version is set to 3.0. The syntax of CPU pinning is
v#p[_v#p], for example:
In order to pin a virtual machine to a host, you must select under , and select the
Use Host CPU check box.
| |
|
Memory Allocation
| The amount of physical memory guaranteed for this virtual machine. | |
|
Storage Allocation
|
The Template Provisioning 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.
| |
|
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.
| |
|
VirtIO-SCSI Enabled
|
Allows users to enable or disable the use of VirtIO-SCSI on the virtual machines.
|
8.4.3.8. Virtual Machine Boot Options Settings Explained
These settings apply to adding or editing new virtual machines.
The Virtual Machine: Boot Options settings table details the information required on the Boot Options tab of the New Virtual Machine and Edit Virtual Machine windows
Table 8.11. 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:
|
|
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.
|
8.4.3.9. Virtual Machine Custom Properties Settings Explained
These settings apply to adding or editing new virtual machines.
The table below details the information required on the Custom Properties tab of the New Virtual Machine and Edit Virtual Machine windows.
Table 8.12. 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.
|
-
|
|
vhost
|
Disables vhost-net, which is the kernel-based virtio network driver on virtual network interface cards attached to the virtual machine. To disable vhost, the format for this property is:
LogicalNetworkName: falseThis will explicitly start the virtual machine without the vhost-net setting on the virtual NIC attached to LogicalNetworkName. |
vhost-net provides better performance than virtio-net, and if it is present, it is enabled on all virtual machine NICs by default. Disabling this property makes it easier to isolate and diagnose performance issues, or to debug vhost-net errors, for example if migration fails for virtual machines on which vhost does not exist.
|
|
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.
|
For Red Hat Enterprise Virtualization 3.1, if viodiskcache is enabled, the virtual machine cannot be live migrated.
|
Warning
Increasing the value of the sndbuf custom property results in increased occurrences of communication failure between hosts and unresponsive virtual machines.
8.4.4. Creating a Cloned Virtual Machine from an Existing Template
Summary
Cloning a virtual machine from a template is like creating a virtual machine from a template. A cloned virtual machine inherits all the settings from the original virtual machine on which its template is based. A clone does not depend on the template it was created from after it has been created.
Procedure 8.3. Creating a Cloned Virtual Machine from an Existing Template
- Click the Virtual Machines resource tab to list all the virtual machines in the results list.
- Click the button to open the New Virtual Machine window.
- Select an existing template from the Based on Template drop-down menu.
- Enter a Name and appropriate Description, and accept the default values inherited from the template in the rest of the fields. You can change them if needed.
- Click the Resource Allocation tab. The template you selected is displayed on the Template Provisioning field. Select Clone.Select the disk provisioning mode in the Allocation field. This selection impacts both the speed of the clone operation and the amount of disk space it requires.
- Selecting
Thin Provisionresults 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
Preallocatedresults in a slower clone operation and is 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.
- Select the Target storage domain for the virtual machine.
- 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 firstImage Locked, thenDown.
Result
The virtual machine is created and displayed in the Virtual Machines list. You can now log on to your virtual machine and begin using it, or assign users to it.
8.4.5. Completing the Configuration of a Virtual Machine by Defining Network Interfaces and Hard Disks
Summary
Before you can use your newly created virtual machine, the Guide Me window prompts you to configure at least one network interface and one virtual disk for the virtual machine.
Procedure 8.4. Completing the Configuration of a Virtual Machine by Defining Network Interfaces and Hard Disks
- On the New Virtual Machine - Guide Me window, click the button to open the New Network Interface window. You can accept the default values or change them as necessary.Enter the Name of the network interface.
- Use the drop-down menus to select the Network and the Type of network interface for the new virtual machine. The Link State is set to Up by default when the NIC is defined on the virtual machine and connected to the network.
Note
The options on the Network and Type fields are populated by the networks available to the cluster, and the NICs available to the virtual machine. - If applicable, select the Specify custom MAC address check box and enter the network interface's MAC address.
- Click the arrow next to Advanced Parameters to configure the Port Mirroring and Card Status fields, if necessary.
- Click to close the New Network Interface window and open the New Virtual Machine - Guide Me window.
- Click the button to open the New Virtual Disk window.
- Add either an Internal virtual disk or an External LUN to the virtual machine.
- Click to close the New Virtual Disk window. The New Virtual Machine - Guide Me window opens with changed context. There is no further mandatory configuration.
- Click to close the window.
Result
You have added a network interface and a virtual disk to your virtual machine.
See Also:
8.4.6. Installing a Guest Operating System onto a Virtual Machine
Prerequisites:
Summary
An operating system has to be installed onto a virtual machine that is created from a blank template. You can install a new operating system on any virtual machine.
Procedure 8.5. Installing an operating system onto a virtual machine
- Select the created virtual machine. It has a status of
Down. - Click the button to open the Run Virtual Machine window.
- Click the tab to define the boot sequence and source images for installing the operating system.
- Click the tab to define additional boot options specific to Linux virtual machines.
- Click the tab to join the virtual machine to a domain on the initial run.
- Click the tab and select a suitable protocol to connect to the virtual machine. SPICE is the recommended protocol.
- Click the tab to enter additional running options for virtual machines.
- Click .
Result
You have installed an operating system onto your virtual machine. You can now log in and begin using your virtual machine, or assign users to it.
8.4.7. Installing Windows on VirtIO-optimized Hardware
Summary
The virtio-win.vfd floppy image contains Windows drivers for VirtIO-optimized disk and network devices. These drivers provide a performance improvement over emulated device drivers.
The
virtio-win.vfd is placed automatically on ISO storage domains that are hosted on the Manager server. It must be manually uploaded using the engine-iso-uploader tool to other ISO storage domains.
You can install the VirtIO-optimized device drivers during your Windows installation by attaching a floppy disk device to your virtual machine.
This procedure presumes that you added a
Red Hat VirtIO network interface and a disk that uses the VirtIO interface to your virtual machine.
Procedure 8.6. Installing VirtIO Drivers during Windows Installation
- Select your virtual machine from the list in the Virtual Machines tab.
- Click the button, and the Run Once window displays.
- Click Boot Options to expand the Boot Options configuration options.
- Click the Attach Floppy check box, and select
virtio-win.vfdfrom the drop down selection box. - Click the Attach CD check box, and select from the drop down selection box the ISO containing the version of Windows you want to install.
- Move CD-ROM in the Boot Sequence field.
- Configure the rest of your Run Once options as required, and click OK to start your virtual machine, and then click the button to open a graphical console to your virtual machine.
Result
Windows installations include an option to load additional drivers early in the installation process. Use this option load drivers from the virtio-win.vfd floppy disk which 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.
8.4.8. Virtual Machine Run Once Settings Explained
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 following table details the information required for the Run Once window.
Table 8.13. Virtual Machine: Run Once Settings
|
Field Name
|
Description
|
|---|---|
|
Boot Options
|
Defines the virtual machine's boot sequence, running options, and source images for installing the operating system and required drivers.
|
|
Linux Boot Options
|
The following options boot a Linux kernel directly instead of through the BIOS bootloader.
|
|
Initial Run
|
Allows the user to enable cloud-init and define the settings this function applies to the virtual machine.
|
|
Host
|
Defines the virtual machine's host.
|
|
Display Protocol
|
Defines the protocol to connect to virtual machines.
|
|
Custom Properties
|
Additional VDSM options for running virtual machines.
|
8.5. Using Virtual Machines
8.5.1. SPICE
The SPICE (Simple Protocol for Independent Computing Environments) protocol facilitates graphical connections to virtual machines. The SPICE protocol allows:
- video at more than 30 frames per second
- bidirectional audio (for softphones/IP phones)
- bidirectional video (for video telephony/video conferencing)
- connection to multiple monitors with a single virtual machine
- USB redirection from the client's USB port into the virtual machine
- connection to a proxy from outside of the network the hypervisor is attached to
8.5.2. Powering on a Virtual Machine
Summary
You can start a virtual machine from the Administration Portal.
Procedure 8.7. Powering on a Virtual Machine
- Use the Virtual Machines resource tab, tree mode, or the search function to find and select a virtual machine in the results list with a status of
Down. - Click the
icon.
Alternatively, right-click and select .
Result
The Status of the virtual machine changes to Up. The display protocol of the selected virtual machine is displayed. If the virtual machine has the rhevm-guest-agent installed, its IP address is also displayed.
8.5.3. Installing SPICE Plugins in Windows and Linux
The SPICE protocol is the default graphical protocol used to connect to virtual machines. Plugins for the Internet Explorer and Firefox web browsers allow you to launch graphical virtual machine connection sessions from the Red Hat Enterprise Virtualization web portals.
Summary
This procedure describes the installation of the SPICE Plugin for Mozilla Firefox on Linux clients.
Procedure 8.8. Installing the SPICE plugin for Mozilla Firefox on Red Hat Enterprise Linux
- Open a terminal and run the following command as root:
# yum install spice-xpi
The plugin will be installed the next time Firefox is started.
Result
The SPICE plugin is installed on your Red Hat Enterprise Linux client.
Summary
This procedure describes the installation of the SPICE ActiveX component for Internet Explorer on Windows clients.
Procedure 8.9. Installing the SPICE ActiveX component for Internet Explorer on Windows
- The first time you attempt to connect to a virtual machine, an add-on notification bar displays in the browser, prompting you to install the SPICE ActiveX component. You need administrative privileges on your client machine to install the component. Contact your systems administrator if you do not have the necessary permissions.
- When you accept the prompt to install the SPICE ActiveX component, Internet Explorer may issue a security warning. Confirm that you wish to proceed, and the component will be installed.
Result
The SPICE ActiveX component for Internet Explorer for Windows is installed on your client machine.
Important
If you installed the SPICE ActiveX component without administrative permissions, you will receive a message stating that the usbclerk package was not installed. This means that you will be able to connect to a virtual machine using SPICE, however you will not be able to use USB devices on your virtual machine. Contact your systems administrator to install usbclerk if required.
8.5.4. Logging in to a Virtual Machine
Summary
The default protocol for graphical connections to virtual machines is SPICE. You can log in to virtual machines using the SPICE protocol from the Administration Portal. An external VNC client is required to log in to virtual machines using the VNC protocol.
Procedure 8.10. Logging in to a virtual machine
- On the Virtual Machines resource tab, select a running virtual machine.
- Click the Console button or right-click the virtual machine and select Console from the menu.
- If the virtual machine's display protocol is set to SPICE, a console window to the virtual machine opens. Log in to the virtual machine's guest operating system.
- If the virtual machine's display protocol is set to VNC, you will be prompted to download a file called "console.vv". This file contains information needed by the VNC client to log into a virtual machine. Use a text editor to open the file and retrieve the information. Run the VNC client and log into the virtual machine using the information provided in the downloaded file.
Result
You have connected to a virtual machine from the Administration Portal using SPICE or a VNC client.
8.6. Shutting Down or Pausing Virtual Machines
8.6.1. Shutting Down or Pausing Virtual Machines
Virtual machine should be shut down from within. However, occasionally there is a need to shut down the virtual machine from the Administration Portal.
The Red Hat Enterprise Virtualization platform provides for an orderly shutdown if the guest tools are installed on the virtual machine. Shutdown of virtual machines should be planned after due consideration, preferably at times that will least impact users.
All users should be logged off of a Windows virtual machine before shutting them down. If any users are still logged in, the virtual machine remains on with a
Powering Off status in the Administration Portal. The virtual machine requires manual intervention to shut it down completely because the following Windows message is displayed on the virtual machine:
Other people are logged on to this computer. Shutting down Windows might cause them to lose data. Do you want to continue shutting down?
If a virtual machine cannot be properly shut down, since, for example, the operating system is not responsive, you might need to force a shutdown, which is equivalent to pulling out the power cord of a physical machine.
Warning
Exercise extreme caution when forcing shutdown of a virtual machine, as data loss may occur.
Pausing a virtual machine puts it into Hibernate mode, where the virtual machine state is preserved. Applications running in RAM are written to the hard drive and CPU usage is zero.
8.6.2. Shutting Down a Virtual Machine
Summary
If your virtual machine has the rhevm-guest-agent installed, or has Advanced Configuration and Power Interface (ACPI) support, you can shut it down from the Administration Portal.
Procedure 8.11. Shutting Down a Virtual Machine
- Use the Virtual Machines resource tab, tree mode, or the search function to find and select a running virtual machine in the results list.
- Click the (
) button.
Alternatively, right-click the virtual machine and select Shut down.
Result
The Status of the virtual machine changes to Down.
8.6.3. Pausing a Virtual Machine
Summary
If your virtual machine has the rhevm-guest-agent installed, or has Advanced Configuration and Power Interface (ACPI) support, you can pause it from the Administration Portal. This is equal to setting it on Hibernate mode.
Procedure 8.12. Pausing a virtual machine
- Use the Virtual Machines resource tab, tree mode, or the search function to find and select a running virtual machine in the results list.
- Click the (
) button.
Alternatively, right-click the virtual machine and select Suspend
Result
The Status of the virtual machine changes to Paused.
8.7. Managing Virtual Machines
- 8.7.1. Editing a Resource
- 8.7.2. Removing a Virtual Machine
- 8.7.3. Adding and Editing Virtual Machine Disks
- 8.7.4. Adding and Editing Virtual Machine Network Interfaces
- 8.7.5. Explanation of Settings in the Virtual Machine Network Interface Window
- 8.7.6. Hot Plugging Virtual Machine Disks
- 8.7.7. Hot Plugging Network Interfaces
- 8.7.8. Removing Disks and Network Interfaces from Virtual Machines
8.7.1. Editing a Resource
Summary
Edit the properties of a resource.
Procedure 8.13. Editing a Resource
- Use the resource tabs, tree mode, or the search function to find and select the resource in the results list.
- Click to open the Edit window.
- Change the necessary properties and click .
Result
The new properties are saved to the resource. The Edit window will not close if a property field is invalid.
8.7.2. Removing a Virtual Machine
Summary
When you no longer require a virtual machine, remove it from the data center. Shut down the virtual machine before removing it.
Procedure 8.14. Removing a virtual machine
- Use the Virtual Machines resource tab, tree mode, or the search function to find and select a virtual machine in the results list.
- Shut down the virtual machine. The Remove button is only enabled for a virtual machine that has a status of
Down. - Click . On the Remove Virtual Machine(s) confirmation window, the Remove Disk(s) check box is automatically selected, which will remove the attached virtual disks together with the virtual machine. If the check box is cleared, the virtual disks will remain in the environment as floating disks.
- Click to remove the virtual machine (and associated virtual disks) and close the window.
Result
The virtual machine is removed from the environment and no longer displays on the Virtual Machines resource tab.
8.7.3. Adding and Editing Virtual Machine Disks
Summary
It is possible to add disks to virtual machines. You can add new disks, or previously created floating disks to a virtual machine. This allows you to provide additional space to and share disks between virtual machines. You can also edit disks to change some of their details.
An Internal disk is the default type of disk. You can also add an External(Direct Lun) disk. Internal disk creation is managed entirely by the Manager; external disks require externally prepared targets that already exist. Existing disks are either floating disks or shareable disks attached to virtual machines.
Procedure 8.15. Adding Disks to Virtual Machines
- Use the Virtual Machines resource tab, tree mode, or the search function to find and select a virtual machine in the results list.
- Click the Disks tab in the details pane to display a list of virtual disks currently associated with the virtual machine.
- Click to open the Add Virtual Disk window.
- Use the appropriate radio buttons to switch between Internal and the External (Direct Lun) disks.
- Select the Attach Disk check box to choose an existing disk from the list and select the Activate check box.Alternatively, enter the Size, Alias, and Description of a new disk and use the drop-down menus and check boxes to configure the disk.
- Click to add the disk and close the window.
Result
Your new disk is listed in the Virtual Disks tab in the details pane of the virtual machine.
8.7.4. Adding and Editing Virtual Machine Network Interfaces
Summary
You can add network interfaces to virtual machines. Doing so allows you to put your virtual machine on multiple logical networks. You can also edit a virtual machine's network interface card to change the details of that network interface card. 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 8.16. Adding Network Interfaces to Virtual Machines
- Use the Virtual Machines resource tab, tree mode, or the search function to find and select a virtual machine in the results list.
- Select the Network Interfaces tab in the details pane to display a list of network interfaces that are currently associated with the virtual machine.
- Click to open the New Network Interface window.
- Enter the Name of the network interface.
- Use the drop-down menus to select the Profile and the Type of network interface for the new network interface. 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.
Note
The Profile and Type fields are populated in accordance with the profiles and network types available to the cluster and the network interface cards available to the virtual machine. - Select the Custom MAC address check box and enter a MAC address for the network interface card as required.
- Click to close the New Network Interface window.
Result
Your new network interface is listed in the Network Interfaces tab in the details pane of the virtual machine.
8.7.5. Explanation of Settings in the Virtual Machine Network Interface Window
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 8.14. Add a network interface to a virtual machine entries
|
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.
|
|
Network
|
Logical network that the network interface is placed on. By default, all network interfaces are put on the rhevm management network.
|
|
Link State
|
Whether or not the network interface is connected to the logical network.
|
|
Type
|
The virtual interface the network interface presents to virtual machines. VirtIO is faster but requires VirtIO drivers. Red Hat Enterprise Linux 5 and higher includes VirtIO drivers. Windows does not include VirtIO drivers, but they can be installed from the guest tools ISO or virtual floppy disk. rtl8139 and e1000 device drivers are included in most operating systems.
|
|
Specify custom MAC address
|
Choose this option to set a custom MAC address. The Red Hat Enterprise 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.
|
|
Port Mirroring
|
A security feature that allows all network traffic going to or leaving from virtual machines on a given logical network and host to be copied (mirrored) to the network interface. If the host also uses the network, then traffic going to or leaving from the host is also copied.
Port mirroring only works on network interfaces with IPv4 IP addresses.
|
|
Card Status
|
Whether or not the network interface is defined on the virtual machine.
|
8.7.6. Hot Plugging Virtual Machine Disks
Summary
You can hot plug virtual machine disks. Hot plugging means enabling or disabling devices while a virtual machine is running.
Procedure 8.17. Hot plugging virtual machine disks
- Use the Virtual Machines resource tab, tree mode, or the search function to find and select a running virtual machine in the results list.
- Select the Disks tab from the details pane of the virtual machine.
- Select the virtual machine disk you would like to hot plug.
- Click the or button.
Result
You have enabled or disabled a virtual machine disk.
8.7.7. Hot Plugging Network Interfaces
Summary
You can hot plug network interfaces. Hot plugging means enabling and disabling network interfaces while a virtual machine is running.
Procedure 8.18. Hot plugging network interfaces
- Use the Virtual Machines resource tab, tree mode, or the search function to find and select a running virtual machine in the results list.
- Select the Network Interfaces tab from the details pane of the virtual machine.
- Select the network interface you would like to hot plug and click to open the Edit Network Interface window.
- Click the Advanced Parameters arrow to access the Card Status option. Set the Card Status to Plugged if you want to enable the network interface, or set it to Unplugged if you want to disable the network interface.
Result
You have enabled or disabled a virtual network interface.
8.7.8. Removing Disks and Network Interfaces from Virtual Machines
Summary
You can remove network interfaces and virtual hard disks from virtual machines. If you remove a disk from a virtual machine, the contents of the disk are permanently lost.
This procedure is not the same as hot plugging. You can only remove virtual hardware that is .
Procedure 8.19. Removing disks and network interfaces from virtual machines
- Select the virtual machine with virtual hardware you'd like to remove.
- Select the relevant tab, either Network Interfaces or Disks, from the virtual machine details pane.
- Select the disk or network interface you'd like to remove. To remove it, you must have first Deactivated it.
- Click the button. Click in the confirmation window. If you are removing a disk, select the Remove Permanently option to completely remove it from the environment. If you don't select this option, for example because the disk is a shared disk, it will remain in the Disks resource tab.
Result
The disk or network interface is no longer attached to the virtual machine.
8.8. Virtual Machines and Permissions
8.8.1. Managing System Permissions for a Virtual Machine
The system administrator, as the SuperUser, manages all aspects of the Administration Portal. More specific administrative roles can be assigned to other users. These restricted administrator roles are useful for empowering a user with certain administrative privileges that limit them to a specific resource: a DataCenterAdmin role has administrator privileges only for the assigned data center, a ClusterAdmin has administrator privileges only for the assigned cluster, and so forth.
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; and
- 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 Enterprise Virtualization provides several user roles which enable the user to manage virtual machines specifically, but not other resources in the data center.
8.8.2. Virtual Machines Administrator Roles Explained
Virtual Machine Administrator Permission Roles
The table below describes the administrator roles and privileges applicable to virtual machine administration.
Table 8.15. Red Hat Enterprise Virtualization System Administrator Roles
| Role | Privileges | Notes |
|---|---|---|
| DataCenterAdmin | Data Center Administrator | Can use, create, delete, manage all virtual machines within a specific data center. |
| ClusterAdmin | Cluster Administrator | Can use, create, delete, manage all virtual machines within a specific cluster. |
| NetworkAdmin | Network Administrator | 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. |
8.8.3. Virtual Machine User Roles Explained
Virtual Machine User Permission Roles
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 8.16. Red Hat Enterprise Virtualization System User Roles
| Role | Privileges | Notes |
|---|---|---|
| UserRole | Can access and use virtual machines and pools. | Can log in to the User Portal and use virtual machines and pools. |
| PowerUserRole | Can create and manage virtual machines and templates. | Apply this role to a user for the whole environment with 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. |
| UserVmManager | System administrator of a virtual machine. | Can manage virtual machines, create and use snapshots, and migrate virtual machines. 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 Templates. | Level of privilege to create a virtual machine by means of a template. |
| VmCreator | Can create virtual machines in the User Portal. | This role is not applied to a 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. |
| NetworkUser | Logical network and network interface user for virtual machines. | If the Allow all users to use this Network option was selected when a logical network is created, NetworkUser 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. |
Note
In Red Hat Enterprise Virtualization 3.0, the PowerUserRole only granted permissions for virtual machines which are directly assigned to the PowerUser, or virtual machines created by the PowerUser. Now, the VmCreator role provides privileges previously conferred by the PowerUserRole. The PowerUserRole can now be applied on a system-wide level, or on specific data centers or clusters, and grants permissions to all virtual machines and templates within the system or specific resource. Having a PowerUserRole is equivalent to having the VmCreator, DiskCreator, and TemplateCreator roles.
8.8.4. Assigning an Administrator or User Role to a Resource
Summary
Assign administrator or user roles to resources to allow users to access or manage that resource.
Procedure 8.20. Assigning a Role to a Resource
- Use the resource tabs, tree mode, or the search function to find and select the resource in the results list.
- Click the tab of the details pane to list the assigned users, the user's role, and the inherited permissions for the selected resource.
- Click to open the Add Permission to User window.
- Enter the name or user name of an existing user into the Search text box and click . Select a user from the resulting list of possible matches.
- Select a role from the Role to Assign: drop-down menu.
- Click to assign the role and close the window.
Result
You have assigned a role to a user; the user now has the inherited permissions of that role enabled for that resource.
8.8.5. Removing an Administrator or User Role from a Resource
Summary
Remove an administrator or user role from a resource; the user loses the inherited permissions associated with the role for that resource.
Procedure 8.21. Removing a Role from a Resource
- Use the resource tabs, tree mode, or the search function to find and select the resource in the results list.
- Click the tab of the details pane to list the assigned users, the user's role, and the inherited permissions for the selected resource.
- Select the user to remove from the resource.
- Click . The Remove Permission window opens to confirm permissions removal.
- Click to remove the user role.
Result
You have removed the user's role, and the associated permissions, from the resource.
8.9. Backing Up and Restoring Virtual Machines with Snapshots
8.9.1. Creating a Snapshot of a Virtual Machine
Summary
A snapshot is a view of a virtual machine's operating system and applications 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.
Note
Live snapshots can only be created for virtual machines running on 3.1-or-higher-compatible data centers. Virtual machines in 3.0-or-lower-compatible data centers must be shut down before a snapshot can be created.
Procedure 8.22. Creating a snapshot of a virtual machine
- Use the Virtual Machines resource tab, tree mode, or the search function to find and select a virtual machine in the results list.
- Click to open the Create Snapshot window.
- Enter a description for the snapshot.
- Click to create the snapshot and close the window.
Result
The virtual machine's operating system and applications 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.
8.9.2. Using a Snapshot to Restore a Virtual Machine
Prerequisites:
Summary
A snapshot can be used to restore a virtual machine to its previous state.
Procedure 8.23. Using a snapshot to restore a virtual machine
- Use the Virtual Machines resource tab, tree mode, or the search function to find and select the virtual machine in the results list. Ensure the status is
Powered Down. - Click the Snapshots tab in the details pane to list the available snapshots.
- Select a snapshot to restore in the left side-pane. The snapshot details display in the right side-pane.
- Click to preview the snapshot. The status of the virtual machine briefly changes to
Image Lockedbefore returning toDown. - Start the virtual machine and it will run with the disk image of the snapshot.
- 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.
Result
The virtual machine is restored to its state at the time of the snapshot, or returned to its state before the preview of the snapshot.
8.9.3. Creating a Virtual Machine from a Snapshot
Prerequisites:
Summary
You have created a snapshot from a virtual machine. Now you can use that snapshot to create another virtual machine.
Procedure 8.24. Creating a virtual machine from a snapshot
- Use the Virtual Machines resource tab, tree mode, or the search function to find and select the virtual machine in the results list.
- Click the Snapshots tab in the details pane to list the available snapshots for the virtual machines.
- Select a snapshot in the list displayed and click to open the Clone VM from Snapshot window.
- Enter the Name and Description of the virtual machine to be created.
- Click to create the virtual machine and close the window.
Result
After a short time, the cloned virtual machine appears in the Virtual Machines tab in the navigation pane. It appears in the navigation pane with a status of Image Locked. The virtual machine will remain in this state until Red Hat Enterprise Virtualization completes the creation of the virtual machine. A virtual machine with a preallocated 20GB 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.
8.9.4. Deleting a Snapshot
Summary
Delete a snapshot and permanently remove it from the virtualized environment.
Procedure 8.25. Deleting a Snapshot
- Use the Virtual Machines resource tab, tree mode, or the search function to find and select a virtual machine in the results list.
- Click the Snapshots tab in the details pane to list available snapshots for the virtual machine.
- Select the snapshot to delete.
- In the Navigation pane, shut down the running virtual machine associated with the snapshot to be deleted.
- Click to open the Delete Snapshot confirmation window.
- Click to delete the snapshot and close the window.
Result
You have removed a virtual machine snapshot. Removing a snapshot does not affect the virtual machine.
8.10. Importing and Exporting Virtual Machines
8.10.1. Exporting and Importing Virtual Machines
A virtual machine or a template can be moved between data centers in the same environment, or to a different Red Hat Enterprise Virtualization environment. The Red Hat Enterprise Virtualization Manager allows you to import and export virtual machines (and templates) stored in Open Virtual Machine Format (OVF). This feature can be used in multiple ways:
- Moving virtual resources between Red Hat Enterprise Virtualization environments.
- Move virtual machines and templates between data centers in a single Red Hat Enterprise Virtualization environment.
- Backing up virtual machines and templates.
There are three stages of exporting and importing virtual resources:
- First you export your virtual machines and templates to an export domain.
- Second, you 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 Enterprise Virtualization environment, or attach it to a data center in a separate Red Hat Enterprise Virtualization environment that is managed by another installation of the Red Hat Enterprise Virtualization Manager.
- Third, you import your virtual machines and template into the data center you attached the export domain to.
A virtual machine must be stopped before it can be moved across data centers. If the virtual machine was created using a template, the template must exist in the destination data center for the virtual machine to work, or the virtual machine must be exported with the Collapse Snapshots option selected.
8.10.2. Overview of the Export-Import Process
The export domain allows you to move virtual machines and templates between Red Hat Enterprise Virtualization environments.
Exporting and importing resources requires that an active export domain be attached to the data center. An export domain is a temporary storage area containing two directories per exported virtual resource. One directory consists of all the OVF (Open Virtualization Format) files pertaining to the virtual machine. The other holds the virtual resource's disk image, or images.
You can also import virtual machines from other virtualization providers, for example, Xen, VMware or Windows virtual machines, using the V2V feature. V2V converts virtual machines and places them in the export domain.
For more information on V2V, see the Red Hat Enterprise Linux V2V Guide.
Note
An export domain can be active in only one data center. This means that the export domain can be attached to either the source data center or the destination data center.
Exporting virtual resources across data centers requires some preparation. Make sure that:
- an export domain exists, and is attached to the source data center.
- the virtual machine is shut down.
- if the virtual machine was created from a template, the template resides on the destination data center, or is exported alongside the virtual machine.
When the virtual machine, or machines, have been exported to the export domain, you can import them into the destination data center. If the destination data center is within the same Red Hat Enterprise Virtualization environment, delete the originals from the source data center after exporting them to the export domain.
8.10.3. Performing an Export-Import of Virtual Resources
Summary
This procedure provides a graphical overview of the steps required to import a virtual resource to its destination.
Procedure 8.26. Performing an export-import of virtual resources
- Attach the export domain to the source data center.
- Export the virtual resource to the export domain.
- Detach the export domain from the source data center.
- Attach the export domain to the destination Data center.
- Import the virtual resource into the destination data center.
Result
Your virtual resource is exported to the destination data center.
See Also:
8.10.4. Exporting a Virtual Machine to the Export Domain
Summary
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.
Procedure 8.27. Exporting a Virtual Machine to the Export Domain
- Use the Virtual Machines resource tab, tree mode, or the search function to find and select a virtual machine in the results list. Ensure the virtual machine has a status of
Down. - Click to open the Export Virtual Machine window.
- Select the Force Override check box to override existing images of the virtual machine on the export domain.Select the Collapse Snapshots check box to create a single export volume per disk. Selecting this option will remove snapshot restore points and include the template in a template-based virtual machine. This removes any dependencies a virtual machine has on a template.
- Click to export the virtual machine and close the window.
Result
The export of the virtual machine begins. The virtual machine displays in the Virtual Machines list with an Image Locked status as 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.
8.10.5. Importing a Virtual Machine into the Destination Data Center
Summary
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 8.28. Importing a Virtual Machine into the Destination Data Center
- Use the Storage resource tab, tree mode, or the search function to find and select the export domain in the results list. The export domain must have a status of
Active - Select the VM Import tab in the details pane to list the available virtual machines to import.
- Select one or more virtual machines to import and click to open the Import Virtual Machine(s) window.
- Use the drop-down menus to select the Default Storage Domain and Cluster.
- Select the Collapse Snapshots check box to remove snapshot restore points and include templates in template-based virtual machines.
- 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.
- Click to import the virtual machines.The Import Conflict window opens if the virtual machine exists in the virtualized environment.
- Choose one of the following radio buttons:
- Don't import
- Clone and enter a unique name for the virtual machine in the New Name field.
Or select the Apply to all check box to import all duplicated virtual machines with the same suffix. - Click OK to import the virtual machines and close the window.
Result
You have imported the virtual machine to the destination data center. This may take some time to complete.
8.11. Migrating Virtual Machines Between Hosts
- 8.11.1. What is Live Migration?
- 8.11.2. Live Migration Prerequisites
- 8.11.3. Automatic Virtual Machine Migration
- 8.11.4. Preventing Automatic Migration of a Virtual Machine
- 8.11.5. Manually Migrating Virtual Machines
- 8.11.6. Setting Migration Priority
- 8.11.7. Canceling ongoing virtual machine migrations
- 8.11.8. Event and Log Notification upon Automatic Migration of Highly Available Virtual Servers
8.11.1. What is Live Migration?
Live migration provides the ability to move a running virtual machine between physical hosts with no interruption to service.
Live migration is transparent to the end user: the virtual machine remains powered on and user applications continue to run while the virtual machine is relocated to a new physical host.
8.11.2. 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 Enterprise 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 must both be members of the same cluster, ensuring CPU compatibility between them.
- 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!=nonecustom 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.
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.
8.11.3. Automatic Virtual Machine Migration
Red Hat Enterprise 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 cluster policy. While no cluster policy is defined by default, it is recommended that you specify the cluster 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.
8.11.4. Preventing Automatic Migration of a Virtual Machine
Summary
Red Hat Enterprise 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 8.29. Preventing automatic migration of a virtual machine
- Use the Virtual Machines resource tab, tree mode, or the search function to find and select a virtual machine or virtual server in the results list.
- Click Edit to open the Edit Virtual Machine window.
- Click the Host tab.
- Use the Run On radio buttons to designate the virtual machine to run on Any Host in Cluster or a Specific host. If applicable, select a specific host from the drop-down menu.
Warning
Explicitly assigning a virtual machine to a specific host and disabling migration is mutually exclusive with Red Hat Enterprise Virtualization high availability. Virtual machines that are assigned to a specific host can only be made highly available using third party high availability products like Red Hat High Availability. - Use the drop-down menu to affect the Migration Options. Select Do not allow migration to enable the Use Host CPU check box.
- If applicable, enter relevant CPU Pinning topology commands in the text field.
- Click to save the changes and close the window.
Result
You have changed the migration settings for the virtual machine.
8.11.5. Manually Migrating Virtual Machines
Summary
A running virtual machine can be migrated to any host within its designated host cluster. This is especially useful if the load on a particular host is too high. When bringing a server down for maintenance, migration is triggered automatically, so manual migration is not required. Migration of virtual machines does not cause any service interruption.
The migrating virtual machine must not have the
cache!=none custom property set.
Procedure 8.30. Manually migrating virtual machines
- Use the Virtual Machines resource tab, tree mode, or the search function to find and select a running virtual machine in the results list.Click to open the Migrate Virtual Machine(s) window.
- Use the radio buttons to select whether to Select Host Automatically or to Select Destination Host, specifying the host using the drop-down menu.
Note
Virtual Machines migrate within their designated host cluster. When the Select Host Automatically option is selected, the system determines the host to which the virtual is migrated according to the load balancing and power management rules set up in the cluster policy. - Click to commence migration and close the window.
Result
The virtual machine is migrated. Once migration is complete the Host column will update to display the host the virtual machine has been migrated to.
8.11.6. Setting Migration Priority
Summary
Red Hat Enterprise Virtualization Manager queues concurrent requests for migration of virtual machines off of a given host. Every minute the load balancing process runs. Hosts already 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.
It is possible to influence the ordering of the migration queue, for example setting mission critical virtual machines to migrate before others. The Red Hat Enterprise Virtualization Manager allows you to set the priority of each virtual machine to facilitate this. Virtual machines migrations will be ordered by priority, those virtual machines with the highest priority will be migrated first.
Note
In previous versions of Red Hat Enterprise Virtualization, you could only set migration policy for virtual servers. You can now set migration policy for both virtual machine types.
Procedure 8.31. Setting Migration Priority
- Use the Virtual Machines resource tab, tree mode, or the search function to find and select a virtual server in the results list.
- Click to open the Edit Virtual Machine window.
- Select the High Availability tab.
- Use the radio buttons to set the Priority for Run/Migrate Queue of the virtual machine to one of Low, Medium, or High.
- Click to save changes and close the window.
Result
The virtual machine's migration priority has been modified.
8.11.7. Canceling ongoing virtual machine migrations
Summary
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 8.32. Canceling ongoing virtual machine migrations
- Select the migrating virtual machine. It is displayed in the Virtual Machines resource tab with a status of Migrating from.
- Click the button at the top of the results list. Alternatively, right-click on the virtual machine and select Cancel Migration from the context menu.
Result
The virtual machine status returns from Migrating from status to Up status.
8.11.8. 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 tab and in the engine log to aid in troubleshooting, as illustrated in the following examples:
Example 8.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 8.2. Notification in the Manager engine.log
This log can be found on the Red Hat Enterprise Virtualization Manager at
/var/log/ovirt-engine/engine.log:
Failed to start Highly Available VM. Attempting to restart. VM Name: Virtual_Machine_Name, VM Id:Virtual_Machine_ID_Number
8.12. Improving Uptime with Virtual Machine High Availability
8.12.1. 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.
8.12.2. 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 Enterprise 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 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.
8.12.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:
- 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.
8.12.4. Configuring a Highly Available Virtual Machine
Summary
High availability must be configured individually for each virtual server.
Note
You can only set high availability for virtual servers. You can not set high availability for virtual desktops.
Procedure 8.33. Configuring a Highly Available Virtual Machine
- Use the Virtual Machines resource tab, tree mode, or the search function to find and select a virtual server in the results list.
- Click to open the Edit Virtual Machine window.
- Click the High Availability tab.
- Select the Highly Available check box to enable high availability for the virtual server.
- Use the radio buttons to set the Priority for Run/Migrate Queue of the virtual machine to one of Low, Medium, or High. 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.
- Click to save changes and close the window.
Result
You have configured high availability for a virtual machine. You can check if a virtual machine is highly available when you select it and click on its General tab in the details pane.
See Also:
8.13. Other Virtual Machine Tasks
8.13.1. Enabling SAP monitoring for a virtual machine from the Administration Portal
Summary
Enable SAP monitoring on a virtual machine to be recognized by SAP monitoring systems.
Procedure 8.34. Enabling SAP monitoring for a Virtual Machine from the Administration Portal
- Use the Virtual Machines resource tab, tree mode, or the search function to find and select a virtual machine with a status of
Downin the results list. - Click button to open the Edit Virtual Machine window.
- Select the Custom Properties tab.
- Use the drop-down menu to select
sap_agent. 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 selectsap_agent. - Click to save changes and close the window.
Result
You have enabled SAP monitoring for your virtual machine.
8.13.2. Configuring Red Hat Enterprise Linux 5.4 or Higher Virtual Machines to use SPICE
8.13.2.1. Using SPICE on virtual machines running versions of Red Hat Enterprise Linux released prior to 5.4
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 additional qxl drivers. The qxl drivers are provided with Red Hat Enterprise Linux 5.4 and newer. Older 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.
8.13.2.2. Installing qxl drivers on virtual machines
Summary
This procedure installs qxl drivers on virtual machines running Red Hat Enterprise Linux 5.4 or higher.
Procedure 8.35. Installing qxl drivers on a virtual machine
- Log in to a Red Hat Enterprise Linux virtual machine.
- Open a terminal.
- Run the following command as root:
#
yum install xorg-x11-drv-qxl
Result
The qxl drivers have been installed and must now be configured.
8.13.2.3. Configuring qxl drivers on virtual machines
Summary
You can configure qxl drivers using either a graphical interface or the command line. Perform only one of the following procedures.
Procedure 8.36. Configuring qxl drivers in GNOME
- Click System.
- Click Administration.
- Click Display.
- Click the Hardware tab.
- Click Video Cards Configure.
- Select qxl and click OK.
- Restart X-Windows by logging out of the virtual machine and logging back in.
Procedure 8.37. Configuring qxl drivers on the command line:
- Back up
/etc/X11/xorg.conf:#
cp /etc/X11/xorg.conf /etc/X11/xorg.conf.$$.backup - Make the following change to the Device section of
/etc/X11/xorg.conf:Section "Device" Identifier "Videocard0" Driver "qxl" Endsection
Result
You have configured qxl drivers to enable your virtual machine to use SPICE.
8.13.2.4. Configuring a virtual machine's tablet and mouse to use SPICE
Summary
Edit the /etc/X11/xorg.conf file to enable SPICE for your virtual machine's tablet devices.
Procedure 8.38. Configuring a virtual machine's tablet and mouse to use SPICE
- Verify that the tablet device is available on your guest:
#
If there is no output from the command, do not continue configuring the tablet./sbin/lsusb -v | grep 'QEMU USB Tablet' - Back up
/etc/X11/xorg.confby running this command:#
cp /etc/X11/xorg.conf /etc/X11/xorg.conf.$$.backup - 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
- Log out and log back into the virtual machine to restart X-Windows.
Result
You have enabled a tablet and a mouse device on your virtual machine to use SPICE.
8.13.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.
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 higher 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:
# service ntpd start
Add the ntpd service to the default startup sequence:
# chkconfig ntpd on
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.
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
You can use the engine-config tool to receive alerts when hosts drift out of sync.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 renamed grub.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.
| Red Hat Enterprise Linux | Additional virtual machine kernel parameters |
|---|---|
| 5.4 AMD64/Intel 64 with the paravirtualized clock | Additional parameters are not required |
| 5.4 AMD64/Intel 64 without the paravirtualized clock | notsc lpj=n |
| 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 |
Using the Real-Time Clock with Windows virtual machines
Windows uses the both the Real-Time Clock (RTC) and the Time Stamp Counter (TSC). For Windows virtual machines the Real-Time Clock can be used instead of the TSC for all time sources which resolves virtual machine timing issues.
To enable the Real-Time Clock for the PMTIMER clocksource (the PMTIMER usually uses the TSC) add the following line to the Windows boot settings. Windows boot settings are stored in the boot.ini file. Add the following line to the
boot.ini file:
/use pmtimer
For more information on Windows boot settings and the pmtimer option, refer to Available switch options for the Windows XP and the Windows Server 2003 Boot.ini files.
See Also:
Chapter 9. Templates
9.1. Introduction to Templates
A template is a copy of a preconfigured virtual machine, used to simplify the subsequent, repeated creation of similar virtual machines. Templates capture installed software and software configurations, as well as the hardware configuration, of the original virtual machine.
When you create a template from a virtual machine, a read-only copy of the virtual machine's disk is taken. The read-only disk becomes the base disk image of the new template, and of any virtual machines created from the template. As such, the template cannot be deleted whilst virtual machines created from the template exist in the environment.
Virtual machines created from a template use the same NIC type and driver as the original virtual machine, but utilize separate and unique MAC addresses.
Note
A virtual machine may require to be sealed before being used to create a template.
9.2. Template Tasks
9.2.1. Creating a Template from an Existing Virtual Machine
Summary
Create a template from an existing virtual machine to use as a blueprint for creating additional virtual machines.
Procedure 9.1. Creating a Template from an Existing Virtual Machine
- Use the Virtual Machines resource tab, tree mode, or the search function to find and select a virtual machine in the results list.
- Ensure the virtual machine is powered down and has a status of
Down. - Click to open the New Template window.
- Enter a Name, Description and Comment for the template.
- From the Cluster drop-down menu, select the cluster with which the template will be associated. By default, this will be the same as that of the source virtual machine.
- In the Disks Allocation section, enter an alias for the disk in the Alias text field and select the storage domain on which the disk will be stored from the Target drop-down list. By default, these will be the same as those of the source virtual machine.
- The Allow all users to access this Template check box is selected by default. This makes the template public.
- The Copy VM permissions check box is not selected by default. Select this check box to copy the permissions of the source virtual machine to the template.
- Click .
Result
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 machine disk and 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.
See Also:
9.2.2. Explanation of Settings and Controls in the New Template Window
The following table details the settings for the New Template window.
Table 9.1. New Template and Edit 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 with any combination of uppercase and lowercase letters, numbers, hyphens, and underscores.
|
|
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 will be associated. This is the same as the original virtual machines by default. You can select any cluster in the data center.
|
|
Create as a Sub Template version
|
Allows you to specify whether the template will be created as a new version of an existing template. Select this check box to access the settings for configuring this option.
|
|
Disks Allocation
|
Alias - An alias for the virtual machine 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 current actual size of the virtual disk used by the template. This value cannot be edited, and is provided for reference only.
Target - The storage domain on which the virtual disk used by the template will be 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.
|
|
Allow all users to access this Template
|
Allows you to specify whether a template is public or 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
|
Allows you to copy explicit permissions that have been set on the source virtual machine to the template.
|
9.2.3. Editing a Template
Summary
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 9.2. Editing a Template
- Use the Templates resource tab, tree mode, or the search function to find and select the template in the results list.
- Click to open the Edit Template window.
- Change the necessary properties and click .
Result
The properties of the template are updated. The Edit Template window will not close if a property field is invalid.
9.2.4. Deleting a Template
Summary
Delete a template from your Red Hat Enterprise Virtualization environment.
Warning
If you have used a template to create a virtual machine, make sure that you do not delete the template as the virtual machine needs it to continue running.
Procedure 9.3. Deleting a Template
- Use the resource tabs, tree mode, or the search function to find and select the template in the results list.
- Click to open the Remove Template(s) window.
- Click to remove the template.
Result
You have removed the template.
9.2.5. Exporting Templates
9.2.5.1. Migrating Templates to the Export Domain
Summary
Export templates into the export domain to move them to another data domain, either in the same Red Hat Enterprise Virtualization environment, or another one.
Procedure 9.4. Exporting Individual Templates to the Export Domain
- Use the Templates resource tab, tree mode, or the search function to find and select the template in the results list.
- Click to open the Export Template window.
Note
Select the Force Override check box to replace any earlier version of the template on the export domain. - Click to begin exporting the template; this may take up to an hour, depending on the virtual machine disk image size and your storage hardware.
- Repeat these steps until the export domain contains all the templates to migrate before you start the import process.Use the Storage resource tab, tree mode, or the search function to find and select the export domain in the results list and click the Template Import tab in the details pane to view all exported templates in the export domain.
Result
The templates have been exported to the export domain.
9.2.5.2. Copying a Template's Virtual Hard Disk
Summary
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 machine disk.
Procedure 9.5. Copying a Virtual Hard Disk
- Select the Disks tab.
- Select the template disk or disks to copy.
- Click the Copy button to display the Copy Disk window.
- Use the drop-down menu or menus to select the Target data domain.
Result
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.
9.2.6. Importing Templates
9.2.6.1. Importing a Template into a Data Center
Prerequisites:
Summary
Import templates from a newly attached export domain.
Procedure 9.6. Importing a Template into a Data Center
- Use the resource tabs, tree mode, or the search function to find and select the newly attached export domain in the results list.
- Select the Template Import tab of the details pane to display the templates that migrated across with the export domain.
- Select a template and click to open the Import Template(s) window.
- Select the templates to import.
- Use the drop-down menus to select the Destination Cluster and Storage domain. Alter the Suffix if applicable.Alternatively, clear the Clone All Templates check box.
- Click OK to import templates and open a notification window. Click to close the notification window.
Result
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.
9.3. Sealing Templates in Preparation for Deployment
9.3.1. Sealing a Linux Virtual Machine Manually for Deployment as a Template
Summary
Generalize (seal) a Linux virtual machine before making it into a template. This prevents conflicts between virtual machines deployed from the template.
Procedure 9.7. Sealing a Linux Virtual Machine
- Log in to the virtual machine. Flag the system for re-configuration by running the following command as root:
# touch /.unconfigured - Remove ssh host keys. Run:
# rm -rf /etc/ssh/ssh_host_* - Set
HOSTNAME=localhost.localdomainin/etc/sysconfig/network - Remove /etc/udev/rules.d/70-*. Run:
# rm -rf /etc/udev/rules.d/70-* - Remove the
HWADDR=line from/etc/sysconfig/network-scripts/ifcfg-eth*. - Optionally delete all the logs from
/var/logand build logs from/root. - Shut down the virtual machine. Run:
# poweroff
Result
The virtual machine is sealed and can be made into a template. You can deploy Linux virtual machines from this template without experiencing configuration file conflicts.
9.3.2. Sealing a Linux Virtual Machine for Deployment as a Template using sys-unconfig
Summary
Generalize (seal) a Linux virtual machine using the sys-unconfig command before making it into a template. This prevents conflicts between virtual machines deployed from the template.
Procedure 9.8. Sealing a Linux Virtual Machine using sys-unconfig
- Log in to the virtual machine.
- Remove ssh host keys. Run:
# rm -rf /etc/ssh/ssh_host_* - Set
HOSTNAME=localhost.localdomainin/etc/sysconfig/network - Remove the
HWADDR=line from/etc/sysconfig/network-scripts/ifcfg-eth*. - Optionally delete all the logs from
/var/logand build logs from/root. - Run the following command:
# sys-unconfig
Result
The virtual machine shuts down; it is now sealed and can be made into a template. You can deploy Linux virtual machines from this template without experiencing configuration file conflicts.
9.3.3. Sealing a Windows Template
9.3.3.1. Considerations when Sealing a Windows Template with Sysprep
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.
The Sysprep tool is used to seal Windows templates before use.
Important
Do not reboot the virtual machine during this process.
Before starting the
Sysprep process, verify the following settings are configured:
- The Windows Sysprep parameters have been correctly defined.If not, click and enter the required information in the Operating System and Domain fields.
- The correct product key has been entered in the
engine-configconfiguration tool.If not, run the configuration tool on the Manager as the root user, and enter the required information. The configuration keys that you need to set areProductKeyandSysPrepPath. For example, the Windows 7 configuration value isProductKeyWindow7andSysPrepWindows7Path. Set these values with this command:# engine-config --set ProductKeyWindow7=<validproductkey> --cver=general
9.3.3.2. Sealing a Windows XP Template
Summary
Seal a Windows XP template using the Sysprep tool before using the template to deploy virtual machines.
Note
You can also use the procedure above to seal a Windows 2003 template. The Windows 2003 Sysprep tool is available at http://www.microsoft.com/download/en/details.aspx?id=14830.
Procedure 9.9. Sealing a Windows XP Template
- Download
sysprepto the virtual machine to be used as a template.The Windows XP Sysprep tool is available at http://www.microsoft.com/download/en/details.aspx?id=11282 - Create a new directory:
c:\sysprep. - Open the
deploy.cabfile and add its contents toc:\sysprep. - Execute
sysprep.exefrom within the folder and click on the welcome message to display the Sysprep tool. - Select the following check boxes:
- Don't reset grace period for activation
- Use Mini-Setup
- Ensure that the shutdown mode is set to
Shut downand click . - Acknowledge the pop-up window to complete the sealing process; the virtual machine shuts down automatically upon completion.
Result
The Windows XP template is sealed and ready for deploying virtual machines.
9.3.3.3. Sealing a Windows 7 or Windows 2008 Template
Summary
Seal a Windows 7 or Windows 2008 template before using the template to deploy virtual machines.
Procedure 9.10. Sealing a Windows 7 or Windows 2008 Template
- In the virtual machine to be used as a template, open a command line terminal and type
regedit. - The Registry Editor window opens. On the left pane, expand → → .
- On the main window, right-click to add a new string value using → .
- Right-click on the file and select Modify to open the Edit String window.
- Enter the following information in the provided fields:
- Value name:
UnattendFile - Value data:
a:\sysprep.inf
- Launch Sysprep from
C:\Windows\System32\sysprep\sysprep.exe. - Enter the following information into the Sysprep tool:
- 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.
Click to complete the sealing process; the virtual machine shuts down automatically upon completion.
Result
The Windows 7 or Windows 2008 template is sealed and ready for deploying virtual machines.
9.3.4. Using Cloud-Init to Automate the Configuration of Virtual Machines
9.3.4.1. Cloud-Init Overview
Cloud-Init is a tool for automating the initial setup of virtual machines such as configuring the hostname, network interfaces, authorized keys and more. 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. Options in the Run Once function of the Red Hat Enterprise Virtualization Manager can then be used to provide these instructions.
9.3.4.2. Installing Cloud-Init
Install cloud-init on a virtual machine.
- Enable the following channel:
Red Hat Common (for RHEL 6 Server x86_64)
- Log on to the virtual machine.
- Open a terminal.
- Install the cloud-init package and dependencies:
# yum install cloud-init
9.3.4.3. Using Cloud-Init
Use Cloud-Init to automate the initial configuration of a Linux virtual machine that has been provisioned based on a template.
- Use the Virtual Machines resource tab, tree mode, or the search function to find and select a virtual machine in the results list.
- Click Run Once to open the Run Virtual Machine(s) window.
- Expand the Initial Run section and select the Cloud-Init check box.
- Select the check box to enter a Hostname.
- Select the check box to enable Network and use the Add new and Remove selected buttons to add or remove network interfaces.
- Select the check box to enable SSH Authorized Keys.
- Select the check box to enable Regenerate System SSH Keys.
- Select the check box to specify a Time Zone.
- Select the check box to specify a Root Password and verify the password in Verify Root Password.
- Select the check box to add a File Attachment and use the Add new and Remove selected buttons to add or remove files.
- Click Ok.
Important
Cloud-Init is only supported on cluster compatibility version 3.3 and higher.
Result
The virtual machine boots and the settings specified in Cloud-Init are applied.
9.4. Templates and Permissions
9.4.1. Managing System Permissions for a Template
The system administrator, as the SuperUser, manages all aspects of the Administration Portal. More specific administrative roles can be assigned to other users. These restricted administrator roles are useful for empowering a user with certain administrative privileges that limit them to a specific resource: a DataCenterAdmin role has administrator privileges only for the assigned data center, a ClusterAdmin has administrator privileges only for the assigned cluster, and so forth.
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; and
- import and export templates.
Note
You can only assign roles and permissions to existing users.
9.4.2. Template Administrator Roles Explained
Template Administrator Permission Roles
The table below describes the administrator roles and privileges applicable to template administration.
Table 9.2. Red Hat Enterprise Virtualization System Administrator Roles
| Role | Privileges | Notes |
|---|---|---|
| TemplateAdmin | Can perform all operations on templates. | Has privileges to create, delete and configure the templates' storage domains and network details, and to move templates between domains. |
| NetworkAdmin | Network Administrator | Can configure and manage networks attached to templates. |
9.4.3. Template User Roles Explained
Template User Permission Roles
The table below describes the user roles and privileges applicable to using and administrating templates in the User Portal.
Table 9.3. Red Hat Enterprise Virtualization Template User Roles
| Role | Privileges | Notes |
|---|---|---|
| TemplateCreator | Can create, edit, manage and remove virtual machine templates within assigned resources. | The TemplateCreator role is not applied to a specific template; apply this role to a 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 template, assign and manage user permissions for the template. | The TemplateOwner role is automatically assigned to the user who creates a template. Other users who do not have TemplateOwner permissions on a template cannot view or use the template. |
| UserTemplateBasedVm | Can use the template to create virtual machines. | Cannot edit template properties. |
| NetworkUser | Logical network and network interface user for templates. | If the Allow all users to use this Network option was selected when a logical network is created, NetworkUser 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. |
9.4.4. Assigning an Administrator or User Role to a Resource
Summary
Assign administrator or user roles to resources to allow users to access or manage that resource.
Procedure 9.11. Assigning a Role to a Resource
- Use the resource tabs, tree mode, or the search function to find and select the resource in the results list.
- Click the tab of the details pane to list the assigned users, the user's role, and the inherited permissions for the selected resource.
- Click to open the Add Permission to User window.
- Enter the name or user name of an existing user into the Search text box and click . Select a user from the resulting list of possible matches.
- Select a role from the Role to Assign: drop-down menu.
- Click to assign the role and close the window.
Result
You have assigned a role to a user; the user now has the inherited permissions of that role enabled for that resource.
9.4.5. Removing an Administrator or User Role from a Resource
Summary
Remove an administrator or user role from a resource; the user loses the inherited permissions associated with the role for that resource.
Procedure 9.12. Removing a Role from a Resource
- Use the resource tabs, tree mode, or the search function to find and select the resource in the results list.
- Click the tab of the details pane to list the assigned users, the user's role, and the inherited permissions for the selected resource.
- Select the user to remove from the resource.
- Click . The Remove Permission window opens to confirm permissions removal.
- Click to remove the user role.
Result
You have removed the user's role, and the associated permissions, from the resource.
Chapter 10. Pools
10.1. Introduction to Virtual Machine Pools
A virtual machine pool is a group of virtual machines that are all clones of the same template and that can be used on demand by any user in a given group. Virtual machine pools allow administrators to rapidly configure a set of generalized virtual machines for users.
Users access a virtual machine pool by taking a virtual machine from the pool. When a user takes a virtual machine from a pool, they are provided with any one of the virtual machines in the pool if any are available. That virtual machine will have the same operating system and configuration as that of the template on which the pool was based, but users may not receive the same member of the pool each time they take a virtual machine. Users can also take multiple virtual machines from the same virtual machine pool depending on the configuration of that pool.
Virtual machines in a pool are stateless, meaning that data is not persistent across reboots. Virtual machines in a pool are started when taken by a user, and shut down when the user is finished.
Virtual machine pools can also contain pre-started virtual machines. Pre-started virtual machines are kept in an up state, and remain idle until they are taken by a user. This allows users to start using such virtual machines immediately, but these virtual machines will consume system resources even while not in use due to being idle.
Note
Virtual machines taken from a pool are not stateless when accessed from the Administration Portal. This is because administrators need to be able to write changes to the disk if necessary.
10.2. Virtual Machine Pool Tasks
10.2.1. Creating a Virtual Machine Pool
Summary
You can create a virtual machine pool that contains multiple virtual machines that have been created based on a common template. Virtual machine pools provide generic virtual machines to end users on demand.
Procedure 10.1. Creating a Virtual Machine Pool
- In flat mode, click the Pools resource tab to display a list of virtual machine pools.
- Click the button to open the New Pool window.
- Use the drop down-list to select the Cluster or use the selected default.
- Use the Based on Template drop-down list to select a template or use the selected default. A template provides standard settings for all the virtual machines in the pool.
- Use the Operating System drop-down list to select an Operating System or use the default provided by the template.
- Use the Optimized for drop-down list to optimize virtual machines for either Desktop use or Server use.
- Enter the Name, Description, and Number of VMs for the pool.
- Select the Maximum number of VMs per user that a single user is allowed to run in a session. The minimum is one.
- Click the Show Advanced Options button, and then select the System tab. Enter the Memory Size to be used for each virtual machine in the pool and the number of Total Virtual CPUs, or use the defaults, which are set in the template.
- If applicable, click the Advanced Parameters disclosure button and use the drop-down lists to select the Cores per Virtual Socket and Virtual Sockets. The number of these you can set depends on the number of Total Virtual CPUs you have specified.
- Click the Pool tab and select a Pool Type:
- Manual - The administrator is responsible for explicitly returning the virtual machine to the pool. The virtual machine reverts to the original base image after the administrator returns it to the pool.
- Automatic - When the virtual machine is shut down, it automatically reverts to its base image and is returned to the virtual machine pool.
- The Initial Run, Console, Host, Resource Allocation, Boot Options, and Custom Properties tabs are not mandatory but define options for your pool. These tabs feature settings and controls that are identical to the settings and controls in the New Virtual Machines window.
- Click to create the pool.
Result
You have created and configured a virtual machine pool with the specified number of identical virtual machines.
You can view these virtual machines in the Virtual Machines resource tab, or in the details pane of the Pools resource tab; a virtual machine in a pool is distinguished from independent virtual machines by its icon.
See Also:
10.2.2. Editing a Virtual Machine Pool
Summary
After a virtual machine pool has been created, its properties can be edited. The properties available when editing a virtual machine pool are identical to those available when creating a new virtual machine pool except that the Number of VMs property is replaced by Increase number of VMs in pool by.
Procedure 10.2. Editing a Virtual Machine Pool
- Use the Pools resource tab, tree mode, or the search function to find and select the virtual machine pool in the results list.
- Click Edit to open the Edit Pool window.
- Edit the properties of the virtual machine pool.
- Click Ok.
Result
The properties of an existing virtual machine pool have been edited.
10.2.3. Prestarting Virtual Machines in a Pool
Prerequisites:
The virtual machines in a virtual machine pool are powered down by default. When a user requests a virtual machine from a pool, a machine is powered up and assigned to the user. In contrast, a prestarted virtual machine is already running and waiting to be assigned to a user, decreasing the amount of time a user has to wait before being able to access a machine. When a prestarted virtual machine is shut down it is returned to the pool and restored to its original state. The maximum number of prestarted virtual machines is the number of virtual machines in the pool.
Summary
Prestarted virtual machines are suitable for environments in which users require immediate access to virtual machines which are not specifically assigned to them. Only automatic pools can have prestarted virtual machines.
Procedure 10.3. Prestarting Virtual Machines in a Pool
- Use the Pools resource tab, tree mode, or the search function to find and select the virtual machine pool in the results list.
- Click to open the Edit Pool window.
- Enter the number of virtual machines to be prestarted in the Prestarted VMs field.
- Select the Pool tab. Ensure Pool Type is set to Automatic.
- Click .
Result
You have set a number of prestarted virtual machines in a pool. The prestarted machines are running and available for use.
10.2.4. Adding Virtual Machines to a Virtual Machine Pool
Summary
If you require more virtual machines than originally provisioned in a virtual machine pool, add more machines to the pool.
Procedure 10.4. Adding Virtual Machines to a Virtual Machine Pool
- Use the Pools resource tab, tree mode, or the search function to find and select the virtual machine pool in the results list.
- Click to open the Edit Pool window.
- Enter the number of additional virtual machines to add in the Increase number of VMs in pool by field.
- Click .
Result
You have added more virtual machines to the virtual machine pool.
10.2.5. Detaching Virtual Machines from a Virtual Machine Pool
Summary
You can detach virtual machines from a virtual machine pool. Detaching a virtual machine removes it from the pool to become an independent virtual machine.
Procedure 10.5. Detaching Virtual Machines from a Virtual Machine Pool
- Use the Pools resource tab, tree mode, or the search function to find and select the virtual machine pool in the results list.
- Ensure the virtual machine has a status of
Downbecause you cannot detach a running virtual machine.Click the Virtual Machines tab in the details pane to list the virtual machines in the pool. - Select one or more virtual machines and click to open the Detach Virtual Machine(s) confirmation window.
- Click to detach the virtual machine from the pool.
Note
The virtual machine still exists in the environment and can be viewed and accessed from the Virtual Machines resource tab. Note that the icon changes to denote that the detached virtual machine is an independent virtual machine.
Result
You have detached a virtual machine from the virtual machine pool.
10.2.6. Removing a Virtual Machine Pool
Summary
You can remove a virtual machine pool from a data center. You must first either delete or detach all of the virtual machines in the pool. Detaching virtual machines from the pool will preserve them as independent virtual machines.
Procedure 10.6. Removing a Virtual Machine Pool
- Use the Pools resource tab, tree mode, or the search function to find and select the virtual machine pool in the results list.
- Click to open the Remove Pool(s) confirmation window.
- Click to remove the pool.
Result
You have removed the pool from the data center.
10.3. Pools and Permissions
10.3.1. Managing System Permissions for a Virtual Machine Pool
The system administrator, as the SuperUser, manages all aspects of the Administration Portal. More specific administrative roles can be assigned to other users. These restricted administrator roles are useful for empowering a user with certain administrative privileges that limit them to a specific resource: a DataCenterAdmin role has administrator privileges only for the assigned data center, a ClusterAdmin has administrator privileges only for the assigned cluster, and so forth.
A virtual machine pool administrator is a system administration role for virtual machine pools in a data center. This role can be applied to specific virtual machine pools, to a data center, or to the whole virtualized environment; this is useful to allow different users to manage certain virtual machine pool resources.
The virtual machine pool administrator role permits the following actions:
- Create, edit, and remove pools; and
- Add and detach virtual machines from the pool.
Note
You can only assign roles and permissions to existing users.
10.3.2. Virtual Machine Pool Administrator Roles Explained
Pool Permission Roles
The table below describes the administrator roles and privileges applicable to pool administration.
Table 10.1. Red Hat Enterprise Virtualization System Administrator Roles
| Role | Privileges | Notes |
|---|---|---|
| VmPoolAdmin | System Administrator role of a virtual pool. | Can create, delete, and configure a virtual pool, assign and remove virtual pool users, and perform basic operations on a virtual machine. |
| ClusterAdmin | Cluster Administrator | Can use, create, delete, manage all virtual machine pools in a specific cluster. |
10.3.3. Assigning an Administrator or User Role to a Resource
Summary
Assign administrator or user roles to resources to allow users to access or manage that resource.
Procedure 10.7. Assigning a Role to a Resource
- Use the resource tabs, tree mode, or the search function to find and select the resource in the results list.
- Click the tab of the details pane to list the assigned users, the user's role, and the inherited permissions for the selected resource.
- Click to open the Add Permission to User window.
- Enter the name or user name of an existing user into the Search text box and click . Select a user from the resulting list of possible matches.
- Select a role from the Role to Assign: drop-down menu.
- Click to assign the role and close the window.
Result
You have assigned a role to a user; the user now has the inherited permissions of that role enabled for that resource.
10.3.4. Removing an Administrator or User Role from a Resource
Summary
Remove an administrator or user role from a resource; the user loses the inherited permissions associated with the role for that resource.
Procedure 10.8. Removing a Role from a Resource
- Use the resource tabs, tree mode, or the search function to find and select the resource in the results list.
- Click the tab of the details pane to list the assigned users, the user's role, and the inherited permissions for the selected resource.
- Select the user to remove from the resource.
- Click . The Remove Permission window opens to confirm permissions removal.
- Click to remove the user role.
Result
You have removed the user's role, and the associated permissions, from the resource.
Chapter 11. Virtual Machine Disks
11.1. Understanding Virtual Machine Storage
Red Hat Enterprise Virtualization supports three storage types: NFS, iSCSI and FCP.
In each type, a host known as the Storage Pool Manager (SPM) manages access between hosts and storage. The SPM host is the only node that has full access within the storage pool; the SPM can modify the storage domain metadata, and the pool's metadata. All other hosts can only access virtual machine hard disk image data.
By default in an NFS, local, or POSIX compliant data center, the SPM creates the virtual disk using a thin provisioned format as a file in a file system.
In iSCSI and other block-based data centers, the SPM creates a volume group on top of the Logical Unit Numbers (LUNs) provided, and makes logical volumes to use as virtual machine disks. Virtual machine disks on block-based storage are preallocated by default.
If the virtual disk is preallocated, a logical volume of the specified size in GB is created. The virtual machine can be mounted on a Red Hat Enterprise Linux server using
kpartx, vgscan, vgchange and mount to investigate the virtual machine's processes or problems.
If the virtual disk is a thin provisioned, a 1 GB logical volume is created. The logical volume is continuously monitored by the host on which the virtual machine is running. As soon as the usage nears a threshold the host notifies the SPM, and the SPM extends the logical volume by 1 GB. The host is responsible for resuming the virtual machine after the logical volume has been extended. If the virtual machine goes into a paused state it means that the SPM could not extend the disk in time. This occurs if the SPM is too busy or if there is not enough storage space.
A virtual disk with a preallocated (RAW) format has significantly faster write speeds than a virtual disk with a thin provisioning (Qcow2) format. Thin provisioning takes significantly less time to create a virtual disk. The thin provision format is suitable for non-IO intensive virtual machines.
Red Hat Enterprise Virtualization 3.3 introduces online virtual drive resizing.
11.2. Understanding Virtual Disks
Virtual disks are of two types, Thin Provisioned or Preallocated. Preallocated disks are RAW formatted. Thin provisioned disks are Qcow2 formatted.
- PreallocatedA preallocated virtual disk has reserved storage of the same size as the virtual disk itself. The backing storage device (file/block device) is presented as is to the virtual machine with no additional layering in between. This results in better performance because no storage allocation is required during runtime.On SAN (iSCSI, FCP) this is achieved by creating a block device with the same size as the virtual disk. On NFS this is achieved by filling the backing hard disk image file with zeros. Preallocating storage on an NFS storage domain presumes that the backing storage is not Qcow2 formatted and zeros will not be deduplicated in the hard disk image file. (If these assumptions are incorrect, do not select Preallocated for NFS virtual disks).
- Thin ProvisionedFor sparse virtual disks backing storage is not reserved and is allocated as needed during runtime. This allows for storage over commitment under the assumption that most disks are not fully utilized and storage capacity can be utilized better. This requires the backing storage to monitor write requests and can cause some performance issues. On NFS backing storage is achieved by using files. On SAN this is achieved by creating a block device smaller than the virtual disk's defined size and communicating with the hypervisor to monitor necessary allocations. This does not require support from the underlying storage devices.
The possible combinations of storage types and formats are described in the following table.
Table 11.1. Permitted Storage Combinations
| Storage | Format | Type | Note |
|---|---|---|---|
| NFS or iSCSI/FCP | RAW or Qcow2 | Sparse or Preallocated | |
| NFS | RAW | Preallocated | A file with an initial size which equals the amount of storage defined for the virtual disk, and has no formatting. |
| NFS | RAW | Sparse | A file with an initial size which is close to zero, and has no formatting. |
| NFS | Qcow2 | Sparse | A file with an initial size which is close to zero, and has RAW formatting. Subsequent layers will be Qcow2 formatted. |
| SAN | RAW | Preallocated | A block device with an initial size which equals the amount of storage defined for the virtual disk, and has no formatting. |
| SAN | Qcow2 | Preallocated | A block device with an initial size which equals the amount of storage defined for the virtual disk, and has Qcow2 formatting. |
| SAN | Qcow2 | Sparse | A block device with an initial size which is much smaller than the size defined for the VDisk (currently 1GB), and has Qcow2 formatting for which space is allocated as needed (currently in 1GB increments). |
11.3. Shareable Disks in Red Hat Enterprise Virtualization
Some applications require storage to be shared between servers. Red Hat Enterprise Virtualization allows you to mark virtual machine hard disks as shareable and attach those disks to virtual machines. That way a single virtual disk can be used by multiple cluster-aware guests.
Shared disks are not to be used in every situation. For applications like clustered database servers, and other highly available services, shared disks are appropriate. Attaching a shared disk to multiple guests that are not cluster-aware is likely to cause data corruption because their reads and writes to the disk are not coordinated.
You cannot take a snapshot of a shared disk. Virtual disks that have snapshots taken of them cannot later be marked shareable.
You can mark a disk shareable either when you create it, or by editing the disk later.
11.4. Virtual Disk Tasks
- 11.4.1. Creating Floating Virtual Disks
- 11.4.2. Explanation of Settings in the New Virtual Disk Window
- 11.4.3. Moving a Virtual Machine Hard Disk Between Data Domains
- 11.4.4. Importing a Virtual Disk Image from an OpenStack Image Service
- 11.4.5. Exporting a Virtual Machine Disk to an OpenStack Image Service
11.4.1. Creating Floating Virtual Disks
Summary
You can create a virtual disk that does not belong to any virtual machines. You can then attach this disk to a single virtual machine, or to multiple virtual machines if the disk is shareable.
Procedure 11.1. Creating Floating Virtual Disks
- Select the Disks resource tab.
- Click to open the Add Virtual Disk window.
- Use the radio buttons to specify whether the virtual disk will be an Internal or External (Direct Lun) disk.
- Enter the Size(GB), Alias, and Description of the virtual disk.
- Use the drop-down menus to select the Interface, Allocation Policy, Data Center, and Storage Domain of the virtual disk.
- Select the Wipe After Delete, Is Bootable and Is Shareable check boxes to enable each of these options.
- Click OK.
Result
You have created a virtual disk that can be attached to one or more virtual machines depending on its settings.
11.4.2. Explanation of Settings in the New Virtual Disk Window
Table 11.2. Add Virtual Disk Settings: Internal
|
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 higher 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.
|
|
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. 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. 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. Thinly provisioned disks are faster to create than preallocated disks and allow for storage over-commitment. Thinly provisioned virtual disks are recommended for desktops.
|
|
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 cluster, and also shows the total space and currently available space in the storage domain.
|
|
Wipe after delete
|
Allows you to enable enhanced security for deletion of sensitive material when the virtual disk is deleted.
|
|
Is bootable
|
Allows you to enable the bootable flag on the virtual disk.
|
|
Is Shareable
|
Allows you to attach the virtual disk to more than one virtual machine at a time.
|
The External (Direct Lun) settings include all entries from the Internal settings except Size(GB), Wipe after Delete, and some additional entries as follows. The settings specific to external LUNs can be displayed in either Targets > LUNs or LUNs > Targets, which specifies whether available LUNs are sorted according to the host on which they are discovered or in a single list of LUNs.
Table 11.3. Add Virtual Disk Settings: External (Direct Lun)
|
Field Name
|
Description
|
|---|---|
|
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.
|
Fill in the fields in the Discover Targets section and click the Discover button 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:
- 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.
11.4.3. Moving a Virtual Machine Hard Disk Between Data Domains
Summary
You would like to move a virtual hard disk from one data domain to another. You might do this to take advantage of high performance storage, or because you would like to decommission one of your storage domains that contains virtual hard disks.
If the virtual disk is attached to 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 data domain as the virtual machine disk.
Procedure 11.2. Moving a Virtual Machine Hard Disk Between Data Domains
- Select the Disks resource tab.
- Select the virtual disk or disks to move.
- Click Move to open the Move Disk(s) window.
- Use the drop-down menu or menus to select the Target data domain.
- Click to move the disks and close the window.
Result
Disks have a Locked status while being moved. Upon completion, the virtual disk has been moved from the source domain to the target domain.
11.4.4. Importing a Virtual Disk Image from an OpenStack Image Service
Summary
Virtual disk images managed by an OpenStack Image Service can be imported into the Red Hat Enterprise Virtualization Manager if that OpenStack Image Service has been added to the Manager as an external provider.
- Click the Storage resource tab and select the OpenStack Image Service domain from the results list.
- Select the image to import in the Images tab of the details pane.
- Click to open the Import Image(s) window.
- From the Data Center drop-down menu, select the data center into which the virtual disk image will be imported.
- From the Domain Name drop-down menu, select the storage domain in which the virtual disk image will be stored.
- Optionally, select a quota from the Quota drop-down menu to apply a quota to the virtual disk image.
- Click to import the image.
Result
The image is imported as a floating disk and is displayed in the results list of the Disks resource tab. It can now be attached to a virtual machine.
11.4.5. Exporting a Virtual Machine Disk to an OpenStack Image Service
Summary
Virtual machine disks can be exported to an OpenStack Image Service that has been added to the Manager as an external provider.
- Click the Disks resource tab.
- Select the disks to export.
- Click the Export button to open the Export Disk window.
- From the Domain Name drop-down list, select the OpenStack Image Service to which the disks will be exported.
- From the Quota drop-down list, select a quota for the disks if a quota is to be applied.
- Click OK.
Result
The virtual machine disks are exported to the specified OpenStack Image Service where they are managed as virtual machine disk images.
Important
Virtual machine disks can only be exported if they do not have multiple volumes, are not thinly provisioned, and do not have any snapshots.
11.5. Virtual Disks and Permissions
11.5.1. Managing System Permissions for a Virtual Disk
The system administrator, as the SuperUser, manages all aspects of the Administration Portal. More specific administrative roles can be assigned to other users. These restricted administrator roles are useful for empowering a user with certain administrative privileges that limit them to a specific resource: a DataCenterAdmin role has administrator privileges only for the assigned data center, a ClusterAdmin has administrator privileges only for the assigned cluster, a StorageAdmin has administrator privileges only for the assigned storage domain, and so forth.
Red Hat Enterprise Virtualization Manager provides two default virtual disk user roles, but no default virtual disk administrator roles. One of these user roles, the DiskCreator role, enables the administration of virtual disks from the User Portal. This role can be applied to specific virtual machines, to a data center, to a specific storage domain, or to the whole virtualized environment; this is useful to allow different users to manage different virtual resources.
The virtual disk creator role permits the following actions:
- Create, edit, and remove virtual disks associated with a virtual machine or other resources; and
- Edit user permissions for virtual disks.
Note
You can only assign roles and permissions to existing users.
11.5.2. Virtual Disk User Roles Explained
Virtual Disk User Permission Roles
The table below describes the user roles and privileges applicable to using and administrating virtual machine disks in the User Portal.
Table 11.4. Red Hat Enterprise Virtualization System Administrator Roles
| Role | Privileges | Notes |
|---|---|---|
| DiskOperator | Virtual disk user. | Can use, view and edit virtual disks. Inherits permissions to use the virtual machine to which the virtual disk is attached. |
| DiskCreator | Can create, edit, manage and remove virtual machine disks within assigned clusters or data centers. | This role is not applied to a specific virtual disk; apply this role to a user for the whole environment with the Configure window. Alternatively apply this role for specific data centers, clusters, or storage domains. |
11.5.3. Assigning an Administrator or User Role to a Resource
Summary
Assign administrator or user roles to resources to allow users to access or manage that resource.
Procedure 11.3. Assigning a Role to a Resource
- Use the resource tabs, tree mode, or the search function to find and select the resource in the results list.
- Click the tab of the details pane to list the assigned users, the user's role, and the inherited permissions for the selected resource.
- Click to open the Add Permission to User window.
- Enter the name or user name of an existing user into the Search text box and click . Select a user from the resulting list of possible matches.
- Select a role from the Role to Assign: drop-down menu.
- Click to assign the role and close the window.
Result
You have assigned a role to a user; the user now has the inherited permissions of that role enabled for that resource.
11.5.4. Removing an Administrator or User Role from a Resource
Summary
Remove an administrator or user role from a resource; the user loses the inherited permissions associated with the role for that resource.
Procedure 11.4. Removing a Role from a Resource
- Use the resource tabs, tree mode, or the search function to find and select the resource in the results list.
- Click the tab of the details pane to list the assigned users, the user's role, and the inherited permissions for the selected resource.
- Select the user to remove from the resource.
- Click . The Remove Permission window opens to confirm permissions removal.
- Click to remove the user role.
Result
You have removed the user's role, and the associated permissions, from the resource.
Chapter 12. Red Hat Storage (GlusterFS) Volumes
12.1. Introduction to Red Hat Storage (GlusterFS) Volumes
Red Hat Storage volumes combine storage from more than one Red Hat Storage server into a single global namespace. A volume is a collection of bricks, where each brick is a mountpoint or directory on a Red Hat Storage Server in the trusted storage pool.
Most of the management operations of Red Hat Storage happen on the volume.
You can use the Administration Portal to create and start new volumes. You can monitor volumes in your Red Hat Storage cluster from the Volumes tab.
While volumes can be created and managed from the Administration Portal, bricks must be created on the individual Red Hat Storage nodes before they can be added to volumes using the Administration Portal
12.2. Introduction to Red Hat Storage (GlusterFS) Bricks
Bricks are the basic unit of storage in Red Hat Storage, and they are combined into volumes. Each brick is a directory or mountpoint. XFS is the recommended brick filesystem.
When adding a brick to a volume, the brick is expressed by combining a server address with export directory path in the following format: SERVER:EXPORT
For example: myhostname:/exports/myexportdir/
While volumes can be created using the Administration Portal, bricks must be manually created on Red Hat Storage nodes. Only after the directory structure is in place can bricks be added to volumes.
If your brick consists of a mounted device with an XFS filesystem as opposed to a directory in an XFS filesystem, consider making the mount permanent across reboots by adding it to the
/etc/fstab file.
12.3. Optimizing Red Hat Storage Volumes to Store Virtual Machine Images
Optimize a Red Hat Storage volume to store virtual machine images using the Administration Portal.
To optimize a volume for storing virtual machines, the Manager sets a number of virtualization-specific parameters for the volume.
Important
Red Hat Storage currently supports Red Hat Enterprise Virtualization 3.1 and above. All Gluster clusters and hosts must be attached to data centers which are compatible with versions higher than 3.0.
Volumes can be optimized to store virtual machines during creation by selecting the Optimize for Virt Store check box, or after creation using the button from the tab.
12.4. Red Hat Storage (GlusterFS) Tasks
- 12.4.1. Creating a Storage Volume
- 12.4.2. Adding Bricks to a Volume
- 12.4.3. Explanation of Settings in the Add Bricks Window
- 12.4.4. Starting Volumes
- 12.4.5. Tuning Volumes
- 12.4.6. Editing Volume Options
- 12.4.7. Reset Volume Options
- 12.4.8. Removing Bricks from a Volume
- 12.4.9. Stopping Red Hat Storage Volumes
- 12.4.10. Deleting Red Hat Storage Volumes
- 12.4.11. Rebalancing Volumes
12.4.1. Creating a Storage Volume
Summary
You can create new volumes using the Administration Portal. When creating a new volume, you must specify the bricks that comprise the volume and specify whether the volume is to be distributed, replicated, or striped.
You must create brick directories or mountpoints before you can add them to volumes.
Important
It is recommended that you use replicated volumes, where bricks exported from different hosts are combined into a volume. Replicated volumes create copies of files across multiple bricks in the volume, preventing data loss when a host is fenced.
Procedure 12.1. Creating A Storage Volume
- Click the Volumes resource tab to list existing volumes in the results list.
- Click to open the New Volume window.
- Use the drop-down menus to select the Data Center and Volume Cluster.
- Enter the Name of the volume.
- Use the drop-down menu to select the Type of the volume.
- If active, select the appropriate Transport Type check box.
- Click the button to select bricks to add to the volume. Bricks must be created externally on the Red Hat Storage nodes.
- If active, use the Gluster, NFS, and CIFS check boxes to select the appropriate access protocols used for the volume.
- Enter the volume access control as a comma-separated list of IP addresses or hostnames in the Allow Access From field.You can use the * wildcard to specify ranges of addresses of IP addresses or hostnames.
- Select the Optimize for Virt Store option to set the parameters to optimize your volume for virtual machine storage. Select this if you intend to use this volume as a storage domain.
- Click to create the volume. The new volume is added and displays on the Volume tab.
Result
You've added a Red Hat Storage volume. You can now use it for storage.
12.4.2. Adding Bricks to a Volume
Summary
You can expand your volumes by adding new bricks. You need to add at least one brick to a distributed volume, multiples of two bricks to replicated volumes, multiples of four bricks to striped volumes when expanding your storage space.
Procedure 12.2. Adding Bricks to a Volume
- On the Volumes tab on the navigation pane, select the volume to which you want to add bricks.
- Select the volume you want to add new bricks to. Click the tab from the Details pane.
- Click to open the Add Bricks window.
- Use the Server drop-down menu to select the server on which the brick resides.
- Enter the path of the Brick Directory. The directory must already exist.
- Click . The brick appears in the list of bricks in the volume, with server addresses and brick directory names.
- Click .
Result
The new bricks are added to the volume and the bricks display in the volume's Bricks tab.
12.4.3. Explanation of Settings in the Add Bricks Window
Table 12.1. Add Bricks Tab Properties
|
Field Name
|
Description
|
|---|---|
|
Volume Type
|
Displays the type of volume. This field cannot be changed, it was set when you created the volume.
|
|
Server
|
The server where the bricks are hosted.
|
| Brick Directory |
The brick direcory or mountpoint.
|
12.4.4. Starting Volumes
Summary
After a volume has been created or an existing volume has been stopped, it needs to be started before it can be used.
Procedure 12.3. Starting Volumes
- In the Volumes tab, select the volume to be started.You can select multiple volumes to start by using
ShiftorCtrlkey. - Click the button.
The volume status changes to
Up.
Result
You can now use your volume for virtual machine storage.
12.4.5. Tuning Volumes
Summary
Tuning volumes allows you to affect their performance. To tune volumes, you add options to them.
Procedure 12.4. Tuning Volumes
- Click the Volumes tab.A list of volumes displays.
- Select the volume that you want to tune, and click the tab from the Details pane.The Volume Options tab displays a list of options set for the volume.
- Click to set an option. The Add Option dialog box displays. Select the Option Key from the drop down list and enter the option value.
- Click .The option is set and displays in the Volume Options tab.
Result
You have tuned the options for your storage volume.
12.4.6. Editing Volume Options
Summary
You have tuned your volume by adding options to it. You can change the options for your storage volume.
Procedure 12.5. Editing Volume Options
- Click the Volumes tab.A list of volumes displays.
- Select the volume that you want to edit, and click the Volume Options tab from the Details pane.The Volume Options tab displays a list of options set for the volume.
- Select the option you wish to edit. Click . The Edit Option dialog box displays. Enter a new value for the option.
- Click .The edited option displays in the Volume Options tab.
result
You've changed the options on your volume.
12.4.7. Reset Volume Options
Summary
You can reset options to revert them to their default values.
- Click the Volumes tab.A list of volumes displays.
- Select the volume and click the tab from the Details pane.The Volume Options tab displays a list of options set for the volume.
- Select the option you wish to reset. Click . A dialog box displays, prompting to confirm the reset option.
- Click .The selected option is reset.
Note
You can reset all volume options by clicking button. A dialog box displays, prompting to confirm the reset option. Click . All volume options are reset for the selected volume.
Result
You've reset volume options to default.
12.4.8. Removing Bricks from a Volume
Summary
You can shrink volumes, as needed, while the cluster is online and available. For example, you might need to remove a brick that has become inaccessible in a distributed volume due to hardware or network failure.
Procedure 12.6. Removing Bricks from a Volume
- On the Volumes tab on the navigation pane, select the volume from which you wish to remove bricks.
- Click the tab from the Details pane.
- Select the bricks you wish to remove. Click .
- A window opens, prompting to confirm the deletion. Click OK to confirm.
Result
The bricks are removed from the volume.
12.4.9. Stopping Red Hat Storage Volumes
Summary
After a volume has been started, it can be stopped.
Procedure 12.7. Stopping Volumes
- In the Volumes tab, select the volume to be stopped.You can select multiple volumes to stop by using
ShiftorCtrlkey. - Click .
Result
The volume status changes is Down.
12.4.10. Deleting Red Hat Storage Volumes
Summary
You can delete a volume or multiple volumes from your cluster.
- In the Volumes tab, select the volume to be deleted.
- Click . A dialog box displays, prompting to confirm the deletion. Click .
Result
The volume is removed from the cluster.
12.4.11. Rebalancing Volumes
Summary
If a volume has been expanded or shrunk by adding or removing bricks to or from that volume, the data on the volume must be rebalanced amongst the servers.
Procedure 12.8. Rebalancing a Volume
- Click the Volumes tab.A list of volumes displays.
- Select the volume to rebalance.
- Click Rebalance.
Result
The selected volume is rebalanced.
Chapter 13. External Providers
- 13.1. Introduction to External Providers in Red Hat Enterprise Virtualization
- 13.2. Enabling the Authentication of OpenStack Providers
- 13.3. Adding an External Provider
- 13.4. Removing an External Provider
- 13.5. Explanation of Settings and Controls in the Add Provider Window
- 13.6. Explanation of Settings and Controls in the Edit Provider Window
13.1. Introduction to External Providers in Red Hat Enterprise Virtualization
In addition to resources managed by the Red Hat Enterprise Virtualization Manager itself, Red Hat Enterprise Virtualization can also take advantage of resources managed by external sources. The providers of these resources, known as external providers, can provide resources such as virtualization hosts, virtual machine images, and networks.
Red Hat Enterprise Virtualization currently supports the following external providers:
- Foreman for Host Provisioning
- Foreman is a tool for managing all aspects of the lifecycle of both physical and virtual hosts. In Red Hat Enterprise Virtualization, hosts managed by Foreman can be added to and used by the Red Hat Enterprise Virtualization Manager as virtualization hosts. After you add a Foreman instance to the Manager, the hosts managed by the Foreman instance can be added by searching for available hosts on that Foreman instance when adding a new host.
- OpenStack Image Service (Glance) for Image Management
- OpenStack Image Service provides a catalog of virtual machine images. In Red Hat Enterprise Virtualization, these images can be imported into the Red Hat Enterprise Virtualization Manager and used as floating disks or attached to virtual machines and converted into templates. After you add an OpenStack Image Service to the Manager, it appears as a storage domain that is not attached to any data center. Virtual machine disks in a Red Hat Enterprise Virtualization environment can also be exported to an OpenStack Image Service as virtual machine disk images.
- OpenStack Network Service (Neutron) for Network Provisioning
- OpenStack Network Service provides software-defined networks. In Red Hat Enterprise Virtualization, networks provided by an OpenStack Network Service can be imported into the Red Hat Enterprise Virtualization Manager and used to carry all types of traffic and create complicated network topologies. After you add an OpenStack Network Service to the Manager, you can access the networks provided by that OpenStack Network Service by manually importing them.
13.2. Enabling the Authentication of OpenStack Providers
Summary
Before you can access the resources offered by an OpenStack provider, you must specify the location of a Keystone endpoint for that provider in the Manager to enable authentication of the resources the provider will offer.
Procedure 13.1. Configuring the Location of a Keystone Endpoint
- Log in to the system running Red Hat Enterprise Virtualization Manager as the
rootuser. - Configure the location of the Keystone server, including the port number and API version:
# engine-config --set KeystoneAuthUrl=http://[address to the endpoint]:35357/v2.0
- Configure the Manager to only consider required networks for VM scheduling:
# engine-config --set OnlyRequiredNetworksMandatoryForVdsSelection=true
- Restart the engine service:
# service ovirt-engine restart
Result
You have configured the location of a Keystone endpoint against which the credentials of OpenStack providers can be authenticated.
Note
At current, only one Keystone endpoint can be specified in the Manager. Due to this, only OpenStack providers that are authenticated using the specified Keystone endpoint can be accessed.
13.3. Adding an External Provider
Summary
All external resource providers are added using a single window that adapts to your input. You must add the resource provider before you can use the resource it provides in your Red Hat Enterprise Virtualization environment.
Procedure 13.2. Adding an External Provider
- Select the External Providers entry in the tree pane.
- Click the Add button.
- Select one of supported resource providers from the Type drop-down menu.
- The available fields change based on the selected resource provider. Fill in the details of your resource provider, and click .
Result
You have added a resource provider, and can now consume the resources it provides in your Red Hat Enterprise Virtualization environment.
13.4. Removing an External Provider
Summary
This procedure describes how to remove external providers.
Procedure 13.3. Removing an External Provider
- Select the External Providers entry in the tree pane.
- Select the external provider to remove.
- Click .
- Click in the Remove Provider(s) window to confirm the removal of this provider.
Result
You have removed an external provider.
13.5. Explanation of Settings and Controls in the Add Provider Window
13.5.1. Add Provider General Settings Explained
The General tab in the Add Provider window allows users to register the core details regarding the provider.
Table 13.1. Add Provider: General Settings
|
Setting
|
Explanation
|
|---|---|
|
Name
|
A name to represent the provider in the Manager.
|
|
Description
|
A description of the provider.
|
|
Type
|
The type of the provider. Changing this setting alters the available fields for configuring the provider.
Foreman
OpenStack Image
OpenStack Server
|
|
Test
|
Allows users to test the specified credentials. This button is available to all provider types.
|
Note
When adding a provider that is secured (https), the certificates of that provider are detected. You are then given the option to add those certificates to your trusted certificates.
13.5.2. Add Provider Agent Configuration Settings Explained
The Agent Configuration tab in the Add Provider window allows users to register details regarding networking plugins. This tab is only available for the OpenStack Network provider type, and only after specifying a plugin via the Networking Plugin setting.
Table 13.2. Add Provider: General Settings
|
Setting
|
Explanation
|
|---|---|
|
Interface Mappings
|
A comma-separated list of mappings in the format of label:interface.
|
|
Host
|
The host name of a QPID server with which to connect.
|
|
Port
|
The remote port by which a connection with the above host is to be made.
|
|
Username
|
A user name for connecting to the provider.
|
|
Password
|
The password against which the above user name is to be authenticated.
|
13.6. Explanation of Settings and Controls in the Edit Provider Window
13.6.1. Edit Provider General Settings Explained
The General tab in the Edit Provider window allows users to edit the core details regarding the provider.
Table 13.3. Edit Provider: General Settings
|
Setting
|
Explanation
|
|---|---|
|
Name
|
A name to represent the provider in the Manager.
|
|
Description
|
A description of the provider.
|
|
Type
|
The type of the provider. Changing this setting alters the available fields for configuring the provider.
Foreman
OpenStack Image
OpenStack Network
|
|
Test
|
Allows users to test the specified credentials. This button is available to all provider types.
|
Note
When you edit a provider and change the type of connection from an unsecured connection (http) to a secured connection (https), the certificates of that provider are detected. You are then given the option to add those certificates to your trusted certificates.
13.6.2. Edit Provider Agent Configuration Settings Explained
The Agent Configuration tab in the Edit Provider window allows users to register details regarding networking plugins. This tab is only available for the OpenStack Network provider type, and only after specifying a plugin via the Networking Plugin setting.
Table 13.4. Edit Provider: General Settings
|
Setting
|
Explanation
|
|---|---|
|
Interface Mappings
|
A comma-separated list of mappings in the format of label:interface.
|
|
Host
|
The host name of a QPID server with which to connect.
|
|
Port
|
The remote port by which a connection with the above host is to be made.
|
|
Username
|
A user name for connecting to the provider.
|
|
Password
|
The password against which the above user name is to be authenticated.
|
Part II. Administering the Environment
Table of Contents
- 14. Users and Roles
- 15. Quotas and Service Level Agreement Policy
- 15.1. Introduction to Quota
- 15.2. Shared Quota and Individually-defined Quota
- 15.3. Quota Accounting
- 15.4. Enabling and Changing a Quota Mode in a Data Center
- 15.5. Creating a New Quota Policy
- 15.6. Explanation of Quota Threshold Settings
- 15.7. Assigning a Quota to an Object
- 15.8. Using Quota to Limit Resources by User
- 15.9. Editing Quotas
- 15.10. Removing Quotas
- 15.11. Service-level Agreement Policy Enforcement
- 16. Event Notifications
- 17. Utilities
- 17.1. Renaming the Manager with the Ovirt Engine Rename Tool
- 17.2. Managing Domains with the Domain Management Tool
- 17.3. Editing the Configuration of the Red Hat Virtualization Manager with the Configuration Tool
- 17.4. Uploading Virtual Machine Images with the Image Uploader Tool
- 17.5. Editing USB Filters with the USB Filter Editor
- 17.6. Collecting Logs with the Log Collector Tool
- 17.7. Uploading ISO Files with the ISO Uploader Tool
- 17.8. Guest Drivers and Agents
- 18. Log Files
- 19. Updating the Red Hat Enterprise Virtualization Environment
- 20. Backups
Chapter 14. Users and Roles
14.1. Introduction to Users
Red Hat Enterprise Virtualization uses external directory services for user authentication and information. All user accounts must be created in external directory servers; these users are called directory users. The exception is the
admin user which resides in the internal domain created during installation.
After a directory server is attached to Red Hat Enterprise Virtualization Manager, the users in the directory can be added to the Administration Portal, making them Red Hat Enterprise Virtualization Manager users. Red Hat Enterprise Virtualization Manager users can be assigned different roles and permissions according to the tasks they have to perform.
There are two types of Red Hat Enterprise Virtualization Manager users - end users who use and manage virtual resources from the User Portal, and administrators who maintain the system infrastructure using the Administration Portal.
User roles and admin roles can be assigned to Red Hat Enterprise Virtualization Manager users for individual resources like virtual machines and hosts, or on a hierarchy of objects like clusters and data centers.
14.2. Directory Users
14.2.1. Directory Services Support in Red Hat Enterprise Virtualization
During installation Red Hat Enterprise Virtualization Manager creates its own internal administration user,
admin. This account is intended for use when initially configuring the environment, and for troubleshooting. To add other users to Red Hat Enterprise Virtualization you will need to attach a directory server to the Manager using the Domain Management Tool, engine-manage-domains.
Once at least one directory server has been attached to the Manager you will be able to add users that exist in the directory server and assign roles to them using the Administration Portal. Users will be identified by their User Principal Name (UPN) of the form
user@domain. Attachment of more than one directory server to the Manager is also supported.
The directory servers supported for use with Red Hat Enterprise Virtualization 3.3 are:
- Active Directory
- Identity Management (IdM)
- Red Hat Directory Server 9 (RHDS 9)
- OpenLDAP
You must ensure that the correct DNS records exist for your directory server. In particular you must ensure that the DNS records for the directory server include:
If these records do not exist in DNS then you will be unable to add the domain to the Red Hat Enterprise Virtualization Manager configuration using
- A valid pointer record (PTR) for the directory server's reverse look-up address.
- A valid service record (SRV) for LDAP over TCP port
389. - A valid service record (SRV) for Kerberos over TCP port
88. - A valid service record (SRV) for Kerberos over UDP port
88.
engine-manage-domains.
For more detailed information on installing and configuring a supported directory server, see the vendor's documentation:
- Active Directory - http://technet.microsoft.com/en-us/windowsserver/dd448614.
- Identity Management (IdM) - http://docs.redhat.com/docs/en-US/Red_Hat_Enterprise_Linux/6/html/Identity_Management_Guide/index.html
- Red Hat Directory Server (RHDS) - http://docs.redhat.com/docs/en-US/Red_Hat_Directory_Server/index.html
- OpenLDAP - http://www.openldap.org/doc/
Important
A user must be created in the directory server specifically for use as the Red Hat Enterprise Virtualization administrative user. Do not use the administrative user for the directory server as the Red Hat Enterprise Virtualization administrative user.
Important
It is not possible to install Red Hat Enterprise Virtualization Manager (rhevm) and IdM (ipa-server) on the same system. IdM is incompatible with the mod_ssl package, which is required by Red Hat Enterprise Virtualization Manager.
Important
If you are using Active Directory as your directory server, and you wish to use
sysprep in the creation of Templates and Virtual Machines, then the Red Hat Enterprise Virtualization administrative user must be delegated control over the Domain to:
- Join a computer to the domain
- Modify the membership of a group
For information on creation of user accounts in Active Directory, see http://technet.microsoft.com/en-us/library/cc732336.aspx.
For information on delegation of control in Active Directory, see http://technet.microsoft.com/en-us/library/cc732524.aspx.
Note
Red Hat Enterprise Virtualization Manager uses Kerberos to authenticate with directory servers. RHDS does not provide native support for Kerberos. If you are using RHDS as your directory server then you must ensure that the directory server is made a service within a valid Kerberos domain. To do this you will need to perform these steps while referring to the relevant directory server documentation:
- Configure the
memberOfplug-in for RHDS to allow group membership. In particular ensure that the value of thememberofgroupattrattribute of thememberOfplug-in is set touniqueMember. In OpenLDAP, thememberOffunctionality is not called a "plugin". It is called an "overlay" and requires no configuration after installation.Consult the Red Hat Directory Server 9.0 Plug-in Guide for more information on configuring thememberOfplug-in. - Define the directory server as a service of the form
ldap/hostname@REALMNAMEin the Kerberos realm. Replace hostname with the fully qualified domain name associated with the directory server and REALMNAME with the fully qualified Kerberos realm name. The Kerberos realm name must be specified in capital letters. - Generate a
keytabfile for the directory server in the Kerberos realm. Thekeytabfile contains pairs of Kerberos principals and their associated encrypted keys. These keys will allow the directory server to authenticate itself with the Kerberos realm.Consult the documentation for your Kerberos principle for more information on generating akeytabfile. - Install the
keytabfile on the directory server. Then configure RHDS to recognize thekeytabfile and accept Kerberos authentication using GSSAPI.Consult the Red Hat Directory Server 9.0 Administration Guide for more information on configuring RHDS to use an externalkeytabfile. - Test the configuration on the directory server by using the
kinitcommand to authenticate as a user defined in the Kerberos realm. Once authenticated run theldapsearchcommand against the directory server. Use the-Y GSSAPIparameters to ensure the use of Kerberos for authentication.
14.3. User Authorization
14.3.1. User Authorization Model
Red Hat Enterprise Virtualization applies authorization controls based on the combination of the three components:
- The user performing the action
- The type of action being performed
- The object on which the action is being performed
14.3.2. User Actions
For an action to be successfully performed, the
user must have the appropriate permission for the object being acted upon. Each type of action corresponds to a permission. There are many different permissions in the system, so for simplicity:
Important
Some actions are performed on more than one object. For example, copying a template to another storage domain will impact both the template and the destination storage domain. The user performing an action must have appropriate permissions for all objects the action impacts.
14.3.3. User Permissions
Permissions enable users to perform actions on objects, where objects are either individual objects or container objects.
Any permissions that apply to a container object also apply to all members of that container. The following diagram depicts the hierarchy of objects in the system.
14.4. Red Hat Enterprise Virtualization Manager User Properties and Roles
14.4.1. User Properties
Roles and permissions are the properties of the user. Roles are predefined sets of privileges that permit access to different levels of physical and virtual resources. Multilevel administration provides a finely grained hierarchy of permissions. For example, a data center administrator has permissions to manage all objects in the data center, while a host administrator has system administrator permissions to a single physical host. A user can have permissions to use a single virtual machine but not make any changes to the virtual machine configurations, while another user can be assigned system permissions to a virtual machine.
14.4.2. User and Administrator Roles
Red Hat Enterprise Virtualization provides a range of pre-configured roles, from an administrator with system-wide permissions to an end user with access to a single virtual machine. While you cannot change or remove the default roles, you can clone and customize them, or create new roles according to your requirements. There are two types of roles:
- Administrator Role: Allows access to the Administration Portal for managing physical and virtual resources. An administrator role does not confer any permissions for the User Portal.
- User Role: Allows access to the User Portal for managing and accessing virtual machines and templates. A user role does not confer any permissions for the Administration Portal.
For example, if you have an
administrator role on a cluster, you can manage all virtual machines in the cluster using the Administration Portal. However, you cannot access any of these virtual machines in the User Portal; this requires a user role.
See Also:
14.4.3. User Roles Explained
The table below describes basic user roles which confer permissions to access and configure virtual machines in the User Portal.
Table 14.1. Red Hat Enterprise Virtualization User Roles - Basic
| Role | Privileges | Notes |
|---|---|---|
| UserRole | Can access and use virtual machines and pools. | Can log in to the User Portal, use assigned virtual machines and pools, view virtual machine state and details. |
| PowerUserRole | Can create and manage virtual machines and templates. | Apply this role to a user for the whole environment with 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. |
| UserVmManager | System administrator of a virtual machine. | Can manage virtual machines, create and use snapshots, and migrate virtual machines. A user who creates a virtual machine in the User Portal is automatically assigned the UserVmManager role on the machine. |
Note
In Red Hat Enterprise Virtualization 3.0, the PowerUserRole only granted permissions for virtual machines which are directly assigned to the PowerUser, or virtual machines created by the PowerUser. Now, the VmCreator role provides privileges previously conferred by the PowerUserRole. The PowerUserRole can now be applied on a system-wide level, or on specific data centers or clusters, and grants permissions to all virtual machines and templates within the system or specific resource. Having a PowerUserRole is equivalent to having the VmCreator, DiskCreator, and TemplateCreator roles.
The table below describes advanced user roles which allow you to do more fine tuning of permissions for resources in the User Portal.
Table 14.2. Red Hat Enterprise Virtualization User Roles - Advanced
| Role | Privileges | Notes |
|---|---|---|
| UserTemplateBasedVm | Limited privileges to only use Templates. | Can use templates to create virtual machines. |
| DiskOperator | Virtual disk user. | Can use, view and edit virtual disks. Inherits permissions to use the virtual machine to which the virtual disk is attached. |
| VmCreator | Can create virtual machines in the User Portal. | This role is not applied to a specific virtual machine; apply this role to a user for the whole environment with the Configure window. Alternatively apply this role for specific data centers or clusters. When applying this role to a cluster, you must also apply the DiskCreator role on an entire data center, or on specific storage domains. |
| TemplateCreator | Can create, edit, manage and remove virtual machine templates within assigned resources. | This role is not applied to a specific template; apply this role to a user for the whole environment with the Configure window. Alternatively apply this role for specific data centers, clusters, or storage domains. |
| DiskCreator | Can create, edit, manage and remove virtual machine disks within assigned clusters or data centers. | This role is not applied to a specific virtual disk; apply this role to a user for the whole environment with the Configure window. Alternatively apply this role for specific data centers or storage domains. |
| TemplateOwner | Can edit and delete the template, assign and manage user permissions for the template. | This role is automatically assigned to the user who creates a template. Other users who do not have TemplateOwner permissions on a template cannot view or use the template. |
| NetworkUser | Logical network and network interface user for virtual machine and template. | Can attach or detach network interfaces from specific logical networks. |
14.4.4. Administrator Roles Explained
The table below describes basic administrator roles which confer permissions to access and configure resources in the Administration Portal.
Table 14.3. Red Hat Enterprise Virtualization System Administrator Roles - Basic
| Role | Privileges | Notes |
|---|---|---|
| SuperUser | System Administrator of the Red Hat Enterprise Virtualization environment. | Has full permissions across all objects and levels, can manage all objects across all data centers. |
| ClusterAdmin | Cluster Administrator. | Can use, create, delete, manage all resources in a cluster, including hosts, templates and virtual machines. |
| DataCenterAdmin | Data Center Administrator. | Can use, create, delete, manage all resources in a data center, including clusters, hosts, templates and virtual machines. |
Important
Do not use the administrative user for the directory server as the Red Hat Enterprise Virtualization administrative user. Create a user in the directory server specifically for use as the Red Hat Enterprise Virtualization administrative user.
The table below describes advanced administrator roles which allow you to do more fine tuning of permissions for resources in the Administration Portal.
Table 14.4. Red Hat Enterprise Virtualization System Administrator Roles - Advanced
| Role | Privileges | Notes |
|---|---|---|
| TemplateAdmin | Administrator of a virtual machine template. | Can create, delete, and configure the storage domains and network details of templates, and move templates between domains. |
| StorageAdmin | Storage Administrator. | Can create, delete, configure, and manage an assigned storage domain. |
| HostAdmin | Host Administrator. | Can attach, remove, configure, and manage a specific host. |
| NetworkAdmin | Network Administrator. | Can configure and manage the network of a particular data center or cluster. A network administrator of a data center or cluster inherits network permissions for virtual pools within the cluster. |
| VmPoolAdmin | System Administrator of a virtual pool. | Can create, delete, and configure a virtual pool; assign and remove virtual pool users; and perform basic operations on a virtual machine in the pool. |
| GlusterAdmin | Gluster Storage Administrator. | Can create, delete, configure, and manage Gluster storage volumes. |
14.5. Red Hat Enterprise Virtualization Manager User Tasks
14.5.1. Adding Users
Summary
Users in Red Hat Enterprise Virtualization must be added from an external directory service before they can be assigned roles and permissions.
Procedure 14.1. Adding Users to Red Hat Enterprise Virtualization
- Click the Users tab to display the list of authorized users.
- Click . The Add Users and Groups window opens.
- In the Search drop down menu, select the appropriate domain. Enter a name or part of a name in the search text field, and click . Alternatively, click to view a list of all users and groups.
- Select the check boxes for the appropriate users or groups.
- Click .
Result
The added user displays on the Users tab.
14.5.2. Viewing User Information
Summary
You can view detailed information on each user in the Users tab.
Procedure 14.2. Viewing User Information
- Click the Users tab to display the list of authorized users.
- Select the user, or perform a search if the user is not visible on the results list.
- The details pane displays for the selected user, usually with the General tab displaying general information, such as the domain name, email and status of the user.
- The other tabs allow you to view groups, permissions, quotas, and events for the user.For example, to view the groups to which the user belongs, click the Directory Groups tab.
Result
You have viewed domain, permissions, quota, group and event information for a user.
14.5.3. Viewing User Permissions on Resources
Summary
Users can be assigned permissions on specific resources or a hierarchy of resources. You can view the assigned users and their permissions on each resource.
Procedure 14.3. Viewing User Permissions on Resources
- Use the resource tabs, tree mode, or the search function to find and select the resource in the results list.
- Click the Permissions tab of the details pane to list the assigned users, the user's role, and the inherited permissions for the selected resource.
Result
You have viewed the assigned users and their roles for a selected resource.
14.5.4. Removing Users
Summary
When a user account is no longer required, remove it from Red Hat Enterprise Virtualization.
Procedure 14.4. Removing Users
- Click the Users tab to display the list of authorized users.
- Select the user to be removed. Ensure the user is not running any virtual machines.
- Click the button. A message displays prompting you to confirm the removal. Click .
Result
The user is removed from Red Hat Enterprise Virtualization, but not from the external directory.
14.5.5. Configuring Roles
Roles are predefined sets of privileges that can be configured from Red Hat Enterprise Virtualization Manager. Roles provide access and management permissions to different levels of resources in the data center, and to specific physical and virtual resources.
With multilevel administration, any permissions which apply to a container object also apply to all individual objects within that container. For example, when a host administrator role is assigned to a user on a specific host, the user gains permissions to perform any of the available host operations, but only on the assigned host. However, if the host administrator role is assigned to a user on a data center, the user gains permissions to perform host operations on all hosts within the cluster of the data center.
14.5.6. Creating a New Role
Summary
If the role you require is not on Red Hat Enterprise Virtualization's default list of roles, you can create a new role and customize it to suit your purposes.
Procedure 14.5. Creating a New Role
- On the header bar, click the Configure button to open the Configure window. The window shows a list of default User and Administrator roles, and any custom roles.
- Click New. The New Role dialog box displays.
- Enter the Name and Description of the new role.
- Select either Admin or User as the Account Type.
- Use the or buttons to view more or fewer of the permissions for the listed objects in the Check Boxes to Allow Action list. You can also expand or collapse the options for each object.
- For each of the objects, select or deselect the actions you wish to permit or deny for the role you are setting up.
- Click to apply the changes you have made. The new role displays on the list of roles.
Result
You have created a new role with permissions to specific resources. You can assign the new role to users.
14.5.7. Editing or Copying a Role
Summary
You can change the settings for roles you have created, but you cannot change default roles. To change default roles, clone and modify them to suit your requirements.
Procedure 14.6. Editing or Copying a Role
- On the header bar, click the Configure button to open the Configure window. The window shows a list of default User and Administrator roles, and any custom roles.
- Select the role you wish to change. Click Edit to open the Edit Role window, or click Copy to open the Copy Role window.
- If necessary, edit the Name and Description of the role.
- Use the or buttons to view more or fewer of the permissions for the listed objects. You can also expand or collapse the options for each object.
- For each of the objects, select or deselect the actions you wish to permit or deny for the role you are editing.
- Click to apply the changes you have made.
Result
You have edited the properties of a role, or cloned a role.
14.6. User Role and Authorization Examples
The following examples illustrate how to apply authorization controls for various scenarios, using the different features of the authorization system described in this chapter.
Example 14.1. Cluster Permissions
Sarah is the system administrator for the accounts department of a company. All the virtual resources for her department are organized under a Red Hat Enterprise Virtualization
cluster called Accounts. She is assigned the ClusterAdmin role on the accounts cluster. This enables her to manage all virtual machines in the cluster, since the virtual machines are child objects of the cluster. Managing the virtual machines includes editing, adding, or removing virtual resources such as disks, and taking snapshots. It does not allow her to manage any resources outside this cluster. Because ClusterAdmin is an administrator role, it allows her to use the Administration Portal to manage these resources, but does not give her any access via the User Portal.
Example 14.2. VM PowerUser Permissions
John is a software developer in the accounts department. He uses virtual machines to build and test his software. Sarah has created a virtual desktop called
johndesktop for him. John is assigned the UserVmManager role on the johndesktop virtual machine. This allows him to access this single virtual machine using the User Portal. Because he has UserVmManager permissions, he can modify the virtual machine and add resources to it, such as new virtual disks. Because UserVmManager is a user role, it does not allow him to use the Administration Portal.
Example 14.3. Data Center Power User Role Permissions
Penelope is an office manager. In addition to her own responsibilities, she occasionally helps the HR manager with recruitment tasks, such as scheduling interviews and following up on reference checks. As per corporate policy, Penelope needs to use a particular application for recruitment tasks.
While Penelope has her own machine for office management tasks, she wants to create a separate virtual machine to run the recruitment application. She is assigned
PowerUserRole permissions for the data center in which her new virtual machine will reside. This is because to create a new virtual machine, she needs to make changes to several components within the data center, including creating the virtual machine disk image in the storage domain.
Note that this is not the same as assigning
DataCenterAdmin privileges to Penelope. As a PowerUser for a data center, Penelope can log in to the User Portal and perform virtual machine-specific actions on virtual machines within the data center. She cannot perform data center-level operations such as attaching hosts or storage to a data center.
Example 14.4. Network Administrator Permissions
Chris works as the network administrator in the IT department. Her day-to-day responsibilities include creating, manipulating, and removing networks in the department's Red Hat Enterprise Virtualization environment. For her role, she requires administrative privileges on the resources and on the networks of each resource. For example, if Chris has
NetworkAdmin privileges on the IT department's data center, she can add and remove networks in the data center, and attach and detach networks for all virtual machines belonging to the data center.
In addition to managing the networks of the company's virtualized infrastructure, Chris also has a junior network administrator reporting to her. The junior network administrator, Pat, is managing a smaller virtualized environment for the company's internal training department. Chris has assigned Pat
NetworkUser permissions and UserVmManager permissions for the virtual machines used by the internal training department. With these permissions, Pat can perform simple administrative tasks such as adding network interfaces onto virtual machines in the Power User Portal. However, he does not have permissions to alter the networks for the hosts on which the virtual machines run, or the networks on the data center to which the virtual machines belong.
Example 14.5. Custom Role Permissions
Rachel works in the IT department, and is responsible for managing user accounts in Red Hat Enterprise Virtualization. She needs permission to add user accounts and assign them the appropriate roles and permissions. She does not use any virtual machines herself, and should not have access to administration of hosts, virtual machines, clusters or data centers. There is no built-in role which provides her with this specific set of permissions. A custom role must be created to define the set of permissions appropriate to Rachel's position.
The custom role shown above allows manipulation of users, permissions and roles. These actions are organized under
System - the top level object of the hierarchy shown in Figure 14.6, “UserManager Custom Role”. This means they apply to all other objects in the system. The role is set to have an Account Type of Admin. This means that when she is assigned this role, Rachel can only use the Administration Portal, not the User Portal.
Chapter 15. Quotas and Service Level Agreement Policy
- 15.1. Introduction to Quota
- 15.2. Shared Quota and Individually-defined Quota
- 15.3. Quota Accounting
- 15.4. Enabling and Changing a Quota Mode in a Data Center
- 15.5. Creating a New Quota Policy
- 15.6. Explanation of Quota Threshold Settings
- 15.7. Assigning a Quota to an Object
- 15.8. Using Quota to Limit Resources by User
- 15.9. Editing Quotas
- 15.10. Removing Quotas
- 15.11. Service-level Agreement Policy Enforcement
15.1. Introduction to Quota
Quota is a resource limitation tool provided with Red Hat Enterprise Virtualizaton. Quota may be thought of as a layer of limitations on top of the layer of limitations set by User Permissions.
Quota is a data-center object.
Quota allows administrators of Red Hat Enterprise Virtualization environments to limit user access to memory, CPU, and storage. Quota defines the memory resources and storage resources an administrator can assign users. As a result users may draw on only the resources assigned to them. When the quota resources are exhausted, Red Hat Enterprise Virtualization does not permit further user actions.
There are two different kinds of Quota:
Table 15.1. The Two Different Kinds of Quota
| Quota type | Definition |
|---|---|
| Run-time Quota | This quota limits the consumption of run time resources, like CPU and memory. |
| Storage Quota | This quota limits the amount of storage available. |
Quota, like SELinux, has three modes:
Table 15.2. Quota Modes
| Quota Mode | Function |
|---|---|
| Enforced | This mode puts into effect the Quota that you have set in audit mode, limiting resources to the group or user affected by the quota. |
| Audit | This mode allows you to change Quota settings. Choose this mode to increase or decrease the amount of run-time quota and the amount of storage quota available to users affected by it. |
| Disabled | This mode turns off the run-time and storage limitations defined by the quota. |
When a user attempts to run a virtual machine, the specifications of the virtual machine are compared to the storage allowance and the run-time allowance set in the applicable quota.
If starting a virtual machine causes the aggregated resources of all running virtual machines covered by a quota to exceed the allowance defined in the quota, then the Manager refuses to run the virtual machine.
When a user creates a new disk, the requested disk size is added to the aggregated disk usage of all the other disks covered by the applicable quota. If the new disk takes the total aggregated disk usage above the amount allowed by the quota, disk creation fails.
Quota allows for resource sharing of the same hardware. It supports hard and soft thresholds. Administrators can use a quota to set thresholds on resources. These thresholds appear, from the user's point of view, as 100% usage of that resource. To prevent failures when the customer unexpectedly exceeds this threshold, the interface supports a "grace" amount by which the threshold can be briefly exceeded. Exceeding the threshold results in a warning sent to the customer.
Important
Quota imposes limitations upon the running of virtual machines. Ignoring these limitations is likely to result in a situation in which you cannot use your virtual machines and virtual disks.
When quota is running in enforced mode, virtual machines and disks that do not have quotas assigned cannot be used.
To power on a virtual machine, a quota must be assigned to that virtual machine.
To create a snapshot of a virtual machine, the disk associated with the virtual machine must have a quota assigned.
When creating a template from a virtual machine, you are prompted to select the quota that you want the template to consume. This allows you to set the template (and all future machines created from the template) to consume a different quota than the virtual machine and disk from which the template is generated.
15.2. Shared Quota and Individually-defined Quota
Users with SuperUser permissions can create quotas for individual users or quotas for groups.
Group quotas can be set for Active Directory users. If a group of ten users are given a quota of 1TB of storage and one of the ten users fills the entire terabyte, then the entire group will be in excess of the quota and none of the ten users will be able to use any of the storage associated with their group.
An individual user's quota is set for only the individual. Once the individual user has used up all of his or her storage or run-time quota, the user will be in excess of the quota and the user will no longer be able to use the storage associated with his or her quota.
15.3. Quota Accounting
When a quota is assigned to a consumer or a resource, each action by that consumer or on the resource involving storage, vCPU, or memory results in quota consumption or quota release.
Since the quota acts as an upper bound that limits the user's access to resources, the quota calculations may differ from the actual current use of the user. The quota is calculated for the max growth potential and not the current usage.
Example 15.1. Accounting example
A user runs a virtual machine with 1 vCPU and 1024 MB memory. The action consumes 1 vCPU and 1024 MB of the quota assigned to that user. When the virtual machine is stopped 1 vCPU and 1024 MB of RAM are released back to the quota assigned to that user. Run-time quota consumption is accounted for only during the actual run-time of the consumer.
A user creates a virtual thin provision disk of 10GB. The actual disk usage may indicate only 3GB of that disk are actually in use. The quota consumption, however, would be 10GB, the max growth potential of that disk.
15.4. Enabling and Changing a Quota Mode in a Data Center
Summary
This procedure enables or changes the quota mode in a data center. You must select a quota mode before you can define quotas. You must be logged in to the Web Administration Portal to follow the steps of this procedure.
Use Audit mode to test your quota to make sure it works as you expect it to. You do not need to have your quota in Audit mode to create or change a quota.
Procedure 15.1. Enabling and Changing Quota in a Data Center
- Click the Data Centers tab in the Navigation Pane.
- From the list of data centers displayed in the Navigation Pane, choose the data center whose quota policy you plan to edit.
- Click in the top left of the Navigation Pane.
- An Edit Data Center window opens. In the Quota Mode drop-down, change the quota mode to Enforced.
- Click the OK button.
Result
You have now enabled a quota mode at the Data Center level. If, during the testing of your quota, you've set the mode to Audit, you must use this procedure again to change the quota mode to Enforced in order for your quota settings to take effect.
15.5. Creating a New Quota Policy
Summary
You have enabled quota mode, either in Audit or Enforcing mode. You want to define a quota policy to manage resource usage in your data center.
Procedure 15.2. Creating a New Quota Policy
- In tree mode, select the data center. The Quota tab appears in the Navigation Pane.
- Click the Quota tab in the Navigation Pane.
- Click in the Navigation Pane. The New Quota window opens.
- Fill in the Name field with a meaningful name.Fill in the Description field with a meaningful name.
- In the Memory & CPU section of the New Quota window, use the green slider to set Cluster Threshold.
- In the Memory & CPU section of the New Quota window, use the blue slider to set Cluster Grace.
- Click on the bottom-right of the Memory & CPU field. An Edit Quota window opens.
- Under the Memory field, select either the Unlimited radio button (to allow limitless use of Memory resources in the cluster), or select the limit to radio button to set the amount of memory set by this quota. If you select the limit to radio button, input a memory quota in megabytes (MB) in the MB field.
- Under the CPU field, select either the Unlimited radio button or the limit to radio button to set the amount of CPU set by this quota. If you select the limit to radio button, input a number of vCPUs in the vCpus field.
- Click in the Edit Quota window.
- In the Storage section of the New Quota window, use the green slider to set Storage Threshold.
- In the Storage section of the New Quota window, use the blue slider to set Storage Grace.
- Click in the Storage field. The Edit Quota window opens.
- Under the Storage Quota field, select either the Unlimited radio button (to allow limitless use of Storage) or the limit to radio button to set the amount of storage to which quota will limit users. If you select the limit to radio button, input a storage quota size in gigabytes (GB) in the GB field.
- Click in the Edit Quota window. You are returned to the New Quota window.
- Click in the New Quota window.
Result
You have created a new quota policy.
See Also:
15.6. Explanation of Quota Threshold Settings
Table 15.3. Quota thresholds and grace
| Setting | Definition |
|---|---|
| Cluster Threshold | The amount of cluster resources available per data center. |
| Cluster Grace | The amount of the cluster available for the data center after exhausting the data center's Cluster Threshold. |
| Storage Threshold | The amount of storage resources available per data center. |
| Storage Grace | The amount of storage available for the data center after exhausting the data center's Storage Threshold. |
If a quota is set to 100GB with 20% Grace, then consumers are blocked from using storage after they use 120GB of storage. If the same quota has a Threshold set at 70%, then consumers receive a warning when they exceed 70GB of storage consumption (but they remain able to consume storage until they reach 120GB of storage consumption.) Both "Threshold" and "Grace" are set relative to the quota. "Threshold" may be thought of as the "soft limit", and exceeding it generates a warning. "Grace" may be thought of as the "hard limit", and exceeding it makes it impossible to consume any more storage resources.
15.7. Assigning a Quota to an Object
Prerequisites:
Summary
This procedure explains how to associate a virtual machine with a quota.
Procedure 15.3. Assigning a Quota to a Virtual Machine
- In the navigation pane, select the Virtual Machine to which you plan to add a quota.
- Click . The Edit Virtual Machine window appears.
- Select the quota you want the virtual machine to consume. Use the Quota drop-down to do this.
- Click .
Result
You have designated a quota for the virtual machine you selected.
Summary
This procedure explains how to associate a virtual machine disk with a quota.
Procedure 15.4. Assigning a Quota to a Virtual Disk
- In the navigation pane, select the Virtual Machine whose disk(s) you plan to add a quota.
- In the details pane, select the disk you plan to associate with a quota.
- Click . The Edit Virtual Disk window appears.
- Select the quota you want the virtual disk to consume.
- Click .
Result
You have designated a quota for the virtual disk you selected.
Important
Quota must be selected for all objects associated with a virtual machine, in order for that virtual machine to work. If you fail to select a quota for the objects associated with a virtual machine, the virtual machine will not work. The error that the Manager throws in this situation is generic, which makes it difficult to know if the error was thrown because you did not associate a quota with all of the objects associated with the virtual machine. It is not possible to take snapshots of virtual machines that do not have an assigned quota. It is not possible to create templates of virtual machines whose virtual disks do not have assigned quotas.
15.8. Using Quota to Limit Resources by User
Prerequisites:
Summary
This procedure describes how to use quotas to limit the resources a user has access to.
Procedure 15.5. Assigning a User to a Quota
- In the tree, click the Data Center with the quota you want to associate with a User.
- Click the Quota tab in the navigation pane.
- Select the target quota in the list in the navigation pane.
- Click the tab in the details pane.
- Click at the top of the details pane.
- In the Search field, type the name of the user you want to associate with the quota.
- Click .
- Select the check box at the left side of the row containing the name of the target user.
- Click in the bottom right of the Assign Users and Groups to Quota window.
Result
After a short time, the user will appear in the Consumers tab of the details pane.
15.9. Editing Quotas
Summary
This procedure describes how to change existing quotas.
Procedure 15.6. Editing Quotas
- On the tree pane, click on the data center whose quota you want to edit.
- Click on the Quota tab in the Navigation Pane.
- Click the name of the quota you want to edit.
- Click Edit in the Navigation pane.
- An Edit Quota window opens. If required, enter a meaningful name in the Name field.
- If required, you can enter a meaningful description in the Description field.
- Select either the All Clusters radio button or the Specific Clusters radio button. Move the Cluster Threshold and Cluster Grace sliders to the desired positions on the Memory & CPU slider.
- Select either the All Storage Domains radio button or the Specific Storage Domains radio button. Move the Cluster Threshold and Cluster Grace sliders to the desired positions on the Memory & CPU slider.
- Click in the Edit Quota window to confirm the new quota settings.
Result
You have changed an existing quota.
15.10. Removing Quotas
Summary
This procedure describes how to remove quotas.
Procedure 15.7. Removing Quotas
- On the tree pane, click on the data center whose quota you want to edit.
- Click on the Quota tab in the Navigation Pane.
- Click the name of the quota you want to remove.
- Click at the top of the Navigation pane, under the row of tabs.
- Click in the Remove Quota(s) window to confirm the removal of this quota.
Result
You have removed a quota.
15.11. Service-level Agreement Policy Enforcement
Red Hat Enterprise Virtualization 3.3 supports service-level agreement CPU features. These features can be accessed through the Administrator Portal.
Summary
This procedure describes how to set service-level agreement CPU features.
- Select in the Navigation Pane.
- Select .
- Select the Resource Allocation tab.
- Specify CPU Shares. Possible options are Low, Medium, High, Custom, and Disabled. Virtual machines set to High receive twice as many shares as Medium, and virtual machines set to Medium receive twice as many shares as virtual machines set to Low. Disabled instructs VDSM to use an older algorithm for determining share dispensation; usually the number of shares dispensed under these conditions is 1020.
Result
You have set a service-level agreement CPU policy. Users' CPU consumption is now governed by the policy you have set.
Chapter 16. Event Notifications
16.1. Configuring Event Notifications
Summary
You want to be emailed when an event happens in your Red Hat Enterprise Virtualization environment. You need to set up a mail transfer agent to deliver messages.
Procedure 16.1. Configuring Event Notifications
- Ensure you have set up the MTA agent with the appropriate variables.
- Use the Users resource tab, tree mode, or the search function to find and select the user.
- Click the Event Notifier tab in the details pane to list events for which the user will be notified. This list will be blank if the user does not have event notification configured.
- Click to open the Add Event Notification window.
- Use the button, or the subject-specific expansion buttons, to view the events.
- Select the appropriate check boxes.
- Enter an email address in the Mail Recipient field.
- Click to save changes and close the window.
- Add and start the ovirt-engine-notifier service on the Red Hat Enterprise Virtualization Manager. This activates the changes you have made:
# chkconfig --add ovirt-engine-notifier# chkconfig ovirt-engine-notifier on# service ovirt-engine-notifier restart
Result
You now receive emails based on events in your Red Hat Enterprise Virtualization environment. The selected events display on the Event Notifier tab for the user.
16.2. Parameters for Event Notifications in notifier.conf
The event notifier configuration file can be found in
/usr/share/ovirt-engine/services/ovirt-engine-notifier/ovirt-engine-notifier.conf.
Table 16.1. notifier.conf variables
| Variable name | Default | Remarks |
|---|---|---|
| SENSITIVE_KEYS | none | A comma-separated list of keys that will not be logged. |
| JBOSS_HOME | /usr/share/jbossas | The location of the application server used by the engine. |
| ENGINE_ETC | /etc/ovirt-engine | The location of the etc directory used by the engine. |
| ENGINE_LOG | /var/log/ovirt-engine | The location of the logs directory used by the engine. |
| ENGINE_USR | /usr/share/ovirt-engine | The location of the usr directory used by the engine. |
| NOTIFIER_STOP_TIME | 30 | The time, in seconds, after which the service will time out. |
| NOTIFIER_STOP_INTERVAL | 1 | The time, in seconds, by which the timeout counter will be incremented. |
| INTERVAL_IN_SECONDS | 120 | The interval in seconds between instances of dispatching messages to subscribers. |
| MAIL_SERVER | none | The SMTP mail server address. Required. |
| MAIL_PORT | 25 | The default port of a non-secured SMTP server is 25. The default port of a secured SMTP server (one with SSL enabled) is 465. |
| MAIL_USER | none | If SSL is enabled to authenticate the user, then this variable must be set. This variable is also used to specify the "from" user address when the MAIL_FROM variable is not set. Some mail servers do not support this functionality. The address is in RFC822 format. |
| MAIL_PASSWORD | none | This variable is required to authenticate the user if the mail server requires authentication or if SSL is enabled. |
| MAIL_ENABLE_SSL | false | This indicates whether SSL should be used to communicate with the mail server. |
| HTML_MESSAGE_FORMAT | false | The mail server sends messages in HTML format if this variable is set to "true". |
| MAIL_FROM | none | This variable specifies a "from" address in RFC822 format, if supported by the mail server. |
| MAIL_REPLY_TO | none | This variable specifies "reply-to" addresses in RFC822 format on sent mail, if supported by the mail server. |
| DAYS_TO_KEEP_HISTORY | none | This variable sets the number of days dispatched events will be preserved in the history table. If this variable is not set, events remain on the history table indefinitely. |
| DAYS_TO_SEND_ON_STARTUP | 0 | The number of days of old events that will be processed and sent when the notifier starts. |
16.3. Canceling Event Notifications
Summary
A user has configured some unnecessary event notifications and wants them canceled.
Procedure 16.2. Canceling Event Notifications
- In the Users tab, select the user or the user group.
- Select the Event Notifier tab in the details pane to list events for which the user receives notifications.
- Click to open the Add Event Notification window.
- Use the button, or the subject-specific expansion buttons, to view the events.
- Clear the appropriate check boxes to remove notification for that event.
- Click to save changes and close the window.
Result
You have canceled unnecessary event notifications for the user.
Chapter 17. Utilities
- 17.1. Renaming the Manager with the Ovirt Engine Rename Tool
- 17.2. Managing Domains with the Domain Management Tool
- 17.3. Editing the Configuration of the Red Hat Virtualization Manager with the Configuration Tool
- 17.4. Uploading Virtual Machine Images with the Image Uploader Tool
- 17.5. Editing USB Filters with the USB Filter Editor
- 17.6. Collecting Logs with the Log Collector Tool
- 17.7. Uploading ISO Files with the ISO Uploader Tool
- 17.8. Guest Drivers and Agents
17.1. Renaming the Manager with the Ovirt Engine Rename Tool
17.1.1. What is the Ovirt Engine Rename Tool?
When the
engine-setup command is run in a clean environment, the command generates a number of certificates and keys that use the fully qualified domain name of the Manager supplied during the setup process. If the fully qualified domain name of the Manager must be changed later on (for example, due to migration of the machine hosting the Manager to a different domain), the records of the fully qualified domain name must be updated to reflect the new name. The ovirt-engine-rename command automates this task.
The
ovirt-engine-rename command updates records of the fully qualified domain name of the Manager in the following locations:
- /etc/ovirt-engine/engine.conf.d/10-setup-protocols.conf
- /etc/ovirt-engine/imageuploader.conf.d/10-engine-setup.conf
- /etc/ovirt-engine/isouploader.conf.d/10-engine-setup.conf
- /etc/ovirt-engine/logcollector.conf.d/10-engine-setup.conf
- /etc/pki/ovirt-engine/cert.conf
- /etc/pki/ovirt-engine/cert.template
- /etc/pki/ovirt-engine/certs/apache.cer
- /etc/pki/ovirt-engine/keys/apache.key.nopass
- /etc/pki/ovirt-engine/keys/apache.p12
Warning
While the
ovirt-engine-rename command creates a new certificate for the web server on which the Manager runs, it does not affect the certificate for the engine or the certificate authority. Due to this, there is some risk involved in using the ovirt-engine-rename command, particularly in environments that have been upgraded from Red Hat Enterprise Virtualization version 3.2 and earlier. Therefore, changing the fully qualified domain name of the Manager by running engine-cleanup and engine-setup is recommended where possible.
17.1.2. Syntax for the Ovirt Engine Rename Command
The basic syntax for the
ovirt-engine-rename command is:
# /usr/share/ovirt-engine/setup/bin/ovirt-engine-rename
The command also accepts the following options:
--newname=[new name]- Allows you to specify the new fully qualified domain name for the Manager without user interaction.
--log=[file]- Allows you to specify the path and name of a file into which logs of the rename operation are to be written.
--config=[file]- Allows you to specify the path and file name of a configuration file to load into the rename operation.
--config-append=[file]- Allows you to specify the path and file name of a configuration file to append to the rename operation. This option can be used to specify the path and file name of an answer file.
--generate-answer=[file]- Allows you to specify the path and file name of a file into which your answers to and the values changed by the
ovirt-engine-renamecommand are recorded.
17.1.3. Using the Ovirt Engine Rename Tool
Summary
You can use the ovirt-engine-rename command to update records of the fully qualified domain name of the Manager.
Procedure 17.1. Renaming the Red Hat Enterprise Virtualization Manager
- Prepare all DNS and other relevant records for the new fully qualified domain name.
- Update the DHCP server configuration if DHCP is used.
- Update the host name on the Manager.
- Run the following command:
# /usr/share/ovirt-engine/setup/bin/ovirt-engine-rename
- When prompted, press Enter to stop the engine service:
During execution engine service will be stopped (OK, Cancel) [OK]:
- When prompted, enter the new fully qualified domain name for the Manager:
New fully qualified server name:[new name]
Result
The ovirt-engine-rename command updates records of the fully qualified domain name of the Manager.
17.2. Managing Domains with the Domain Management Tool
- 17.2.1. What is the Domain Management Tool?
- 17.2.2. Syntax for the Domain Management Tool
- 17.2.3. Using the Domain Management Tool
- 17.2.4. Adding Domains to Configuration
- 17.2.5. Editing a Domain in the Configuration
- 17.2.6. Deleting a Domain from the Configuration
- 17.2.7. Validating Domain Configuration
- 17.2.8. Listing Domains in Configuration
- 17.2.9. Getting a Configuration Value
- 17.2.10. Setting a Configuration Value
17.2.1. What is the Domain Management Tool?
Red Hat Enterprise Virtualization Manager authenticates users using directory services. To add users to Red Hat Enterprise Virtualization Manager you must first use the internal
admin user to add the directory service that the users must be authenticated against. You add and remove directory services domains using the included domain management tool, engine-manage-domains.
The
engine-manage-domains command is only accessible on the machine on which Red Hat Enterprise Virtualization Manager is installed. The engine-manage-domains command must be run as the root user.
17.2.2. Syntax for the Domain Management Tool
The usage syntax is:
engine-manage-domains -action=ACTION [options]
Available actions are:
add- Add a domain to Red Hat Enterprise Virtualization Manager's directory services configuration.
edit- Edit a domain in Red Hat Enterprise Virtualization Manager's directory services configuration.
delete- Delete a domain from Red Hat Enterprise Virtualization Manager's directory services configuration.
validate- Validate Red Hat Enterprise Virtualization Manager's directory services configuration. This command attempts to authenticate each domain in the configuration using the configured user name and password.
list- List Red Hat Enterprise Virtualization Manager's current directory services configuration.
These options can be combined with the actions on the command line:
-domain=DOMAIN- Specifies the domain on which the action will be performed. The
-domainparameter is mandatory foradd,edit, anddelete. -provider=PROVIDER- Specifies the LDAP provider type of the directory server for the domain. Valid values are:
ActiveDirectory- Active Directory.IPA- Identity Management (IdM).RHDS- Red Hat Directory Server. Red Hat Directory Server does not come with Kerberos. Red Hat Enterprise Virtualization requires Kerberos authentication. RHDS must be made a service within a Kerberos domain to provide directory services to the Manager.Note
If you want to use RHDS as your directory server, you must have thememberofplugin installed in RHDS. To use thememberofplugin, your users must beinetusers. For more information about using thememberofplugin, see the Red Hat Directory Server Plug-in Guide.
-user=USER- Specifies the domain user to use. The
-userparameter is mandatory foradd, and optional foredit. -passwordFile=FILE- Specifies that the domain user's password is on the first line of the provided file. This option, or the
-interactiveoption, must be used to provide the password for use with theaddaction. -addPermissions- Specifies that the domain user will be given the SuperUser role in Red Hat Enterprise Virtualization Manager. By default, if the
-addPermissionsparameter is not specified, the SuperUser role is not assigned to the domain user. The-addPermissionsoption is optional. It is only valid when used in combination with theaddandeditactions. -interactive- Specifies that the domain user's password is to be provided interactively. This option, or the
-passwordFileoption, must be used to provide the password for use with theaddaction. -configFile=FILE- Specifies an alternate configuration file that the command must load. The
-configFileparameter is always optional. -report- In conjunction with the
validateaction results in the output of a report of all encountered validation errors.
For full usage information consult the
engine-manage-domains command's help output:
# engine-manage-domains --help
17.2.3. Using the Domain Management Tool
The following examples demonstrate the use of the
engine-manage-domains command to perform basic manipulation of the Red Hat Enterprise Virtualization Manager domain configuration.
17.2.4. Adding Domains to Configuration
In this example, the
engine-manage-domains command is used to add the IdM domain directory.demo.redhat.com to the Red Hat Enterprise Virtualization Manager configuration. The configuration is set to use the admin user when querying the domain; the password is provided interactively.
Example 17.1. engine-manage-domains Add Action
# engine-manage-domains -action=add -domain=directory.demo.redhat.com -provider=IPA -user=admin -interactive loaded template kr5.conf file setting default_tkt_enctypes setting realms setting domain realm success User guid is: 80b71bae-98a1-11e0-8f20-525400866c73 Successfully added domain directory.demo.redhat.com. oVirt Engine restart is required in order for the changes to take place (service ovirt-engine restart).
17.2.5. Editing a Domain in the Configuration
In this example, the
engine-manage-domains command is used to edit the directory.demo.redhat.com domain in the Red Hat Enterprise Virtualization Manager configuration. The configuration is updated to use the admin user when querying this domain; the password is provided interactively.
Example 17.2. engine-manage-domains Edit Action
# engine-manage-domains -action=edit -domain=directory.demo.redhat.com -user=admin -interactive loaded template kr5.conf file setting default_tkt_enctypes setting realms setting domain realmo success User guide is: 80b71bae-98a1-11e0-8f20-525400866c73 Successfully edited domain directory.demo.redhat.com. oVirt Engine restart is required in order for the changes to take place (service ovirt-engine restart).
17.2.6. Deleting a Domain from the Configuration
In this example, the
engine-manage-domains command is used to remove the directory.demo.redhat.com domain from the Red Hat Enterprise Virtualization Manager configuration. Users defined in the removed domain will no longer be able to authenticate with the Red Hat Enterprise Virtualization Manager. The entries for the affected users will remain defined in the Red Hat Enterprise Virtualization Manager until they are explicitly removed.
The domain being removed in this example is the last one listed in the Red Hat Enterprise Virtualization Manager configuration. A warning is displayed highlighting this fact and that only the
admin user from the internal domain will be able to log in until another domain is added.
Example 17.3. engine-manage-domains Delete Action
# engine-manage-domains -action=delete -domain='directory.demo.redhat.com' WARNING: Domain directory.demo.redhat.com is the last domain in the configuration. After deleting it you will have to either add another domain, or to use the internal admin user in order to login. Successfully deleted domain directory.demo.redhat.com. Please remove all users and groups of this domain using the Administration portal or the API.
17.2.7. Validating Domain Configuration
In this example, the
engine-manage-domains command is used to validate the Red Hat Enterprise Virtualization Manager configuration. The command attempts to log into each listed domain with the credentials provided in the configuration. The domain is reported as valid if the attempt is successful.
Example 17.4. engine-manage-domains Validate Action
# engine-manage-domains -action=validate User guide is: 80b71bae-98a1-11e0-8f20-525400866c73 Domain directory.demo.redhat.com is valid.
17.2.8. Listing Domains in Configuration
The
engine-manage-domains command lists the directory services domains defined in the Red Hat Enterprise Virtualization Manager configuration. This command prints the domain, the user name in User Principal Name (UPN) format, and whether the domain is local or remote for each configuration entry.
Example 17.5. engine-manage-domains List Action
# engine-manage-domains -action=list
Domain: directory.demo.redhat.com
User name: admin@DIRECTORY.DEMO.REDHAT.COM
This domain is a remote domain.17.2.9. Getting a Configuration Value
Example 17.6. Retrieving the Value of the SearchResultsLimit Key
# engine-config --get=SearchResultsLimit --cver=general 100
17.3. Editing the Configuration of the Red Hat Virtualization Manager with the Configuration Tool
17.3.1. Configuration Tool
Installing the Red Hat Enterprise Virtualization Manager modifies only a subset of configuration settings from their defaults. Further modifications are made using the configuration tool:
engine-config.
The configuration tool does not require Red Hat JBoss Enterprise Application Platform or the Red Hat Enterprise Virtualization Manager to be running to update the configuration. Configuration key values are stored in the database; configuration changes will not be saved unless the database is operational. Changes are applied when Red Hat JBoss Enterprise Application Platform is restarted.
The Red Hat Enterprise Virtualization Manager stores configuration settings as a series of key-to-value pair mappings. The configuration tool allows you to:
- list all available configuration keys,
- list all available configuration values,
- retrieve the value of a specific configuration key, and
- set the value of a specific configuration key.
You are also able to maintain multiple versions of the Manager's configuration with the configuration tool. Use the
--cver parameter to specify the configuration version to be used when retrieving or setting a value for a configuration key. The default configuration version is general.
17.3.2. Syntax for engine-config Command
The configuration tool is accessible on the client machine on which the Red Hat Enterprise Virtualization Manager is installed. For full usage information consult the help output of the
engine-config command:
# engine-config --helpCommon tasks
- List available configuration keys
- Use the
--listparameter to list available configuration keys.#
engine-config--listEach available configuration key is listed by name and description. - List available configuration values
- Use the
--allparameter to list available configuration values.#
engine-config--allEach available configuration key is listed by name, current value of the key, and the configuration version. - Retrieve value of configuration key
- Use the
--getparameter to retrieve the value of a specific key.#
engine-config--get KEY_NAMEReplace KEY_NAME with the name of the specific key to retrieve the key name, value, and the configuration version. Use the--cverparameter to specify the configuration version of the value to be retrieved. - Set value of configuration key
- Use the
--setparameter to set the value of a specific key. You must also set the configuration version to which the change is to apply using the--cverparameter.#
engine-config--set KEY_NAME=KEY_VALUE--cver=VERSIONReplace KEY_NAME with the name of the specific key to set; replace KEY_VALUE with the value to be set. Environments with more than one configuration version require the VERSION to be specified.
17.3.3. The admin@internal User
The
admin@internal user account is automatically created upon installation of the Red Hat Enterprise Virtualization Manager. This account is stored locally in the Red Hat Enterprise Virtualization Manager's PostgreSQL database, separate from external directory services such as IdM or Active Directory. Unlike external directory domains, users cannot be added or deleted from the internal domain. The admin@internal user is the SuperUser of the Red Hat Enterprise Virtualization Manager and has administrative privileges over the environment via the Administration Portal.
The password for the
admin@internal user is set during the installation of the Red Hat Enterprise Virtualization Manager. Use the engine-config utility if you need to reset the password.
17.3.4. Changing the Password for admin@internal
- Log in to the Red Hat Enterprise Virtualization Manager server as the
rootuser. - Use the
engine-configutility to set a new password for theadmin@internaluser.# engine-config -s AdminPassword=interactive
Use escape characters if your password includes any special characters. - Restart the ovirt-engine service for the changes to take effect.
# service ovirt-engine restart
17.3.5. Configuration Tool Examples
Example 17.8. Getting a Configuration Value
# engine-config --get=SearchResultsLimit --cver=general 100
Example 17.9. Setting a Configuration Value
# engine-config --set SearchResultsLimit=50 --cver=general
17.3.6. Red Hat Enterprise Virtualization Manager Configuration Options Explanations, Limitations, and Best Practices
Table 17.1. Red Hat Enterprise Virtualization Manager Configuration Options, Explanations, Limitations, and Best Practices
| Option Name | Description | Possible values | Recommended (default) values | Comments |
|---|---|---|---|---|
| AsyncTaskPollingRate | Async Task Polling Rate (in seconds) | Integer | 10 | How often (in seconds) RHEV-M queries the status of an async task currently running. |
| AsyncTaskZombieTaskLifeInMinutes | Zombie tasks lifetime in minutes | Integer | 3000 | How long (in minutes) a task is allowed to run before assuming it has become a zombie and should be killed. The value affects large storage manipulations especially. When using slow storage and large virtual images, or when a task is known to take longer than 3000 minutes (50 hours), the value should be increased. |
| AttestationPort | Definition of service port for attestation service | Integer | 8443 | Which port is your attestation server listening for connections on? |
| AttestationServer | Definition of FQDN of attestation server | String | Default is 'oat-server' | Fully qualified domain name or IP address of your attestation server. |
| AttestationTruststore | Trust store used for securing communication with attestation service | String | TrustStore.jks | Copy the TrustStore.jks keystore file from /var/lib/oat-appraiser/Certificate/ on your attestation server to /usr/share on your engine server. |
| AttestationTruststorePass | The password used to access trust store | String | password | The default password is password. |
| AttestationFirstStageSize | Attestation size for first stage | Integer | 10 | Used for quick initialization. Do not change unless you know why. |
| AuditLogAgingThreshold | Audit Log Aging Threshold (in days) | Integer | 30 | How long an audit log is kept before being rotated. |
| AuditLogCleanupTime | Time to check for Audit Log cleanup | Time | 03:35:35 | At what time the Audit Log is checked for Aging and cleaned up. |
| AuthenticationMethod | Authentication Method used by RHEV-M | String | LDAP | The API used for querying users. Currently LDAP is the only supported value. |
| BlockMigrationOnSwapUsagePercentage | Host swap percentage threshold (for scheduling) | Integer | 0 | The maximum percentage of swap space on the host that a VM run or migration is allowed to consume on the host. If the host is swapping beyond this percentage, a VM will not migrate over and will not be started. |
| BootstrapMinimalVdsmVersion | Minimum VDSM version | String | 4.9 | The minimum version of VDSM that is acceptable when adding hosts to the Engine. Newer versions have more features. |
| CABaseDirectory | CA Base Directory | String | /etc/pki/ovirt-engine | Where the RHEV-M Certificate Authority is located on the RHEV-M host. |
| CertificateFileName | Certificate File Name | String | /etc/pki/ovirt-engine/certs/engine.cer | Points to the certificate file used by RHEV-M for SSL/TLS communication with VDSM. |
| CpuOverCommitDurationMinutes | The duration in minutes of CPU consumption to activate selection algorithm | Integer | 2 | When the cluster policy is set to Even Distribution, wait for this amount of minutes after detecting CPU overcommit before triggering virtual machine migrations to rebalance the host load. This configuration value applies only for the default. |
| DisableFenceAtStartupInSec | Disable Fence Operations At RHEV-M Startup in Seconds | Integer | 300 | Allow this amount of seconds after RHEV-M starts to detect hosts, before assuming the hosts are unresponsive and proceed to fence hosts. This value should be increased when RHEV-M is on a machine that has slow network startup (a VMWare guest, for example). |
| EmulatedMachine | Supported machine types | String | RHEL 6.2.0: v3.0 RHEL 6.3.0: v3.1 RHEL 6.4.0: v3.2 | |
| WANDisableEffects | Disabled WAN Effects value to send to the SPICE console | StringMultiple | animation | The list of effects which will be disabled for SPICE. Possible values: animation, wallpaper, font-smooth, and all. |
| WANColorDepth | WAN Color Depth value to send to the SPICE console | Integer | 16 | The color depth used by the SPICE. Possible values are 16 and 32. |
| EnableSpiceRootCertificateValidation | Enable Spice Root Certification Validation | String | true | If 'true', the certificate of the host on which the virtual machine is running and the RHEV-M setup CA certificate are sent to the SPICE client when attempting to connect to the virtual machine with SPICE, as an extra security mechanism. |
| EnableUSBAsDefault | Enable USB devices attachment to the virtual machine by default | String | true | - |
| EnableVdsLoadBalancing | Enables Host Load Balancing system | String | true | This config value allows the user to turn on or off (true and false, respectively) the virtual machine load balancing according to the policy configured for the cluster. |
| FreeSpaceCriticalLowInGB | Critical low disk space alert threshold (in GB) | Integer | 5 | Produces an alert when a Storage Domain has this amount of space left. This setting is also used in various preliminary tests for action sanity when users try to use storage domains, to prevent reaching this critical amount. Adding and importing disks will fail if the amount of space is less than the value specified here. |
| FreeSpaceLow | Limit of percentage of free disk space below which it is considered low | Integer | 10 | When a storage domain has this percentage of space left, it is considered low on disk space. |
| HighUtilizationForEvenlyDistribute | High Utilization Limit For Evenly Distribute selection algorithm | Integer | 75 | Maximum number of virtual machines per host in the Evenly Distribute algorithm. |
| HighUtilizationForPowerSave | High Utilization Limit For Power Save selection algorithm | Integer | 75 | A default for newly created clusters, in use with PowerSave load balancing algorithm, marks the higher limit of host utilization for populating hosts. |
| LDAPQueryTimeout | Read Timeout in seconds for LDAP queries | Integer | 30 | The amount of time an LDAP query will read before the query is stopped. |
| LDAPOperationTimeout | Search timeout at LDAP server side | Integer | 30 | The amount of time an LDAP search will operate before it is stopped. |
| LDAPConnectTimeout | Connect timeout in seconds for LDAP queries | Integer | 30 | The amount of time an LDAP query will connect before it is stopped. |
| LocalAdminPassword | Local Administrator Password | Password | Populated during initial setup | The password for admin@local default user. |
| LogPhysicalMemoryThresholdInMB | Threshold for logging low host memory in MB | Integer | 1024 | The minimum amount of RAM left before a host is considered low on memory. If a host's RAM is lower than this setting, it is recorded on the audit log and no action is taken. |
| LowUtilizationForEvenlyDistribute | Low Utilization Limit for Evenly Distribute selection algorithm | Integer | 0 | Minimum number of virtual machines per host in the Evenly Distribute algorithm. |
| LowUtilizationForPowerSave | Low Utilization Limit for Power Save selection algorithm | Integer | 20 | A default for newly created clusters, in use with PowerSave load balancing algorithm, marks the lower limit of host utilization for populating hosts. |
| MacPoolRanges | MAC Addresses Pool Ranges | String | 00:1A:4A:23:18:00-00:1A:4A:23:18:FF | The MAC address pool range to be automatically assigned to virtual machines. |
| MaxDiskSize | Max size of newly created disk (in GB) | Integer | 16384 | The maximum size (in GB) for a new virtual disk image assigned to virtual machines. |
| MaxMacsCountInPool | Maximum MAC Addresses count in Pool | Integer | 100000 | Maximum number of MAC addresses allowed in the MAC pool. |
| MaxNumberofHostsInStoragePool | Maximum number of hosts in Storage Pool | Integer | 250 | Limits the maximum number of hosts assigned to the clusters of a single Data Center. This can be increased after testing more hosts, if necessary. |
| MaxNumOfCpuPerSocket | Maximum Number of CPU per socket | Integer | 16 | Maximum number of virtual CPU cores that can be assigned to a single virtual CPU socket. |
| MaxNumOfVMCpus | Total Numbers of Virtual Machine CPUs | Integer | 160 | Maximum total amount of CPU cores assigned to a virtual machine (determined by number of cores multiplied by number of sockets). |
| MaxNumofVmSockets | Maximum number of sockets per virtual machine | Integer | 16 | Maximum number of virtual CPU sockets assigned to a virtual machine. |
| MaxRerunVmOnVdsCount | Maximum virtual machine rerun attempts on a host | Integer | 3 | Maximum number of attempts to start a virtual machine on a host before an error ("unable to start VM") is reported. |
| MaxStorageVdsDelayCheckSec | Max delay for check of domain in seconds | Integer | 5 | Maximum amount of seconds to wait for storage domain status to be returned before reporting an error. |
| MaxStorageVdsTimeoutCheckSec | Maximum timeout for last check of domain in seconds | Integer | 30 | When monitoring storage, vdsmd on the hosts reports a "lastCheck" value for each domain. This setting is used to decide whether the last check happened too long ago and domain is considered in error. |
| MaxVDSMemOverCommit | Max Host Memory Over-Commit (%) for virtual desktops load | Integer | 200 | The percentage of memory overcommit permitted to occur when using virtual desktop loads. |
| MaxVdsMemOverCommitForServers | Maximum Host Memory Over-Commit (%) for Virtual Servers load | Integer | 150 | The percentage of memory overcommit permitted to occur when using virtual server loads. |
| MaxVdsNameLength | Max VDS name length | Integer | 255 | Maximum name length for a Hypervisor host. |
| MaxVmNameLengthNonWindows | Maximum virtual machine name length for non-Windows operating system | Integer | 64 | Maximum name length for a non-Windows virtual machine. |
| MaxVmNameLengthWindows | Maximum name length in Windows | Integer | 15 | Maximum name length for Windows virtual machine (limitation imposed by Windows hostnames). |
| MaxVmsInPool | Max virtual machines in pool | Integer | 1000 | Maximum number of virtual machines in a single data center. |
| VmPoolMaxSubsequentFailures | Maximum number of subsequent VM creation failures before giving up | Integer | 3 | The maximum number of subsequent failed virtual machine creations that can occur in a virtual machine pool before the operation is stopped. |
| NumberofFailedRunsOnVds | Number of Failed Runs on Host | Integer | 3 | Number of attempts to run virtual machines on hosts before setting host status to "Error". |
| NumberOfVmsForTopSizeVms | Number of virtual machines with highest disk size to display | Integer | 10 | Number of virtual machines to display in the storage domain's virtual machine tab. Will display this amount of virtual machines, sorted by the most storage space per used virtual machine. |
| NumberVmRefreshesBeforeSave | Number of Virtual Machine Data Refreshes Before Saving to Database | Integer | 5 | The number of host monitor iterations between refreshing virtual machines from VDSM (determines if virtual machines should be refreshed one upon each iteration) |
| oVirtISOsRepositoryPath | The RHEV-H installation files path | String | /usr/share/rhev-hypervisor | The location of RHEV-H ISO images used for upgrading Hypervisor hosts. |
| PollUri | The URI used for accessing the attestation service | String | AttestationService/resources/PollHosts | |
| ProductKey2003 | Product Key (for Windows 2003) | String | - | Windows serial key to be used with sysprepped virtual machines created from a template. |
| ProductKey2003x64 | Product Key (for Windows 2003 x64) | String | - | Windows serial key to be used with sysprepped virtual machines created from a template. |
| ProductKey2008 | Product Key (for Windows 2008) | String | - | Windows serial key to be used with sysprepped virtual machines created from a template. |
| ProductKey2008R2 | Product Key (for Windows 2008 R2) | String | - | Windows serial key to be used with sysprepped virtual machines created from a template. |
| ProductKey2008x64 | Product Key (for Windows 2008 x64) | String | - | Windows serial key to be used with sysprepped virtual machines created from a template. |
| ProductKey | Product Key (for Windows XP) | String | - | Windows serial key to be used with sysprepped virtual machines created from a template. |
| ProductKeyWindow7 | Product Key (for Windows 7) | String | - | Windows serial key to be used with sysprepped virtual machines created from a template. |
| ProductKeyWindow7x64 | Product Key (for Windows 7 x64) | String | - | Windows serial key to be used with sysprepped virtual machines created from a template. |
| ProductRPMVersion | Red Hat Enterprise Virtualization Manger RPM Version | String | Automatically populated | The PRM version of the currently used rhevm package. |
| RDPLoginWithFQN | Connect to RDP console with Fully Qualified User-Name (user@domain) | String | true | - |
| SANWipeAfterDelete | Initializing disk image is more secure but it can be time consuming and I/O intensive depending on the size of the image | String | false | Represents the default value (checked/unchecked) of the "wipe after delete" check box in the "New Virtual Disk" dialog if the newly-created Disk belongs to a SAN (FC/iSCSI) Data Center (i.e. about to be created on a SAN storage domain). |
| SearchResultsLimit | Max Quantity of Search Results | Integer | 100 | The number of results to return for search queries if no specific figure is given in the web administration portal or REST. |
| SecureConnectionWithOATServers | Determine whether use secure communication or not to access attestation service | Boolean | true | |
| ServerRebootTimeout | Host Reboot Timeout (in seconds) | Integer | 300 | Wait this amount of seconds when a host is rebooted or fenced, before determining that the host is Non Responsive. Can be increased for hosts that take longer to reboot. |
| SpiceProxyDefault | The address of the SPICE Proxy. | String | none | When this key is set to a value, the SPICE proxy is activated (turned on). When this key is not set to a value, the SPICE proxy is not activated (turned off). |
| SpiceReleaseCursorKeys | Keyboard keys combination that causes the mouse cursor to be released from its grab on SPICE | String | Shift+F12 | - |
| SpiceSecureChannels | SPICE Secure Channels | String | smain, sinputs, scursor, splayback, srecord, sdisplay, susbredir, ssmartcard | Which SPICE channels should be secured with SSL. |
| SpiceToggleFullScreenKeys | Keyboard keys combination that toggles the full-screen state of SPICE client window | String | Shift+F11 | - |
| SpiceUsbAutoShare | Enable USB devices sharing by default in SPICE | String | true | Represents the default value (checked/unchecked) of the "Enable USB Auto-Share" check box in the SPICE Console Options dialog in the User Portal. |
| SpmCommandFailOverRetries | Number of retries to failover the Storage Pool Manager on failed commands | Integer | 3 | Number of SPM selection failover retries. In case an SPM command fails, backend performs a failover - it selects a new SPM and re-runs the command. |
| SPMFailOverAttempts | Number of attempts to connect to the Storage Pool Manager before Failover | Integer | 3 | When monitoring a Storage Pool, if the current SPM fails, failover does not happen immediately (see description of SpmCommandFailOverRetries). This setting defines the number of retries before deciding that the current SPM is down and a failover is required. |
| SpmVCpuConsumption | The CPU consumption of SPM embodied as number of VCPUs on the Host | Integer | 1 | When a host is the SPM, it is considered to be using this amount of extra virtual CPUs, to make up for the overhead that SPM operations generate. |
| SSHInactivityTimeoutSeconds | SSH Inactivity Timeout (in seconds) | Integer | 600 | The maximum amount of time backend allows for an SSH session to remote hosts. After this timeout the session is killed. |
| SSHInactivityHardTimoutSeconds | SSH Inactivity Hard Timeout (in seconds) | Integer | - | |
| NumberOfUSBSlots | Number of USB slots in VMs with native USB support | Integer | 4 | - |
| SSLEnabled | SPICE SSL Enabled | String | true | Whether SPICE Secure channels should be SSL encrypted. |
| StorageDomainFailureTimeoutInMinutes | Storage Domain failure timeout | Integer | 5 | Defines the amount of time taken before deciding domain is problematic, starting at the first failure reported by VDSM (in minutes). |
| StoragePoolRefreshTimeInSeconds | Storage Pool Manager Polling Rate (in seconds) | Integer | 10 | Storage Pool monitoring frequency. |
| SysPrep2K3Path | Path to a Windows 2003 machine sysprep file | string | /etc/ovirt-engine/sysprep/sysprep.2k3 | Path to the operating system specific sysprep file template. |
| SysPrep2K8Path | Path to a Windows 2008 machine sysprep file | string | /etc/ovirt-engine/sysprep/sysprep.2k8x86 | Path to the operating system specific sysprep file template. |
| SysPrep2K8R2Path | Path to a Windows 2008 R2 machine sysprep file | string | /etc/ovirt-engine/sysprep/sysprep.2k8 | Path to the operating system specific sysprep file template. |
| SysPrep2K8x64Path | Path to a Windows 2008 machine sysprep file | string | /etc/ovirt-engine/sysprep/sysprep.2k8 | Path to the operating system specific sysprep file template. |
| SysPrepWindows7Path | Path to a Windows 7 machine sysprep file | string | /etc/ovirt-engine/sysprep/sysprep.w7 | Path to the operating system specific sysprep file template. |
| SysPrepWindows7x64Path | Path to a Windows 7 x64 machine sysprep file | string | /etc/ovirt-engine/sysprep/sysprep.w7x64 | Path to the operating system specific sysprep file template. |
| SysPrepWindows8Path | Path to a Windows 8 machine Sys-Prep file | String | /etc/ovirt-engine/sysprep/sysprep.w8 | Path to the operating system specific sysprep file template. |
| SysPrepWindows8x64Path | Path to a Windows 8 x64 machine Sys-Prep file | String | /etc/ovirt-engine/sysprep/sysprep.w8x64 | Path to the operating system specific sysprep file template. |
| SysPrepWindows2012x64Path | Path to a Windows 2012 x64 machine Sys-Prep file | String | /etc/ovirt-engine/sysprep/sysprep.2k12x64 | Path to the operating system specific sysprep file template. |
| SysPrepXPPath | Path to a Windows XP machine sysprep file | string | /etc/ovirt-engine/sysprep/sysprep.xp | Path to the operating system specific sysprep file template. |
| TimeoutToResetVdsInSeconds | Communication timeout in seconds before attempting reset | Integer | 60 | The amount of time a host is unresponsive before a fence command is issued. This is used in conjunction with VDSAttemptsToResetCount. |
| TimeToReduceFailedRunOnVdsInMinutes | Time to Reduce Failed Run on Host (in minutes) | Integer | 30 | The amount of time that the host will be in Error status after failing to run virtual machines. |
| UserDefinedVMProperties | User-defined virtual machine properties | String | Custom properties set by user | Mostly used with VDSM hooks. |
| UserRefreshRate | Refresh Rate of Users' Data from Active Directory (in seconds) | Integer | 3600 | How often the directory server is polled for user account updates. |
| UtilizationThresholdInPercent | The Utilization Threshold (in percent) | Integer | 80 | In load balancing, this is a default value used to calculate the maximum CPU limit to determine if the host is overutilized. This is the percent of the value that the user set in high-utilization in the cluster. |
| ValidNumOfMonitors | Valid Numbers of Monitors | Integer | 1,2,4 | Number of monitors available for SPICE-enabled virtual machines. |
| VdcVersion | Red Hat Enterprise Virtualization Manager Version | String | Automatically set to the current version of RHEV-M | - |
| VDSAttemptstoResetCount | Number of attempts to communicate with Host before trying to reset | Integer | 2 | The amount of times to retry communications with a host before a fence command is issued. Used in conjunction with TimeoutToResetVdsInSeconds. |
| VdsLoadBalancingIntervalInMinutes | Host Load Balancing Interval (in minutes) | Integer | 1 | The interval between running the virtual machines' load balancer in minutes (also defines the first invocation of the load balancer). |
| VdsRecoveryTimeoutInMinutes | Host Timeout when Recovering (in minutes) | Integer | 3 | When VDSM fails/restarts, it can sometimes be in recovering mode (VDSM reports "initializing" or "recovering from reports"). |
| VdsRefreshRate | Time interval in seconds to poll a Host's status | Integer | 2 | How often a Hypervisor host's status is checked. |
| vdsTimeout | Host Control Communication Timeout (in seconds) | Integer | 180 | Timeout for a VDSM call - the time engine will wait for sync call to VDSM. |
| VMGracefulShutdownMessage | Message displayed in Virtual Machine when Virtual Machine is being shut down from Red Hat Enterprise Virtualization Manager | String | The Red Hat Enterprise Virtualization Manager is shutting down this Virtual Machine | - |
| VMMinMemorySizeInMB | Minimal memory size of virtual machine in MB | Integer | 256 | - |
| VncKeyboardLayout | Keyboard Layout configuration for VNC | String | en-us | Possible values: ar, da, de-ch, en-us, et, fo, fr-be, fr-ch, hu, it, li, mk, nl, no, pt, ru, sv, tr, de en-gb, es, fi, fr, fr-ca, hr, is, ja, lv, nl-be, pl, pt-br, sl, th. |
| WaitForVdsInitInSec | Wait for a host to complete init in SPM selection | Integer | 60 | This is a timeout for initializing host as in VdsRecoveryTimeoutInMinutes, but this timeout is shorter and is used during the SPM selection algorithm. If the selected host is initialized, wait for it to recover. |
| FenceQuietTimeBetweenOperationsInSec | Quiet time between Power Management operations in seconds | Integer | 180 | The minimum time in seconds between two power management operations activated manually by a user. |
| MaxAuditLogMessageLength | Maximum length of an Audit Log message | Integer | 10000 | - |
| SysPrepDefaultUser | Default sysprep user name | String | - | This user is used if the domain for sysprep is unknown or no domain is specified. |
| SysPrepDefaultPassword | Default SysPrep user password | Password | Empty | This password is used if the domain for sysprep is unknown or no domain is specified. |
| UserSessionTimeOutInterval | Session timeout interval in minutes | Integer | 30 | User session timeout. Global for all types of access - User Portal/Admin Portal/Web Admin/API. |
| AdminPassword | admin user password | Password | ****** | Password of admin user (used if no directory service is used for authentication). |
| IPTablesConfig | Iptables configuration used to autoconfigure the Manager. | String | The complete set of iptables rules that are used when automatic firewall configuration is selected during enginesetup | |
| OvirtIsoPrefix | oVirt ISOs files prefix | String | rhevh | |
| OvirtInitialSupportedIsoVersion | oVirt node initial Supported ISO Version | String | 5.8 | |
| VdsLocalDisksLowFreeSpace | Amount of free disk space on a host local storage domain that should be considered low, in MB. | Integer | 1000 | Setting this value lower than the default of 1000MB reduces the time available to add additional space to your data domains before virtual machine performance is affected. If you have many virtual machines, generating or receiving data, it may make sense to set this value higher. |
| VdsLocalDisksCriticallyLowFreeSpace | Amount of free disk space on a host local storage domain that should be considered critically low, in MB. | Integer | 500 | Setting this value lower than the default of 500MB reduces the time between when critical disk shortage messages begin being displayed and when virtual machine performance is affected. If you have many virtual machines, generating or receiving data quickly, you might find that the default value is too low, and does not provide enough time to add more storage. |
| AllowDuplicateMacAddresses | Enable duplicate MAC address for VM network interface | String | false | If enabled, allows that the same MAC address be set explicitly on several virtual NICs. Otherwise, setting a MAC address that is already in use on another virtual NIC is prohibited. |
| JobCleanupRateInMinutes | Frequency of jobs clean-up process | Integer | 10 | |
| SucceededJobCleanupTimeInMinutes | Time to keep successfully ended jobs | Integer | 10 | |
| FailedJobCleanupTimeInMinutes | Time to keep failed jobs | Integer | 60 | |
| VmPoolMonitorIntervalInMinutes | Interval in minutes for monitoring number of Prestarted Vms in Vm Pools | Integer | 5 | |
| VmPoolMonitorBatchSize | Maximum number of Vms that the Vm Pool Monitor will attempt to prestart in a single cycle | Integer | 5 | |
| NetworkConnectivityCheckTimeoutInSeconds | The time to wait before rolling back network changes in case the engine losses connectivity with the host in seconds | Integer | 120 | |
| AllowClusterWithVirtGlusterEnabled | Allows to create a Cluster with both Virt and Gluster services enabled | String | false | If enabled, the user can create a cluster with both Virt and Gluster support or one of them, otherwise the user cannot create a cluster that supports both. |
| EnableMACAntiSpoofingFilterRules | Indicates if Network Filtering should be enabled or not | String | v3.0: false v3.1: false v3.2: true | If enabled, MAC anti-spoofing rules are set on each virtual NIC, enforcing that the ethernet frames this NIC sends have the source MAC that is assigned to it in the engine. |
| EnableHostTimeDrift | Indicates if host time-drift validation is enabled | String | false | If time drift validation is enabled, the Manager will require that host system time be within a given variation of the Manager system time. The allowed difference is set by HostTimeDriftInSec |
| EngineMode | Engine working mode | String | Active | |
| HostTimeDriftInSec | Allowed time drift between any Host and Engine | Integer | 300 |
17.4. Uploading Virtual Machine Images with the Image Uploader Tool
17.4.1. Virtual Machine Image Uploader
Using the
engine-image-uploader command, you can list export storage domains and upload virtual machines in OVF to an export storage domain and have them automatically recognized in the Red Hat Enterprise Virtualization Manager. The tool only supports gzip compressed OVF files created by Red Hat Enterprise Virtualization.
The image uploader makes creating distributable virtual machine images practical.
The archive contains images and master directories that are in the following format:
|-- images | |-- [Image Group UUID] | |--- [Image UUID (this is the disk image)] | |--- [Image UUID (this is the disk image)].meta |-- master | |---vms | |--- [UUID] | |--- [UUID].ovf
17.4.2. Syntax for the engine-image-uploader Command
The basic syntax for the image uploader command is:
engine-image-uploader[options]listengine-image-uploader[options]upload[file].[file]...[file]
The two supported modes of operation are
list and upload.
- The
listparameter lists the valid export storage domains available for image uploads. - The
uploadparameter uploads selected image file(s) to the specified image storage domain.
The image uploader command requires either the
list or upload parameter be included for basic usage. The upload parameter requires a minimum of one local file name to upload.
There are numerous parameters to further refine the
engine-image-uploader command. You can set defaults for any of these in the /etc/ovirt-engine/imageuploader.conf file.
General Options
-h,--help- Displays command usage information and returns to prompt.
--conf-file=PATH- Sets PATH as the configuration file the tool is to use. The default is
etc/ovirt-engine/imageuploader.conf. --log-file=PATH- Sets PATH as the specific file name the command should use for the log output.
--quiet- Sets quiet mode, reducing console output to a minimum. Quiet mode is off by default.
-v,--verbose- Sets verbose mode, providing more console output. Verbose mode is off by default.
-f,--force- Force mode is necessary when the source file being uploaded has an identical file name as an existing file at the destination; it forces the existing file to be overwritten. Force mode is off by default.
Red Hat Enterprise Virtualization Manager Options
-u USER,--user=USER- Sets the user associated with the file to be uploaded. The USER is specified in the format user@domain, where user is the user name and domain is the directory services domain in use. The user must exist in directory services and be known to the Red Hat Enterprise Virtualization Manager.
-r FQDN,--rhevm=FQDN- Sets the fully qualified domain name of the Red Hat Enterprise Virtualization Manager server from which to upload images, where FQDN is replaced by the fully qualified domain name of the Manager. It is assumed that the image uploader is being run on the same client machine as the Red Hat Enterprise Virtualization Manager; the default value is
localhost:443.
Export Storage Domain Options
These options specify the export domain to which files are uploaded. They are alternatives; do not use these parameters together.
-e,--export-domain=EXPORT_DOMAIN- Sets the storage domain EXPORT_DOMAIN as the destination for uploads.
-n,--nfs-server=NFSSERVER- Sets the NFS path NFSSERVER as the destination for uploads.
-i,--ovf-id- Use this option if you do not want to update the UUID of the image. By default, the tool will generate a new UUID for the image. This ensures that there is no conflict between the id of the incoming image and those already in the environment.
-d,-disk-instance-id- Use this option if you do not want to rename the instance ID for each disk (i.e. InstanceId) in the image. By default, this tool will generate new UUIDs for disks within the image to be imported. This ensures that there are no conflicts between the disks on the imported image and those within the environment.
-m,--mac-address- Use this option if you do not want to remove the network components from the image that will be imported. By default, this tool will remove any network interface cards from the image to prevent conflicts with network cards on other virtual machines within the environment. Once the image has been imported, use the Administration Portal to add network interface cards back and the Manager will ensure that there are no MAC address conflicts.
-N NEW_IMAGE_NAME,--name=NEW_IMAGE_NAME- Supply this option if you want to rename the image.
17.4.3. Creating an OVF Archive That is Compatible with the Image Uploader
Summary
You can create files that can be uploaded using the engine-image-uploader tool.
Procedure 17.2. Creating an OVF Archive That is Compatible with the Image Uploader
- Use the Manager to create an empty export domain. An empty export domain makes it easy to see which directory contains your virtual machine.
- Export your virtual machine to the empty export domain you just created.
- Log in to the storage server that serves as the export domain, find the root of the NFS share and change to the subdirectory under that mount point. You started with a new export domain, there is only one directory under the exported directory. It contains the
images/andmaster/directories. - Run the
tar -zcvf my.ovf images/ master/command to create the tar/gzip ovf archive. - Anyone you give the resulting ovf file to (in this example, called
my.ovf) can import it to Red Hat Enterprise Virtualization Manager using theengine-image-uploadercommand.
Result
You have created a compressed OVF image file that can be distributed. Anyone you give it to can use the engine-image-uploader command to upload your image into their Red Hat Enterprise Virtualization environment.
17.4.4. Basic engine-image-uploader Usage Examples
Here is an example of how to use
engine-image-uploader to list storage domains:
Example 17.10. Uploading a file Using the engine-image-uploader Tool
# engine-image-uploader list Please provide the REST API username for RHEV-M: admin@internal Please provide the REST API password for the admin@internal RHEV-M user: ********** Export Storage Domain Name | Datacenter | Export Domain Status myexportdom | Myowndc | active
To upload an Open Virtualization Format (ovf) file, you need to enter an NFS server name (
-n NFSSERVER) or export domain (-e EXPORT_STORAGE_DOMAIN) and the name of the .ovf file:
# engine-image-uploader -e myexportdom upload myrhel6.ovf Please provide the REST API username for RHEV-M: admin@internal Please provide the REST API password for the admin@internal RHEV-M user: **********
17.5. Editing USB Filters with the USB Filter Editor
17.5.1. Installing the USB Filter Editor
Summary
The USB Filter Editor is a Windows tool used to configure the usbfilter.txt policy file. The policy rules defined in this file allow or deny the pass-through of specific USB devices from client machines to virtual machines managed using the Red Hat Enterprise Virtualization Manager. The policy file resides on the Red Hat Enterprise Virtualization Manager in the following location:
/etc/ovirt-engine/usbfilter.txt
Changes to USB filter policies do not take effect unless the
ovirt-engine service on the Red Hat Enterprise Virtualization Manager server is restarted.
Download the
USBFilterEditor.msi file from the Red Hat Enterprise Virtualization Manager (v.3.3 x86_64) channel of the Red Hat Network.
Note
See the Red Hat Enterprise Virtualization Manager Release Notes for specific channel names current to your system.
Procedure 17.3. Installing the USB Filter Editor
- On a Windows machine, launch the
USBFilterEditor.msiinstaller obtained from Red Hat Network. - Follow the steps of the installation wizard. Unless otherwise specified, the USB Filter Editor will be installed by default in either
C:\Program Files\RedHat\USB Filter EditororC:\Program Files(x86)\RedHat\USB Filter Editordepending on your version of Windows. - A USB Filter Editor shortcut icon is created on your desktop.
Important
Use a Secure Copy (SCP) client to import and export filter policies from the Red Hat Enterprise Virtualization Manager. A Secure Copy tool for Windows machines is WinSCP (http://winscp.net).
Result
The default USB device policy provides virtual machines with basic access to USB devices; update the policy to allow the use of additional USB devices.
17.5.2. The USB Filter Editor Interface
- Double-click the USB Filter Editor shortcut icon on your desktop.
The Red Hat USB Filter Editor interface displays the Class, Vendor, Product, Revision, and Action for each USB device. Permitted USB devices are set to Allow in the Action column; prohibited devices are set to Block.
Table 17.2. USB Editor Fields
| Name | Description |
|---|---|
| Class | Type of USB device; for example, printers, mass storage controllers. |
| Vendor | The manufacturer of the selected type of device. |
| Product | The specific USB device model. |
| Revision | The revision of the product. |
| Action | Allow or block the specified device. |
The USB device policy rules are processed in their listed order. Use the and buttons to move devices higher or lower in the list. The universal Block rule needs to remain as the lowest entry to ensure all USB devices are denied unless explicitly allowed in the USB Filter Editor.
17.5.3. Adding a USB Policy
Summary
Add a USB policy to the USB Filter Editor.
Double-click the USB Filter Editor shortcut icon on your desktop to open the editor.
Procedure 17.4. Adding a USB Policy
- Click the button. The Edit USB Criteria window opens:
- Use the USB Class, Vendor ID, Product ID, and Revision check boxes and lists to specify the device.Click the button to permit virtual machines use of the USB device; click the button to prohibit the USB device from virtual machines.Click to add the selected filter rule to the list and close the window.
Example 17.11. Adding a Device
The following is an example of how to add USB ClassSmartcard, deviceEP-1427X-2 Ethernet Adapter, from manufacturerAcer Communications & Multimediato the list of allowed devices.
- Click → to save the changes.
Result
You have added a USB policy to the USB Filter Editor. USB filter policies need to be exported to the Red Hat Enterprise Virtualization Manager to take effect.
17.5.4. Removing a USB Policy
Summary
Remove a USB policy from the USB Filter Editor.
Double-click the USB Filter Editor shortcut icon on your desktop to open the editor.
Procedure 17.5. Removing a USB Policy
- Select the policy to be removed.
- Click . A message displays prompting you to confirm that you want to remove the policy.
- Click to confirm that you want to remove the policy.
- Click → to save the changes.
Result
You have removed a USB policy from the USB Filter Editor. USB filter policies need to be exported to the Red Hat Enterprise Virtualization Manager to take effect.
17.5.5. Searching for USB Device Policies
Summary
Search for attached USB devices to either allow or block them in the USB Filter Editor.
Double-click the USB Filter Editor shortcut icon on your desktop to open the editor.
Procedure 17.6. Searching for USB Device Policies
- Click . The Attached USB Devices window displays a list of all the attached devices.
- Select the device and click or as appropriate. Double-click the selected device to close the window. A policy rule for the device is added to the list.
- Use the Up and Down buttons to change the position of the new policy rule in the list.
- Click → to save the changes.
Result
You have searched the attached USB devices. USB filter policies need to be exported to the Red Hat Enterprise Virtualization Manager to take effect.
17.5.6. Exporting a USB Policy
Summary
USB device policy changes need to be exported and uploaded to the Red Hat Enterprise Virtualization Manager for the updated policy to take effect. Upload the policy and restart the ovirt-engine service.
Double-click the USB Filter Editor shortcut icon on your desktop to open the editor.
Procedure 17.7. Exporting a USB Policy
- Click ; the window opens.
- Save the file with a file name of
usbfilter.txt. - Using a Secure Copy client, such as WinSCP, upload the
usbfilter.txtfile to the server running Red Hat Enterprise Virtualization Manager. The file must be placed in the following directory on the server:/etc/ovirt-engine/ - As the
rootuser on the server running Red Hat Enterprise Virtualization Manager, restart theovirt-engineservice.# service ovirt-engine restart
Result
The USB device policy will now be implemented on virtual machines running in the Red Hat Enterprise Virtualization environment.
17.5.7. Importing a USB Policy
Summary
An existing USB device policy must be downloaded and imported into the USB Filter Editor before you can edit it.
Procedure 17.8. Importing a USB Policy
- Using a Secure Copy client, such as WinSCP, upload the
usbfilter.txtfile to the server running Red Hat Enterprise Virtualization Manager. The file must be placed in the following directory on the server:/etc/ovirt-engine/ - Double-click the USB Filter Editor shortcut icon on your desktop to open the editor.
- Click to open the window.
- Open the
usbfilter.txtfile that was downloaded from the server.
Result
You are able to edit the USB device policy in the USB Filter Editor.
17.6. Collecting Logs with the Log Collector Tool
17.6.1. Log Collector
A log collection tool is included in the Red Hat Enterprise Virtualization Manager. This allows you to easily collect relevant logs from across the Red Hat Enterprise Virtualization environment when requesting support.
The log collection command is
engine-log-collector. You are required to log in as the root user and provide the administration credentials for the Red Hat Enterprise Virtualization environment. The engine-log-collector -h command displays usage information, including a list of all valid options for the engine-log-collector command.
17.6.2. Syntax for engine-log-collector Command
The basic syntax for the log collector command is:
engine-log-collector[options]list[all, clusters, datacenters]engine-log-collector[options]collect
The two supported modes of operation are
list and collect.
- The
listparameter lists either the hosts, clusters, or data centers attached to the Red Hat Enterprise Virtualization Manager. You are able to filter the log collection based on the listed objects. - The
collectparameter performs log collection from the Red Hat Enterprise Virtualization Manager. The collected logs are placed in an archive file under the/tmp/logcollectordirectory. Theengine-log-collectorcommand assigns each log a specific file name.
Unless another parameter is specified, the default action is to list the available hosts together with the data center and cluster to which they belong. You will be prompted to enter user names and passwords to retrieve certain logs.
There are numerous parameters to further refine the
engine-log-collector command.
General options
--version- Displays the version number of the command in use and returns to prompt.
-h,--help- Displays command usage information and returns to prompt.
--conf-file=PATH- Sets PATH as the configuration file the tool is to use.
--local-tmp=PATH- Sets PATH as the directory in which logs are saved. The default directory is
/tmp/logcollector. --ticket-number=TICKET- Sets TICKET as the ticket, or case number, to associate with the SOS report.
--upload=FTP_SERVER- Sets FTP_SERVER as the destination for retrieved logs to be sent using FTP. Do not use this option unless advised to by a Red Hat support representative.
--log-file=PATH- Sets PATH as the specific file name the command should use for the log output.
--quiet- Sets quiet mode, reducing console output to a minimum. Quiet mode is off by default.
-v,--verbose- Sets verbose mode, providing more console output. Verbose mode is off by default.
Red Hat Enterprise Virtualization Manager Options
These options filter the log collection and specify authentication details for the Red Hat Enterprise Virtualization Manager.
These parameters can be combined for specific commands. For example,
engine-log-collector --user=admin@internal --cluster ClusterA,ClusterB --hosts "SalesHost"* specifies the user as admin@internal and limits the log collection to only SalesHost hosts in clusters A and B.
--no-hypervisors- Omits virtualization hosts from the log collection.
-u USER,--user=USER- Sets the user name for login. The USER is specified in the format user@domain, where user is the user name and domain is the directory services domain in use. The user must exist in directory services and be known to the Red Hat Enterprise Virtualization Manager.
-r FQDN,--rhevm=FQDN- Sets the fully qualified domain name of the Red Hat Enterprise Virtualization Manager server from which to collect logs, where FQDN is replaced by the fully qualified domain name of the Manager. It is assumed that the log collector is being run on the same local host as the Red Hat Enterprise Virtualization Manager; the default value is
localhost. -c CLUSTER,--cluster=CLUSTER- Collects logs from the virtualization hosts in the nominated CLUSTER in addition to logs from the Red Hat Enterprise Virtualization Manager. The cluster(s) for inclusion must be specified in a comma-separated list of cluster names or match patterns.
-d DATACENTER,--data-center=DATACENTER- Collects logs from the virtualization hosts in the nominated DATACENTER in addition to logs from the Red Hat Enterprise Virtualization Manager. The data center(s) for inclusion must be specified in a comma-separated list of data center names or match patterns.
-H HOSTS_LIST,--hosts=HOSTS_LIST- Collects logs from the virtualization hosts in the nominated HOSTS_LIST in addition to logs from the Red Hat Enterprise Virtualization Manager. The hosts for inclusion must be specified in a comma-separated list of host names, fully qualified domain names, or IP addresses. Match patterns are also valid.
SOS Report Options
The log collector uses the JBoss SOS plugin. Use the following options to activate data collection from the JMX console.
--jboss-home=JBOSS_HOME- JBoss installation directory path. The default is
/var/lib/jbossas. --java-home=JAVA_HOME- Java installation directory path. The default is
/usr/lib/jvm/java. --jboss-profile=JBOSS_PROFILE- Displays a quoted and space-separated list of server profiles; limits log collection to specified profiles. The default is
'rhevm-slimmed'. --enable-jmx- Enables the collection of run-time metrics from Red Hat Enterprise Virtualization's JBoss JMX interface.
--jboss-user=JBOSS_USER- User with permissions to invoke JBoss JMX. The default is
admin. --jboss-logsize=LOG_SIZE- Maximum size in MB for the retrieved log files.
--jboss-stdjar=STATE- Sets collection of JAR statistics for JBoss standard JARs. Replace STATE with
onoroff. The default ison. --jboss-servjar=STATE- Sets collection of JAR statistics from any server configuration directories. Replace STATE with
onoroff. The default ison. --jboss-twiddle=STATE- Sets collection of twiddle data on or off. Twiddle is the JBoss tool used to collect data from the JMX invoker. Replace STATE with
onoroff. The default ison. --jboss-appxml=XML_LIST- Displays a quoted and space-separated list of applications with XML descriptions to be retrieved. Default is
all.
SSH Configuration
--ssh-port=PORT- Sets PORT as the port to use for SSH connections with virtualization hosts.
-k KEYFILE,--key-file=KEYFILE- Sets KEYFILE as the public SSH key to be used for accessing the virtualization hosts.
--max-connections=MAX_CONNECTIONS- Sets MAX_CONNECTIONS as the maximum concurrent SSH connections for logs from virtualization hosts. The default is
10.
PostgreSQL Database Options
The
pg-pass parameter includes the Red Hat Enterprise Virtualization Manager database in the log. The database user name and database name must be specified if they have been changed from the default values.
Use the
pg-dbhost parameter if the database is not on the local host. Use the optional pg-host-key parameter to collect remote logs. The PostgreSQL SOS plugin must be installed on the database server for remote log collection to be successful.
--no-postgresql- Disables collection of database. Database collection is performed by default.
--pg-user=USER- Sets USER as the user name to use for connections with the database server. The default is
postgres. --pg-dbname=DBNAME- Sets DBNAME as the database name to use for connections with the database server. The default is
rhevm. --pg-dbhost=DBHOST- Sets DBHOST as the host name for the database server. The default is
localhost. --pg-host-key=KEYFILE- Sets KEYFILE as the public identity file (private key) for the database server. This value is not set by default; it is required only where the database does not exist on the local host.
17.6.3. Basic Log Collector Usage
When the
engine-log-collector command is run without specifying any additional parameters, its default behavior is to collect all logs from the Red Hat Enterprise Virtualization Manager and its attached hosts. It will also collect database logs unless the --no-postgresql parameter is added. In the following example, log collector is run to collect all logs from the Red Hat Enterprise Virtualization Manager and three attached hosts.
Example 17.12. Log Collector Usage
# engine-log-collector
INFO: Gathering oVirt Engine information...
INFO: Gathering PostgreSQL the oVirt Engine database and log files from localhost...
Please provide REST API password for the admin@internal oVirt Engine user (CTRL+D to abort):
About to collect information from 3 hypervisors. Continue? (Y/n):
INFO: Gathering information from selected hypervisors...
INFO: collecting information from 192.168.122.250
INFO: collecting information from 192.168.122.251
INFO: collecting information from 192.168.122.252
INFO: finished collecting information from 192.168.122.250
INFO: finished collecting information from 192.168.122.251
INFO: finished collecting information from 192.168.122.252
Creating compressed archive...
INFO Log files have been collected and placed in /tmp/logcollector/sosreport-rhn-account-20110804121320-ce2a.tar.xz.
The MD5 for this file is 6d741b78925998caff29020df2b2ce2a and its size is 26.7M17.7. Uploading ISO Files with the ISO Uploader Tool
17.7.1. ISO Uploader
The ISO uploader is a tool for uploading ISO images to the ISO storage domain. It is installed as part of the Red Hat Enterprise Virtualization Manager.
The ISO uploader command is
engine-iso-uploader. You are required to log in as the root user and provide the administration credentials for the Red Hat Enterprise Virtualization environment. The engine-iso-uploader -h command displays usage information, including a list of all valid options for the engine-iso-uploader command.
17.7.2. Syntax for engine-iso-uploader Command
The basic syntax for the ISO uploader command is:
engine-iso-uploader[options]listengine-iso-uploader[options]upload[file].[file]...[file]
The two supported modes of operation are
list and upload.
- The
listparameter lists the valid ISO storage domains available for ISO uploads. The Red Hat Enterprise Virtualization Manager sets this list on the local machine upon installation. - The
uploadparameter uploads single or multiple space-separated ISO files to the specified ISO storage domain. NFS is used as default; SSH is available.
The ISO uploader command requires either the
list or upload parameter be included for basic usage. The upload parameter requires a minimum of one local file name to upload.
There are numerous parameters to further refine the
engine-iso-uploader command.
General Options
--version- Displays the version number of the command in use and returns to prompt.
-h,--help- Displays command usage information and returns to prompt.
--conf-file=PATH- Sets PATH as the configuration file the tool is to use.
--log-file=PATH- Sets PATH as the specific file name the command should use for the log output.
--quiet- Sets quiet mode, reducing console output to a minimum. Quiet mode is off by default.
-v,--verbose- Sets verbose mode, providing more console output. Verbose mode is off by default.
-f,--force- Force mode is necessary when the source file being uploaded has an identical file name as an existing file at the destination; it forces the existing file to be overwritten. Force mode is off by default.
Red Hat Enterprise Virtualization Manager Options
-u USER,--user=USER- Sets the user associated with the file to be uploaded. The USER is specified in the format user@domain, where user is the user name and domain is the directory services domain in use. The user must exist in directory services and be known to the Red Hat Enterprise Virtualization Manager.
-r FQDN,--rhevm=FQDN- Sets the fully qualified domain name of the Red Hat Enterprise Virtualization Manager server from which to upload ISOs, where FQDN is replaced by the fully qualified domain name of the Manager. It is assumed that the ISO uploader is being run on the same client machine as the Red Hat Enterprise Virtualization Manager; the default value is
localhost.
ISO Storage Domain Options
These options specify the ISO domain to which files are uploaded. They are alternatives; do not use these parameters together.
-i,--iso-domain=ISODOMAIN- Sets the storage domain ISODOMAIN as the destination for uploads.
-n,--nfs-server=NFSSERVER- Sets the NFS path NFSSERVER as the destination for uploads.
Connection Options
The ISO uploader uses NFS as default to upload files. These options specify SSH file transfer instead.
--ssh-user=USER- Sets USER as the SSH user name to use for the upload.
--ssh-port=PORT- Sets PORT as the port to use when connecting to SSH.
-k KEYFILE,--key-file=KEYFILE- Sets KEYFILE as the public key to use for SSH authentication. You will be prompted to enter the password of the user specified with
--ssh-user=USERif no key is set.
17.7.3. Specifying an NFS Server
Example 17.13. Uploading to an NFS Server
# engine-iso-uploader --nfs-server=storage.demo.redhat.com:/iso/path upload RHEL6.0.iso17.7.4. Basic ISO Uploader Usage
The example below demonstrates the ISO uploader and the list parameter. The first command lists the available ISO storage domains; the
admin@internal user is used because no user was specified in the command. The second command uploads an ISO file over NFS to the specified ISO domain.
Example 17.14. List Domains and Upload Image
# engine-iso-uploader list
Please provide the REST API password for the admin@internal oVirt Engine user (CTRL+D to abort):
ISO Storage Domain Name | Datacenter | ISO Domain Status
ISODomain | Default | active# engine-iso-uploader --iso-domain=[ISODomain] upload [RHEL6.iso]
Please provide the REST API password for the admin@internal oVirt Engine user (CTRL+D to abort):17.7.5. Uploading the VirtIO and Guest Tool Image Files to an ISO Storage Domain
The example below demonstrates the command to upload the
virtio-win.iso, virtio-win_x86.vfd, virtio-win_amd64.vfd, and rhev-tools-setup.iso image files to the ISODomain.
Example 17.15. Uploading the VirtIO and Guest Tool Image Files
# engine-iso-uploader --iso-domain=[ISODomain] upload /usr/share/virtio-win/virtio-win.iso /usr/share/virtio-win/virtio-win_x86.vfd /usr/share/virtio-win/virtio-win_amd64.vfd /usr/share/rhev-guest-tools-iso/rhev-tools-setup.iso17.7.6. VirtIO and Guest Tool Image Files
The virtio-win ISO and Virtual Floppy Drive (VFD) images, which contain the VirtIO drivers for Windows virtual machines, and the rhev-tools-setup ISO, which contains the Red Hat Enterprise Virtualization Guest Tools for Windows virtual machines, are copied to an ISO storage domain upon installation and configuration of the domain.
These image files provide software that can be installed on virtual machines to improve performance and usability. The most recent virtio-win and rhev-tools-setup files can be accessed via the following symbolic links on the file system of the Red Hat Enterprise Virtualization Manager:
/usr/share/virtio-win/virtio-win.iso/usr/share/virtio-win/virtio-win_x86.vfd/usr/share/virtio-win/virtio-win_amd64.vfd/usr/share/rhev-guest-tools-iso/rhev-tools-setup.iso
These image files must be manually uploaded to ISO storage domains that were not created locally by the installation process. Use the
engine-iso-uploader command to upload these images to your ISO storage domain. Once uploaded, the image files can be attached to and used by virtual machines.
17.8. Guest Drivers and Agents
17.8.1. Installing Guest Agents and Drivers
Installing Red Hat Enterprise Virtualization guest agents and drivers on virtual machines provides optimized performance and extra features.
- Installing the agents and drivers on Red Hat Enterprise Linux guests
- All of the drivers are included in the base channel for RHN registered Red Hat Enterprise Linux virtual machines. They can be installed using the
yum install rhevm-guest-agentcommand.Your guest must be subscribed to theRed Hat Enterprise Virt Agentchannel to install the agents.In Red Hat Enterprise Linux 5, this channel is labeledrhel-x86_64-rhev-agent-5-server. In Red Hat Enterprise Linux 6, the channel is labeledrhel-x86_64-rhev-agent-6-server. - Installing the agents and drivers on Windows guests
- The agents and drivers are installed on Windows virtual machines using the
rhev-tools-setup.isodisk image. The guest tools ISO is distributed using the Red Hat Network asrhev-guest-tools-iso.rpm, an RPM file installed on the Red Hat Enterprise Virtualization Manager.After installing the Manager, the guest tools ISO can be found at/usr/share/rhev-guest-tools-iso/rhev-tools-setup.iso. When setting up the Manager, if you have created a local storage share for an ISO storage domain, the ISO file is automatically copied to the ISO storage domain. In this case the ISO image is automatically attached to Windows guests when they are created. Otherwise, the ISO must be manually attached to Windows guests for the tools and agents to be installed.Updated versions of the 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.
See Also:
17.8.2. Automating Guest Additions on Windows Guests with Red Hat Enterprise Virtualization Application Provisioning Tool(APT)
Red Hat Enterprise Virtualization Application Provisioning Tool (APT) is a Windows service that can be installed in Windows virtual machines and templates. Attach the guest tools ISO file to your Windows virtual machine and RHEV-Application Provisioning.exe automatically runs to install the APT service.
When the APT service is installed on a virtual machine, attached ISO files are automatically scanned. When the service recognizes a valid Red Hat Enterprise Virtualization guest tools ISO, and no other guest tools are installed, the APT service installs the guest tools. If guest tools are installed, and the ISO image contains newer versions of the tools, an upgrade is automatically performed.
When the APT service has successfully installed or upgraded guest tools on a virtual machine, the virtual machine is automatically rebooted.
17.8.3. Red Hat Enterprise Virtualization Guest Drivers and Guest Agents
Red Hat Enterprise Virtualization provides customized drivers and guest tools to use with Windows and Red Hat Enterprise Linux guests. The drivers allow guests to use enhanced virtual devices that perform better than emulated devices; the guest agents facilitate communication between the guest and the Red Hat Enterprise Virtualization Manager.
Table 17.3. Red Hat Enterprise Virtualization Guest Drivers
|
Driver
|
Description
|
Works on
|
|---|---|---|
virtio-net
|
Paravirtualized network driver provides enhanced performance over emulated devices like rtl.
|
Server and Desktop.
|
virtio-block
|
Paravirtualized HDD driver 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.
|
Server and Desktop.
|
virtio-scsi
|
Paravirtualized iSCSI HDD 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.
|
Server and Desktop.
|
virtio-serial
|
Virtio-serial provides support 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.
|
Server and Desktop.
|
virtio-balloon
|
Virtio-balloon is used to 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 Enterprise Virtualization 3.1 or higher.
|
Server and Desktop.
|
qxl
|
A paravirtualized display driver reduces CPU usage on the host and provides better performance through reduced network bandwidth on most workloads.
|
Server and Desktop.
|
Table 17.4. Red Hat Enterprise Virtualization Guest Agents and Tools
|
Guest agent/tool
|
Description
|
Works on
|
|---|---|---|
rhevm-guest-agent
|
Allows the Red Hat Enterprise 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 higher guests, the rhevm-guest-agent installs tuned on your virtual machine and configures it to use an optimized, virtualized-guest profile.
|
Server and Desktop.
|
spice-agent
|
The SPICE agent supports 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.
|
Server and Desktop.
|
rhev-sso
|
An agent that enables users to automatically log in to their virtual machines based on the credentials used to access the Red Hat Enterprise Virtualization Manager.
|
Desktop.
|
rhev-usb
|
A component that contains drivers and services for Legacy USB support (version 3.0 and earlier) on guests. It is needed for accessing a USB device that is plugged into the client machine.
RHEV-USB Client is needed on the client side.
|
Desktop.
|
17.8.4. Subscribing to channels
17.8.4.1. Subscribing to Channels Using Subscription Manager
Summary
To install packages signed by Red Hat you must register the target system to Red Hat Network. You can then use an entitlement from your entitlement pool to subscribe the system to channels.
Procedure 17.9. Subscribing to Channels Using Subscription Manager
- Run the
subscription-managercommand to register the system with Red Hat Network. To complete registration successfully you will need to supply your Red Hat Network Username and Password when prompted.register# subscription-manager register
Identify available entitlement pools
To subscribe the system to channels, you must locate the identifiers for the relevant entitlement pools. Use thelistaction of thesubscription-managerto find these.For example, to identify available subscription pools forRed Hat Enterprise Virtualizationuse the command:# subscription-manager list --available | grep -A8 "Red Hat Enterprise Virtualization"
Subscribe system to entitlement pools
Using the pool identifiers located in the previous step, subscribe the system to the required entitlements. When a system is subscribed to an entitlement pool, the system is automatically subscribed to the channels in the entitlement. The main channel is automatically enabled, other channels in the entitlement must be enabled manually. Use thesubscribeaction of thesubscription-managercommand, replacing POOLID with one of the pool identifiers each time the command is run:# subscription-manager subscribe --pool=POOLID
Enable additional subscription channels
When a system is subscribed to an entitlement with a main channel and some additional channel, only the main channel is enabled by default. Other channels are available, but disabled. The additional channels must be enabled using theyum-config-managercommand as therootuser:# yum-config-manager --enable CHANNEL
Result
The system is now registered with Red Hat Network and subscribed to the channels required.
17.8.4.2. Subscribing to Channels Using RHN Classic
Summary
To install packages you must first register the target system to Red Hat Network and subscribe to the software channels containing your packages.
Procedure 17.10. Subscribing to the channels using RHN Classic
- Run the
rhn_registercommand to register the system with Red Hat Network. To complete registration successfully you will need to supply your Red Hat Network user name and password. Follow the onscreen prompts to complete registration of the system.# rhn_register
Subscribe to Required Channels
You must subscribe the system to the required channels using either the web interface to Red Hat Network or the command linerhn-channelcommand.Using the
rhn-channelCommandRun therhn-channelcommand to subscribe the system to each of the required channels. The commands which need to be run are:# rhn-channel --add --channel=CHANNEL
Important
If you are not the administrator for the machine as defined in Red Hat Network, or the machine is not registered to Red Hat Network, then use of therhn-channelcommand will result in an error:Error communicating with server. The message was: Error Class Code: 37 Error Class Info: You are not allowed to perform administrative tasks on this system. Explanation: An error has occurred while processing your request. If this problem persists please enter a bug report at bugzilla.redhat.com. If you choose to submit the bug report, please be sure to include details of what you were trying to do when this error occurred and details on how to reproduce this problem.If you encounter this error when usingrhn-channelthen to add the channel to the system you must use the web user interface.Using the Web Interface to Red Hat Network
To add a channel subscription to a system from the web interface:- Log on to Red Hat Network (http://rhn.redhat.com).
- Move the mouse cursor over the Subscriptions link at the top of the screen, and then click the Registered Systems link in the menu that appears.
- Select the system to which you are adding channels from the list presented on the screen, by clicking the name of the system.
- Click Alter Channel Subscriptions in the Subscribed Channels section of the screen.
- Select the channels to be added from the list presented on the screen.
- Click the Change Subscription button to finalize the change.
Result
The system is now registered with Red Hat Network and subscribed to the channels required.
Chapter 18. Log Files
18.1. Red Hat Enterprise Virtualization Manager Installation Log Files
Table 18.1. Installation
| Log File | Description |
|---|---|
/var/log/ovirt-engine/engine-cleanup_yyyy_mm_dd_hh_mm_ss.log | Log from the engine-cleanup command. This is the command used to reset a Red Hat Enterprise Virtualization Manager installation. A log is generated each time the command is run. The date and time of the run is used in the filename to allow multiple logs to exist. |
/var/log/ovirt-engine/engine-db-install-yyyy_mm_dd_hh_mm_ss.log | Log from the engine-setup command detailing the creation and configuration of the rhevm database. |
/var/log/ovirt-engine/rhevm-dwh-setup-yyyy_mm_dd_hh_mm_ss.log | Log from the rhevm-dwh-setup command. This is the command used to create the ovirt_engine_history database for reporting. A log is generated each time the command is run. The date and time of the run is used in the filename to allow multiple logs to exist concurrently. |
/var/log/ovirt-engine/ovirt-engine-reports-setup-yyyy_mm_dd_hh_mm_ss.log | Log from the rhevm-reports-setup command. This is the command used to install the Red Hat Enterprise Virtualization Manager Reports modules. A log is generated each time the command is run. The date and time of the run is used in the filename to allow multiple logs to exist concurrently. |
/var/log/ovirt-engine/setup/ovirt-engine-setup-yyyymmddhhmmss.log | Log from the engine-setup command. A log is generated each time the command is run. The date and time of the run is used in the filename to allow multiple logs to exist concurrently. |
18.2. Red Hat Enterprise Virtualization Manager Log Files
Table 18.2. Service Activity
| Log File | Description |
|---|---|
/var/log/ovirt-engine/engine.log | Reflects all Red Hat Enterprise Virtualization Manager GUI crashes, Active Directory look-ups, Database issues, and other events. |
/var/log/ovirt-engine/host-deploy | Log files from hosts deployed from the Red Hat Enterprise Virtualization Manager. |
/var/lib/ovirt-engine/setup-history.txt | Tracks the installation and upgrade of packages associated with the Red Hat Enterprise Virtualization Manager. |
18.3. SPICE Log Files
SPICE logs its activity in several places, including client and guest side logs.
Table 18.3.
| Log Type | Log Location | To Change Log Level: |
|---|---|---|
|
SPICE Client (Windows 7)
|
%temp%\spicex.log
|
|
|
SPICE Client (Windows XP)
|
C:\Documents and Settings\(User Name)\Local Settings\Temp\spicex.log
|
|
|
SPICE Client (Red Hat Enterprise Linux)
|
/var/log/messages
|
Launch Firefox from the command line with
SPICE_DEBUG=1 firefox.
|
|
USB Redirector on Windows Client
|
C:\Windows\Temp\usbclerk.log
|
Not applicable.
|
|
Host/Hypervisor SPICE Server
|
/var/log/libvirt/qemu/(guest_name).log
|
Run
export SPICE_DEBUG_LEVEL=5 on the host/hypervisor prior to launching the guest.
|
|
Windows Guest
|
C:\Windows\Temp\vdagent*
C:\Windows\Temp\vdservice*
|
Not applicable
|
|
Red Hat Enterprise Linux Guest
|
/var/log/spice-vdagentd.log
|
|
18.4. Red Hat Enterprise Virtualization Host Log Files
Table 18.4.
| Log File | Description |
|---|---|
/var/log/vdsm/libvirt.log | Log file for libvirt. |
/var/log/vdsm/spm-lock.log | Log file detailing the host's ability to obtain a lease on the Storage Pool Manager role. The log details when the host has acquired, released, renewed, or failed to renew the lease. |
/var/log/vdsm/vdsm.log | Log file for VDSM, the Manager's agent on the virtualization host(s). |
/tmp/ovirt-host-deploy-@DATE@.log | Host deployment log, copied to engine as /var/log/ovirt-engine/host-deploy/ovirt-@DATE@-@HOST@-@CORRELATION_ID@.log after the host has been successfully deployed. |
18.5. Remotely Logging Host Activities
18.5.1. Setting Up a Virtualization Host Logging Server
Summary
Red Hat Enterprise Virtualization hosts generate and update log files, recording their actions and problems. Collecting these log files centrally simplifies debugging.
This procedure should be used on your centralized log server. You could use a separate logging server, or use this procedure to enable host logging on the Red Hat Enterprise Virtualization Manager.
Procedure 18.1. Setting up a Virtualization Host Logging Server
- Configure SELinux to allow rsyslog traffic.
# semanage port -a -t syslogd_port_t -p udp 514
- Edit
/etc/rsyslog.confand add below lines:$template TmplAuth, "/var/log/%fromhost%/secure" $template TmplMsg, "/var/log/%fromhost%/messages" $RuleSet remote authpriv.* ?TmplAuth *.info,mail.none;authpriv.none,cron.none ?TmplMsg $RuleSet RSYSLOG_DefaultRuleset $InputUDPServerBindRuleset remote
Uncomment the following:#$ModLoad imudp #$UDPServerRun 514
- Restart the rsyslog service:
# service rsyslog restart
Result
Your centralized log server is now configured to receive and store the messages and secure logs from your virtualization hosts.
18.5.2. Configuring Logging
Summary
The Hypervisor creates and updates a number of log files. The Logging screen allows configuration of a daemon to automatically export these log files to a remote server.
Procedure 18.2. Configuring Hypervisor Logging
logrotate Configuration
The logrotate utility simplifies the administration of log files. The Hypervisor uses logrotate to rotate logs when they reach a certain file size.Log rotation involves renaming the current logs and starting new ones in their place. The Logrotate Max Log Size value set on the Logging screen is used to determine when a log will be rotated.Enter the Logrotate Max Log Size in kilobytes. The default maximum log size is 1024 kilobytes.rsyslog Configuration
The rsyslog utility is a multithreaded syslog daemon. The Hypervisor is able to use rsyslog to transmit log files over the network to a remote syslog daemon. For information on setting up the remote syslog daemon, see the Red Hat Enterprise Linux Deployment Guide.- Enter the remote rsyslog server address in the Server Address field.
- Enter the remote rsyslog server port in the Server Port field. The default port is
514.
netconsole Configuration
The netconsole module allows kernel messages to be sent to a remote machine. The Hypervisor uses netconsole to transmit kernel messages over the network.- Enter the Server Address.
- Enter the Server Port. The default port is
6666.
Save Configuration
To save the logging configuration, select and press Enter.
Result
The logging configuration has been updated and logs will be exported to the remote rsyslog server specified.
18.5.3. Configuring Logging
Summary
The Hypervisor creates and updates a number of log files. The Logging screen allows configuration of a daemon to automatically export these log files to a remote server.
Procedure 18.3. Configuring Hypervisor Logging
logrotate Configuration
The logrotate utility simplifies the administration of log files. The Hypervisor uses logrotate to rotate logs when they reach a certain file size.Log rotation involves renaming the current logs and starting new ones in their place. The Logrotate Max Log Size value set on the Logging screen is used to determine when a log will be rotated.Enter the Logrotate Max Log Size in kilobytes. The default maximum log size is 1024 kilobytes.rsyslog Configuration
The rsyslog utility is a multithreaded syslog daemon. The Hypervisor is able to use rsyslog to transmit log files over the network to a remote syslog daemon. For information on setting up the remote syslog daemon, see the Red Hat Enterprise Linux Deployment Guide.- Enter the remote rsyslog server address in the Server Address field.
- Enter the remote rsyslog server port in the Server Port field. The default port is
514.
netconsole Configuration
The netconsole module allows kernel messages to be sent to a remote machine. The Hypervisor uses netconsole to transmit kernel messages over the network.- Enter the Server Address.
- Enter the Server Port. The default port is
6666.
Save Configuration
To save the logging configuration, select and press Enter.
Result
The logging configuration has been updated and logs will be exported to the remote rsyslog server specified.
Chapter 19. Updating the Red Hat Enterprise Virtualization Environment
19.1. Upgrades between Minor Releases
- 19.1.1. Checking for Red Hat Enterprise Virtualization Manager Updates
- 19.1.2. Updating Red Hat Enterprise Virtualization Manager
- 19.1.3. Updating Red Hat Enterprise Virtualization Manager Reports
- 19.1.4. Updating Red Hat Enterprise Virtualization Hypervisors
- 19.1.5. Updating Red Hat Enterprise Linux Virtualization Hosts
- 19.1.6. Updating the Red Hat Enterprise Virtualization Guest Tools
19.1.1. Checking for Red Hat Enterprise Virtualization Manager Updates
Summary
Use the engine-upgrade-check command, included in Red Hat Enterprise Virtualization Manager, to check for updates.
Procedure 19.1. Checking for Red Hat Enterprise Virtualization Manager Updates
- Run
engine-upgrade-checkas a user with administrative privileges such as therootuser.# engine-upgrade-check
- Where no updates are available the command will output the text
No upgrade.# engine-upgrade-check VERB: queue package rhevm-setup for update VERB: package rhevm-setup queued VERB: Building transaction VERB: Empty transaction VERB: Transaction Summary: No upgrade
- Where updates are available the command will list the packages to be updated.
# engine-upgrade-check VERB: queue package rhevm-setup for update VERB: package rhevm-setup queued VERB: Building transaction VERB: Transaction built VERB: Transaction Summary: VERB: updated - rhevm-lib-3.3.0-0.46.el6ev.noarch VERB: update - rhevm-lib-3.3.1-0.48.el6ev.noarch VERB: updated - rhevm-setup-3.3.0-0.46.el6ev.noarch VERB: update - rhevm-setup-3.3.1-0.48.el6ev.noarch Upgrade available
Result
You have successfully checked for Red Hat Enterprise Virtualization Manager updates.
19.1.2. Updating Red Hat Enterprise Virtualization Manager
Summary
Updates to the Red Hat Enterprise Virtualization Manager are released via Red Hat Network. Before installing an update from Red Hat Network be sure to read the advisory text associated with it as well as the most recent version of the Red Hat Enterprise Virtualization Release Notes, and the Red Hat Enterprise Virtualization Technical Notes. A number of actions must be performed to complete an upgrade, including:
- Stopping the
ovirt-engineservice. - Downloading and installing the updated packages.
- Backing up and updating the database.
- Performing post installation configuration.
- Restarting the
ovirt-engineservice.
root user.
Procedure 19.2. Updating Red Hat Enterprise Virtualization Manager
- Run the
yumcommand to update the rhevm-setup package.# yum update rhevm-setup
- Run the
engine-setupcommand to update the Red Hat Enterprise Virtualization Manager.# engine-setup
Note
From Version 3.3, installation of Red Hat Enterprise Virtualization Manager supportsotopi, a standalone, plug-in-based installation framework for setting up system components. Under this framework, therhevm-upgradecommand used during the installation process has been updated toengine-setupand is now obsolete.Note
The upgrade process may take some time; allow time for the upgrade process to complete and do not stop the process once initiated. Once the upgrade has been completed, you will also be instructed to separately upgrade the data warehouse and reports functionality. These additional steps are only required if these optional packages are installed.
Result
You have successfully updated Red Hat Enterprise Virtualization Manager.
19.1.3. Updating Red Hat Enterprise Virtualization Manager Reports
Summary
The Red Hat Enterprise Virtualization Manager Reports must be updated separately to the Red Hat Enterprise Virtualization Manager. This task provides instructions for updating both the history database and the reporting engine. You must run all commands in this task while logged into the system hosting Red Hat Enterprise Virtualization Manager as the root user.
Procedure 19.3. Updating Red Hat Enterprise Virtualization Manager Reports
- Use the
yumcommand to update the rhevm-reports and rhevm-dwh packages.# yum update -y rhevm-reports rhevm-dwh
- Run the
rhevm-dwh-setupcommand to update theovirt_engine_historydatabase.# rhevm-dwh-setup
- Run the
rhevm-reports-setupcommand to update the reporting engine.# rhevm-reports-setup
Result
You have successfully updated the Red Hat Enterprise Virtualization Manager Reports.
19.1.4. Updating Red Hat Enterprise Virtualization Hypervisors
Summary
Updating Red Hat Enterprise Virtualization Hypervisors involves reinstalling the Hypervisor with a newer version of the Hypervisor ISO image. This includes stopping and restarting the Hypervisor. Virtual machines are automatically migrated to a different host, as a result it is recommended that Hypervisor updates are performed at a time when the host's usage is relatively low.
It is recommended that administrators update Red Hat Enterprise Virtualization Hypervisors regularly. Important bug fixes and security updates are included in updates. Hypervisors which are not up to date may be a security risk.
Warning
Upgrading Hypervisor hosts involves shutting down, deactivating guests, and restarting the physical server. If any virtual machines are running on the Hypervisor, all data and configuration details may be destroyed if they are not shut down. Upgrading Hypervisors must be carefully planned and executed with care and consideration.
Important
Ensure that the cluster contains more than one host before performing an upgrade. Do not attempt to re-install or upgrade all the hosts at the same time, as one host must remain available to perform Storage Pool Manager (SPM) tasks.
Procedure 19.4. Updating Red Hat Enterprise Virtualization Hypervisors
- Log in to the system hosting Red Hat Enterprise Virtualization Manager as the
rootuser. - Ensure that:
- the system is subscribed to the
Red Hat Enterprise Virtualizationentitlement — if using certificate-based Red Hat Network; or - the system is subscribed to the
Red Hat Enterprise Virtualization Hypervisor (v.6 x86-64)(labeledrhel-x86_64-server-6-rhevh) — if using classic Red Hat Network.
- Run the
yumcommand with theupdaterhev-hypervisor6parameters to ensure that you have the most recent version of the rhev-hypervisor6 package installed.# yum update rhev-hypervisor6
- Use your web browser to log in to the Administration Portal as a Red Hat Enterprise Virtualization administrative user.
- Click the Hosts tab, and then select the host that you intend to upgrade. If the host is not displayed, or the list of hosts is too long to filter visually, perform a search to locate the host.
- With the host selected, click the General tab on the Details pane.
- If the host requires updating, an alert message indicates that a new version of the Red Hat Enterprise Virtualization Hypervisor is available.
- If the host does not require updating, no alert message is displayed and no further action is required.
- Ensure the host remains selected and click the Maintenance button, if the host is not already in maintenance mode. This will cause any virtual machines running on the host to be migrated to other hosts. If the host is the SPM, this function will be moved to another host. The status of the host changes as it enters maintenance mode. When the host status is
Maintenance, the message in the general tab changes, providing you with a link which when clicked will re-install or upgrade the host. - Ensure that the host remains selected, and that you are on the General tab of the the Details pane. Click the Upgrade link. The Install Host dialog box displays.
- Select
rhev-hypervisor.iso, which is symbolically linked to the most recent hypervisor image. - Click OK to update and re-install the host. The dialog closes, the details of the host are updated in the Hosts tab, and the status changes.The host status will transition through these stages:These are all expected, and each stage will take some time.
Installing,Reboot,Non Responsive, andUp.
- Once successfully updated, the host displays a status of
Up. Any virtual machines that were migrated off the host, are at this point able to be migrated back to it.Important
After a Red Hat Enterprise Virtualization Hypervisor is successfully registered to the Red Hat Enterprise Virtualization Manager and then upgraded, it may erroneously appear in the Administration Portal with the status of Install Failed. Click on the button, and the hypervisor will change to an Up status and be ready for use.
Result
You have successfully updated a Red Hat Enterprise Virtualization Hypervisor. Repeat these steps for each Hypervisor in the Red Hat Enterprise Virtualization environment.
19.1.5. Updating Red Hat Enterprise Linux Virtualization Hosts
Summary
Red Hat Enterprise Linux virtualization hosts are updated the same way as regular Red Hat Enterprise Linux systems, using yum. It is highly recommended that you use yum to update your systems regularly, to ensure timely application of security and bug fixes. All steps in this task must be run while logged into the Red Hat Enterprise Linux virtualization host as the root user.
Procedure 19.5. Updating Red Hat Enterprise Linux Virtualization Hosts
- On the administration portal, navigate to the Hosts tab and select the host to be updated. Click to place it into maintenance mode.
- On the Red Hat Enterprise Linux virtualization host, run the
yumcommand with theupdateparameter to update all installed packages.# yum update
- If a package such as the kernel was updated, you must reboot the host to get the new functionality. If a package such as VDSM or libvirt was updated, you must restart that service to get the new functionality. Moreover, if the libvirt package is updated, you must restart the
VDSMservice.
Result
You have successfully updated the Red Hat Enterprise Linux virtualization host. Repeat this process for each Red Hat Enterprise Linux virtualization host in the Red Hat Enterprise Virtualization environment.
19.1.6. Updating the Red Hat Enterprise Virtualization Guest Tools
Summary
The guest tools allow the Manager to communicate with running guests, providing information such as IP addresses, memory usage, and installed applications for display in the Administration Portal. The guest tools are distributed as an ISO file that can be attached to guests. The ISO file is packaged as an RPM file, that can be installed and upgraded on registered Red Hat Enterprise Virtualization Manager servers.
Procedure 19.6. Updating the Red Hat Enterprise Virtualization Guest Tools
- On the Manager, as root user, use the
yum upgradeto upgrade therhev-guest-tools-isopackage.# yum update -y rhev-guest-tools-iso*
- When the
rhev-guest-tools-isopackage has been successfully upgraded, use theengine-iso-uploadercommand to upload it to your ISO storage domain. Replace [ISODomain] with the name of your ISO storage domain.engine-iso-uploader --iso-domain=[ISODomain] upload /usr/share/rhev-guest-tools-iso/rhev-tools-setup.iso
Therhev-tools-setup.isofile is actually a link to the most recently updated ISO file. The link is automatically changed to point to the newest ISO file every time you upgrade therhev-guest-tools-isopackage. - Using the web portal or REST API, attach the rhev-tools-setup.iso file to each of your guests, and from within each guest, upgrade the tools installed on each guest using the installer on the ISO.
Result
You've updated your rhev-tools-setup.iso file, uploaded the updated ISO to your ISO storage domain, and attached it to your virtual machines.
19.2. Upgrading to Red Hat Enterprise Virtualization 3.3
19.2.1. Red Hat Enterprise Virtualization Manager 3.3 Upgrade Overview
Upgrading Red Hat Enterprise Virtualization Manager is a straightforward process that comprises three main steps:
The command used to perform the upgrade itself is
- Configuring channels and entitlements.
- Updating the required packages.
- Performing the upgrade.
engine-setup, which provides an interactive interface. While the upgrade is in process, virtualization hosts and the virtual machines running on those virtualization hosts continue to operate independently. When the upgrade is complete, you can then upgrade your hosts to the latest versions of Red Hat Enterprise Linux or Red Hat Enterprise Virtualization Hypervisor.
19.2.2. Red Hat Enterprise Virtualization 3.3 Upgrade Considerations
The following is a list of key considerations that must be made when planning your upgrade.
Important
- Upgrading to version 3.3 can only be performed from version 3.2
- Users of Red Hat Enterprise Virtualization 3.1 must migrate to Red Hat Enterprise Virtualization 3.2 before attempting to upgrade to Red Hat Enterprise Virtualization 3.3.
- Red Hat Enterprise Virtualization Manager cannot be installed on the same machine as IPA
- An error message displays if the ipa-server package is installed. Red Hat Enterprise Virtualization Manager 3.3 does not support installation on the same machine as Identity Management (IdM). To resolve this issue, you must migrate the IdM configuration to another system before re-attempting the upgrade. For further information, see https://access.redhat.com/knowledge/articles/233143.
Error: IPA was found to be installed on this machine. Red Hat Enterprise Virtualization Manager 3.3 does not support installing IPA on the same machine. Please remove ipa packages before you continue.
- Upgrading to JBoss Enterprise Application Platform 6.1.0 is recommended
- Although Red Hat Enterprise Virtualization Manager 3.3 supports Enterprise Application Platform 6.0.1, upgrading to the latest supported version of JBoss is recommended. For more information on upgrading to JBoss Enterprise Application Platform 6.1.0, see Upgrade the JBoss EAP 6 RPM Installation.
- The rhevm-upgrade command has been replaced by engine-setup
- From Version 3.3, installation of Red Hat Enterprise Virtualization Manager supports
otopi, a standalone, plug-in-based installation framework for setting up system components. Under this framework, therhevm-upgradecommand used during the installation process has been updated toengine-setupand is now obsolete.
19.2.3. Upgrading to Red Hat Enterprise Virtualization Manager 3.3
Summary
The following procedure outlines the process for upgrading Red Hat Enterprise Virtualization Manager 3.2 to Red Hat Enterprise Virtualization Manager 3.3. This procedure assumes that the system on which the Manager is hosted is subscribed to the channels and entitlements for receiving Red Hat Enterprise Virtualization 3.2 packages.
If the upgrade fails, the
engine-setup command will attempt to roll your Red Hat Enterprise Virtualization Manager installation back to its previous state. For this reason, the channels required by Red Hat Enterprise Virtualization 3.2 must not be removed until after the upgrade is complete as outlined below. If the upgrade fails, detailed instructions display that explain how to restore your installation.
Procedure 19.7. Upgrading to Red Hat Enterprise Virtualization Manager 3.3
- Subscribe the system to the required channels and entitlements for receiving Red Hat Enterprise Virtualization Manager 3.3 packages.Subscription ManagerRed Hat Enterprise Virtualization 3.3 packages are provided by the
rhel-6-server-rhevm-3.3-rpmsrepository associated with theRed Hat Enterprise Virtualizationentitlement. Use theyum-config-managercommand to enable the repository in youryumconfiguration.# yum-config-manager --enable rhel-6-server-rhevm-3.3-rpms
Red Hat Network ClassicThe Red Hat Enterprise Virtualization 3.3 packages are provided by theRed Hat Enterprise Virtualization Manager (v.3.3 x86_64)channel, also referred to asrhel-x86_64-server-6-rhevm-3.3in Red Hat Network Classic. Use therhn-channelcommand or the Red Hat Network web interface to subscribe to theRed Hat Enterprise Virtualization Manager (v.3.3 x86_64)channel:# rhn-channel --add --channel=rhel-x86_64-server-6-rhevm-3.3
- Update the rhevm-setup package to ensure you have the most recent version of
engine-setup.# yum update rhevm-setup
- Run the
engine-setupcommand and follow the prompts to upgrade Red Hat Enterprise Virtualization Manager.# engine-setup [ INFO ] Stage: Initializing Welcome to the RHEV 3.3.0 upgrade. Please read the following knowledge article for known issues and updated instructions before proceeding with the upgrade. RHEV 3.3.0 Upgrade Guide: Tips, Considerations and Roll-back Issues https://access.redhat.com/site/articles/408623 Would you like to continue with the upgrade? (Yes, No) [Yes]: - Remove Red Hat Enterprise Virtualization Manager 3.2 channels and entitlements to ensure the system does not use any Red Hat Enterprise Virtualization Manager 3.2 packages.Subscription ManagerUse the
yum-config-managercommand to disable the Red Hat Enterprise Virtualization 3.2 repository in youryumconfiguration.# yum-config-manager --disable rhel-6-server-rhevm-3.2-rpms
Red Hat Network ClassicUse therhn-channelcommand or the Red Hat Network web interface to remove theRed Hat Enterprise Virtualization Manager (v.3.2 x86_64)channels.# rhn-channel --remove --channel=rhel-x86_64-server-6-rhevm-3.2
- Run the following command to ensure all packages related to Red Hat Enterprise Virtualization are up to date:
# yum update
In particular, if you are using the JBoss Application Server from JBoss Enterprise Application Platform 6.0.1, you must run the above command to upgrade to Enterprise Application Platform 6.1.
Result
Red Hat Enterprise Virtualization Manager has been upgraded. To take full advantage of all Red Hat Enterprise Virtualization 3.3 features you must also:
- Ensure all of your virtualization hosts are up to date and running the most recent Red Hat Enterprise Linux packages or Hypervisor images.
- Change all of your clusters to use compatibility version 3.3.
- Change all of your data centers to use compatibility version 3.3.
19.3. Upgrading to Red Hat Enterprise Virtualization Manager 3.2
19.3.1. Upgrading to Red Hat Enterprise Virtualization Manager 3.2
Summary
Upgrading Red Hat Enterprise Virtualization Manager to version 3.2 is performed using the rhevm-upgrade command. Virtualization hosts, and the virtual machines running upon them, will continue to operate independently while the Manager is being upgraded. Once the Manager upgrade is complete you will be able to upgrade your hosts, if you haven't already, to the latest versions of Red Hat Enterprise Linux and Red Hat Enterprise Virtualization Hypervisor.
Important
Users of Red Hat Enterprise Virtualization 3.0 must migrate to Red Hat Enterprise Virtualization 3.1 before attempting this upgrade.
Note
In the event that the upgrade fails the
rhevm-upgrade command will attempt to roll your Red Hat Enterprise Virtualization Manager installation back to its previous state. Where this also fails detailed instructions for manually restoring the installation are displayed.
Procedure 19.8. Upgrading to Red Hat Enterprise Virtualization Manager 3.2
Add Red Hat Enterprise Virtualization 3.2 Subscription
Ensure that the system is subscribed to the required channels and entitlements to receive Red Hat Enterprise Virtualization Manager 3.2 packages. This procedure assumes that the system is already subscribed to required channels and entitlements to receive Red Hat Enterprise Virtualization 3.1 packages. These must also be available to complete the upgrade process.Certificate-based Red Hat NetworkThe Red Hat Enterprise Virtualization 3.2 packages are provided by therhel-6-server-rhevm-3.2-rpmsrepository associated with theRed Hat Enterprise Virtualizationentitlement. Use theyum-config-managercommand to enable the repository in youryumconfiguration. Theyum-config-managercommand must be run while logged in as therootuser.# yum-config-manager --enable rhel-6-server-rhevm-3.2-rpms
Red Hat Network ClassicThe Red Hat Enterprise Virtualization 3.2 packages are provided by theRed Hat Enterprise Virtualization Manager (v.3.2 x86_64)channel, also referred to asrhel-x86_64-server-6-rhevm-3.2in Red Hat Network Classic.rhn-channel --add --channel=rhel-x86_64-server-6-rhevm-3.2
Use therhn-channelcommand, or the Red Hat Network Web Interface, to subscribe to theRed Hat Enterprise Virtualization Manager (v.3.2 x86_64)channel.Remove Enterprise Virtualization 3.1 Subscription
Ensure that the system does not use any Red Hat Enterprise Virtualization Manager 3.1 packages by removing the Red Hat Enterprise Vitulization Manager 3.1 channels and entitlements.Certificate-based Red Hat NetworkUse theyum-config-managercommand to disable the Red Hat Enterprise Virtualization 3.1 repository in youryumconfiguration. Theyum-config-managercommand must be run while logged in as therootuser.# yum-config-manager --disablerepo=rhel-6-server-rhevm-3.1-rpms
Red Hat Network ClassicUse therhn-channelcommand, or the Red Hat Network Web Interface, to remove theRed Hat Enterprise Virtualization Manager (v.3.1 x86_64)channels.# rhn-channel --remove --channel=rhel-6-server-rhevm-3.1
Update the rhevm-setup Package
To ensure that you have the most recent version of therhevm-upgradecommand installed you must update the rhevm-setup package. Log in as therootuser and useyumto update the rhevm-setup package.# yum update rhevm-setup
Run the
rhevm-upgradeCommandTo upgrade Red Hat Enterprise Virtualization Manager run therhevm-upgradecommand. You must be logged in as therootuser to run this command.# rhevm-upgrade Loaded plugins: product-id, rhnplugin Info: RHEV Manager 3.1 to 3.2 upgrade detected Checking pre-upgrade conditions...(This may take several minutes)
- If the ipa-server package is installed then an error message is displayed. Red Hat Enterprise Virtualization Manager 3.2 does not support installation on the same machine as Identity Management (IdM).
Error: IPA was found to be installed on this machine. Red Hat Enterprise Virtualization Manager 3.2 does not support installing IPA on the same machine. Please remove ipa packages before you continue.
To resolve this issue you must migrate the IdM configuration to another system before re-attempting the upgrade. For further information see https://access.redhat.com/knowledge/articles/233143.
Result
Your Red Hat Enterprise Virtualization Manager installation has now been upgraded. To take full advantage of all Red Hat Enterprise Virtualization 3.2 features you must also:
- Ensure that all of your virtualization hosts are up to date and running the most recent Red Hat Enterprise Linux packages or Hypervisor images.
- Change all of your clusters to use compatibility version 3.2.
- Change all of your data centers to use compatibility version 3.2.
19.4. Upgrading to Red Hat Enterprise Virtualization Manager 3.1
19.4.1. Upgrading to Red Hat Enterprise Virtualization Manager 3.1
Summary
Upgrading Red Hat Enterprise Virtualization Manager to version 3.1 is performed using the rhevm-upgrade command. Virtualization hosts, and the virtual machines running upon them, will continue to operate independently while the Manager is being upgraded. Once the Manager upgrade is complete you will be able to upgrade your hosts, if you haven't already, to the latest versions of Red Hat Enterprise Linux and Red Hat Enterprise Virtualization Hypervisor.
Important
Refer to https://access.redhat.com/knowledge/articles/269333 for an up to date list of tips and considerations to be taken into account when upgrading to Red Hat Enterprise Virtualization 3.1.
Important
Users of Red Hat Enterprise Virtualization 2.2 must migrate to Red Hat Enterprise Virtualization 3.0 before attempting this upgrade. For information on migrating from Red Hat Enterprise Virtualization 2.2 to Red Hat Enterprise Virtualization 3.0, refer to https://access.redhat.com/knowledge/techbriefs/migrating-red-hat-enterprise-virtualization-manager-version-22-30.
Note
In the event that the upgrade fails the
rhevm-upgrade command will attempt to roll your Red Hat Enterprise Virtualization Manager installation back to its previous state. Where this also fails detailed instructions for manually restoring the installation are displayed.
Procedure 19.9. Upgrading to Red Hat Enterprise Virtualization Manager 3.1
Red Hat JBoss Enterprise Application Platform 6 Subscription
Ensure that the system is subscribed to the required channels and entitlements to receive Red Hat JBoss Enterprise Application Platform 6 packages. Red Hat JBoss Enterprise Application Platform 6 is a required dependency of Red Hat Enterprise Virtualization Manager 3.1.Certificate-based Red Hat NetworkThe Red Hat JBoss Enterprise Application Platform 6 packages are provided by theRed Hat JBoss Enterprise Application Platformentitlement in certificate-based Red Hat Network.Use thesubscription-managercommand to ensure that the system is subscribed to theRed Hat JBoss Enterprise Application Platformentitlement.# subscription-manager list
Red Hat Network ClassicThe Red Hat JBoss Enterprise Application Platform 6 packages are provided by theRed Hat JBoss Application Platform (v 6) for 6Server x86_64channel, also referred to asjbappplatform-6-x86_64-server-6-rpm, in Red Hat Network Classic. The Channel Entitlement Name for this channel isRed Hat JBoss Enterprise Application Platform (v 4, zip format).Use therhn-channelcommand, or the Red Hat Network Web Interface, to subscribe to theRed Hat JBoss Application Platform (v 6) for 6Server x86_64channel.Add Red Hat Enterprise Virtualization 3.1 Subscription
Ensure that the system is subscribed to the required channels and entitlements to receive Red Hat Enterprise Virtualization Manager 3.1 packages.Certificate-based Red Hat NetworkThe Red Hat Enterprise Virtualization 3.1 packages are provided by therhel-6-server-rhevm-3.1-rpmsrepository associated with theRed Hat Enterprise Virtualizationentitlement. Use theyum-config-managercommand to enable the repository in youryumconfiguration. Theyum-config-managercommand must be run while logged in as therootuser.# yum-config-manager --enable rhel-6-server-rhevm-3.1-rpms
Red Hat Network ClassicThe Red Hat Enterprise Virtualization 3.1 packages are provided by theRed Hat Enterprise Virtualization Manager (v.3.1 x86_64)channel, also referred to asrhel-x86_64-server-6-rhevm-3.1in Red Hat Network Classic.Use therhn-channelcommand, or the Red Hat Network Web Interface, to subscribe to theRed Hat Enterprise Virtualization Manager (v.3.1 x86_64)channel.Remove Red Hat Enterprise Virtualization 3.0 Subscription
Ensure that the system does not use any Red Hat Enterprise Virtualization Manager 3.0 packages by removing the Red Hat Enterprise Virtualization Manager 3.0 channels and entitlements.Certificate-based Red Hat NetworkUse theyum-config-managercommand to disable the Red Hat Enterprise Virtualization 3.0 repositories in youryumconfiguration. Theyum-config-managercommand must be run while logged in as therootuser.# yum-config-manager --disablerepo=rhel-6-server-rhevm-3-rpms
# yum-config-manager --disablerepo=jb-eap-5-for-rhel-6-server-rpms
Red Hat Network ClassicUse therhn-channelcommand, or the Red Hat Network Web Interface, to remove theRed Hat Enterprise Virtualization Manager (v.3.0 x86_64)channels.# rhn-channel --remove --channel=rhel-6-server-rhevm-3
# rhn-channel --remove --channel=jbappplatform-5-x86_64-server-6-rpm
Update the rhevm-setup Package
To ensure that you have the most recent version of therhevm-upgradecommand installed you must update the rhevm-setup package. Log in as therootuser and useyumto update the rhevm-setup package.# yum update rhevm-setup
Run the
rhevm-upgradeCommandTo upgrade Red Hat Enterprise Virtualization Manager run therhevm-upgradecommand. You must be logged in as therootuser to run this command.# rhevm-upgrade Loaded plugins: product-id, rhnplugin Info: RHEV Manager 3.0 to 3.1 upgrade detected Checking pre-upgrade conditions...(This may take several minutes)
- If the ipa-server package is installed then an error message is displayed. Red Hat Enterprise Virtualization Manager 3.1 does not support installation on the same machine as Identity Management (IdM).
Error: IPA was found to be installed on this machine. Red Hat Enterprise Virtualization Manager 3.1 does not support installing IPA on the same machine. Please remove ipa packages before you continue.
To resolve this issue you must migrate the IdM configuration to another system before re-attempting the upgrade. For further information see https://access.redhat.com/knowledge/articles/233143. - A list of packages that depend on Red Hat JBoss Enterprise Application Platform 5 is displayed. These packages must be removed to install Red Hat JBoss Enterprise Application Platform 6, required by Red Hat Enterprise Virtualization Manager 3.1.
Warning: the following packages will be removed if you proceed with the upgrade: * objectweb-asm Would you like to proceed? (yes|no):You must enteryesto proceed with the upgrade, removing the listed packages.
Result
Your Red Hat Enterprise Virtualization Manager installation has now been upgraded. To take full advantage of all Red Hat Enterprise Virtualization 3.1 features you must also:
- Ensure that all of your virtualization hosts are up to date and running the most recent Red Hat Enterprise Linux packages or Hypervisor images.
- Change all of your clusters to use compatibility version 3.1.
- Change all of your data centers to use compatibility version 3.1.
See Also:
19.5. Post-upgrade Tasks
19.5.1. Features Requiring a Compatibility Upgrade to Red Hat Enterprise Virtualization 3.3
Some of the new features in Red Hat Enterprise Virtualization are only available if your data centers, clusters, and storage have a compatibility version of 3.3.
Table 19.1. Features Requiring a Compatibility Upgrade to Red Hat Enterprise Virtualization 3.3
| Feature | Description |
|---|---|
|
Libvirt-to-libvirt virtual machine migration
|
Perform virtual machine migration using libvirt-to-libvirt communication. This is safer, more secure, and has less host configuration requirements than native KVM migration, but has a higher overhead on the host CPU.
|
|
Isolated network to carry virtual machine migration traffic
|
Separates virtual machine migration traffic from other traffic types, like management and display traffic. Reduces chances of migrations causing a network flood that disrupts other important traffic types.
|
|
Define a gateway per logical network
|
Each logical network can have a gateway defined as separate from the management network gateway. This allows more customizable network topologies.
|
|
Snapshots including RAM
|
Snapshots now include the state of a virtual machine's memory as well as disk.
|
|
Optimized iSCSI device driver for virtual machines
|
Virtual machines can now consume iSCSI storage as virtual hard disks using an optimized device driver.
|
|
Host support for MOM management of memory overcommitment
|
MOM is a policy-driven tool that can be used to manage overcommitment on hosts. Currently MOM supports control of memory ballooning and KSM.
|
|
GlusterFS data domains.
|
Native support for the GlusterFS protocol was added as a way to create storage domains, allowing Gluster data centers to be created.
|
|
Custom device property support
|
In addition to defining custom properties of virtual machines, you can also define custom properties of virtual machine devices.
|
|
Multiple monitors using a single virtual PCI device
|
Drive multiple monitors using a single virtual PCI device, rather than one PCI device per monitor.
|
|
Updatable storage server connections
|
It is now possible to edit the storage server connection details of a storage domain.
|
|
Check virtual hard disk alignment
|
Check if a virtual disk, the filesystem installed on it, and its underlying storage are aligned. If it is not aligned, there may be a performance penalty.
|
|
Extendable virtual machine disk images
|
You can now grow your virtual machine disk image when it fills up.
|
|
OpenStack Image Service integration
|
Red Hat Enterprise Virtualization supports the OpenStack Image Service. You can import images from and export images to an Image Service repository.
|
|
Gluster hook support
|
You can manage Gluster hooks, which extend volume life cycle events, from Red Hat Enterprise Virtualization Manager.
|
|
Gluster host UUID support
|
This feature allows a Gluster host to be identified by the Gluster server UUID generated by Gluster in addition to identifying a Gluster host by IP address.
|
|
Network quality of service (QoS) support
|
Limit the inbound and outbound network traffic at the virtual NIC level.
|
|
Cloud-Init support
|
Cloud-Init allows you to automate early configuration tasks in your virtual machines, including setting hostnames, authorized keys, and more.
|
19.5.2. Changing the Cluster Compatibility Version
Prerequisites:
Summary
Red Hat Enterprise Virtualization clusters have a compatibility version. The cluster compatibility version indicates the features of Red Hat Enterprise Virtualization supported by all of the hosts in the cluster. The cluster compatibility is set according to the version of the least capable host operating system in the cluster.
Note
To change the cluster compatibility version, you must have first updated all the hosts in your cluster to a level that supports your desired compatibility level.
Procedure 19.10. Changing the Cluster Compatibility Version
- Log in to the Administration Portal as the administrative user. By default this is the
adminuser. - Click the Clusters tab.
- Select the cluster that you wish to change from the list displayed. If the list of clusters is too long to filter visually then perform a search to locate the desired cluster.
- Click the button.
- Change the Compatibility Version to the desired value.
- Click .
Result
You have updated the compatibility version of the cluster. Once you have updated the compatibility version of all clusters in a data center, then you are also able to change the compatibility version of the data center itself.
19.5.3. Changing the Data Center Compatibility Version
Prerequisites:
Summary
Red Hat Enterprise Virtualization data centers have a compatibility version. The compatibility version indicates the version of Red Hat Enterprise Virtualization that the data center is intended to be compatible with. All clusters in the data center must support the desired compatibility level.
Procedure 19.11. Changing the Data Center Compatibility Version
- Log in to the Administration Portal as the administrative user. By default this is the
adminuser. - Click the Data Centers tab.
- Select the data center that you wish to change from the list displayed. If the list of data centers is too long to filter visually then perform a search to locate the desired data center.
- Click the button.
- Change the Compatibility Version to the desired value.
- Click .
Result
You have updated the compatibility version of the data center.
Chapter 20. Backups
20.1. Backing Up and Restoring the Red Hat Enterprise Virtualization Manager
- 20.1.1. Backing up Red Hat Enterprise Virtualization Manager - Overview
- 20.1.2. Syntax for the engine-backup Command
- 20.1.3. Creating a Backup with the engine-backup Command
- 20.1.4. Restoring a Backup with the engine-backup Command
- 20.1.5. Restoring a Backup to a Fresh Installation
- 20.1.6. Restoring a Backup to Overwrite an Existing Installation
- 20.1.7. Restoring a Backup with Different Credentials
20.1.1. Backing up Red Hat Enterprise Virtualization Manager - Overview
While taking complete backups of the machine on which the Red Hat Enterprise Virtualization Manager is installed is recommended whenever changing the configuration of that machine, a utility is provided for backing up only the key files related to the Manager. This utility - the
engine-backup command - can be used to rapidly back up the engine database and configuration files into a single file that can be easily stored.
20.1.2. Syntax for the engine-backup Command
The
engine-backup command works in one of two basic modes:
# engine-backup --mode=backup
# engine-backup --mode=restore
These two modes are further extended by a set of parameters that allow you to specify the scope of the backup and different credentials for the engine database. A full list of parameters and their function is as follows:
Basic Options
--mode- Specifies whether the command will perform a backup operation or a restore operation. Two options are available -
backup, andrestore. This is a required parameter. --file- Specifies the path and name of a file into which backups are to be taken in backup mode, and the path and name of a file from which to read backup data in restore mode. This is a required parameter in both backup mode and restore mode.
--log- Specifies the path and name of a file into which logs of the backup or restore operation are to be written. This parameter is required in both backup mode and restore mode.
--scope- Specifies the scope of the backup or restore operation. There are two options -
all, which backs up both the engine database and configuration data, anddb, which backs up only the engine database.
Database Options
The following options are only available when using the
engine-backup command in restore mode.
--change-db-credentials- Allows you to specify alternate credentials for restoring the engine database using credentials other than those stored in the backup itself. Specifying this parameter allows you to add the following parameters.
--db-host- Specifies the IP address or fully qualified domain name of the host on which the database resides. This is a required parameter.
--db-port- Specifies the port by which a connection to the database will be made.
--db-user- Specifies the name of the user by which a connection to the database will be made. This is a required parameter.
--db-passfile- Specifies a file containing the password by which a connection to the database will be made. Either this parameter or the
--db-passwordparameter must be specified. --db-password- Specifies the plain text password by which a connection to the database will be made. Either this parameter or the
--db-passfileparameter must be specified. --db-name- Specifies the name of the database to which the database will be restored. This is a required parameter.
--db-secured- Specifies that the connection with the database is to be secured.
--db-secured-validation- Specifies that the connection with the host is to be validated.
Help
--help- Provides an overview of the available modes, parameters, sample usage, how to create a new database and configure the firewall in conjunction with backing up and restoring the Red Hat Enterprise Virtualization Manager.
20.1.3. Creating a Backup with the engine-backup Command
Summary
The process for creating a backup of the engine database and the configuration data for the Red Hat Enterprise Virtualization Manager using the engine-backup command is straightforward and can be performed while the Manager is active.
Procedure 20.1. Backing up the Red Hat Enterprise Virtualization Manager
- Log on to the machine running the Red Hat Enterprise Virtualization Manager.
- Run the following command to create a full backup:Alternatively, run the following command to back up only the engine database:
Example 20.1. Creating a Full Backup
# engine-backup --scope=all --mode=backup --log=[file name] --file=[file name]
Example 20.2. Creating an engine database Backup
# engine-backup --scope=db --mode=backup --log=[file name] --file=[file name]
Result
A tar file containing a backup of the engine database, or the engine database and the configuration data for the Red Hat Enterprise Virtualization Manager, is created using the path and file name provided.
20.1.4. Restoring a Backup with the engine-backup Command
While the process for restoring a backup using the
engine-backup command is straightforward, it involves several additional steps in comparison to that for creating a backup depending on the destination to which the backup is to be restored. For example, the engine-backup command can be used to restore backups to fresh installations of Red Hat Enterprise Virtualization, on top of existing installations of Red Hat Enterprise Virtualization, and using local or remote databases.
Important
Backups can only be restored to environments of the same major release as that of the backup. For example, a backup of a Red Hat Enterprise Virtualization version 3.3 environment can only be restored to another Red Hat Enterprise Virtualization version 3.3 environment. To view the version of Red Hat Enterprise Virtualization contained in a backup file, unpack the backup file and read the value in the
version file located in the root directory of the unpacked files.
20.1.5. Restoring a Backup to a Fresh Installation
Summary
The engine-backup command can be used to restore a backup to a fresh installation of the Red Hat Enterprise Virtualization Manager. The following procedure must be performed on a machine on which the base operating system has been installed and the required packages for the Red Hat Enterprise Virtualization Manager have been installed, but the engine-setup command has not yet been run. This procedure assumes that the backup file can be accessed from the machine on which the backup is to be restored.
Note
The
engine-backup command does not handle the actual creation of the engine database or the initial configuration of the postgresql service. Therefore, these tasks must be performed manually as outlined below when restoring a backup to a fresh installation.
Procedure 20.2. Restoring a Backup to a Fresh Installation
- Log on to the machine on which the Red Hat Enterprise Virtualization Manager is installed.
- Manually create an empty database to which the database in the backup can be restored and configure the
postgresqlservice:- Run the following commands to initialize the
postgresqldatabase, start thepostgresqlservice and ensure this service starts on boot:# service postgresql initdb # service postgresql start # chkconfig postgresql on
- Run the following commands to enter the postgresql command line:
# su postgres $ psql
- Run the following command to create a new user:
postgres=# create role [user name] with login encrypted password '[password]';
- Run the following command to create the new database:
postgres=# create database [database name] owner [user name] template template0 encoding 'UTF8' lc_collate 'en_US.UTF-8' lc_ctype 'en_US.UTF-8';
- Edit the
/var/lib/pgsql/data/pg_hba.conffile as follows:- For local databases, add the two following lines immediately underneath the line starting with
Localat the bottom of the file:host [database name] [user name] 0.0.0.0/0 md5 host [database name] [user name] ::0/0 md5
- For remote databases, add the following line immediately underneath the line starting with
Localat the bottom of the file, replacing X.X.X.X with the IP address of the Manager:host [database name] [user name] X.X.X.X/32 md5
- Run the following command to restart the
postgresqlservice:# service postgresql restart
- Restore the backup using the
engine-backupcommand with the--change-db-credentialsparameter to pass the credentials of the new database:# engine-backup --mode=restore --file=[file name] --log=[file name] --change-db-credentials --db-host=[database location] --db-name=[database name] --db-user=[user name] --db-password=[password]
If successful, the following output displays:Restoring... Note: you might need to manually fix: - iptables/firewalld configuration - autostart of ovirt-engine service You can now start the engine service and then restart httpd Done.
- Run the following command and follow the prompts to configure the Manager, selecting to manually configure the database when prompted:
# engine-setup
Result
The engine database and configuration files for the Red Hat Enterprise Virtualization Manager have been restored to the version in the backup.
20.1.6. Restoring a Backup to Overwrite an Existing Installation
Summary
The engine-backup command can restore a backup to a machine on which the Red Hat Enterprise Virtualization Manager has already been installed and set up. This is useful when you have taken a backup up an installation, performed changes on that installation and then want to restore the installation from the backup.
Note
When restoring a backup to overwrite an existing installation, you must run the
engine-cleanup command to clean up the existing installation before using the engine-backup command. Because the engine-backup command only cleans the engine database, and does not drop the database or delete the user that owns that database, you do not need to create a new database or specify the database credentials because the user and database already exist.
Procedure 20.3. Restoring a Backup to Overwrite an Existing Installation
- Log on to the machine on which the Red Hat Enterprise Virtualization Manager is installed.
- Run the following command and follow the prompts to remove the configuration files for and clean the database associated with the Manager:
# engine-cleanup
- Restore the backup using the
engine-backupcommand:# engine-backup --mode=restore --file=[file name] --log=[file name]
If successful, the following output displays:Restoring... Note: you might need to manually fix: - iptables/firewalld configuration - autostart of ovirt-engine service You can now start the engine service and then restart httpd Done.
- Run the following command and follow the prompts to re-configure the firewall and ensure the
ovirt-engineservice is correctly configured:# engine-setup
Result
The engine database and configuration files for the Red Hat Enterprise Virtualization Manager have been restored to the version in the backup.
20.1.7. Restoring a Backup with Different Credentials
Summary
The engine-backup command can restore a backup to a machine on which the Red Hat Enterprise Virtualization Manager has already been installed and set up, but the credentials of the database in the backup are different to those of the database on the machine on which the backup is to be restored. This is useful when you have taken a backup of an installation and want to restore the installation from the backup to a different system.
Important
When restoring a backup to overwrite an existing installation, you must run the
engine-cleanup command to clean up the existing installation before using the engine-backup command. Because the engine-backup command only cleans the engine database, and does not drop the database or delete the user that owns that database, you do not need to create a new database or specify the database credentials because the user and database already exist. However, if the credentials for the owner of the engine database are not known, you must change them before you can restore the backup.
Procedure 20.4. Restoring a Backup with Different Credentials
- Log on to the machine on which the Red Hat Enterprise Virtualization Manager is installed.
- Run the following command and follow the prompts to remove the configuration files for and clean the database associated with the Manager:
# engine-cleanup
- Change the password for the owner of the engine database if the credentials of that user are not known:
- Run the following commands to enter the postgresql command line:
# su postgres $ psql
- Run the following command to change the password of the user that owns the engine database:
postgres=# alter role [user name] encrypted password '[new password]';
- Restore the backup using the
engine-backupcommand with the--change-db-credentialsparameter:# engine-backup --mode=restore --file=[file name] --log=[file name] --change-db-credentials --db-host=[database location] --db-name=[database name] --db-user=[user name] --db-password=[password]
If successful, the following output displays:Restoring... Note: you might need to manually fix: - iptables/firewalld configuration - autostart of ovirt-engine service You can now start the engine service and then restart httpd Done.
- Run the following command and follow the prompts to re-configure the firewall and ensure the
ovirt-engineservice is correctly configured:# engine-setup
Result
The engine database and configuration files for the Red Hat Enterprise Virtualization Manager have been restored to the version in the backup using the supplied credentials, and the Manager has been configured to use the new database.
20.2. Manually Backing Up and Restoring the Red Hat Enterprise Virtualization Manager
- 20.2.1. Backing Up the Engine Database Using the backup.sh Script
- 20.2.2. Backing Up Manager Configuration Files
- 20.2.3. What is a complete backup of the Red Hat Enterprise Virtualization Manager?
- 20.2.4. Configuring Red Hat Enterprise Virtualization Manager
- 20.2.5. Restoring the Engine Database Using the restore.sh Script
- 20.2.6. Restoring Red Hat Enterprise Virtualization Manager Configuration Files
20.2.1. Backing Up the Engine Database Using the backup.sh Script
Summary
The Red Hat Enterprise Virtualization Manager includes a script to automate database backups. Using this script on your Manager server, you can protect yourself against potential data loss.
Important
If your environment was upgraded from Red Hat Enterprise Virtualization 3.0, please see KB337653 for additional information about backing up and restoring your database.
Procedure 20.5. Backing up the engine database using the backup.sh script
- Change into the
/usr/share/ovirt-engine/dbscripts/directory. - Invoke
backup.shwith the-hparameter to see the available options.Usage: backup.sh [-h] [-s SERVERNAME] [-p PORT] [-d DATABASE] [-l DIR] -u USERNAME [-v] -s SERVERNAME - The database servername for the database (def. localhost) -p PORT - The database port for the database (def. 5432) -d DATABASE - The database name (def. engine) -u USERNAME - The username for the database. -v - Turn on verbosity (WARNING: lots of output) -l DIR - Backup file directory. -h - This help text. for more options please run pg_dump --help
- Invoke the
backup.shcommand again with parameters appropriate for your environment. If you are backing up the localenginedatabase, the-s, -p,and-dparameters are not necessary. Use the-lto specify the backup directory. This will cause a.sqlfile to be created in the directory you give. - Copy the
.sqlyou just created from the directory you specified to a safe remote location.
Result
You have used the backup.sh script to backup your engine database.
20.2.2. Backing Up Manager Configuration Files
The Red Hat Enterprise Virtualization Manager stores customized configurations as configuration files. These files contain specific configuration details of a given environment, and must also be backed up if a recovery is to be performed.
Important
If your environment was upgraded from Red Hat Enterprise Virtualization 3.0, please see KB340903 for additional information about backing up and restoring your configuration files.
Table 20.1. Configuration files and directories requiring backup.
| Location | What is it? |
|---|---|
| /etc/ovirt-engine/ | Contains Red Hat Enterprise Virtualization Manager configuration files. |
| /etc/sysconfig/ovirt-engine | It is the ovirt-engine service configuration file. |
| /etc/yum/pluginconf.d/versionlock.list | Contains version information about currently installed Red Hat Enterprise Virtualization components. |
| /etc/pki/ovirt-engine/ | Security certificates provided by the Red Hat Enterprise Virtualization Manager to clients. |
| /usr/share/jasperreports-server-pro/buildomatic | Contains files required to build the Red Hat Enterprise Virtualization reports server. |
| /var/lib/ovirt-engine/backups | A folder where all backup data is stored. |
| /var/lib/ovirt-engine/deployments | A folder where all deployment data is stored. |
| /usr/share/ovirt-engine-reports/reports/users/rhevm-002dadmin.xml | Contains plain-text, un-encrypted user and password information for the rhev-admin user. |
| /usr/share/ovirt-engine-reports/default_master.properties | Contains settings to handle the configuration and deployment of JasperServer. |
| /root/.rnd | Random seed file, used to generate secure certificates. |
| /var/log/ovirt-engine/engine-setup_SETUPDATE.log | Contains the answers you gave to the setup configuration questions. Restoring the Manager requires running the setup again, and giving the same answers. |
When all the files in the above table have been backed up, you will be able to recover the Red Hat Enterprise Virtualization Manager to a working state after an unforeseen event.
20.2.3. What is a complete backup of the Red Hat Enterprise Virtualization Manager?
A complete backup of your Red Hat Enterprise Virtualization Manager includes your database and all of the Manager's configuration files.
Recovering with a complete back up requires you to re-install the Manager, replace it's newly created configuration files with your backed up configuration files, and replace it's newly created database with your existing database.
20.2.4. Configuring Red Hat Enterprise Virtualization Manager
Summary
Once package installation is complete the Red Hat Enterprise Virtualization Manager must be configured. The engine-setup command is provided to assist with this task. The script asks you a series of questions, the answers to which form the basis for system configuration. Once all required values have been provided the updated configuration is applied and the Red Hat Enterprise Virtualization Manager services are started.
Procedure 20.6. Configuring Red Hat Enterprise Virtualization Manager
Start setup script
To begin configuring the system runengine-setupas therootuser.# engine-setup
Stop ovirt-engine
To install Red Hat Enterprise Virtualization Manager the Red Hat JBoss Enterprise Application Platform needs to first be stopped. Stopping this service allows it to be configured for use with the Manager. Typeyesto stop the service and proceed with Manager installation.In order to proceed the installer must stop the ovirt-engine service Would you like to stop the ovirt-engine service? (yes|no): yes
Override Apache configuration
Red Hat Enterprise Virtualization uses themod_proxymodule for the Apache web server (httpd) to redirect network traffic from the HTTP and HTTPS ports which you select, to the application server that the Manager runs on. If theengine-setupscript detects an existinghttpdconfiguration then you will need to decide whether or not to override it:RHEV Manager uses httpd to proxy requests to the application server. It looks like the httpd installed locally is being actively used. The installer can override current configuration . Alternatively you can use JBoss directly (on ports higher than 1024) Do you wish to override current httpd configuration and restart the service? ['yes'| 'no'] [yes] :
- If you do not receive this message, there is no existing
httpdconfiguration on the system and the script will move to the next step. - If you do receive this message, you must:
- enter
yesif you wish to configure the Manager to listen to HTTP and/or HTTPS ports lower than port1024; or - enter
noif you do not wish to configure the Manager to listen to HTTP and/or HTTPS ports lower than port1024, leaving the existinghttpdconfiguration intact.
Set Port for HTTP
The script prompts for entry of the port to use for HTTP communication. To use the default value,80, press Enter. To use an alternative value enter it in the field, and then press Enter.HTTP Port [80] :
The port you select also appears in the URL that must be used to access the Red Hat Enterprise Virtualization Manager over HTTP.Set Port for HTTPS
The script prompts for entry of the port to use for HTTPS communication. To use the default value,443, press Enter. To use an alternative value enter it in the field, and then press Enter.HTTPS Port [443] :
Where a port other than443is selected it changes the URL that must be used to access the Red Hat Enterprise Virtualization Manager over HTTPS.Set Fully Qualified Domain Name (FQDN)
The script prompts for entry of the system's fully qualified domain name. This name should be resolvable via both forward and reverse DNS lookup. The script attempts to determine the fully qualified domain name automatically. The value identified is listed in square brackets as the default setting for the fully qualified domain name, based on your setup.Host fully qualified domain name. Note: this name should be fully resolvable [rhevm31.demo.redhat.com] :
Where the automatically determined fully qualified domain name is correct, press Enter to use the value and continue. Where the automatically determined fully qualified domain name is not correct, enter the correct value and press Enter to use the new value and continue.Your fully qualified domain name should have both forward and reverse lookup records in DNS, especially if will also install the reports server.Set Administrator Password
The script creates an authentication domain internal to the Red Hat Enterprise Virtualization Manager for the default administrative account. The domain is namedinternal, the administrative user is calledadmin. External authentication domains are added as a post-installation step using theengine-manage-domainscommand.You must choose a password for theadminuser. You will be asked to enter it a second time to confirm your selection.Password for Administrator (admin@internal) :
Set Organization Name
The script prompts for entry of the Organization Name. The Organization Name appears in theSubjectfield of the certificate used to secure communications with the Red Hat Enterprise Virtualization Manager.Organization Name for the Certificate [demo.redhat.com] :
Configure Default Storage Type
The script prompts for selection of the default storage type. This is the storage type that is used for theDefaultdata center. You are able to add further data centers that use different storage types from the Administration Portal at any time.The default storage type you will be using ['NFS'| 'FC'| 'ISCSI'| 'POSIXFS'] [NFS] :
The default selection is Network File System (NFS). The other available values are:The- POSIX compliant filesystems (
POSIXFS), - Fibre Channel (
FC), and - Internet Small Computer System Interface (
ISCSI).
POSIXFS,NFS,FC, andISCSIoptions are used to connect to remote storage.POSIXFSis especially for GlusterFS data domains, but can be used for other POSIX compliant filesystems. Red Hat Enterprise Virtualization also supports theLOCALFSstorage type which allows the use of local storage attached to the virtualization hosts. TheLOCALFSstorage type is not however a supported choice for use in theDefaultdata center.To use the default selection,NFS, press Enter. Otherwise, enter the desired value.Select database location
Red Hat Enterprise Virtualization supports the use of a local database on the management system, or a remote database provided elsewhere in your environment. The setup script prompts you to indicate whether you wish to use a local database, which is the default option, or a remote database:Enter DB type for installation ['remote'| 'local'] [local] :
- Enter
localto have the setup script create a local PostgreSQL database server for the Manager.The script prompts for entry of a password to use for the local Red Hat Enterprise Virtualization Manager database. Enter the desired password. You will be asked to enter the password again to confirm it.Database password (required for secure authentication with the locally created database) :
- Enter
remoteto have the script use a remote database server for the Manager.- You will be prompted to provide:The database server that you specify must be configured to allow remote connections. Additionally, the database user that you select must have the permissions required to create databases on the remote database server.
- the IP address or hostname of the remote database server,
- the port number on which the remote database server is listening,
- the administrative user name for the remote database server, and
- the administrative user's password.
Important
Your remote database server must have theuuid-osspPostgres extension loaded. You can load it like thispsql -U postgres -d template1 -f /usr/share/pgsql/contrib/uuid-ossp.sql
Once loaded, every subsequent database created includes the functions provided by the extension.Enter DB type for installation ['remote'| 'local'] [local] : remote Enter the host IP or host name where DB is running: database.demo.redhat.com Enter DB port number [5432] : 5432 Enter DB admin user name [postgres] : Remote database password : Confirm password :
Secure connection
You can configure Red Hat Enterprise Virtualization Manager to use a secure connection, encrypted using SSL when connecting to the remote database server. You must ensure that the remote database server is configured to support secure connections before enabling them.Configure secure connection? (make sure SSL is configured on remote database) ['yes'| 'no'] [no] :
Enteryesto use secure database connections.
The setup script will connect to the remote database server to verify the details that you provided are correct.
Configure NFS ISO Domain
The script asks whether or not an NFS share should be configured on the server and used as an ISO storage domain.Configure NFS share on this server to be used as an ISO Domain? ['yes'| 'no'] [yes] :
An ISO storage domain is used to store copies of removable media for use when provisioning and using virtual machines. The Red Hat Enterprise Virtualization Manager is able to use either an ISO storage domain on the system it is installed to or one that exists on remote storage. In either case the ISO storage domain must be accessible via NFS. The ability to configure an ISO storage domain is also available from the Administration Portal after installation.To take the default action, which is to configure an NFS share for use as an ISO storage domain, press Enter. To skip this step typenoand press Enter.If you chose to configure an NFS share then you will also need to provide both a path and a display name for it. The path is the location on the local file system where the NFS share must be created. The directory must not already exist.Local ISO domain path [/usr/local/exports/iso] :
The ISO domain will be created and exported as an NFS share. It will be shown as active in the Red Hat Enterprise Virtualization Manager once the first active virtualization host has been added to theDefaultdata center.Configure Firewall
The Red Hat Enterprise Virtualization Manager requires that network traffic on a number of ports be allowed through the system's firewall. Theengine-setupscript is able to configure this automatically, but selecting this option overrides any existing firewall configuration. Where there is an existing firewall configuration that needs to be maintained you must manually configure the firewall to include the additional rules required by the Red Hat Enterprise Virtualization Manager.The installer can configure firewall automatically overriding the current configuration. The old configuration will be backed up. Alternately you can configure the firewall later using an example file. Which firewall do you wish to configure? ['None'| 'iptables']:
- To proceed with automatic firewall configuration type
iptablesand then press Enter. - To skip automatic firewall configuration type
Noneand then press Enter. You will need to add rules equivalent to those found in/etc/ovirt-engine/iptables.exampleto youriptablesconfiguration.
Confirm Configuration
You have now provided the script with all the information required to complete configuration of the Red Hat Enterprise Virtualization Manager. The values which you entered are displayed for confirmation.Example 20.3. Configuration Confirmation Screen
RHEV Manager will be installed using the following configuration: ================================================================= override-httpd-config: yes http-port: 80 https-port: 443 host-fqdn: rhev-manager1.redhat.com auth-pass: ******** org-name: Red Hat default-dc-type: NFS db-remote-install: local db-local-pass: ******** config-nfs: no override-firewall: iptables Proceed with the configuration listed above? (yes|no): yes
- To permanently apply the configuration values listed type
yesand then press Enter to apply the configuration. - If one or more of the configuration values listed is incorrect type
noand then Enter to revisit the configuration.
The configuration values are applied. A number of services need to be started and as a result this step takes some time. Do not terminate the installation once application of the configuration values has commenced.Once the script has completed successfully take note of the additional information it provides. In particular note down theSSH Certificate fingerprint,SSH Public key fingerprint, and Red Hat Enterprise Virtualization Manager URL for your records.Example 20.4. Successful Configuration
Installing: Configuring RHEV Manager... [ DONE ] Configuring JVM... [ DONE ] Creating CA... [ DONE ] Updating ovirt-engine service... [ DONE ] Setting Database Configuration... [ DONE ] Setting Database Security... [ DONE ] Creating Database... [ DONE ] Updating the Default Data Center Storage Type... [ DONE ] Editing RHEV Manager Configuration... [ DONE ] Editing Postgresql Configuration... [ DONE ] Configuring Firewall... [ DONE ] Starting ovirt-engine Service... [ DONE ] Configuring HTTPD... [ DONE ] **** Installation completed successfully ****** (Please allow RHEV Manager a few moments to start up.....) **** To access RHEV Manager browse to http://rhev-manager1.redhat.com:80 **** Additional information: * There are less than 4096 MBs of available free memory on this machine. It is recommended to have at least 4096 MBs of available memory to run the RHEV Manager. * RHEV Manager CA SSL Certificate SHA1 fingerprint: 6C:5C:32:0E:C8:17:B9:90:7D:F5:80:A2:D3:63:47:85:36:C9:DC:18 * SSH Public key fingerprint: d2:08:bc:66:cb:19:79:70:4d:52:5b:cc:39:b2:dc:38 * The installation log file is available at: /var/log/ovirt-engine/engine-setup_2013_03_07_12_16_40.log * Please use the user "admin" and password specified in order to login into RHEV Manager * To configure additional users, first configure authentication domains using the 'rhevm-manage-domains' utility
Result
The Red Hat Enterprise Virtualization Manager has been installed and configured successfully. You are now able to connect to the Administration Portal for the first time.
20.2.5. Restoring the Engine Database Using the restore.sh Script
Summary
The Red Hat Enterprise Virtualization Manager includes a script to automate database restoration. Using this script on your Manager server, you can recover from database corruption.
Important
If your environment was upgraded from Red Hat Enterprise Virtualization 3.0, please see KB337653 for additional information about backing up and restoring your database.
Procedure 20.7. Restoring the Engine Database Using the restore.sh Script
- Change into the
/usr/share/ovirt-engine/dbscripts/directory. - Invoke
restore.shwith the-hparameter to see the available options.Usage: restore.sh [-h] [-s SERVERNAME] [-p PORT] -u USERNAME -d DATABASE -f FILE [-r] -s SERVERNAME - The database servername for the database (def. localhost) -p PORT - The database port for the database (def. 5432) -u USERNAME - The username for the database. -d DATABASE - The database name -f File - Backup file name to restore from. -r - Remove existing database with same name -h - This help text. for more options please run pg_restore --help
- Invoke the
restore.shcommand again with parameters appropriate for your environment. If you are restoring the localenginedatabase, the-sand-pparameters are not necessary. Use the-dto specify name of the database you are creating. Red Hat Enterprise Virtualization expects a primary database namedengine. Use the-fto specify the.sqlfile you are restoring from.
Result
You have used the restore.sh script to restore your engine database.
20.2.6. Restoring Red Hat Enterprise Virtualization Manager Configuration Files
Prerequisites:
Summary
Restore a backed up copy of configuration files to the Red Hat Enterprise Virtualization Manager.
Important
If your environment was upgraded from Red Hat Enterprise Virtualization 3.0, please see KB340903 for additional information about backing up and restoring your configuration files.
Procedure 20.8. Restoring Red Hat Enterprise Virtualization Manager Configuration Files
- Stop the engine service:
# service ovirt-engine stop
- Completely remove all previous installations of the Red Hat Enterprise Virtualization Manager:
# yum remove rhevm
- Remove
/etc/pki/ovirt-engine:# rm -rf /etc/pki/ovirt-engine
- Remove the main
rhevmdirectory:# rm -rf /etc/ovirt-engine
- Install the Red Hat Enterprise Virtualization Manager:
# yum install -y rhevm
- Run
engine-setup, giving the same answers as when you originally installedrhevm:# engine-setup
Your answers can be found in/var/log/engine-setup-SETUP-DATE.log, which you backed up. - Stop the engine service, which was restarted as a part of the previous command:
# service ovirt-engine stop
- Restore the backed up configuration files to their original locations.
- Make sure the ownership of the
.truststorefile is correct:# chown ovirt:ovirt /etc/pki/ovirt-engine/.truststore
- Make sure the permissions of the
notifier.conffile is correct:# chmod 640 /etc/ovirt-engine/notifier/notifier.conf
- Start the engine service:
# service ovirt-engine start
Result
You have restored a backed up copy of configuration files to the Red Hat Enterprise Virtualization Manager.
Part III. Gathering Information About the Environment
Table of Contents
Chapter 21. Reports, History Database Reports, and Dashboards
21.1. Reports
- 21.1.1. Reports
- 21.1.2. JasperReports and JasperServer in Red Hat Enterprise Virtualization
- 21.1.3. Online Help for JasperReports
- 21.1.4. Jasper Reports System Requirements
- 21.1.5. Users in the Red Hat Enterprise Virtualization Reports Portal
- 21.1.6. Logging in to Access the Reports Portal
- 21.1.7. Accessing the Red Hat Enterprise Virtualization Reports User Management Menu
- 21.1.8. Reports Portal User Roles
- 21.1.9. Navigating Reports and Dashboards
- 21.1.10. Report Parameters
- 21.1.11. Right-click Reporting Integration with the Red Hat Enterprise Virtualization Administration Portal
- 21.1.12. Executive Reports
- 21.1.13. Inventory Reports
- 21.1.14. Service Level Reports
- 21.1.15. Trend Reports
- 21.1.16. Ad Hoc Reports
- 21.1.17. Reports Schema: Tag History and ENUM Views
21.1.1. Reports
Red Hat Enterprise Virtualization includes a comprehensive management history database, which can be used by reporting applications to generate reports at data center, cluster and host levels. This chapter provides information to enable you to set up queries against the history database and generate reports.
Red Hat Enterprise Virtualization Manager uses PostgreSQL 8.4.12 as a database platform to store information about the state of the virtualization environment, its configuration and performance. At install time, Red Hat Enterprise Virtualization Manager creates a PostgreSQL database called engine.
Installing the rhevm-dwh package creates a second database called ovirt_engine_history, which contains historical configuration information and statistical metrics collected every minute over time from the engine operational database. Tracking the changes to the database provides information on the objects in the database, enabling the user to analyze activity, enhance performance, and resolve difficulties.
Warning
The replication of data in the ovirt_engine_history database is performed by the Red Hat Enterprise Virtualization Manager Extract Transform Load Service, ovirt-engine-dwhd. The service is based on Talend Open Studio, a data integration tool. This service is configured to start automatically during the data warehouse package setup. It is a Java program responsible for extracting data from the engine database, transforming the data to the history database standard and loading it to the ovirt_engine_history database.
The ovirt-engine-dwhd service must not be stopped.
The ovirt_engine_history database schema changes over time. The database includes a set of database views to provide a supported, versioned API with a consistent structure. A view is a virtual table composed of the result set of a database query. The database stores the definition of a view as a
SELECT statement. The result of the SELECT statement populates the virtual table that the view returns. A user references the view name in PL/PGSQL statements the same way a table is referenced.
21.1.2. JasperReports and JasperServer in Red Hat Enterprise Virtualization
Red Hat Enterprise Virtualization provides a customized implementation of JasperServer, which allows web-based access to a range of pre-configured reports and dashboards, plus the ability to create ad hoc reports.
JasperReports is an open source reporting tool, capable of being embedded in Java-based applications. It produces reports which can be rendered to screen, printed, or exported to a variety of formats including PDF, Excel, CSV, Word, RTF, Flash, ODT and ODS. JasperReports integrates with JasperServer, an open source reporting server for JasperReports. Using JasperServer, reports built in JasperReports can be accessed via a web interface.
21.1.3. Online Help for JasperReports
JasperServer provides extensive online help. Use the online help to find information on common administration tasks and the JasperServer product in general. This section provides information on the reports available for Red Hat Enterprise Virtualization and the customizations that integrate JasperServer with Red Hat Enterprise Virtualization. To navigate to the online help facility, click on Help in the top right-hand corner of the browser.
21.1.4. Jasper Reports System Requirements
The Red Hat Enterprise Virtualization Manager Reports tool supports the following browsers:
- In Red Hat Enterprise Linux 5.7 - Firefox 17 or later
- In Red Hat Enterprise Linux 6 - Firefox 17 or later
- In Windows 7 - Internet Explorer 9
- In Windows Server 2008 - Internet Explorer 9
21.1.5. Users in the Red Hat Enterprise Virtualization Reports Portal
The Red Hat Enterprise Virtualization Reports Portal does not use your directory server for authentication.
By default, there are two Reports Portal users:
rhevm-admin and superuser. The passwords for these users were set during the installation of Red Hat Enterprise Virtualization Reports. Generally, additional users must be added manually.
When a domain user accesses the Reports Portal from within the Administration Portal using right-click reporting, a corresponding user is automatically created in the Reports Portal using the user's domain user name. This user cannot login to the Reports Portal directly, but is able to view all the reports accessible from the Administration portal.
21.1.6. Logging in to Access the Reports Portal
You were prompted to set a password for the
superuser and rhevm-admin accounts when you installed Red Hat Enterprise Virtualization Reports. Red Hat Enterprise Virtualization Reports does not provide default passwords.
To access reports, navigate to the reports portal at:
https://YOUR.MANAGER.URL/rhevm-reports/login.html. A login screen for Red Hat Enterprise Virtualization Reports is displayed.
Note
You can also access the reports portal from your Red Hat Enterprise Virtualization landing page.
Enter your login credentials. If this is the first time you are connecting to the reports portal, log in as
ovirt-user. Click the button.
The Reports Portal does not use your directory service for authentication. By default, the Reports Portal includes two users:
rhevm-admin and superuser. Generally, additional users need to be created within the Reports Portal.
21.1.7. Accessing the Red Hat Enterprise Virtualization Reports User Management Menu
Summary
You can add additional reports users, giving them access to the reports portal. Complete this procedure as a user with sufficient permissions to manage other users, like rhevm-admin.
- In to Red Hat Enterprise Virtualization reports portal, hover over the Manage button on the top menu bar.
- Click on Users in the drop-down menu that appears to access the Manage Users interface. It contains three panes:
- Organizations
- Users
- Properties
- Select a user in the Users pane by clicking on the name of the user. Information about the user displays in the Properties pane.
- Click the button at the bottom of the user's Properties pane.The Properties pane contains these fields:
- User name,
- User ID,
- Email,
- Password (required),
- Confirm Password (required),
- A User is enabled check box,
- A The user is defined externally check box,
- A list of Roles Available to the user, and
- A list of Roles Assigned to the user.
- Click the button.
Result
You have given more users permissions to access the reports portal.
21.1.8. Reports Portal User Roles
There are three roles, each of which provides a different level of permissions:
- ROLE_ADMINISTRATOR - Can create/edit/delete reports, dashboards, ad hoc reports, and manage the server.
- ROLE_USER - Can create/edit/delete ad hoc reports and view reports and dashboards.
- ROLE_ANONYMOUS - Can log in and look at reports and dashboards.
Other roles can be created and assigned. For information on how to create and assign other roles, detailed information about user management, and other system functions, please refer to the JasperServer documentation.
21.1.9. Navigating Reports and Dashboards
Select the button on the reports portal home page.
You can use the smaller (
) button in the navigation bar at the top of the reports portal to return to this page.
) button in the navigation bar at the top of the reports portal to return to this page.
Use the Filter pane on the left of the screen to select a subset of reports you would like to view.
You can use filters to select from the available reports.
Table 21.1. Navigation Filters
| Filter | Description |
|---|---|
Available Resources | Select from All, Modified by me, or Viewed by me. |
Resource type | Choose from the types of available resources including Reports, Ad Hoc views, Dashboards, and more. |
Timeframe | Choose a time frame you'd like to see information from. |
Schedule | Filter by data collection schedule. |
21.1.10. Report Parameters
Report parameters are user-defined at report run time. Report parameters define the scope and timeframe of the report. When running a report, you are prompted for the parameters applicable to the report you selected.
To view the required parameters for a report, click the report in the reports list.
Select a report from the list to display the Input Controls window. The Input Controls window consists of a number of drop-down menus allow you to define the report's parameters.
Note
The dialog is contextual and differs from report to report. Parameters marked with an asterisk (*) are required.
Cascading parameters
Many report parameters are cascading input fields. This means the selection made for one parameter changes the options available for another parameter. The Data Center and Cluster parameters are cascading. Once a user selects a data center, only clusters within that data center are available for selection. Similarly, if a user selects a cluster, the Host Type field updates to show only host types that exist in the selected cluster. Cascading parameters filter out objects that do not contain child objects relevant to the report. For example, a report pertaining to virtual machines removes the selection of clusters that do not contain virtual machines. A report pertaining to both virtual machines and hosts only provides a selection from clusters containing both virtual machines and hosts.
Deleted objects
Objects deleted (removed) from the system are still recorded in the reporting history database. Select deleted objects, such as clusters, data centers and hosts, as values for report parameters if required. The bottom of the parameter options list shows deleted objects, which are suffixed with the date of removal from the system.
You can toggle whether deleted entries are shown in the report using the Show Deleted Entities? field in the Input Controls window.
21.1.11. Right-click Reporting Integration with the Red Hat Enterprise Virtualization Administration Portal
The Administration portal provides integrated access to reports on most resources.
To access a report on a given resource, select the resource in the Administration Portal. Right-click the resource to show a context sensitive menu, and select the Show Report option. This expands to show all of the available reports on the selected resource.
Alternatively, you can select a given resource in the Administration Portal. If there are reports on that resource, the Show Report action becomes available above the results pane.
21.1.12. Executive Reports
21.1.12.1. Executive reports: Active Virtual Machines by OS
The
Active Virtual Machines by OS report shows a summary of the number of active virtual machines in a given time period, broken down by operating system. The following parameters are provided to run this report:
Table 21.2. Active Virtual Machines by OS Parameters
| Parameter | Description |
|---|---|
Show Deleted Entities? | The report includes deleted objects, such as data centers, clusters, and hosts removed from the environment. |
Period Range | The report is for the period range selected. Daily reports cover a single day. Monthly reports cover a single month. Quarterly reports cover a three-month quarter, beginning on the month specified in the Dates parameter. Yearly reports cover a year, beginning on the month specified in the Dates parameter. |
Dates | The report covers the selected period range, beginning on this date. Daily period ranges pass in one day increments. For a Monthly period range, the selected month is used. For a Quarterly period range, the quarter is determined as beginning on the selected month. A yearly period range also starts on the selected month. |
Data Center | The report includes only virtual machines in the selected data center. The options list shows only data centers that contain virtual machines. |
Cluster | The report only includes virtual machines in the selected cluster. The options list shows only clusters in the selected data center. If All is selected, the report includes all virtual machines in the selected data center. |
Virtual Machine Type | The report only includes virtual machines of the selected type. Possible types are Server and Desktop. The options list shows only types that exist in the selected data center and cluster. If All is selected, the report includes all virtual machine types. |
21.1.12.2. Executive Reports: Cluster Capacity Vs Usage
The
Cluster Capacity Vs Usage report shows the relationship between system capacity and usage (workload) over a given time period. Capacity is expressed in terms of CPU cores and physical memory, while usage is expressed as vCPUs and virtual machine memory. The following parameters must be provided to run this report:
Table 21.3. Cluster Capacity Vs Usage Parameters
| Parameter | Description |
|---|---|
Show Deleted Entities? | The report includes deleted objects, such as data centers, clusters, and hosts removed from the environment. |
Period Range | The report is for the period range selected. Daily reports cover a single day. Monthly reports cover a single month. Quarterly reports cover a three-month quarter, beginning on the month specified in the Dates parameter. Yearly reports cover a year, beginning on the month specified in the Dates parameter. |
Dates | The report covers the selected period range, beginning on this date. Daily period ranges pass in one day increments. For a Monthly period range, the selected month is used. For a Quarterly period range, the quarter is determined as beginning on the selected month. A yearly period range also starts on the selected month. |
Data Center | The list of options for the Cluster parameter includes only clusters in the selected data center. The options list contains only data centers that contain clusters. |
Cluster | The report only includes the selected cluster. The options list shows only clusters in the selected data center. If All is selected, the report includes all clusters in the selected data center. |
21.1.12.3. Executive Reports: Host Operating System Break Down
The
Host OS Break Down report indicates the number of hosts running each operating system version over a given time period. The following parameters must be provided to run this report:
Table 21.4. Host OS Break Down Parameters
| Parameter | Description |
|---|---|
Show Deleted Entities? | The report includes deleted objects, such as data centers, clusters, and hosts removed from the environment. |
Period Range | The report is for the period range selected. Daily reports cover a single day. Monthly reports cover a single month. Quarterly reports cover a three-month quarter, beginning on the month specified in the Dates parameter. Yearly reports cover a year, beginning on the month specified in the Dates parameter. |
Dates | The report covers the selected period range, beginning on this date. Daily period ranges pass in one day increments. For a Monthly period range, the selected month is used. For a Quarterly period range, the quarter is determined as beginning on the selected month. A yearly period range also starts on the selected month. |
Data Center | The list of options for the Cluster parameter includes only clusters in the selected data center. The options list shows only data centers that contain clusters. |
Cluster | The report includes only hosts in the selected cluster. The options list shows only clusters in the selected data center. If All is selected, the report includes all hosts in the selected data center. |
21.1.12.4. Executive Reports: Summary of Host Usage Resources
The
Summary of Host Usage Resources report shows a scatter plot of average host resource utilization for a given time period in terms of CPU and memory usage. The following parameters must be provided to run this report:
Table 21.5. Summary of Host Usage Resources Parameters
| Parameter | Description |
|---|---|
Show Deleted Entities? | The report includes deleted objects, such as data centers, clusters, and hosts removed from the environment. |
Period Range | The report is for the period range selected. Daily reports cover a single day. Monthly reports cover a single month. Quarterly reports cover a three-month quarter, beginning on the month specified in the Dates parameter. Yearly reports cover a year, beginning on the month specified in the Dates parameter. |
Dates | The report covers the selected period range, beginning on this date. Daily period ranges pass in one day increments. For a Monthly period range, the selected month is used. For a Quarterly period range, the quarter is determined as beginning on the selected month. A yearly period range also starts on the selected month. |
Data Center | The list of options for the Cluster parameter includes only clusters in the selected data center. The options list shows only data centers that contain clusters. |
Cluster | The report includes only hosts in the selected cluster. The options list shows only clusters in the selected data center. If All is selected, the report includes all hosts in the selected data center. |
21.1.13. Inventory Reports
21.1.13.1. Inventory Reports: Hosts Inventory
The
Hosts Inventory report shows a list of all hosts in the selected data center and cluster. The following parameters must be provided to run this report:
Table 21.6. Hosts Inventory Parameters
| Parameter | Description |
|---|---|
Show Deleted Entities? | The report includes deleted objects, such as data centers, clusters, and hosts removed from the environment. |
Data Center | The list of options for the Cluster parameter includes only clusters in the selected data center. The options list shows only data centers that contain clusters. |
Cluster | The report includes only hosts in the selected cluster. The options list shows only clusters in the selected data center. If All is selected, the report includes all hosts in the selected data center. |
Host Type | The report includes only hosts of the selected type. The options list shows only host types present in the selected data center and cluster. If All is selected, the report includes all host types. |
21.1.13.2. Inventory Reports: Storage Domain Over Time
The
Storage Domain Size Over Time report shows a line graph contrasting the total available and total used space for a single storage domain over time for a given period. The following parameters must be provided to run this report:
Table 21.7. Storage Domain Size Over Time Parameters
| Parameter | Description |
|---|---|
Show Deleted Entities? | The report includes deleted objects, such as data centers, clusters, and hosts removed from the environment. |
Period Range | The report is for the period range selected. Monthly reports cover a single month. Quarterly reports cover a three-month quarter, beginning on the month specified in the Dates parameter. |
Dates | The report covers the selected period range, beginning on this date. For a Monthly period range, the selected month is used. For a Quarterly period range, the quarter is determined as beginning on the selected month. The list of options for the Storage Domain name parameter includes only storage domains that were attached during the specified period. |
Data Center | The options list for the Storage Domain Name parameter shows only storage domains in this selected data center. |
Storage Domain Type | The options list for the Storage Domain Name parameter shows only storage domains of this selected type. |
Storage Domain Name | The report refers to the storage domain selected. A report is only for a single storage domain and the user must select a storage domain. The list of options shows only storage domains that were attached to the data center during the selected period. |
21.1.13.3. Inventory Reports: Virtual Machines Inventory
The
Virtual Machines Inventory report shows a list of all virtual machines in the selected data center and cluster. The following parameters must be provided to run this report:
Table 21.8. Virtual Machines Inventory Parameters
| Parameter | Description |
|---|---|
Show Deleted Entities? | The report includes deleted objects, such as data centers, clusters, and hosts removed from the environment. |
Data Center | The list of options for the Cluster parameter includes only clusters in the selected data center. The options list shows only data centers that contain clusters. |
Cluster | The report includes only virtual machines in the selected cluster. The options list shows only clusters in the selected data center. If All is selected, the report includes all virtual machines in the selected data center. |
Virtual Machine Type | The report includes only virtual machines of the selected type. The options list shows only virtual machine types present in the selected data center and cluster. If All is selected, the report includes all virtual machine types. |
21.1.13.4. Inventory Reports: Cloud Provider Virtual Machine Inventory
The Cloud Provider Virtual Machine Inventory report shows a list of all virtual machines in the selected data center and cluster, and is required by cloud providers to bill customers. The following parameters must be provided to run this report:
Table 21.9. Cloud Provider Virtual Machine Inventory Parameters
| Parameter | Description |
|---|---|
Show Deleted Entities? | The report includes deleted objects, such as data centers, clusters, and hosts removed from the environment. |
Period Range | The report is for the period range selected. Daily reports cover a single day. Monthly reports cover a single month. Quarterly reports cover a three-month quarter, beginning on the month specified in the Dates parameter. Yearly reports cover a year, beginning on the month specified in the Dates parameter. |
Dates | The report covers the selected period range, beginning on this date. Daily period ranges pass in one day increments. For a Monthly period range, the selected month is used. For a Quarterly period range, the quarter is determined as beginning on the selected month. A yearly period range also starts on the selected month. |
Data Center | The list of options for the Cluster parameter includes only clusters in the selected data center. The options list shows only data centers that contain clusters. |
Cluster | The report includes only virtual machines in the selected cluster. The options list shows only clusters in the selected data center. If All is selected, the report includes all virtual machines in the selected data center. |
Virtual Machine Type | The report includes only virtual machines of the selected type. The options list shows only virtual machine types present in the selected data center and cluster. If All is selected, the report includes all virtual machine types. |
21.1.14. Service Level Reports
21.1.14.1. Service Level Reports: Cluster Host Uptime
The
Cluster Host Uptime report shows the weighted average uptime of hosts within a cluster for a given period of time. This report also provides a table listing the total planned (maintenance) and unplanned down time for each host. The following parameters must be provided to run this report:
Table 21.10. Cluster Host Uptime Parameters
| Parameter | Description |
|---|---|
Show Deleted Entities? | The report includes deleted objects, such as data centers, clusters, and hosts removed from the environment. |
Period Range | The report is for the period range selected. Daily reports cover a single day. Monthly reports cover a single month. Quarterly reports cover a three-month quarter, beginning on the month specified in the Dates parameter. Yearly reports cover a year, beginning on the month specified in the Dates parameter. |
Dates | The report covers the selected period range, beginning on this date. Daily period ranges pass in one day increments. For a Monthly period range, the selected month is used. For a Quarterly period range, the quarter is determined as beginning on the selected month. A yearly period range also starts on the selected month. |
Data Center | The list of options for the Cluster parameter includes only clusters in the selected data center. The options list shows only data centers that contain clusters. |
Cluster | The report includes only hosts in the selected cluster. The options list shows only clusters in the selected data center. If All is selected, the report includes all hosts in the selected data center. |
Host Type | The report includes only hosts of the selected type. The options list shows only host types present in the selected data center and cluster. If All is selected, the report includes all host types. |
21.1.14.2. Service Level Reports: Cluster Quality of Service - Hosts
The
Cluster Quality of Services - Hosts report shows the amount of time hosts sustain load above a specified threshold for a given time period. Load is defined in terms of CPU usage percent and memory usage percent. The following parameters must be provided to run this report:
Table 21.11. Cluster Quality of Service - Hosts Parameters
| Parameter | Description |
|---|---|
Show Deleted Entities? | The report includes deleted objects, such as data centers, clusters, and hosts removed from the environment. |
Period Range | The report is for the period range selected. Daily reports cover a single day. Monthly reports cover a single month. Quarterly reports cover a three-month quarter, beginning on the month specified in the Dates parameter. Yearly reports cover a year, beginning on the month specified in the Dates parameter. |
Dates | The report covers the selected period range, beginning on this date. Daily period ranges pass in one day increments. For a Monthly period range, the selected month is used. For a Quarterly period range, the quarter is determined as beginning on the selected month. A yearly period range also starts on the selected month. |
Data Center | The list of options for the Cluster parameter includes only clusters in the selected data center. The options list shows only data centers that contain clusters. |
Cluster | The report includes only hosts in the selected cluster. The options list shows only clusters in the selected data center. If All is selected, the report includes all hosts in the selected data center. |
Host Type | The report includes only hosts of the selected type. The options list shows only host types present in the selected data center and cluster. If All is selected, the report includes all host types. |
CPU Threshold | The report measures the quality of service as the amount of time hosts sustain load above a given threshold. The CPU Threshold defines a load threshold as a percentage of total CPU usage on the host. The load is measured by one-minute samples, averaged over an hour. The report therefore shows sustained load, not short term peaks. A CPU Threshold of 60 per cent is a suggested starting point to produce a meaningful quality of service report. |
Memory Threshold | The report measures the quality of service as the amount of time hosts sustain load above a given threshold. The Memory Threshold defines a load threshold as a percentage of total memory usage on the host. The load is measured by one-minute samples, averaged over an hour. The report therefore shows sustained load, not short term peaks. A Memory Threshold of 60 per cent is a suggested starting point to produce a meaningful quality of service report. |
21.1.14.3. Service Level Reports: Cluster Quality of Service - Virtual Machines
The
Cluster Quality of Service - Virtual Machines report shows the amount of time virtual machines sustain load above a specified threshold for a given time period. Load is defined in terms of CPU usage percent and memory usage percent. The following parameters must be provided to run this report:
Table 21.12. Cluster Quality of Service - Virtual Machines Parameters
| Parameter | Description |
|---|---|
Show Deleted Entities? | The report includes deleted objects, such as data centers, clusters, and hosts removed from the environment. |
Period Range | The report is for the period range selected. Daily reports cover a single day. Monthly reports cover a single month. Quarterly reports cover a three-month quarter, beginning on the month specified in the Dates parameter. Yearly reports cover a year, beginning on the month specified in the Dates parameter. |
Dates | The report covers the selected period range, beginning on this date. Daily period ranges pass in one day increments. For a Monthly period range, the selected month is used. For a Quarterly period range, the quarter is determined as beginning on the selected month. A yearly period range also starts on the selected month. |
Data Center | The list of options for the Cluster parameter includes only clusters in the selected data center. The options list shows only data centers that contain clusters. |
Cluster | The report includes only virtual machines in the selected cluster. The options list shows only clusters in the selected data center. If All is selected, the report includes all virtual machines in the selected data center. |
Virtual Machine Type | The report includes only virtual machines of the selected type. The options list shows only virtual machine types present in the selected data center and cluster. If All is selected, the report includes all virtual machine types. |
CPU Threshold | The report measures quality of service as the amount of time virtual machines sustain load above a given threshold. The CPU Threshold defines a load threshold as a percentage of total CPU usage on the virtual machine. The load is measured by one-minute samples, averaged over an hour. The report therefore shows sustained load, not short term peaks. A CPU Threshold of 60 per cent is a suggested starting point to produce a meaningful quality of service report. |
Memory Threshold | The reports measures quality of service as the amount of time virtual machines sustain load above a given threshold. The Memory Threshold defines a load threshold as a percentage of total memory usage on the virtual machine. The load is measured by one-minute samples, averaged over an hour. The report therefore shows sustained load, not short term peaks. A Memory Threshold of 60 per cent is a suggested starting point to produce a meaningful quality of service report. |
21.1.14.4. Service Level Reports: Single Host Uptime
The
Single Host Uptime report shows the total proportion of uptime, planned downtime and unplanned downtime for a single host. The following parameters must be provided to run this report:
Table 21.13. Single Host Uptime Parameters
| Parameter | Description |
|---|---|
Show Deleted Entities? | The report includes deleted objects, such as data centers, clusters, and hosts removed from the environment. |
Period Range | The report is for the period range selected. Daily reports cover a single day. Monthly reports cover a single month. Quarterly reports cover a three-month quarter, beginning on the month specified in the Dates parameter. Yearly reports cover a year, beginning on the month specified in the Dates parameter. |
Dates | The report covers the selected period range, beginning on this date. Daily period ranges pass in one day increments. For a Monthly period range, the selected month is used. For a Quarterly period range, the quarter is determined as beginning on the selected month. A yearly period range also starts on the selected month. |
Data Center | The list of options for the Cluster parameter includes only clusters in the selected data center. The options list shows only data centers that contain clusters. |
Cluster | The list of options for the Host Name parameter includes only hosts in the selected cluster. The options list shows only clusters in the selected data center. If All is selected, the list of options for the Host Name parameter includes all hosts in the selected data center. |
Host Type | The list of options for the Host Name parameter includes only hosts of the selected type. The options list shows only host types present in the selected data center and cluster. If All is selected, the list of options for the Host Name parameter includes all host types. |
Host Name | The report refers to the host selected. A report is only for a single host and a user must select a host. |
21.1.14.5. Service Level Reports: Top 10 Downtime Hosts
The
Top 10 Downtime Hosts report shows the total proportion of uptime, planned downtime and unplanned downtime for the 10 hosts with the greatest amount of downtime. The following parameters must be provided to run this report:
Table 21.14. Top 10 Downtime Hosts Parameters
Parameter | Description |
|---|---|
Show Deleted Entities? | The report includes deleted objects, such as data centers, clusters, and hosts removed from the environment. |
Period Range | The report is for the period range selected. Daily reports cover a single day. Monthly reports cover a single month. Quarterly reports cover a three-month quarter, beginning on the month specified in the Dates parameter. Yearly reports cover a year, beginning on the month specified in the Dates parameter. |
Dates | The report covers the selected period range, beginning on this date. Daily period ranges pass in one day increments. For a Monthly period range, the selected month is used. For a Quarterly period range, the quarter is determined as beginning on the selected month. A yearly period range also starts on the selected month. |
Data Center | The list of options for the Cluster parameter includes only clusters in the selected data center. The options list contains only data centers that contain clusters. |
Cluster | The report includes only hosts in the selected cluster. The options list shows only clusters in the selected data center. If All is selected, the report includes all hosts in the selected data center. |
Host Type | The report includes only hosts of the selected type. The options list shows only host types present in the selected data center and cluster. If All is selected, the report includes all host types. |
21.1.14.6. Service Level Reports: High Availability Virtual Servers Uptime
The
High Availability Virtual Servers Uptime report shows the weighted average uptime of high availability virtual servers within a cluster for a given period of time. The report also provides a table listing the total uptime and unplanned down time for each virtual server. The following parameters must be provided to run this report:
Table 21.15. High Availability Virtual Servers Uptime Parameters
| Parameter | Description |
|---|---|
Show Deleted Entities? | The report includes deleted objects, such as data centers, clusters, and hosts removed from the environment. |
Period Range | The report is for the period range selected. Daily reports cover a single day. Monthly reports cover a single month. Quarterly reports cover a three-month quarter, beginning on the month specified in the Dates parameter. Yearly reports cover a year, beginning on the month specified in the Dates parameter. |
Dates | The report covers the selected period range, beginning on this date. Daily period ranges pass in one day increments. For a Monthly period range, the selected month is used. For a Quarterly period range, the quarter is determined as beginning on the selected month. A yearly period range also starts on the selected month. |
Data Center | The list of options for the Cluster parameter includes only clusters in the selected data center. The options list shows only data centers that contain clusters. |
Cluster | The report includes only virtual servers in the selected cluster. The options list shows only clusters in the selected data center. If All is selected, the report includes all virtual servers in the selected data center. |
21.1.15. Trend Reports
21.1.15.1. Trend Reports: Five Least Utilized Hosts (Over Time)
The
Five Least Utilized Hosts (Over Time) report shows the weighted average daily peak load, in terms of CPU and memory usage, for the five hosts with the lowest load factor for a given period of time. The following parameters must be provided to run this report:
Table 21.16. Five Least Utilized Hosts (Over Time) Parameters
| Parameter | Description |
|---|---|
Show Deleted Entities? | The report includes deleted objects, such as data centers, clusters, and hosts removed from the environment. |
Period Range | The report is for the period range selected. Daily reports cover a single day. Monthly reports cover a single month. Quarterly reports cover a three-month quarter, beginning on the month specified in the Dates parameter. Yearly reports cover a year, beginning on the month specified in the Dates parameter. |
Dates | The report covers the selected period range, beginning on this date. Daily period ranges pass in one day increments. For a Monthly period range, the selected month is used. For a Quarterly period range, the quarter is determined as beginning on the selected month. A yearly period range also starts on the selected month. |
Data Center | The list of options for the Cluster parameter includes only clusters in the selected data center. The options list shows only data centers that contain clusters. |
Cluster | The report includes only hosts in the selected cluster. The options list shows only clusters in the selected data center. If All is selected, the report includes all hosts in the selected data center. |
Host Type | The report includes only hosts of the selected type. The options list shows only host types present in the selected data center and cluster. If All is selected, the report includes all host types. |
21.1.15.2. Trend Reports: Five Least Utilized Virtual Machines (Over Time)
The
Five Least Utilized Virtual Machines (Over Time) report shows the weighted average daily peak load, in terms of CPU and memory usage, for the five virtual machines with the lowest load factor for a given period of time. The following parameters must be provided to run this report:
Table 21.17. Five Least Utilized Virtual Machines (Over Time) Parameters
| Parameter | Description |
|---|---|
Show Deleted Entities? | The report includes deleted objects, such as data centers, clusters, and hosts removed from the environment. |
Period Range | The report is for the period range selected. Daily reports cover a single day. Monthly reports cover a single month. Quarterly reports cover a three-month quarter, beginning on the month specified in the Dates parameter. Yearly reports cover a year, beginning on the month specified in the Dates parameter. |
Dates | The report covers the selected period range, beginning on this date. Daily period ranges pass in one day increments. For a Monthly period range, the selected month is used. For a Quarterly period range, the quarter is determined as beginning on the selected month. A yearly period range also starts on the selected month. |
Data Center | The list of options for the Cluster parameter includes only clusters in the selected data center. The options list shows only data centers that contain clusters. |
Cluster | The report includes only virtual machines in the selected cluster. The options list shows only clusters in the selected data center. If All is selected, the report includes all virtual machines in the selected data center. |
Virtual Machine Type | The report includes only virtual machines of the selected type. The options list shows only virtual machine types present in the selected data center and cluster. If All is selected, the report includes all virtual machine types. |
21.1.15.3. Trend Reports: Five Most Utilized Hosts (Over Time)
The
Five Most Utilized Hosts (Over Time) report shows the weighted average daily peak load, in terms of CPU and memory usage, for the five hosts with the highest load factor for a given period of time. The following parameters must be provided to run this report:
Table 21.18. Five Most Utilized Hosts (Over Time) Parameters
| Parameter | Description |
|---|---|
Show Deleted Entities? | The report includes deleted objects, such as data centers, clusters, and hosts removed from the environment. |
Period Range | The report is for the period range selected. Daily reports cover a single day. Monthly reports cover a single month. Quarterly reports cover a three-month quarter, beginning on the month specified in the Dates parameter. Yearly reports cover a year, beginning on the month specified in the Dates parameter. |
Dates | The report covers the selected period range, beginning on this date. Daily period ranges pass in one day increments. For a Monthly period range, the selected month is used. For a Quarterly period range, the quarter is determined as beginning on the selected month. A yearly period range also starts on the selected month. |
Data Center | The list of options for the Cluster parameter includes only clusters in the selected data center. The options list shows only data centers that contain clusters. |
Cluster | The report includes only hosts in the selected cluster. The options list shows only clusters in the selected data center. If All is selected, the report includes all hosts in the selected data center. |
Host Type | The report includes only hosts of the selected type. The options list shows only host types present in the selected data center and cluster. If All is selected, the report includes all host types. |
21.1.15.4. Trend Reports: Five Most Utilized Virtual Machines (Over Time)
The
Five Most Utilized Virtual Machines (Over Time) report shows the weighted average daily peak load, in terms of CPU and memory usage, for the five virtual machines with the highest load factor for a given period of time. The following parameters must be provided to run this report:
Table 21.19. Five Most Utilized Virtual Machines (Over Time) Parameters
| Parameter | Description |
|---|---|
Show Deleted Entities? | The report includes deleted objects, such as data centers, clusters, and hosts removed from the environment. |
Period Range | The report is for the period range selected. Daily reports cover a single day. Monthly reports cover a single month. Quarterly reports cover a three-month quarter, beginning on the month specified in the Dates parameter. Yearly reports cover a year, beginning on the month specified in the Dates parameter. |
Dates | The report covers the selected period range, beginning on this date. Daily period ranges pass in one day increments. For a Monthly period range, the selected month is used. For a Quarterly period range, the quarter is determined as beginning on the selected month. A yearly period range also starts on the selected month. |
Data Center | The list of options for the Cluster parameter includes only clusters in the selected data center. The options list shows only data centers which contain clusters. |
Cluster | The report includes only virtual machines in the selected cluster. The options list shows only clusters in the selected data center. If All is selected, the report includes all virtual machines in the selected data center. |
Virtual Machine Type | The report includes only virtual machines of the selected type. The options list shows only virtual machine types present in the selected data center and cluster. If All is selected, the report includes all virtual machine types. |
21.1.15.5. Trend Reports: Multiple Hosts Resource Usage (Over Time)
The
Multiple Hosts Resource Usage (Over Time) report shows the daily peak load, in terms of CPU and memory usage, for up to five selected hosts over a given period of time. The following parameters must be provided to run this report:
Table 21.20. Multiple Hosts Resource Usage (Over Time) Parameters
| Parameter | Description |
|---|---|
Show Deleted Entities? | The report includes deleted objects, such as data centers, clusters, and hosts removed from the environment. |
Period Range | The report is for the period range selected. Daily reports cover a single day. Monthly reports cover a single month. Quarterly reports cover a three-month quarter, beginning on the month specified in the Dates parameter. Yearly reports cover a year, beginning on the month specified in the Dates parameter. |
Dates | The report covers the selected period range, beginning on this date. Daily period ranges pass in one day increments. For a Monthly period range, the selected month is used. For a Quarterly period range, the quarter is determined as beginning on the selected month. A yearly period range also starts on the selected month. |
Data Center | The list of options for the Cluster parameter includes only clusters in the selected data center. The options list shows only data centers that contain clusters. |
Cluster | The list of options for the Hosts list parameter includes only hosts in the selected cluster. The options list shows only clusters in the selected data center. If All is selected, the list of options for the Hosts list parameter includes all hosts in the selected data center. |
Host Type | The list of options for the Hosts list parameter includes only hosts of the selected type. The options list shows only host types present in the selected data center and cluster. If All is selected, the list of options for the Hosts list parameter includes all host types. |
Hosts list | The report includes all hosts selected in the host list. Select any number of hosts up to a maximum of five. |
21.1.15.6. Trend Reports: Multiple Virtual Machines Resource Usage (Over Time)
The
Multiple Virtual Machines Resource Usage (Over Time) report shows the daily peak load, in terms of CPU and memory usage, for up to five selected virtual machines over a given period of time. The following parameters must be provided to run this report:
Table 21.21. Multiple Virtual Machines Resource Usage (Over Time) Parameters
| Parameter | Description |
|---|---|
Show Deleted Entities? | The report includes deleted objects, such as data centers, clusters, and hosts removed from the environment. |
Period Range | The report is for the period range selected. Daily reports cover a single day. Monthly reports cover a single month. Quarterly reports cover a three-month quarter, beginning on the month specified in the Dates parameter. Yearly reports cover a year, beginning on the month specified in the Dates parameter. |
Dates | The report covers the selected period range, beginning on this date. Daily period ranges pass in one day increments. For a Monthly period range, the selected month is used. For a Quarterly period range, the quarter is determined as beginning on the selected month. A yearly period range also starts on the selected month. |
Data Center | The list of options for the Cluster parameter includes only clusters in the selected data center. The options list shows only data centers that contain clusters. |
Cluster | The list of options for the VM List parameter include only virtual machines in the selected cluster. The options list shows only clusters in the selected data center. If All is selected, the list of options for the VM List parameter includes all virtual machines in the selected data center. |
Virtual Machine Type | The list of options for the VM List parameter includes only virtual machines of the selected type. The options list shows only virtual machine types present in the selected data center and cluster. If All is selected, the list of options for the VM List parameter includes all virtual machine types. |
Virtual Machine List | The report includes all virtual machines selected in the virtual machine list. Select any number of virtual machines up to a maximum of five. |
21.1.15.7. Trend Reports: Single Host Resource Usage (Days of Week)
The
Single Host Resource Usage (Days of Week) report shows various resource utilization metrics for a single host over a given period of time and broken down by day of the week. The metrics include CPU usage, memory usage, number of active virtual machines and network usage. The following parameters must be provided to run this report:
Table 21.22. Single Host Resource Usage (Days of Week) Parameters
| Parameter | Description |
|---|---|
Show Deleted Entities? | The report includes deleted objects, such as data centers, clusters, and hosts removed from the environment. |
Period Range | The report is for the period range selected. Daily reports cover a single day. Monthly reports cover a single month. Quarterly reports cover a three-month quarter, beginning on the month specified in the Dates parameter. Yearly reports cover a year, beginning on the month specified in the Dates parameter. |
Dates | The report covers the selected period range, beginning on this date. Daily period ranges pass in one day increments. For a Monthly period range, the selected month is used. For a Quarterly period range, the quarter is determined as beginning on the selected month. A yearly period range also starts on the selected month. |
Data Center | The list of options for the Cluster parameter includes only clusters in the selected data center. The options list shows only data centers that contain clusters. |
Cluster | The list of options for the Host Name parameter includes only hosts in the selected cluster. The options list shows only clusters in the selected data center. If All is selected, the list of options for the Host Name parameter includes all hosts in the selected data center. |
Host Type | The list of options for the Host Name parameter includes only hosts of the selected type. The options list shows only host types present in the selected data center and cluster. If All is selected, the list of options for the Host Name parameter includes all host types. |
Host Name | The report refers to the host selected. A report is only for a single host and the user must select a host. |
21.1.15.8. Trend Reports: Single Host Resource Usage (Hour of Day)
The
Single Host Resource Usage (Hour of Day) report shows a variety of resource utilization metrics for a single host over a given period of time, broken down by hour of the day (0-23). The metrics include CPU usage, memory usage, number of active virtual machines and network usage. The following parameters must be provided to run this report:
Table 21.23. Single Host Resource Usage (Hour of Day) Parameters
| Parameter | Description |
|---|---|
Show Deleted Entities? | The report includes deleted objects, such as data centers, clusters, and hosts removed from the environment. |
Period Range | The report is for the period range selected. Daily reports cover a single day. Monthly reports cover a single month. Quarterly reports cover a three-month quarter, beginning on the month specified in the Dates parameter. Yearly reports cover a year, beginning on the month specified in the Dates parameter. |
Dates | The report covers the selected period range, beginning on this date. Daily period ranges pass in one day increments. For a Monthly period range, the selected month is used. For a Quarterly period range, the quarter is determined as beginning on the selected month. A yearly period range also starts on the selected month. |
Data Center | The list of options for the Cluster parameter includes only clusters in the selected data center. The options list shows only data centers that contain clusters. |
Cluster | The list of options for the Host Name parameter includes only hosts in the selected cluster. The options list shows only clusters in the selected data center. If All is selected, the list of options for the Host Name parameter includes all hosts in the selected data center. |
Host Type | Only hosts of the selected type will be included in the list of options for the Host Name parameter. The options list shows only host types present in the selected data center and cluster. If All is selected, the list of options for the Host Name parameter includes all host types. |
Host Name | The report refers to the host selected. A report is only for a single host and the user must select a host. |
21.1.15.9. Trend Reports: Single Virtual Machine Resources (Days of Week)
The
Single Virtual Machine Resources (Days of Week) report shows a variety of resource utilization metrics for a single virtual machine over a given period of time, broken down by day of the week. The metrics include CPU usage, memory usage, disk usage and network usage. The following parameters must be provided to run this report:
Table 21.24. Single Virtual Machine Resources (Days of Week) Parameters
| Parameter | Description |
|---|---|
Show Deleted Entities? | The report includes deleted objects, such as data centers, clusters, and hosts removed from the environment. |
Period Range | The report is for the period range selected. Daily reports cover a single day. Monthly reports cover a single month. Quarterly reports cover a three-month quarter, beginning on the month specified in the Dates parameter. Yearly reports cover a year, beginning on the month specified in the Dates parameter. |
Dates | The report covers the selected period range, beginning on this date. Daily period ranges pass in one day increments. For a Monthly period range, the selected month is used. For a Quarterly period range, the quarter is determined as beginning on the selected month. A yearly period range also starts on the selected month. |
Data Center | The list of options for the Cluster parameter includes only clusters in the selected data center. The options list shows only data centers that contain clusters. |
Cluster | The list of options for the VM Name parameter includes only virtual machines in the selected cluster. The options list shows only clusters in the selected data center. If All is selected, the list of options for the VM Name parameter includes all virtual machines in the selected data center. |
Virtual Machine Type | The list of options for the VM Name parameter includes only virtual machines of the selected type. The options list shows only virtual machine types present in the selected data center and cluster. If All is selected, the list of options for the VM Name parameter includes all virtual machine types. |
Virtual Machine Name | The report refers to the virtual machine selected. A report is only for a single virtual machine and the user must select a virtual machine. |
21.1.15.10. Trend Reports: Single Virtual Machine Resources (Hour of Day)
The
Single Virtual Machine Resources (Hour of Day) report shows a variety of resource utilization metrics for a single virtual machine over a given period of time, broken down by hour of the day (0-23). The metrics include CPU usage, memory usage, disk usage and network usage. The following parameters must be provided to run this report:
Table 21.25. Single Virtual Machine Resources (Hour of Day) Parameters
| Parameter | Description |
|---|---|
Show Deleted Entities? | The report includes deleted objects, such as data centers, clusters, and hosts removed from the environment. |
Period Range | The report is for the period range selected. Daily reports cover a single day. Monthly reports cover a single month. Quarterly reports cover a three-month quarter, beginning on the month specified in the Dates parameter. Yearly reports cover a year, beginning on the month specified in the Dates parameter. |
Dates | The report covers the selected period range, beginning on this date. Daily period ranges pass in one day increments. For a Monthly period range, the selected month is used. For a Quarterly period range, the quarter is determined as beginning on the selected month. A yearly period range also starts on the selected month. |
Data Center | The list of options for the Cluster parameter includes only clusters in the selected data center. The options list shows only data centers which contain clusters. |
Cluster | The list of options for the VM Name parameter includes only virtual machines in the selected cluster. The options list shows only clusters in the selected data center. If All is selected, the list of options for the VM Name parameter includes all virtual machines in the selected data center. |
Virtual Machine Type | The list of options for the VM Name parameter includes only virtual machines of the selected type. The options list shows only virtual machine types present in the selected data center and cluster. If All is selected, the list of options for the VM Name parameter includes all virtual machine types. |
Virtual Machine Name | The report refers to the virtual machine selected. A report is only for a single virtual machine and the user must select a virtual machine. |
21.1.15.11. Trend Reports: Single Virtual Machine Resources (Over Time)
The
Single Virtual Machine Resources (Over Time) report shows a variety of resource utilization metrics for a single virtual machine over a given period of time. The metrics include CPU usage, memory usage, disk usage and network usage. The following parameters must be provided to run this report:
Table 21.26. Single Virtual Machine Resources (Over Time) Parameters
| Parameter | Description |
|---|---|
Show Deleted Entities? | The report includes deleted objects, such as data centers, clusters, and hosts removed from the environment. |
Period Range | The report is for the period range selected. Daily reports cover a single day. Monthly reports cover a single month. Quarterly reports cover a three-month quarter, beginning on the month specified in the Dates parameter. Yearly reports cover a year, beginning on the month specified in the Dates parameter. |
Dates | The report covers the selected period range, beginning on this date. Daily period ranges pass in one day increments. For a Monthly period range, the selected month is used. For a Quarterly period range, the quarter is determined as beginning on the selected month. A yearly period range also starts on the selected month. |
Data Center | The list of options for the Cluster parameter includes only clusters in the selected data center. The options list shows only data centers that contain clusters. |
Cluster | The list of options for the VM Name parameter includes only virtual machines in the selected cluster. The options list shows only clusters in the selected data center. If All is selected, the list of options for the VM Name parameter includes all virtual machines in the selected data center. |
Virtual Machine Type | The list of options for the VM Name parameter lists only virtual machines of the selected type. The options list shows only virtual machine types present in the selected data center and cluster. If All is selected, the list of options for the VM Name parameter includes all virtual machine types. |
Virtual Machine Name | The report refers to the virtual machine selected. A report is only for a single virtual machine and the user must select a virtual machine. |
21.1.16. Ad Hoc Reports
Red Hat Enterprise Virtualization Reports provides you with a tool to create customized ad hoc reports. This tool is a component of JasperServer. To create an Ad Hoc Report as an administrator, navigate to the Create drop-down menu on the top menu bar and select Ad Hoc View to open the Data Chooser: Source window.
The
Working with the Ad Hoc Editor section of the online help explains the ad hoc report interface in detail.
21.1.17. Reports Schema: Tag History and ENUM Views
This section describes the tag history and ENUM views available to the user for querying and generating reports. Latest tag views show only living tags relations and the latest details version.
Note
delete_date and detach_date do not appear in latest views because these views provide the latest configuration of living entities, which, by definition, have not been deleted.
Tag relations and latest tag relations history views
Table 21.27. Tag Relations History in the System
| Name | Type | Description |
|---|---|---|
| history_id | integer | The unique ID of this row in the table. |
| entity_id | uuid | Unique ID of the entity or tag in the system. |
| entity_type | smallint |
|
| parent_id | uuid | Unique ID of the entity or tag in the system. |
| attach_date | timestamp with time zone | The date the entity or tag was attached to the entity or tag. |
| detach_date | timestamp with time zone | The date the entity or tag was detached from the entity or tag. |
Tag details and latest tag details views
Tag details history in the system.
Table 21.28. v3_2_tag_details_view\v3_2_latest_tag_details_view
| Name | Type | Description |
|---|---|---|
| history_id | integer | The unique ID of this row in the table. |
| tag_id | uuid | Unique ID of the tag in the system. |
| tag_name | varchar(50) | Name of the tag, as displayed in the tag tree. |
| tag_description | varchar(4000) | Description of the tag, as displayed in the edit dialog. |
| tag_path | varchar(4000) | The path to the tag in the tree. |
| tag_level | smallint | The tag level in the tree. |
| create_date | timestamp with time zone | The date this tag was added to the system. |
| update_date | timestamp with time zone | The date this tag was changed in the system. |
| delete_date | timestamp with time zone | The date this tag was deleted from the system. |
Enum translator view
The ENUM table is used to easily translate column numeric types to their meanings and lists ENUM values for columns in the history database.
Table 21.29. v3_2_enum_translator_view
| Name | Type | Description |
|---|---|---|
| enum_type | varchar(40) | The type of ENUM. |
| enum_key | smallint | The key of the ENUM. |
| value | varchar(40) | The value of the ENUM. |
21.2. History Database Reports
- 21.2.1. Red Hat Enterprise Virtualization History Database
- 21.2.2. Tracking Configuration History
- 21.2.3. Recording Statistical History
- 21.2.4. Tracking Tag History
- 21.2.5. Connecting to the History Database
- 21.2.6. Configuring the History Database
- 21.2.7. Allowing Read-Only Access to the History Database
- 21.2.8. History Database Report Examples
- 21.2.9. Statistics History Views
- 21.2.10. Configuration History Views
21.2.1. Red Hat Enterprise Virtualization History Database
Red Hat Enterprise Virtualization Reports uses data from the Red Hat Enterprise Virtualization History Database (called
ovirt_engine_history) which tracks the engine database over time.
Important
Sufficient data must exist in the history database to produce meaningful reports. Most reports use values aggregated on a daily basis. Meaningful reports can only be produced if data for at least several days is available. In particular, because trend reports are designed to highlight long term trends in the system, a sufficient history is required to highlight meaningful trends.
21.2.2. Tracking Configuration History
The ETL service,
ovirt-engine-dwhd, tracks three types of changes:
- A new entity is added to the engine database - the ETL Service replicates the change to the ovirt_engine_history database as a new entry.
- An existing entity is updated - the ETL Service replicates the change to the ovirt_engine_history database as a new entry.
- An entity is removed from the engine database - A new entry in the ovirt_engine_history database flags the corresponding entity as removed. Removed entities are only flagged as removed. To maintain correctness of historical reports and representations, they are not physically removed.
The configuration tables in the ovirt_engine_history database differ from the corresponding tables in the engine database in several ways. The most apparent difference is they contain fewer configuration columns. This is because certain configuration items are less interesting to report than others and are not kept due to database size considerations. Also, columns from a few tables in the engine database appear in a single table in ovirt_engine_history and have different column names to make viewing data more convenient and comprehensible. All configuration tables contain:
- a
history_idto indicate the configuration version of the entity; - a
create_datefield to indicate when the entity was added to the system; - an
update_datefield to indicate when the entity was changed; and - a
delete_datefield to indicate the date the entity was removed from the system.
21.2.3. Recording Statistical History
The ETL service collects data into the statistical tables every minute. Data is stored for every minute of the past 24 hours. Minute-by-minute data more than two hours old is aggregated into hourly data and stored for two months. Hourly data more than two days old is aggregated into daily data and stored for five years.
Hourly data and daily data can be found in the hourly and daily tables.
Each statistical datum is kept in its respective aggregation level table: samples, hourly, and daily history. All history tables also contain a history_id column to uniquely identify rows. Tables reference the configuration version of a host in order to enable reports on statistics of an entity in relation to its past configuration.
21.2.4. Tracking Tag History
The ETL Service collects tag information as displayed in the Administration Portal every minute and stores this data in the tags historical tables. The ETL Service tracks five types of changes:
- A tag is created in the Administration Portal - the ETL Service copies the tag details, position in the tag tree and relation to other objects in the tag tree.
- A entity is attached to the tag tree in the Administration Portal - the ETL Service replicates the addition to the ovirt_engine_history database as a new entry.
- A tag is updated - the ETL Service replicates the change of tag details to the ovirt_engine_history database as a new entry.
- An entity or tag branch is removed from the Administration Portal - the ovirt_engine_history database flags the corresponding tag and relations as removed in new entries. Removed tags and relations are only flagged as removed or detached. In order to maintain correctness of historical reports and representations, they are not physically removed.
- A tag branch is moved - the corresponding tag and relations are updated as new entries. Moved tags and relations are only flagged as updated. In order to maintain correctness of historical reports and representations, they are not physically updated.
21.2.5. Connecting to the History Database
The
ovirt_engine_history database resides within the instance of PostgreSQL that the installer creates during Red Hat Enterprise Virtualization Manager installation.
For local connections to the database, use a PostgreSQL compatible query or reporting tool with the credentials used in Red Hat Enterprise Virtualization Manager installation.
Summary
The history data warehouse can also be accessed remotely. All of the PostgreSQL configuration files that you need to change are located in /var/lib/pgsql/data
Procedure 21.1. Enabling Remote Access to the History Database
- Edit the
postgresql.conffile, and add two parameters.listen_addresses = "*"
If you want to allow access by specific hosts, use a comma separated list of IP addresses or hostnames instead of "*".ssl=on
- Edit
pg_hba.confto add:hostssl all all <net address/mask> md5
Replace <net address/mask> with the IP address and netmask of allowed hosts. For example, 192.168.0.0/24. - You can use the certificate and key created by the Red Hat Enterprise Virtualization Manager at installation,
/etc/pki/ovirt-engine/certs/engine.cerand/etc/pki/ovirt-engine/keys/engine_id_rsarespectively.- PostgreSQL requires that the certificate and key be named server.crt and server.key, respectively. You can use the
ln -sto create a soft link to put the Manager's certificate and key files where PostgreSQL expects them.# ln -s /etc/pki/ovirt-engine/certs/engine.cer /var/lib/pgsql/data/server.crt
# ln -s /etc/pki/ovirt-engine/keys/engine_id_rsa /var/lib/pgsql/data/server.key
- Alternatively, you can create a new certificate and key file. Using the commands documented in the PostgreSQL Manual, create
server.crtandserver.keyfiles.
- Stop the engine service.
# service ovirt-engine stop
- Restart the PostgreSQL service
# service postgresql restart
- Undeploy and redeploy the Jasper WAR files
- Remove the
.deployedfile:# rm /var/lib/ovirt-engine/deployments/rhevm-reports.war.deployed
This causes an.undeployedfile to be created:/var/lib/ovirt-engine/deployments/rhevm-reports.war.undeployed - When the
.undeployedfile is there, you know the app is down. Remove the.undeployedfile:# rm /var/lib/ovirt-engine/deployments/rhevm-reports.war.undeployed
- Then you can redeploy:
# touch /var/lib/ovirt-engine/deployments/rhevm-reports.war.dodeploy
Which causes a.deployedfile to be created:/var/lib/ovirt-engine/deployments/rhevm-reports.war.deployed
- Add an iptables rule to allow external machines to connect to the Manager and access PostgreSQL. For example, in a default iptables configuration, the following will insert a new rule after the SSH rule:
iptables -I INPUT 5 -p tcp -m state --state NEW --dport 5432 -j ACCEPT
- Start the engine service.
# service ovirt-engine start
Result
You have enabled a remote user with acceptable credentials to access the Red Hat Enterprise Virtualization history database.
21.2.6. Configuring the History Database
After the Manager has been configured for the first time, the basic configuration by which the engine connects to the engine database and engine history database and collects reports can be changed by editing the values in the
Default.properties file located in the /etc/ovirt-engine/ovirt-engine-dwh/ directory. The following is an outline of each of the sections in this file.
Engine History Database Connection Definitions
The options in this section allow you to configure how connections are made to the engine history database, including the driver used, the connection string, and details regarding the user by which the connection is made.
## Driver Java Class ovirtEngineHistoryDbDriverClass=org.postgresql.Driver ## JDBC Connection String ovirtEngineHistoryDbJdbcConnection=jdbc\:postgresql\://localhost\:5432/ovirt_engine_history?stringtype\=unspecified ## DB User Name ovirtEngineHistoryDbUser=engine_history ## DB Password ovirtEngineHistoryDbPassword=1269JDEF
Engine Database Connection Definitions
The options in this section allow you to configure how connections are made to the engine database, including the driver used, the connection string, and details regarding the by which the connection is made.
## Driver Java Class ovirtEngineDbDriverClass=org.postgresql.Driver ## JDBC Connection String ovirtEngineDbJdbcConnection=jdbc\:postgresql\://localhost\:5432/engine?stringtype\=unspecified ## DB User Name ovirtEngineDbUser=engine ## DB Password ovirtEngineDbPassword=3jIARVXZ
Delete Job Run Time
The option in this section allows you to specify when delete jobs will be run. The value can be changed to an integer from 0 to 23, which corresponds to the hour of the day from which the jobs will be run. A value of 0 corresponds to 12:00 a.m. and a value of 23 to 11:00 p.m.
runDeleteTime=3
Sample Collection Interval
The option in this section allows you to specify the interval at which statistics samples will be collected. The value can be changed to an integer that represents the interval in seconds.
runInterleave=60
Audit Log Error Reporting
The option in this section allows you to specify the minimum time between errors being pushed to the engine audit log. The value can be changed to an integer that represents the minimum time in milliseconds.
timeBetweenErrorEvents=300000
Table Size Controls
The options in this section allow you to specify the length of time in hours for which records are stored in the statistics table, and the version of ETL used. The value of the first three options can be changed to an integer that represents the number of hours the respective records will be kept. The value of the fourth option can be changed to a number that represents the version of ETL to be used by the data warehouse.
hoursToKeepSamples=24 hoursToKeepHourly=1440 hoursToKeepDaily=43800 etlVersion=3.3.0
21.2.7. Allowing Read-Only Access to the History Database
Summary
To allow access to the history database without allowing edits, you must create a read-only PostgreSQL user that can log in to and read from the ovirt_engine_history database. This procedure must be executed on the system on which the history database is installed.
Procedure 21.2. Allowing Read-Only Access to the History Database
- Create the user to be granted read-only access to the history database:
# psql -U postgres -c "CREATE ROLE [user name] WITH LOGIN ENCRYPTED PASSWORD '[password]';" -d ovirt_engine_history
- Grant the newly created user permission to connect to the history database:
# psql -U postgres -c "GRANT CONNECT ON DATABASE ovirt_engine_history TO [user name];"
- Grant the newly created user usage of the
publicschema:# psql -U postgres -c "GRANT USAGE ON SCHEMA public TO [user name];" ovirt_engine_history
- Generate the rest of the permissions that will be granted to the newly created user and save them to a file:
# psql -U postgres -c "SELECT 'GRANT SELECT ON ' || relname || ' TO [user name];' FROM pg_class JOIN pg_namespace ON pg_namespace.oid = pg_class.relnamespace WHERE nspname = 'public' AND relkind IN ('r', 'v');" --pset=tuples_only=on ovirt_engine_history > grant.sql - Use the file you created in the previous step to grant permissions to the newly created user:
# psql -U postgres -f grant.sql ovirt_engine_history
- Remove the file you used to grant permissions to the newly created user:
# rm grant.sql
Result
You can now access the ovirt_engine_history database with the newly created user using the following command:
# psql -U [user name] ovirt_engine_history
SELECT statements against tables and views in the ovirt_engine_history database succeed, while modifications fail.
21.2.8. History Database Report Examples
The following examples provide an introduction to reports produced from queries to the ovirt_engine_history database. The database gives users access to a rich data set and enables a variety of complex reporting scenarios. These examples illustrate only basic reporting requirements.
Resource Utilization on a Single Host
This example produces a resource utilization report for a single host. The resource utilization report provides CPU- and memory-usage percentage information from readings taken at one-minute intervals. This kind of report is useful for gaining insight into the load factor of an individual host over a short period of time. The report is defined by the following SQL query. Ensure the values provided for the host_name and history_datetime components of the where clause are substituted with the appropriate values for your environment and that the latest configuration is in use.
Example 21.1. Report query for resource utilization on a single host
select history_datetime as DateTime, cpu_usage_percent as CPU, memory_usage_percent as Memory from host_configuration, host_samples_history where host_configuration.host_id = host_samples_history.host_id and host_name = 'example.labname.abc.company.com' and host_configuration.history_id in (select max(a.history_id) from host_configuration as a where host_configuration.host_id = a.host_id) and history_datetime >= '2011-07-01 18:45' and history_datetime <= '2011-07-31 21:45'
This query returns a table of data with one row per minute:
Table 21.30. Resource Utilization for a Single Host Example Data
| DateTime | CPU | Memory |
|---|---|---|
| 2010-07-01 18:45 | 42 | 0 |
| 2010-07-01 18:46 | 42 | 0 |
| 2010-07-01 18:47 | 42 | 1 |
| 2010-07-01 18:48 | 33 | 0 |
| 2010-07-01 18:49 | 33 | 0 |
| 2010-07-01 18:50 | 25 | 1 |
Compose the data into a graph or chart using third party data analysis and visualization tools such as OpenOffice.org Calc and Microsoft Excel. For this example, a line graph showing the utilization for a single host over time is a useful visualization. Figure 21.12, “Single host utilization line graph” was produced using the Chart Wizard tool in OpenOffice.org Calc.
Resource Utilization Across All Hosts
This example produces an aggregated resource utilization report across all hosts in the Red Hat Enterprise Virtualization Manager environment. Aggregated usage percentages for CPU and memory are shown with an hourly temporal resolution. This kind of report reveals utilization trends for the entire environment over a long period of time and is useful for capacity planning purposes. The following SQL query defines the report. Ensure the values provided for the history_datetime components of the where clause are substituted with appropriate values for your environment.
Example 21.2. Report query for resource utilization across all hosts
select extract(hour from history_datetime) as Hour, avg(cpu_usage_percent) as CPU, avg(memory_usage_percent) as Memory from host_hourly_history where history_datetime >= '2011-07-01' and history_datetime < '2011-07-31' group by extract(hour from history_datetime) order by extract(hour from history_datetime)
This query returns a table of data with one row per hour:
Table 21.31. Resource utilization across all hosts example data
| Hour | CPU | Memory |
|---|---|---|
| 0 | 39 | 40 |
| 1 | 38 | 38 |
| 2 | 37 | 32 |
| 3 | 35 | 45 |
| 4 | 35 | 37 |
| 5 | 36 | 37 |
Compose the data into a graph or chart using third party data analysis and visualization tools such as OpenOffice.org Calc and Microsoft Excel. For this example, a line graph showing the total system utilization over time is a useful visualization. Figure 21.13, “Total system utilization line graph” was produced using the Chart Wizard tool in OpenOffice.org Calc.
Tag Filter of Latest VM Configuration
This example filters the latest virtual machine configuration list using the history tag tables. This kind of report demonstrates usage of the tags tree built in the Red Hat Enterprise Virtualization Manager to filter lists. The following SQL query defines this report. This query uses a predefined function that receives tag history IDs and returns the tag path with latest names of the tags in the Administration Portal. Ensure the values provided for the function result components of the where clause are substituted with appropriate values for your environment.
Example 21.3.
SELECT vm_name FROM vm_configuration inner join latest_tag_relations_history on (vm_configuration.vm_id = latest_tag_relations_history.entity_id) inner join latest_tag_details on (latest_tag_details.tag_id = latest_tag_relations_history.parent_id) WHERE getpathinnames(latest_tag_details.history_id) like '/root/tlv%'
This query returns a table of data with all virtual machine names that are attached to this tag:
Table 21.32. Tag Filtering of Latest VM Configuration
| vm_name |
|---|
| RHEL6-Pool-67 |
| RHEL6-Pool-5 |
| RHEL6-Pool-6 |
| RHEL6-23 |
List Current Virtual Machines' Names, Types, and Operating Systems
This example produces a list of all current virtual machines names, types and operating systems in the Red Hat Enterprise Virtualization Manager environment. This kind of report demonstrates the usage of the ENUM table. The following SQL query defines this report:
Example 21.4.
SELECT vm_name, vm_type, operating_system FROM vm_configuration inner join enum_translator as vm_type_value on (vm_type_value.enum_type = 'VM_TYPE' and vm_configuration.vm_type = vm_type_value.enum_key) inner join enum_translator as os_value on (os_value.enum_type = 'OS_TYPE' and vm_configuration.operating_system = os_value.enum_key)
This query returns a table of virtual machines with OS and VM Type data:
Table 21.33. Current Virtual Machines' Names, Types, and Operating Systems
| vm_name | vm_type | operating_system |
|---|---|---|
| RHEL6-Pool-2 | Desktop | RHEL 6 x64 |
| RHEL6-Pool-1 | Desktop | RHEL 6 x64 |
| RHEL6-Pool-3 | Desktop | RHEL 6 x64 |
| RHEL6-Pool-4 | Desktop | RHEL 6 x64 |
| RHEL6-Pool-5 | Desktop | RHEL 6 x64 |
21.2.9. Statistics History Views
21.2.9.1. Statistics History Views
This section describes the statistics history views available to the user for querying and generating reports.
21.2.9.2. Datacenter Statistics Views
Historical statistics for each data center in the system.
Table 21.34. Historical Statistics for Each Data Center in the System
| Name | Type | Description |
|---|---|---|
| history_id | integer | The unique ID of this row in the table. |
| history_datetime | timestamp with time zone | The timestamp of this history row (rounded to minute, hour, day as per the aggregation level). |
| datacenter_id | uuid | The unique ID of the data center. |
| datacenter_status | smallint |
|
| minutes_in_status | decimal | The total number of minutes that the data center was in the status shown in the datacenter_status column for the aggregation period. For example, if a data center was up for 55 minutes and in maintenance mode for 5 minutes during an hour, two rows will show for this hour. One will have a datacenter_status of Up and minutes_in_status of 55, the other will have a datacenter_status of Maintenance and a minutes_in_status of 5. |
| datacenter_configuration_version | integer | The data center configuration version at the time of sample. |
21.2.9.3. Storage Domain Statistics Views
Table 21.35. Historical Statistics for Each Storage Domain in the System
| Name | Type | Description |
|---|---|---|
| history_id | integer | The unique ID of this row in the table. |
| history_datetime | timestamp with time zone | The timestamp of this history row (rounded to minute, hour, day as per the aggregation level). |
| storage_domain_id | uuid | Unique ID of the storage domain in the system. |
| available_disk_size_gb | integer | The total available (unused) capacity on the disk, expressed in gigabytes (GB). |
| used_disk_size_gb | integer | The total used capacity on the disk, expressed in gigabytes (GB). |
| storage_configuration_version | integer | The storage domain configuration version at the time of sample. |
21.2.9.4. Host Statistics Views
Table 21.36. Historical Statistics for Each Host in the System
| Name | Type | Description |
|---|---|---|
| history_id | integer | The unique ID of this row in the table. |
| history_datetime | timestamp with time zone | The timestamp of this history row (rounded to minute, hour, day as per the aggregation level). |
| host_id | uuid | Unique ID of the host in the system. |
| host_status | smallint |
|
| minutes_in_status | decimal | The total number of minutes that the host was in the status shown in the status column for the aggregation period. For example, if a host was up for 55 minutes and down for 5 minutes during an hour, two rows will show for this hour. One will have a status of Up and minutes_in_status of 55, the other will have a status of Down and a minutes_in_status of 5. |
| memory_usage_percent | smallint | Percentage of used memory on the host. |
| max_memory_usage | smallint | Percentage of used memory on the host. |
| cpu_usage_percent | smallint | Used CPU percentage on the host. |
| max_cpu_usage | smallint | The maximum CPU usage for the aggregation period, expressed as a percentage. For hourly aggregations, this is the maximum collected sample value. For daily aggregations, it is the maximum hourly average value. |
| ksm_cpu_percent | smallint | CPU percentage ksm on the host is using. |
| max_ksm_cpu_percent | smallint | The maximum KSM usage for the aggregation period, expressed as a percentage. For hourly aggregations, this is the maximum collected sample value. For daily aggregations, it is the maximum hourly average value. |
| active_vms | smallint | The average number of active virtual machines for this aggregation. |
| max_active_vms | smallint | The maximum active number of virtual machines for the aggregation period. For hourly aggregations, this is the maximum collected sample value. For daily aggregations, it is the maximum hourly average value. |
| total_vms | smallint | The average number of all virtual machines on the host for this aggregation. |
| max_total_vms | smallint | The maximum total number of virtual machines for the aggregation period. For hourly aggregations, this is the maximum collected sample value. For daily aggregations, it is the maximum hourly average value. |
| total_vms_vcpus | smallint | Total number of VCPUs allocated to the host. |
| max_total_vms_vcpus | smallint | The maximum total virtual machine VCPU number for the aggregation period. For hourly aggregations, this is the maximum collected sample value. For daily aggregations, it is the maximum hourly average value. |
| cpu_load | smallint | The CPU load of the host. |
| max_cpu_load | smallint | The maximum CPU load for the aggregation period. For hourly aggregations, this is the maximum collected sample value. For daily aggregations, it is the maximum hourly average value. |
| system_cpu_usage_percent | smallint | Used CPU percentage on the host. |
| max_system_cpu_usage_percent | smallint | The maximum system CPU usage for the aggregation period, expressed as a percentage. For hourly aggregations, this is the maximum collected sample value. For daily aggregations, it is the maximum hourly average value. |
| user_cpu_usage_percent | smallint | Used user CPU percentage on the host. |
| max_user_cpu_usage_percent | smallint | The maximum user CPU usage for the aggregation period, expressed as a percentage. For hourly aggregations, this is the maximum collected sample value. For daily aggregations, it is the maximum hourly average value. |
| swap_used_mb | integer | Used swap size usage of the host in megabytes (MB). |
| max_swap_used_mb | integer | The maximum user swap size usage of the host for the aggregation period in megabytes (MB), expressed as a percentage. For hourly aggregations, this is the maximum collected sample value. For daily aggregations, it is the maximum hourly average value. |
| host_configuration_version | integer | The host configuration version at the time of sample. |
21.2.9.5. Host Interface Statistics Views
Historical Statistics for Each Host Network Interface in the System
Table 21.37. Historical Statistics for Each Host Network Interface in the System
| Name | Type | Description |
|---|---|---|
| history_id | integer | The unique ID of this row in the table. |
| history_datetime | timestamp with time zone | The timestamp of this history view (rounded to minute, hour, day as per the aggregation level). |
| host_interface_id | uuid | Unique identifier of the interface in the system. |
| receive_rate_percent | smallint | Used receive rate percentage on the host. |
| max_receive_rate_percent | smallint | The maximum receive rate for the aggregation period, expressed as a percentage. For hourly aggregations, this is the maximum collected sample value. For daily aggregations, it is the maximum hourly average value. |
| transmit_rate_percent | smallint | Used transmit rate percentage on the host. |
| max_transmit_rate_percent | smallint | The maximum transmit rate for the aggregation period, expressed as a percentage. For hourly aggregations, this is the maximum collected sample value. For daily aggregations, it is the maximum hourly average value. |
| host_interface_configuration_version | integer | The host interface configuration version at the time of sample. |
21.2.9.6. Virtual Machine Statistics Views
Table 21.38. Historical statistics for the virtual machines in the system
| Name | Type | Description |
|---|---|---|
| history_id | integer | The unique ID of this row in the table. |
| history_datetime | timestamp with time zone | The timestamp of this history row (rounded to minute, hour, day as per the aggregation level). |
| vm_id | uuid | Unique ID of the virtual machine in the system. |
| vm_status | smallint |
|
| minutes_in_status | decimal | The total number of minutes that the virtual machine was in the status shown in the status column for the aggregation period. For example, if a virtual machine was up for 55 minutes and down for 5 minutes during an hour, two rows will show for this hour. One will have a status of Up and minutes_in_status, the other will have a status of Down and a minutes_in_status of 5. |
| cpu_usage_percent | smallint | The percentage of the CPU in use by the virtual machine. |
| max_cpu_usage | smallint | The maximum CPU usage for the aggregation period, expressed as a percentage. For hourly aggregations, this is the maximum collected sample value. For daily aggregations, it is the maximum hourly average value. |
| memory_usage_percent | smallint | Percentage of used memory in the virtual machine. The guest tools must be installed on the virtual machine for memory usage to be recorded. |
| max_memory_usage | smallint | The maximum memory usage for the aggregation period, expressed as a percentage. For hourly aggregations, this is the maximum collected sample value. For daily aggregations, it is the maximum hourly average value. The guest tools must be installed on the virtual machine for memory usage to be recorded. |
| user_cpu_usage_percent | smallint | Used user CPU percentage on the host. |
| max_user_cpu_usage_percent | smallint | The maximum user CPU usage for the aggregation period, expressed as a percentage. For hourly aggregations, this is the maximum collected sample value. For daily aggregation, it is the maximum hourly average value. |
| system_cpu_usage_percent | smallint | Used system CPU percentage on the host. |
| max_system_cpu_usage_percent | smallint | The maximum system CPU usage for the aggregation period, expressed as a percentage. For hourly aggregations, this is the maximum collected sample value. For daily aggregations, it is the maximum hourly average value. |
| vm_ip | varchar(255) | The IP address of the first NIC. Only shown if the guest agent is installed. |
| current_user_name | varchar(255) | Name of user logged into the virtual machine console, if a guest agent is installed. |
| currently_running_on_host | uuid | The unique ID of the host the virtual machine is running on. |
| vm_configuration_version | integer | The virtual machine configuration version at the time of sample. |
| current_host_configuration_version | integer | The current host the virtual machine is running on. |
21.2.9.7. Virtual Machine Interface Statistics Views
Table 21.39. Historical Statistics for the Virtual Machine Network Interfaces in the System
| Name | Type | Description |
|---|---|---|
| history_id | integer | The unique ID of this row in the table. |
| history_datetime | timestamp with time zone | The timestamp of this history row (rounded to minute, hour, day as per the aggregation level). |
| vm_interface_id | uuid | Unique identifier of the interface in the system. |
| receive_rate_percent | smallint | Used receive rate percentage on the host. |
| max_receive_rate_percent | smallint | The maximum receive rate for the aggregation period, expressed as a percentage. For hourly aggregations, this is the maximum collected sample value. For daily aggregations, it is the maximum hourly average value. |
| transmit_rate_percent | smallint | Used transmit rate percentage on the host. |
| max_transmit_rate_percent | smallint | The maximum transmit rate for the aggregation period, expressed as a percentage. For hourly aggregations, this is the maximum collected sample value. For daily aggregations, it is the maximum hourly average rate. |
| vm_interface_configuration_version | integer | The virtual machine interface configuration version at the time of sample. |
21.2.9.8. Virtual Machine Disk Statistics Views
Table 21.40. Historical Statistics for the Virtual Disks in the System
| Name | Type | Description |
|---|---|---|
| history_id | integer | The unique ID of this row in the table. |
| history_datetime | timestamp with time zone | The timestamp of this history row (rounded to minute, hour, day as per the aggregation level). |
| vm_disk_id | uuid | Unique ID of the disk in the system. |
| vm_disk_status | integer |
|
| minutes_in_status | decimal | The total number of minutes that the virtual machine disk was in the status shown in the status column for the aggregation period. For example, if a virtual machine disk was locked for 55 minutes and OK for 5 minutes during an hour, two rows will show for this hour. One will have a status of Locked and minutes_in_status of 55, the other will have a status of OK and a minutes_in_status of 5. |
| vm_disk_actual_size_mb | integer | The actual size allocated to the disk. |
| read_rate_bytes_per_second | integer | Read rate to disk in bytes per second. |
| max_read_rate_bytes_per_second | integer | The maximum read rate for the aggregation period. For hourly aggregations, this is the maximum collected sample value. For daily aggregations, it is the maximum hourly average value. |
| read_latency_seconds | decimal | The virtual machine disk read latency measured in seconds. |
| max_read_latency_seconds | decimal | The maximum write latency for the aggregation period, measured in seconds. For hourly aggregations, this is the maximum collected sample value. For daily aggregations, it is the maximum hourly average value. |
| write_rate_bytes_per_second | integer | Write rate to disk in bytes per second. |
| max_write_rate_bytes_per_second | integer | The maximum write rate for the aggregation period. For hourly aggregations, this is the maximum collected sample value. For daily aggregations, it is the maximum hourly average value. |
| write_latency_seconds | decimal | The virtual machine disk write latency measured in seconds. |
| max_write_latency_seconds | decimal | The maximum write latency for the aggregation period, measured in seconds. For hourly aggregations, this is the maximum collected sample value. For daily aggregations, it is the maximum hourly average value. |
| flush_latency_seconds | decimal | The virtual machine disk flush latency measured in seconds. |
| max_flush_latency_seconds | decimal | The maximum flush latency for the aggregation period, measured in seconds. For hourly aggregations, this is the maximum collected sample value. For daily aggregations, it is the maximum hourly average value. |
| vm_disk_configuration_version | integer | The virtual machine disk configuration version at the time of sample. |
21.2.10. Configuration History Views
21.2.10.1. Configuration History Views
This section describes the configuration views available to the user for querying and generating reports.
Note
delete_date does not appear in latest views because these views provide the latest configuration of living entities, which, by definition, have not been deleted.
21.2.10.2. Data Center Configuration
Data centers configuration history in the system.
Table 21.41. v3_2_configuration_history_datacenters
| Name | Type | Description |
|---|---|---|
| history_id | integer | The ID of the configuration version in the history database. |
| datacenter_id | uuid | The unique ID of the data center in the system. |
| datacenter_name | varchar(40) | Name of the data center, as displayed in the edit dialog. |
| datacenter_description | varchar(4000) | Description of the data center, as displayed in the edit dialog. |
| storage_type | smallint |
|
| create_date | timestamp with time zone | The date this entity was added to the system. |
| update_date | timestamp with time zone | The date this entity was changed in the system. |
| delete_date | timestamp with time zone | The date this entity was deleted from the system. |
21.2.10.3. Datacenter Storage Domain Map
A historical map showing the relationships between storage domains and data centers in the system.
Table 21.42. v3_2_map_history_datacenters_storage_domains
| Name | Type | Description |
|---|---|---|
| history_id | integer | The ID of the configuration version in the history database. |
| storage_domain_id | uuid | The unique ID of this storage domain in the system. |
| datacenter_id | uuid | The unique ID of the data center in the system. |
| attach_date | timestamp with time zone | The date the storage domain was attached to the data center. |
| detach_date | timestamp with time zone | The date the storage domain was detached from the data center. |
21.2.10.4. Storage Domain Configuration
Storage domains configuration history in the system.
Table 21.43. v3_2_configuration_history_storage_domains
| Name | Type | Description |
|---|---|---|
| history_id | integer | The ID of the configuration version in the history database. |
| storage_domain_id | uuid | The unique ID of this storage domain in the system. |
| storage_domain_name | varchar(250) | Storage domain name. |
| storage_domain_type | smallint |
|
| storage_type | smallint |
|
| create_date | timestamp with time zone | The date this entity was added to the system. |
| update_date | timestamp with time zone | The date this entity was changed in the system. |
| delete_date | timestamp with time zone | The date this entity was deleted from the system. |
21.2.10.5. Cluster Configuration
Clusters configuration history in the system.
Table 21.44. v3_2_configuration_history_clusters
| Name | Type | Description |
|---|---|---|
| history_id | integer | The ID of the configuration version in the history database. |
| cluster_id | uuid | The unique identifier of the datacenter this cluster resides in. |
| cluster_name | varchar(40) | Name of the cluster, as displayed in the edit dialog. |
| cluster_description | varchar(4000) | As defined in the edit dialog. |
| datacenter_id | uuid | The unique identifier of the datacenter this cluster resides in. |
| cpu_name | varchar(255) | As displayed in the edit dialog. |
| compatibility_version | varchar(40) | As displayed in the edit dialog. |
| datacenter_configuration_version | integer | The data center configuration version at the time of creation or update. |
| create_date | timestamp with time zone | The date this entity was added to the system. |
| update_date | timestamp with time zone | The date this entity was changed in the system. |
| delete_date | timestamp with time zone | The date this entity was deleted from the system. |
21.2.10.6. Host Configuration
Host configuration history in the system.
Table 21.45. v3_2_configuration_history_hosts
| Name | Type | Description |
|---|---|---|
| history_id | integer | The ID of the configuration version in the history database. |
| host_id | uuid | The unique ID of the host in the system. |
| host_unique_id | varchar(128) | This field is a combination of the host physical UUID and one of its MAC addresses, and is used to detect hosts already registered in the system. |
| host_name | varchar(255) | Name of the host (same as in the edit dialog). |
| cluster_id | uuid | The unique ID of the cluster that this host belongs to. |
| host_type | smallint |
|
| fqdn_or_ip | varchar(255) | The host's DNS name or its IP address for Red Hat Enterprise Virtualization Manager to communicate with (as displayed in the edit dialog). |
| memory_size_mb | integer | The host's physical memory capacity, expressed in megabytes (MB). |
| swap_size_mb | integer | The host swap partition size. |
| cpu_model | varchar(255) | The host's CPU model. |
| number_of_cores | smallint | Total number of CPU cores in the host. |
| host_os | varchar(255) | The host's operating system version. |
| pm_ip_address | varchar(255) | Power Management server IP address. |
| kernel_version | varchar(255) | The host's kernel version. |
| kvm_version | varchar(255) | The host's KVM version. |
| vdsm_version | varchar(40) | The host's VDSM version. |
| vdsm_port | integer | As displayed in the edit dialog. |
| cluster_configuration_version | integer | The cluster configuration version at the time of creation or update. |
| create_date | timestamp with time zone | The date this entity was added to the system. |
| update_date | timestamp with time zone | The date this entity was changed in the system. |
| delete_date | timestamp with time zone | The date this entity was deleted from the system. |
21.2.10.7. Host Interface Configuration
Host interface configuration history in the system.
Table 21.46. v3_2_configuration_history_hosts_interfaces
| Name | Type | Description |
|---|---|---|
| history_id | integer | The ID of the configuration version in the history database. |
| host_interface_id | uuid | The unique ID of this interface in the system. |
| host_interface_name | varchar(50) | The interface name as reported by the host. |
| host_id | uuid | Unique ID of the host this interface belongs to. |
| host_interface_type | smallint |
|
| host_interface_speed_bps | integer | The interface speed in bits per second. |
| mac_address | varchar(20) | The interface MAC address. |
| network_name | varchar(50) | The logical network associated with the interface. |
| ip_address | varchar(50) | As displayed in the edit dialog. |
| gateway | varchar(20) | As displayed in the edit dialog. |
| bond | Boolean | A flag to indicate if this interface is a bonded interface. |
| bond_name | varchar(50) | The name of the bond this interface is part of (if it is part of a bond). |
| vlan_id | integer | As displayed in the edit dialog. |
| host_configuration_version | integer | The host configuration version at the time of creation or update. |
| create_date | timestamp with time zone | The date this entity was added to the system. |
| update_date | timestamp with time zone | The date this entity was changed in the system. |
| delete_date | timestamp with time zone | The date this entity was deleted from the system. |
21.2.10.8. Virtual Machine Configuration
A list of all virtual machines in the system.
Table 21.47. v3_2_configuration_history_vms
| Name | Type | Description |
|---|---|---|
| history_id | integer | The ID of the configuration version in the history database. |
| vm_id | uuid | The unique ID of this VM in the system. |
| vm_name | varchar(255) | The name of the VM. |
| vm_description | varchar(4000) | As displayed in the edit dialog. |
| vm_type | smallint |
|
| cluster_id | uuid | The unique ID of the cluster this VM belongs to. |
| template_id | uuid | The unique ID of the template this VM is derived from. The field is for future use, as the templates are not synchronized to the history database in this version. |
| template_name | varchar(40) | Name of the template from which this VM is derived. |
| cpu_per_socket | smallint | Virtual CPUs per socket. |
| number_of_sockets | smallint | Total number of virtual CPU sockets. |
| memory_size_mb | integer | Total memory allocated to the VM, expressed in megabytes (MB). |
| operating_system | smallint |
|
| ad_domain | varchar(40) | As displayed in the edit dialog. |
| default_host | uuid | As displayed in the edit dialog, the ID of the default host in the system. |
| high_availability | Boolean | As displayed in the edit dialog. |
| initialized | Boolean | A flag to indicate if this VM was started at least once for Sysprep initialization purposes. |
| stateless | Boolean | As displayed in the edit dialog. |
| fail_back | Boolean | As displayed in the edit dialog. |
| usb_policy | smallint | As displayed in the edit dialog. |
| time_zone | varchar(40) | As displayed in the edit dialog. |
| cluster_configuration_version | integer | The cluster configuration version at the time of creation or update. |
| default_host_configuration_version | integer | The host configuration version at the time of creation or update. |
| create_date | timestamp with time zone | The date this entity was added to the system. |
| update_date | timestamp with time zone | The date this entity was changed in the system. |
| delete_date | timestamp with time zone | The date this entity was deleted from the system. |
21.2.10.9. Virtual Machine Interface Configuration History
Virtual interfaces configuration history in the system
Table 21.48. v3_2_configuration_history_vms_interfaces
| Name | Type | Description |
|---|---|---|
| history_id | integer | The ID of the configuration version in the history database. |
| vm_interface_id | uuid | The unique ID of this interface in the system. |
| vm_interface_name | varchar(50) | As displayed in the edit dialog. |
| vm_id | uuid | The ID of the virtual machine this interface belongs to. |
| vm_interface_type | smallint |
The type of the virtual interface.
|
| vm_interface_speed_bps | integer | The average speed of the interface during the aggregation in bits per second. |
| mac_address | varchar(20) | As displayed in the edit dialog. |
| network_name | varchar(50) | As displayed in the edit dialog. |
| vm_configuration_version | integer | The virtual machine configuration version at the time of creation or update. |
| create_date | timestamp with time zone | The date this entity was added to the system. |
| update_date | timestamp with time zone | The date this entity was changed in the system. |
| delete_date | timestamp with time zone | The date this entity was deleted from the system. |
21.2.10.10. Disks to Virtual Machine Map
A historical map showing the relationships between virtual disks and virtual machines in the system.
Table 21.49. disks_vm_map table
| Name | Type | Description |
|---|---|---|
| history_id | integer | The ID of the configuration version in the history database. |
| vm_disk_id | uuid | The unique ID of this virtual disk in the system. |
| vm_id | uuid | The unique ID of the virtual machine in the system. |
| attach_date | timestamp with time zone | The date the virtual disk was attached to the virtual machine. |
| detach_date | timestamp with time zone | The date the virtual disk was detached from the virtual machine. |
21.2.10.11. Virtual Machine Disk Configuration
Virtual disks configuration history in the system.
Table 21.50. v3_2_configuration_history_vms_disks
| Name | Type | Description |
|---|---|---|
| history_id | integer | The ID of the configuration version in the history database. |
| vm_disk_id | uuid | The unique ID of this disk in the system. |
| vm_disk_description | varchar(4000) | As displayed in the edit dialog. |
| storage_domain_id | uuid | The ID of the storage domain this disk image belongs to. |
| vm_disk_size_mb | integer | The defined size of the disk in megabytes (MB). |
| vm_disk_type | integer |
As displayed in the edit dialog. Only System and data are currently used.
|
| vm_disk_format | integer |
As displayed in the edit dialog.
|
| vm_disk_interface | integer |
|
| create_date | timestamp with time zone | The date this entity was added to the system. |
| update_date | timestamp with time zone | The date this entity was changed in the system. |
| delete_date | timestamp with time zone | The date this entity was deleted from the system. |
21.3. Dashboards
21.3.1. Dashboards
A dashboard is a collection of related reports that provide a summary of resource usage in the virtualized environment. Dashboards feature an active control panel, allowing quick adjustment of the parameters. Though a dashboard cannot be exported or printed, each of the reports in a dashboard can be opened separately to export, print, save, or adjust the data.
Dashboards can be created and configured using the
Designer, in the Reports Portal. For more information on dashboards, consult the JasperReports documentation by clicking the in the top menu bar of the Reports Portal.
21.3.2. Inventory Dashboard
The
Inventory Dashboard provides an executive summary of the inventory of a data center over a given period of time. The dashboard includes average disk use, number of active virtual machines, and a breakdown of host operating systems. The following parameters can be modified for this dashboard:
Table 21.51. Inventory Dashboard Parameters
| Parameter | Description |
|---|---|
Show Deleted Entities? | The report includes deleted objects, such as data centers, clusters, and hosts removed from the environment. |
Period Range | The dashboard shows data for the period range selected. Monthly dashboards cover a single month. Quarterly dashboards cover a three-month quarter, beginning on the month specified in the Dates parameter. |
Dates | The dashboard covers the selected period range, beginning on this date. For a Monthly period range, the selected month is used. For a Quarterly period range, the quarter is determined as beginning on the selected month. |
Data Center | The report refers to the selected data center. The list of options shows only data centers containing either hosts, storage domains or virtual machines. The list of options for the Cluster parameter includes only clusters in the selected data center. |
21.3.3. Trends Dashboard
The
Trends Dashboard provides an executive summary of the trends in a data center over a given period of time. The dashboard includes graphs of CPU and memory usage over time for the most highly utilized hosts and virtual machines in the data center. The following parameters can be modified for this dashboard:
Table 21.52. Trends Dashboard Parameters
| Parameter | Description |
|---|---|
Show Deleted Entities? | The report includes deleted objects, such as data centers, clusters, and hosts removed from the environment. |
Period Range | The dashboard shows data for the period range selected. Monthly dashboards cover a single month. Quarterly dashboards cover a three-month quarter, beginning on the month specified in the Dates parameter. |
Dates | The dashboard covers the selected period range, beginning on this date. For a Monthly period range, the selected month is used. For a Quarterly period range, the quarter is determined as beginning on the selected month. |
Data Center | The report refers to the selected data center. The list of options shows only data centers containing either hosts, storage domains or virtual machines. The list of options for the Cluster parameter includes only clusters in the selected data center. |
21.3.4. Uptime Dashboard
The
Uptime Dashboard provides an executive summary of the service level and uptime for a data center over a given period of time. The dashboard includes details on total uptime for each cluster in the data center for the period. The following parameters can be modified for this dashboard:
Table 21.53. Uptime Dashboard Parameters
| Parameter | Description |
|---|---|
Show Deleted Entities? | The report includes deleted objects, such as data centers, clusters, and hosts removed from the environment. |
Period Range | The dashboard shows data for the period range selected. Monthly dashboards cover a single month. Quarterly dashboards cover a three-month quarter, beginning on the month specified in the Dates parameter. |
Dates | The dashboard covers the selected period range, beginning on this date. For a Monthly period range, the selected month is used. For a Quarterly period range, the quarter is determined as beginning on the selected month. |
Data Center | The report refers to the selected data center. The list of options shows only data centers containing either hosts, storage domains or virtual machines. The list of options for the Cluster parameter includes only clusters in the selected data center. |
21.3.5. Integrated Reporting Dashboard in the Red Hat Enterprise Virtualization Administration Portal
The Administration Portal also features dashboards for data centers, clusters, and the overall environment. Select the appropriate resource in tree mode and click the resource tab to display the dashboard information in the results list.
The dashboards accessible in the Administration Portal are used for viewing data, as such they do not have an active control panel. Configure these dashboards in the Reports Portal by editing
Datacenter Dashboard, Cluster Dashboard, and System Dashboard.
A.1. Red Hat Enterprise Virtualization Manager Firewall Requirements
The Red Hat Enterprise Virtualization Manager requires that a number of ports be opened to allow network traffic through the system's firewall. The
engine-setup script is able to configure the firewall automatically, but this will overwrite any pre-existing firewall configuration.
Where an existing firewall configuration exists the firewall rules required by the Manager must instead be manually inserted into it. The
engine-setup command will save a list of the iptables rules required in the /usr/share/ovirt-engine/conf/iptables.example file.
The firewall configuration documented here assumes a default configuration. Where non-default HTTP and HTTPS ports are chosen during installation adjust the firewall rules to allow network traffic on the ports that were selected - not the default ports (
80 and 443) listed here.
Table A.1. Red Hat Enterprise Virtualization Manager Firewall Requirements
| Port(s) | Protocol | Source | Destination | Purpose |
|---|---|---|---|---|
| - | ICMP |
|
| When registering to the Red Hat Enterprise Virtualization Manager, virtualization hosts send an ICMP ping request to the Manager to confirm that it is online. |
| 22 | TCP |
|
| SSH (optional) |
| 80, 443 | TCP |
|
|
Provides HTTP and HTTPS access to the Manager.
|
Important
In environments where the Red Hat Enterprise Virtualization Manager is also required to export NFS storage, such as an ISO Storage Domain, additional ports must be allowed through the firewall. Grant firewall exceptions for the ports applicable to the version of NFS in use:
NFSv4
- TCP port
2049for NFS.
NFSv3
- TCP and UDP port
2049for NFS. - TCP and UDP port
111(rpcbind/sunrpc). - TCP and UDP port specified with
MOUNTD_PORT="port" - TCP and UDP port specified with
STATD_PORT="port" - TCP port specified with
LOCKD_TCPPORT="port" - UDP port specified with
LOCKD_UDPPORT="port"
The
MOUNTD_PORT, STATD_PORT, LOCKD_TCPPORT, and LOCKD_UDPPORT ports are configured in the /etc/sysconfig/nfs file.
A.2. Virtualization Host Firewall Requirements
Both Red Hat Enterprise Linux hosts and Red Hat Enterprise Virtualization Hypervisors require that a number of ports be opened to allow network traffic through the system's firewall. In the case of the Red Hat Enterprise Virtualization Hypervisor these firewall rules are configured automatically. For Red Hat Enterprise Linux hosts however it is necessary to manually configure the firewall.
Table A.2. Virtualization Host Firewall Requirements
| Port(s) | Protocol | Source | Destination | Purpose |
|---|---|---|---|---|
| 22 | TCP |
|
| Secure Shell (SSH) access. |
| 5900 - 6411 | TCP |
|
|
Remote guest console access via VNC and SPICE. These ports must be open to facilitate client access to virtual machines.
|
| 5989 | TCP, UDP |
|
|
Used by Common Information Model Object Managers (CIMOM) to monitor virtual machines running on the virtualization host. If you wish to use a CIMOM to monitor the virtual machines in your virtualization environment then you must ensure that this port is open.
|
| 16514 | TCP |
|
|
Virtual machine migration using
libvirt.
|
| 49152 - 49216 | TCP |
|
|
Virtual machine migration and fencing using VDSM. These ports must be open facilitate both automated and manually initiated migration of virtual machines.
|
| 54321 | TCP |
|
|
VDSM communications with the Manager and other virtualization hosts.
|
Example A.1. Option Name: IPTablesConfig
Recommended (default) values: Automatically generated by vdsm bootstrap script
*filter :INPUT ACCEPT [0:0] :FORWARD ACCEPT [0:0] :OUTPUT ACCEPT [0:0] -A INPUT -m state --state ESTABLISHED,RELATED -j ACCEPT -A INPUT -p icmp -j ACCEPT -A INPUT -i lo -j ACCEPT # vdsm -A INPUT -p tcp --dport 54321 -j ACCEPT # libvirt tls -A INPUT -p tcp --dport 16514 -j ACCEPT # SSH -A INPUT -p tcp --dport 22 -j ACCEPT # guest consoles -A INPUT -p tcp -m multiport --dports 5634:6166 -j ACCEPT # migration -A INPUT -p tcp -m multiport --dports 49152:49216 -j ACCEPT # snmp -A INPUT -p udp --dport 161 -j ACCEPT # Reject any other input traffic -A INPUT -j REJECT --reject-with icmp-host-prohibited -A FORWARD -m physdev ! --physdev-is-bridged -j REJECT --reject-with icmp-host-prohibited COMMIT
A.3. Directory Server Firewall Requirements
Red Hat Enterprise Virtualization requires a directory server to support user authentication. A number of ports must be opened in the directory server's firewall to support GSS-API authentication as used by the Red Hat Enterprise Virtualization Manager.
Table A.3. Host Firewall Requirements
| Port(s) | Protocol | Source | Destination | Purpose |
|---|---|---|---|---|
| 88, 464 | TCP, UDP |
|
| Kerberos authentication. |
| 389, 636 | TCP |
|
| Lightweight Directory Access Protocol (LDAP) and LDAP over SSL. |
A.4. Database Server Firewall Requirements
Red Hat Enterprise Virtualization supports the use of a remote database server. If you plan to use a remote database server with Red Hat Enterprise Virtualization then you must ensure that the remote database server allows connections from the Manager.
Table A.4. Host Firewall Requirements
| Port(s) | Protocol | Source | Destination | Purpose |
|---|---|---|---|---|
| 5432 | TCP, UDP |
|
| Default port for PostgreSQL database connections. |
If you plan to use a local database server on the Manager itself, which is the default option provided during installation, then no additional firewall rules are required.
B.1. VDSM
The VDSM service is used by the Red Hat Enterprise Virtualization Manager to manage Red Hat Enterprise Virtualization Hypervisors and Red Hat Enterprise Linux hosts. VDSM manages and monitors the host's storage, memory and network resources. It also co-ordinates virtual machine creation, statistics gathering, log collection and other host administration tasks. VDSM is run as a daemon on each hypervisor host managed by Red Hat Enterprise Virtualization Manager. It answers XML-RPC calls from clients. The Red Hat Enterprise Virtualization Manager functions as a VDSM client.
B.2. VDSM Hooks
VDSM is extensible via hooks. Hooks are scripts executed on the host when key events occur. When a supported event occurs VDSM runs any executable hook scripts in
/usr/libexec/vdsm/hooks/nn_event-name/ on the host in alphanumeric order. By convention each hook script is assigned a two digit number, included at the front of the file name, to ensure that the order in which the scripts will be run in is clear. You are able to create hook scripts in any programming language, Python will however be used for the examples contained in this chapter.
Note that all scripts defined on the host for the event are executed. If you require that a given hook is only executed for a subset of the virtual machines which run on the host then you must ensure that the hook script itself handles this requirement by evaluating the Custom Properties associated with the virtual machine.
Warning
VDSM hooks can interfere with the operation of Red Hat Enterprise Virtualization. A bug in a VDSM hook has the potential to cause virtual machine crashes and loss of data. VDSM hooks should be implemented with caution and tested rigorously. The Hooks API is new and subject to significant change in the future.
B.3. Extending VDSM with Hooks
This chapter describes how to extend VDSM with event-driven hooks. Extending VDSM with hooks is an experimental technology, and this chapter is intended for experienced developers. Note that at this time hooks are not able to run on Red Hat Enterprise Virtualization Hypervisors, they must only be used on Red Hat Enterprise Linux hosts. By setting custom properties on virtual machines it is possible to pass additional parameters, specific to a given virtual machine, to the hook scripts.
B.4. Supported VDSM Events
Table B.1. Supported VDSM Events
| Name | Description |
|---|---|
| before_vm_start | Before virtual machine starts. |
| after_vm_start | After virtual machine starts. |
| before_vm_cont | Before virtual machine continues. |
| after_vm_cont | After virtual machine continues. |
| before_vm_pause | Before virtual machine pauses. |
| after_vm_pause | After virtual machine pauses. |
| before_vm_hibernate | Before virtual machine hibernates. |
| after_vm_hibernate | After virtual machine hibernates. |
| before_vm_dehibernate | Before virtual machine dehibernates. |
| after_vm_dehibernate | After virtual machine dehibernates. |
| before_vm_migrate_source | Before virtual machine migration, run on the source hypervisor host from which the migration is occurring. |
| after_vm_migrate_source | After virtual machine migration, run on the source hypervisor host from which the migration is occurring. |
| before_vm_migrate_destination | Before virtual machine migration, run on the destination hypervisor host to which the migration is occurring. |
| after_vm_migrate_destination | After virtual machine migration, run on the destination hypervisor host to which the migration is occurring. |
| after_vm_destroy | After virtual machine destruction. |
| before_vdsm_start | Before VDSM is started on the hypervisor host. before_vdsm_start hooks are executed as the user root, and do not inherit the environment of the VDSM process. |
| after_vdsm_stop | After VDSM is stopped on the hypervisor host. after_vdsm_stop hooks are executed as the user root, and do not inherit the environment of the VDSM process. |
| before_nic_hotplug | Before the NIC is hot plugged into the virtual machine. |
| after_nic_hotplug | After the NIC is hot plugged into the virtual machine. |
| before_nic_hotunplug | Before the NIC is hot unplugged from the virtual machine |
| after_nic_hotunplug | After the NIC is hot unplugged from the virtual machine. |
| after_nic_hotplug_fail | After hot plugging the NIC to the virtual machine fails. |
| after_nic_hotunplug_fail | After hot unplugging the NIC from the virtual machine fails. |
| before_disk_hotplug | Before the disk is hot plugged into the virtual machine. |
| after_disk_hotplug | After the disk is hot plugged into the virtual machine. |
| before_disk_hotunplug | Before the disk is hot unplugged from the virtual machine |
| after_disk_hotunplug | After the disk is hot unplugged from the virtual machine. |
| after_disk_hotplug_fail | After hot plugging the disk to the virtual machine fails. |
| after_disk_hotunplug_fail | After hot unplugging the disk from the virtual machine fails. |
| before_device_create | Before creating a device that supports custom properties. |
| after_device_create | After creating a device that supports custom properties. |
| before_update_device | Before updating a device that supports custom properties. |
| after_update_device | After updating a device that supports custom properties. |
| before_device_destroy | Before destroying a device that supports custom properties. |
| after_device_destroy | After destroying a device that supports custom properties. |
| before_device_migrate_destination | Before device migration, run on the destination hypervisor host to which the migration is occurring. |
| after_device_migrate_destination | After device migration, run on the destination hypervisor host to which the migration is occurring. |
| before_device_migrate_source | Before device migration, run on the source hypervisor host from which the migration is occurring. |
| after_device_migrate_source | After device migration, run on the source hypervisor host from which the migration is occurring. |
B.5. The VDSM Hook Environment
Most hook scripts are run as the
vdsm user and inherit the environment of the VDSM process. The exceptions are hook scripts triggered by the before_vdsm_start and after_vdsm_stop events. Hook scripts triggered by these events run as the root user and do not inherit the environment of the VDSM process.
B.6. The VDSM Hook Domain XML Object
When hook scripts are started, the
_hook_domxml variable is appended to the environment. This variable contains the path of the libvirt domain XML representation of the relevant virtual machine. Several hooks are an exception to this rule, as outlined below.
The
_hook_domxml variable of the following hooks contains the XML representation of the NIC and not the virtual machine.
*_nic_hotplug_**_nic_hotunplug_**_update_device*_device_create*_device_migrate_*
Important
The
before_migration_destination and before_dehibernation hooks currently receive the XML of the domain from the source host. The XML of the domain at the destination will have various differences.
The libvirt domain XML format is used by VDSM to define virtual machines. Details on the libvirt domain XML format can be found at http://libvirt.org/formatdomain.html. The uuid of the virtual machine may be deduced from the domain XML, but it is also available as the environment variable
vmId.
B.7. Defining Custom Properties
The custom properties that are accepted by the Red Hat Enterprise Virtualization Manager - and in turn passed to custom hooks - are defined using the
engine-config command. Run this command as the root user on the host where Red Hat Enterprise Virtualization Manager is installed.
The
UserDefinedVMProperties and CustomDeviceProperties configuration keys are used to store the names of the custom properties supported. Regular expressions defining the valid values for each named custom property are also contained in these configuration keys.
Multiple custom properties are separated by a semi-colon. Note that when setting the configuration key, any existing value it contained is overwritten. When combining new and existing custom properties, all of the custom properties in the command used to set the key's value must be included.
Once the configuration key has been updated, the
ovirt-engine service must be restarted for the new values to take effect.
Example B.1. Virtual Machine Properties - Defining the smartcard Custom Property
- Check the existing custom properties defined by the
UserDefinedVMPropertiesconfiguration key using the following command:# engine-config -g UserDefinedVMProperties
As shown by the output below, the custom propertymemoryis already defined. The regular expression^[0-9]+$ensures that the custom property will only ever contain numeric characters.# engine-config -g UserDefinedVMProperties UserDefinedVMProperties: version: 3.0 UserDefinedVMProperties: version: 3.1 UserDefinedVMProperties: version: 3.2 UserDefinedVMProperties: version: 3.3 UserDefinedVMProperties : memory=^[0-9]+$ version: 3.2
- Because the
memorycustom property is already defined in theUserDefinedVMPropertiesconfiguration key, the new custom property must be appended to it. The additional custom property,smartcard, is added to the configuration key's value. The new custom property is able to hold a value oftrueorfalse.# engine-config -s UserDefinedVMProperties='memory=^[0-9]+$;smartcard=^(true|false)$' --cver=3.2
- Verify that the custom properties defined by the
UserDefinedVMPropertiesconfiguration key have been updated correctly.# engine-config -g UserDefinedVMProperties UserDefinedVMProperties: version: 3.0 UserDefinedVMProperties: version: 3.1 UserDefinedVMProperties: version: 3.2 UserDefinedVMProperties: version: 3.3 UserDefinedVMProperties : memory=^[0-9]+$;smartcard=^(true|false)$ version: 3.2
- Finally, the
ovirt-engineservice must be restarted for the configuration change to take effect.# service ovirt-engine restart
Example B.2. Device Properties - Defining the interface Custom Property
- Check the existing custom properties defined by the
CustomDevicePropertiesconfiguration key using the following command:# engine-config -g CustomDeviceProperties
As shown by the output below, no custom properties have yet been defined.# engine-config -g CustomDeviceProperties CustomDeviceProperties: version: 3.0 CustomDeviceProperties: version: 3.1 CustomDeviceProperties: version: 3.2 CustomDeviceProperties: version: 3.3
- The
interfacecustom property does not already exist, so it can be appended as is. In this example, the value of thespeedsub-property is set to a range from one to five, and the value of theduplexsub-property is set to a selection of eitherfullorhalf.# engine-config -s CustomDeviceProperties="{type=interface;prop={speed=^([0-9]{1,5})$;duplex=^(full|half)$}}" --cver=3.3 - Verify that the custom properties defined by the
CustomDevicePropertiesconfiguration key have been updated correctly.# engine-config -g CustomDeviceProperties UserDefinedVMProperties: version: 3.0 UserDefinedVMProperties: version: 3.1 UserDefinedVMProperties: version: 3.2 UserDefinedVMProperties : {type=interface;prop={speed=^([0-9]{1,5})$;duplex=^(full|half)$}} version: 3.3 - Finally, the
ovirt-engineservice must be restarted for the configuration change to take effect.# service ovirt-engine restart
B.8. Setting Custom Device Properties
Once custom device properties are defined in the Red Hat Enterprise Virtualization Manager, you can begin setting them on virtual network interface cards. Custom properties are set from the VM Interface Profile window of the Profiles tab in the details pane for networks in the Administration Portal.
The VM Interface Profile window provides a facility for you to select from the list of defined custom properties. Once you select a custom property key, an additional field will display allowing you to enter a value for that key. Add additional key/value pairs by clicking the + button and remove them by clicking the - button.
B.9. Setting Virtual Machine Custom Properties
Prerequisites:
Once custom properties are defined in the Red Hat Enterprise Virtualization Manager, you can begin setting them on virtual machines. Custom properties are set on the Custom Properties tab of the New Virtual Machine and Edit Virtual Machine windows in the Administration Portal.
You can also set custom properties from the Run Virtual Machine(s) dialog box. Custom properties set from the Run Virtual Machine(s) dialog box will only apply to the virtual machine until it is next shutdown.
The Custom Properties tab provides a facility for you to select from the list of defined custom properties. Once you select a custom property key an additional field will display allowing you to enter a value for that key. Add additional key/value pairs by clicking the + button and remove them by clicking the - button.
B.10. Evaluating Virtual Machine Custom Properties in a VDSM Hook
Prerequisites:
Each key set in the Custom Properties field for a virtual machine is appended as an environment variable when calling hook scripts. Although the regular expressions used to validate the Custom Properties field provide some protection you should ensure that your scripts also validate that the inputs provided match their expectations.
Example B.3. Evaluating Custom Properties
This short Python example checks for the existence of the custom property
key1. If the custom property is set then the value is printed to standard error. If the custom property is not set then no action is taken.
#!/usr/bin/python
import os
import sys
if os.environ.has_key('key1'):
sys.stderr.write('key1 value was : %s\n' % os.environ['key1'])
else:
sys.exit(0)
B.11. Using the VDSM Hooking Module
VDSM ships with a Python hooking module, providing helper functions for VDSM hook scripts. This module is provided as an example, and is only relevant to VDSM hooks written in Python.
The hooking module supports reading of a virtual machine's libvirt XML into a DOM object. Hook scripts can then use Python's built in
xml.dom library (http://docs.python.org/release/2.6/library/xml.dom.html) to manipulate the object.
The modified object can then be saved back to libvirt XML using the hooking module. The hooking module provides the following functions to support hook development:
Table B.2. Hooking module functions
| Name | Argument | Description |
|---|---|---|
tobool | string | Converts a string "true" or "false" to a Boolean value |
read_domxml | - | Reads the virtual machine's libvirt XML into a DOM object |
write_domxml | DOM object | Writes the virtual machine's libvirt XML from a DOM object |
B.12. VDSM Hook Execution
before_vm_start scripts can edit the domain XML in order to change VDSM's definition of a virtual machine before it reaches libvirt. Caution must be exercised in doing so. Hook scripts have the potential to disrupt the operation of VDSM, and buggy scripts can result in outages to the Red Hat Enterprise Virtualization environment. In particular, ensure you never change the uuid of the domain, and do not attempt to remove a device from the domain without sufficient background knowledge.
Both
before_vdsm_start and after_vdsm_stop hook scripts are run as the root user. Other hook scripts that require root access to the system must be written to use the sudo command for privilege escalation. To support this the /etc/sudoers must be updated to allow the vdsm user to use sudo without reentering a password. This is required as hook scripts are executed non-interactively.
Example B.4. Configuring sudo for VDSM Hooks
In this example the
sudo command will be configured to allow the vdsm user to run the /bin/chown command as root.
- Log into the virtualization host as
root. - Open the
/etc/sudoersfile in a text editor. - Add this line to the file:
vdsm ALL=(ALL) NOPASSWD: /bin/chown
This specifies that thevdsmuser has the ability to run the/bin/chowncommand as therootuser. TheNOPASSWDparameter indicates that the user will not be prompted to enter their password when callingsudo.
Once this configuration change has been made VDSM hooks are able to use the
sudo command to run /bin/chown as root. This Python code uses sudo to execute /bin/chown as root on the file /my_file.
retcode = subprocess.call( ["/usr/bin/sudo", "/bin/chown", "root", "/my_file"] )
The standard error stream of hook scripts is collected in VDSM's log. This information is used to debug hook scripts.
B.13. VDSM Hook Return Codes
Hook scripts must return one of the return codes shown in Table B.3, “Hook Return Codes”. The return code will determine whether further hook scripts are processed by VDSM.
Table B.3. Hook Return Codes
| Code | Description |
|---|---|
| 0 | The hook script ended successfully |
| 1 | The hook script failed, other hooks should be processed |
| 2 | The hook script failed, no further hooks should be processed |
| >2 | Reserved |
B.14. VDSM Hook Examples
The example hook scripts provided in this section are strictly not supported by Red Hat. You must ensure that any and all hook scripts that you install to your system, regardless of source, are thoroughly tested for your environment.
Example B.5. NUMA Node Tuning
Purpose:
This hook script allows for tuning the allocation of memory on a NUMA host based on the numaset custom property. Where the custom property is not set no action is taken.
Configuration String:
numaset=^(interleave|strict|preferred):[\^]?\d+(-\d+)?(,[\^]?\d+(-\d+)?)*$
The regular expression used allows the
numaset custom property for a given virtual machine to specify both the allocation mode (interleave, strict, preferred) and the node to use. The two values are separated by a colon (:). The regular expression allows specification of the nodeset as:
- that a specific node (
numaset=strict:1, specifies that only node 1 be used), or - that a range of nodes be used (
numaset=strict:1-4, specifies that nodes 1 through 4 be used), or - that a specific node not be used (
numaset=strict:^3, specifies that node 3 not be used), or - any comma-separated combination of the above (
numaset=strict:1-4,6, specifies that nodes 1 to 4, and 6 be used).
Script:
/usr/libexec/vdsm/hooks/before_vm_start/50_numa
#!/usr/bin/python
import os
import sys
import hooking
import traceback
'''
numa hook
=========
add numa support for domain xml:
<numatune>
<memory mode="strict" nodeset="1-4,^3" />
</numatune>
memory=interleave|strict|preferred
numaset="1" (use one NUMA node)
numaset="1-4" (use 1-4 NUMA nodes)
numaset="^3" (don't use NUMA node 3)
numaset="1-4,^3,6" (or combinations)
syntax:
numa=strict:1-4
'''
if os.environ.has_key('numa'):
try:
mode, nodeset = os.environ['numa'].split(':')
domxml = hooking.read_domxml()
domain = domxml.getElementsByTagName('domain')[0]
numas = domxml.getElementsByTagName('numatune')
if not len(numas) > 0:
numatune = domxml.createElement('numatune')
domain.appendChild(numatune)
memory = domxml.createElement('memory')
memory.setAttribute('mode', mode)
memory.setAttribute('nodeset', nodeset)
numatune.appendChild(memory)
hooking.write_domxml(domxml)
else:
sys.stderr.write('numa: numa already exists in domain xml')
sys.exit(2)
except:
sys.stderr.write('numa: [unexpected error]: %s\n' % traceback.format_exc())
sys.exit(2)
C.1. Red Hat Enterprise Virtualization User Interface Plugins
Red Hat Enterprise Virtualization supports plugins that expose non-standard features. This makes it easier to use the Red Hat Enterprise Virtualization Administration Portal to integrate with other systems. Each interface plugin represents a set of user interface extensions that can be packaged and distributed for use with Red Hat Enterprise Virtualization.
Red Hat Enterprise Virtualization's User Interface plugins integrate with the Administration Portal directly on the client using the JavaScript programming language. Plugins are invoked by the Administration Portal and executed in the web browser's JavaScript runtime. User Interface plugins can use the JavaScript language and its libraries.
At key events during runtime, the Administration Portal invokes individual plugins via event handler functions representing Administration-Portal-to-plugin communication. Although the Administration Portal supports multiple event-handler functions, a plugin declares functions which are of interest only to its implementation. Each plugin must register relevant event handler functions as part of the plugin bootstrap sequence before the plugin is put to use by the administration portal.
To facilitate the plugin-to-Administration-Portal communication that drives the User Interface extension, the Administration Portal exposes the plugin API as a global (top-level) pluginApi JavaScript object that individual plugins can consume. Each plugin obtains a separate pluginApi instance, allowing the Administration Portal to control plugin API-function invocation for each plugin with respect to the plugin's lifecycle.
C.2. Red Hat Enterprise Virtualization User Interface Plugin Lifecycle
C.2.1. Red Hat Enterprise Virtualization User Interface Plugin Lifecycle
The basic lifecycle of a User Interface Plugin divides into three stages:
- Plugin discovery.
- Plugin loading.
- Plugin bootstrapping.
C.2.2. Red Hat Enterprise Virtualization User Interface Plugin Discovery
Creating plugin descriptors is the first step in the plugin discovery process. Plugin descriptors contain important plugin metadata as well as (optional) default plugin-specific configurations.
As part of handling administration portal HTML page requests (
HTTP GET), User Interface plugin infrastructure attempts to discover and load plugin descriptors from your local file system. For each plugin descriptor, the infrastructure also attempts to load corresponding plugin user configurations used to override default plugin-specific configurations (if any exist) and tweak plugin runtime behavior. Plugin user configuration is optional. After loading descriptors and corresponding user configuration files, oVirt Engine aggregates User Interface plugin data and embeds it into the administration portal HTML page for runtime evaluation.
By default, plugin descriptors reside in
$ENGINE_USR/ui-plugins, with a default mapping of ENGINE_USR=/usr/share/ovirt-engine as defined by oVirt Engine local configuration. Plugin descriptors are expected to comply with JSON format specifications, but plugin descriptors allow Java/C++ style comments (of both /* and // varieties) in addition to the JSON format specifications.
By default, plugin user configuration files reside in
$ENGINE_ETC/ui-plugins, with a default mapping of ENGINE_ETC=/etc/ovirt-engine as defined by oVirt Engine local configuration. Plugin user configuration files are expected to comply with same content format rules as plugin descriptors.
Note
Plugin user configuration files generally follow the
<descriptorFileName>-config.json naming convention.
C.2.3. Red Hat Enterprise Virtualization User Interface Plugin Loading
After a plugin has been discovered and its data is embedded into the administration portal HTML page, administration portal tries to load the plugin as part of application startup (unless you have configured it not to load as part of application startup).
For each plugin that has been discovered, the administration portal creates an HTML iframe element that is used to load its host page. The plugin host page is necessary to begin the plugin bootstrap process, which (the bootstrap process) is used to evaluate the plugin code in the context of the plugin's iframe element. User interface plugin infrastructure supports serving plugin resource files (such as the plugin host page) from the local file system. The plugin host page is loaded into the iframe element and the plugin code is evaluated. After the plugin code is evaluated, the plugin communicates with the administration portal by means of the plugin API.
C.2.4. Red Hat Enterprise Virtualization User Interface Plugin Bootstrapping
A typical plugin bootstrap sequence consists of following steps:
Procedure C.1. Plugin Bootstrap Sequence
- Obtain pluginApi instance for the given plugin
- Obtain runtime plugin configuration object (optional)
- Register relevant event handler functions
- Notify UI plugin infrastructure to proceed with plugin initialization
The following code snippet illustrates the above mentioned steps in practice:
// Access plugin API using 'parent' due to this code being evaluated within the context of an iframe element.
// As 'parent.pluginApi' is subject to Same-Origin Policy, this will only work when WebAdmin HTML page and plugin
// host page are served from same origin. WebAdmin HTML page and plugin host page will always be on same origin
// when using UI plugin infrastructure support to serve plugin resource files.
var api = parent.pluginApi('MyPlugin');
// Runtime configuration object associated with the plugin (or an empty object).
var config = api.configObject();
// Register event handler function(s) for later invocation by UI plugin infrastructure.
api.register({
// UiInit event handler function.
UiInit: function() {
// Handle UiInit event.
window.alert('Favorite music band is ' + config.band);
}
});
// Notify UI plugin infrastructure to proceed with plugin initialization.
api.ready();
C.3. User Interface Plugin-related Files and Their Locations
Table C.1. UI Plugin-related Files and their Locations
| File | Location | Remarks |
|---|---|---|
| Plugin descriptor files (meta-data) | /usr/share/ovirt-engine/ui-plugins/my-plugin.json | |
| Plugin user configuration files | /etc/ovirt-engine/ui-plugins/my-plugin-config.json | |
| Plugin resource files | /usr/share/ovirt-enging/ui-plugins/<resourcePath>/PluginHostPage.html | <resourcePath> is defined by the corresponding attribute in the plugin descriptor. |
C.4. Example User Interface Plugin Deployment
Follow these instructions to create a user interface plugin that runs a
Hello World! program when you sign in to the Red Hat Enterprise Virtualization Manager administration portal.
Procedure C.2. Deploying a Hello World! Plugin
- Create a plugin descriptor by creating the following file in the Manager at
/usr/share/ovirt-engine/ui-plugins/helloWorld.json:{ "name": "HelloWorld", "url": "/webadmin/webadmin/plugin/HelloWorld/start.html", "resourcePath": "hello-files" } - Create the plugin host page by creating the following file in the Manager at
/usr/share/ovirt-engine/ui-plugins/hello-files/start.html:<!DOCTYPE html><html><head> <script> var api = parent.pluginApi('HelloWorld'); api.register({ UiInit: function() { window.alert('Hello world'); } }); api.ready(); </script> </head><body></body></html>
If you have successfully implemented the
Hello World! plugin, you will see this screen when you sign in to the administration portal:
C.5. Using Red Hat Support Plugin
The Red Hat Access Plugin allows you to use Red Hat access services from the Red Hat Enterprise Virtualization Administration Portal. You must log in using your Red Hat login credentials. The Red Hat Access Plugin detects when you are not logged in; if you are not logged in, a login window opens.
Note
Red Hat Enterprise Virtualization Administration Portal credentials are not the same as a user's Red Hat login.
After logging in, you will be able to access the Red Hat Customer Portal. Red Hat Support Plugin is available in the details pane as well as in several context menus in the Red Hat Enterprise Virtualization Administration Portal. Search the Red Hat Access database using the
Red Hat Search: field. Search results display in the left-hand navigation list in the details pane.
Right click on context menus in the Red Hat Enterprise Virtualization Administrator Portal to access the Red Hat Support Plugin.
Open a new support case or modify an existing case by selecting the
Open New Support Case or Modify Existing Case radio buttons.
Select the
Red Hat Documentation tab to open the documentation relevant to the part of the Administration Portal currently on the screen.
D.1. Replacing the Red Hat Enterprise Virtualization Manager SSL Certificate
Summary
You want to use your organization's commercially signed certificate to identify your Red Hat Enterprise Virtualization Manager to users connecting over https.
Note
Using a commercially issued certificate for https connections does not affect the certificate used for authentication between your Manager and hosts, they will continue to use the self-signed certificate generated by the Manager.
Prerequisites
This procedure requires a PEM formatted certificate from your commercial certificate issuing authority, a .nokey file, and a .cer file. The .nokey and .cer files are sometimes distributed as a certificate-key bundle in the P12 format.
This procedure assumes that you have a certificate-key bundle in the P12 format.
Procedure D.1. Replacing the Red Hat Enterprise Virtualization Manager Apache SSL Certificate
- The Manager has been configured to use
/etc/pki/ovirt-engine/apache-ca.pem, which is symbolically linked to/etc/pki/ovirt-engine/ca.pem. Remove the symbolic link.# rm /etc/pki/ovirt-engine/apache-ca.pem
- Save your commercially issued certificate as
/etc/pki/ovirt-engine/apache-ca.pem.mv YOUR-3RD-PARTY-CERT.pem /etc/pki/ovirt-engine/apache-ca.pem
- Move your P12 bundle to
/etc/pki/ovirt-engine/keys/apache.p12. - Extract the key from the bundle.
# openssl pkcs12 -in /etc/pki/ovirt-engine/keys/apache.p12 -nocerts -nodes > /etc/pki/ovirt-engine/keys/apache.key.nopass
- Extract the certificate from the bundle.
# openssl pkcs12 -in /etc/pki/ovirt-engine/keys/apache.p12 -nokeys > /etc/pki/ovirt-engine/certs/apache.cer
- Restart the Apache server.
# service httpd restart
Result
Your users can now connect to the portals without being warned about the authenticity of the certificate used to encrypt https traffic.
Table E.1. Data Center Properties
|
Term
|
Definition
|
|---|---|
|
Brick
|
A brick is the GlusterFS basic unit of storage, represented by an export directory on a server in the trusted storage pool. A Brick is expressed by combining a server with an export directory in the following format:
SERVER:EXPORT
For example:
myhostname:/exports/myexportdir/
|
|
Block Storage
|
Block special files or block devices correspond to devices through which the system moves data in the form of blocks. These device nodes often represent addressable devices such as hard disks, CD-ROM drives, or memory-regions. Red Hat Storage supports XFS file system with extended attributes.
|
|
Cluster
|
A trusted pool of linked computers, working together closely thus in many respects forming a single computer. In Red Hat Storage terminology a cluster is called as trusted storage pool.
|
|
Client
|
The machine which mounts the volume (this may also be a server)
|
|
Distributed File System
|
A file system that allows multiple clients to concurrently access data spread across multiple servers/bricks in a trusted storage pool. Data sharing among multiple locations is fundamental to all distributed file system.
|
|
Geo-Replication
|
Geo-replication provides a continuous, asynchronous, and incremental replication service from site to another over Local Area Networks (LAN), Wide Area Network (WAN), and across the Internet.
|
|
glusterd
|
The Gluster management daemon that needs to run on all servers in the trusted storage pool.
|
|
Metadata
|
Metadata is data providing information about one or more other pieces of data.
|
|
N-way Replication
|
Local synchronous data replication typically deployed across campus or Amazon Web Services Availability Zones.
|
|
Namespace
|
Namespace is an abstract container or environment created to hold a logical grouping of unique identifiers or symbols. Each Red Hat Storage trusted storage pool exposes a single namespace as a POSIX mount point that contains every file in the trusted storage pool.
|
|
POSIX
|
Portable Operating System Interface (for Unix) is the name of a family of related standards specified by the IEEE to define the application programming interface (API), along with shell and utilities interfaces for software compatible with variants of the UNIX operating system. Red Hat Storage exports a fully POSIX compatible file system.
|
|
RAID
|
Redundant Array of Inexpensive Disks (RAID) is a technology that provides increased storage reliability through redundancy, combining multiple low-cost, less-reliable disk drives components into a logical unit where all drives in the array are interdependent.
|
|
RRDNS
|
Round Robin Domain Name Service (RRDNS) is a method to distribute load across application servers. RRDNS is implemented by creating multiple A records with the same name and different IP addresses in the zone file of a DNS server.
|
|
Server
|
The machine (virtual or bare metal) which hosts the actual file system in which data will be stored.
|
|
Scale-Up Storage
|
Increases the capacity of the storage device, but only in a single dimension. An example might be adding additional disk capacity to a single computer in a trusted storage pool.
|
|
Scale-Out Storage
|
Increases the capability of a storage device in multiple dimensions. For example adding a server to a trusted storage pool increases CPU, disk capacity, and throughput for the trusted storage pool.
|
|
Subvolume
|
A brick after being processed by at least one translator.
|
|
Translator
|
A translator connects to one or more subvolumes, does something with them, and offers a subvolume connection.
|
|
Trusted Storage Pool
|
A storage pool is a trusted network of storage servers. When you start the first server, the storage pool consists of that server alone.
|
|
User Space
|
Applications running in user space donât directly interact with hardware, instead using the kernel to moderate access. User Space applications are generally more portable than applications in kernel space. Gluster is a user space application.
|
|
Virtual File System (VFS)
|
VFS is a kernel software layer that handles all system calls related to the standard Linux file system. It provides a common interface to several kinds of file systems
|
|
Volfile
|
Volfile is a configuration file used by glusterfs process. Volfile will be usually located at
/var/lib/glusterd/vols/VOLNAME.
|
|
Volume
|
A volume is a logical collection of bricks. Most of the gluster management operations happen on the volume.
|
F.1. Search
- F.1.1. Performing Searches in Red Hat Enterprise Virtualization
- F.1.2. Search Syntax and Examples
- F.1.3. Search Auto-Completion
- F.1.4. Search Result Type Options
- F.1.5. Search Criteria
- F.1.6. Search: Multiple Criteria and Wildcards
- F.1.7. Search: Determining Search Order
- F.1.8. Searching for Data Centers
- F.1.9. Searching for Clusters
- F.1.10. Searching for Hosts
- F.1.11. Searching for Networks
- F.1.12. Searching for Storage
- F.1.13. Searching for Disks
- F.1.14. Searching for Volumes
- F.1.15. Searching for Virtual Machines
- F.1.16. Searching for Pools
- F.1.17. Searching for Templates
- F.1.18. Searching for Users
- F.1.19. Searching for Events
F.1.1. Performing Searches in Red Hat Enterprise Virtualization
The Administration Portal enables the management of thousands of resources, such as virtual machines, hosts, users, and more. To perform a search, enter the search query (free-text or syntax-based) in the search bar. Search queries can be saved as bookmarks for future reuse, so you do not have to reenter a search query each time the specific search results are needed.
F.1.2. Search Syntax and Examples
The syntax of the search queries for Red Hat Enterprise Virtualization resources is as follows:
result type: {criteria} [sortby sort_spec]
Syntax Examples
The following examples describe how the search query is used and help you to understand how Red Hat Enterprise Virtualization assists with building search queries.
Table F.1. Example Search Queries
| Example | Result |
|---|---|
| Hosts: Vms.status = up | Displays a list of all hosts running virtual machines that are up. |
| Vms: domain = qa.company.com | Displays a list of all virtual machines running on the specified domain. |
| Vms: users.name = Mary | Displays a list of all virtual machines belonging to users with the user name Mary. |
| Events: severity > normal sortby time | Displays the list of all Events whose severity is higher than Normal, sorted by time. |
F.1.3. Search Auto-Completion
The Administration Portal provides auto-completion to help you create valid and powerful search queries. As you type each part of a search query, a drop-down list of choices for the next part of the search opens below the Search Bar. You can either select from the list and then continue typing/selecting the next part of the search, or ignore the options and continue entering your query manually.
The following table specifies by example how the Administration Portal auto-completion assists in constructing a query:
Hosts: Vms.status = down
Table F.2. Example Search Queries Using Auto-Completion
| Input | List Items Displayed | Action |
|---|---|---|
h | Hosts (1 option only) |
Select
Hosts or;
Type
Hosts
|
Hosts: |
All host properties
| Type v |
Hosts: v | host properties starting with a v | Select Vms or type Vms |
Hosts: Vms | All virtual machine properties | Type s |
Hosts: Vms.s | All virtual machine properties beginning with s | Select status or type status |
Hosts: Vms.status | =
=!
| Select or type = |
Hosts: Vms.status = | All status values | Select or type down |
F.1.4. Search Result Type Options
The result type allows you to search for resources of any of the following types:
- Vms for a list of virtual machines
- Host for a list of hosts
- Pools for a list of pools
- Template for a list of templates
- Event for a list of events
- Users for a list of users
- Cluster for a list of clusters
- Datacenter for a list of data centers
- Storage for a list of storage domains
As each type of resource has a unique set of properties and a set of other resource types that it is associated with, each search type has a set of valid syntax combinations. You can also use the auto-complete feature to create valid queries easily.
F.1.5. Search Criteria
You can specify the search criteria after the colon in the query. The syntax of
{criteria} is as follows:
<prop><operator><value>
or
<obj-type><prop><operator><value>
Examples
The following table describes the parts of the syntax:
Table F.3. Example Search Criteria
| Part | Description | Values | Example | Note |
|---|---|---|---|---|
| prop | The property of the searched-for resource. Can also be the property of a resource type (see obj-type), or tag (custom tag). | Limit your search to objects with a certain property. For example, search for objects with a status property. | Status | -- |
| obj-type | A resource type that can be associated with the searched-for resource. | These are system objects, like data centers and virtual machines. | Users | -- |
| operator | Comparison operators. |
=
!= (not equal)
>
<
>=
<=
| -- | Value options depend on obj-type. |
| Value | What the expression is being compared to. |
String
Integer
Ranking
Date (formatted according to Regional Settings)
|
Jones
256
normal
|
|
F.1.6. Search: Multiple Criteria and Wildcards
Wildcards can be used in the
<value> part of the syntax for strings. For example, to find all users beginning with m, enter m*.
You can perform a search having two criteria by using the Boolean operators
AND and OR. For example:
Vms: users.name = m* AND status = Up
This query returns all running virtual machines for users whose names begin with "m".
Vms: users.name = m* AND tag = "paris-loc"
This query returns all virtual machines tagged with "paris-loc" for users whose names begin with "m".
When two criteria are specified without
AND or OR, AND is implied. AND precedes OR, and OR precedes implied AND.
F.1.7. Search: Determining Search Order
You can determine the sort order of the returned information by using
sortby. Sort direction (asc for ascending, desc for descending) can be included.
For example:
events: severity > normal sortby time desc
This query returns all Events whose severity is higher than Normal, sorted by time (descending order).
F.1.8. Searching for Data Centers
The following table describes all search options for Data Centers.
Table F.4. Searching for Data Centers
| Property (of resource or resource-type) | Type | Description (Reference) |
|---|---|---|
| Clusters.clusters-prop | Depends on property type | The property of the clusters associated with the data center. |
| name | String | The name of the data center. |
| description | String | A description of the data center. |
| type | String | The type of data center. |
| status | List | The availability of the data center. |
| sortby | List | Sorts the returned results by one of the resource properties. |
| page | Integer | The number of results to display per page. |
Example
Datacenter: type = nfs and status != up
returns a list of data centers with:
- A storage type of NFS and status other than up
F.1.9. Searching for Clusters
The following table describes all search options for clusters.
Table F.5. Searching Clusters
| Property (of resource or resource-type) | Type | Description (Reference) |
|---|---|---|
| Datacenter.datacenter-prop | Depends on property type | The property of the data center associated with the cluster. |
| Datacenter | String | The data center to which the cluster belongs. |
| name | String | The unique name that identifies the clusters on the network. |
| description | String | The description of the cluster. |
| initialized | String | True or False indicating the status of the cluster. |
| sortby | List | Sorts the returned results by one of the resource properties. |
| page | Integer | The number of results to display per page. |
Example
Clusters: initialized = true or name = Default
returns a list of clusters which are:
- initialized; or
- named Default
F.1.10. Searching for Hosts
The following table describes all search options for hosts.
Table F.6. Searching for Hosts
| Property (of resource or resource-type) | Type | Description (Reference) |
|---|---|---|
| Vms.Vms-prop | Depends on property type | The property of the virtual machines associated with the host. |
| Templates.templates-prop | Depends on property type | The property of the templates associated with the host. |
| Events.events-prop | Depends on property type | The property of the events associated with the host. |
| Users.users-prop | Depends on property type | The property of the users associated with the host. |
| name | String | The name of the host. |
| status | List | The availability of the host. |
| cluster | String | The cluster to which the host belongs. |
| address | String | The unique name that identifies the host on the network. |
| cpu_usage | Integer | The percent of processing power used. |
| mem_usage | Integer | The percentage of memory used. |
| network_usage | Integer | The percentage of network usage. |
| load | Integer | Jobs waiting to be executed in the run-queue per processor, in a given time slice. |
| version | Integer | The version number of the operating system. |
| cpus | Integer | The number of CPUs on the host. |
| memory | Integer | The amount of memory available. |
| cpu_speed | Integer | The processing speed of the CPU. |
| cpu_model | String | The type of CPU. |
| active_vms | Integer | The number of Vms currently running. |
| migrating_vms | Integer | The number of Vms currently being migrated. |
| committed_mem | Integer | The percentage of committed memory. |
| tag | String | The tag assigned to the host. |
| type | String | The type of host. |
| datacenter | String | The data center to which the host belongs. |
| sortby | List | Sorts the returned results by one of the resource properties. |
| page | Integer | The number of results to display per page. |
Example
Hosts: cluster = Default and Vms.os = rhel6
returns a list of hosts which:
- Are part of the Default cluster and host virtual machines running the Red Hat Enterprise Linux 6 operating system.
F.1.11. Searching for Networks
The following table describes all search options for networks.
Table F.7. Searching for Networks
| Property (of resource or resource-type) | Type | Description (Reference) |
|---|---|---|
| Cluster_network.clusternetwork-prop | Depends on property type | The property of the cluster associated with the network. |
| Host_Network.hostnetwork-prop | Depends on property type | The property of the host associated with the network. |
| name | String | The human readable name that identifies the network. |
| description | String | Keywords or text describing the network, optionally used when creating the network. |
| vlanid | Integer | The VLAN ID of the network. |
| stp | String | Whether Spanning Tree Protocol (STP) is enabled or disabled for the network. |
| mtu | Integer | The maximum transmission unit for the logical network. |
| vmnetwork | String | Whether the network is only used for virtual machine traffic. |
| datacenter | String | The data center to which the network is attached. |
| sortby | List | Sorts the returned results by one of the resource properties. |
| page | Integer | The page number of results to display. |
Example
Network: mtu > 1500 and vmnetwork = true
returns a list of networks:
- with a maximum transmission unit greater than 1500 bytes
- which are set up for use by only virtual machines.
F.1.12. Searching for Storage
The following table describes all search options for storage.
Table F.8. Searching for Storage
| Property (of resource or resource-type) | Type | Description (Reference) |
|---|---|---|
| Hosts.hosts-prop | Depends on property type | The property of the hosts associated with the storage. |
| Clusters.clusters-prop | Depends on property type | The property of the clusters associated with the storage. |
| name | String | The unique name that identifies the storage on the network. |
| status | String | The status of the storage domain. |
| datacenter | String | The data center to which the storage belongs. |
| type | String | The type of the storage. |
| size | Integer | The size of the storage. |
| used | Integer | The amount of the storage that is used. |
| committed | Integer | The amount of the storage that is committed. |
| sortby | List | Sorts the returned results by one of the resource properties. |
| page | Integer | The number of results to display per page. |
Example
Storage: size > 200 or used < 50
returns a list of storage with:
- total storage space greater than 200 GB; or
- used storage space less than 50 GB.
F.1.13. Searching for Disks
The following table describes all search options for disks.
Table F.9. Searching for Disks
| Property (of resource or resource-type) | Type | Description (Reference) |
|---|---|---|
| Datacenters.datacenters-prop | Depends on property type | The property of the data centers associated with the disk. |
| Storages.storages-prop | Depends on property type | The property of the storage associated with the disk. |
| alias | String | The human readable name that identifies the storage on the network. |
| description | String | Keywords or text describing the disk, optionally used when creating the disk. |
| provisioned_size | Integer | The virtual size of the disk. |
| size | Integer | The size of the disk. |
| actual_size | Integer | The actual size allocated to the disk. |
| creation_date | Integer | The date the disk was created. |
| bootable | String | Whether the disk can or cannot be booted. Valid values are one of 0, 1, yes, or no |
| shareable | String | Whether the disk can or cannot be attached to more than one virtual machine at a time. Valid values are one of 0, 1, yes, or no |
| format | String | The format of the disk. Can be one of unused, unassigned, cow, or raw. |
| status | String | The status of the disk. Can be one of unassigned, ok, locked, invalid, or illegal. |
| disk_type | String | The type of the disk. Can be one of image or lun. |
| number_of_vms | Integer | The number of virtual machine(s) to which the disk is attached. |
| vm_names | String | The name(s) of the virtual machine(s) to which the disk is attached. |
| quota | String | The name of the quota enforced on the virtual disk. |
| sortby | List | Sorts the returned results by one of the resource properties. |
| page | Integer | The page number of results to display. |
Example
Disks: format = cow and provisioned_size > 8
returns a list of virtual disks with:
- Qcow, also known as thin provisioning, format; and
- an allocated disk size greater than 8 GB.
F.1.14. Searching for Volumes
The following table describes all search options for volumes.
Table F.10. Searching for Volumes
| Property (of resource or resource-type) | Type | Description (Reference) |
|---|---|---|
| Volume.cluster-prop | Depends on property type | The property of the clusters associated with the volume. |
| Cluster | String | The name of the cluster associated with the volume. |
| name | String | The human readable name that identifies the volume. |
| type | String | Can be one of distribute, replicate, distributed_replicate, stripe, or distributed_stripe. |
| transport_type | Integer | Can be one of tcp or rdma |
| replica_count | Integer | Number of replica. |
| stripe_count | Integer | Number of stripes. |
| status | String | The status of the volume. Can be one of Up or Down. |
| sortby | List | Sorts the returned results by one of the resource properties. |
| page | Integer | The page number of results to display. |
Example
Volume: transport_type = rdma and stripe_count >= 2
returns a list of volumes with:
- Transport type set to RDMA; and
- with 2 or more stripes.
F.1.15. Searching for Virtual Machines
The following table describes all search options for virtual machines (Vms). Vms can be either virtual servers or virtual desktops.
Table F.11. Searching for Virtual Machines
| Property (of resource or resource-type) | Type | Description (Reference) |
|---|---|---|
| Hosts.hosts-prop | Depends on property type | The property of the hosts associated with the virtual machine. |
| Templates.templates-prop | Depends on property type | The property of the templates associated with the virtual machine. |
| Events.events-prop | Depends on property type | The property of the events associated with the virtual machine. |
| Users.users-prop | Depends on property type | The property of the users associated with the virtual machine. |
| name | String | The name of the virtual machine. |
| status | List | The availability of the virtual machine. |
| ip | Integer | The IP address of the virtual machine. |
| uptime | Integer | The number of minutes that the virtual machine has been running. |
| domain | String | The domain (usually Active Directory domain) that groups these machines. |
| os | String | The operating system selected when the virtual machine was created. |
| creationdate | Date | The date on which the virtual machine was created. |
| address | String | The unique name that identifies the virtual machine on the network. |
| cpu_usage | Integer | The percent of processing power used. |
| mem_usage | Integer | The percentage of memory used. |
| network_usage | Integer | The percentage of network used. |
| memory | Integer | The maximum memory defined. |
| apps | String | The applications currently installed on the virtual machine. |
| cluster | List | The cluster to which the virtual machine belongs. |
| pool | List | The virtual machine pool to which the virtual machine belongs. |
| loggedinuser | String | The name of the user currently logged in to the virtual machine. |
| tag | List | The tags to which the virtual machine belongs. |
| datacenter | String | The data center to which the virtual machine belongs. |
| type | List | The virtual machine type (server or desktop). |
| quota | String | The name of the quota associated with the virtual machine. |
| sortby | List | Sorts the returned results by one of the resource properties. |
| page | Integer | The page number of results to display. |
Example
Vms: template.name = Win* and user.name = ""
returns a list of VMs, where:
- The template on which the virtual machine is based begins with Win and the virtual machine is assigned to any user.
Example
Vms: cluster = Default and os = windowsxp
returns a list of VMs, where:
- The cluster to which the virtual machine belongs is named Default and the virtual machine is running the Windows XP operating system.
F.1.16. Searching for Pools
The following table describes all search options for Pools.
Table F.12. Searching for Pools
| Property (of resource or resource-type) | Type | Description (Reference) |
|---|---|---|
| name | String | The name of the pool. |
| description | String | The description of the pool. |
| type | List | The type of pool. |
| sortby | List | Sorts the returned results by one of the resource properties. |
| page | Integer | The page number of results to display. |
Example
Pools: type = automatic
returns a list of pools with:
- Type of automatic
F.1.17. Searching for Templates
The following table describes all search options for templates.
Table F.13. Searching for Templates
| Property (of resource or resource-type) | Type | Description (Reference) |
|---|---|---|
| Vms.Vms-prop | String | The property of the virtual machines associated with the template. |
| Hosts.hosts-prop | String | The property of the hosts associated with the template. |
| Events.events-prop | String | The property of the events associated with the template. |
| Users.users-prop | String | The property of the users associated with the template. |
| name | String | The name of the template. |
| domain | String | The domain of the template. |
| os | String | The type of operating system. |
| creationdate | Integer |
The date on which the template was created.
Date format is mm/dd/yy.
|
| childcount | Integer | The number of Vms created from the template. |
| mem | Integer | Defined memory. |
| description | String | The description of the template. |
| status | String | The status of the template. |
| cluster | String | The cluster associated with the template. |
| datacenter | String | The data center associated with the template. |
| quota | String | The quota associated with the template. |
| sortby | List | Sorts the returned results by one of the resource properties. |
| page | Integer | The page number of results to display. |
Example
Template: Events.severity >= normal and Vms.uptime > 0
returns a list of templates, where:
- Events of normal or greater severity have occurred on VMs derived from the template, and the VMs are still running.
F.1.18. Searching for Users
The following table describes all search options for users.
Table F.14. Searching for Users
| Property (of resource or resource-type) | Type | Description (Reference) |
|---|---|---|
| Vms.Vms-prop | Depends on property type | The property of the virtual machines associated with the user. |
| Hosts.hosts-prop | Depends on property type | The property of the hosts associated with the user. |
| Templates.templates-prop | Depends on property type | The property of the templates associated with the user. |
| Events.events-prop | Depends on property type | The property of the events associated with the user. |
| name | String | The name of the user. |
| lastname | String | The last name of the user. |
| usrname | String | The unique name of the user. |
| department | String | The department to which the user belongs. |
| group | String | The group to which the user belongs. |
| title | String | The title of the user. |
| status | String | The status of the user. |
| role | String | The role of the user. |
| tag | String | The tag to which the user belongs. |
| pool | String | The pool to which the user belongs. |
| sortby | List | Sorts the returned results by one of the resource properties. |
| page | Integer | The page number of results to display. |
Example
Users: Events.severity > normal and Vms.status = up or Vms.status = pause
returns a list of users where:
- Events of greater than normal severity have occurred on their virtual machines AND the virtual machines are still running; or
- The users' virtual machines are paused.
F.1.19. Searching for Events
The following table describes all search options you can use to search for events. Auto-completion is offered for many options as appropriate.
Table F.15. Searching for Events
| Property (of resource or resource-type) | Type | Description (Reference) |
|---|---|---|
| Vms.Vms-prop | Depends on property type | The property of the virtual machines associated with the event. |
| Hosts.hosts-prop | Depends on property type | The property of the hosts associated with the event. |
| Templates.templates-prop | Depends on property type | The property of the templates associated with the event. |
| Users.users-prop | Depends on property type | The property of the users associated with the event. |
| Clusters.clusters-prop | Depends on property type | The property of the clusters associated with the event. |
| Volumes.Volumes-prop | Depends on property type | The property of the volumes associated with the event. |
| type | List | Type of the event. |
| severity | List | The severity of the event: Warning/Error/Normal. |
| message | String | Description of the event type. |
| time | Integer | Time at which the event occurred. |
| usrname | String | The user name associated with the event. |
| event_host | String | The host associated with the event. |
| event_vm | String | The virtual machine associated with the event. |
| event_template | String | The template associated with the event. |
| event_storage | String | The storage associated with the event. |
| event_datacenter | String | The data center associated with the event. |
| event_volume | String | The volume associated with the event. |
| correlation_id | Integer | The identification number of the event. |
| sortby | List | Sorts the returned results by one of the resource properties. |
| page | Integer | The page number of results to display. |
Example
Events: Vms.name = testdesktop and Hosts.name = gonzo.example.com
returns a list of events, where:
- The event occurred on the virtual machine named
testdesktopwhile it was running on the hostgonzo.example.com.
F.2. Bookmarks
F.2.1. Saving a Query String as a Bookmark
Summary
A bookmark can be used to remember a search query, and shared with other users.
Procedure F.1. Saving a Query String as a Bookmark
- Enter the desired search query in the search bar and perform the search.
- Click the star-shaped button to the right of the search bar to open the New Bookmark window.
- Enter the Name of the bookmark.
- Edit the Search string field (if applicable).
- Click to save the query as a bookmark and close the window.
- The search query is saved and displays in the Bookmarks pane.
Result
You have saved a search query as a bookmark for future reuse. Use the Bookmark pane to find and select the bookmark.
F.2.2. Editing a Bookmark
Summary
You can modify the name and search string of a bookmark.
Procedure F.2. Editing a Bookmark
- Click the Bookmarks tab on the far left side of the screen.
- Select the bookmark you wish to edit.
- Click the button to open the Edit Bookmark window.
- Change the Name and Search string fields as necessary.
- Click to save the edited bookmark.
Result
You have edited a bookmarked search query.
F.2.3. Deleting a Bookmark
Summary
When a bookmark is no longer needed, remove it.
Procedure F.3. Deleting a Bookmark
- Click the Bookmarks tab on the far left side of the screen.
- Select the bookmark you wish to remove.
- Click the button to open the Remove Bookmark window.
- Click to remove the selected bookmark.
Result
You have removed a bookmarked search query.
F.3. Tags
F.3.1. Using Tags to Customize Interactions with Red Hat Enterprise Virtualization
After your Red Hat Enterprise Virtualization platform is set up and configured to your requirements, you can customize the way you work with it using tags. Tags provide one key advantage to system administrators: they allow system resources to be arranged into groups or categories. This is useful when many objects exist in the virtualization environment and the administrator would like to concentrate on a specific set of them.
This section describes how to create and edit tags, assign them to hosts or virtual machines and search using the tags as criteria. Tags can be arranged in a hierarchy that matches a structure, to fit the needs of the enterprise.
Administration Portal Tags can be created, modified, and removed using the Tags pane.
F.3.2. Creating a Tag
Summary
You can edit the name and description of a tag.
Procedure F.4. Creating a Tag
- Click the Tags tab on the left side of the screen.
- Select the node under which you wish to create the tag. For example, to create it at the highest level, click the root node.
- Click the New button to open the New Tag window.
- Enter the Name and Description of the new tag.
- Click to create the tag.
Result
The new tag is created and displays on the Tags tab.
F.3.3. Modifying a Tag
Summary
You can edit the name and description of a tag.
Procedure F.5. Modifying a Tag
- Click the Tags tab on the left side of the screen.
- Select the tag you wish to modify.
- Click to open the Edit Tag window.
- Change the Name and Description fields as necessary.
- Click to save the edited tag.
Result
You have modified the properties of a tag.
F.3.4. Deleting a Tag
Summary
When a tag is no longer needed, remove it.
Procedure F.6. Deleting a Tag
- Click the Tags tab on the left side of the screen.
- Select the tag you wish to delete.
- Click to open the Remove Tag(s) window. The message warns you that removing the tag will also remove all descendants of the tag.
- Click to delete the selected tag.
Result
You have removed the tag and all its descendants. The tag is also removed from all the objects that it was attached to.
F.3.5. Adding and Removing Tags to and from Objects
Summary
You can assign tags to and remove tags from hosts, virtual machines, and users.
Procedure F.7. Adding and Removing Tags to and from Objects
- Use the resource tab, tree mode, or the search function to find and select the object(s) you wish to tag or untag.
- Click the Assign Tags button to open the Assign Tags window.
- Select the check box to assign a tag to the object, or clear the check box to detach the tag from the object.
- Click .
Result
The specified tag is now added or removed as a custom property of the selected object(s).
F.3.6. Searching for Objects Using Tags
- Enter a search query using
tagas the property and the desired value or set of values as criteria for the search.The objects tagged with the specified criteria are listed in the results list.
See Also:
G.1. Branding
G.1.1. Re-Branding the Manager
Various aspects of the Red Hat Enterprise Virtualization Manager can be customized, such as the icons used by and text displayed in pop-up windows and the links shown on the Welcome Page. This allows you to re-brand the Manager and gives you fine-grained control over the end look and feel presented to administrators and users.
The files required to customize the Manager are located in the
/etc/ovirt-engine/branding/ directory on the system on which the Manager is installed. The files comprise a set of cascading style sheet files that are used to style various aspects of the graphical user interface and a set of properties files that contain messages and links that are incorporated into various components of the Manager.
To customize a component, edit the file for that component and save the changes. The next time you open or refresh that component, the changes will be applied.
G.1.2. Login Screen
The login screen is the login screen used by both the Administration Portal and User Portal. The elements of the login screen that can be customized are as follows:
- The border
- The header image on the left
- The header image on the right
- The header text
The classes for the login screen are located in
common.css.
G.1.3. Administration Portal Screen
The administration portal screen is the main screen that is shown when you log into the Administration Portal. The elements of the administration portal screen that can be customized are as follows:
- The logo
- The left background image
- The center background image
- The right background image
- The text to the right of the logo
The classes for the administration portal screen are located in
web_admin.css.
G.1.4. User Portal Screen
The user portal screen is the screen that is shown when you log into the User Portal. The elements of the user portal screen that can be customized are as follows:
- The logo
- The center background image
- The right background image
- The border around the main grid
- The text above the Logged in user label
The classes for the user portal screen are located in
user_portal.css.
G.1.5. Pop-Up Windows
Pop-up windows are all windows in the Manager that allow you to create, edit or update an entity such as a host or virtual machine. The elements of pop-up windows that can be customized are as follows:
- The border
- The header image on the left
- The header center image (repeated)
The classes for pop-up windows are loctaed in
common.css.
G.1.6. Tabs
There are two types of tab elements in the User Portal - the main tabs for switching between the Basic view and the Extended view, and the tabs on the left side of the screen when the Extended view is selected. Many pop-up windows in the Administration Portal also include tabs. The elements of these tabs that can be customized are as follows:
- Active
- Inactive
The classes for tabs are located in
common.css and user_portal.css.
G.1.7. The Welcome Page
The Welcome Page is the page that is initially displayed when you visit the homepage of the Manager. In addition to customizing the overall look and feel, you can also make other changes such as adding links to the page for additional documentation or internal websites by editing a template file. The elements of the Welcome Page that can be customized are as follows:
- The page title
- The header (left, center and right)
- The error message
- The link to forward and the associated message for that link
The classes for the Welcome Page are located in
welcome_style.css.
The Template File
The template file for the Welcome Page is a regular HTML file of the name welcome_page.template that does not contain HTML, HEAD or BODY tags. This file is inserted directly into the Welcome Page itself, and acts as a container for the content that is displayed in the Welcome Page. As such, you must edit this file to add new links or change the content itself. Another feature of the template file is that it contains placeholder text such as {user_portal} that are replaced by corresponding text in the messages.properties file when the Welcome Page is processed.
G.1.8. The Page Not Found Page
The Page Not Found page is a page that is displayed when you open a link to a page that cannot be found in the Red Hat Enterprise Virtualization Manager. The elements of the Page Not Found page that can be customized are as follows:
- The page title
- The header (left, center and right)
- The error message
- The link to forward and the associated message for that link
The classes for the Page Not Found page are located in
welcome_style.css.
| Revision History | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Revision 3.3-52 | Wed 01 Oct 2014 | |||||||||||||
| ||||||||||||||
| Revision 3.3-51 | Tue 29 Apr 2014 | |||||||||||||
| ||||||||||||||
| Revision 3.3-50 | Mon 3 Mar 2014 | |||||||||||||
| ||||||||||||||
| Revision 3.3-49 | Thu 20 Feb 2014 | |||||||||||||
| ||||||||||||||
| Revision 3.3-48 | Tue 18 Feb 2014 | |||||||||||||
| ||||||||||||||
| Revision 3.3-47 | Wed 12 Feb 2014 | |||||||||||||
| ||||||||||||||
| Revision 3.3-46 | Thu 06 Feb 2014 | |||||||||||||
| ||||||||||||||
| Revision 3.3-45 | Thu 06 Feb 2014 | |||||||||||||
| ||||||||||||||
| Revision 3.3-44 | Fri 31 Jan 2014 | |||||||||||||
| ||||||||||||||
| Revision 3.3-43 | Tue 21 Jan 2014 | |||||||||||||
| ||||||||||||||
| Revision 3.3-42 | Thu 09 Jan 2014 | |||||||||||||
| ||||||||||||||
| Revision 3.3-41 | Wed 08 Jan 2014 | |||||||||||||
| ||||||||||||||
| Revision 3.3-40 | Wed 08 Jan 2014 | |||||||||||||
| ||||||||||||||
| Revision 3.3-39 | Mon 23 Dec 2013 | |||||||||||||
| ||||||||||||||
| Revision 3.3-38 | Wed 18 Dec 2013 | |||||||||||||
| ||||||||||||||
| Revision 3.3-37 | Tue 17 Dec 2013 | |||||||||||||
| ||||||||||||||
| Revision 3.3-36 | Mon 16 Dec 2013 | |||||||||||||
| ||||||||||||||
| Revision 3.3-35 | Thu 12 Dec 2013 | |||||||||||||
| ||||||||||||||
| Revision 3.3-34 | Wed 11 Dec 2013 | |||||||||||||
| ||||||||||||||
| Revision 3.3-33 | Mon 09 Dec 2013 | |||||||||||||
| ||||||||||||||
| Revision 3.3-32 | Wed 04 Dec 2013 | |||||||||||||
| ||||||||||||||
| Revision 3.3-31 | Tue 26 Nov 2013 | |||||||||||||
| ||||||||||||||
| Revision 3.3-30 | Mon 25 Nov 2013 | |||||||||||||
| ||||||||||||||
| Revision 3.3-29 | Thu 21 Nov 2013 | |||||||||||||
| ||||||||||||||
| Revision 3.3-28 | Thu 21 Nov 2013 | |||||||||||||
| ||||||||||||||
| Revision 3.3-27 | Wed 20 Nov 2013 | |||||||||||||
| ||||||||||||||
| Revision 3.3-26 | Mon 18 Nov 2013 | |||||||||||||
| ||||||||||||||
| Revision 3.3-25 | Wed 13 Nov 2013 | |||||||||||||
| ||||||||||||||
| Revision 3.3-24 | Wed 13 Nov 2013 | |||||||||||||
| ||||||||||||||
| Revision 3.3-23 | Mon 11 Nov 2013 | |||||||||||||
| ||||||||||||||
| Revision 3.3-22 | Fri 08 Nov 2013 | |||||||||||||
| ||||||||||||||
| Revision 3.3-21 | Tue 05 Nov 2013 | |||||||||||||
| ||||||||||||||
| Revision 3.3-20 | Fri 01 Nov 2013 | |||||||||||||
| ||||||||||||||
| Revision 3.3-19 | Tue 15 Oct 2013 | |||||||||||||
| ||||||||||||||
| Revision 3.3-18 | Mon 14 Oct 2013 | |||||||||||||
| ||||||||||||||
| Revision 3.3-17 | Fri 11 Oct 2013 | |||||||||||||
| ||||||||||||||
| Revision 3.3-16 | Wed 09 Oct 2013 | |||||||||||||
| ||||||||||||||
| Revision 3.3-15 | Tue 08 Oct 2013 | |||||||||||||
| ||||||||||||||
| Revision 3.3-14 | Fri 04 Oct 2013 | |||||||||||||
| ||||||||||||||
| Revision 3.3-13 | Fri 04 Oct 2013 | |||||||||||||
| ||||||||||||||
| Revision 3.3-12 | Thu 03 Oct 2013 | |||||||||||||
| ||||||||||||||
| Revision 3.3-11 | Mon 30 Sep 2013 | |||||||||||||
| ||||||||||||||
| Revision 3.3-10 | Fri 27 Sep 2013 | |||||||||||||
| ||||||||||||||
| Revision 3.3-9 | Tue 10 Sep 2013 | |||||||||||||
| ||||||||||||||
| Revision 3.3-8 | Fri 06 Sep 2013 | |||||||||||||
| ||||||||||||||
| Revision 3.3-7 | Tue 20 Aug 2013 | |||||||||||||
| ||||||||||||||
| Revision 3.3-6 | Tue 13 Aug 2013 | |||||||||||||
| ||||||||||||||
| Revision 3.3-5 | Tue 13 Aug 2013 | |||||||||||||
| ||||||||||||||
| Revision 3.3-4 | Mon 12 Aug 2013 | |||||||||||||
| ||||||||||||||
| Revision 3.3-3 | Fri 09 Aug 2013 | |||||||||||||
| ||||||||||||||
| Revision 3.3-2 | Thu 08 Aug 2013 | |||||||||||||
| ||||||||||||||
| Revision 3.3-1 | Thu 18 Jul 2013 | |||||||||||||
| ||||||||||||||