Red Hat Virtualization User Guide

Below you will find brief information for Red Hat Enterprise Virtualization 3.2. This guide provides information for administrators to manage Red Hat Enterprise Virtualization environments. It covers topics like data centers, clusters, hosts, storage, and virtual machines.

PDF

Document

Red Hat Enterprise Virtualization
3.2
Administration Guide
Administrating Red Hat Enterprise Virtualization Environments.
Edition 1
Jodi Biddle
Steve Gordon
Dayle Parker
Andrew Burden
Tim Hildred
Anjana Sriram
Zac Dover
Dan Macpherson
Cheryn Tan
Red Hat Enterprise Virtualization 3.2 Administration Guide
Administrating Red Hat Enterprise Virtualization Environments.
Edition 1
Jo di Biddle
[email protected] m
Andrew Burden
[email protected] m
Zac Do ver
zdo [email protected] m
Steve Go rdo n
sgo rdo [email protected] m
Tim Hildred
[email protected] m
Dan Macpherso n
[email protected] m
Dayle Parker
[email protected] m
Anjana Sriram
Red Hat Engineering Co ntent Services
[email protected] m
Cheryn Tan
[email protected] m
Legal Notice
Copyright &copy; 2013 Red Hat, Inc.
T his 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 &reg; is the registered trademark of Linus T orvalds in the United States and other countries.
Java &reg; is a registered trademark of Oracle and/or its affiliates.
XFS &reg; is a trademark of Silicon Graphics International Corp. or its subsidiaries in the United States
and/or other countries.
MySQL &reg; is a registered trademark of MySQL AB in the United States, the European Union and other
countries.
Node.js &reg; 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.
T he OpenStack &reg; 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
T his book contains information and procedures relevant to Red Hat Enterprise Virtualization
administrators.
Table of Contents
Table of Contents
.Preface
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13
...........
1. Document Conventions
13
1.1. T ypographic Conventions
13
1.2. Pull-quote Conventions
14
1.3. Notes and Warnings
15
2. Getting Help and Giving Feedback
15
2.1. Do You Need Help?
15
2.2. We Need Feedback!
16
.Chapter
. . . . . . . . 1.
. . .Using
. . . . . . this
. . . . .Guide
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
............
1.1. Administration Guide Prerequisites
17
1.2. Administration Guide Layout
17
1.3. Example Workflows
18
1.3.1. Administration Guide Example Workflows Overview
18
1.3.2. Administration Guide Example Workflow: New iSCSI Data Center
18
1.3.3. Administration Guide Example Workflow: Newly Virtualized Workload
18
1.3.4. Administration Guide Example Workflow: T emplate for Group Use
18
.Chapter
. . . . . . . . 2.
. . .Basics
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
............
2.1. Introduction
20
2.1.1. Red Hat Enterprise Virtualization Architecture
20
2.1.2. Red Hat Enterprise Virtualization System Components
21
2.1.3. Red Hat Enterprise Virtualization Resources
21
2.1.4. Red Hat Enterprise Virtualization API Support Statement
22
2.1.5. SPICE
23
2.1.6. Administering and Maintaining the Red Hat Enterprise Virtualization Environment
24
2.2. Using the Administration Portal Graphical Interface
24
2.2.1. Graphical User Interface Elements
24
2.2.2. T ree Mode and Flat Mode
25
2.2.3. Using the Guide Me Facility
26
2.2.4. Performing Searches in Red Hat Enterprise Virtualization
27
2.2.5. Saving a Query String as a Bookmark
27
. . . . . I.
Part
. . Administering
. . . . . . . . . . . . . . .the
. . . .Resources
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
............
.Chapter
. . . . . . . . 3.
. . .Data
. . . . . Centers
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .30
...........
3.1. Introduction to Data Centers
30
3.2. T he Storage Pool Manager (SPM)
31
3.3. SPM Priority
31
3.4. Using the Events T ab to Identify Problem Objects in Data Centers
32
3.5. Data Center T asks
32
3.5.1. Creating a New Data Center
32
3.5.2. Explanation of Settings in the New Data Center and Edit Data Center Windows
33
3.5.3. Editing a Resource
34
3.5.4. Creating a New Logical Network in a Data Center or Cluster
35
3.5.5. Re-Initializing a Data Center: Recovery Procedure
36
3.5.6. Removing a Data Center
37
3.5.7. Force Removing a Data Center
37
3.6. Data Centers and Storage Domains
38
3.6.1. Attaching an Existing Data Domain to a Data Center
38
3.6.2. Attaching an Existing ISO domain to a Data Center
38
3.6.3. Attaching an Existing Export Domain to a Data Center
39
3.6.4. Detaching a Storage Domain from a Data Center
39
1
Red Hat Enterprise Virtualization 3.2 Administration Guide
3.6.5. Activating a Storage Domain from Maintenance Mode
3.7. Data Centers and Permissions
3.7.1. Managing System Permissions for a Data Center
3.7.2. Data Center Administrator Roles Explained
3.7.3. Assigning an Administrator or User Role to a Resource
3.7.4. Removing an Administrator or User Role from a Resource
40
40
40
41
42
42
.Chapter
........4
. ...Clusters
..............................................................................4
. .3. . . . . . . . . .
4.1. Introduction to Clusters
43
4.2. Cluster T asks
44
4.2.1. Creating a New Cluster
44
4.2.2. Explanation of Settings and Controls in the New Cluster and Edit Cluster Windows
45
4.2.2.1. General Cluster Settings Explained
45
4.2.2.2. Optimization Settings Explained
47
4.2.2.3. Resilience Policy Settings Explained
49
4.2.2.4. Cluster Policy Settings Explained
50
4.2.3. Editing a Resource
51
4.2.4. Importing an Existing Red Hat Storage Cluster
52
4.2.5. Explanation of Settings in the Add Hosts Window
54
4.2.6. Setting Load and Power Management Policies for Hosts in a Cluster
55
4.2.7. Creating a New Logical Network in a Data Center or Cluster
57
4.2.8. Removing a Cluster
58
4.2.9. Designate a Specific T raffic T ype for a Logical Network with the Assign/UnAssign Window
4.2.10. Explanation of Settings in the Assign/UnAssign Window
59 58
4.3. Clusters and Permissions
60
4.3.1. Managing System Permissions for a Cluster
60
4.3.2. Cluster Administrator Roles Explained
61
4.3.3. Assigning an Administrator or User Role to a Resource
61
4.3.4. Removing an Administrator or User Role from a Resource
62
.Chapter
. . . . . . . . 5.
. . .Logical
. . . . . . . .Networks
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .63
...........
5.1. Introduction to Logical Networks
63
5.2. Port Mirroring
64
5.3. Required Networks, Optional Networks, and Virtual Machine Networks
64
5.4. Logical Network T asks
65
5.4.1. Creating a New Logical Network in a Data Center or Cluster
65
5.4.2. Explanation of Settings and Controls in the New Logical Network and Edit Logical Network
Windows
67
5.4.3. Editing a Logical Network
68
5.4.4. Designate a Specific T raffic T ype for a Logical Network with the Assign/UnAssign Window
5.4.5. Explanation of Settings in the Assign/UnAssign Window
70 69
5.4.6. Adding Multiple VLANs to a Single Network Interface using Logical Networks
71
5.4.7. Using the Networks T ab
73
5.5. Logical Networks and Permissions
74
5.5.1. Managing System Permissions for a Network
74
5.5.2. Network Administrator and User Roles Explained
74
5.5.3. Assigning an Administrator or User Role to a Resource
75
5.5.4. Removing an Administrator or User Role from a Resource
76
.Chapter
. . . . . . . . 6.
. . .Hosts
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
............
6.1. Introduction to Red Hat Enterprise Virtualization Hosts
77
6.2. Red Hat Enterprise Virtualization Hypervisor Hosts
78
6.3. Red Hat Enterprise Linux Hosts
78
6.4. Host T asks
78
6.4.1. Adding a Red Hat Enterprise Linux Host
78
6.4.2. Explanation of Settings and Controls in the New Host and Edit Host Windows
79
2
Table of Contents
6.4.2.1. Host General Settings Explained
6.4.2.2. Host Power Management Settings Explained
6.4.2.3. SPM Priority Settings Explained
6.4.2.4. Host Console Settings Explained
6.4.3. Configuring Host Power Management Settings
6.4.4. Configuring Host Storage Pool Manager (SPM) Settings
6.4.5. Editing a Resource
6.4.6. Approving Newly Added Red Hat Enterprise Virtualization Hypervisor Hosts
6.4.7. Moving a Host to Maintenance Mode
6.4.8. Activating a host from maintenance mode
6.4.9. Removing a Host
6.4.10. Customizing Hosts with T ags
6.5. Hosts and Networking
6.5.1. Editing Host Network Interfaces and Adding Logical Networks to Hosts
6.5.2. Creating a Bond Device using the Administration Portal
6.5.3. Example Uses of Custom Bonding Options with Host Interfaces
6.5.4. Saving a host network configuration
6.6. Host Resilience
6.6.1. Host High Availability
6.6.2. Power Management by Proxy in Red Hat Enterprise Virtualization
6.6.3. Setting Fencing Parameters on a Host
6.6.4. Using Host Power Management Functions
6.6.5. Manually Fencing or Isolating a Non Responsive Host
6.7. Hosts and Permissions
6.7.1. Managing System Permissions for a Host
6.7.2. Host Administrator Roles Explained
6.7.3. Assigning an Administrator or User Role to a Resource
6.7.4. Removing an Administrator or User Role from a Resource
79
81
83
83
84
85
86
86
87
87
88
88
89
89
91
92
93
93
93
94
94
96
97
98
98
98
99
99
.Chapter
. . . . . . . . 7.
. . .Storage
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
.............
7.1. Introduction to Storage in Red Hat Enterprise Virtualization
101
7.2. Understanding Storage Domains
102
7.3. Storage Metadata Versions in Red Hat Enterprise Virtualization
102
7.4. Preparing and Adding File-based Storage
103
7.4.1. Preparing NFS Storage
103
7.4.2. Attaching NFS Storage
105
7.4.3. Preparing Local Storage
106
7.4.4. Adding Local Storage
107
7.5. Adding POSIX Compliant File System Storage
108
7.5.1. POSIX Compliant File System Storage in Red Hat Enterprise Virtualization
108
7.5.2. Attaching POSIX Compliant File System Storage
108
7.6. Adding Block-based Storage
110
7.6.1. Preparing iSCSI Storage
110
7.6.2. Adding iSCSI Storage
111
7.6.3. Adding FCP Storage
113
7.6.4. Un-useable LUNs in Red Hat Enterprise Virtualization
115
7.7. Storage T asks
116
7.7.1. Importing existing ISO or export storage domains
116
7.7.2. Populating the ISO Storage Domain
117
7.7.3. Moving storage domains to maintenance mode
118
7.7.4. Editing a Resource
118
7.7.5. Activating storage domains
119
7.7.6. Removing a storage domain
119
7.7.7. Destroying a storage domain
120
7.7.8. Detaching the Export Domain
120
7.7.9. Attaching an Export Domain to a Data Center
121
3
Red Hat Enterprise Virtualization 3.2 Administration Guide
7.8. Red Hat Storage Volumes
7.8.1. Introduction to Red Hat Storage Volumes
7.8.2. Gluster Storage T erminology
7.8.3. Creating A Storage Volume
7.8.4. Adding Bricks to a Volume
7.8.5. Explanation of Settings in the Add Bricks window
7.8.6. Enabling Red Hat Storage Volumes for Virtualization
7.8.7. Starting Volumes
7.8.8. T uning Volumes
7.8.9. Editing Volume Options
7.8.10. Reset Volume Options
7.8.11. Removing Bricks from a Volume
7.8.12. Stopping Red Hat Storage Volumes
7.8.13. Deleting Red Hat Storage Volumes
7.9. Storage and Permissions
7.9.1. Managing system permissions for a storage domain
7.9.2. Storage Administrator Roles Explained
7.9.3. Assigning an Administrator or User Role to a Resource
7.9.4. Removing an Administrator or User Role from a Resource
121
121
121
124
125
126
127
128
128
129
130
130
130
131
131
131
132
132
133
.Chapter
. . . . . . . . 8.
. . .Virtual
. . . . . . . Machines
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134
.............
8.1. Introduction to Virtual Machines
134
8.2. Supported Virtual Machine Operating Systems
134
8.3. Virtual Machine Performance Parameters
135
8.4. Creating Virtual Machines
135
8.4.1. Creating a New Virtual Machine from an Existing T emplate
135
8.4.2. Creating a New Virtual Machine from a Blank T emplate
136
8.4.3. Explanation of Settings and Controls in the New Virtual Machine and Edit Virtual Machine
Windows
137
8.4.3.1. Virtual Machine General Settings Explained
137
8.4.3.2. Virtual Machine Initial Run Settings Explained
139
8.4.3.3. Virtual Machine Console Settings Explained
139
8.4.3.4. Virtual Machine Host Settings Explained
141
8.4.3.5. Virtual Machine High Availability Settings Explained
143
8.4.3.6. Virtual Machine Resource Allocation Settings Explained
143
8.4.3.7. Virtual Machine Boot Options Settings Explained
144
8.4.3.8. Virtual Machine Custom Properties Settings Explained
147
8.4.4. Creating a Cloned Virtual Machine from an Existing T emplate
148
8.4.5. Completing the Configuration of a Virtual Machine by Defining Network Interfaces and Hard
Disks
150
8.4.6. Installing a Guest Operating System onto a Virtual Machine
152
8.4.7. Installing Windows on VirtIO Optimized Hardware
153
8.4.8. Virtual Machine Run Once Settings Explained
153
8.5. Using Virtual Machines
155
8.5.1. SPICE
155
8.5.2. Powering on a Virtual Machine
156
8.5.3. Installing SPICE Plugins in Windows and Linux
156
8.5.4. Logging in to a Virtual Machine
157
8.6. Shutting Down or Pausing Virtual Machines
158
8.6.1. Shutting Down or Pausing Virtual Machines
158
8.6.2. Shutting Down a Virtual Machine
158
8.6.3. Pausing a Virtual Machine
158
8.7. Managing Virtual Machines
159
8.7.1. Editing a Resource
159
8.7.2. Removing a Virtual Machine
159
8.7.3. Adding and Editing Virtual Machine Disks
160
4
Table of Contents
8.7.4. Adding and Editing Virtual Machine Network Interfaces
161
8.7.5. Explanation of Settings in the Virtual Machine Network Interface Window
163
8.7.6. Hot Plugging Virtual Machine Disks
165
8.7.7. Hot Plugging Network Interfaces
165
8.7.8. Removing Disks and Network Interfaces from Virtual Machines
166
8.8. Virtual Machines and Permissions
166
8.8.1. Managing System Permissions for a Virtual Machine
166
8.8.2. Virtual Machines Administrator Roles Explained
167
8.8.3. Virtual Machine User Roles Explained
168
8.8.4. Assigning an Administrator or User Role to a Resource
170
8.8.5. Removing an Administrator or User Role from a Resource
170
8.9. Backing Up and Restoring Virtual Machines with Snapshots
171
8.9.1. Creating a Snapshot of a Virtual Machine
171
8.9.2. Using a Snapshot to Restore a Virtual Machine
172
8.9.3. Creating a Virtual Machine from a Snapshot
173
8.9.4. Deleting a Snapshot
174
8.10. Importing and Exporting Virtual Machines
175
8.10.1. Exporting and Importing Virtual Machines
175
8.10.2. Overview of the Export-Import Process
176
8.10.3. Performing an Export-Import of Virtual Resources
176
8.10.4. Exporting a Virtual Machine to the Export Domain
179
8.10.5. Importing a Virtual Machine into the Destination Data Center
180
8.11. Migrating Virtual Machines Between Hosts
181
8.11.1. What is Live Migration?
181
8.11.2. Live Migration Prerequisites
182
8.11.3. Automatic Virtual Machine Migration
182
8.11.4. Preventing Automatic Migration of a Virtual Machine
182
8.11.5. Manually Migrating Virtual Machines
184
8.11.6. Setting Migration Priority
185
8.11.7. Cancelling ongoing virtual machine migrations
185
8.11.8. Event and Log Notification upon Automatic Migration of Highly Available Virtual Servers
186
8.12. Improving Uptime with Virtual Machine High Availability
186
8.12.1. Why Use High Availability?
186
8.12.2. What is High Availability?
186
8.12.3. High Availability Considerations
187
8.12.4. Configuring a Highly Available Virtual Machine
187
8.13. Other Virtual Machine T asks
189
8.13.1. Enabling SAP monitoring for a virtual machine from the Administration Portal
189
8.13.2. Configuring Red Hat Enterprise Linux 5.4 or Higher Virtual Machines to use SPICE
190
8.13.2.1. Using SPICE on virtual machines running versions of Red Hat Enterprise Linux
released prior to 5.4
190
8.13.2.2. Installing qxl drivers on virtual machines
190
8.13.2.3. Configuring qxl drivers on virtual machines
190
8.13.2.4. Configuring a virtual machine's tablet and mouse to use SPICE
191
8.13.3. KVM virtual machine timing management
192
.Chapter
. . . . . . . . 9.
. . .T. emplates
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196
.............
9.1. Introduction to T emplates
196
9.2. T emplate T asks
196
9.2.1. Creating a T emplate from an Existing Virtual Machine
196
9.2.2. Explanation of Settings and Controls in the New T emplate Window
198
9.2.3. Editing a Resource
198
9.2.4. Explanation of Settings and Controls in the Edit T emplate Window
199
9.2.5. Deleting a T emplate
200
9.2.6. Exporting T emplates
200
5
Red Hat Enterprise Virtualization 3.2 Administration Guide
9.2.6.1. Migrating T emplates to the Export Domain
9.2.7. Importing T emplates
9.2.7.1. Importing a T emplate into a Data Center
9.3. Sealing T emplates in Preparation for Deployment
9.3.1. Sealing a Linux Virtual Machine for Deployment as a T emplate
9.3.2. Sealing a Windows T emplate
9.3.2.1. Considerations when Sealing a Windows T emplate with Sysprep
9.3.2.2. Sealing a Windows XP T emplate
9.3.2.3. Sealing a Windows 7 or Windows 2008 T emplate
9.4. T emplates and Permissions
9.4.1. Managing System Permissions for a T emplate
9.4.2. T emplate Administrator Roles Explained
9.4.3. T emplate User Roles Explained
9.4.4. Assigning an Administrator or User Role to a Resource
9.4.5. Removing an Administrator or User Role from a Resource
200
201
201
202
202
203
203
204
204
205
205
206
206
207
208
.Chapter
. . . . . . . . 10.
. . . . Pools
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209
.............
10.1. Introduction to Virtual Machine Pools
209
10.2. Virtual Machine Pool T asks
209
10.2.1. Creating a Virtual Machine Pool
209
10.2.2. Editing a Resource
210
10.2.3. Prestarting Virtual Machines in a Pool
211
10.2.4. Adding Virtual Machines to a Virtual Machine Pool
211
10.2.5. Detaching Virtual Machines from a Virtual Machine Pool
212
10.2.6. Removing a Virtual Machine Pool
212
10.3. Pools and Permissions
213
10.3.1. Managing System Permissions for a Virtual Machine Pool
213
10.3.2. Virtual Machine Pool Administrator Roles Explained
213
10.3.3. Assigning an Administrator or User Role to a Resource
214
10.3.4. Removing an Administrator or User Role from a Resource
214
.Chapter
. . . . . . . . 11.
. . . . Virtual
. . . . . . . Machine
. . . . . . . . . .Disks
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216
.............
11.1. Understanding Virtual Machine Storage
216
11.2. Understanding Virtual Disks
216
11.3. Shareable Disks in Red Hat Enterprise Virtualization
218
11.4. Creating Unassociated Virtual Machine Hard Disks
218
11.5. Explanation of Settings in the New Virtual Machine Disk and Edit Virtual Machine Disk
Windows
220
11.6. Moving a Virtual Machine Hard Disk Between Data Domains
221
11.7. Virtual Disks and Permissions
222
11.7.1. Managing System Permissions for a Virtual Disk
222
11.7.2. Virtual Disk User Roles Explained
223
11.7.3. Assigning an Administrator or User Role to a Resource
223
11.7.4. Removing an Administrator or User Role from a Resource
224
. . . . . II.
Part
. . .Administering
. . . . . . . . . . . . . . the
. . . . Environment
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225
.............
.Chapter
. . . . . . . . 12.
. . . . Users
. . . . . . .and
. . . .Roles
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226
.............
12.1. Introduction to Users
226
12.2. Directory Users
226
12.2.1. Directory Services Support in Red Hat Enterprise Virtualization
226
12.3. User Authorization
228
12.3.1. User Authorization Model
228
12.3.2. User Actions
228
12.3.3. User Permissions
229
12.4. Red Hat Enterprise Virtualization Manager User Properties and Roles
230
6
Table of Contents
12.4.1. User Properties
12.4.2. User and Administrator Roles
12.4.3. User Roles Explained
12.4.4. Administrator Roles Explained
12.5. Red Hat Enterprise Virtualization Manager User T asks
12.5.1. Adding Users
12.5.2. Viewing User Information
12.5.3. Viewing User Permissions on Resources
12.5.4. Removing Users
12.5.5. Configuring Roles
12.5.6. Creating a New Role
12.5.7. Editing or Copying a Role
12.6. User Role and Authorization Examples
230
230
231
233
234
234
235
236
236
237
237
239
239
.Chapter
. . . . . . . . 13.
. . . .Quotas
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .24
. . .2. . . . . . . . . .
13.1. Introduction to Quota
242
13.2. Shared Quota and Individually-defined Quota
243
13.3. Quota Accounting
243
13.4. Enabling and Changing a Quota Mode in a Data Center
244
13.5. Creating a New Quota Policy
244
13.6. Explanation of Quota T hreshold Settings
245
13.7. Assigning a Quota to an Object
246
13.8. Using Quota to Limit Resources by User
247
13.9. Editing Quotas
249
13.10. Removing Quotas
251
.Chapter
. . . . . . . . 14
. . . .. Event
. . . . . . .Notifications
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253
.............
14.1. Configuring Event Notifications
253
14.2. Parameters for event notifications in notifier.conf
254
14.3. Canceling Event Notifications
255
.Chapter
. . . . . . . . 15.
. . . . Utilities
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257
.............
15.1. Managing Domains with the Domain Management T ool
257
15.1.1. What is the Domain Management T ool?
257
15.1.2. Syntax for the Domain Management T ool
257
15.1.3. Using the Domain Management T ool
259
15.1.4. Adding Domains to Configuration
259
15.1.5. Editing a Domain in the Configuration
259
15.1.6. Deleting a Domain from the Configuration
260
15.1.7. Validating Domain Configuration
260
15.1.8. Listing Domains in Configuration
260
15.1.9. Getting a Configuration Value
261
15.1.10. Setting a Configuration Value
261
15.2. Editing the Configuration of the Red Hat Virtualization Manager with the Configuration T ool
15.2.1. Configuration T ool
261 261
15.2.2. Syntax for rhevm-config Command
261
15.2.3. T he admin@internal user
262
15.2.4. Changing the password for admin@internal
263
15.2.5. Configuration tool examples
263
15.2.6. Red Hat Enterprise Virtualization Manager Configuration Options Explanations,
Limitations, and Best Practices
263
15.3. Uploading Virtual Machine Images with the Image Uploader T ool
281
15.3.1. Virtual Machine Image Uploader
281
15.3.2. Syntax for the rhevm-image-uploader Command
281
15.3.3. Creating an OVF Archive T hat Is Compatible with the Image Uploader
283
15.3.4. Basic rhevm-image-uploader Usage Examples
284
7
Red Hat Enterprise Virtualization 3.2 Administration Guide
15.4. Editing USB Filters with the USB Filter Editor
284
15.4.1. Installing the USB Filter Editor
284
15.4.2. T he USB Filter Editor Interface
285
15.4.3. Adding a USB policy
286
15.4.4. Removing a USB Policy
288
15.4.5. Searching for USB Device Policies
290
15.4.6. Exporting a USB Policy
291
15.4.7. Importing a USB Policy
291
15.5. Collecting Logs with the Log Collector T ool
292
15.5.1. Log Collector
292
15.5.2. Syntax for rhevm-log-collector Command
292
15.5.3. Basic Log Collector Usage
296
15.6. Uploading ISO Files with the ISO Uploader T ool
296
15.6.1. ISO Uploader
296
15.6.2. Syntax for rhevm-iso-uploader Command
297
15.6.3. Specifying an NFS Server
298
15.6.4. Basic ISO Uploader Usage
299
15.6.5. Uploading the VirtIO and Guest T ool Image Files to an ISO Storage Domain
299
15.6.6. VirtIO and Guest T ool Image Files
299
15.7. Guest Drivers and Agents
300
15.7.1. Installing Guest Agents and Drivers
300
15.7.2. Automating Guest Additions on Windows Guests with Red Hat Enterprise Virtualization
Application Provisioning T ool(APT )
301
15.7.3. Red Hat Enterprise Virtualization Guest Drivers and Guest Agents
301
15.7.4. Subscribing to channels
304
15.7.4.1. Subscribing to Channels Using Subscription Manager
304
15.7.4.2. Subscribing to channels using RHN Classic
305
.Chapter
. . . . . . . . 16.
. . . . Log
. . . . .Files
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 307
.............
16.1. Red Hat Enterprise Virtualization Manager Installation Log Files
307
16.2. Red Hat Enterprise Virtualization Manager Log Files
307
16.3. Red Hat Enterprise Virtualization Host Log Files
308
16.4. Remotely Logging Host Activities
308
16.4.1. Setting up a Virtualization Host Logging Server
308
16.4.2. Configuring Red Hat Enterprise Virtualization Hypervisor Hosts to Use a Logging Server
16.4.3. Configuring Red Hat Enterprise Linux Hosts to Use a Logging Server
309 309
.Chapter
. . . . . . . . 17.
. . . . Updating
. . . . . . . . . .the
. . . .Red
. . . . .Hat
. . . .Enterprise
. . . . . . . . . . . Virtualization
. . . . . . . . . . . . . . Environment
. . . . . . . . . . . . . . . . . . . . . . . . . . . . 311
.............
17.1. Upgrades between Minor Releases
311
17.1.1. Checking for Red Hat Enterprise Virtualization Manager Updates
311
17.1.2. Updating Red Hat Enterprise Virtualization Manager
311
17.1.3. Updating Red Hat Enterprise Virtualization Manager Reports
312
17.1.4. Updating Red Hat Enterprise Virtualization Hypervisors
313
17.1.5. Updating Red Hat Enterprise Linux Virtualization Hosts
315
17.1.6. Updating the Red Hat Enterprise Virtualization Guest T ools
315
17.2. Upgrading to Red Hat Enterprise Virtualization 3.2
316
17.2.1. Upgrading to Red Hat Enterprise Virtualization Manager 3.2
316
17.2.2. Upgrading to Red Hat Enterprise Virtualization Manager 3.1
318
17.2.3. Changing the Cluster Compatibility Version
321
17.2.4. Changing the Data Center Compatibility Version
321
.Chapter
. . . . . . . . 18.
. . . . Backups
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 323
.............
18.1. Backing Up the Engine Database Using the backup.sh Script
323
18.2. Restoring the Engine Database Using the restore.sh Script
323
18.3. Backing Up Manager Configuration Files
324
18.4. Restoring Red Hat Enterprise Virtualization Manager Configuration Files
325
8
Table of Contents
. . . . . III.
Part
. . . Gathering
. . . . . . . . . . . Information
. . . . . . . . . . . . .About
. . . . . . the
. . . . Environment
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 328
.............
.Chapter
. . . . . . . . 19.
. . . . Reports,
. . . . . . . . . History
. . . . . . . . Database
. . . . . . . . . . .Reports,
. . . . . . . . . and
. . . . .Dashboards
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 329
.............
19.1. Reports
329
19.1.1. Reports
329
19.1.2. JasperReports and JasperServer in Red Hat Enterprise Virtualization
329
19.1.3. Online Help for JasperReports
330
19.1.4. Jasper Reports System Requirements
330
19.1.5. Users in the Red Hat Enterprise Virtualization Reports Portal
330
19.1.6. Logging in to Access the Reports Portal
330
19.1.7. Accessing the Red Hat Enterprise Virtualization Reports User Management Menu
332
19.1.8. Reports Portal User Roles
332
19.1.9. Navigating Reports and Dashboards
333
19.1.10. Report Parameters
335
19.1.11. Right-click Reporting Integration with the Red Hat Enterprise Virtualization Administration
Portal
336
19.1.12. Executive Reports
337
19.1.12.1. Executive reports: Active Virtual Machines by OS
337
19.1.12.2. Executive Reports: Cluster Capacity Vs Usage
338
19.1.12.3. Executive Reports: Host Operating System Break Down
339
19.1.12.4. Executive Reports: Summary of Host Usage Resources
340
19.1.13. Inventory Reports
341
19.1.13.1. Inventory Reports: Hosts Inventory
341
19.1.13.2. Inventory Reports: Storage Domain Over T ime
342
19.1.13.3. Inventory Reports: Virtual Machines Inventory
343
19.1.13.4. Inventory Reports: Cloud Provider Virtual Machine Inventory
344
19.1.14. Service Level Reports
345
19.1.14.1. Service Level Reports: Cluster Host Uptime
345
19.1.14.2. Service Level Reports: Cluster Quality of Service - Hosts
346
19.1.14.3. Service Level Reports: Cluster Quality of Service - Virtual Machines
348
19.1.14.4. Service Level Reports: Single Host Uptime
350
19.1.14.5. Service Level Reports: T op 10 Downtime Hosts
351
19.1.14.6. Service Level Reports: High Availability Virtual Servers Uptime
351
19.1.15. T rend Reports
352
19.1.15.1. T rend Reports: Five Least Utilized Hosts (Over T ime)
352
19.1.15.2. T rend Reports: Five Least Utilized Virtual Machines (Over T ime)
353
19.1.15.3. T rend Reports: Five Most Utilized Hosts (Over T ime)
354
19.1.15.4. T rend Reports: Five Most Utilized Virtual Machines (Over T ime)
355
19.1.15.5. T rend Reports: Multiple Hosts Resource Usage (Over T ime)
356
19.1.15.6. T rend Reports: Multiple Virtual Machines Resource Usage (Over T ime)
357
19.1.15.7. T rend Reports: Single Host Resource Usage (Days of Week)
358
19.1.15.8. T rend Reports: Single Host Resource Usage (Hour of Day)
359
19.1.15.9. T rend Reports: Single Virtual Machine Resources (Days of Week)
360
19.1.15.10. T rend Reports: Single Virtual Machine Resources (Hour of Day)
361
19.1.15.11. T rend Reports: Single Virtual Machine Resources (Over T ime)
362
19.1.16. Ad Hoc Reports
363
19.1.17. Reports Schema: T ag History and ENUM Views
364
19.2. History Database Reports
365
19.2.1. Red Hat Enterprise Virtualization History Database
365
19.2.2. T racking Configuration History
366
19.2.3. Recording Statistical History
366
19.2.4. T racking T ag History
366
19.2.5. Connecting to the History Database
367
19.2.6. Allowing Read-only Access to the History Database
368
19.2.7. History Database Report Examples
369
9
Red Hat Enterprise Virtualization 3.2 Administration Guide
19.2.8. Statistics History Views
373
19.2.8.1. Statistics History Views
373
19.2.8.2. Datacenter Statistics Views
373
19.2.8.3. Storage Domain Statistics Views
374
19.2.8.4. Host Statistics Views
375
19.2.8.5. Host Interface Statistics Views
378
19.2.8.6. Virtual Machine Statistics Views
378
19.2.8.7. Virtual Machine Interface Statistics Views
380
19.2.8.8. Virtual Machine Disk Statistics Views
381
19.2.9. Configuration History Views
383
19.2.9.1. Configuration History Views
383
19.2.9.2. Data Center Configuration
383
19.2.9.3. Datacenter Storage Domain Map
384
19.2.9.4. Storage Domain Configuration
384
19.2.9.5. Cluster Configuration
385
19.2.9.6. Host Configuration
386
19.2.9.7. Host Interface Configuration
387
19.2.9.8. Virtual Machine Configuration
388
19.2.9.9. Virtual Machine Interface Configuration History
390
19.2.9.10. Disks to Virtual Machine Map
391
19.2.9.11. Virtual Machine Disk Configuration
392
19.3. Dashboards
393
19.3.1. Dashboards
393
19.3.2. Header Inventory Dashboard
394
19.3.3. Header T rends Dashboard
394
19.3.4. Header Uptime Dashboard
395
19.3.5. Integrated Reporting Dashboard in the Red Hat Enterprise Virtualization Administration
Portal
396
.Firewalls
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 397
.............
A.1. Red Hat Enterprise Virtualization Manager Firewall Requirements
397
A.2. Virtualization Host Firewall Requirements
399
A.3. Directory Server Firewall Requirements
401
A.4. Database Server Firewall Requirements
402
.VDSM
. . . . . .and
. . . . Hooks
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4. .03
...........
B.1. VDSM
403
B.2. VDSM Hooks
403
B.3. Extending VDSM with Hooks
403
B.4. Supported VDSM Events
403
B.5. T he VDSM Hook Environment
405
B.6. T he VDSM Hook Domain XML Object
405
B.7. Defining Virtual Machine Custom Properties
405
B.8. Setting Virtual Machine Custom Properties
406
B.9. Evaluating Virtual Machine Custom Properties in a VDSM Hook
407
B.10. Using the VDSM Hooking Module
407
B.11. VDSM Hook Execution
408
B.12. VDSM Hook Return Codes
409
B.13. VDSM Hook Examples
409
.Red
. . . .Hat
. . . . Enterprise
. . . . . . . . . . . .Virtualization
. . . . . . . . . . . . . .User
. . . . . Interface
. . . . . . . . . .Plugins
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4. 12
............
C.1. Red Hat Enterprise Virtualization User Interface Plugins
412
C.2. Red Hat Enterprise Virtualization User Interface Plugin Lifecycle
412
C.2.1. Red Hat Enterprise Virtualization User Interface Plugin Lifecycle
412
C.2.2. Red Hat Enterprise Virtualization User Interface Plugin Discovery
412
C.2.3. Red Hat Enterprise Virtualization User Interface Plugin Loading
413
10
Table of Contents
C.2.4. Red Hat Enterprise Virtualization User Interface Plugin Bootstrapping
C.3. User Interface Plugin-related Files and their Locations
C.4. Example User Interface Plugin Deployment
C.5. Installing Red Hat Support Plugin
C.6. Using Red Hat Support Plugin
413
414
414
415
416
.Red
. . . .Hat
. . . . Enterprise
. . . . . . . . . . . .Virtualization
. . . . . . . . . . . . . .and
. . . . SSL
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4. 20
............
D.1. Replacing the Red Hat Enterprise Virtualization Manager SSL Certificate
420
.Using
. . . . . .Search,
. . . . . . . . Bookmarks,
. . . . . . . . . . . . .and
. . . . T. .ags
. . . .to
. . .Find
. . . . .Your
. . . . .Way
. . . . .Around
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4. 22
............
E.1. Search
422
E.1.1. Performing Searches in Red Hat Enterprise Virtualization
422
E.1.2. Search Syntax and Examples
422
E.1.3. Search Auto-Completion
422
E.1.4. Search Result T ype Options
423
E.1.5. Search Criteria
423
E.1.6. Search: Multiple Criteria and Wildcards
425
E.1.7. Search: Determining Search Order
425
E.1.8. Searching for Data Centers
425
E.1.9. Searching for Clusters
426
E.1.10. Searching for Hosts
426
E.1.11. Searching for Networks
428
E.1.12. Searching for Storage
429
E.1.13. Searching for Disks
429
E.1.14. Searching for Volumes
431
E.1.15. Searching for Virtual Machines
431
E.1.16. Searching for Pools
434
E.1.17. Searching for T emplates
435
E.1.18. Searching for Users
436
E.1.19. Searching for Events
437
E.2. Bookmarks
439
E.2.1. Saving a Query String as a Bookmark
439
E.2.2. Editing a Bookmark
439
E.2.3. Deleting a Bookmark
440
E.3. T ags
440
E.3.1. Using T ags to Customize Interactions with Red Hat Enterprise Virtualization
440
E.3.2. Creating a T ag
440
E.3.3. Modifying a T ag
441
E.3.4. Deleting a T ag
441
E.3.5. Adding and Removing T ags to and from Objects
442
E.3.6. Searching for Objects using T ags
442
. . . . . . . . . .History
Revision
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4. 4
. .3. . . . . . . . . .
11
Red Hat Enterprise Virtualization 3.2 Administration Guide
12
Preface
Preface
1. Document Conventions
T his manual uses several conventions to highlight certain words and phrases and draw attention to
specific pieces of information.
In PDF and paper editions, this manual uses typefaces drawn from the Liberation Fonts set. T he
Liberation Fonts set is also used in HT ML editions if the set is installed on your system. If not, alternative
but equivalent typefaces are displayed. Note: Red Hat Enterprise Linux 5 and later include the Liberation
Fonts set by default.
1.1. Typographic Conventions
Four typographic conventions are used to call attention to specific words and phrases. T hese
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:
T o see the contents of the file m y_next_bestselling_novel in your current working
directory, enter the cat m y_next_bestselling_novel command at the shell prompt
and press Enter to execute the command.
T he 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.
T he first example highlights a particular key to press. T he 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 m ono-spaced bold. For example:
File-related classes include filesystem for file systems, file for files, and dir for
directories. Each class has its own associated set of permissions.
Proportional Bold
T his 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 sub-menu titles. For example:
Choose System → Preferences → Mouse from the main menu bar to launch Mouse
Preferences. In the Buttons tab, select the Left-handed m ouse check box and click
Close to switch the primary mouse button from the left to the right (making the mouse
suitable for use in the left hand).
T o insert a special character into a gedit file, choose Applications → Accessories →
13
Red Hat Enterprise Virtualization 3.2 Administration Guide
Character Map from the main menu bar. Next, choose Search → Find… from the
Character Map menu bar, type the name of the character in the Search field and click
Next. T he character you sought will be highlighted in the Character T able. Double-click
this highlighted character to place it in the T ext to copy field and then click the Copy
button. Now switch back to your document and choose Edit → Paste from the gedit menu
bar.
T he 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:
T o connect to a remote machine using ssh, type ssh username@ domain.name at a shell
prompt. If the remote machine is exam ple.com and your username on that machine is
john, type ssh john@ exam ple.com .
T he m ount -o rem ount file-system command remounts the named file system. For
example, to remount the /hom e file system, the command is m ount -o rem ount /hom e.
T o see the version of a currently installed package, use the rpm -q package command. 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
T erminal output and source code listings are set off visually from the surrounding text.
Output sent to a terminal is set in m ono-spaced rom an and presented thus:
books
books_tests
Desktop
Desktop1
documentation
downloads
drafts
images
mss
notes
photos
scripts
stuff
svgs
svn
Source-code listings are also set in m ono-spaced rom an but add syntax highlighting as follows:
14
Preface
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(&amp;kvm-&gt;lock);
match = kvm_find_assigned_dev(&amp;kvm-&gt;arch.assigned_dev_head,
assigned_dev-&gt;assigned_dev_id);
if (!match) {
printk(KERN_INFO &quot;%s: device hasn't been assigned before, &quot;
&quot;so cannot be deassigned\n&quot;, __func__);
r = -EINVAL;
goto out;
}
kvm_deassign_device(kvm, match);
kvm_free_assigned_device(kvm, match);
out:
mutex_unlock(&amp;kvm-&gt;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
15
Red Hat Enterprise Virtualization 3.2 Administration Guide
Portal at http://access.redhat.com. T hrough 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.
16
Chapter 1. Using this Guide
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 rhevm management network,
and at least one user: the internal adm in user.
T he 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.
Report a bug
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. &quot;Add a new logical network&quot; is an action, and &quot;cluster&quot; is an object.
T he Red Hat Enterprise Virtualization Administration Guide uses objects to group content. T he objects
are ordered according to their likely order of usage by administrators. T he objects are:
Data Centers;
Clusters;
Networks;
Hosts;
Storage;
Virtual Machines, T emplates, and Pools;
Users and Roles;
Quotas;
Monitoring, Reports, and Dashboards;
Firewalls;
VDSM and Hooks;
Utilities; and
Backups.
T o use this guide, find the object you are interested in affecting, then find the action or task you want to
perform.
17
Red Hat Enterprise Virtualization 3.2 Administration Guide
Report a bug
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. T hey 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.
Report a bug
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. T he storage is deployed as iSCSI storage. T he
hypervisors run Red Hat Enterprise Linux. T he storage traffic is carried over a storage network separate
from management traffic. Control over this hardware is delegated to one of your colleagues.
Section 5.4.1, “Creating a New Logical Network in a Data Center or Cluster”
Section 7.6.2, “Adding iSCSI Storage”
Section 3.7.3, “Assigning an Administrator or User Role to a Resource”
Report a bug
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.
Section 8.12.4, “Configuring a Highly Available Virtual Machine”
Section 9.2.1, “Creating a T emplate from an Existing Virtual Machine”
Section 8.11.2, “Live Migration Prerequisites”
Section 8.11.3, “Automatic Virtual Machine Migration”
Section 8.11.6, “Setting Migration Priority”
Section 6.6.1, “Host High Availability”
Section 6.6.3, “Setting Fencing Parameters on a Host”
Section 3.7.3, “Assigning an Administrator or User Role to a Resource”
Report a bug
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.
Section 7.4.1, “Preparing NFS Storage”
Section 7.4.2, “Attaching NFS Storage”
Section 7.7.2, “Populating the ISO Storage Domain”
Section 15.6.1, “ISO Uploader”
18
Chapter 1. Using this Guide
Section 8.4.2, “Creating a New Virtual Machine from a Blank T emplate”
Section 8.4.6, “Installing a Guest Operating System onto a Virtual Machine”
Section 9.2.1, “Creating a T emplate from an Existing Virtual Machine”
Section 12.5.1, “Adding Users”
Section 3.7.3, “Assigning an Administrator or User Role to a Resource”
Report a bug
19
Red Hat Enterprise Virtualization 3.2 Administration Guide
Chapter 2. Basics
2.1. Introduction
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. T hese tools provide local
management for virtual machines, networks and storage.
T he 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. T his includes physical network links, and logical
networks.
Figure 2.1. Red Hat Enterprise Virtualization Platform Overview
20
Chapter 2. Basics
Report a bug
2.1.2. Red Hat Enterprise Virtualization System Components
T he Red Hat Enterprise Virtualization environment consists of one or more hosts (either Red Hat
Enterprise Linux 6.3 or later hosts or Red Hat Enterprise Virtualization Hypervisor hosts) and at least
one Red Hat Enterprise Virtualization Manager.
Hosts run virtual machines using KVM virtualization technology (Kernel-based Virtual Machine).
T he 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.
T he Red Hat Enterprise Virtualization Manager is accessed through the Administration Portal using a
web browser.
Report a bug
2.1.3. Red Hat Enterprise Virtualization Resources
T he 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 non-physical 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 of 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. T hey 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 - T he 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.
T emplate - A template is a model virtual machine with pre-defined 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
21
Red Hat Enterprise Virtualization 3.2 Administration Guide
new applications. In case of problems, a snapshot can be used to restore the virtual machine to its
original state.
User T ypes - 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.
Report a bug
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. T hese 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 T ransfer (REST ) API
T he 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)
T he SDK provided by the rhevm-sdk package is a fully supported interface for interacting with
Red Hat Enterprise Virtualization Manager.
Command Line Shell
T he 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
T he 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. T he 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
22
Chapter 2. Basics
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 libvirt using the virsh -r command 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:
T he vdsClient Command
Use of the vdsClient command 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.
Report a bug
2.1.5. SPICE
T he SPICE protocol facilitates graphical connections to virtual machines. T he SPICE protocol allows:
video at more than 30 frames per second
bi-directional audio (for soft-phones/IP phones)
bi-directional 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
Report a bug
23
Red Hat Enterprise Virtualization 3.2 Administration Guide
2.1.6. Administering and Maintaining the Red Hat Enterprise Virtualization
Environment
T he 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. T his 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.
T roubleshooting for specific users or virtual machines for overall system functionality.
Generating general and specific reports.
Report a bug
2.2. Using the Administration Portal Graphical Interface
2.2.1. Graphical User Interface Elements
T he Red Hat Enterprise Virtualization Administration Portal consists of contextual panes and menus and
can be used in two modes, tree mode and flat mode. T ree mode allows you to browse the object
hierarchy of a data center and is the recommended manner of operation. T he elements of the GUI are
shown in the diagram below.
User Interface Elements
Header
T he Header bar contains the name of the current logged in user and the Sign Out button. T he
About button shows version information. T he Configure button allows you to configure user roles.
T he Guide button provides a shortcut to the book you are reading now.
Search Bar
T he 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. T he star icon can be used
to save the search as a bookmark.
Resource T abs
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.
T he Administration Portal provides the following tabs: Data Centers, Clusters, Hosts, Storage, Disks,
Virtual Machines, Pools, T emplates, Users, and Events, and a Dashboard tab if you have installed
the Data Warehouse and Reporting services.
Results List
24
Chapter 2. Basics
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
T he 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.
T ree/Bookmarks/T ags Pane
T he T ree pane displays a navigable hierarchy of the resources in the virtualized environment.
Bookm arks are used to save frequently used or complicated searches for repeated use. Bookmarks
can be added, edited, or removed.
T ags are applied to groups of resources and are used to search for all resources associated with
that tag.
Alerts/Events Pane
T he Alerts tab lists all high severity events such as errors or warnings. T he Events tab shows an
audit of events for all resources. T he T asks tab lists the current running tasks. You can view this
panel by clicking the maximize/ minimize button.
Important
T he minimum supported resolution viewing the Administration Portal in a web browser is
1024x768. T he Administration Portal will not render correctly when viewed at a lower resolution.
Report a bug
2.2.2. Tree Mode and Flat Mode
T he Administration Portal provides two different modes for managing your resources: tree mode and flat
mode. T ree 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.
25
Red Hat Enterprise Virtualization 3.2 Administration Guide
Figure 2.2. T ree Mode
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.
T o access flat mode, click on the System item in the T ree pane on the left side of the screen. You are
in flat mode if the Pools and Users resource tabs appear.
Figure 2.3. Flat Mode
Report a bug
2.2.3. Using the Guide Me Facility
When setting up resources such as data centers and clusters, a number of tasks must be completed in
26
Chapter 2. Basics
sequence. T he context-sensitive Guide Me window prompts for actions that are appropriate to the
resource being configured. T he Guide Me window can be accessed at any time by clicking the Guide
Me button on the resource toolbar.
Figure 2.4 . New Data Center Guide Me Window
Report a bug
2.2.4. Performing Searches in Red Hat Enterprise Virtualization
T he Administration Portal enables the management of thousands of resources, such as virtual
machines, hosts, users, and more. T o perform a search, enter the search query (free-text or syntaxbased) 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:
Section E.1, “Search”
Report a bug
2.2.5. 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
1. Enter the desired search query in the search bar and perform the search.
2. Click the star-shaped Bookm ark button to the right of the search bar to open the New
27
Red Hat Enterprise Virtualization 3.2 Administration Guide
Bookm ark window.
Figure 2.5. Bookmark Icon
3. Enter the Nam e of the bookmark.
4. Edit the Search string field (if applicable).
5. Click OK to save the query as a bookmark and close the window.
6. T he search query is saved and displays in the Bookm arks pane.
Result
You have saved a search query as a bookmark for future reuse. Use the Bookm ark pane to find and
select the bookmark.
See Also:
Section E.1, “Search”
Section E.2, “Bookmarks”
Report a bug
28
Part I. Administering the Resources
Part I. Administering the Resources
29
Red Hat Enterprise Virtualization 3.2 Administration Guide
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.
Figure 3.1. Data Centers
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.
30
Chapter 3. D ata Centers
Figure 3.2. Data Center Objects
Report a bug
3.2. The Storage Pool Manager (SPM)
T he 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. T he 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. T he SPM does
not preclude the host from its standard operation; a host running as SPM can still host virtual resources.
T he SPM entity controls access to storage by coordinating the metadata across the storage domains.
T his includes creating, deleting, and manipulating virtual disks (images), snapshots, and templates, and
allocating storage for sparse block devices (on SAN). T his is an exclusive responsibility: only one host
can be the SPM in the data center at one time to ensure metadata integrity.
T he Red Hat Enterprise Virtualization Manager ensures that the SPM is always available. T he 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. T his process can take some time.
Report a bug
3.3. SPM Priority
T he SPM role uses some of a host's available resources. T he 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
31
Red Hat Enterprise Virtualization 3.2 Administration Guide
not have to contend with SPM operations for host resources.
You can change a host's SPM priority by editing the host.
See Also:
Section 6.4.4, “Configuring Host Storage Pool Manager (SPM) Settings”
Report a bug
3.4. Using the Events Tab to Identify Problem Objects in Data
Centers
T he Events tab for a data center displays all events associated with that data center; events include
audits, warnings, and errors. T he information displayed in the results list will enable you to identify
problem objects in your Red Hat Enterprise Virtualization environment.
T he 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.
Report a bug
3.5. Data Center Tasks
3.5.1. Creating a New Data Center
Summary
T his procedure creates a data center in your virtualization environment. T he data center requires a
functioning cluster, host, and storage domain to operate.
Note
T he storage T ype can be edited until the first storage domain is added to the data center. Once
a storage domain has been added, the storage T ype cannot be changed.
If you set the Com patibility 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
1. Select the Data Centers resource tab to list all data centers in the results list.
2. Click New to open the New Data Center window.
3. Enter the Nam e and Description of the data center.
4. Select the storage T ype, Com patibility Version, and Quota Mode of the data center from
the drop-down menus.
5. Click OK to create the data center and open the New Data Center - Guide Me window.
6. T he Guide Me window lists the entities that need to be configured for the data center. Configure
these entities or postpone configuration by clicking the Configure Later button; configuration
32
Chapter 3. D ata Centers
can be resumed by selecting the data center and clicking the Guide Me button.
Result
T he 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:
Section 2.2.3, “Using the Guide Me Facility”
Section 3.5.2, “Explanation of Settings in the New Data Center and Edit Data Center Windows”
Report a bug
3.5.2. Explanation of Settings in the New Data Center and Edit Data Center
Windows
T he 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 OK, prohibiting the
changes being accepted. In addition, field prompts indicate the expected values or range of values.
33
Red Hat Enterprise Virtualization 3.2 Administration Guide
T able 3.1. Data Center Properties
Field
Description/Action
Nam e
T he name of the data center. T his 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
T he description of the data center. T his field is
recommended but not mandatory.
T ype
T he storage type. Choose one of
NFS
iSCSI
Fibre Channel
Local on Host
POSIX compliant FS
T he type of data domain dictates the type of the
data center and cannot be changed after creation
without significant disruption. All storage in a data
center must be of one type only. For example, if
iSCSI is selected as the type, only iSCSI data
domains can be attached to the data center.
Com patibility Version
T he version of Red Hat Enterprise Virtualization.
Choose one of:
3.0
3.1
3.2
After upgrading the Red Hat Enterprise
Virtualization Manager, the hosts, clusters and
data centers may still be in the earlier version.
Ensure that you have upgraded all the hosts,
then the clusters, before you upgrade the
Compatibility Level of the data center.
Quota Mode
Quota is a resource limitation tool provided with
Red Hat Enterprise Virtualizaton. Choose one of:
Disabled - Select if you do not want to
implement Quota
Audit - Select if you want to edit the Quota
settings
Enforced - Select to implement Quota
Report a bug
3.5.3. Editing a Resource
Summary
Edit the properties of a resource.
34
Chapter 3. D ata Centers
Procedure 3.2. Editing a Resource
1. Use the resource tabs, tree mode, or the search function to find and select the resource in the
results list.
2. Click Edit to open the Edit window.
3. Change the necessary properties and click OK.
Result
T he new properties are saved to the resource. T he Edit window will not close if a property field is
invalid.
See Also:
Section 3.5.2, “Explanation of Settings in the New Data Center and Edit Data Center Windows”
Report a bug
3.5.4. Creating a New Logical Network in a Data Center or Cluster
Summary
Create a logical network and define its use in the data center, or clusters in a data center.
Procedure 3.3. Defining Logical Networks in a Cluster
1. Use the Data Centers or Clusters resource tabs, tree mode, or the search function to find
and select the resource in the results list.
2. Click the Logical Networks tab of the details pane to list the existing logical networks.
3. Click New in the Data Centers details pane to open the New Logical Network window.
Click Add Network in the Clusters details pane to open the New Logical Network window.
35
Red Hat Enterprise Virtualization 3.2 Administration Guide
Figure 3.3. New Logical Network
4. Enter the Nam e and Description of the logical network.
5. Select the check boxes to enable a VM Network, Enable VLAN tagging, and Override
MT U.
6. Select the cluster(s) you want to assign the network to. Note that the network is added as
required Network to the selected clusters.
7. T ick the Allow all users to use this Network checkbox to confer permissions for the
new network to all users.
8. Click OK to create the logical network.
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.
See Also:
Section 5.4.2, “Explanation of Settings and Controls in the New Logical Network and Edit Logical
Network Windows”
Report a bug
3.5.5. Re-Initializing a Data Center: Recovery Procedure
36
Chapter 3. D ata Centers
T his 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
1. Click the Data Centers resource tab and select the data center to re-initialize.
2. Ensure that any storage domains attached to the data center are in maintenance mode.
3. Right-click the data center and select Re-Initialize Data Center from the drop-down menu
to open the Data Center Re-Initialize window.
4. T he 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.
5. Select the Approve operation check box.
6. Click OK to close the window and re-initialize the data center.
Result
T he 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.
Report a bug
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
1. Ensure the storage domains attached to the data center is in maintenance mode.
2. Click the Data Centers resource tab and select the data center to remove.
3. Click Rem ove to open the Rem ove Data Center(s) confirmation window.
4. Click OK.
Result
T he data center has been removed.
Report a bug
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 Rem ove the data center under either circumstance.
Force Rem ove does not require an active host. It also permanently removes the attached storage
37
Red Hat Enterprise Virtualization 3.2 Administration Guide
domain.
It may be necessary to Destroy a corrupted storage domain before you can Force Rem ove the data
center.
Procedure 3.6. Force Removing a Data Center
1. Click the Data Centers resource tab and select the data center to remove.
2. Click Force Rem ove to open the Force Rem ove Data Center confirmation window.
3. Select the Approve operation check box.
4. Click OK
Result
T he data center and attached storage domain are permanently removed from the Red Hat Enterprise
Virtualization environment.
Report a bug
3.6. Data Centers and Storage Domains
3.6.1. Attaching an Existing Data Domain to a Data Center
Prerequisites:
Section 7.4, “Preparing and Adding File-based Storage”
Section 7.6, “Adding Block-based Storage”
Summary
Data domains that are Unattached can be attached to a data center. T he data domain must be of the
same Storage T ype as the data center.
Procedure 3.7. Attaching an Existing Data Domain to a Data Center
1. Click the Data Centers resource tab and select the appropriate data center.
2. Select the Storage tab in the details pane to list the storage domains already attached to the
data center.
3. Click Attach Data to open the Attach Storage window.
4. 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.
5. Click OK.
Result
T he data domain is attached to the data center and can be activated.
Report a bug
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. T he ISO domain must be of the
38
Chapter 3. D ata Centers
same Storage T ype 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
1. Click the Data Centers resource tab and select the appropriate data center.
2. Select the Storage tab in the details pane to list the storage domains already attached to the
data center.
3. Click Attach ISO to open the Attach ISO Library window.
4. Click the radio button for the appropriate ISO domain.
5. Click OK.
Result
T he ISO domain is attached to the data center and can be activated.
Report a bug
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
1. Click the Data Centers resource tab and select the appropriate data center.
2. Select the Storage tab in the details pane to list the storage domains already attached to the
data center.
3. Click Attach Export to open the Attach Export Dom ain window.
4. Click the radio button for the appropriate Export domain.
5. Click OK.
Result
T he Export domain is attached to the data center and can be activated.
Report a bug
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. T he 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.
39
Red Hat Enterprise Virtualization 3.2 Administration Guide
Note
T he master storage, if it is the last available storage domain, cannot be removed.
Procedure 3.10. Detaching a Storage Domain from a Data Center
1. Click the Data Centers resource tab and select the appropriate data center.
2. Select the Storage tab in the details pane to list the storage domains attached to the data
center.
3. Select the storage domain to detach. If the storage domain is Active, click Maintenance to
move the domain into maintenance mode.
4. Click Detach to open the Detach Storage confirmation window.
5. Click OK.
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.
Report a bug
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
1. Click the Data Centers resource tab and select the appropriate data center.
2. Select the Storage tab in the details pane to list the storage domains attached to the data
center.
3. Select the appropriate storage domain and click Activate.
Result
T he storage domain is activated and can be used in the data center.
Report a bug
3.7. Data Centers and Permissions
3.7.1. Managing System Permissions for a Data Center
T he system administrator, as the SuperUser, manages all aspects of the Administration Portal. More
specific administrative roles can be assigned to other users. T hese restricted administrator roles are
useful for empowering a user with certain administrative privileges that limit them to a specific resource:
a DataCenterAdm in role has administrator privileges only for the assigned data center, a
ClusterAdm in has administrator privileges only for the assigned cluster, a StorageAdm in has
administrator privileges only for the assigned storage domain, and so forth.
40
Chapter 3. D ata Centers
A data center administrator is a system administration role for a specific data center only. T his is useful
in virtualized environments with multiple data center, where each data center requires a system
administrator. T he DataCenterAdm in 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 Configure
button in the header bar to assign a data center administrator for all data centers in the environment.
T he 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.
See Also:
Section 3.7.2, “Data Center Administrator Roles Explained”
Report a bug
3.7.2. Data Center Administrator Roles Explained
Data Center Permission Roles
T he table below describes the administrator roles and privileges applicable to data center
administration.
T able 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.
See Also:
Section 12.4.2, “User and Administrator Roles”
Report a bug
41
Red Hat Enterprise Virtualization 3.2 Administration Guide
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
1. Use the resource tabs, tree mode, or the search function to find and select the resource in the
results list.
2. Click the Perm issions tab of the details pane to list the assigned users, the user's role, and the
inherited permissions for the selected resource.
3. Click Add to open the Add Perm ission to User window.
4. Enter the name or user name of an existing user into the Search text box and click Go. Select a
user from the resulting list of possible matches.
5. Select a role from the Role to Assign: drop-down menu.
6. Click OK 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.
See Also:
Section 12.4.2, “User and Administrator Roles”
Report a bug
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
1. Use the resource tabs, tree mode, or the search function to find and select the resource in the
results list.
2. Click the Perm issions tab of the details pane to list the assigned users, the user's role, and the
inherited permissions for the selected resource.
3. Select the user to remove from the resource.
4. Click Rem ove. T he Rem ove Perm ission window opens to confirm permissions removal.
5. Click OK to remove the user role.
Result
You have removed the user's role, and the associated permissions, from the resource.
Report a bug
42
Chapter 4. Clusters
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 only use the
features present in all models.
Every cluster in the system must belong to a data center, and every 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.
T he cluster is the highest level at which power and load-sharing policies can be defined.
Clusters can run virtual machines or Red Hat Storage Servers. T hese two purposes are mutually
exclusive: A single cluster cannot support virtualization and storage hosts together.
T he Red Hat Enterprise Virtualization platform contains a default cluster in the default data center at
installation.
Figure 4 .1. Cluster
See Also:
Chapter 3, Data Centers
Chapter 5, Logical Networks
Chapter 6, Hosts
Chapter 7, Storage
Report a bug
43
Red Hat Enterprise Virtualization 3.2 Administration Guide
4.2. Cluster Tasks
4.2.1. Creating a New Cluster
Prerequisites:
Section 3.5.1, “Creating a New Data Center”
Summary
A data center can contain multiple clusters and a cluster can hold multiple hosts. All hosts in a cluster
must run 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 Guide Me button.
Important
T he default rhevm network cannot be modified once a Cluster has been attached to a data
center. Perform all configuration for the rhevm network, such as enabling VLAN tagging, before a
Cluster is attached and while the data center remains in the Uninitialized state.
Procedure 4 .1. Creating a New Cluster
1. Select the Clusters resource tab to list all clusters in the results list.
2. Click New to open the New Cluster window.
3. Select the Data Center the cluster will belong to from the drop-down menu.
4. Enter the Nam e and Description of the cluster.
5. Select the CPU Nam e and Com patibility Version from the drop-down menus. 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.
6. T ick either the Enable Virt Service or Enable Gluster Service check boxes,
depending on whether the cluster should be populated with virtual machine hosts or Glusterenabled nodes. Note that you cannot add Red Hat Enterprise Virtualization Hypervisor hosts to a
Gluster-enabled cluster.
7. Click the Optim ization tab to select the memory page sharing threshold for the cluster, and
optionally enable CPU thread handling on the cluster's hosts.
8. Click the Resilience Policy tab to select the virtual machine migration policy.
9. Click OK to create the cluster and open the New Cluster - Guide Me window.
10. T he Guide Me window lists the entities that need to be configured for the cluster. Configure
these entities or postpone configuration by clicking the Configure Later button; configuration
can be resumed by selecting the cluster and clicking the Guide Me button.
Result
T he new cluster is added to the virtualization environment.
See Also:
Section 4.2.2, “Explanation of Settings and Controls in the New Cluster and Edit Cluster Windows”
44
Chapter 4. Clusters
Section 2.2.3, “Using the Guide Me Facility”
Report a bug
4.2.2. Explanation of Settings and Controls in the New Cluster and Edit Cluster
Windows
4 .2.2.1. General Cluster Settings Explained
Figure 4 .2. New Cluster window
T he 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.
45
Red Hat Enterprise Virtualization 3.2 Administration Guide
T able 4 .1. General Cluster Settings
Field
Description/Action
Data Center
T he data center that will contain the cluster.
Nam e
T he name of the cluster. T his text field has a 40character limit and must be a unique name with
any combination of uppercase and lowercase
letters, numbers, hyphens, and underscores.
Description
T he description of the cluster. T his field is
recommended but not mandatory.
CPU Nam e
T he CPU type of the cluster. Choose one of:
Intel Conroe Family
Intel Penryn Family
Intel Nehalem Family
Intel Westmere Family
Intel SandyBridge Family
Intel Haswell
AMD Opteron G1
AMD Opteron G2
AMD Opteron G3
AMD Opteron G4
AMD Opteron G5
All hosts in a cluster must run the same CPU type
(Intel or AMD); this cannot be changed after
creation without significant disruption. T he CPU
type should be set for the least powerful host. For
example: an Intel SandyBridge host can
attach to an Intel Penryn cluster; an Intel
Conroe host cannot. Hosts with different CPU
models will only use features present in all
models.
Com patibility Version
T he version of Red Hat Enterprise Virtualization.
Choose one of:
3.0
3.1
3.2
You will not be able to select a version older than
the version specified for the data center.
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.
Im port existing gluster
configuration
T his check box is only available if the Enable
Gluster Service radio button is selected.
46
Chapter 4. Clusters
T his option allows you to import an existing
Gluster-enabled cluster and all its attached hosts
to Red Hat Enterprise Virtualization Manager.
T he following options are required for each host
in the cluster that is being imported:
Address: Enter the IP or fully qualified domain
name of the Gluster host server.
Fingerprint: Red Hat Enterprise
Virtualization Manager fetches the host's
fingerprint, to ensure you are connecting with
the correct host.
Root Password: Enter the root password
required for communicating with the host.
See Also:
Section 4.2.5, “Explanation of Settings in the Add Hosts Window”
Report a bug
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. T his 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 T hread Handling allows hosts to run virtual machines with a total number of processor cores
greater than number of cores in the host. T his 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.
47
Red Hat Enterprise Virtualization 3.2 Administration Guide
Figure 4 .3. Optimization Settings
T he table below describes the settings for the Optim ization tab in the New Cluster and Edit
Cluster windows.
48
Chapter 4. Clusters
T able 4 .2. Optimization Settings
Field
Description/Action
Mem ory Optim ization
CPU T hreads
None - Disable m em ory page
sharing: Disables memory page sharing.
For Server Load - Enable m em ory
page sharing to 150%: Sets the memory
page sharing threshold to 150% of the
system memory on each host.
For Desktop Load - Enable m em ory
page sharing to 200%: Sets the memory
page sharing threshold to 200% of the
system memory on each host.
Selecting the Count T hreads As Cores
checkbox allows hosts to run virtual machines
with a total number of processor cores greater
than the number of cores in the host.
T he 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.
Report a bug
4 .2.2.3. Resilience Policy Settings Explained
T he 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 resourceconsuming process. T herefore, 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.
T he table below describes the settings for the Resilience Policy tab in the New Cluster and
Edit Cluster windows.
49
Red Hat Enterprise Virtualization 3.2 Administration Guide
T able 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.
Report a bug
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.
Figure 4 .4 . Power Management Policy Settings
T he table below describes the settings for the Edit Policy window.
50
Chapter 4. Clusters
T able 4 .4 . Cluster General T ab Properties
Field/T ab
Description/Action
None
Set the policy value to None to have no load or
power sharing between hosts. T his is the default
mode.
Even Distribution
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 under-utilized hosts. Hosts with
a CPU load below the minimum service level past
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 maximum service level.
Maxim um Service Level
Set by the blue slider. If the host runs at maximum
service level for the defined time interval, the Red
Hat Enterprise Virtualization Manager will migrate
virtual machines to other hosts in the cluster until
the host's CPU load is below the maximum
service threshold.
Minim um Service Level
Set by the green slider. If the host runs below
minimum service level for the defined time interval,
the Red Hat Enterprise Virtualization Manager will
migrate virtual machines to other hosts in the
cluster and power down the host.
T im e Interval Entry Field
Sets the time (in minutes) that a host can run a
CPU load outside of the defined service levels
before the cluster policy takes action. T he defined
time interval protects against temporary spikes in
CPU load activating cluster policies and
instigating unnecessary virtual machine migration.
Maximum two characters.
Report a bug
4.2.3. Editing a Resource
Summary
Edit the properties of a resource.
Procedure 4 .2. Editing a Resource
1. Use the resource tabs, tree mode, or the search function to find and select the resource in the
results list.
2. Click Edit to open the Edit window.
51
Red Hat Enterprise Virtualization 3.2 Administration Guide
3. Change the necessary properties and click OK.
Result
T he new properties are saved to the resource. T he Edit window will not close if a property field is
invalid.
Report a bug
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.
Procedure 4 .3. Importing an Existing Red Hat Storage Cluster to Red Hat Enterprise
Virtualization Manager
1. Select the Clusters resource tab to list all clusters in the results list.
2. Click New to open the New Cluster window.
3. Select the Data Center the cluster will belong to from the drop-down menu.
4. Enter the Nam e and Description of the cluster.
5. Select the Enable Gluster Service radio button and the Im port existing gluster
configuration check box.
T he Im port existing gluster configuration field is displayed only if you select
Enable Gluster Service radio button.
52
Chapter 4. Clusters
Figure 4 .5. Import Existing Cluster Configuration
6. In the Address field, enter the hostname or IP address of any server in the cluster.
T he 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.
7. Enter the Root Password for the server, and click OK.
8. T he Add Hosts window opens, and a list of hosts that are a part of the cluster displays.
53
Red Hat Enterprise Virtualization 3.2 Administration Guide
Figure 4 .6. Add Hosts Window
9. For each host, enter the Nam e and the Root Password.
10. If you wish to use the same password for all hosts, select the Use a Com m on Password
checkbox to enter the password in the provided text field.
Click Apply to set the entered password all hosts.
Make sure the fingerprints are valid and submit your changes by clicking OK.
Result
T he 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:
Section 4.2.5, “Explanation of Settings in the Add Hosts Window”
Section 4.2.2, “Explanation of Settings and Controls in the New Cluster and Edit Cluster Windows”
Report a bug
4.2.5. Explanation of Settings in the Add Hosts Window
T he Add Hosts window allows you to specify the details of the hosts imported as part of a Glusterenabled cluster. T his window appears after you have selected the Enable Gluster Service
checkbox in the New Cluster window and provided the necessary host details.
54
Chapter 4. Clusters
Figure 4 .7. Add Hosts Window
T able 4 .5. Add Gluster Hosts Settings
Field
Description
Use a common password
T ick this checkbox 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
T his 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 if you wish to use a
different root password for each host. T his field
overrides the common password provided for all
hosts in the cluster.
Fingerprint
T he host fingerprint is displayed to ensure you
are connecting with the correct host. T his field is
automatically populated with the fingerprint of the
host you provided in the New Cluster window.
See Also:
Section 4.2.4, “Importing an Existing Red Hat Storage Cluster”
Report a bug
4.2.6. Setting Load and Power Management Policies for Hosts in a Cluster
Summary
55
Red Hat Enterprise Virtualization 3.2 Administration Guide
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.
A host that exceeds the Maxim um Service Level will share its CPU processor load, additional
virtual machines, to other hosts.
A host that does not exceed the Minim um Service Level will migrate all of its virtual machines to
other hosts and power down until such time as it is required again.
Procedure 4 .4 . Setting Load and Power Management Policies for Hosts
1. Use the resource tabs, tree mode, or the search function to find and select the cluster in the
results list.
2. Click the Edit Policy button, found in the General tab of the details pane, to open the Edit
Policy window.
Figure 4 .8. Edit Cluster Policy
3. Select one of the following policies:
None
Even Distribution - use the blue slider to specify the Maxim um Service Level for a
host.
Power Saving - use the green slider to specify the Minim um Service Level for a host.
Use the blue slider to specify the Maxim um Service Level for a host.
4. Specify the defined time interval (in minutes) in the text field.
5. Click OK.
6. Result
56
Chapter 4. Clusters
You have updated the cluster policy for the cluster.
See Also:
Section 4.2.2.4, “Cluster Policy Settings Explained”
Report a bug
4.2.7. Creating a New Logical Network in a Data Center or Cluster
Summary
Create a logical network and define its use in the data center, or clusters in a data center.
Procedure 4 .5. Defining Logical Networks in a Cluster
1. Use the Data Centers or Clusters resource tabs, tree mode, or the search function to find
and select the resource in the results list.
2. Click the Logical Networks tab of the details pane to list the existing logical networks.
3. Click New in the Data Centers details pane to open the New Logical Network window.
Click Add Network in the Clusters details pane to open the New Logical Network window.
Figure 4 .9. New Logical Network
4. Enter the Nam e and Description of the logical network.
5. Select the check boxes to enable a VM Network, Enable VLAN tagging, and Override
MT U.
57
Red Hat Enterprise Virtualization 3.2 Administration Guide
MT U.
6. Select the cluster(s) you want to assign the network to. Note that the network is added as
required Network to the selected clusters.
7. T ick the Allow all users to use this Network checkbox to confer permissions for the
new network to all users.
8. Click OK to create the logical network.
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.
See Also:
Section 5.4.2, “Explanation of Settings and Controls in the New Logical Network and Edit Logical
Network Windows”
Section 5.3, “Required Networks, Optional Networks, and Virtual Machine Networks”
Report a bug
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
1. Use the resource tabs, tree mode, or the search function to find and select the cluster in the
results list.
2. Ensure there are no hosts in the cluster.
3. Click Rem ove to open the Rem ove Cluster(s) confirmation window.
4. Click OK
Result
T he cluster is removed.
Report a bug
4.2.9. Designate a Specific Traffic Type for a Logical Network with the
Assign/UnAssign Window
Prerequisites:
Section 5.4.1, “Creating a New Logical Network in a Data Center or Cluster”
Summary
58
Chapter 4. Clusters
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
1. Use the Clusters resource tab, tree mode, or the search function to find and select the cluster in
the results list.
2. Select the Logical Networks tab in the details pane to list the logical networks assigned to the
cluster.
3. Click Assign/UnAssign Networks to open the Assign/UnAssign Networks window.
Figure 4 .10. Assign/UnAssign Networks
4. Select appropriate check boxes.
5. Click OK to save the changes and close the window.
Result
You have optimized the network traffic flow for the logical network.
See Also:
Section 6.5.1, “Editing Host Network Interfaces and Adding Logical Networks to Hosts”
Section 4.2.10, “Explanation of Settings in the Assign/UnAssign Window”
Report a bug
4.2.10. Explanation of Settings in the Assign/UnAssign Window
T he table below describes the settings for the Assigning/UnAssigning window.
59
Red Hat Enterprise Virtualization 3.2 Administration Guide
T able 4 .6. Assign/UnAssign 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
T he logical network carries the virtual machine
network traffic.
Display Network
T he logical network carries the virtual machine
SPICE and virtual network controller traffic.
Report a bug
4.3. Clusters and Permissions
4.3.1. Managing System Permissions for a Cluster
T he system administrator, as the SuperUser, manages all aspects of the Administration Portal. More
specific administrative roles can be assigned to other users. T hese restricted administrator roles are
useful for empowering a user with certain administrative privileges that limit them to a specific resource:
a DataCenterAdm in role has administrator privileges only for the assigned data center, a
ClusterAdm in 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. T his is useful in
data centers with multiple clusters, where each cluster requires a system administrator. T he
ClusterAdm in role is a hierarchical model: a user assigned the cluster administrator role for a cluster
can manage all objects in the cluster. Use the Configure button in the header bar to assign a cluster
administrator for all clusters in the environment.
T he 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.
See Also:
Section 4.3.2, “Cluster Administrator Roles Explained”
Report a bug
60
Chapter 4. Clusters
4.3.2. Cluster Administrator Roles Explained
Cluster Permission Roles
T he table below describes the administrator roles and privileges applicable to cluster administration.
T able 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 nonrequired.
However, a ClusterAdm in
does not have permissions to
attach or detach networks from
a cluster, to do so
NetworkAdm in 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.
See Also:
Section 12.4.2, “User and Administrator Roles”
Report a bug
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
1. Use the resource tabs, tree mode, or the search function to find and select the resource in the
results list.
2. Click the Perm issions tab of the details pane to list the assigned users, the user's role, and the
inherited permissions for the selected resource.
3. Click Add to open the Add Perm ission to User window.
4. Enter the name or user name of an existing user into the Search text box and click Go. Select a
61
Red Hat Enterprise Virtualization 3.2 Administration Guide
user from the resulting list of possible matches.
5. Select a role from the Role to Assign: drop-down menu.
6. Click OK 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.
Report a bug
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
1. Use the resource tabs, tree mode, or the search function to find and select the resource in the
results list.
2. Click the Perm issions tab of the details pane to list the assigned users, the user's role, and the
inherited permissions for the selected resource.
3. Select the user to remove from the resource.
4. Click Rem ove. T he Rem ove Perm ission window opens to confirm permissions removal.
5. Click OK to remove the user role.
Result
You have removed the user's role, and the associated permissions, from the resource.
Report a bug
62
Chapter 5. Logical Networks
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.
T he default logical network in all data centers is the management network called rhevm . T he 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.
Figure 5.1. Data Center Objects
Warning
Do not change networking in a data center or a cluster if any hosts are running as this risks
making the host unreachable.
63
Red Hat Enterprise Virtualization 3.2 Administration Guide
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.
T his 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:
Chapter 3, Data Centers
Chapter 4, Clusters
Chapter 6, Hosts
Chapter 7, Storage
Chapter 8, Virtual Machines
Report a bug
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. T his 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.
T he only traffic copied is internal to one logical network on one host. T here 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.
See Also:
Section 8.7.4, “Adding and Editing Virtual Machine Network Interfaces”
Report a bug
5.3. Required Networks, Optional Networks, and Virtual Machine
Networks
In versions of Red Hat Enterprise Virtualization prior to 3.1, all of the hosts in a cluster had to use all of
64
Chapter 5. Logical Networks
the cluster's logical network to be operational. Hosts that were missing logical networks were marked
Non-operational.
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.
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. T he presence or
absence of these networks does not affect the Operational status of a host.
Use the Assign/UnAssign Network 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.
See Also:
Section 5.4.2, “Explanation of Settings and Controls in the New Logical Network and Edit Logical
Network Windows”
Report a bug
5.4. Logical Network Tasks
5.4.1. Creating a New Logical Network in a Data Center or Cluster
Summary
Create a logical network and define its use in the data center, or clusters in a data center.
Procedure 5.1. Defining Logical Networks in a Cluster
1. Use the Data Centers or Clusters resource tabs, tree mode, or the search function to find
and select the resource in the results list.
2. Click the Logical Networks tab of the details pane to list the existing logical networks.
3. Click New in the Data Centers details pane to open the New Logical Network window.
Click Add Network in the Clusters details pane to open the New Logical Network window.
65
Red Hat Enterprise Virtualization 3.2 Administration Guide
Figure 5.2. New Logical Network
4. Enter the Nam e and Description of the logical network.
5. Select the check boxes to enable a VM Network, Enable VLAN tagging, and Override
MT U.
6. Select the cluster(s) you want to assign the network to. Note that the network is added as
required Network to the selected clusters.
7. T ick the Allow all users to use this Network checkbox to confer permissions for the
new network to all users.
8. Click OK to create the logical network.
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.
See Also:
Section 5.4.2, “Explanation of Settings and Controls in the New Logical Network and Edit Logical
Network Windows”
Section 5.3, “Required Networks, Optional Networks, and Virtual Machine Networks”
Report a bug
66
Chapter 5. Logical Networks
5.4.2. Explanation of Settings and Controls in the New Logical Network and Edit
Logical Network Windows
Figure 5.3. New Logical Network Settings
T he table below describes the settings for the New Logical Network window.
67
Red Hat Enterprise Virtualization 3.2 Administration Guide
T able 5.1. New Logical Network Settings
Field Name
Description
Nam e
T he name of the logical network. T his 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
T he description of the logical network. T his field
is recommended but not mandatory.
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, like storage
communications for example, do not select VM
Network
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.
Override MT U
Set a custom maximum transmission unit for the
logical network. You can use this to match the
MT U supported by your new logical network to
the MT U supported by the hardware it interfaces
with. Enter a numeric value in the text entry field if
MT U override is enabled.
Attach/Detach Network to/from
Cluster(s)
Select the clusters that use the logical network.
Allow all users to use this Network
Confers NetworkUser permissions on the new
network to Everyone. T his allows any user in
the system with permissions on the relevant
virtual machine or template to connect the
network to the virtual machine or template.
Report a bug
5.4.3. Editing a Logical Network
Summary
Edit the settings of a logical network.
Procedure 5.2. Editing a Logical Network
68
Logical networks are added to clusters as
Required networks by default. You can change
this later using the Assign/UnAssign
Network button.
Chapter 5. Logical Networks
1. 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.
2. Click the Logical Networks tab in the details pane to list the logical networks in the data
center.
3. Select a logical network and click Edit to open the Edit Logical Network window.
4. You are required to detach all clusters before editing the logical network settings. Clear the cluster
check boxes in the Attach/Detach Network to/from Cluster(s) area and click Apply to
open the Attach/Detach Network to/from Clusters confirmation window.
Select the Approve operation check box and click OK to detach the clusters and enable
editing of the logical network.
5. Edit the necessary settings.
6. Attach the necessary clusters.
7. Click OK to save the changes.
Result
You have updated the settings of your logical network.
See Also:
Section 5.4.2, “Explanation of Settings and Controls in the New Logical Network and Edit Logical
Network Windows”
Report a bug
5.4.4. Designate a Specific Traffic Type for a Logical Network with the
Assign/UnAssign Window
Prerequisites:
Section 5.4.1, “Creating a New Logical Network in a Data Center or Cluster”
Summary
Specify the traffic type for the logical network to optimize the network traffic flow.
Procedure 5.3. Assigning or UnAssigning a Logical Network to a Cluster
1. Use the Clusters resource tab, tree mode, or the search function to find and select the cluster in
the results list.
2. Select the Logical Networks tab in the details pane to list the logical networks assigned to the
cluster.
3. Click Assign/UnAssign Networks to open the Assign/UnAssign Networks window.
69
Red Hat Enterprise Virtualization 3.2 Administration Guide
Figure 5.4 . Assign/UnAssign Networks
4. Select appropriate check boxes.
5. Click OK to save the changes and close the window.
Result
You have optimized the network traffic flow for the logical network.
See Also:
Section 6.5.1, “Editing Host Network Interfaces and Adding Logical Networks to Hosts”
Section 5.4.5, “Explanation of Settings in the Assign/UnAssign Window”
Report a bug
5.4.5. Explanation of Settings in the Assign/UnAssign Window
T he table below describes the settings for the Assigning/UnAssigning window.
70
Chapter 5. Logical Networks
T able 5.2. Assign/UnAssign 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
T he logical network carries the virtual machine
network traffic.
Display Network
T he logical network carries the virtual machine
SPICE and virtual network controller traffic.
Report a bug
5.4.6. Adding Multiple VLANs to a Single Network Interface using Logical
Networks
Prerequisites:
Section 5.4.1, “Creating a New Logical Network in a Data Center or Cluster”
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.4 . Adding Multiple VLANs to a Network Interface using Logical Networks
1. 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.
2. Click the Network Interfaces tab in the details pane to list the physical network interfaces
attached to the data center.
3. Click Setup Host Networks to open the Setup Host Networks window.
4. Drag your VLAN-tagged logical networks into the Assigned Logical Networks area next to
the physical network interface. T he physical network interface can have multiple logical networks
assigned due to the VLAN tagging.
71
Red Hat Enterprise Virtualization 3.2 Administration Guide
Figure 5.5. Setup Host Networks
5. 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:
None,
DHCP, or
Static,
Provide the IP and Subnet Mask.
Click OK.
6. 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.
7. Select the Save network configuration check box
8. Click OK.
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. T his 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:
72
Chapter 5. Logical Networks
Section 6.5, “Hosts and Networking”
Report a bug
5.4.7. Using the Networks Tab
T he 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.
Figure 5.6. Networks T ab
All networks in the Red Hat Enterprise Virtualization environment display in the results list of the
Networks tab. T he New, Edit and Rem ove 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, T em plates, and
Perm issions 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
T hese functions are also accessible through each individual resource tab. See the links below for how
to set up networks on resources.
Section 5.4.1, “Creating a New Logical Network in a Data Center or Cluster”
Section 4.2.9, “Designate a Specific T raffic T ype for a Logical Network with the Assign/UnAssign
Window”
Section 5.4.6, “Adding Multiple VLANs to a Single Network Interface using Logical Networks”
Section 8.7.4, “Adding and Editing Virtual Machine Network Interfaces”
Section 3.7.3, “Assigning an Administrator or User Role to a Resource”
Report a bug
73
Red Hat Enterprise Virtualization 3.2 Administration Guide
5.5. Logical Networks and Permissions
5.5.1. Managing System Permissions for a Network
T he system administrator, as the SuperUser, manages all aspects of the Administration Portal. More
specific administrative roles can be assigned to other users. T hese restricted administrator roles are
useful for empowering a user with certain administrative privileges that limit them to a specific resource:
a DataCenterAdm in role has administrator privileges only for the assigned data center, a
HostAdm in 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.
T he 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.
T he user who creates a network is automatically assigned NetworkAdm in permissions on the created
network. You can also change the administrator of a network by removing the existing administrator and
adding the new administrator.
See Also:
Section 5.5.2, “Network Administrator and User Roles Explained”
Report a bug
5.5.2. Network Administrator and User Roles Explained
Network Permission Roles
T he table below describes the administrator and user roles and privileges applicable to network
administration.
74
Chapter 5. Logical Networks
T able 5.3. Red Hat Enterprise Virtualization Network Administrator and User Roles
Role
Privileges
Notes
NetworkAdmin
Network Administrator for data
center, cluster, host, virtual
machine, or template. T he user
who creates a network is
automatically assigned
NetworkAdm in 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. T o configure
port mirroring on a virtual
machine network, apply the
NetworkAdm in role on the
network and the
UserVm Manager 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.
See Also:
Section 5.5.1, “Managing System Permissions for a Network”
Report a bug
5.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 5.5. Assigning a Role to a Resource
1. Use the resource tabs, tree mode, or the search function to find and select the resource in the
results list.
2. Click the Perm issions tab of the details pane to list the assigned users, the user's role, and the
inherited permissions for the selected resource.
3. Click Add to open the Add Perm ission to User window.
4. Enter the name or user name of an existing user into the Search text box and click Go. Select a
user from the resulting list of possible matches.
5. Select a role from the Role to Assign: drop-down menu.
6. Click OK 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.
See Also:
Section 5.5.1, “Managing System Permissions for a Network”
75
Red Hat Enterprise Virtualization 3.2 Administration Guide
Report a bug
5.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 5.6. Removing a Role from a Resource
1. Use the resource tabs, tree mode, or the search function to find and select the resource in the
results list.
2. Click the Perm issions tab of the details pane to list the assigned users, the user's role, and the
inherited permissions for the selected resource.
3. Select the user to remove from the resource.
4. Click Rem ove. T he Rem ove Perm ission window opens to confirm permissions removal.
5. Click OK to remove the user role.
Result
You have removed the user's role, and the associated permissions, from the resource.
Report a bug
76
Chapter 6. Hosts
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 Tuned and ktune section of Red Hat
Enterprise Linux 6.0 Performance T uning Guide
T he Red Hat Enterprise Virtualization Hypervisor has security features enabled. Security Enhanced
Linux (SELinux) and the iptables firewall are fully configured and on by default. T he 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
Support is still ongoing for Red Hat Enterprise Linux 5.4 and 5.5 that already belong to existing
Clusters. However, the Red Hat Enterprise Virtualization Guest Agent is now included in the virtio
serial channel, whereas before it was in a separate channel. As a result, the Guest Agent
installed on Windows guests on Red Hat Enterprise Linux hosts that are upgraded from version 5
to 6 lose connection to the Manager.
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:
http://www.redhat.com/mailman/listinfo/rhev-watch-list/
77
Red Hat Enterprise Virtualization 3.2 Administration Guide
See Also:
Chapter 3, Data Centers
Chapter 4, Clusters
Chapter 5, Logical Networks
Chapter 8, Virtual Machines
Report a bug
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. T hey 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
T he 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.
Report a bug
6.3. 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.
Report a bug
6.4. Host Tasks
6.4.1. Adding a Red Hat Enterprise Linux Host
Summary
A Red Hat Enterprise Linux host is based on a standard installation of Red Hat Enterprise Linux. T he
physical host must be set up before you can add it the Red Hat Enterprise Virtualization environment.
T he Red Hat Enterprise Virtualization Manager logs into the host to perform virtualization checks, install
78
Chapter 6. Hosts
packages, create a network bridge, and reboot the host. T he process of adding a new host can take up
to 10 minutes.
Procedure 6.1. Adding a Red Hat Enterprise Linux Host
1. Click the Hosts resource tab to list the hosts in the results list.
2. Click New to open the New Host window.
3. Use the drop-down menus to select the Data Center and Host Cluster for the new host.
4. Enter the Nam e, Address, and Root Password of the new host.
5. If applicable, clear the Autom atically configure host firewall check box.
6. You can configure the Power Managem ent 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.
7. Click OK to add the host and close the window.
Result
T he new host displays in the list of hosts with a status of Installing. Once installation is complete,
the status will update to Reboot. T he 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:
Section 6.4.2, “Explanation of Settings and Controls in the New Host and Edit Host Windows”
Report a bug
6.4.2. Explanation of Settings and Controls in the New Host and Edit Host
Windows
6.4 .2.1. Host General Settings Explained
T hese settings apply when editing host details or adding new Red Hat Enterprise Linux hosts.
79
Red Hat Enterprise Virtualization 3.2 Administration Guide
Figure 6.1. New Host Settings
T he General settings table contains the information required on the General tab of the New Host or
Edit Host window.
T able 6.1. General settings
Field Name
Description
Name
T he name of the cluster. T his text field has a 40character limit and must be a unique name with
any combination of uppercase and lowercase
letters, numbers, hyphens, and underscores.
Address
T he IP address, or resolvable hostname of the
host.
Data Center
T he data center to which the host belongs. Red
Hat Enterprise Virtualization Hypervisor hosts
can not be added to Gluster-enabled clusters.
Host Cluster
T he cluster to which the host belongs.
Root password
T he password of the host's root user. T his can
only be given when you add the host, it cannot be
edited afterwards.
80
Chapter 6. Hosts
Report a bug
6.4 .2.2. Host Power Management Settings Explained
Figure 6.2. Power Management Settings
T he Power Managem ent settings table contains the information required on the Power
Managem ent tab of the New Host or Edit Host windows.
81
Red Hat Enterprise Virtualization 3.2 Administration Guide
T able 6.2. Power Managem ent Settings
Field Name
Description
Prim ary/ Secondary
Prior to Red Hat Enterprise Virtualization 3.2, a
host with power management configured only
recognised one fencing agent. Fencing agents
configured on version 3.1 and earlier, and single
agents, are treated as primary agents. T he
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.
If this checkbox is selected, both fencing
agents are used concurrently when a host is
fenced. T his means that both fencing agents
have to respond to the Stop command for the
host to be stopped; if one agent responds to
the Start command, the host will go up.
If this checkbox is not selected, the fencing
agents are used sequentially. T his means
that to stop or start a host, the primary agent
is used first, and if it fails, the secondary
agent is used.
Address
T he address to access your host's power
management device. Either a resolvable
hostname or an IP address.
User Nam e
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.
T ype
T he type of power management device in your
host.
Choose one of the following:
apc - APC MasterSwitch network power
switch. Not for use with APC 5.x power switch
devices.
apc_snm p - Use with APC 5.x power switch
devices.
bladecenter - IBM Bladecentre Remote
Supervisor Adapter
cisco_ucs - Cisco Unified Computing
System
drac5 - Dell Remote Access Controller for
Dell computers
eps - ePowerSwitch 8M+ network power
switch
82
Chapter 6. Hosts
ilo, ilo2, ilo3, ilo4 - HP Integrated
Lights-Out
ipm ilan - Intelligent Platform Management
Interface and Sun Integrated Lights Out
Management devices.
rsa - IBM Remote Supervisor Adaptor
rsb - Fujitsu-Siemens RSB management
interface
wti - WT I Network PowerSwitch
Port
T he 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
T ick this checkbox to allow the power
management device to connect securely to the
host. T his 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 Up and Down buttons to change the
sequence in which the resources are used.
Report a bug
6.4 .2.3. SPM Priority Settings Explained
T he SPM settings table details the information required on the SPM tab of the New Host or Edit Host
window.
T able 6.3. SPM settings
Field Name
Description
SPM Priority
Likelihood that the host will be given the role of
Storage Pool Manager(SPM). Choose between
Low, Normal, and High priority.
Report a bug
6.4 .2.4 . Host Console Settings Explained
T he Console settings table details the information required on the Console tab of the New Host or
Edit Host window.
83
Red Hat Enterprise Virtualization 3.2 Administration Guide
T able 6.4 . Console settings
Field Name
Description
Override display address
Select this checkbox to enable overriding the
display addresses of the host. T his 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
T he display address specified here will be used
for all virtual machines running on this host. T he
address must be in the format of a fully qualified
domain name or IP.
Report a bug
6.4.3. 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 m aintenance m ode 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 m aintenance m ode.
Procedure 6.2. Configuring Power Management Settings
1. Use the Hosts resource tab, tree mode, or the search function to find and select the host in the
results list.
2. Click Edit to open the Edit Host window.
3. Click the Power Managem ent tab to display the Power Management settings.
4. Select the Enable Power Managem ent check box to enable the fields.
5. T he Prim ary 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.
6. Select the Concurrent check box to enable multiple fence agents to be used concurrently.
7. Enter the Address, User Nam e, and Password of the power management device into the
appropriate fields.
84
Chapter 6. Hosts
8. Use the drop-down menu to select the T ype of power management device.
9. Enter the Port number used by the power management device to communicate with the host.
10. Enter the Options for the power management device. Use a comma-separated list of
'key=value' or 'key'.
11. Select the Secure checkbox to enable the power management device to connect securely to the
host.
12. Click T est to ensure the settings are correct.
13. Click OK to save your settings and close the window.
Result
You have configured the power management settings for the host. T he Power Managem ent dropdown menu is now enabled in the Administration Portal.
See Also:
Section 6.4.2.2, “Host Power Management Settings Explained”
Section 6.6.3, “Setting Fencing Parameters on a Host”
Report a bug
6.4.4. Configuring Host Storage Pool Manager (SPM) Settings
Summary
T he SPM is a management role given to one of the hosts in a data center to maintain access control
over the storage domains. T he 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.
T he 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.3. Configuring SPM settings
1. Use the Hosts resource tab, tree mode, or the search function to find and select the host in the
results list.
2. Click Edit to open the Edit Host window.
3. Click the SPM tab to display the SPM Priority settings.
4. Use the radio buttons to select the appropriate SPM priority for the host.
5. Click OK to save the settings and close the window.
Result
You have configured the SPM priority of the host.
See Also:
Section 6.4.2.3, “SPM Priority Settings Explained”
Report a bug
85
Red Hat Enterprise Virtualization 3.2 Administration Guide
6.4.5. Editing a Resource
Summary
Edit the properties of a resource.
Procedure 6.4 . Editing a Resource
1. Use the resource tabs, tree mode, or the search function to find and select the resource in the
results list.
2. Click Edit to open the Edit window.
3. Change the necessary properties and click OK.
Result
T he new properties are saved to the resource. T he Edit window will not close if a property field is
invalid.
See Also:
Section 6.4.2, “Explanation of Settings and Controls in the New Host and Edit Host Windows”
Report a bug
6.4.6. Approving Newly Added Red Hat Enterprise Virtualization Hypervisor
Hosts
Prerequisites:
Section 6.4.1, “Adding a Red Hat Enterprise Linux Host”
Summary
You have to install your Red Hat Enterprise Virtualization Hypervisor hosts before you can approve them
in the Red Hat Enterprise Virtualization Manager. Read about installing Red Hat Enterprise Virtualization
Hypervisors in the Red Hat Enterprise Virtualization Installation Guide.
Once installed, the Red Hat Enterprise Virtualization Hypervisor host is visible in the Administration
Portal but not active. Approve it so that it can host virtual machines.
Procedure 6.5. Approving newly added Red Hat Enterprise Virtualization Hypervisor hosts
1. In the Hosts tab, select the host you recently installed using the Red Hat Enterprise Virtualization
Hypervisor host installation media. T his host shows a status of Pending Approval.
2. Click the Approve button.
Result
T he host's status changes to Up and it can be used to run virtual machines.
86
Chapter 6. Hosts
Note
You can also add this host using the Adding a Red Hat Enterprise Linux Host procedure, which
utilizes the Red Hat Enterprise Virtualization Hypervisor host's IP address and the password that
was set on the RHEV-M screen.
Report a bug
6.4.7. 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.
T he 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.6. Moving a Host to Maintenance Mode
1. Use the Hosts resource tab, tree mode, or the search function to find and select the host in the
results list.
2. Click Maintenance to open the Maintenance Host(s) confirmation window.
3. Click OK to initiate maintenance mode.
Result:
All running virtual machines are migrated to alternative hosts. T he Status field of the host changes to
Preparing for Maintenance, and finally Maintenance when the operation completes
successfully.
Report a bug
6.4.8. 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.7. Activating a Host from Maintenance Mode
1. Use the Hosts resource tab, tree mode, or the search function to find and select the host in the
results list.
2. Click Activate.
Result
T he host status changes to Unassigned, and finally Up when the operation is complete. Virtual
machines can now run on the host.
87
Red Hat Enterprise Virtualization 3.2 Administration Guide
Report a bug
6.4.9. Removing a Host
Summary
Remove a host from your virtualized environment.
Procedure 6.8. Removing a host
1. Use the Hosts resource tab, tree mode, or the search function to find and select the host in the
results list.
2. Place the host into maintenance mode.
3. Click Rem ove to open the Rem ove Host(s) confirmation window.
4. Select the Force Rem ove 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.
5. Click OK.
Result
Your host has been removed from the environment and is no longer visible in the Hosts tab.
Report a bug
6.4.10. Customizing Hosts with Tags
Prerequisites:
Section E.3.2, “Creating a T ag”
Summary
You can use tags to store information about your hosts. You can then search for hosts based on tags.
Procedure 6.9. Customizing hosts with tags
1. Use the Hosts resource tab, tree mode, or the search function to find and select the host in the
results list.
2. Click Assign T ags to open the Assign T ags window.
88
Chapter 6. Hosts
Figure 6.3. Assign T ags Window
3. T he Assign T ags window lists all available tags. Select the check boxes of applicable tags.
4. Click OK to assign the tags and close the window.
Result
You have added extra, searchable information about your host as tags.
Report a bug
6.5. Hosts and Networking
6.5.1. 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.10. Editing Host Network Interfaces and Adding Logical Networks to Hosts
1. Use the Hosts resource tab, tree mode, or the search function to find and select the host in the
results.
2. Click the Network Interfaces tab in the details pane to list the network interfaces attached to
the host and their configurations.
3. Click the Setup Host Networks button to open the Setup Host Networks window.
89
Red Hat Enterprise Virtualization 3.2 Administration Guide
Figure 6.4 . T he Setup Host Networks window
4. 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.
5. 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:
None,
DHCP, or
Static.
If you have chosen Static, provide the IP and Subnet Mask.
Click OK.
6. 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.
7. Select the Save network configuration check box if you want these network changes to be
made persistent when the environment is rebooted.
8. Click OK to implement the changes and close the window.
Result
You have assigned logical networks to network interfaces and configured the host network.
90
Chapter 6. Hosts
Report a bug
6.5.2. Creating a Bond Device using the Administration Portal
Summary
You can bond two network interfaces of the same make and model together using one of the 4
supported bonding modes. T his type of configuration can increase available bandwidth and reliability.
Note
If you would like to use the bond device to carry the rhevm management network with VLAN
tagging enabled, please see Red Hat KB43070.
Procedure 6.11. Creating a Bond Device using the Administration Portal
1. Use the Hosts resource tab, tree mode, or the search function to find and select the host in the
results list.
2. Click the Network Interfaces tab in the details pane to list the physical network interfaces
attached to the host.
3. Click Setup Host Networks to open the Setup Host Networks window.
4. Select and drag one of the interfaces over the top of another interface and drop it to open the
Create New Bond window.
Alternatively, right-click the interface and select another interface from the drop-down menu.
Figure 6.5. Bond Devices Window
91
Red Hat Enterprise Virtualization 3.2 Administration Guide
5. Select the Bond Nam e 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.
6. Click OK to create the bond and close the Create New Bond window.
7. Assign a logical network to the newly created bonded interface.
8. Optionally choose to Verify connectivity between Host and Engine and Save
network configuration.
9. Click OK accept the changes and close the Setup Host Networks window.
Result:
Your two interfaces are a linked bond device and can be edited as a single interface. T he bond device
lists 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. T he 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.
See Also:
Section 6.5.1, “Editing Host Network Interfaces and Adding Logical Networks to Hosts”
Report a bug
6.5.3. 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. T he 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
T his 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
92
Chapter 6. Hosts
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
Report a bug
6.5.4. 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.12. Saving a host network configuration
1. Use the Hosts resource tab, tree mode, or the search function to find and select the host in the
results list.
2. Click the Network Interfaces tab on the Details pane to list the NICs on the host, their
address, and other specifications.
3. Click the Save Network Configuration button.
4. T he host network configuration is saved and the following message is displayed on the task bar:
&quot;Network Changes were saved on host &lt;Hostname&gt;.&quot;
Result
T he host's network configuration is saved persistently and will survive reboots.
Report a bug
6.6. Host Resilience
6.6.1. Host High Availability
T he 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 configuation, 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.
93
Red Hat Enterprise Virtualization 3.2 Administration Guide
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 rightclicking on a host and using the options on the menu. In a fencing operation, a non-responsive host is
re-booted, and if the host does not return to an active status within a prescribed time, it remains nonresponsive 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.
Report a bug
6.6.2. Power Management by Proxy in Red Hat Enterprise Virtualization
T he 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. T he Manager uses VDSM to execute power management device actions, so another host in the
environment is used as a fencing proxy.
With Red Hat Enterprise Virtualization 3.2, the ability to prioritize hosts for use as fencing proxies was
introduced. 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.
Report a bug
6.6.3. Setting Fencing Parameters on a Host
T he parameters for host fencing are set using the Power Managem ent 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 managment operations.
Procedure 6.13. Setting fencing parameters on a host
1. Use the Hosts resource tab, tree mode, or the search function to find and select the host in the
results list.
2. Click Edit to open the Edit Host window.
3. Click the Power Managem ent tab.
94
Chapter 6. Hosts
Figure 6.6. Power Management Settings
4. Select the Enable Power Managem ent check box to enable the fields.
5. T he Prim ary 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.
6. Select the Concurrent check box to enable multiple fence agents to be used concurrently.
7. Enter the Address, User Nam e, and Password of the power management device.
8. Select the power management device T ype from the drop-down menu.
9. Enter the Port number used by the power management device to communicate with the host.
10. Enter the specific Options of the power management device. Use a comma-separated list of
'key=value' or 'key' entries.
11. Click the T est 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.
95
Red Hat Enterprise Virtualization 3.2 Administration Guide
12. Click OK 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.
See Also:
Section 6.4.2.2, “Host Power Management Settings Explained”
Report a bug
6.6.4. Using Host Power Management Functions
Prerequisites:
Section 6.6.3, “Setting Fencing Parameters on a Host”
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.14 . Using Host Power Management Functions
1. Use the Hosts resource tab, tree mode, or the search function to find and select the host in the
results list.
2. Click the Power Managem ent drop-down menu.
Figure 6.7. Restart
3. Select one of the following options:
Restart: T his 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. T he agent then restarts this host. When the host is ready for
use its status displays as Up.
Start: T his option starts the host and lets it join a cluster. When it is ready for use its status
displays as Up.
Stop: T his 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.
96
Chapter 6. Hosts
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.
4. Selecting one of the above options opens a confirmation window. Click OK to confirm and proceed.
Result
T he selected action is performed.
Report a bug
6.6.5. 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.15. Manually fencing or isolating a non-responsive host
1. On the Hosts tab, select the host. T he status must display as non-responsive.
2. Manually reboot the host. T his could mean physically entering the lab and rebooting the host.
3. On the Administration Portal, right-click the host entry and select the Confirm Host has been
rebooted button.
Figure 6.8. T he Host Right-click menu
4. A message displays prompting you to ensure that the host has been shut down or rebooted.
97
Red Hat Enterprise Virtualization 3.2 Administration Guide
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.
Report a bug
6.7. Hosts and Permissions
6.7.1. Managing System Permissions for a Host
T he system administrator, as the SuperUser, manages all aspects of the Administration Portal. More
specific administrative roles can be assigned to other users. T hese restricted administrator roles are
useful for empowering a user with certain administrative privileges that limit them to a specific resource:
a DataCenterAdm in role has administrator privileges only for the assigned data center, a
HostAdm in has administrator privileges only for the assigned host, and so forth.
A host administrator is a system administration role for a specific host only. T his 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.
T he 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.
See Also:
Section 6.7.2, “Host Administrator Roles Explained”
Report a bug
6.7.2. Host Administrator Roles Explained
Host Permission Roles
T he table below describes the administrator roles and privileges applicable to host administration.
T able 6.5. 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.
See Also:
98
Chapter 6. Hosts
Section 12.4.2, “User and Administrator Roles”
Report a bug
6.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 6.16. Assigning a Role to a Resource
1. Use the resource tabs, tree mode, or the search function to find and select the resource in the
results list.
2. Click the Perm issions tab of the details pane to list the assigned users, the user's role, and the
inherited permissions for the selected resource.
3. Click Add to open the Add Perm ission to User window.
4. Enter the name or user name of an existing user into the Search text box and click Go. Select a
user from the resulting list of possible matches.
5. Select a role from the Role to Assign: drop-down menu.
6. Click OK 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.
See Also:
Section 12.4.2, “User and Administrator Roles”
Report a bug
6.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 6.17. Removing a Role from a Resource
1. Use the resource tabs, tree mode, or the search function to find and select the resource in the
results list.
2. Click the Perm issions tab of the details pane to list the assigned users, the user's role, and the
inherited permissions for the selected resource.
3. Select the user to remove from the resource.
4. Click Rem ove. T he Rem ove Perm ission window opens to confirm permissions removal.
5. Click OK to remove the user role.
Result
You have removed the user's role, and the associated permissions, from the resource.
99
Red Hat Enterprise Virtualization 3.2 Administration Guide
Report a bug
100
Chapter 7. Storage
Chapter 7. Storage
7.1. Introduction to Storage in Red Hat Enterprise Virtualization
Red Hat Enterprise Virtualization uses a centralized storage system for virtual machine disk images, ISO
files and snapshots. Storage networking can be implemented using:
Network File System (NFS).
Other POSIX compliant file systems.
Internet Small Computer System Interface (iSCSI).
Local storage attached directly to the virtualization hosts.
Fibre Channel Protocol (FCP).
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.
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.
T he Red Hat Enterprise Virtualization platform enables you to assign and manage storage using the
Administration Portal's Storage tab. T he 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.
T he 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. ISO storage domains
use NFS storage.
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
101
Red Hat Enterprise Virtualization 3.2 Administration Guide
environment once you have determined the storage needs of your data center(s).
Important
T o 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.
Report a bug
7.2. 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 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. T he 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.
Report a bug
7.3. 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. T he total size of this metadata is limited to 2 kb, limiting the number of storage domains
that can be in a pool.
T emplate 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.
102
Chapter 7. Storage
Physical volume names are no longer included in the metadata.
T emplate 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. T his 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, 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.
Report a bug
7.4. Preparing and Adding File-based Storage
7.4.1. Preparing NFS Storage
Summary
T hese 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
1. 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-utils
If 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 using yum while logged in as the
root user:
# yum install nfs-utils
2. Configure Boot Scripts
T o ensure that NFS shares are always available when the system is operational both the nfs and
rpcbind services must start at boot time. Use the chkconfig command while logged in as
root to modify the boot scripts.
103
Red Hat Enterprise Virtualization 3.2 Administration Guide
#
#
#
#
chkconfig
chkconfig
chkconfig
chkconfig
--add rpcbind
--add nfs
rpcbind on
nfs on
Once the boot script configuration has been done, start the services for the first time.
# service rpcbind start
# service nfs start
3. Create Directory
Create the directory you wish to share using NFS.
# mkdir /exports/iso
Replace /exports/iso with the name, and path of the directory you wish to use.
4. Export Directory
T o be accessible over the network using NFS the directory must be exported. NFS exports are
controlled using the /etc/exports configuration 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.
T o grant read, and write access to /exports/iso using NFS for example you add the following
line to the /etc/exports file.
/exports/iso
*(rw)
Again, replace /exports/iso with the name, and path of the directory you wish to use.
5. Reload NFS Configuration
For the changes to the /etc/exports file to take effect the service must be told to reload the
configuration. T o force the service to reload the configuration run the following command as root:
# service nfs reload
6. Set Permissions
T he 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/iso is the directory to be used as an NFS share.
# chown -R 36:36 /exports/iso
T he permissions on the directory must be set to allow read and write access to both the owner
and the group. T he owner should also have execute access to the directory. T he permissions are
set using the chm od command. T he following command arguments set the required permissions
on the /exports/iso directory.
# chmod 0755 /exports/iso
Result
T he NFS file share has been created, and is ready to be attached by the Red Hat Enterprise
Virtualization Manager.
104
Chapter 7. Storage
Report a bug
7.4.2. Attaching NFS Storage
Summary
An NFS type Storage Dom ain 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
1. Click the Storage resource tab to list the existing storage domains.
2. Click New Dom ain to open the New Dom ain window.
Figure 7.1. NFS Storage
3. Enter the Nam e of the storage domain.
4. Select the Data Center, Dom ain Function / Storage T ype, and Use Host from the
105
Red Hat Enterprise Virtualization 3.2 Administration Guide
drop-down menus.
If applicable, select the Form at from the drop-down menu.
5. Enter the Export Path to be used for the storage domain.
T he export path should be in the format of 192.168.0.10:/data or
dom ain.exam ple.com :/data
6. Click Advanced Param eters 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.
7. Click OK to create the storage domain and close the window.
Result
T he 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.
Report a bug
7.4.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/im ages. T his directory already exists with the correct permissions on Hypervisor
installations. T he steps in this procedure are only required when preparing local storage on Red
Hat Enterprise Linux virtualization hosts.
Procedure 7.3. Preparing Local Storage
1. On the virtualization host, create the directory to be used for the local storage.
# mkdir -p /data/images
2. Ensure that the directory has permissions allowing read/write access to the vdsm user (UID 36)
and kvm group (GID 36).
# chown 36:36 /data /data/images
106
Chapter 7. Storage
# chmod 0755 /data /data/images
Result
Your local storage is ready to be added to the Red Hat Enterprise Virtualization environment.
Report a bug
7.4.4. Adding Local Storage
Summary
You have prepared the storage that is local to your host. Add it to the host to begin using it.
Adding local storage to a host in this manner causes the host to be put in a new data center and cluster.
T he 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
1. Use the Hosts resource tab, tree mode, or the search function to find and select the host in the
results list.
2. Click Maintenance to place the host into maintenance mode.
3. Click Configure Local Storage to open the Configure Local Storage window.
Figure 7.2. Configure Local Storage Window
4. Click the Edit buttons next to the Data Center, Cluster, and Storage fields to configure
and name the local storage domain.
107
Red Hat Enterprise Virtualization 3.2 Administration Guide
5. Set the path to your local storage in the text entry field.
6. If applicable, select the Mem ory Optim ization tab to configure the memory optimization policy
for the new local storage cluster.
7. Click OK to save the settings and close the window.
Result
Your host comes online in a data center of its own.
Report a bug
7.5. Adding POSIX Compliant File System Storage
7.5.1. POSIX Compliant File System Storage in Red Hat Enterprise Virtualization
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. T his 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. T he 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.
Report a bug
7.5.2. 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.5. Attaching POSIX Compliant File System Storage
1. Click the Storage resource tab to list the existing storage domains in the results list.
2. Click New Dom ain to open the New Dom ain window.
108
Chapter 7. Storage
Figure 7.3. POSIX Storage
3. Enter the Nam e for the storage domain.
4. Select the Data Center to be associated with the storage domain. T he Data Center selected
must be of type POSIX (POSIX com pliant FS). Alternatively, select (none).
5. Select Data / POSIX com pliant FS from the Dom ain Function / Storage T ype dropdown menu.
If applicable, select the Form at from the drop-down menu.
6. Select a host from the Use Host drop-down menu. Only hosts within the selected data center will
be listed. T he host that you select will be used to connect the storage domain.
7. Enter the Path to the POSIX file system, as you would normally provide it to the m ount command.
8. Enter the VFS T ype, as you would normally provide it to the m ount command using the -t
argument. See m an m ount for a list of valid VFS types.
9. Enter additional Mount Options, as you would normally provide them to the m ount command
using the -o argument. T he mount options should be provided in a comma-separated list. See
m an m ount for a list of valid mount options.
10. Click OK to attach the new Storage Domain and close the window.
Result
109
Red Hat Enterprise Virtualization 3.2 Administration Guide
You have used a supported mechanism to attach an unsupported file system as a storage domain.
Report a bug
7.6. Adding Block-based Storage
7.6.1. Preparing iSCSI Storage
Summary
T hese 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.6. Preparing iSCSI Storage
1. Install the scsi-target-utils package using the yum command as root on your storage server.
# yum install -y scsi-target-utils
2. Add the devices or files you want to export to the /etc/tgt/targets.conf file. Here is a
generic example of a basic addition to the targets.conf file:
&lt;target iqn.YEAR-MONTH.com.EXAMPLE:SERVER.targetX&gt;
backing-store /PATH/TO/DEVICE1 # Becomes LUN 1
backing-store /PATH/TO/DEVICE2 # Becomes LUN 2
backing-store /PATH/TO/DEVICE3 # Becomes LUN 3
&lt;/target&gt;
T argets 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.
3. Start the tgtd service.
# service tgtd start
4. Make the tgtd start persistently across reboots.
# chkconfig tgtd on
5. Open an iptables firewall port to allow clients to access your iSCSI export. By default, iSCSI uses
port 3260. T his example inserts a firewall rule at position 6 in the INPUT table.
# iptables -I INPUT 6 -p tcp --dport 3260 -j ACCEPT
6. 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.
Report a bug
110
Chapter 7. Storage
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.7. Adding iSCSI Storage
1. Click the Storage resource tab to list the existing storage domains in the results list.
2. Click the New Dom ain button to open the New Dom ain window.
3. Enter the Nam e of the new storage domain.
Figure 7.4 . New iSCSI Domain
111
Red Hat Enterprise Virtualization 3.2 Administration Guide
4. 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).
5. Use the drop-down menus to select the Dom ain Function / Storage T ype and the
Form at. T he storage domain types that are not compatible with the chosen data center are not
available.
6. 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.
7. T he Red Hat Enterprise Virtualization Manager is able to map either iSCSI targets to LUNs, or
LUNs to iSCSI targets. T he New Dom ain 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 T arget Discovery
a. Click Discover T argets to enable target discovery options. When targets have been
discovered and logged in to, the New Dom ain 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 T argets options to add LUNs on many targets, or multiple
paths to the same LUNs.
b. Enter the fully qualified domain name or IP address of the iSCSI host in the Address field.
c. Enter the port to connect to the host on when browsing for targets in the Port field. T he
default is 3260.
d. If the Challenge Handshake Authentication Protocol (CHAP) is being used to secure the
storage, select the User Authentication check box. Enter the CHAP usernam e and
CHAP password.
e. Click the Discover button.
f. Select the target you want to use from the discovery results and click the Login button.
Alternatively, click the Login All to log in to all of the discovered targets.
8. Click the + button next to the desired target. T his will expand the entry and display all unused
LUNs attached to the target.
9. Select the check box for each LUN that you are using to create the storage domain.
10. Click OK to create the storage domain and close the window.
Result
T he new iSCSI storage domain displays on the storage tab. T his can take up to 5 minutes.
112
Chapter 7. Storage
Report a bug
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.8. Adding FCP Storage
1. Click the Storage resource tab to list all storage domains in the virtualized environment.
2. Click New Dom ain to open the New Dom ain window.
3. Enter the Nam e of the storage domain
113
Red Hat Enterprise Virtualization 3.2 Administration Guide
Figure 7.5. Adding FCP Storage
4. 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).
5. Use the drop-down menus to select the Dom ain Function / Storage T ype and the
Form at. T he storage domain types that are not compatible with the chosen data center are not
available.
6. 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.
7. T he New Dom ain 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.
114
Chapter 7. Storage
Alternatively, select the Add LUN check boxes for individual LUNs to use them with the FCP data
domain.
8. Click OK to create the storage domain and close the window.
Result
T he new FCP data domain displays on the Storage 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. Select either Build
New Dom ain or Use Existing Volum e Group.
Report a bug
7.6.4. Un-useable 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.
Figure 7.6. Un-useable LUNs in the Red Hat Enterprise Virtualization Administration
Portal
LUNs that are already being used by the SPM host will also display as in use. You can choose to
115
Red Hat Enterprise Virtualization 3.2 Administration Guide
forcefully over ride the contents of these LUNs, but the operation is not guaranteed to succeed.
Report a bug
7.7. Storage Tasks
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.9. Importing an Existing ISO or Export Storage Domain
1. Click the Storage resource tab to list all the available storage domains in the results list.
2. Click Im port Dom ain to open the Im port Pre-Configured Dom ain window.
Figure 7.7. Import Domain
3. Select the appropriate Dom ain Function / Storage T ype from the following:
ISO
116
Chapter 7. Storage
Export
T he Dom ain Function / Storage T ype determines the availability of the Form at field.
4. 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.
5. Enter the Export path of the storage. T he export path can be either a static IP address or a
resolvable hostname. For example, 192.168.0.10:/Im ages/ISO or
storage.dem o.redhat.com :/exports/iso.
6. Click OK to import the domain and close the window.
7. T he storage domain is imported and displays on the Storage tab. T he next step is to attach it to
a data center. T his 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.
Report a bug
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.
T he 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.10. Populating the ISO Storage Domain
1. Copy the required ISO image to a temporary directory on the system running Red Hat Enterprise
Virtualization Manager.
2. Log in to the system running Red Hat Enterprise Virtualization Manager as the root user.
3. Use the rhevm -iso-uploader command to upload the ISO image. T his 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 image RHEL6.iso is uploaded to the ISO domain called ISODom ain
using NFS. T he command will prompt for an administrative username and password. T he
username must be provided in the form username@domain.
# rhevm-iso-uploader --iso-domain=ISODomain upload RHEL6.iso
117
Red Hat Enterprise Virtualization 3.2 Administration Guide
Result
T he 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.
See Also:
Section 15.6, “Uploading ISO Files with the ISO Uploader T ool”
Report a bug
7.7.3. Moving storage domains to maintenance mode
Summary
Detaching and removing storage domains requires that they be in maintenance mode. T his 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.11. Moving storage domains to maintenance mode
1. Use the Storage resource tab, tree mode, or the search function to find and select the storage
domain in the results list.
2. Shut down and move all the virtual machines running on the storage domain.
3. Click the Data Centers tab in the details pane.
4. Click Maintenance. T he storage domain is deactivated and has an Inactive status 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.
Report a bug
7.7.4. Editing a Resource
Summary
Edit the properties of a resource.
118
Chapter 7. Storage
Procedure 7.12. Editing a Resource
1. Use the resource tabs, tree mode, or the search function to find and select the resource in the
results list.
2. Click Edit to open the Edit window.
3. Change the necessary properties and click OK.
Result
T he new properties are saved to the resource. T he Edit window will not close if a property field is
invalid.
Report a bug
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.
1. Use the Storage resource tab, tree mode, or the search function to find and select the inactive
storage domain in the results list.
2. Click the Data Centers tab in the details pane.
3. Select the appropriate data center and click Activate.
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.
Report a bug
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.13. Removing a Storage Domain
1. Use the Storage resource tab, tree mode, or the search function to find and select the
appropriate storage domain in the results list.
2. Move the domain into maintenance mode to deactivate it.
3. Detach the domain from the data center.
4. Click Remove to open the Rem ove Storage confirmation window.
5. Select a host from the list.
6. Click OK to remove the storage domain and close the window.
119
Red Hat Enterprise Virtualization 3.2 Administration Guide
Summary
T he storage domain is permanently removed from the environment.
Report a bug
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.14 . Destroying a Storage Domain
1. Use the Storage resource tab, tree mode, or the search function to find and select the
appropriate storage domain in the results list.
2. Right-click the storage domain and select Destroy to open the Destroy Storage Dom ain
confirmation window.
3. Select the Approve operation check box and click OK to destroy the storage domain and
close the window.
Result
T he storage domain has been destroyed. Manually clean the export directory for the storage domain to
recycle it.
Report a bug
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.15. Detaching an Export Domain from the Data Center
1. Use the Storage resource tab, tree mode, or the search function to find and select the export
domain in the results list.
2. Click the Data Centers tab in the details pane and select the export domain.
3. Click Maintenance to put the export domain into maintenance mode.
4. Click Detach to open the Detach Storage confirmation window.
5. Click OK to detach the export domain.
Result
T he export domain has been detached from the data center, ready to be attached to another data
center.
Report a bug
120
Chapter 7. Storage
7.7.9. Attaching an Export Domain to a Data Center
Prerequisites:
Section 9.2.7, “Importing T emplates”
Summary
Attach the export domain to a data center.
Procedure 7.16. Attaching an Export Domain to a Data Center
1. Use the Storage resource tab, tree mode, or the search function to find and select the export
domain in the results list.
2. Click the Data Centers tab in the details pane.
3. Click Attach to open the Attach to Data Center window.
4. Select the radio button of the appropriate data center.
5. Click OK to attach the export domain.
6. Select the newly attached data center in the details pane and click Activate.
Result
T he export domain is attached to the data center and activated.
Report a bug
7.8. Red Hat Storage Volumes
7.8.1. Introduction to Red Hat Storage Volumes
You can use the console to create and start new volumes. Volumes combine storage from more than
one Red Hat Storage Server into a single global namespace. A volume is a logical collection of bricks
where each brick is an export directory on a Red Hat Storage Server in the trusted storage pool. Most of
the management operations of Red Hat Storage Console happen on the volume.
You can monitor volumes in your cluster from the Volum es tab.
Note
Bricks must be created externally on Red Hat Storage nodes.
Report a bug
7.8.2. Gluster Storage Terminology
121
Red Hat Enterprise Virtualization 3.2 Administration Guide
T able 7.1. Data Center Properties
T erm
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:
m yhostnam e:/exports/m yexportdir/
Block Storage
Block special files or block devices correspond to
devices through which the system moves data in
the form of blocks. T hese 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
T he 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
T he 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 Z ones.
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
122
Chapter 7. Storage
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
T he 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.
T ranslator
A translator connects to one or more subvolumes,
does something with them, and offers a
subvolume connection.
T rusted 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
123
Red Hat Enterprise Virtualization 3.2 Administration Guide
the gluster management operations happen on
the volume.
Report a bug
7.8.3. Creating A Storage Volume
Summary
You can create new volumes in your storage environment. 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.
Important
When using local storage on Red Hat Storage hosts, it is recommended to use replicated
volumes, where bricks are exported from different hosts. Replicated volumes create copies of
files across multiple bricks in the volume, preventing data loss when a host is fenced.
Procedure 7.17. Creating A Storage Volume
1. Click the Volum es tab. T he Volum es tab displays a list of all volumes in the system.
2. Click the Create Volum e button. T he Create Volum e dialog box displays.
Figure 7.8. Create Volume
124
Chapter 7. Storage
3. Select the cluster from the Volume Cluster drop-down list.
4. In the Name field, enter the name of the volume.
5. Select the type of the volume from the T ype drop-down list. You can choose the volume type as
Distribute, Replicate, or Stripe.
6. Add bricks to your volume. Bricks must be created externally on the Red Hat Storage nodes. Click
Add Bricks.
7. Select the Access Protocol for the new volume by selecting GlusterFS,or NFS, or both
checkboxes.
8. In the Allow Access From field, specify the volume access control as a comma-separated list of
IP addresses or hostnames.
You can use wildcards to specify ranges of addresses such as an asterisk (*) which specifies all
IP addresses or hostnames. You need to use IP-based authentication for Gluster Filesystem and
NFS exports.
9. Click OK to create the volume. T he new volume is added and displays on the Volum e tab.
Result
You've added a Red Hat Storage volume to store virtual machines on.
Report a bug
7.8.4. Adding Bricks to a Volume
Summary
You can expand your cluster 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.18. Adding Bricks to a Volume
1. On the Volum es tab on the navigation pane, select the volume to which you want to add bricks.
2. Select the volume to add new bricks. Click the Bricks tab from the Details pane.
3. Click Add Bricks to open the Add Bricks window.
125
Red Hat Enterprise Virtualization 3.2 Administration Guide
Figure 7.9. Add Bricks
4. Use the Server drop-down menu to select the server on which the brick will reside.
5. Enter the path for the Brick Directory. T he directory or its parent directory must already
exist.
6. Click Add. A list of available bricks appears, with server addresses and brick directory names.
7. T ick the checkbox of the bricks you wish to use.
8. Click OK.
Result
T he new bricks are added to the volume and the bricks displays in the volume's Bricks tab.
Report a bug
7.8.5. Explanation of Settings in the Add Bricks window
126
Chapter 7. Storage
T able 7.2. Add Bricks T ab Properties
Field Name
Description
Volum e T ype
Displays the type of volume. T his field cannot be
changed, it was set when you created the volume.
Server
T he selected server to add new bricks.
Brick Directory
T he directory in the server.
Report a bug
7.8.6. Enabling Red Hat Storage Volumes for Virtualization
Summary
You can enable a Red Hat Storage volume for virtualization using Red Hat Enterprise Virtualization
Manager by creating a cluster with the Enable Gluster Service option selected. A volume is a
logical collection of bricks, where each brick is an export directory on a server in the trusted storage
pool. Most of the management operations of Red Hat Storage occur on the volume.
Red Hat recommends that you use separate data centers for Red Hat Storage nodes.
Important
Enable Gluster Service is a T echnology Preview feature. T echnology 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.
Important
Red Hat Storage currently only supports Red Hat Enterprise Virtualization 3.1. All Gluster clusters
and hosts must be attached to data centers which are compatible with version 3.1.
Procedure 7.19. Enabling Red Hat Storage Volumes for Virtualization
1. On the Data Centers tab, click New to create a new data center. Set its Com patibility
Version to 3.1 and its storage T ype to POSIX com pliant FS. See Section 3.5.1, “Creating a
New Data Center” for details.
2. You can either create a new Gluster-enabled cluster and install at least one new host, or import
an existing Gluster-enabled cluster and all its attached hosts.
A. New cluster and host: On the Clusters tab, click New to create a new cluster. Choose the
Data Center you just created, enter all required details and select the Enable Gluster
Service checkbox. See Section 4.2.1, “Creating a New Cluster” for details.
On the Hosts tab, click New to add a new Red Hat Storage host. Choose the Data Center
and Cluster you just created, enter all required details to install the host. See Section 6.4.1,
“Adding a Red Hat Enterprise Linux Host” for details.
B. Existing cluster and host: On the Clusters tab, click New to import your existing Gluster
127
Red Hat Enterprise Virtualization 3.2 Administration Guide
enabled cluster and all its attached hosts. Choose the Data Center you just created, enter
all required details and select the Enable Gluster Service checkbox. Select the Im port
existing gluster configuration checkbox and enter all required details. See
Section 4.2.4, “Importing an Existing Red Hat Storage Cluster” for details.
3. On the Volum es tab, click Create Volum e and enter all required information. Add bricks to the
volume using the Add Bricks button. See Section 7.8.3, “Creating A Storage Volume” for details.
4. Select the newly created volume and click Optim ize for Virt Store.
T he volume is tuned and group, storage-owner-uid, and storage-owner-gid options are
set.
5. Select the new volume and click Start to start the volume. T he volume status changes to Up.
You must optimize the volume before you can attach the volume to your storage domain.
Result
You can now create a storage domain using the optimized Red Hat Storage volume and manage it using
the Red Hat Enterprise Virtualization Manager.
Report a bug
7.8.7. 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 7.20. Starting Volumes
1. In the Volum es tab, select the volume to be started.
You can select multiple volumes to start by using Shift or Ctrl key.
2. Click the Start button.
T he volume status changes to Up.
Result
You can now use your volume for virtual machine storage.
Report a bug
7.8.8. Tuning Volumes
Summary
T uning volumes allows you to affect their performance. T o tune volumes, you add options to them.
Procedure 7.21. T uning Volumes
1. Click the Volum es tab.
A list of volumes displays.
2. Select the volume that you want to tune, and click the Volum e Options tab from the Details
pane.
T he Volum e Options tab displays a list of options set for the volume.
128
Chapter 7. Storage
3. Click Add to set an option. T he Add Option dialog box displays. Select the Option Key from the
drop down list and enter the option value.
Figure 7.10. Add Option
4. Click OK.
T he option is set and displays in the Volum e Options tab.
Result
You have tuned the options for your storage volume.
Report a bug
7.8.9. Editing Volume Options
Summary
You have tuned your volume by adding options to it. You can change the options for your storage
volume.
Procedure 7.22. Editing Volume Options
1. Click the Volum es tab.
A list of volumes displays.
2. Select the volume that you want to edit, and click the Volum e Options tab from the Details pane.
T he Volum e Options tab displays a list of options set for the volume.
3. Select the option you wish to edit. Click Edit. T he Edit Option dialog box displays. Enter a
new value for the option.
4. Click OK.
T he edited option displays in the Volum e Options tab.
result
You've changed the options on your volume.
129
Red Hat Enterprise Virtualization 3.2 Administration Guide
Report a bug
7.8.10. Reset Volume Options
Summary
You can reset options to revert them to their default values.
1. Click the Volum es tab.
A list of volumes displays.
2. Select the volume and click the Volum e Options tab from the Details pane.
T he Volum e Options tab displays a list of options set for the volume.
3. Select the option you wish to reset. Click Reset. A dialog box displays, prompting to confirm the
reset option.
4. Click OK.
T he selected option is reset.
Note
You can reset all volume options by clicking Reset All button. A dialog box displays, prompting
to confirm the reset option. Click OK. All volume options are reset for the selected volume.
Result
You've reset volume options to default.
Report a bug
7.8.11. 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 7.23. Removing Bricks from a Volume
1. On the Volum es tab on the navigation pane, select the volume from which you wish to remove
bricks.
2. Click the Bricks tab from the Details pane.
3. Select the bricks you wish to remove. Click Rem ove Bricks.
4. A window opens, prompting to confirm the deletion. Click OK to confirm.
Result
T he bricks are removed from the volume.
Report a bug
7.8.12. Stopping Red Hat Storage Volumes
130
Chapter 7. Storage
Summary
After a volume has been started, it can be stopped.
Procedure 7.24 . Stopping Volumes
1. In the Volum es tab, select the volume to be stopped.
You can select multiple volumes to stop by using Shift or Ctrl key.
2. Click Stop.
Result
T he volume status changes is Down.
Report a bug
7.8.13. Deleting Red Hat Storage Volumes
Summary
You can delete a volume or multiple volumes from your cluster.
1. In the Volum es tab, select the volume to be deleted.
2. Click Rem ove. A dialog box displays, prompting to confirm the deletion. Click OK.
Result
T he volume is removed from the cluster.
Report a bug
7.9. Storage and Permissions
7.9.1. Managing system permissions for a storage domain
T he system administrator, as the SuperUser, manages all aspects of the Administration Portal. More
specific administrative roles can be assigned to other users. T hese restricted administrator roles are
useful for empowering a user with certain administrative privileges that limit them to a specific resource:
a DataCenterAdm in role has administrator privileges only for the assigned data center, a
StorageAdm in 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. T his 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.
T he 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.
131
Red Hat Enterprise Virtualization 3.2 Administration Guide
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.
See Also:
Section 7.9.2, “Storage Administrator Roles Explained”
Report a bug
7.9.2. Storage Administrator Roles Explained
Storage Domain Permission Roles
T he table below describes the administrator roles and privileges applicable to storage domain
administration.
T able 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.
See Also:
Section 12.4.2, “User and Administrator Roles”
Report a bug
7.9.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.25. Assigning a Role to a Resource
1. Use the resource tabs, tree mode, or the search function to find and select the resource in the
results list.
2. Click the Perm issions tab of the details pane to list the assigned users, the user's role, and the
inherited permissions for the selected resource.
3. Click Add to open the Add Perm ission to User window.
4. Enter the name or user name of an existing user into the Search text box and click Go. Select a
user from the resulting list of possible matches.
5. Select a role from the Role to Assign: drop-down menu.
132
Chapter 7. Storage
6. Click OK 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.
See Also:
Section 12.4.2, “User and Administrator Roles”
Report a bug
7.9.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.26. Removing a Role from a Resource
1. Use the resource tabs, tree mode, or the search function to find and select the resource in the
results list.
2. Click the Perm issions tab of the details pane to list the assigned users, the user's role, and the
inherited permissions for the selected resource.
3. Select the user to remove from the resource.
4. Click Rem ove. T he Rem ove Perm ission window opens to confirm permissions removal.
5. Click OK to remove the user role.
Result
You have removed the user's role, and the associated permissions, from the resource.
Report a bug
133
Red Hat Enterprise Virtualization 3.2 Administration Guide
Chapter 8. Virtual Machines
8.1. Introduction to Virtual Machines
A virtual machine is a software implementation of a computer. T he 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.
Report a bug
8.2. Supported Virtual Machine Operating Systems
Red Hat Enterprise Virtualization supports the virtualization of these guest operating systems:
T able 8.1. Supported virtual machine 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 Other Linux 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
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
32-bit, 64-bit
Yes
Windows Server 2008
32 bit, 64 bit
Yes
Windows Server 2008 R2
64-bit
Yes
Windows Server 2012 R2
64-bit
No
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 which prevent SPICE from performing optimally.
134
Chapter 8. Virtual Machines
Note
See http://www.redhat.com/resourcelibrary/articles/enterprise-linux-virtualization-support for
information about up-to-date guest support.
Report a bug
8.3. Virtual Machine Performance Parameters
Red Hat Enterprise Virtualization virtual machines can support the following parameters:
T able 8.2. Supported virtual machine parameters
Parameter
Number
Note
Virtualized CPUs
160
per virtual machine
Virtualized RAM
2T B
For a 64 bit virtual machine
Virtualized RAM
4GB
per 32 bit virtual machine. Note,
the virtual machine may not
register the entire 4GB. T he
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
Report a bug
8.4. Creating Virtual Machines
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 T emplate
1. Click the Virtual Machines resource tab to list all the virtual machines in the results list.
T he 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.
2. Click the New Server button to open the New Server Virtual Machine window, or the New
Desktop button to open the New Desktop Virtual Machine window.
135
Red Hat Enterprise Virtualization 3.2 Administration Guide
3. Select the Data Center and Host Cluster on which the desktop is to run. Select an existing
template from the Based on T em plate drop-down menu.
Figure 8.1. New Virtual Machine Window
4. Enter a suitable Nam e and Description, and accept the default values inherited from the
template. You can change the rest of the fields if needed.
5. Click OK.
Result
T he 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:
Section 8.4.3, “Explanation of Settings and Controls in the New Virtual Machine and Edit Virtual
Machine Windows”
Section 8.4.2, “Creating a New Virtual Machine from a Blank T emplate”
Report a bug
8.4.2. Creating a New Virtual Machine from a Blank Template
Summary
136
Chapter 8. Virtual Machines
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 T emplate
1. Click the Virtual Machines resource tab to list all the virtual machines in the results list.
T he 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.
2. Click the New Server button to open the New Server Virtual Machine window, or the New
Desktop button to open the New Desktop Virtual Machine window.
3. On the General tab, you only need to fill in the Nam e and Operating System fields. You can
accept the default settings for other fields, or change them if required.
4. Alternatively, click the Initial Run, Console, Host, Resource Allocation, Boot
Options, and Custom Properties tabs in turn to define options for your virtual machine.
5. Click OK to create the virtual machine and close the window.
6. T he New Virtual Machine - Guide Me window opens. Use the Guide Me buttons to
complete configuration or click Configure Later to close the window.
Result
T he 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.
See Also:
Section 8.4.3, “Explanation of Settings and Controls in the New Virtual Machine and Edit Virtual
Machine Windows”
Report a bug
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
T hese settings apply to adding or editing new virtual machines.
T he Virtual Machine: General settings table details the information required on the General
tab of the New or Edit windows.
137
Red Hat Enterprise Virtualization 3.2 Administration Guide
T able 8.3. Virtual Machine: General Settings
Field Name
Description
Data Center
T he data center to which the virtual machine is
attached.
Host Cluster
T he 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.
Quota (Server only)
A policy that limits the virtual machine from using
more CPU, memory, or storage resources than
are allocated.
Nam e
T he name of virtual machine. Names must not
contain any spaces, and must contain at least
one character from A-Z . T he maximum length of a
virtual machine name is 15 characters.
Description
A meaningful description of the new virtual
machine.
Based on T em plate
T emplates can be used to create a virtual
machines from existing models. T his field is set to
Blank by default, which enables creating a virtual
machine from scratch.
Mem ory Size
T he 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.
T otal Virtual CPUs
T he 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
T he number of cores assigned to each virtual
socket.
Virtual Sockets
T he number of CPU sockets for the virtual
machine. Do not assign more sockets to a virtual
machine than are present on the physical host.
Operating System
T he operating system. Valid values include a
range of Red Hat Enterprise Linux and Windows
variants.
Stateless (Desktop only)
Select this check box if the virtual machine is to
run in stateless mode. T he 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. T his type of virtual
138
Chapter 8. Virtual Machines
machine is useful when creating virtual machines
that need to be used for a short time, or by
temporary staff.
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.
Report a bug
8.4 .3.2. Virtual Machine Initial Run Settings Explained
T hese settings apply to adding or editing new virtual machines.
T he Virtual Machine: Initial Run settings table details the information required on the
Initial Run tab of the New or Edit windows.
T able 8.4 . Virtual Machine: Initial Run Settings
Field Name
Description
General - T im e Zone
T he 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 - Dom ain
T he domain in which the virtual machine is to run.
T his option is only available when Windows is
selected as the operating system on the
Virtual Machine - General tab.
Report a bug
8.4 .3.3. Virtual Machine Console Settings Explained
T hese settings apply to adding or editing new virtual machines.
T he Virtual Machine: Console settings table details the information required on the Console tab
of the New or Edit windows.
139
Red Hat Enterprise Virtualization 3.2 Administration Guide
T able 8.5. 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.
USB Support
Defines whether USB devices can be used on the
virtual machine. T his option is only available for
virtual machines using the SPICE protocol. Select
either:
Disabled - Does not allow USB redirection
from the client machine to the virtual machine.
Legacy - Enables the SPICE USB redirection
policy used in Red Hat Enterprise
Virtualization 3.0. T his option can only be
used on Windows virtual machines, and will
not be supported in future versions of Red
Hat Enterprise Virtualization.
Native - Enables native KVM/ SPICE USB
redirection for Linux and Windows virtual
machines. Virtual machines do not require any
in-guest agents or drivers for native USB.
T his option can only be used if the virtual
machine's cluster compatibility version is set
to 3.1 or higher.
Monitors
T he number of monitors for the virtual machine.
T his 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.
Enable Sm artcard
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.
T ick or untick the checkbox to activate and
deactivate Smartcard authentication for individual
virtual machines.
Disable strict user checking
Click the Advanced Param eters arrow and
select the checkbox 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
14 0
Chapter 8. Virtual Machines
machine. No other user is able to open a console
to the same virtual machine until it has been
rebooted. T he 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 re-booted.
Disable strict checking with caution, because you
can expose the previous user's session to the
new user
Report a bug
8.4 .3.4 . Virtual Machine Host Settings Explained
T hese settings apply to adding or editing new virtual machines.
T he Virtual Machine: Host settings table details the information required on the Host tab of the
New or Edit windows.
14 1
Red Hat Enterprise Virtualization 3.2 Administration Guide
T able 8.6. Virtual Machine: Host Settings
Field Name
Description
Max free Mem ory for scheduling new
VMs
Reports the maximum amount of memory that
remains for the hypervisor to use when creating
new virtual machines. T he value in this field is
calculated prior to taking into account other
scheduling policies, which may further reduce the
amount of memory available for creating virtual
machines. If an attempt to create a virtual machine
fails and Max free Mem ory for
scheduling new VMs only narrowly exceeds
the amount of memory you need to create the
virtual machine, the other scheduling policies
have most likely reduced the amount of free
memory to a level at which Red Hat Enterprise
Virtualization cannot create a new virtual machine.
Run On
Defines the host on which the virtual machine is
to run. Select either:
Any Host in Cluster - T he virtual
machine can start and run on any available
host in the cluster.
Specific - T he virtual machine must run on
a particular host in the cluster. Select the
specific host from the drop-down menu of
available hosts.
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.
Run VM on the selected host (no
migration allowed) - Starts and runs the virtual
machine only on the selected host. Select this
option if your virtual machine does not need to
be highly available.
Allow VM m igration only upon
Adm inistrator specific request
(system will not trigger automatic migration of
this VM) - Prevents the virtual machine from
being migrated mid-operation. For example in
cases of host overload or fencing, the virtual
machine will remain on the host on which it
was started.
CPU Pinning topology
14 2
Enables the virtual machine's virtual CPU (vCPU)
to run on a specific physical CPU (pCPU) in a
specific host. T his option is not supported if the
virtual machine's cluster compatibility version is
set to 3.0. T he syntax of CPU pinning is
v#p[_v#p], for example:
Chapter 8. Virtual Machines
0#0 - Pins vCPU 0 to pCPU 0.
0#0_1#3 - Pins vCPU 0 to pCPU 0, and pins
vCPU 1 to pCPU 3.
1#1-4 ,^2 - Pins vCPU 1 to one of the
pCPUs in the range of 1 to 4, excluding pCPU
2.
In order to pin a virtual machine to a host, you
must select Do not allow m igration under
Migration Options, and select the Use
Host CPU check box.
Report a bug
8.4 .3.5. Virtual Machine High Availability Settings Explained
T hese settings apply to adding or editing new server virtual machines.
T he Virtual Machine: High Availability settings table details the information required on the
High Availability tab of the New or Edit windows.
T able 8.7. 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 re-run on another host. If the host is
manually shut down by the system administrator,
the virtual machine is not automatically moved to
another host.
Priority for Run/Migration queue
Sets the priority level for the virtual machine to be
migrated or restarted on another host.
Report a bug
8.4 .3.6. Virtual Machine Resource Allocation Settings Explained
T hese settings apply to adding or editing new virtual machines.
T he Virtual Machine: Resource Allocation settings table details the information required on
the Resource Allocation tab of the New or Edit windows.
14 3
Red Hat Enterprise Virtualization 3.2 Administration Guide
T able 8.8. Virtual Machine: Resource Allocation Settings
Field Name
Sub-element
Description
Mem ory Allocation
T he amount of physical memory
guaranteed for this virtual
machine.
Storage Allocation
T he T em plate
Provisioning option is only
available when the virtual
machine is created from a
template.
T hin
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.
Alias
T he name of the virtual disk.
Allocation policy
Storage allocation policy for
disks created when creating a
virtual machine from a template
as a Clone.
Preallocated results is 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.
T hin Provisioned
results is a faster clone
operation and provides
optimized usage of storage
capacity. Disk space is
allocated only as it is
required.
T arget
T he storage domain for the
virtual disk.
Quota
T he type of quota enforced on
the virtual disk.
Report a bug
8.4 .3.7. Virtual Machine Boot Options Settings Explained
T hese settings apply to adding or editing new virtual machines.
14 4
Chapter 8. Virtual Machines
T he Virtual Machine: Boot Options settings table details the information required on the Boot
Options tab of the New or Edit windows.
14 5
Red Hat Enterprise Virtualization 3.2 Administration Guide
T able 8.9. Virtual Machine: Boot Options Settings
Field Name
Description
First Device
After installing a new virtual machine, the new
virtual machine must go into Boot mode before
powering up. Select the first device that the virtual
machine must try to boot:
Hard Disk
CD-ROM
Network (PXE)
Second Device
Select the second device for the virtual machine
to use to boot if the first device is not available.
T he 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. T he images must be
available in the ISO domain.
Boot Options
Defines the virtual machine's boot sequence,
running options, and source images for installing
the operating system and required drivers.
Attach Floppy - Attaches a floppy disk
image to the virtual machine. Use this option
to install Windows drivers. T he floppy disk
image must reside in the ISO domain.
Attach CD - Attaches an ISO image to the
virtual machine. Use this option to install the
virtual machine's operating system and
applications. T he CD image must reside in the
ISO domain.
Boot Sequence - Determines the order in
which the boot devices are used to boot the
virtual machine. Select either Hard Disk,
CD-ROM or Network, and use the arrow keys
to move the option up or down.
Run Stateless - Deletes all changes to the
virtual machine upon shutdown.
Start in Pause Mode - Starts then
pauses the virtual machine to enable
connection to the console, suitable for virtual
machines in remote locations.
Linux Boot Options
T he following options boot a Linux kernel directly
instead of through the BIOS bootloader.
kernel path - A fully-qualified path to a
kernel image to boot the virtual machine. T he
kernel image must be stored on either the ISO
domain (path name in the format of
14 6
Chapter 8. Virtual Machines
iso://path-to-im age) or on the host's
local storage domain (path name in the format
of /data/im ages).
initrd path - A fully-qualified path to a
ramdisk image to be used with the previously
specified kernel. T he ramdisk image must be
stored on the ISO domain (path name in the
format of iso://path-to-im age) or on the
host's local storage domain (path name in the
format of /data/im ages).
kernel param s - Kernel command line
parameter strings to be used with the defined
kernel on boot.
Report a bug
8.4 .3.8. Virtual Machine Custom Properties Settings Explained
T hese settings apply to adding or editing new virtual machines.
T he Virtual Machine: Custom Properties settings table details the information required on the
Custom Properties tab of the New or Edit windows.
14 7
Red Hat Enterprise Virtualization 3.2 Administration Guide
T able 8.10. Virtual Machine: Custom Properties Settings
Field Name
Description
Recommendations and
Limitations
sap_agent
Enables SAP monitoring on the
virtual machine. Set to true or
false.
-
sndbuf
Enter the size of the buffer for
sending the virtual machine's
outgoing data over the socket.
Default value is 0.
-
vhost
Disables vhost-net, which is the
kernel-based virtio network
driver on virtual network
interface cards attached to the
virtual machine. T o disable
vhost, the format for this
property is:
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.
LogicalNetworkName:
false
T his will explicitly start the
virtual machine without the
vhost-net setting on the virtual
NIC attached to
LogicalNetworkName.
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 occurances of
communication failure between hosts and unresponsive virtual machines.
Report a bug
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 T emplate
14 8
Chapter 8. Virtual Machines
1. Click the Virtual Machines resource tab to list all the virtual machines in the results list.
2. Click the New Server button to open the New Server Virtual Machine window, or the New
Desktop button to open the New Desktop Virtual Machine window.
3. Select an existing template from the Based on T em plate drop-down menu.
4. Enter a Nam e and appropriate Description, and accept the default values inherited from the
template in the rest of the fields. You can change them if needed.
5. Click the Resource Allocation tab. T he template you selected is displayed on the
T em plate Provisioning field. Select Clone.
Figure 8.2. Provisioning - Clone
Select the disk provisioning mode in the Allocation field. T his selection impacts both the speed
of the clone operation and the amount of disk space it requires.
Selecting T hin Provision results in a faster clone operation and provides optimized usage
of storage capacity. Disk space is allocated only as it is required. T his is the default selection.
Selecting Preallocated results 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.
6. Select the T arget storage domain for the virtual machine.
7. Click OK.
14 9
Red Hat Enterprise Virtualization 3.2 Administration Guide
Note
Cloning a virtual machine may take some time. A new copy of the template's disk must be
created. During this time, the virtual machine's status is first Im age Locked, then Down.
Result
T he 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.
Report a bug
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
1. On the New Virtual Machine - Guide Me window, click the Configure Network
Interfaces button to open the New Network Interface window. You can accept the default
values or change them as necessary.
Figure 8.3. New Network Interface window
Enter the Nam e of the network interface.
2. Use the drop-down menus to select the Network and the T ype of network interface for the new
virtual machine. T he Link State is set to Up by default when the NIC is defined on the virtual
150
Chapter 8. Virtual Machines
machine and connected to the network.
Note
T he options on the Network and T ype fields are populated by the networks available to
the cluster, and the NICs available to the virtual machine.
3. If applicable, select the Specify custom MAC address check box and enter the network
interface's MAC address.
4. Click the arrow next to Advanced Param eters to configure the Port Mirroring and Card
Status fields, if necessary.
5. Click OK to close the New Network Interface window and open the New Virtual Machine
- Guide Me window.
6. Click the Configure Virtual Disk button to open the New Virtual Disk window.
7. Add either an Internal virtual disk or an External LUN to the virtual machine.
Figure 8.4 . New Virtual Disk Window
8. Click OK to close the New Virtual Disk window. T he New Virtual Machine - Guide Me
window opens with changed context. T here is no further mandatory configuration.
9. Click Configure Later to close the window.
151
Red Hat Enterprise Virtualization 3.2 Administration Guide
Result
You have added a network interface and a virtual disk to your virtual machine.
See Also:
Section 8.7.5, “Explanation of Settings in the Virtual Machine Network Interface Window”
Section 11.5, “Explanation of Settings in the New Virtual Machine Disk and Edit Virtual Machine Disk
Windows”
Report a bug
8.4.6. Installing a Guest Operating System onto a Virtual Machine
Prerequisites:
Section 8.4.2, “Creating a New Virtual Machine from a Blank T emplate”
Section 8.7.5, “Explanation of Settings in the Virtual Machine Network Interface Window”
Section 11.5, “Explanation of Settings in the New Virtual Machine Disk and Edit Virtual Machine Disk
Windows”
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
1. Select the created virtual machine. It has a status of Down.
2. Click the Run Once button to open the Run Virtual Machine window.
Figure 8.5. Run Virtual Machine Window
3. Click the Boot Options tab to define the boot sequence and source images for installing the
operating system.
4. Click the Linux Boot Options tab to define additional boot options specific to Linux virtual
machines.
5. Click the Initial Run tab to join the virtual machine to a domain on the initial run.
6. Click the Display Protocol tab and select a suitable protocol to connect to the virtual
machine. SPICE is the recommended protocol.
7. Click the Custom Properties tab to enter additional running options for virtual machines.
8. Click OK.
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.
152
Chapter 8. Virtual Machines
Report a bug
8.4.7. Installing Windows on VirtIO Optimized Hardware
Summary
T he virtio-win.vfd floppy image contains Windows drivers for VirtIO optimized disk and network
devices. T hese drivers provide a performance improvement over emulated device drivers.
T he virtio-win.vfd is placed automatically on ISO storage domains that are hosted on the Manager
server. It must be manually uploaded using the rhevm-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.
T his 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
1. Select your virtual machine from the list in the Virtual Machines tab.
2. Click the Run Once button, and the Run Once window displays.
3. Click Boot Options to expand the Boot Options configuration options.
4. Click the Attach Floppy checkbox, and select virtio-win.vfd from the drop down selection
box.
5. Click the Attach CD checkbox, and select from the drop down selection box the ISO containing
the version of Windows you want to install.
6. Move CD-ROM UP in the Boot Sequence field.
7. Configure the rest of your Run Once options as required, and click OK to start your virtual
machine, and then click the Console button to open a graphical console to your virtual machine.
Result
Windows installations include an option to load additional drivers early in the 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.
Report a bug
8.4.8. Virtual Machine Run Once Settings Explained
T he 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. T he following table details the
information required for the Run Once window.
153
Red Hat Enterprise Virtualization 3.2 Administration Guide
T able 8.11. 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.
Attach Floppy - Attaches a floppy disk
image to the virtual machine. Use this option
to install Windows drivers. T he floppy disk
image must reside in the ISO domain.
Attach CD - Attaches an ISO image to the
virtual machine. Use this option to install the
virtual machine's operating system and
applications. T he CD image must reside in the
ISO domain.
Boot Sequence - Determines the order in
which the boot devices are used to boot the
virtual machine. Select either Hard Disk,
CD-ROM or Network, and use the arrow keys
to move the option up or down.
Run Stateless - Deletes all changes to the
virtual machine upon shutdown.
Start in Pause Mode - Starts then
pauses the virtual machine to enable
connection to the console, suitable for virtual
machines in remote locations.
Linux Boot Options
T he following options boot a Linux kernel directly
instead of through the BIOS bootloader.
kernel path - A fully-qualified path to a
kernel image to boot the virtual machine. T he
kernel image must be stored on either the ISO
domain (path name in the format of
iso://path-to-im age) or on the host's
local storage domain (path name in the format
of /data/im ages).
initrd path - A fully-qualified path to a
ramdisk image to be used with the previously
specified kernel. T he ramdisk image must be
stored on the ISO domain (path name in the
format of iso://path-to-im age) or on the
host's local storage domain (path name in the
format of /data/im ages).
kernel param s - Kernel command line
parameter strings to be used with the defined
kernel on boot.
Initial Run
Defines the virtual machine's domain and user log
in credentials.
Dom ain - T he domain in which the virtual
154
Chapter 8. Virtual Machines
machine runs.
Alternate Credentials - By default you
will log in to the virtual machine with the same
credentials you use for the Administration
Portal. T o log in as a different user, enter a
suitable User Nam e and Password. T his
user must exist in the same domain as the
virtual machine.
Display Protocol
Defines the protocol to connect to virtual
machines.
VNC - Can be used for Linux virtual machines.
Requires a VNC client to connect to a virtual
machine using VNC.
SPICE - Recommended protocol for Linux and
Windows virtual machines, excepting Windows
8 and Server 2012 virtual machines.
Custom Properties
Additional VDSM options for running virtual
machines.
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.
vhost - Enter the name of the virtual host on
which this virtual machine should run. T he
name can contain any combination of letters
and numbers.
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.
Report a bug
8.5. Using Virtual Machines
8.5.1. SPICE
T he SPICE protocol facilitates graphical connections to virtual machines. T he SPICE protocol allows:
video at more than 30 frames per second
bi-directional audio (for soft-phones/IP phones)
bi-directional 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
155
Red Hat Enterprise Virtualization 3.2 Administration Guide
Report a bug
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
1. 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.
2. Click the
icon.
Alternatively, right-click and select Run.
Result
T he Status of the virtual machine changes to Up. T he 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.
Report a bug
8.5.3. Installing SPICE Plugins in Windows and Linux
T he 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
T his 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
T he plugin will be installed the next time Firefox is started.
Result
T he SPICE plugin is installed on your Red Hat Enterprise Linux client.
Summary
T his 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
1. T he 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.
156
Chapter 8. Virtual Machines
2. 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
T he 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. T his 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.
Report a bug
8.5.4. Logging in to a Virtual Machine
Prerequisites:
Section 8.5.3, “Installing SPICE Plugins in Windows and Linux”
Summary
T he 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
1. On the Virtual Machines resource tab, select a running virtual machine.
2. Click the Console button or right-click the virtual machine and select Console from the menu.
Figure 8.6. Connection Icon on the Virtual Machine Menu
3. A. 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.
B. If the virtual machine's display protocol is set to VNC, a window containing connection details
including the IP address, port number and password required opens. Use the details with your
VNC client to connect to the virtual machine.
Result
You have connected to a virtual machine from the Administration Portal using SPICE or a VNC client.
See Also:
Section 8.4.3.3, “Virtual Machine Console Settings Explained”
Report a bug
157
Red Hat Enterprise Virtualization 3.2 Administration Guide
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.
T he 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.
T he 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.
Report a bug
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
1. Use the Virtual Machines resource tab, tree mode, or the search function to find and select a
running virtual machine in the results list.
2. Click the Shut down (
) button.
Alternatively, right-click the virtual machine and select Shut down.
Result
T he Status of the virtual machine changes to Down.
Report a bug
8.6.3. Pausing a Virtual Machine
158
Chapter 8. Virtual Machines
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. T his is equal to setting it on
Hibernate mode.
Procedure 8.12. Pausing a virtual machine
1. Use the Virtual Machines resource tab, tree mode, or the search function to find and select a
running virtual machine in the results list.
2. Click the Suspend (
) button.
Alternatively, right-click the virtual machine and select Suspend
Result
T he Status of the virtual machine changes to Paused.
Report a bug
8.7. Managing Virtual Machines
8.7.1. Editing a Resource
Summary
Edit the properties of a resource.
Procedure 8.13. Editing a Resource
1. Use the resource tabs, tree mode, or the search function to find and select the resource in the
results list.
2. Click Edit to open the Edit window.
3. Change the necessary properties and click OK.
Result
T he new properties are saved to the resource. T he Edit window will not close if a property field is
invalid.
See Also:
Section 11.5, “Explanation of Settings in the New Virtual Machine Disk and Edit Virtual Machine Disk
Windows”
Report a bug
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
159
Red Hat Enterprise Virtualization 3.2 Administration Guide
1. Use the Virtual Machines resource tab, tree mode, or the search function to find and select a
virtual machine in the results list.
2. Shut down the virtual machine. T he Rem ove button is only enabled for a virtual machine that has
a status of Down.
3. Click Rem ove. On the Rem ove Virtual Machine(s) confirmation window, the Rem ove
Disk(s) checkbox is automatically selected, which will remove the attached virtual disks together
with the virtual machine. If the checkbox is de-selected, the virtual disks will remain in the
environment as floating disks.
4. Click OK to remove the virtual machine (and associated virtual disks) and close the window.
Result
T he virtual machine is removed from the environment and no longer displays on the Virtual
Machines resource tab.
Report a bug
8.7.3. Adding and Editing Virtual Machine Disks
Prerequisites:
Section 8.4.1, “Creating a New Virtual Machine from an Existing T emplate”
Summary
It is possible to add disks to virtual machines. You can add new disks, or previously created floating
disks to a virtual machine. T his 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
1. Use the Virtual Machines resource tab, tree mode, or the search function to find and select a
virtual machine in the results list.
2. Click the Disks tab in the details pane to display a list of virtual disks currently associated with
the virtual machine.
3. Click Add to open the Add Virtual Disk window.
160
Chapter 8. Virtual Machines
Figure 8.7. Add Virtual Disk Window
4. Use the appropriate radio buttons to switch between Internal and the External (Direct
Lun) disks.
5. 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.
6. Click OK 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.
See Also:
Section 11.5, “Explanation of Settings in the New Virtual Machine Disk and Edit Virtual Machine Disk
Windows”
Report a bug
161
Red Hat Enterprise Virtualization 3.2 Administration Guide
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 to change some
network interface details. T his 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
1. Use the Virtual Machines resource tab, tree mode, or the search function to find and select a
virtual machine in the results list.
2. Select the Network Interfaces tab in the details pane to display a list of network interfaces
that are currently associated with the virtual machine.
3. Click New to open the New Network Interface window.
Figure 8.8. New Network Interface window
4. Enter the Nam e of the network interface.
5. Use the drop-down menus to select the Network and the T ype of network interface for the new
network interface. T he Link State is set to Up by default when the NIC is defined on the virtual
machine and connected to the network.
Note
T he options on the Network and T ype fields are populated by the networks available to
the cluster, and the NICs available to the virtual machine.
6. If applicable, select the Specify custom MAC address check box and enter the network
interface's MAC address.
7. Click the arrow next to Advanced Param eters to configure the Port Mirroring and Card
Status fields, if necessary.
162
Chapter 8. Virtual Machines
8. Click OK 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.
Report a bug
8.7.5. Explanation of Settings in the Virtual Machine Network Interface Window
T hese 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.
163
Red Hat Enterprise Virtualization 3.2 Administration Guide
T able 8.12. Add a network interface to a virtual machine entries
Field Name
Description
Nam e
T he name of the network interface. T his 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.
Up: T he network interface is located on its
slot.
When the Card Status is Plugged, it
means the network interface is connected
to a network cable, and is active.
When the Card Status is Unplugged,
the network interface will be automatically
connected to the network and become
active.
Down: T he network interface is located on its
slot, but it is not connected to any network.
Virtual machines will not be able to run in this
state.
T ype
T he 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.
T he 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.
164
Chapter 8. Virtual Machines
Card Status
Whether or not the network interface is defined
on the virtual machine.
Plugged: T he network interface has been
defined on the virtual machine.
If its Link State is Up, it means the
network interface is connected to a
network cable, and is active.
If its Link State is Down, the network
interface is not connected to a network
cable.
Unplugged: T he network interface is only
defined on the Manager, and is not associated
with a virtual machine.
If its Link State is Up, when the network
interface is plugged it will automatically be
connected to a network and become
active.
If its Link State is Down, the network
interface is not connected to any network
until it is defined on a virtual machine.
Report a bug
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
1. Use the Virtual Machines resource tab, tree mode, or the search function to find and select a
running virtual machine in the results list.
2. Select the Disks tab from the details pane of the virtual machine.
3. Select the virtual machine disk you would like to hot plug.
4. Click the Activate or Deactivate button.
Result
You have enabled or disabled a virtual machine disk.
Report a bug
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.
165
Red Hat Enterprise Virtualization 3.2 Administration Guide
Procedure 8.18. Hot plugging network interfaces
1. Use the Virtual Machines resource tab, tree mode, or the search function to find and select a
running virtual machine in the results list.
2. Select the Network Interfaces tab from the details pane of the virtual machine.
3. Select the network interface you would like to hot plug and click Edit to open the Edit Network
Interface window.
4. Click the Advanced Param eters 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.
See Also:
Section 8.7.5, “Explanation of Settings in the Virtual Machine Network Interface Window”
Report a bug
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.
T his procedure is not the same as hot plugging. You can only remove virtual hardware that is
Deactivated.
Procedure 8.19. Removing disks and network interfaces from virtual machines
1. Select the virtual machine with virtual hardware you'd like to remove.
2. Select the relevant tab, either Network Interfaces or Disks, from the virtual machine details
pane.
3. Select the disk or network interface you'd like to remove. T o remove it, you must have first
Deactivated it.
4. Click the Rem ove button. Click OK in the confirmation window. If you are removing a disk, select the
Rem ove Perm anently 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
T he disk or network interface is no longer attached to the virtual machine.
Report a bug
8.8. Virtual Machines and Permissions
8.8.1. Managing System Permissions for a Virtual Machine
T he system administrator, as the SuperUser, manages all aspects of the Administration Portal. More
specific administrative roles can be assigned to other users. T hese restricted administrator roles are
166
Chapter 8. Virtual Machines
useful for empowering a user with certain administrative privileges that limit them to a specific resource:
a DataCenterAdm in role has administrator privileges only for the assigned data center, a
ClusterAdm in has administrator privileges only for the assigned cluster, and so forth.
A UserVm Manager is a system administration role for virtual machines in a data center. T his 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.
T he 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.
See Also:
Section 8.8.2, “Virtual Machines Administrator Roles Explained”
Report a bug
8.8.2. Virtual Machines Administrator Roles Explained
Virtual Machine Administrator Permission Roles
T he table below describes the administrator roles and privileges applicable to virtual machine
administration.
T able 8.13. 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. T o configure port
mirroring on a virtual machine
network, apply the
NetworkAdm in role on the
network and the
UserVm Manager role on the
virtual machine.
167
Red Hat Enterprise Virtualization 3.2 Administration Guide
See Also:
Section 12.4.2, “User and Administrator Roles”
Report a bug
8.8.3. Virtual Machine User Roles Explained
Virtual Machine User Permission Roles
T he table below describes the user roles and privileges applicable to virtual machine users. T hese roles
allow access to the User Portal for managing and accessing virtual machines, but they do not confer any
permissions for the Administration Portal.
168
Chapter 8. Virtual Machines
T able 8.14 . 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.
UserT emplateBasedVm
Limited privileges to only use
T emplates.
Level of privilege to create a
virtual machine by means of a
template.
VmCreator
Can create virtual machines in
the User Portal.
T his 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.
169
Red Hat Enterprise Virtualization 3.2 Administration Guide
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 Vm Creator role provides privileges previously conferred by the
PowerUserRole. T he 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
Vm Creator, DiskCreator, and T em plateCreator roles.
Report a bug
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
1. Use the resource tabs, tree mode, or the search function to find and select the resource in the
results list.
2. Click the Perm issions tab of the details pane to list the assigned users, the user's role, and the
inherited permissions for the selected resource.
3. Click Add to open the Add Perm ission to User window.
4. Enter the name or user name of an existing user into the Search text box and click Go. Select a
user from the resulting list of possible matches.
5. Select a role from the Role to Assign: drop-down menu.
6. Click OK 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.
See Also:
Section 12.4.2, “User and Administrator Roles”
Report a bug
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
1. Use the resource tabs, tree mode, or the search function to find and select the resource in the
results list.
170
Chapter 8. Virtual Machines
2. Click the Perm issions tab of the details pane to list the assigned users, the user's role, and the
inherited permissions for the selected resource.
3. Select the user to remove from the resource.
4. Click Rem ove. T he Rem ove Perm ission window opens to confirm permissions removal.
5. Click OK to remove the user role.
Result
You have removed the user's role, and the associated permissions, from the resource.
Report a bug
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.
T ake 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
1. Use the Virtual Machines resource tab, tree mode, or the search function to find and select a
virtual machine in the results list.
2. Select the Snapshots tab in the details pane.
3. Click Create in the left side-pane of the details pane to open the Create Snapshot window.
Figure 8.9. T he Virtual Machines Details Pane with Snapshots tab
4. Enter a description for the snapshot.
171
Red Hat Enterprise Virtualization 3.2 Administration Guide
5. Click OK to create the snapshot and close the window.
Figure 8.10. New Snapshot in the Details Pane
Result
T he virtual machine's operating system and applications are stored in a snapshot that can be previewed
or restored. T he 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.
Report a bug
8.9.2. Using a Snapshot to Restore a Virtual Machine
Prerequisites:
Section 8.9.1, “Creating a Snapshot of a Virtual Machine”
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
1. 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.
2. Click the Snapshots tab in the details pane to list the available snapshots.
3. Select a snapshot to restore in the left side-pane. T he snapshot details display in the right sidepane.
4. Click Preview to preview the snapshot. T he status of the virtual machine briefly changes to
Im age Locked before returning to Down.
172
Chapter 8. Virtual Machines
Figure 8.11. Preview snapshot
5. Start the virtual machine and it will run with the disk image of the snapshot.
6. Click Com m it 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
T he virtual machine is restored to its state at the time of the snapshot, or returned to its state before the
preview of the snapshot.
Report a bug
8.9.3. Creating a Virtual Machine from a Snapshot
Prerequisites:
Section 8.9.1, “Creating a Snapshot of a Virtual Machine”
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
1. Use the Virtual Machines resource tab, tree mode, or the search function to find and select
the virtual machine in the results list.
2. Click the Snapshots tab in the details pane to list the available snapshots for the virtual
machines.
3. Select a snapshot in the list displayed and click Clone to open the Clone VM from Snapshot
window.
4. Enter the Nam e and Description of the virtual machine to be created.
173
Red Hat Enterprise Virtualization 3.2 Administration Guide
Figure 8.12. Clone a Virtual Machine from a Snapshot
5. Click OK 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 Im age Locked. T he 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 Im age Locked to Down in the
Virtual Machines tab in the navigation pane.
Report a bug
8.9.4. Deleting a Snapshot
Summary
174
Chapter 8. Virtual Machines
Delete a snapshot and permanently remove it from the virtualized environment.
Procedure 8.25. Deleting a Snapshot
1. Use the Virtual Machines resource tab, tree mode, or the search function to find and select a
virtual machine in the results list.
2. Click the Snapshots tab in the details pane to list available snapshots for the virtual machine.
Figure 8.13. Snapshot List
3. Select the snapshot to delete.
4. In the Navagation pane, shut down the running virtual machine associated with the snapshot to be
deleted.
5. Click Delete to open the Delete Snapshot confirmation window.
6. Click OK 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.
Report a bug
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. T he Red Hat Enterprise Virtualization Manager
allows you to import and export virtual machines (and templates) stored in Open Virtual Machine Format
(OVF). T his 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.
T here 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
175
Red Hat Enterprise Virtualization 3.2 Administration Guide
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 Virtualizaiton environment that is managed by another
installation of the Red Hat Enterprise Virtualization Manager.
T hird, you import your virtual machines and template into the data center you attached the expord
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.
Report a bug
8.10.2. Overview of the Export-Import Process
T he 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.
T he 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. T his 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.
Report a bug
8.10.3. Performing an Export-Import of Virtual Resources
Summary
T his procedure provides a graphical overview of the steps required to import a virtual resource to its
destination.
176
Chapter 8. Virtual Machines
Procedure 8.26. Performing an export-import of virtual resources
1. Attach the export domain to the source data center.
Figure 8.14 . Attach Export Domain
2. Export the virtual resource to the export domain.
Figure 8.15. Export the Virtual Resource
3. Detach the export domain from the source data center.
177
Red Hat Enterprise Virtualization 3.2 Administration Guide
Figure 8.16. Detach Export Domain
4. Attach the export domain to the destination Data center.
Figure 8.17. Attach the Export Domain
5. Import the virtual resource into the destination data center.
178
Chapter 8. Virtual Machines
Figure 8.18. Import the virtual resource
Result
Your virtual resource is exported to the destination data center.
See Also:
Section 3.6.3, “Attaching an Existing Export Domain to a Data Center”
Section 3.6.4, “Detaching a Storage Domain from a Data Center”
Section 8.10.4, “Exporting a Virtual Machine to the Export Domain”
Section 8.10.5, “Importing a Virtual Machine into the Destination Data Center”
Report a bug
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
1. 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.
2. Click Export to open the Export Virtual Machine window.
3. 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. T his removes any dependencies a virtual machine has on a template.
4. Click OK to export the virtual machine and close the window.
179
Red Hat Enterprise Virtualization 3.2 Administration Guide
Result
T he export of the virtual machine begins. T he virtual machine displays in the Virtual Machines list with an
Im age 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
Im port tab of the export domain's details pane.
Report a bug
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
1. Use the Storage resource tab, tree mode, or the search function to find and select the export
domain in the results list. T he export domain must have a status of Active
2. Select the VM Im port tab in the details pane to list the available virtual machines to import.
3. Select one or more virtual machines to import and click Im port to open the Im port Virtual
Machine(s) window.
Figure 8.19. Import Virtual Machine
4. Use the drop-down menus to select the Default Storage Dom ain, Cluster, and Cluster
180
Chapter 8. Virtual Machines
Quota in the data center.
5. Select the Collapse All Snapshots check box to remove snapshot restore points and
include templates in template-based virtual machines.
6. Click OK to import the virtual machines.
T he Im port Conflict window opens if the virtual machine exists in the virtualized
environment.
Figure 8.20. Import Conflict Window
7. Choose one of the following radio buttons:
Don't im port
Clone and enter a unique name for the virutal machine in the New Nam e: field.
Or select the Apply to all check box to import all duplicated virtual machines with the same
suffix.
8. Click OK to import the virtual machines and close the window.
Result
You have imported the virtual machine to the destination data center. T his may take some time to
complete.
Report a bug
8.11. Migrating Virtual Machines Between Hosts
8.11.1. What is Live Migration?
Live migration provides the ability to move a running virtual machine between physical hosts with no
181
Red Hat Enterprise Virtualization 3.2 Administration Guide
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.
Report a bug
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:
T he source and destination host must both be members of the same cluster, ensuring CPU
compatibility between them.
T he source and destination host must have a status of Up.
T he source and destination host must have access to the same virtual networks and VLANs.
T he source and destination host must have access to the data storage domain on which the virtual
machine resides.
T here must be enough CPU capacity on the destination host to support the virtual machine's
requirements.
T here must be enough RAM on the destination host that is not in use to support the virtual
machine's requirements.
T he migrating vitual machine must not have the cache!=none custom property set.
In addition, for best performance, the storage and management networks should be split to avoid
network saturation. Virtual machine migration involves transferring large amounts of data between hosts.
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.
Report a bug
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. T he destination host for each virtual
machine is assessed as the virtual machine is migrated, in order to spread the load across the cluster.
T he 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.
Report a bug
8.11.4. Preventing Automatic Migration of a Virtual Machine
Summary
182
Chapter 8. Virtual Machines
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.
T he 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
1. 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.
2. Click Edit to open the Edit Desktop Virtual Machine or Edit Server Virtual
Machine window.
Figure 8.21. Edit Desktop Virtual Machine Window
3. Click the Host tab.
4. 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.
183
Red Hat Enterprise Virtualization 3.2 Administration Guide
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.
5. Use the drop-down menu to affect the Migration Options. Select Do not allow
m igration to enable the Use Host CPU check box.
6. If applicable, enter relevant CPU Pinning topology commands in the text field.
7. Click OK to save the changes and close the window.
Result
You have changed the migration settings for the virtual machine.
See Also:
Section 4.2.2.3, “Resilience Policy Settings Explained”
Report a bug
8.11.5. Manually Migrating Virtual Machines
Summary
A running virtual machine can be migrated to any host within its designated host cluster. T his 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.
T he migrating vitual machine must not have the cache!=none custom property set.
Procedure 8.30. Manually migrating virtual machines
1. 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 Migrate to open the Migrate Virtual Machine(s) window.
2. Use the radio buttons to select whether to Select Host Autom atically 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
Autom atically 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.
3. Click OK to commence migration and close the window.
Result
184
Chapter 8. Virtual Machines
T he virtual machine is migrated. Once migration is complete the Host column will update to display the
host the virtual machine has been migrated to.
Report a bug
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. T he 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
You can only set the migration priority for virtual servers. You can not set migration priority for
virtual desktops.
Procedure 8.31. Setting Migration Priority
1. Use the Virtual Machines resource tab, tree mode, or the search function to find and select a
virtual server in the results list.
2. Click Edit to open the Edit Server Virtual Machine window.
3. Select the High Availability tab.
4. Use the radio buttons to set the Priority for Run/Migrate Queue of the virtual machine to
one of Low, Medium , or High.
5. Click OK to save changes and close the window.
Result
T he virtual machine's migration priority has been modified.
Report a bug
8.11.7. Cancelling 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. Cancelling ongoing virtual machine migrations
1. Select the migrating virtual machine. It is displayed in the Virtual Machines resource tab with
a status of Migrating from .
185
Red Hat Enterprise Virtualization 3.2 Administration Guide
2. Click the Cancel Migration button at the top of the results list. Alternatively, right-click on the
virtual machine and select Cancel Migration from the context menu.
Result
T he virtual machine status returns from Migrating from status to Up status.
Report a bug
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 Events tab and in the engine log to aid in troubleshooting,
as illustrated in the following examples:
Example 8.1. Notification in the Events T ab 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
T his log can be found on the Red Hat Enterprise Virtualization Manager at /var/log/ovirtengine/engine.log:
Failed to start Highly Available VM. Attempting to restart. VM Name: Virtual_Machine_Name, VM
Id:Virtual_Machine_ID_Number
Report a bug
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.
Report a bug
8.12.2. What is High Availability?
High availability means that a virtual machine will be automatically restarted if its process is interrupted.
T his 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
186
Chapter 8. Virtual Machines
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. T his ensures that there is sufficient capacity to restart virtual
machines at all times.
Report a bug
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. T o enable the migration of highly available virtual
machines:
Power management must be configured for the hosts running the highly available virtual machines.
T he host running the highly available virtual machine must be part of a cluster which has other
available hosts.
T he destination host must be running.
T he source and destination host must have access to the data domain on which the virtual machine
resides.
T he source and destination host must have access to the same virtual networks and VLANs.
T here must be enough CPUs on the destination host that are not in use to support the virtual
machine's requirements.
T here must be enough RAM on the destination host that is not in use to support the virtual
machine's requirements.
Report a bug
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
1. Use the Virtual Machines resource tab, tree mode, or the search function to find and select a
virtual server in the results list.
2. Click Edit to open the Edit Server Virtual Machine window.
3. Click the High Availability tab.
187
Red Hat Enterprise Virtualization 3.2 Administration Guide
Figure 8.22. Set virtual machine high availability
4. Select the Highly Available check box to enable high availability for the virtual server.
5. 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.
6. Click OK 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:
Section 8.4.3.5, “Virtual Machine High Availability Settings Explained”
Section 4.2.2.3, “Resilience Policy Settings Explained”
Report a bug
188
Chapter 8. Virtual Machines
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
1. Use the Virtual Machines resource tab, tree mode, or the search function to find and select a
virtual machine with a status of Down in the results list.
2. Click Edit button to open the Edit Virtual Machine window.
3. Select the Custom Properties tab.
Figure 8.23. Enable SAP
4. Use the drop-down menu to select sap_agent. Ensure the secondary drop-down menu is set to
T rue.
If previous properties have been set, select the plus sign to add a new property rule and select
sap_agent.
5. Click OK to save changes and close the window.
189
Red Hat Enterprise Virtualization 3.2 Administration Guide
Result
You have enabled SAP monitoring for your virtual machine.
Report a bug
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. T o use SPICE, the X-Windows system requires additional qxl drivers. T he
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
T ypically, 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.
Report a bug
8.13.2.2. Installing qxl drivers on virtual machines
Summary
T his 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
1. Log in to a Red Hat Enterprise Linux virtual machine.
2. Open a terminal.
3. Run the following command as root:
# yum install xorg-x11-drv-qxl
Result
T he qxl drivers have been installed and must now be configured.
Report a bug
8.13.2.3. Configuring qxl drivers on virtual machines
Summary
190
Chapter 8. Virtual Machines
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
1. Click System .
2. Click Adm inistration.
3. Click Display.
4. Click the Hardware tab.
5. Click Video Cards Configure.
6. Select qxl and click OK.
7. Restart X-Windows by logging out of the virtual machine and logging back in.
Procedure 8.37. Configuring qxl drivers on the command line:
1. Back up /etc/X11/xorg.conf:
# cp /etc/X11/xorg.conf /etc/X11/xorg.conf.$$.backup
2. Make the following change to the Device section of /etc/X11/xorg.conf:
Section &quot;Device&quot;
Identifier &quot;Videocard0&quot;
Driver &quot;qxl&quot;
Endsection
Result
You have configured qxl drivers to enable your virtual machine to use SPICE.
Report a bug
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
1. Verify that the tablet device is available on your guest:
# /sbin/lsusb -v | grep 'QEMU USB Tablet'
If there is no output from the command, do not continue configuring the tablet.
2. Back up /etc/X11/xorg.conf by running this command:
# cp /etc/X11/xorg.conf /etc/X11/xorg.conf.$$.backup
3. Make the following changes to /etc/X11/xorg.conf:
191
Red Hat Enterprise Virtualization 3.2 Administration Guide
Section &quot;ServerLayout&quot;
Identifier
&quot;single head configuration&quot;
Screen
0 &quot;Screen0&quot; 0 0
InputDevice
&quot;Keyboard0&quot; &quot;CoreKeyboard&quot;
InputDevice
&quot;Tablet&quot; &quot;SendCoreEvents&quot;
InputDevice
&quot;Mouse&quot; &quot;CorePointer&quot;
EndSection
Section &quot;InputDevice&quot;
Identifier &quot;Mouse&quot;
Driver
&quot;void&quot;
#Option
&quot;Device&quot; &quot;/dev/input/mice&quot;
#Option
&quot;Emulate3Buttons&quot; &quot;yes&quot;
EndSection
Section &quot;InputDevice&quot;
Identifier &quot;Tablet&quot;
Driver
&quot;evdev&quot;
Option
&quot;Device&quot; &quot;/dev/input/event2&quot;
Option &quot;CorePointer&quot; &quot;true&quot;
EndSection
4. Log out and log back into the virtual machine to restart X-Windows.
Result
You have enabled tablet devices on your virtual machine to use SPICE.
Report a bug
8.13.3. KVM virtual machine timing management
Virtualization poses various challenges for virtual machine time keeping. Virtual machines which use the
T ime Stamp Counter (T SC) as a clock source may suffer timing issues as some CPUs do not have a
constant T ime 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 para-virtualized clock. T he 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.
T hese problems exist on other virtualization platforms and timing should always be tested.
192
Chapter 8. Virtual Machines
Important
T he Network T ime Protocol (NT P) 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.
T he NT P servers you are trying to use must be operational and accessible to your hosts and
virtual machines.
Determining if your CPU has the constant T ime Stamp Counter
Your CPU has a constant T ime Stamp Counter if the constant_tsc flag is present. T o 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 T ime 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
T hese 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. T he T SC is not stable on the host, which is sometimes
caused by cpufreq changes, deep C state, or migration to a host with a faster T SC. Deep C sleep
states can stop the T SC. T o prevent the kernel using deep C states append
&quot;processor.m ax_cstate=1&quot; 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.
193
Red Hat Enterprise Virtualization 3.2 Administration Guide
Using the rhevm -config tool to recive alerts when hosts drift out of sync.
You can use the rhevm -config tool to configure alerts when your hosts drift out of sync.
T here are 2 relevant parameters for time drift on hosts: EnableHostT im eDrift and
HostT im eDriftInSec. EnableHostT im eDrift, with a default value of false, can be enabled to
recieve alert notifications of host time drift. T he HostT im eDriftInSec parameter is used to set the
maximum allowable drift before alerts start being sent.
Alerts are sent once per hour per host.
Using the para-virtualized clock with Red Hat Enterprise Linux virtual machines
For certain Red Hat Enterprise Linux virtual machines, additional kernel parameters are required. T hese
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
T he process of configuring kernel parameters can be automated using the ktune package
T he 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. T his 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.
T he table below lists versions of Red Hat Enterprise Linux and the parameters required for virtual
machines on systems without a constant T ime Stamp Counter.
Red Hat Enterprise Linux
Additional virtual machine kernel
parameters
5.4 AMD64/Intel 64 with the para-virtualized clock
Additional parameters are not required
5.4 AMD64/Intel 64 without the para-virtualized
clock
notsc lpj=n
5.4 x86 with the para-virtualized clock
Additional parameters are not required
5.4 x86 without the para-virtualized 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
194
Chapter 8. Virtual Machines
Using the Real-T ime Clock with Windows virtual machines
Windows uses the both the Real-T ime Clock (RT C) and the T ime Stamp Counter (T SC). For Windows
virtual machines the Real-T ime Clock can be used instead of the T SC for all time sources which
resolves virtual machine timing issues.
T o enable the Real-T ime Clock for the PMT IMER clocksource (the PMT IMER usually uses the T SC) 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:
Section 15.2.1, “Configuration T ool”
Report a bug
195
Red Hat Enterprise Virtualization 3.2 Administration Guide
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. T emplates 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. T he 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.
Report a bug
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 the blueprint for additional virtual machines.
Procedure 9.1. Creating a T emplate from an Existing Virtual Machine
1. Use the Virtual Machines resource tab, tree mode, or the search function to find and select
the virtual machine in the results list.
2. Ensure that the virtual machine is powered down and has a status of Down.
3. Click Make T em plate to open the New T em plate window.
196
Chapter 9. Templates
Figure 9.1. New T emplate Window
4. Enter the Nam e and Description of the template.
5. Select the Host Cluster and storage T arget from the drop-down menus; by default, these are
set the same as the source virtual machine.
6. T he Allow all users to access this T em plate check box is selected by default, which
makes it public.
7. Click OK to create the template. T he virtual machine displays a status of Im age Locked while the
template is being created; this may take up to an hour, depending on the virtual machine disk
image size and your storage hardware.
Result
T he template is created and added to the T em plates tab. You can now create new virtual machines
from 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:
197
Red Hat Enterprise Virtualization 3.2 Administration Guide
Section 8.9.1, “Creating a Snapshot of a Virtual Machine”
Section 9.2.2, “Explanation of Settings and Controls in the New T emplate Window”
Report a bug
9.2.2. Explanation of Settings and Controls in the New Template Window
T he table below describes the settings for the New T em plate window.
T able 9.1. New and Edit T emplate Properties
Field
Description/Action
Nam e
T he name of the template. T his 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
T he description of the template. T his field is
recommended but not mandatory.
Host Cluster
T he cluster with which the template will be
associated. T his is the same as the original
virtual machines by default; you can select from
any cluster in the data center.
T arget
T he storage domain with which the template will
be associated. T his is the same as the original
virtual machines by default; you can select from
any storage domain in the data center.
Allow all users to access the
T em plate
A public template can be accessed by all users.
A private template can only be accessed by
T em plateAdm in and the SuperUser.
Report a bug
9.2.3. Editing a Resource
Summary
Edit the properties of a resource.
Procedure 9.2. Editing a Resource
1. Use the resource tabs, tree mode, or the search function to find and select the resource in the
results list.
2. Click Edit to open the Edit window.
3. Change the necessary properties and click OK.
Result
T he new properties are saved to the resource. T he Edit window will not close if a property field is
invalid.
Report a bug
198
Chapter 9. Templates
9.2.4. Explanation of Settings and Controls in the Edit Template Window
T he table below describes the settings for the Edit T em plate window.
T able 9.2. Edit T emplate Window
Field Name
Description
Data Center
T he data center to which the virtual machine is
attached.
Host Cluster
T he 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.
Nam e
T he name of virtual machine. Names must not
contain any spaces, and must contain at least
one character from A-Z . T he maximum length of a
virtual machine name is 15 characters.
Description
A meaningful description of the new virtual
machine.
Mem ory Size
T he 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.
T otal Virtual CPUs
T he 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
T he number of cores assigned to each virtual
socket.
Virtual Sockets
T he number of CPU sockets for the virtual
machine. Do not assign more sockets to a virtual
machine than are present on the physical host.
Operating System
T he operating system. Valid values include a
range of Red Hat Enterprise Linux and Windows
variants.
Stateless (Desktop only)
Select this check box if the virtual machine is to
run in stateless mode. T he 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. T his type of virtual
machine is useful when creating virtual machines
that need to be used for a short time, or by
temporary staff.
199
Red Hat Enterprise Virtualization 3.2 Administration Guide
Report a bug
9.2.5. 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 T emplate
1. Use the resource tabs, tree mode, or the search function to find and select the template in the
results list.
2. Click Rem ove to open the Rem ove T em plate(s) window.
3. Click OK to remove the template.
Result
You have removed the template.
See Also:
Section 11.5, “Explanation of Settings in the New Virtual Machine Disk and Edit Virtual Machine Disk
Windows”
Report a bug
9.2.6. Exporting Templates
9.2.6.1. Migrating T emplates 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 T emplates to the Export Domain
1. Use the T em plates resource tab, tree mode, or the search function to find and select the
template in the results list.
2. Click Export to open the Export T em plate window.
Note
Select the Force Override check box to replace any earlier version of the template on
the export domain.
3. Click OK to begin exporting the template; this may take up to an hour, depending on the virtual
200
Chapter 9. Templates
machine disk image size and your storage hardware.
4. 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 T em plate Im port tab in the details pane to view all
exported templates in the export domain.
Result
T he templates have been exported to the export domain.
See Also:
Section 7.7.8, “Detaching the Export Domain”
Report a bug
9.2.7. Importing Templates
9.2.7.1. Importing a T emplate into a Data Center
Prerequisites:
Section 9.2.7, “Importing T emplates”
Section 7.7.9, “Attaching an Export Domain to a Data Center”
Summary
Import templates from a newly attached export domain.
Procedure 9.5. Importing a T emplate into a Data Center
1. Use the resource tabs, tree mode, or the search function to find and select the newly attached
export domain in the results list.
2. Select the T em plate Im port tab of the details pane to display the templates that migrated
across with the export domain.
3. Select a template and click Im port to open the Im port T em plate(s) window.
201
Red Hat Enterprise Virtualization 3.2 Administration Guide
Figure 9.2. Import T emplates
4. Select the templates to import.
5. Use the drop-down menus to select the Destination Cluster and Storage domain. Alter the
Suffix if applicable.
Alternatively, clear the Clone All T em plates check box.
6. Click OK to import templates and open a notification window. Click Close to close the notification
window.
Result
T he template is imported into the destination data center. T his 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 T em plates resource tab.
T he templates can create new virtual machines, or run existing imported virtual machines based on that
template.
Report a bug
9.3. Sealing Templates in Preparation for Deployment
9.3.1. Sealing a Linux Virtual Machine for Deployment as a Template
Summary
Generalize (seal) a Linux virtual machine before making it into a template. T his prevents conflicts
between virtual machines deployed from the template.
Procedure 9.6. Sealing a Linux Virtual Machine
202
Chapter 9. Templates
1. Log in to the virtual machine. Flag the system for re-configuration by running the following
command as root:
# touch /.unconfigured
2. Remove ssh host keys. Run:
# rm -rf /etc/ssh/ssh_host_*
3. Set HOST NAME=localhost.localdom ain in /etc/sysconfig/network
4. Remove /etc/udev/rules.d/70-*. Run:
# rm -rf /etc/udev/rules.d/70-*
5. Remove the HWADDR= line from /etc/sysconfig/network-scripts/ifcfg-eth* .
6. Optionally delete all the logs from /var/log and build logs from /root.
7. Shut down the virtual machine. Run:
# poweroff
Result
T he 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.
Report a bug
9.3.2. Sealing a Windows Template
9.3.2.1. Considerations when Sealing a Windows T emplate with Sysprep
A template created for Windows virtual machines must be generalized (sealed) before being used to
deploy virtual machines. T his ensures that machine-specific settings are not reproduced in the template.
T he 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:
T he Windows Sysprep parameters have been correctly defined.
If not, click Edit and enter the required information in the Operating System and Dom ain fields.
T he correct product key has been entered in the rhevm -config configuration tool.
If not, run the configuration tool on the Manager as the root user, and enter the required information.
T he configuration keys that you need to set are ProductKey and SysPrepPath. For example, the
Windows 7 configuration value is ProductKeyWindow7 and SysPrepWindows7Path. Set these
values with this command:
203
Red Hat Enterprise Virtualization 3.2 Administration Guide
# rhevm-config --set ProductKeyWindow7=&lt;validproductkey&gt; --cver=general
See Also:
Section 15.2.2, “Syntax for rhevm-config Command”
Report a bug
9.3.2.2. Sealing a Windows XP T emplate
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. T he Windows 2003
Sysprep tool is available at http://www.microsoft.com/download/en/details.aspx?id=14830.
Procedure 9.7. Sealing a Windows XP T emplate
1. Download sysprep to the virtual machine to be used as a template.
T he Windows XP Sysprep tool is available at http://www.microsoft.com/download/en/details.aspx?
id=11282
2. Create a new directory: c:\sysprep.
3. Open the deploy.cab file and add its contents to c:\sysprep.
4. Execute sysprep.exe from within the folder and click OK on the welcome message to display the
Sysprep tool.
5. Select the following check boxes:
Don't reset grace period for activation
Use Mini-Setup
6. Ensure that the shutdown mode is set to Shut down and click Reseal.
7. Acknowledge the pop-up window to complete the sealing process; the virtual machine shuts down
automatically upon completion.
Result
T he Windows XP template is sealed and ready for deploying virtual machines.
Report a bug
9.3.2.3. Sealing a Windows 7 or Windows 2008 T emplate
Summary
Seal a Windows 7 or Windows 2008 template before using the template to deploy virtual machines.
Procedure 9.8. Sealing a Windows 7 or Windows 2008 T emplate
1. In the virtual machine to be used as a template, open a command line terminal and type regedit.
204
Chapter 9. Templates
2. T he Registry Editor window opens. On the left pane, expand HKEY_LOCAL_MACHINE →
SYST EM → SET UP.
3. On the main window, right-click to add a new string value using New → String Value.
4. Right-click on the file and select Modify to open the Edit String window.
5. Enter the following information in the provided fields:
Value name: UnattendFile
Value data: a:\sysprep.inf
6. Launch Sysprep from C:\Windows\System 32\sysprep\sysprep.exe.
7. 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 OK to complete the sealing process; the virtual machine shuts down automatically upon
completion.
Result
T he Windows 7 or Windows 2008 template is sealed and ready for deploying virtual machines.
Report a bug
9.4. Templates and Permissions
9.4.1. Managing System Permissions for a Template
T he system administrator, as the SuperUser, manages all aspects of the Administration Portal. More
specific administrative roles can be assigned to other users. T hese restricted administrator roles are
useful for empowering a user with certain administrative privileges that limit them to a specific resource:
a DataCenterAdm in role has administrator privileges only for the assigned data center, a
ClusterAdm in 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. T his 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.
T he 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.
See Also:
Section 9.4.2, “T emplate Administrator Roles Explained”
205
Red Hat Enterprise Virtualization 3.2 Administration Guide
Report a bug
9.4.2. Template Administrator Roles Explained
T emplate Administrator Permission Roles
T he table below describes the administrator roles and privileges applicable to template administration.
T able 9.3. Red Hat Enterprise Virtualization System Administrator Roles
Role
Privileges
Notes
T emplateAdmin
Can perform all operations on
templates.
Has privileges to create, delete
and configure templates'
storage domains and network
details, and to move templates
between domains.
NetworkAdmin
Network Administrator
Can configure and manage
networks attached to templates.
See Also:
Section 12.4.2, “User and Administrator Roles”
Report a bug
9.4.3. Template User Roles Explained
T emplate User Permission Roles
T he table below describes the user roles and privileges applicable to using and administrating
templates in the User Portal.
206
Chapter 9. Templates
T able 9.4 . Red Hat Enterprise Virtualization T emplate User Roles
Role
Privileges
Notes
T emplateCreator
Can create, edit, manage and
remove virtual machine
templates within assigned
resources.
T he T em plateCreator 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.
T emplateOwner
Can edit and delete the
template, assign and manage
user permissions for the
template.
T he T em plateOwner role is
automatically assigned to the
user who creates a template.
Other users who do not have
T em plateOwner permissions
on a template cannot view or
use the template.
UserT emplateBasedVm
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.
See Also:
Section 12.4.2, “User and Administrator Roles”
Report a bug
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.9. Assigning a Role to a Resource
1. Use the resource tabs, tree mode, or the search function to find and select the resource in the
results list.
2. Click the Perm issions tab of the details pane to list the assigned users, the user's role, and the
inherited permissions for the selected resource.
3. Click Add to open the Add Perm ission to User window.
4. Enter the name or user name of an existing user into the Search text box and click Go. Select a
user from the resulting list of possible matches.
207
Red Hat Enterprise Virtualization 3.2 Administration Guide
5. Select a role from the Role to Assign: drop-down menu.
6. Click OK 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.
See Also:
Section 12.4.2, “User and Administrator Roles”
Report a bug
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.10. Removing a Role from a Resource
1. Use the resource tabs, tree mode, or the search function to find and select the resource in the
results list.
2. Click the Perm issions tab of the details pane to list the assigned users, the user's role, and the
inherited permissions for the selected resource.
3. Select the user to remove from the resource.
4. Click Rem ove. T he Rem ove Perm ission window opens to confirm permissions removal.
5. Click OK to remove the user role.
Result
You have removed the user's role, and the associated permissions, from the resource.
Report a bug
208
Chapter 10. Pools
Chapter 10. Pools
10.1. Introduction to Virtual Machine Pools
Virtual machines can be placed in pools for use on demand by any user in a particular group. A single
virtual machine cannot be used concurrently by multiple users. Different virtual machine pools can be set
up for different purposes.
Users do not always get the same desktop, but get an available virtual machine of the required type,
from the appropriate virtual machine pool.
Virtual machines in pools are stateless, data is not persistent across reboots. Virtual machines in a pool
are started when there is a user request, and shut down when the user is finished.
Virtual machine pools can contain prestarted virtual machines waiting for user requests. T his provides a
faster response time, but uses system resources on idle virtual machines.
Note
Virtual machines are not stateless when accessed from the Administration Portal. T his is
because administrators need to be able to write changes to the disk if necessary.
Report a bug
10.2. Virtual Machine Pool Tasks
10.2.1. Creating a Virtual Machine Pool
Summary
You can create a virtual pool that contains multiple virtual machines. Virtual machine pools provide virtual
machines to end users in an on-demand basis.
Procedure 10.1. Creating a Virtual Machine Pool
1. In flat mode, click the Pools resource tab to display a list of virtual machine pools.
2. Click the New button to open the New Pool window.
3. Use the drop-down menus to select the Data Center and Host Cluster.
4. Enter the Nam e, Description, and Num ber of VMs for the pool.
5. If applicable, use the drop-down menu to select a template.
6. Enter the Mem ory Size to be used for each virtual machine in the pool and the T otal
Virtual CPUs.
7. If applicable, click the Advanced Param eters expansion button and use the drop-down menus
to select the Cores per Virtual Socket and Virtual Sockets.
8. Use the drop-down menu to select the Operating System to be used for the virtual machines
in the pool.
9. In the Pool tab, select one of the following pool types:
Manual - T he administrator is responsible for explicitly returning the virtual machine to the
209
Red Hat Enterprise Virtualization 3.2 Administration Guide
pool. T he virtual machine reverts to the original base image after the administrator returns it to
the pool.
Autom atic - When the virtual machine is shut down, it automatically reverts to its base image
and is returned to the virtual machine pool.
10. T he Initial Run, Console, Host, Resource Allocation, Boot Options, and Custom
Properties tabs are not mandatory but define options for your pool. T hese tabs feature
identical settings and controls as the New Virtual Machines window.
11. Click OK 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.
Figure 10.1. Virtual Machines Displaying in the Details Pane of a Virtual Machine Pool
See Also:
Section 8.4.2, “Creating a New Virtual Machine from a Blank T emplate”
Section 8.4.3.3, “Virtual Machine Console Settings Explained”
Section 8.4.3, “Explanation of Settings and Controls in the New Virtual Machine and Edit Virtual
Machine Windows”
Report a bug
10.2.2. Editing a Resource
Summary
Edit the properties of a resource.
Procedure 10.2. Editing a Resource
1. Use the resource tabs, tree mode, or the search function to find and select the resource in the
results list.
2. Click Edit to open the Edit window.
3. Change the necessary properties and click OK.
Result
T he new properties are saved to the resource. T he Edit window will not close if a property field is
invalid.
210
Chapter 10. Pools
See Also:
Section 8.4.3, “Explanation of Settings and Controls in the New Virtual Machine and Edit Virtual
Machine Windows”
Report a bug
10.2.3. Prestarting Virtual Machines in a Pool
Prerequisites:
Section 10.2.1, “Creating a Virtual Machine Pool”
In a virtual machine pool, the machines are in a powered down state 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. T he 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
1. Use the Pools resource tab, tree mode, or the search function to find and select the virtual
machine pool in the results list.
2. Click Edit to open the Edit Pool window.
3. Enter the number of virtual machines to be prestarted in the Prestarted VMs field.
4. Select the Pool tab. Ensure that the Pool T ype is set to Autom atic.
5. Click OK.
Result
You have set a number of prestarted virtual machines in a pool. T he prestarted machines are running
and available for use.
Report a bug
10.2.4. Adding Virtual Machines to a Virtual Machine Pool
Summary
If you require more virtual machines than was originally provisioned in a virtual machine pool, add more
machines to the pool.
Procedure 10.4 . Adding Virtual Machines to a Virtual Machine Pool
1. Use the Pools resource tab, tree mode, or the search function to find and select the virtual
machine pool in the results list.
2. Click Edit to open the Edit Pool window.
3. Enter the number of additional virtual machines to add in the Increase num ber of VMs in
211
Red Hat Enterprise Virtualization 3.2 Administration Guide
pool by field.
4. Click OK.
T he total number of virtual machines in the pool has increased.
Result
You have added more virtual machines to the virtual machine pool.
Report a bug
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
1. Use the Pools resource tab, tree mode, or the search function to find and select the virtual
machine pool in the results list.
2. Ensure the virtual machine has a status of Down as you cannot detach a running virtual machine.
Click the Virtual Machines tab in the details pane to list the virtual machines in the pool.
3. Select the virtual machine that you want to remove and click Detach to open the Detach
Virtual Machine(s) confirmation window.
4. Click OK to detach the virtual machine from the pool.
Note
T he 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.
Figure 10.2. A Detached Virtual Machine
Result
You have detached the virtual machine from the virtual machine pool.
Report a bug
10.2.6. Removing a Virtual Machine Pool
Summary
212
Chapter 10. Pools
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
1. Use the Pools resource tab, tree mode, or the search function to find and select the virtual
machine pool in the results list.
2. Click Rem ove to open the Rem ove Pool(s) confirmation window.
3. Click OK to remove the pool.
Result
You have removed the pool from the data center.
Report a bug
10.3. Pools and Permissions
10.3.1. Managing System Permissions for a Virtual Machine Pool
T he system administrator, as the SuperUser, manages all aspects of the Administration Portal. More
specific administrative roles can be assigned to other users. T hese restricted administrator roles are
useful for empowering a user with certain administrative privileges that limit them to a specific resource:
a DataCenterAdm in role has administrator privileges only for the assigned data center, a
ClusterAdm in 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. T his 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.
T he 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.
See Also:
Section 10.3.2, “Virtual Machine Pool Administrator Roles Explained”
Report a bug
10.3.2. Virtual Machine Pool Administrator Roles Explained
Pool Permission Roles
T he table below describes the administrator roles and privileges applicable to pool administration.
213
Red Hat Enterprise Virtualization 3.2 Administration Guide
T able 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.
See Also:
Section 12.4.2, “User and Administrator Roles”
Report a bug
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
1. Use the resource tabs, tree mode, or the search function to find and select the resource in the
results list.
2. Click the Perm issions tab of the details pane to list the assigned users, the user's role, and the
inherited permissions for the selected resource.
3. Click Add to open the Add Perm ission to User window.
4. Enter the name or user name of an existing user into the Search text box and click Go. Select a
user from the resulting list of possible matches.
5. Select a role from the Role to Assign: drop-down menu.
6. Click OK 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.
See Also:
Section 12.4.2, “User and Administrator Roles”
Report a bug
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.
214
Chapter 10. Pools
Procedure 10.8. Removing a Role from a Resource
1. Use the resource tabs, tree mode, or the search function to find and select the resource in the
results list.
2. Click the Perm issions tab of the details pane to list the assigned users, the user's role, and the
inherited permissions for the selected resource.
3. Select the user to remove from the resource.
4. Click Rem ove. T he Rem ove Perm ission window opens to confirm permissions removal.
5. Click OK to remove the user role.
Result
You have removed the user's role, and the associated permissions, from the resource.
Report a bug
215
Red Hat Enterprise Virtualization 3.2 Administration Guide
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. T he 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. T he virtual
machine can be mounted on a Red Hat Enterprise Linux server using kpartx, vgscan, vgchange and
m ount to investigate the virtual machine's processes or problems.
If the virtual disk is a thin provisioned, a 1 GB logical volume is created. T he 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. T he 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. T his 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. T hin provisioning takes significantly less time to create a virtual
disk. T he thin provision format is suitable for non-IO intensive virtual machines.
Report a bug
11.2. Understanding Virtual Disks
Virtual disks are of two types, T hin Provisioned or Preallocated. Preallocated disks are RAW
formatted. T hin provisioned disks are Qcow2 formatted.
Preallocated
A preallocated virtual disk has reserved storage of the same size as the virtual disk itself. T he
backing storage device (file/block device) is presented as is to the virtual machine with no additional
layering in between. T his 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
zeroes will not be deduplicated in the hard disk image file. (If these assumptions are incorrect, do not
select Preallocated for NFS virtual disks).
T hin Provisioned
For sparse virtual disks backing storage is not reserved and is allocated as needed during runtime.
T his allows for storage over commitment under the assumption that most disks are not fully utilized
216
Chapter 11. Virtual Machine D isks
and storage capacity can be utilized better. T his requires the backing storage to monitor write
requests and can cause some performance issues. On NFS backing storage is achieved simply 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. T his does not require
support from the underlying storage devices.
T he possible combinations of storage types and formats are described in the following table.
T able 11.1. Permitted Storage Combinations
Storage
Format
T ype
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).
Report a bug
217
Red Hat Enterprise Virtualization 3.2 Administration Guide
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. T hat 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.
Report a bug
11.4. Creating Unassociated Virtual Machine Hard Disks
Summary
You can create a virtual hard disk independently from any virtual machines. You can then attach your
disk to a virtual machine, or many virtual machines if it's shareable.
Procedure 11.1. Creating Unassociated Virtual Machine Hard Disks
1. Select the Disks resource tab.
2. Click Add to open the Add Virtual Disk window.
218
Chapter 11. Virtual Machine D isks
Figure 11.1. Add Virtual Disk Window
3. Use the radio buttons to select Internal or External(Direct Lun).
4. Enter the Size(GB), Alias, and Description of the virtual disk.
5. Use the drop-down menus to select the Interface, Form at, Data Center, and Storage
Dom ain of the virtual disk.
6. Select the appropriate check boxes to wipe the disk after delete, make the disk bootable, and
make the disk shareable.
7. Click OK to create the virtual disk and close the window.
Result
You have created a virtual disk which can be shared between different virtual machines.
See Also:
Section 11.5, “Explanation of Settings in the New Virtual Machine Disk and Edit Virtual Machine Disk
Windows”
Report a bug
219
Red Hat Enterprise Virtualization 3.2 Administration Guide
11.5. Explanation of Settings in the New Virtual Machine Disk and
Edit Virtual Machine Disk Windows
T able 11.2. Add a disk settings: Internal
Field Name
Description
Size(GB)
Size of new virtual disk in GB.
Alias
T he name of the template, limited to 40
characters.
Description
Optionally describe the new virtual disk.
Interface
T he virtual interface the disk 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. IDE devices
do not require special drivers.
Form at
T he provisioning policy for the new virtual disk.
Preallocated allots the entire size of the disk on
the data domain at creation time. T hin provision
starts at 1 GB and sets a maximum limit on the
size the disk can grow to. Preallocated disks take
more time to create than thin provisioned ones,
but have better read and write performance.
Preallocated is the recommended format for
server disks. T hin provisioned disks are faster to
create and allow for storage over-commitment.
T hin provisioned is the recommended format for
desktop disks.
Data Center
T he data center in which this disk is available.
Storage Dom ain
T he data domain that the disk is stored on.
Wipe after delete
Enhanced security for deletion of sensitive
material when the disk is deleted.
Is bootable
Sets the bootable flag on the disk.
Is shareable
T his disk can be attached to more than one
virtual machine at a time.
T he External(Direct LUN) settings include all of the entries from the Internal except for
Size(GB) and some additional entries.
220
Chapter 11. Virtual Machine D isks
T able 11.3. Add a disk settings: External(Direct LUN)
Field Name
Description
Use Host
T he host to use to mount the LUN.
Storage T ype
T ype of external LUN to add. Either iSCSI or Fibre
Channel targets are allowed.
Discover T argets
Can be expanded when you are using iSCSI
external LUNs and T argets &gt; LUNs is
selected.
Address
T he hostname or IP address of the target server.
T he Address field is visible when you are using
iSCSI external LUNs and T argets &gt; LUNs is
selected.
Port
T he port that has been opened on the target
server. T he default is 3260. T he Port field is
visible when you are using iSCSI external LUNs
and T argets &gt; LUNs is selected.
User Authentication
T he iSCSI server requires User
Authentication.T he User Authentication field
is visible when you are using iSCSI external LUNs
and T argets &gt; LUNs is selected.
CHAP usernam e and password
T he username and password of a user with
permission to login to LUNs. T he CHAP
usernam e and password fields are
accessible when you are using password
protected iSCSI external LUNs and T argets &gt;
LUNs is selected.
Fill in all the fields correctly and your external LUNs are displayed to be used as virtual disks.
Using LUNs directly as virtual machine hard disk images removes a layer of abstraction between your
virtual machines and their data.
Here are some things that you should keep in mind when you choose to use 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.
See Also:
Section 7.6.4, “Un-useable LUNs in Red Hat Enterprise Virtualization”
Report a bug
11.6. 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 want to do this to
221
Red Hat Enterprise Virtualization 3.2 Administration Guide
take advantage of high performance storage, or because you would like to decommission one of your
storage domains that contains virtual hard disks.
If your virtual machine was created from a template, then the template must exist on any data domain
that you migrate the virtual machine disks to. Use an export domain to move templates between storage
domains.
Procedure 11.2. Moving a Virtual Machine Hard Disk Between Data Domains
1. Select the Disks resource tab.
2. Select the virtual disk or disks to move.
3. Click Move to open the Move Disk(s) window.
4. Use the drop-down menu or menus to select the T arget data domain.
5. Click OK 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.
See Also:
Section 9.2.6.1, “Migrating T emplates to the Export Domain”
Report a bug
11.7. Virtual Disks and Permissions
11.7.1. Managing System Permissions for a Virtual Disk
T he system administrator, as the SuperUser, manages all aspects of the Administration Portal. More
specific administrative roles can be assigned to other users. T hese restricted administrator roles are
useful for empowering a user with certain administrative privileges that limit them to a specific resource:
a DataCenterAdm in role has administrator privileges only for the assigned data center, a
ClusterAdm in has administrator privileges only for the assigned cluster, a StorageAdm in 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. T his 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.
T he 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.
222
Chapter 11. Virtual Machine D isks
See Also:
Section 11.7.2, “Virtual Disk User Roles Explained”
Report a bug
11.7.2. Virtual Disk User Roles Explained
Virtual Disk User Permission Roles
T he table below describes the user roles and privileges applicable to using and administrating virtual
machine disks in the User Portal.
T able 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.
T his 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.
See Also:
Section 12.4.2, “User and Administrator Roles”
Report a bug
11.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 11.3. Assigning a Role to a Resource
1. Use the resource tabs, tree mode, or the search function to find and select the resource in the
results list.
2. Click the Perm issions tab of the details pane to list the assigned users, the user's role, and the
inherited permissions for the selected resource.
3. Click Add to open the Add Perm ission to User window.
4. Enter the name or user name of an existing user into the Search text box and click Go. Select a
user from the resulting list of possible matches.
5. Select a role from the Role to Assign: drop-down menu.
6. Click OK to assign the role and close the window.
223
Red Hat Enterprise Virtualization 3.2 Administration Guide
Result
You have assigned a role to a user; the user now has the inherited permissions of that role enabled for
that resource.
See Also:
Section 12.4.2, “User and Administrator Roles”
Report a bug
11.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 11.4 . Removing a Role from a Resource
1. Use the resource tabs, tree mode, or the search function to find and select the resource in the
results list.
2. Click the Perm issions tab of the details pane to list the assigned users, the user's role, and the
inherited permissions for the selected resource.
3. Select the user to remove from the resource.
4. Click Rem ove. T he Rem ove Perm ission window opens to confirm permissions removal.
5. Click OK to remove the user role.
Result
You have removed the user's role, and the associated permissions, from the resource.
Report a bug
224
Part II. Administering the Environment
Part II. Administering the Environment
225
Red Hat Enterprise Virtualization 3.2 Administration Guide
Chapter 12. Users and Roles
12.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. T he exception is the adm in 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.
T here 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 adm in 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.
Report a bug
12.2. Directory Users
12.2.1. Directory Services Support in Red Hat Enterprise Virtualization
During installation Red Hat Enterprise Virtualization Manager creates its own internal administration
user, adm in. T his account is intended for use when initially configuring the environment, and for
troubleshooting. T o add other users to Red Hat Enterprise Virtualization you will need to attach a
directory server to the Manager using the Domain Management T ool, rhevm -m anage-dom ains.
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 Principle Name (UPN) of the form user@ domain. Attachment of more than one
directory server to the Manager is also supported.
T he directory servers currently supported for use with Red Hat Enterprise Virtualization 3.2 are:
Active Directory;
Identity Management (IdM); and
Red Hat Directory Server 9 (RHDS 9).
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:
A valid pointer record (PT R) for the directory server's reverse look-up address.
A valid service record (SRV) for LDAP over T CP port 389.
A valid service record (SRV) for Kerberos over T CP port 88.
A valid service record (SRV) for Kerberos over UDP port 88.
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 rhevm -m anage-dom ains.
226
Chapter 12. Users and Roles
For more detailed information on installing and configuring a supported directory server, refer to the
vendor's documentation:
Active Directory - http://technet.microsoft.com/en-us/windowsserver/dd448614.
Identity Management (IdM) - http://docs.redhat.com/docs/enUS/Red_Hat_Enterprise_Linux/6/html/Identity_Management_Guide/index.html
Red Hat Directory Server (RHDS) - http://docs.redhat.com/docs/enUS/Red_Hat_Directory_Server/index.html
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 T emplates and Virtual Machines, then the Red Hat Enterprise Virtualization
administrative user must be delegated control over the Domain to:
Join a com puter to the dom ain
Modify the m em bership of a group
For information on creation of user accounts in Active Directory refer to
http://technet.microsoft.com/en-us/library/cc732336.aspx.
For information on delegation of control in Active Directory refer to http://technet.microsoft.com/enus/library/cc732524.aspx.
227
Red Hat Enterprise Virtualization 3.2 Administration Guide
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. T o do this you will need to perform these steps while referring to the relevant directory
server documentation:
Configure the m em berOf plug-in for RHDS to allow group membership. In particular ensure
that the value of the memberofgroupattr attribute of the m em berOf plug-in is set to
uniqueMem ber.
Consult the Red Hat Directory Server 9.0 Plug-in Guide for more information on configuring
the m em berOf plug-in.
Define the directory server as a service of the form ldap/hostname@ REALMNAME in 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. T he Kerberos
realm name must be specified in capital letters.
Generate a keytab file for the directory server in the Kerberos realm. T he keytab file
contains pairs of Kerberos principals and their associated encrypted keys. T hese 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 a
keytab file.
Install the keytab file on the directory server. T hen configure RHDS to recognize the keytab
file 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 external keytab file.
T est the configuration on the directory server by using the kinit command to authenticate
as a user defined in the Kerberos realm. Once authenticated run the ldapsearch command
against the directory server. Use the -Y GSSAPI parameters to ensure the use of Kerberos
for authentication.
Report a bug
12.3. User Authorization
12.3.1. User Authorization Model
Red Hat Enterprise Virtualization applies authorization controls based on the combination of the three
components:
T he user performing the action
T he type of action being performed
T he object on which the action is being performed
Report a bug
12.3.2. User Actions
For an action to be successfully performed, the user must have the appropriate perm ission for the
object being acted upon. Each type of action corresponds to a perm ission. T here are many
228
Chapter 12. Users and Roles
different permissions in the system, so for simplicity:
Figure 12.1. Actions
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. T he user
performing an action must have appropriate permissions for all objects the action impacts.
Report a bug
12.3.3. User Permissions
Permissions enable users to perform actions on objects, where objects are either individual objects or
container objects.
Figure 12.2. Permissions &amp; Roles
Any permissions that apply to a container object also apply to all members of that container. T he
following diagram depicts the hierarchy of objects in the system.
229
Red Hat Enterprise Virtualization 3.2 Administration Guide
Figure 12.3. Red Hat Enterprise Virtualization Object Hierarchy
Report a bug
12.4. Red Hat Enterprise Virtualization Manager User Properties
and Roles
12.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.
Report a bug
12.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. T here 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 adm inistrator role on a cluster, you can manage all virtual machines in
230
Chapter 12. Users and Roles
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:
Section 12.6, “User Role and Authorization Examples”
Section 12.4.3, “User Roles Explained”
Section 12.4.4, “Administrator Roles Explained”
Report a bug
12.4.3. User Roles Explained
T he table below describes basic user roles which confer permissions to access and configure virtual
machines in the User Portal.
T able 12.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 Vm Creator role provides privileges previously conferred by the
PowerUserRole. T he 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
Vm Creator, DiskCreator, and T em plateCreator roles.
T he table below describes advanced user roles which allow you to do more fine tuning of permissions
231
Red Hat Enterprise Virtualization 3.2 Administration Guide
for resources in the User Portal.
T able 12.2. Red Hat Enterprise Virtualization User Roles - Advanced
Role
Privileges
Notes
UserT emplateBasedVm
Limited privileges to only use
T emplates.
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.
T his 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.
T emplateCreator
Can create, edit, manage and
remove virtual machine
templates within assigned
resources.
T his 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.
T his 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.
T emplateOwner
Can edit and delete the
template, assign and manage
user permissions for the
template.
T his role is automatically
assigned to the user who
creates a template. Other users
who do not have
T em plateOwner 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.
Report a bug
232
Chapter 12. Users and Roles
12.4.4. Administrator Roles Explained
T he table below describes basic administrator roles which confer permissions to access and configure
resources in the Administration Portal.
T able 12.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.
T he table below describes advanced administrator roles which allow you to do more fine tuning of
permissions for resources in the Administration Portal.
233
Red Hat Enterprise Virtualization 3.2 Administration Guide
T able 12.4 . Red Hat Enterprise Virtualization System Administrator Roles - Advanced
Role
Privileges
Notes
T emplateAdmin
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.
Report a bug
12.5. Red Hat Enterprise Virtualization Manager User Tasks
12.5.1. Adding Users
Prerequisites:
Section 12.2.1, “Directory Services Support in Red Hat Enterprise Virtualization”
Summary
Users in Red Hat Enterprise Virtualization must be added from an external directory service before they
can be assigned roles and permissions.
Procedure 12.1. Adding Users to Red Hat Enterprise Virtualization
1. Click the Users tab to display the list of authorized users.
2. Click Add. T he Add Users and Groups window opens.
234
Chapter 12. Users and Roles
Figure 12.4 . Add Users and Groups Window
3. 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 GO. Alternatively, click GO to view a list of all users and groups.
4. Select the check boxes for the appropriate users or groups.
5. Click OK.
Result
T he added user displays on the Users tab.
Report a bug
12.5.2. Viewing User Information
Summary
You can view detailed information on each user in the Users tab.
Procedure 12.2. Viewing User Information
1. Click the Users tab to display the list of authorized users.
2. Select the user, or perform a search if the user is not visible on the results list.
3. T he 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.
4. T he 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.
235
Red Hat Enterprise Virtualization 3.2 Administration Guide
Result
You have viewed domain, permissions, quota, group and event information for a user.
Report a bug
12.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 12.3. Viewing User Permissions on Resources
1. Use the resource tabs, tree mode, or the search function to find and select the resource in the
results list.
2. Click the Perm issions 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.
Report a bug
12.5.4. Removing Users
Summary
When a user account is no longer required, remove it from Red Hat Enterprise Virtualization.
Procedure 12.4 . Removing Users
1. Click the Users tab to display the list of authorized users.
236
Chapter 12. Users and Roles
Figure 12.5. Users T ab
2. Select the user to be removed. Ensure the user is not running any virtual machines.
3. Click the Rem ove button. A message displays prompting you to confirm the removal. Click OK.
Result
T he user is removed from Red Hat Enterprise Virtualization, but not from the external directory.
Report a bug
12.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.
See Also:
Section 12.3.1, “User Authorization Model”
Report a bug
12.5.6. Creating a New Role
Summary
237
Red Hat Enterprise Virtualization 3.2 Administration Guide
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 12.5. Creating a New Role
1. On the header bar, click the Configure button to open the Configure window. T he window
shows a list of default User and Administrator roles, and any custom roles.
2. Click New. T he New Role dialog box displays.
Figure 12.6. T he New Role Dialog
3. Enter the Nam e and Description of the new role.
4. Select either Adm in or User as the Account T ype.
5. Use the Expand All or Collapse All 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.
6. For each of the objects, select or deselect the actions you wish to permit or deny for the role you
are setting up.
7. Click OK to apply the changes you have made. T he 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.
Report a bug
238
Chapter 12. Users and Roles
12.5.7. Editing or Copying a Role
Summary
You can change the settings for roles you have created, but you cannot change default roles. T o change
default roles, clone and modify them to suit your requirements.
Procedure 12.6. Editing or Copying a Role
1. On the header bar, click the Configure button to open the Configure window. T he window
shows a list of default User and Administrator roles, and any custom roles.
2. Select the role you wish to change. Click Edit to open the Edit Role window, or click Copy to
open the Copy Role window.
3. If necessary, edit the Nam e and Description of the role.
4. Use the Expand All or Collapse All buttons to view more or fewer of the permissions for
the listed objects. You can also expand or collapse the options for each object.
5. For each of the objects, select or deselect the actions you wish to permit or deny for the role you
are editing.
6. Click OK to apply the changes you have made.
Result
You have edited the properties of a role, or cloned a role.
Report a bug
12.6. User Role and Authorization Examples
T he following examples illustrate how to apply authorization controls for various scenarios, using the
different features of the authorization system described in this chapter.
Example 12.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 ClusterAdm in role on the accounts cluster. T his 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
ClusterAdm in 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 12.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
UserVm Manager role on the johndesktop virtual machine. T his allows him to access this single
virtual machine using the User Portal. Because he has UserVm Manager permissions, he can modify
the virtual machine and add resources to it, such as new virtual disks. Because UserVm Manager is
a user role, it does not allow him to use the Administration Portal.
239
Red Hat Enterprise Virtualization 3.2 Administration Guide
Example 12.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. T his 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 DataCenterAdm in privileges to Penelope. As a
PowerUser for a data center, Penelope can log in to the User Portal and perform virtual machinespecific 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 12.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 NetworkAdm in 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. T he junior network administrator, Pat, is managing a
smaller virtualized environment for the company's internal training department. Chris has assigned
Pat NetworkUser permissions and UserVm Manager 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.
24 0
Chapter 12. Users and Roles
Example 12.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. T here 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.
Figure 12.7. UserManager Custom Role
T he UserManager custom role shown above allows manipulation of users, permissions and roles.
T hese actions are organized under System - the top level object of the hierarchy shown in
Figure 12.7, “UserManager Custom Role”. T his means they apply to all other objects in the system.
T he role is set to have an Account T ype of Adm in. T his means that when she is assigned this
role, Rachel can only use the Administration Portal, not the User Portal.
Report a bug
24 1
Red Hat Enterprise Virtualization 3.2 Administration Guide
Chapter 13. Quotas
13.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.
T here are two different kinds of Quota:
T able 13.1. T he T wo Different Kinds of Quota
Quota type
Definition
Run-time Quota
T his quota limits the consumption of run time
resources, like CPU and memory.
Storage Quota
T his quota limits the amount of storage available.
Quota, like SELinux, has three modes:
T able 13.2. Quota Modes
Quota Mode
Function
Enforced
T his 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
T his 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
T his 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. T hese thresholds appear, from the
24 2
Chapter 13. Quotas
user's point of view, as 100% usage of that resource. T o prevent failures when the customer
unexpectedly exceeds this threshold, the interface supports a &quot;grace&quot; 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.
T o power on a virtual machine, a quota must be assigned to that virtual machine.
T o 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. T his 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.
Report a bug
13.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 1T B 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.
Report a bug
13.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. T he quota is calculated for the max
growth potential and not the current usage.
24 3
Red Hat Enterprise Virtualization 3.2 Administration Guide
Example 13.1. Accounting example
A user runs a virtual machine with 1 vCPU and 1024 MB memory. T he 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. T he actual disk usage may indicate only 3GB of
that disk are actually in use. T he quota consumption, however, would be 10GB, the max growth
potential of that disk.
Report a bug
13.4. Enabling and Changing a Quota Mode in a Data Center
Summary
T his 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 13.1. Enabling and Changing Quota in a Data Center
1. Click the Data Centers tab in the Navigation Pane.
2. From the list of data centers displayed in the Navigation Pane, choose the data center whose
quota policy you plan to edit.
3. Click Edit in the top left of the Navigation Pane.
4. An Edit Data Center window opens. In the Quota Mode drop-down, change the quota mode
to Enforced.
5. 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.
Report a bug
13.5. Creating a New Quota Policy
Prerequisites:
Section 13.4, “Enabling and Changing a Quota Mode in a Data Center”
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.
24 4
Chapter 13. Quotas
Procedure 13.2. Creating a New Quota Policy
1. In tree mode, select the data center. T he Quota tab appears in the Navigation Pane.
2. Click the Quota tab in the Navigation Pane.
3. Click Add in the Navigation Pane. T he New Quota window opens.
4. Fill in the Nam e field with a meaningful name.
Fill in the Description field with a meaningful name.
5. In the Mem ory &amp; CPU section of the New Quota window, use the green slider to set Cluster
T hreshold.
6. In the Mem ory &amp; CPU section of the New Quota window, use the blue slider to set Cluster
Grace.
7. Click Edit on the bottom-right of the Mem ory &amp; CPU field. An Edit Quota window opens.
8. Under the Mem ory field, select either the Unlim ited radio button (to allow limitless use of
Memory resources in the cluster), or select the lim it to radio button to set the amount of
memory set by this quota. If you select the lim it to radio button, input a memory quota in
megabytes (MB) in the MB field.
9. Under the CPU field, select either the Unlim ited radio button or the lim it to radio button to
set the amount of CPU set by this quota. If you select the lim it to radio button, input a number
of vCPUs in the vCpus field.
10. Click OK in the Edit Quota window.
11. In the Storage section of the New Quota window, use the green slider to set Storage
T hreshold.
12. In the Storage section of the New Quota window, use the blue slider to set Storage Grace.
13. Click Edit in the Storage field. T he Edit Quota window opens.
14. Under the Storage Quota field, select either the Unlim ited radio button (to allow limitless use
of Storage) or the lim it to radio button to set the amount of storage to which quota will limit
users. If you select the lim it to radio button, input a storage quota size in gigabytes (GB) in
the GB field.
15. Click OK in the Edit Quota window. You are returned to the New Quota window.
16. Click OK in the New Quota window.
Result
You have created a new quota policy.
See Also:
Section 13.6, “Explanation of Quota T hreshold Settings”
Section 13.7, “Assigning a Quota to an Object”
Report a bug
13.6. Explanation of Quota Threshold Settings
24 5
Red Hat Enterprise Virtualization 3.2 Administration Guide
T able 13.3. Quota thresholds and grace
Setting
Definition
Cluster T hreshold
T he amount of cluster resources available per
data center.
Cluster Grace
T he amount of the cluster available for the data
center after exhausting the data center's Cluster
T hreshold.
Storage T hreshold
T he amount of storage resources available per
data center.
Storage Grace
T he amount of storage available for the data
center after exhausting the data center's Storage
T hreshold.
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 T hreshold 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 &quot;T hreshold&quot; and &quot;Grace&quot; are set relative to the quota.
&quot;T hreshold&quot; may be thought of as the &quot;soft limit&quot;, and exceeding it generates a warning. &quot;Grace&quot; may be
thought of as the &quot;hard limit&quot;, and exceeding it makes it impossible to consume any more storage
resources.
Report a bug
13.7. Assigning a Quota to an Object
Prerequisites:
Section 13.5, “Creating a New Quota Policy”
Summary
T his procedure explains how to associate a virtual machine with a quota.
Procedure 13.3. Assigning a Quota to a Virtual Machine
1. In the navigation pane, select the Virtual Machine to which you plan to add a quota.
2. Click Edit. T he Edit Desktop Virtual Machine window appears.
3. Select the quota you want the virtual machine to consume. Use the Quota drop-down to do this.
4. Click OK.
Result
You have designated a quota for the virtual machine you selected.
Summary
T his procedure explains how to associate a virtual machine disk with a quota.
Procedure 13.4 . Assigning a Quota to a Virtual Disk
1. In the navigation pane, select the Virtual Machine whose disk(s) you plan to add a quota.
2. In the details pane, select the disk you plan to associate with a quota.
24 6
Chapter 13. Quotas
3. Click Edit. T he Edit Virtual Disk window appears.
4. Select the quota you want the virtual disk to consume.
5. Click OK.
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. T he 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.
Report a bug
13.8. Using Quota to Limit Resources by User
Prerequisites:
Section 13.5, “Creating a New Quota Policy”
Summary
T his procedure describes how to use quotas to limit the resources a user has access to.
Procedure 13.5. Assigning a User to a Quota
1. In the tree, click the Data Center with the quota you want to associate with a User.
Figure 13.1. Selecting the Data Center
24 7
Red Hat Enterprise Virtualization 3.2 Administration Guide
2. Click the Quota tab in the navigation pane.
Figure 13.2. Selecting the Quota T ab
3. Select the target quota in the list in the navigation pane.
Figure 13.3. Selecting the T arget Quota
4. Click the Consum ers tab in the details pane.
24 8
Chapter 13. Quotas
Figure 13.4 . Selecting the Consumers T ab
5. Click Add at the top of the details pane.
Figure 13.5. Clicking the Add Button
6. In the Search field, type the name of the user you want to associate with the quota.
7. Click GO.
8. Select the check box at the left side of the row containing the name of the target user.
9. Click OK in the bottom right of the Assign Users and Groups to Quota window.
Result
After a short time, the user will appear in the Consum ers tab of the details pane.
Report a bug
13.9. Editing Quotas
Summary
T his procedure describes how to change existing quotas.
Procedure 13.6. Editing Quotas
1. On the tree pane, click on the data center whose quota you want to edit.
24 9
Red Hat Enterprise Virtualization 3.2 Administration Guide
Figure 13.6. Selecting a Data Center to Edit Its Quota
2. Click on the Quota tab in the Navigation Pane.
Figure 13.7. Selecting the Quota T ab in the Navigation Pane
3. Click the name of the quota you want to edit.
250
Chapter 13. Quotas
Figure 13.8. Selecting a Quota to Edit
4. Click Edit in the Navigation pane.
5. An Edit Quota window opens. If required, enter a meaningful name in the Nam e field.
6. If required, you can enter a meaningful description in the Description field.
7. Select either the All Clusters radio button or the Specific Clusters radio button. Move
the Cluster T hreshold and Cluster Grace sliders to the desired positions on the Mem ory
&amp; CPU slider.
8. Select either the All Storage Dom ains radio button or the Specific Storage Dom ains
radio button. Move the Cluster T hreshold and Cluster Grace sliders to the desired
positions on the Mem ory &amp; CPU slider.
9. Click OK in the Edit Quota window to confirm the new quota settings.
Result
You have changed an existing quota.
Report a bug
13.10. Removing Quotas
Summary
T his procedure describes how to remove quotas.
Procedure 13.7. Removing Quotas
1. On the tree pane, click on the data center whose quota you want to edit.
2. Click on the Quota tab in the Navigation Pane.
3. Click the name of the quota you want to remove.
4. Click Rem ove at the top of the Navigation pane, under the row of tabs.
5. Click OK in the Rem ove Quota(s) window to confirm the removal of this quota.
251
Red Hat Enterprise Virtualization 3.2 Administration Guide
Result
You have removed a quota.
Report a bug
252
Chapter 14. Event Notifications
Chapter 14. Event Notifications
14.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 14 .1. Configuring Event Notifications
1. Ensure that you have set up the MT A agent with the appropriate variables.
2. Use the Users resource tab, tree mode, or the search function to find and select the user.
3. Click the Event Notifier tab in the details pane to list events for which the user will be notified.
T his list will be blank if the user does not have event notification configured.
4. Click Manage Events to open the Add Event Notification window.
Figure 14 .1. T he Add Events Notification Window
5. Use the Expand All button, or the subject-specific expansion buttons, to view the events.
253
Red Hat Enterprise Virtualization 3.2 Administration Guide
6. Select the appropriate check boxes.
7. Enter an email address in the Mail Recipient: field.
8. Click OK to save changes and close the window.
9. Add and start the engine-notifierd service on the Red Hat Enterprise Virtualization Manager.
T his activates the changes you have just made:
# chkconfig --add engine-notifierd
# chkconfig engine-notifierd on
# service engine-notifierd restart
Result
You now receive emails based on events in your Red Hat Enterprise Virtualization Environment. T he
selected events display on the Event Notifier tab for the user.
Report a bug
14.2. Parameters for event notifications in notifier.conf
T he event notifier configuration file can be found in /etc/rhevm /notifier/notifier.conf.
254
Chapter 14. Event Notifications
T able 14 .1. notifier.conf variables
Variable name
Default
Remarks
INT ERVAL_IN_SECONDS
120
T he interval in seconds between
instances of dispatching messages to
subscribers.
MAIL_SERVER
none
T he SMT P mail server address.
Required.
MAIL_PORT
25
T he default port of a non-secured
SMT P server is 25. T he default port of
a secured SMT P server (one with SSL
enabled) is 465.
MAIL_USER
none
If SSL is enabled to authenticate the
user, then this variable must be set.
T his variable is also used to specify
the &quot;from&quot; user address when the
MAIL_FROM variable is not set. Some
mail servers do not support this
functionality. T he address is in RFC822
format.
MAIL_PASSWORD
none
T his variable is required to
authenticate the user if the mail server
requires authentication or if SSL is
enabled.
MAIL_ENABLE_SSL
false
T his indicates whether SSL should be
used to communicate with the mail
server.
HT ML_MESSAGE_FORMAT
false
T he mail server sends messages in
HT ML format if this variable is set to
&quot;true&quot;.
MAIL_FROM
none
T his variable specifies a &quot;from&quot;
address in RFC822 format, if supported
by the mail server.
MAIL_REPLY_T O
none
T his variable specifies &quot;reply-to&quot;
addresses in RFC822 format on sent
mail, if supported by the mail server.
DAYS_T O_KEEP_HIST ORY
none
T his 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.
Report a bug
14.3. Canceling Event Notifications
Summary
A user has configured some unnecessary event notifications and wants them canceled.
255
Red Hat Enterprise Virtualization 3.2 Administration Guide
Procedure 14 .2. Canceling Event Notifications
1. In the Users tab, select the user or the user group.
2. Select the Event Notifier tab in the details pane to list events for which the user receives
notifications.
3. Click Manage Events to open the Add Event Notification window.
4. Use the Expand All button, or the subject-specific expansion buttons, to view the events.
5. Clear the appropriate check boxes to remove notification for that event.
6. Click OK to save changes and close the window.
Result
You have canceled unnecessary event notifications for the user.
Report a bug
256
Chapter 15. Utilities
Chapter 15. Utilities
15.1. Managing Domains with the Domain Management Tool
15.1.1. What is the Domain Management Tool?
Red Hat Enterprise Virtualization Manager authenticates users using directory services. T o add users
to Red Hat Enterprise Virtualization Manager you must first use the internal adm in 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, rhevm -m anage-dom ains.
T he rhevm -m anage-dom ains command is only accessible on the machine on which Red Hat
Enterprise Virtualization Manager is installed. T he rhevm -m anage-dom ains command must be run
as the root user.
Report a bug
15.1.2. Syntax for the Domain Management Tool
T he usage syntax is:
rhevm-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. T his
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.
T hese options can be combined with the actions on the command line:
-domain=DOMAIN
Specifies the domain on which the action will be performed. T he -domain parameter is
mandatory for add, edit, and delete.
257
Red Hat Enterprise Virtualization 3.2 Administration Guide
-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 the m em berof
plugin installed in RHDS. T o use the m em berof plugin, your users must be
inetusers. For more information about using the m em berof plugin, see the Red
Hat Directory Server Plug-in Guide.
-user=USER
Specifies the domain user to use. T he -user parameter is mandatory for add, and optional for
edit.
-passwordFile=FILE
Specifies that the domain user's password is on the first line of the provided file. T his option, or
the -interactive option, must be used to provide the password for use with the add action.
-addPermissions
Specifies that the domain user will be given the SuperUser role in Red Hat Enterprise
Virtualization Manager. By default, if the -addPermissions parameter is not specified, the
SuperUser role is not assigned to the domain user. T he -addPermissions option is optional.
It is only valid when used in combination with the add and edit actions.
-interactive
Specifies that the domain user's password is to be provided interactively. T his option, or the passwordFile option, must be used to provide the password for use with the add action.
-configFile=FILE
Specifies an alternate configuration file that the command must load. T he -configFile
parameter is always optional.
-report
In conjunction with the validate action results in the output of a report of all encountered
validation errors.
For full usage information consult the rhevm -m anage-dom ains command's help output:
258
Chapter 15. Utilities
# rhevm-manage-domains --help
Report a bug
15.1.3. Using the Domain Management Tool
T he following examples demonstrate the use of the rhevm -m anage-dom ains command to perform
basic manipulation of the Red Hat Enterprise Virtualization Manager domain configuration.
Report a bug
15.1.4. Adding Domains to Configuration
In this example, the rhevm -m anage-dom ains command is used to add the IdM domain
directory.dem o.redhat.com to the Red Hat Enterprise Virtualization Manager configuration. T he
configuration is set to use the adm in user when querying the domain; the password is provided
interactively.
Example 15.1. rhevm -m anage-dom ains Add Action
# rhevm-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).
Report a bug
15.1.5. Editing a Domain in the Configuration
In this example, the rhevm -m anage-dom ains command is used to edit the
directory.dem o.redhat.com domain in the Red Hat Enterprise Virtualization Manager
configuration. T he configuration is updated to use the adm in user when querying this domain; the
password is provided interactively.
Example 15.2. rhevm -m anage-dom ains Edit Action
# rhevm-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).
259
Red Hat Enterprise Virtualization 3.2 Administration Guide
Report a bug
15.1.6. Deleting a Domain from the Configuration
In this example, the rhevm -m anage-dom ains command is used to remove the
directory.dem o.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. T he entries for the affected users will remain defined in the Red
Hat Enterprise Virtualization Manager until they are explicitly removed.
T he 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 adm in user from
the internal domain will be able to log in until another domain is added.
Example 15.3. rhevm -m anage-dom ains Delete Action
# rhevm-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.
Report a bug
15.1.7. Validating Domain Configuration
In this example, the rhevm -m anage-dom ains command is used to validate the Red Hat Enterprise
Virtualization Manager configuration. T he command attempts to log into each listed domain with the
credentials provided in the configuration. T he domain is reported as valid if the attempt is successful.
Example 15.4 . rhevm -m anage-dom ains Validate Action
# rhevm-manage-domains -action=validate
User guide is: 80b71bae-98a1-11e0-8f20-525400866c73
Domain directory.demo.redhat.com is valid.
Report a bug
15.1.8. Listing Domains in Configuration
In this example, the rhevm -m anage-dom ains command is used to list the domains defined in the Red
Hat Enterprise Virtualization Manager configuration. For each configuration entry the command displays
the domain, the user name — in User Principle Name (UPN) format — and whether the domain is local or
remote.
Example 15.5. rhevm -m anage-dom ains List Action
# rhevm-manage-domains -action=list
Domain: directory.demo.redhat.com
User name: [email protected]
This domain is a remote domain.
260
Chapter 15. Utilities
Report a bug
15.1.9. Getting a Configuration Value
Example 15.6. Retrieving the Value of the SearchResultsLim it Key
# rhevm-config --get=SearchResultsLimit --cver=general
100
Report a bug
15.1.10. Setting a Configuration Value
Example 15.7. Setting the Value of the SearchResultsLim it Key
# rhevm-config --set SearchResultsLimit=50 --cver=general
Report a bug
15.2. Editing the Configuration of the Red Hat Virtualization
Manager with the Configuration Tool
15.2.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: rhevm -config.
T he configuration tool does not require JBoss 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 JBoss is
restarted.
T he Red Hat Enterprise Virtualization Manager stores configuration settings as a series of key-to-value
pair mappings. T he 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. T he default configuration version is general.
Report a bug
15.2.2. Syntax for rhevm-config Command
T he 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 rhevm -config command:
261
Red Hat Enterprise Virtualization 3.2 Administration Guide
# rhevm-config --help
Common tasks
List available configuration keys
Use the --list parameter to list available configuration keys.
# rhevm-config --list
Each available configuration key is listed by name and description.
List available configuration values
Use the --all parameter to list available configuration values.
# rhevm-config --all
Each available configuration key is listed by name, current value of the key, and the
configuration version.
Retrieve value of configuration key
Use the --get parameter to retrieve the value of a specific key.
# rhevm-config --get KEY_NAME
Replace KEY_NAME with the name of the specific key to retrieve the key name, value, and the
configuration version. Use the --cver parameter to specify the configuration version of the
value to be retrieved.
Set value of configuration key
Use the --set parameter to set the value of a specific key. You must also set the configuration
version to which the change is to apply using the --cver parameter.
# rhevm-config --set KEY_NAME=KEY_VALUE --cver=VERSION
Replace 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.
Report a bug
15.2.3. The admin@internal user
T he adm in@ internal user account is automatically created upon installation of the Red Hat
Enterprise Virtualization Manager. T his 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. T he adm in@ internal user is the SuperUser of the Red Hat Enterprise Virtualization
Manager and has administrative privileges over the environment via the Administration Portal.
262
Chapter 15. Utilities
T he password for the adm in@ internal user is set during the installation of the Red Hat Enterprise
Virtualization Manager. Use the rhevm-config utility if you need to reset the password.
Report a bug
15.2.4. Changing the password for admin@internal
1. Log in to the Red Hat Enterprise Virtualization Manager server as the root user.
2. Use the rhevm-config utility to set a new password for the adm in@ internal user.
# rhevm-config -s AdminPassword=interactive
Use escape characters if your password includes any special characters.
3. Restart the ovirt-engine service for the changes to take effect.
# service ovirt-engine restart
Report a bug
15.2.5. Configuration tool examples
Example 15.8. Getting a Configuration Value
# rhevm-config --get=SearchResultsLimit --cver=general
100
Example 15.9. Setting a Configuration Value
# rhevm-config --set SearchResultsLimit=50 --cver=general
Report a bug
15.2.6. Red Hat Enterprise Virtualization Manager Configuration Options
Explanations, Limitations, and Best Practices
263
Red Hat Enterprise Virtualization 3.2 Administration Guide
T able 15.1. Red Hat Enterprise Virtualization Manager Configuration Options, Explanations,
Limitations, and Best Practices
Option Name
Description
Possible values
Recommended
(default) values
Comments
AsyncT askPolling
Rate
Async T ask
Polling Rate (in
seconds)
Integer
10
How often (in
seconds) RHEV-M
queries the status
of an async task
currently running.
AsyncT askZ ombi
eT askLifeInMinute
s
Z ombie 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.
T he 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.
AuditLogAgingT hr
eshold
Audit Log Aging
T hreshold (in
days)
Integer
30
How long an audit
log is kept before
being rotated.
AuditLogCleanupT
ime
T ime to check for
Audit Log cleanup
T ime
03:35:35
At what time the
Audit Log is
checked for Aging
and cleaned up.
AuthenticationMet
hod
Authentication
Method used by
RHEV-M
String
LDAP
T he API used for
querying users.
Currently LDAP is
the only
supported value.
BlockMigrationOn
SwapUsagePerce
ntage
Host swap
percentage
threshold (for
scheduling)
Integer
0
T he 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
264
Chapter 15. Utilities
this percentage, a
VM will not migrate
over and will not
be started.
BootstrapMinimalV Minimum VDSM
dsmVersion
version
String
4.9
T he 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/ovirtengine
Where the RHEVM Certificate
Authority is
located on the
RHEV-M host.
CertificateFileNam
e
Certificate File
Name
String
/etc/pki/ovirtengine/certs/engin
e.cer
Points to the
certificate file
used by RHEV-M
for SSL/T LS
communication
with VDSM.
CpuOverCommitD
urationMinutes
T he 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. T his
configuration
value applies only
for the default.
DisableFenceAtSt
artupInSec
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 nonresponsive and
proceed to fence
hosts. T his value
should be
increased when
RHEV-M is on a
machine that has
slow network
265
Red Hat Enterprise Virtualization 3.2 Administration Guide
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
WANDisableEffect
s
Disabled WAN
Effects value to
send to the SPICE
console
StringMultiple
animation
T he list of effects
which will be
disabled for
SPICE. Possible
values:
anim ation,
wallpaper,
font-sm ooth,
and all.
WANColorDepth
WAN Color Depth
value to send to
the SPICE console
Integer
16
T he color depth
used by the
SPICE. Possible
values are 16 and
32.
EnableSpiceRoot
CertificateValidatio
n
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.
EnableUSBAsDef
ault
Enable USB
devices
attachment to the
virtual machine by
default
String
true
-
EnableVdsLoadBa
lancing
Enables Host
Load Balancing
system
String
true
T his 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.
FreeSpaceCritical
LowInGB
Critical low disk
space alert
threshold (in GB)
Integer
5
Produces an alert
when a Storage
Domain has this
266
Chapter 15. Utilities
amount of space
left. T his 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.
HighUtilizationFor
EvenlyDistribute
High Utilization
Integer
Limit For Evenly
Distribute
selection algorithm
75
Maximum number
of virtual
machines per host
in the Evenly
Distribute
algorithm.
HighUtilizationFor
PowerSave
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.
LDAPQueryT imeo
ut
Read T imeout in
seconds for LDAP
queries
Integer
30
T he amount of
time an LDAP
query will read
before the query
is stopped.
LDAPOperationT i
meout
Search timeout at
LDAP server side
Integer
30
T he amount of
time an LDAP
search will
operate before it
is stopped.
LDAPConnectT im
eout
Connect timeout in
seconds for LDAP
queries
Integer
30
T he amount of
time an LDAP
query will connect
267
Red Hat Enterprise Virtualization 3.2 Administration Guide
before it is
stopped.
LocalAdminPassw
ord
Local
Administrator
Password
Password
Populated during
initial setup
T he password for
adm in@ local
default user.
LogPhysicalMemo
ryT hresholdInMB
T hreshold for
logging low host
memory in MB
Integer
1024
T he 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.
LowUtilizationForE
venlyDistribute
Low Utilization
Integer
Limit for Evenly
Distribute
selection algorithm
0
Minimum number
of virtual
machines per host
in the Evenly
Distribute
algorithm.
LowUtilizationForP
owerSave
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
T he MAC address
pool range to be
automatically
assigned to virtual
machines.
MaxDiskSize
Max size of newly
created disk (in
GB)
Integer
16384
T he maximum
size (in GB) for a
new virtual disk
image assigned to
virtual machines.
MaxMacsCountInP Maximum MAC
ool
Addresses count
in Pool
Integer
100000
Maximum number
of MAC
addresses
allowed in the
MAC pool.
MaxNumberofHost
sInStoragePool
Integer
250
Limits the
maximum number
of hosts assigned
to the clusters of
a single Data
Center. T his can
268
Maximum number
of hosts in
Storage Pool
Chapter 15. Utilities
be increased after
testing more
hosts, if
necessary.
MaxNumOfCpuPer
Socket
Maximum Number
of CPU per socket
Integer
16
Maximum number
of virtual CPU
cores that can be
assigned to a
single virtual CPU
socket.
MaxNumOfVMCpu
s
T otal 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).
MaxNumofVmSock
ets
Maximum number
of sockets per
virtual machine
Integer
16
Maximum number
of virtual CPU
sockets assigned
to a virtual
machine.
MaxRerunVmOnV
dsCount
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
(&quot;unable to start
VM&quot;) is reported.
MaxStorageVdsD
elayCheckSec
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.
MaxStorageVdsT i
meoutCheckSec
Maximum timeout
for last check of
domain in
seconds
Integer
30
When monitoring
storage, vdsmd on
the hosts reports
a &quot;lastCheck&quot;
value for each
domain. T his
setting is used to
decide whether
the last check
happened too
long ago and
domain is
considered in
error.
269
Red Hat Enterprise Virtualization 3.2 Administration Guide
MaxVDSMemOver
Commit
Max Host Memory
Over-Commit (%)
for virtual
desktops load
Integer
200
T he percentage of
memory
overcommit
permitted to occur
when using virtual
desktop loads.
MaxVdsMemOver
CommitForServers
Maximum Host
Memory OverCommit (%) for
Virtual Servers
load
Integer
150
T he percentage of
memory
overcommit
permitted to occur
when using virtual
server loads.
MaxVdsNameLen
gth
Max VDS name
length
Integer
255
Maximum name
length for a
Hypervisor host.
MaxVmNameLengt
hNonWindows
Maximum virtual
machine name
length for nonWindows
operating system
Integer
64
Maximum name
length for a nonWindows virtual
machine.
MaxVmNameLengt
hWindows
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.
VmPoolMaxSubse
quentFailures
Maximum number
of subsequent VM
creation failures
before giving up
Integer
3
T he maximum
number of
subsequent failed
virtual machine
creations that can
occur in a virtual
machine pool
before the
operation is
stopped.
NumberofFailedRu
nsOnVds
Number of Failed
Runs on Host
Integer
3
Number of
attempts to run
virtual machines
on hosts before
setting host
status to &quot;Error&quot;.
NumberOfVmsFor
T opSizeVms
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
270
Chapter 15. Utilities
tab. Will display
this amount of
virtual machines,
sorted by the
most storage
space per used
virtual machine.
NumberVmRefres
hesBeforeSave
Number of Virtual
Machine Data
Refreshes Before
Saving to
Database
Integer
5
T he number of
host monitor
iterations between
refreshing virtual
machines from
VDSM
(determines if
virtual machines
should be
refreshed one
upon each
iteration)
oVirtISOsReposito
ryPath
T he RHEV-H
installation files
path
String
/usr/share/rhevhypervisor
T he location of
RHEV-H ISO
images used for
upgrading
Hypervisor hosts.
ProductKey2003
Product Key (for
Windows 2003)
String
-
Windows serial
key to be used
with sysprepped
virtual machines
created from a
template.
ProductKey2003x
64
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.
ProductKey2008R
2
Product Key (for
Windows 2008
R2)
String
-
Windows serial
key to be used
with sysprepped
virtual machines
created from a
template.
ProductKey2008x
64
Product Key (for
Windows 2008
x64)
String
-
Windows serial
key to be used
with sysprepped
virtual machines
271
Red Hat Enterprise Virtualization 3.2 Administration Guide
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.
ProductKeyWindo
w7
Product Key (for
Windows 7)
String
-
Windows serial
key to be used
with sysprepped
virtual machines
created from a
template.
ProductKeyWindo
w7x64
Product Key (for
Windows 7 x64)
String
-
Windows serial
key to be used
with sysprepped
virtual machines
created from a
template.
ProductRPMVersi
on
Red Hat
Enterprise
Virtualization
Manger RPM
Version
String
Automatically
populated
T he PRM version
of the currently
used rhevm
package.
RDPLoginWithFQ
N
Connect to RDP
console with Fully
Qualified UserName
(user@domain)
String
true
-
SANWipeAfterDel
ete
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/uncheck
ed) of the &quot;wipe
after delete&quot;
check box in the
&quot;New Virtual Disk&quot;
dialog if the newlycreated Disk
belongs to a SAN
(FC/iSCSI) Data
Center (i.e. about
to be created on a
SAN storage
domain).
Integer
100
T he number of
results to return
for search queries
if no specific
figure is given in
the web
administration
SearchResultsLimi Max Quantity of
t
Search Results
272
Chapter 15. Utilities
portal or REST .
ServerRebootT im
eout
Host Reboot
T imeout (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
T he 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).
SpiceReleaseCur
sorKeys
Keyboard keys
combination that
causes the mouse
cursor to be
released from its
grab on SPICE
String
Shift+F12
-
SpiceSecureChan
nels
SPICE Secure
Channels
String
smain, sinputs,
scursor,
splayback,
srecord, sdisplay,
susbredir,
ssmartcard
Which SPICE
channels should
be secured with
SSL.
SpiceT oggleFullSc
reenKeys
Keyboard keys
combination that
toggles the fullscreen state of
SPICE client
window
String
Shift+F11
-
SpiceUsbAutoSha
re
Enable USB
devices sharing
by default in
SPICE
String
true
Represents the
default value
(checked/uncheck
ed) of the &quot;Enable
USB Auto-Share&quot;
check box in the
SPICE Console
Options dialog in
the User Portal.
SpmCommandFail
OverRetries
Number of retries
to failover the
Storage Pool
Manager on failed
Integer
3
Number of SPM
selection failover
retries. In case an
SPM command
273
Red Hat Enterprise Virtualization 3.2 Administration Guide
commands
fails, backend
performs a
failover - it selects
a new SPM and
re-runs the
command.
SPMFailOverAttem Number of
pts
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
SpmCommandFail
OverRetries). T his
setting defines the
number of retries
before deciding
that the current
SPM is down and
a failover is
required.
SpmVCpuConsum
ption
T he CPI
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.
SSHInactivityT ime
outSeconds
SSH Inactivity
T imeout (in
seconds)
Integer
600
T he maximum
amount of time
backend allows
for an SSH
session to remote
hosts. After this
timeout the
session is killed.
SSHInactivityHard
T imoutSeconds
SSH Inactivity
Hard T imeout (in
seconds)
Integer
-
NumberOfUSBSlot
s
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.
StorageDomainFai
Storage Domain
Integer
5
Defines the
274
Chapter 15. Utilities
lureT imeoutInMinu
tes
failure timeout
amount of time
taken before
deciding domain is
problematic,
starting at the first
failure reported by
VDSM (in
minutes).
StoragePoolRefre
shT imeInSeconds
Storage Pool
Manager Polling
Rate (in seconds)
Integer
10
Storage Pool
monitoring
frequency.
SysPrep2K3Path
Path to a Windows
2003 machine
sysprep file
string
/etc/ovirtengine/sysprep/sy
sprep.2k3
Path to the
operating system
specific sysprep
file template.
SysPrep2K8Path
Path to a Windows
2008 machine
sysprep file
string
/etc/ovirtengine/sysprep/sy
sprep.2k8x86
Path to the
operating system
specific sysprep
file template.
SysPrep2K8R2Pat
h
Path to a Windows
2008 R2 machine
sysprep file
string
/etc/ovirtengine/sysprep/sy
sprep.2k8
Path to the
operating system
specific sysprep
file template.
SysPrep2K8x64P
ath
Path to a Windows
2008 machine
sysprep file
string
/etc/ovirtengine/sysprep/sy
sprep.2k8
Path to the
operating system
specific sysprep
file template.
SysPrepWindows
7Path
Path to a Windows
7 machine
sysprep file
string
/etc/ovirtengine/sysprep/sy
sprep.w7
Path to the
operating system
specific sysprep
file template.
SysPrepWindows
7x64Path
Path to a Windows
7 x64 machine
sysprep file
string
/etc/ovirtengine/sysprep/sy
sprep.w7x64
Path to the
operating system
specific sysprep
file template.
SysPrepWindows
8Path
Path to a Windows
8 machine SysPrep file
String
/etc/ovirtengine/sysprep/sy
sprep.w8
Path to the
operating system
specific sysprep
file template.
SysPrepWindows
8x64Path
Path to a Windows
8 x64 machine
Sys-Prep file
String
/etc/ovirtengine/sysprep/sy
sprep.w8x64
Path to the
operating system
specific sysprep
file template.
SysPrepWindows
2012x64Path
Path to a Windows
2012 x64 machine
Sys-Prep file
String
/etc/ovirtengine/sysprep/sy
sprep.2k12x64
Path to the
operating system
specific sysprep
file template.
SysPrepXPPath
Path to a Windows
XP machine
sysprep file
string
/etc/ovirtengine/sysprep/sy
sprep.xp
Path to the
operating system
specific sysprep
file template.
275
Red Hat Enterprise Virtualization 3.2 Administration Guide
T imeoutT oResetV
dsInSeconds
Integer
60
T he amount of
time a host is
nonresponsive
before a fence
command is
issued. T his is
used in
conjunction with
VDSAttemptsToR
esetCount.
T imeT oReduceFai T ime to Reduce
ledRunOnVdsInMi Failed Run on
nutes
Host (in minutes)
Integer
30
T he amount of
time that the host
will be in Error
status after failing
to run virtual
machines.
UserDefinedVMPr
operties
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.
UtilizationT hresho
ldInPercent
T he Utilization
T hreshold (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. T his is
the percent of the
value that the
user set in highutilization in the
cluster.
ValidNumOfMonito
rs
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 RHEVM
-
VDSAttemptstoRe
setCount
Number of
attempts to
communicate with
Host before trying
to reset
Integer
2
T he amount of
times to retry
communications
with a host before
a fence command
is issued. Used in
conjunction with
TimeoutToReset
276
Communication
timeout in
seconds before
attempting reset
Chapter 15. Utilities
VdsInSeconds.
VdsLoadBalancing
IntervalInMinutes
Host Load
Balancing Interval
(in minutes)
Integer
1
T he interval
between running
the virtual
machines' load
balancer in
minutes (also
defines the first
invocation of the
load balancer).
VdsRecoveryT ime
outInMinutes
Host T imeout
when Recovering
(in minutes)
Integer
3
When VDSM
fails/restarts, it
can sometimes be
in recovering
mode (VDSM
reports
&quot;initializing&quot; or
&quot;recovering from
reports&quot;).
VdsRefreshRate
T ime interval in
seconds to poll a
Host's status
Integer
2
How often a
Hypervisor host's
status is checked.
vdsT imeout
Host Control
Communication
T imeout (in
seconds)
Integer
180
T imeout for a
VDSM call - the
time engine will
wait for sync call
to VDSM.
VMGracefulShutd
ownMessage
Message
displayed in
Virtual Machine
when Virtual
Machine is being
shut down from
Red Hat
Enterprise
Virtualization
Manager
String
T he Red Hat
Enterprise
Virtualization
Manager is
shutting down this
Virtual Machine
-
VMMinMemorySiz
eInMB
Minimal memory
size of virtual
machine in MB
Integer
256
-
VncKeyboardLayo
ut
Keyboard Layout
configuration for
VNC
String
en-us
Possible values:
ar, da, de-ch, enus, et, fo, fr-be, frch, hu, it, li, mk, nl,
no, pt, ru, sv, tr, de
en-gb, es, fi, fr, frca, hr, is, ja, lv, nlbe, pl, pt-br, sl, th.
WaitForVdsInitInS
ec
Wait for a host to
complete init in
SPM selection
Integer
60
T his is a timeout
for initializing host
as in
VdsRecoveryTim
277
Red Hat Enterprise Virtualization 3.2 Administration Guide
eoutInMinutes,
but this timeout is
shorter and is
used during the
SPM selection
algorithm. If the
selected host is
initialized, wait for
it to recover.
FenceQuietT imeB
etweenOperations
InSec
Quiet time
between Power
Management
operations in
seconds
Integer
180
T he minimum time
in seconds
between two
power
management
operations
activated manually
by a user.
MaxAuditLogMess
ageLength
Maximum length of
an Audit Log
message
Integer
10000
-
SysPrepDefaultUs
er
Default sysprep
user name
String
-
T his user is used
if the domain for
sysprep is
unknown or no
domain is
specified.
SysPrepDefaultPa
ssword
Default SysPrep
user password
Password
Empty
T his password is
used if the domain
for sysprep is
unknown or no
domain is
specified.
UserSessionT ime
OutInterval
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).
IPT ablesConfig
Iptables
configuration used
to autoconfigure
the Manager.
String
278
T he complete set
of iptables rules
that are used
when automatic
firewall
configuration is
selected during
rhevm-setup
Chapter 15. Utilities
OvirtIsoPrefix
oVirt ISOs files
prefix
String
rhevh
OvirtInitialSupport
edIsoVersion
oVirt node initial
Supported ISO
Version
String
5.8
VdsLocalDisksLo
wFreeSpace
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
recieving data, it
may make sense
to set this value
higher.
VdsLocalDisksCrit
icallyLowFreeSpac
e
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.
AllowDuplicateMac
Addresses
Enable duplicate
MAC address for
VM network
interface
String
false
If enabled, allows
that the same
MAC address be
set explicitly on
several virtual
279
Red Hat Enterprise Virtualization 3.2 Administration Guide
NICs. Otherwise,
setting a MAC
address that is
already in use on
another virtual NIC
is prohibited.
JobCleanupRateIn
Minutes
Frequency of jobs
clean-up process
Integer
10
SucceededJobCle
anupT imeInMinute
s
T ime to keep
successfully
ended jobs
Integer
10
FailedJobCleanup
T imeInMinutes
T ime to keep
failed jobs
Integer
60
VmPoolMonitorInte
rvalInMinutes
Interval in minutes
for monitoring
number of
Prestarted Vms in
Vm Pools
Integer
5
VmPoolMonitorBat
chSize
Maximum number
of Vms that the
Vm Pool Monitor
will attempt to
Prestart in a
single cycle
Integer
5
NetworkConnectivi T he time to wait
tyCheckT imeoutIn before rolling back
Seconds
network changes
in case the engine
losses
connectivity with
the host in
seconds
Integer
120
AllowClusterWithV
irtGlusterEnabled
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.
EnableMACAntiSp
oofingFilterRules
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
280
Chapter 15. Utilities
the engine.
EnableHostT imeD
rift
Indicates if host
time-drift validation
is enabled
String
false
EngineMode
Engine working
mode
String
Active
HostT imeDriftInSe
c
Allowed time drift
between any Host
and Engine
Integer
300
If time drift
validation is
enabled, the
Manager will
require that host
system time be
within a given
variation of the
Manager system
time. T he allowed
difference is set
by
HostT imeDriftInSe
c
Report a bug
15.3. Uploading Virtual Machine Images with the Image Uploader
Tool
15.3.1. Virtual Machine Image Uploader
Using the rhevm-image-uploader command, you can list export storage domains and upload virtual
machines in Open Virtualization Format (OVF) to an export storage domain and have them automatically
recognized in the Red Hat Enterprise Virtualization Manager. T he tool only supports gzip compressed
OVF files created by Red Hat Enterprise Virtualization.
T he image uploader makes creating distributable virtual machine images practical.
T he archive should contain 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
Report a bug
15.3.2. Syntax for the rhevm-image-uploader Command
T he basic syntax for the image uploader command is:
281
Red Hat Enterprise Virtualization 3.2 Administration Guide
rhevm-image-uploader [options] list
rhevm-image-uploader [options] upload [file].[file]...[file]
T he two supported modes of operation are list and upload.
T he list parameter lists the valid export storage domains available for image uploads.
T he upload parameter uploads selected image file(s) to the specified image storage domain.
T he image uploader command requires either the list or upload parameter be included for basic
usage. T he upload parameter requires a minimum of one local file name to upload.
T here are numerous parameters to further refine the rhevm -im age-uploader command. You can
set defaults for any of these in the /etc/ovirt-engine/im ageuploader.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. T he default is etc/ovirtengine/im ageuploader.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. T he USER is specified in the format
user@domain, where user is the user name and domain is the directory services domain in
use. T he 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
282
Chapter 15. Utilities
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:4 4 3.
Export Storage Domain Options
T hese options specify the export domain to which files are uploaded. T hey 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. T his 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.
T his 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.
Report a bug
15.3.3. Creating an OVF Archive That Is Compatible with the Image Uploader
Summary
You can create files that can be uploaded using the rhevm -im age-uploader tool.
Procedure 15.1. Creating an OVF Archive T hat is Compatible with the Image Uploader
1. Use the Manager to create an empty export domain. An empty export domain makes it easy to see
283
Red Hat Enterprise Virtualization 3.2 Administration Guide
which directory contains your virtual machine.
2. Export your virtual machine to the empty export domain you just created.
3. 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 im ages/ and m aster/
directories.
4. Run the tar -zcvf m y.ovf im ages/ m aster/ command to create the tar/gzip ovf archive.
5. Anyone you give the resulting ovf file to (in this example, called m y.ovf) can import it to Red Hat
Enterprise Virtualization Manager using the rhevm -im age-uploader command.
Result
You have created a compressed OVF image file that can be distributed. Anyone you give it to can use
the rhevm -im age-uploader command to upload your image into their Red Hat Enterprise
Virtualization environment.
Report a bug
15.3.4. Basic rhevm-image-uploader Usage Examples
Here is an example of how to use rhevm -im age-uploader to list storage domains:
Example 15.10. Uploading a file Using the rhevm-image-uploader T ool
# rhevm-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
T o 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:
# rhevm-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:
**********
Report a bug
15.4. Editing USB Filters with the USB Filter Editor
15.4.1. Installing the USB Filter Editor
Summary
T he USB Filter Editor is a Windows tool used to configure the usbfilter.txt policy file. T he 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. T he policy file resides
on the Red Hat Enterprise Virtualization Manager in the following location:
284
Chapter 15. Utilities
/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.m si file from the Red Hat Enterprise Virtualization
Manager (version.number x86_64 ) channel of the Red Hat Network.
Note
Refer to the Red Hat Enterprise Virtualization Manager Release Notes for specific channel names
current to your system.
Procedure 15.2. Installing the USB Filter Editor
1. On a Windows machine, launch the USBFilterEditor.m si installer obtained from Red Hat
Network.
2. 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 Editor or
C:\Program Files(x86)\RedHat\USB Filter Editor depending on your version of
Windows.
3. 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
T he default USB device policy provides virtual machines with basic access to USB devices; update the
policy to allow the use of additional USB devices.
Report a bug
15.4.2. The USB Filter Editor Interface
Double-click the USB Filter Editor shortcut icon on your desktop.
285
Red Hat Enterprise Virtualization 3.2 Administration Guide
Figure 15.1. Red Hat USB Filter Editor
T he 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.
T able 15.2. USB Editor Fields
Name
Description
Class
T ype of USB device; for example, printers, mass
storage controllers.
Vendor
T he manufacturer of the selected type of device.
Product
T he specific USB device model.
Revision
T he revision of the product.
Action
Allow or block the specified device.
T he USB device policy rules are processed in their listed order. Use the Up and Down buttons to move
devices higher or lower in the list. T he 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.
Report a bug
15.4.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.
286
Chapter 15. Utilities
Procedure 15.3. Adding a USB Policy
1. Click the Add button. T he Edit USB Criteria window opens:
Figure 15.2. Edit USB Criteria
2. Use the USB Class, Vendor ID, Product ID, and Revision check boxes and lists to specify
the device.
Click the Allow button to permit virtual machines use of the USB device; click the Block button to
prohibit the USB device from virtual machines.
Click OK to add the selected filter rule to the list and close the window.
287
Red Hat Enterprise Virtualization 3.2 Administration Guide
Example 15.11. Adding a Device
T he following is an example of how to add USB Class Sm artcard, device EP-14 27X-2
Ethernet Adapter, from manufacturer Acer Com m unications &amp; Multim edia to the
list of allowed devices.
3. Click File → Save 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.
Report a bug
15.4.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 15.4 . Removing a USB Policy
1. Select the policy to be removed.
288
Chapter 15. Utilities
Figure 15.3. Select USB Policy
2. Click Rem ove. A message displays prompting you to confirm that you want to remove the policy.
Figure 15.4 . Edit USB Criteria
3. Click Yes to confirm that you want to remove the policy.
4. Click File → Save to save the changes.
Result
289
Red Hat Enterprise Virtualization 3.2 Administration Guide
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.
Report a bug
15.4.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 15.5. Searching for USB Device Policies
1. Click Search. T he Attached USB Devices window displays a list of all the attached devices.
Figure 15.5. Attached USB Devices
2. Select the device and click Allow or Block as appropriate. Double-click the selected device to
close the window. A policy rule for the device is added to the list.
3. Use the Up and Down buttons to change the position of the new policy rule in the list.
4. Click File → Save 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.
Report a bug
290
Chapter 15. Utilities
15.4.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 15.6. Exporting a USB Policy
1. Click Export; the Save As window opens.
2. Save the file with a file name of usbfilter.txt.
3. Using a Secure Copy client, such as WinSCP, upload the usbfilter.txt file to the server
running Red Hat Enterprise Virtualization Manager. T he file must be placed in the following
directory on the server:
/etc/ovirt-engine/
4. As the root user on the server running Red Hat Enterprise Virtualization Manager, restart the
ovirt-engine service.
# service ovirt-engine restart
Result
T he USB device policy will now be implemented on virtual machines running in the Red Hat Enterprise
Virtualization environment.
Report a bug
15.4.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 15.7. Importing a USB Policy
1. Using a Secure Copy client, such as WinSCP, upload the usbfilter.txt file to the server
running Red Hat Enterprise Virtualization Manager. T he file must be placed in the following
directory on the server:
/etc/ovirt-engine/
2. Double-click the USB Filter Editor shortcut icon on your desktop to open the editor.
3. Click Im port to open the Open window.
4. Open the usbfilter.txt file that was downloaded from the server.
Result
You are able to edit the USB device policy in the USB Filter Editor.
Report a bug
291
Red Hat Enterprise Virtualization 3.2 Administration Guide
15.5. Collecting Logs with the Log Collector Tool
15.5.1. Log Collector
A log collection tool is included in the Red Hat Enterprise Virtualization Manager. T his allows you to
easily collect relevant logs from across the Red Hat Enterprise Virtualization environment when
requesting support.
T he log collection command is rhevm -log-collector. You are required to log in as the root user
and provide the administration credentials for the Red Hat Enterprise Virtualization environment. T he
rhevm -log-collector -h command displays usage information, including a list of all valid options
for the rhevm -log-collector command.
Report a bug
15.5.2. Syntax for rhevm-log-collector Command
T he basic syntax for the log collector command is:
rhevm-log-collector [options] list [all, clusters, datacenters]
rhevm-log-collector [options] collect
T he two supported modes of operation are list and collect.
T he list parameter 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.
T he collect parameter performs log collection from the Red Hat Enterprise Virtualization Manager.
T he collected logs are placed in an archive file under the /tm p/logcollector directory. T he
rhevm -log-collector command 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.
T here are numerous parameters to further refine the rhevm -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. T he default directory is
/tm p/logcollector.
292
Chapter 15. Utilities
--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 FT P. 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
T hese options filter the log collection and specify authentication details for the Red Hat Enterprise
Virtualization Manager.
T hese parameters can be combined for specific commands. For example, rhevm -log-collector -user=adm in@ internal --cluster ClusterA,ClusterB --hosts &quot;SalesHost&quot;* specifies
the user as adm in@ 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. T he USER is specified in the format user@domain, where user is
the user name and domain is the directory services domain in use. T he 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. T he cluster(s) for inclusion must be specified in a
comma-separated list of cluster names or match patterns.
293
Red Hat Enterprise Virtualization 3.2 Administration Guide
-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. T he 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. T he 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
T he 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. T he default is /var/lib/jbossas.
--java-home=JAVA_HOME
Java installation directory path. T he 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. T he 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. T he 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 on or off. T he
default is on.
--jboss-servjar=STATE
Sets collection of JAR statistics from any server configuration directories. Replace STATE with
on or off. T he default is on.
294
Chapter 15. Utilities
--jboss-twiddle=STATE
Sets collection of twiddle data on or off. T widdle is the JBoss tool used to collect data from the
JMX invoker. Replace STATE with on or off. T he default is on.
--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. T he default is 10.
PostgreSQL Database Options
T he pg-pass parameter includes the Red Hat Enterprise Virtualization Manager database in the log.
T he 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. T he 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. T he default is
postgres.
--pg-dbname=DBNAME
Sets DBNAME as the database name to use for connections with the database server. T he
default is rhevm .
--pg-dbhost=DBHOST
Sets DBHOST as the host name for the database server. T he default is localhost.
295
Red Hat Enterprise Virtualization 3.2 Administration Guide
--pg-host-key=KEYFILE
Sets KEYFILE as the public identity file (private key) for the database server. T his value is not
set by default; it is required only where the database does not exist on the local host.
Report a bug
15.5.3. Basic Log Collector Usage
In this example log collector is run to collect all logs from the Red Hat Enterprise Virtualization Manager
and the three attached hosts. Additionally the database and JBoss logs are also collected.
Example 15.12. Log Collector Usage
# rhevm-log-collector
Please provide the username for rhevm (CTRL+D to abort):
[email protected]
Please provide the password for rhevm (CTRL+D to abort):
Host list (datacenter=None, cluster=None, host=None):
Data Center
| Cluster
| Hostname/IP Address
SalesDataCenter
| SalesCluster
| 192.168.122.250
EngineeringDataCenter | EngineeringCluster
| 192.168.122.251
FinanceDataCenter
| FinanceCluster
| 192.168.122.252
# rhevm-log-collector collect
Please provide the username for rhevm (CTRL+D to abort):
[email protected]
Please provide the password for rhevm (CTRL+D to abort):
About to collect information from 3 hypervisors. Continue? (Y/n): Y
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
Please provide the password to dump the PostgreSQL database (CTRL+D to abort):
INFO: Gathering PostgreSQL the RHEV-M database and log files from localhost...
INFO: Gathering RHEV-M information...
Please provide the password for jboss (CTRL+D to abort):
INFO: Log files have been collected and placed in /tmp/logcollector/sosreportrhn-account-20110804121320-ce2a.tar.xz.
The MD5 for this file is 6d741b78925998caff29020df2b2ce2a and its size is
26.7M
Report a bug
15.6. Uploading ISO Files with the ISO Uploader Tool
15.6.1. ISO Uploader
T he 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.
T he ISO uploader command is rhevm -iso-uploader. You are required to log in as the root user
and provide the administration credentials for the Red Hat Enterprise Virtualization environment. T he
296
Chapter 15. Utilities
rhevm -iso-uploader -h command displays usage information, including a list of all valid options for
the rhevm -iso-uploader command.
Report a bug
15.6.2. Syntax for rhevm-iso-uploader Command
T he basic syntax for the ISO uploader command is:
rhevm-iso-uploader [options] list
rhevm-iso-uploader [options] upload [file].[file]...[file]
T he two supported modes of operation are list and upload.
T he list parameter lists the valid ISO storage domains available for ISO uploads. T he Red Hat
Enterprise Virtualization Manager sets this list on the local machine upon installation.
T he upload parameter uploads single or multiple space-separated ISO files to the specified ISO
storage domain. NFS is used as default; SSH is available.
T he ISO uploader command requires either the list or upload parameter be included for basic usage.
T he upload parameter requires a minimum of one local file name to upload.
T here are numerous parameters to further refine the rhevm -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.
297
Red Hat Enterprise Virtualization 3.2 Administration Guide
Red Hat Enterprise Virtualization Manager Options
-u USER, --user=USER
Sets the user associated with the file to be uploaded. T he USER is specified in the format
user@domain, where user is the user name and domain is the directory services domain in
use. T he 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
T hese options specify the ISO domain to which files are uploaded. T hey 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
T he ISO uploader uses NFS as default to upload files. T hese 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=USER if no key is set.
Report a bug
298
Chapter 15. Utilities
Example 15.13. Uploading to an NFS Server
# rhevm-iso-uploader --nfs-server=storage.demo.redhat.com:/iso/path upload
RHEL6.0.iso
Report a bug
15.6.4. Basic ISO Uploader Usage
T he example below demonstrates the ISO uploader and the list parameter. T he first command lists the
available ISO storage domains; the user name is requested because it was not provided in the
command. T he second command uploads an ISO file over NFS to the listed ISO domain: ISODom ain.
Example 15.14 . List Domains and Upload Image
# rhevm-iso-uploader list
Please provide the REST API username for RHEV-M (CTRL+D to abort):
[email protected]
Please provide the REST API password for RHEV-M (CTRL+D to abort):
ISO Storage Domain List:
ISODomain
# rhevm-iso-uploader --iso-domain=ISODomain upload RHEL6.iso
Please provide the REST API username for RHEV-M (CTRL+D to abort):
[email protected]
Please provide the REST API password for RHEV-M (CTRL+D to abort):
Report a bug
15.6.5. Uploading the VirtIO and Guest Tool Image Files to an ISO Storage
Domain
T he example below demonstrates the command to upload the virtio-win.iso, virtio-win.vfd,
and rhev-tools-setup.iso image files to the ISODom ain.
Example 15.15. Uploading the VirtIO and Guest T ool Image Files
# rhevm-iso-uploader --iso-domain=ISODomain upload /usr/share/virtiowin/virtio-win.iso /usr/share/virtio-win/virtio-win.vfd /usr/share/rhevguest-tools-iso/rhev-tools-setup.iso
Report a bug
15.6.6. VirtIO and Guest Tool Image Files
T he 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 T ools for Windows virtual machines, are copied to an ISO storage domain upon installation and
configuration of the domain.
T hese image files provide software that can be installed on virtual machines to improve performance
and usability. T he most recent virtio-win and rhev-tools-setup images are referred to by the following
symbolic links on the file system of the Red Hat Enterprise Virtualization Manager:
299
Red Hat Enterprise Virtualization 3.2 Administration Guide
/usr/share/virtio-win/virtio-win.iso
/usr/share/virtio-win/virtio-win.vfd
/usr/share/rhev-guest-tools-iso/rhev-tools-setup.iso
T hese image files must be manually uploaded to ISO storage domains that were not created locally by
the installation process. Use the rhevm -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.
Report a bug
15.7. Guest Drivers and Agents
15.7.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. T hey can be installed using the yum install rhevm -guest-agent
command.
Your guest must be subscribed to the Red Hat Enterprise Virt Agent channel to install
the agents.
In Red Hat Enterprise Enterprise Linux 5, this channel is labelled rhel-x86_64 -rhevagent-5-server. In Red Hat Enterprise Linux 6, the channel is labelled rhel-x86_64 rhev-agent-6-server.
Installing the agents and drivers on Windows guests
T he agents and drivers are installed on Windows virtual machines using the rhev-toolssetup.iso disk image. T he guest tools ISO is distributed using the Red Hat Network as
rhev-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-guesttools-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:
Section 15.7.4, “Subscribing to channels”
Section 15.7.2, “Automating Guest Additions on Windows Guests with Red Hat Enterprise
300
Chapter 15. Utilities
Virtualization Application Provisioning T ool(APT )”
Report a bug
15.7.2. Automating Guest Additions on Windows Guests with Red Hat Enterprise
Virtualization Application Provisioning Tool(APT)
Red Hat Enterprise Virtualization Application Provisioning T ool (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.
Report a bug
15.7.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. T he 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.
301
Red Hat Enterprise Virtualization 3.2 Administration Guide
T able 15.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. T he
driver complements the software
implementation of the virtiodevice used by the host to play
the role of a hardware device.
Server and Desktop.
virtio-serial
Virtio-serial provides support for
multiple serial ports. T he
improved performance is used
for fast communication between
the guest and the host that
avoids network complications.
T his 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 overcommitment. T he 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.
302
Chapter 15. Utilities
T able 15.4 . Red Hat Enterprise Virtualization Guest Agents and T ools
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.
Server and Desktop.
On Red Hat Enterprise Linux 6
and higher guests, the rhevguest-agent installs tuned on
your virtual machine and
configures it to use an
optimized, virtualized-guest
profile.
spice-agent
T he SPICE agent supports
multiple monitors and is
responsible for client-mousemode support to provide a
better user experience and
improved responsiveness than
the QEMU emulation. Cursor
capture is not needed in clientmouse-mode. T he 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. T he 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
Desktop.
303
Red Hat Enterprise Virtualization 3.2 Administration Guide
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.
Report a bug
15.7.4. Subscribing to channels
15.7.4 .1. Subscribing to Channels Using Subscription Manager
Summary
T o 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 15.8. Subscribing to Channels Using Subscription Manager
1. Run the subscription-m anager register command to register the system with Red Hat
Network. T o complete registration successfully you will need to supply your Red Hat Network
Usernam e and Password when prompted.
# subscription-manager register
2. Identify available entitlement pools
T o subscribe the system to channels, you must locate the identifiers for the relevant entitlement
pools. Use the list action of the subscription-m anager to find these.
For example, to identify available subscription pools for Red Hat Enterprise
Virtualization use the command:
# subscription-manager list --available | grep -A8 &quot;Red Hat Enterprise
Virtualization&quot;
3. 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. T he main channel is automatically enabled, other
channels in the entitlement must be enabled manually. Use the subscribe action of the
subscription-m anager command, replacing POOLID with one of the pool identifiers each time
the command is run:
# subscription-manager subscribe --pool=POOLID
4. 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. T he
additional channels must be enabled using the yum -config-m anager command as the root
user:
304
Chapter 15. Utilities
# yum-config-manager --enable CHANNEL
Result
T he system is now registered with Red Hat Network and subscribed to the channels required.
Report a bug
15.7.4 .2. Subscribing to channels using RHN Classic
Summary
T o install packages you must first register the target system to Red Hat Network and subscribe to the
software channels containing your packages.
Procedure 15.9. Subscribing to the channels using RHN Classic
1. Run the rhn_register command to register the system with Red Hat Network. T o complete
registration successfully you will need to supply your Red Hat Network username and password.
Follow the onscreen prompts to complete registration of the system.
# rhn_register
2. 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 line rhn-channel command.
A. Using the rhn-channel Command
Run the rhn-channel command to subscribe the system to each of the required channels.
T he commands which need to be run are:
# rhn-channel --add --channel=CHANNEL
305
Red Hat Enterprise Virtualization 3.2 Administration Guide
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 the rhn-channel
command 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 using rhn-channel then to add the channel to the
system you must use the web user interface.
B. Using the Web Interface to Red Hat Network
T o add a channel subscription to a system from the web interface:
a. Log on to Red Hat Network (http://rhn.redhat.com).
b. Move the mouse cursor over the Subscriptions link at the top of the screen, and
then click the Registered System s link in the menu that appears.
c. Select the system to which you are adding channels from the list presented on the
screen, by clicking the name of the system.
d. Click Alter Channel Subscriptions in the Subscribed Channels section of
the screen.
e. Select the channels to be added from the list presented on the screen.
f. Click the Change Subscription button to finalize the change.
Result
T he system is now registered with Red Hat Network and subscribed to the channels required.
Report a bug
306
Chapter 16. Log Files
Chapter 16. Log Files
16.1. Red Hat Enterprise Virtualization Manager Installation Log
Files
T able 16.1. Installation
Log File
Description
/var/log/ovirt-engine/enginecleanup_yyyy_mm_dd_hh_mm_ss.log
Log from the engine-cleanup command. T his
is the command used to reset a Red Hat
Enterprise Virtualization Manager installation. A
log is generated each time the command is run.
T he date and time of the run is used in the
filename to allow multiple logs to exist.
/var/log/ovirt-engine/engine-dbinstall-yyyy_mm_dd_hh_mm_ss.log
Log from the rhevm -setup command detailing
the creation and configuration of the rhevm
database.
/var/log/ovirt-engine/rhevm -dwhsetup-yyyy_mm_dd_hh_mm_ss.log
Log from the rhevm -dwh-setup command. T his
is the command used to create the
rhevm _history database for reporting. A log is
generated each time the command is run. T he
date and time of the run is used in the filename to
allow multiple logs to exist concurrently.
/var/log/ovirt-engine/ovirt-enginereports-setup-yyyy_mm_dd_hh_mm_ss.log
Log from the rhevm -reports-setup command.
T his is the command used to install the Red Hat
Enterprise Virtualization Manager Reports
modules. A log is generated each time the
command is run. T he date and time of the run is
used in the filename to allow multiple logs to exist
concurrently.
/var/log/ovirt-engine/enginesetup_yyyy_mm_dd_hh_mm_ss.log
Log from the rhevm -setup command. A log is
generated each time the command is run. T he
date and time of the run is used in the filename to
allow multiple logs to exist concurrently.
/var/log/ovirt-engine/ovirt-engineupgrade_yyyy_mm_dd_hh_mm_ss.log
Log from the rhevm -upgrade command. A log is
generated each time the command is run. T he
date and time of the run is used in the filename to
allow multiple logs to exist concurrently.
Report a bug
16.2. Red Hat Enterprise Virtualization Manager Log Files
307
Red Hat Enterprise Virtualization 3.2 Administration Guide
T able 16.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.
Report a bug
16.3. Red Hat Enterprise Virtualization Host Log Files
T able 16.3. Installation
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. T he 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).
/tm p/ovirt-host-deploy-@[email protected]
Host deployment log, copied to engine as
/var/log/ovirt-engine/host-deploy/ovirt-@DATE@@HOST@-@[email protected] after the host
has been successfully deployed.
Report a bug
16.4. Remotely Logging Host Activities
16.4.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.
T his 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 16.1. Setting up a Virtualization Host Logging Server
1. Configure SELinux to allow rsyslog traffic.
# semanage port -a -t syslogd_port_t -p udp 514
2. Edit /etc/rsyslog.conf and add below lines:
308
Chapter 16. Log Files
$template TmplAuth, &quot;/var/log/%fromhost%/secure&quot;
$template TmplMsg, &quot;/var/log/%fromhost%/messages&quot;
authpriv.*
?TmplAuth
*.info,mail.none;authpriv.none,cron.none
?TmplMsg
Un-comment the following:
#$ModLoad imudp
#$UDPServerRun 514
3. Restart the rsyslog service:
# service rsyslog restart
Result
Your centralized log server is now configured to receive and store the m essages and secure logs from
your virtualization hosts.
Report a bug
16.4.2. Configuring Red Hat Enterprise Virtualization Hypervisor Hosts to Use a
Logging Server
Prerequisites:
Section 16.4.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.
Use this procedure on a Red Hat Enterprise Virtualization Hypervisor host to begin sending log files to
your centralized log server.
Procedure 16.2. Configuring Red Hat Enterprise Virtualization Hypervisor Hosts to Use a
Logging Server
1. Log in to your Red Hat Enterprise Virtualization Hypervisor host as adm in to access the
Hypervisors text user interface (T UI) setup screen.
2. Select Logging from the list of options on the left of the screen.
3. Press the T ab key to reach the text entry fields. Enter the IP address or FQDN of your centralized
log server and the port it uses.
4. Press the T ab key to reach the Apply, and press the Enter Key.
Result
Your Red Hat Enterprise Virtualization Hypervisor host has been configured to send messages to a
centralized log server.
Report a bug
16.4.3. Configuring Red Hat Enterprise Linux Hosts to Use a Logging Server
309
Red Hat Enterprise Virtualization 3.2 Administration Guide
Prerequisites:
Section 16.4.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.
Use this procedure on your Red Hat Enterprise Linux host to configure it to send logs to your centralized
log server.
Procedure 16.3. Configuring Red Hat Enterprise Linux Hosts to Use a Logging Server
1. Ensure that you have rsyslog installed:
# rpm -qi rsyslog
If rsyslog is not installed, install it:
# yum install rsyslog
2. Edit /etc/rsyslog.conf, and specify the address of your centralized log server by adding the
following:
*.*
@@YOURSERVERADDRESS:YOURSERVERPORT
For example:
*.*
@@192.168.20.254:514
Or:
*.*
@@log-server.company.com:514
T he @ @ specifies the T CP protocol for transmission. Use a single @ to specify UDP.
3. Restart the rsyslog service:
# service rsyslog restart
Result
Your Red Hat Enterprise Linux host now sends log messages to your centralized log server.
Report a bug
310
Chapter 17. Updating the Red Hat Enterprise Virtualization Environment
Chapter 17. Updating the Red Hat Enterprise Virtualization
Environment
17.1. Upgrades between Minor Releases
17.1.1. Checking for Red Hat Enterprise Virtualization Manager Updates
Summary
Use the rhevm -check-update command, included in Red Hat Enterprise Virtualization Manager, to
check for updates.
Procedure 17.1. Checking for Red Hat Enterprise Virtualization Manager Updates
1. Run rhevm -check-update as the root user.
# rhevm-check-update
2. A. Where no updates are available the command will output the text No updates available.
# rhevm-check-update
Loaded plugins: product-id, versionlock
Checking for updates... (This may take several minutes)
No updates available
B. Where updates are available the command will list the packages to be updated.
# rhevm-check-update
Loaded plugins: product-id
Checking for updates... (This may take several minutes)
10 Updates available:
* rhevm-3.2.0-10.14.beta1.el6ev.noarch
* rhevm-backend-3.2.0-10.14.beta1.el6ev.noarch
* rhevm-config-3.2.0-10.14.beta1.el6ev.noarch
* rhevm-dbscripts-3.2.0-10.14.beta1.el6ev.noarch
* rhevm-genericapi-3.2.0-10.14.beta1.el6ev.noarch
* rhevm-notification-service-3.2.0-10.14.beta1.el6ev.noarch
* rhevm-restapi-3.2.0-10.14.beta1.el6ev.noarch
* rhevm-tools-common-3.2.0-10.14.beta1.el6ev.noarch
* rhevm-userportal-3.2.0-10.14.beta1.el6ev.noarch
* rhevm-webadmin-portal-3.2.0-10.14.beta1.el6ev.noarch
Result
You have successfully checked for Red Hat Enterprise Virtualization Manager updates.
Report a bug
17.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
311
Red Hat Enterprise Virtualization 3.2 Administration Guide
the most recent version of the Red Hat Enterprise Virtualization — Release Notes, and the Red Hat
Enterprise Virtualization — Technical Notes. T o complete an upgrade a number of actions must be
performed including:
stopping the ovirt-engine service,
downloading and installing the updated packages,
backing up and updating the database,
performing post installation configuration, and
restarting the ovirt-engine service.
A script is included to perform these actions for you in an automated fashion. Active virtualization hosts
are not upgraded by this process and must be updated separately. As a result the virtual machines
running upon them are not affected. All commands in this task must be run while logged into the system
hosting Red Hat Enterprise Virtualization Manager as the root user.
Procedure 17.2. Updating Red Hat Enterprise Virtualization Manager
1. Run the yum command to update the rhevm-setup package.
# yum update rhevm-setup
2. Run the rhevm -upgrade command to update the Red Hat Enterprise Virtualization Manager.
# rhevm-upgrade
Note
Be aware that the upgrade process may take some time. Allow time for the upgrade
process to complete and do not stop it once initiated. Once the upgrade has been
completed you will also be instructed to separately upgrade the data warehouse and
reports functionality. T hese additional steps are only required if these optional packages
are installed.
Result
You have successfully updated Red Hat Enterprise Virtualization Manager.
Report a bug
17.1.3. Updating Red Hat Enterprise Virtualization Manager Reports
Summary
T he Red Hat Enterprise Virtualization Manager Reports must be updated separately to the Red Hat
Enterprise Virtualization Manager. T his 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 17.3. Updating Red Hat Enterprise Virtualization Manager Reports
1. Use the yum command to update the rhevm-reports and rhevm-dwh packages.
312
Chapter 17. Updating the Red Hat Enterprise Virtualization Environment
# yum update -y rhevm-reports rhevm-dwh
2. Run the rhevm -dwh-setup command to update the rhevm _history database.
# rhevm-dwh-setup
3. Run the rhevm -reports-setup command to update the reporting engine.
# rhevm-reports-setup
Result
You have successfully updated the Red Hat Enterprise Virtualization Manager Reports.
Report a bug
17.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. T his 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 17.4 . Updating Red Hat Enterprise Virtualization Hypervisors
1. Log in to the system hosting Red Hat Enterprise Virtualization Manager as the root user.
2. Ensure that:
the system is subscribed to the Red Hat Enterprise Virtualization entitlement — if
using certificate-based Red Hat Network; or
the system is subscribed to the Red Hat Enterprise Virtualization Hypervisor
(v.6 x86-64 ) (labeled rhel-x86_64 -server-6-rhevh) — if using classic Red Hat
313
Red Hat Enterprise Virtualization 3.2 Administration Guide
Network.
3. Run the yum command with the update rhev-hypervisor parameters to ensure that you have
the most recent version of the rhev-hypervisor package installed.
# yum update rhev-hypervisor
4. Use your web browser to log in to the Administration Portal as a Red Hat Enterprise Virtualization
administrative user.
5. 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.
6. With the host selected, click the General tab on the Details pane.
A. If the host requires updating, an alert message indicates that a new version of the Red Hat
Enterprise Virtualization Hypervisor is available.
B. If the host does not require updating, no alert message is displayed and no further action is
required.
7. Ensure the host remains selected and click the Maintenance button, if the host is not already in
maintenance mode. T his 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. T he 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.
8. Ensure that the host remains selected, and that you are on the General tab of the the Details
pane. Click the Upgrade link. T he Install Host dialog box displays.
9. Select rhev-hypervisor.iso, which is symbolically linked to the most recent hypervisor image.
10. Click OK to update and re-install the host. T he dialog closes, the details of the host are updated in
the Hosts tab, and the status changes.
T he host status will transition through these stages:
Installing,
Reboot,
Non Responsive, and
Up.
T hese are all expected, and each stage will take some time.
11. 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 Activate 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.
Report a bug
314
Chapter 17. Updating the Red Hat Enterprise Virtualization Environment
17.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 17.5. Updating Red Hat Enterprise Linux Virtualization Hosts
1. On the administration portal, navigate to the Hosts tab and select the host to be updated. Click
Maintenance to place it into maintenance mode.
2. On the Red Hat Enterprise Linux virtualization host, run the yum command with the update
parameter to update all installed packages.
# yum update
3. 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.
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.
Report a bug
17.1.6. Updating the Red Hat Enterprise Virtualization Guest Tools
Summary
T he guest tools allow the Manager to communicate with running guests, providing information like IP
addresses, memory usage, and installed applications for display in the Administration Portal. T he guest
tools are distributed as an ISO file that can be attached to guests. T he ISO file is packaged as an RPM
file, that can be installed and upgraded on registered Red Hat Enterprise Manager servers.
Procedure 17.6. Updating the Red Hat Enterprise Virtualization Guest T ools
1. On the Manager, as root user, use the yum upgrade to upgrade the rhev-guest-tools-iso
package.
# yum update -y rhev-guest-tools-iso*
2. When the rhev-guest-tools-iso package has been successfully upgraded, use the rhevm iso-uploader to upload it to your ISO storage domain. Replace ISODomain with the name of
your ISO storage domain.
rhevm-iso-uploader --iso-domain=ISODomain upload /usr/share/rhev-guest-toolsiso/rhev-tools-setup.iso
T he rhev-tools-setup.iso file is actually a link to the most recently updated ISO file. T he link
is automatically changed to point to the newest ISO file every time you upgrade the rhev-guesttools-iso package.
315
Red Hat Enterprise Virtualization 3.2 Administration Guide
3. 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.
Report a bug
17.2. Upgrading to Red Hat Enterprise Virtualization 3.2
17.2.1. Upgrading to Red Hat Enterprise Virtualization Manager 3.2
Prerequisites:
Section 17.2.2, “Upgrading to Red Hat Enterprise Virtualization Manager 3.1”
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 17.7. Upgrading to Red Hat Enterprise Virtualization Manager 3.2
1. 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. T his procedure assumes that the system is
already subscribed to required channels and entitlements to receive Red Hat Enterprise
Virtualization 3.1 packages. T hese must also be available to complete the upgrade process.
Certificate-based Red Hat Network
T he Red Hat Enterprise Virtualization 3.2 packages are provided by the rhel-6-serverrhevm -3.2-rpm s repository associated with the Red Hat Enterprise Virtualization
entitlement. Use the yum -config-m anager command to enable the repository in your yum
configuration. T he yum -config-m anager command must be run while logged in as the root
316
Chapter 17. Updating the Red Hat Enterprise Virtualization Environment
user.
# yum-config-manager --enable rhel-6-server-rhevm-3.2-rpms
Red Hat Network Classic
T he Red Hat Enterprise Virtualization 3.2 packages are provided by the Red Hat Enterprise
Virtualization Manager (v.3.2 x86_64 ) channel, also referred to as rhel-x86_64 server-6-rhevm -3.2 in Red Hat Network Classic.
rhn-channel --add --channel=rhel-x86_64-server-6-rhevm-3.2
Use the rhn-channel command, or the Red Hat Network Web Interface, to subscribe to the Red
Hat Enterprise Virtualization Manager (v.3.2 x86_64 ) channel.
2. Update the rhevm-setup Package
T o ensure that you have the most recent version of the rhevm -upgrade command installed you
must update the rhevm-setup package. Log in as the root user and use yum to update the
rhevm-setup package.
# yum update rhevm-setup
3. Run the rhevm -upgrade Command
T o upgrade Red Hat Enterprise Virtualization Manager run the rhevm -upgrade command. You
must be logged in as the root user 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)
4. 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.
T o resolve this issue you must migrate the IdM configuration to another system before reattempting 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. T o 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.
Report a bug
317
Red Hat Enterprise Virtualization 3.2 Administration Guide
17.2.2. 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-virtualizationmanager-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 17.8. Upgrading to Red Hat Enterprise Virtualization Manager 3.1
1. Add JBoss Enterprise Application Platform 6 Subscription
Ensure that the system is subscribed to the required channels and entitlements to receive JBoss
Enterprise Application Platform 6 packages. JBoss Enterprise Application Platform 6 is a required
dependency of Red Hat Enterprise Virtualization Manager 3.1.
Certificate-based Red Hat Network
T he JBoss Enterprise Application Platform 6 packages are provided by the JBoss Enterprise
Application Platform entitlement in certificate-based Red Hat Network.
Use the subscription-m anager command to ensure that the system is subscribed to the
JBoss Enterprise Application Platform entitlement.
# subscription-manager list
Red Hat Network Classic
318
Chapter 17. Updating the Red Hat Enterprise Virtualization Environment
T he JBoss Enterprise Application Platform 6 packages are provided by the JBoss
Application Platform (v 6) for 6Server x86_64 channel, also referred to as
jbappplatform -6-x86_64 -server-6-rpm , in Red Hat Network Classic. T he Channel
Entitlement Name for this channel is JBoss Enterprise Application Platform (v 4 ,
zip form at).
Use the rhn-channel command, or the Red Hat Network Web Interface, to subscribe to the
JBoss Application Platform (v 6) for 6Server x86_64 channel.
2. 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 Network
T he Red Hat Enterprise Virtualization 3.1 packages are provided by the rhel-6-serverrhevm -3.1-rpm s repository associated with the Red Hat Enterprise Virtualization
entitlement. Use the yum -config-m anager command to enable the repository in your yum
configuration. T he yum -config-m anager command must be run while logged in as the root
user.
# yum-config-manager --enable rhel-6-server-rhevm-3.1-rpms
Red Hat Network Classic
T he Red Hat Enterprise Virtualization 3.1 packages are provided by the Red Hat Enterprise
Virtualization Manager (v.3.1 x86_64 ) channel, also referred to as rhel-x86_64 server-6-rhevm -3.1 in Red Hat Network Classic.
Use the rhn-channel command, or the Red Hat Network Web Interface, to subscribe to the Red
Hat Enterprise Virtualization Manager (v.3.1 x86_64 ) channel.
3. 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 Manager 3.0 channels and entitlements.
Certificate-based Red Hat Network
Use the yum -config-m anager command to disable the Red Hat Enterprise Virtualization 3.0
repositories in your yum configuration. T he yum -config-m anager command must be run while
logged in as the root user.
# 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 Classic
Use the rhn-channel command, or the Red Hat Network Web Interface, to remove the Red Hat
Enterprise Virtualization Manager (v.3.0 x86_64 ) channels.
# rhn-channel --remove --channel=rhel-6-server-rhevm-3
319
Red Hat Enterprise Virtualization 3.2 Administration Guide
4. Update the rhevm-setup Package
T o ensure that you have the most recent version of the rhevm -upgrade command installed you
must update the rhevm-setup package. Log in as the root user and use yum to update the
rhevm-setup package.
# yum update rhevm-setup
5. Run the rhevm -upgrade Command
T o upgrade Red Hat Enterprise Virtualization Manager run the rhevm -upgrade command. You
must be logged in as the root user 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)
6. 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.
T o resolve this issue you must migrate the IdM configuration to another system before reattempting the upgrade. For further information see
https://access.redhat.com/knowledge/articles/233143.
7. A list of packages that depend on JBoss Enterprise Application Platform 5 is displayed. T hese
packages must be removed to install 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 enter yes to proceed with the upgrade, removing the listed packages.
Result
Your Red Hat Enterprise Virtualization Manager installation has now been upgraded. T o 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:
Section 17.1.4, “Updating Red Hat Enterprise Virtualization Hypervisors”
320
Chapter 17. Updating the Red Hat Enterprise Virtualization Environment
Section 17.1.5, “Updating Red Hat Enterprise Linux Virtualization Hosts”
Section 17.2.3, “Changing the Cluster Compatibility Version”
Section 17.2.4, “Changing the Data Center Compatibility Version”
Report a bug
17.2.3. Changing the Cluster Compatibility Version
Prerequisites:
Section 17.1.4, “Updating Red Hat Enterprise Virtualization Hypervisors”
Section 17.1.5, “Updating Red Hat Enterprise Linux Virtualization Hosts”
Summary
Red Hat Enterprise Virtualization clusters have a compatibility version. T he compatibility version
indicates the version of Red Hat Enterprise Virtualization that the cluster is intended to be compatible
with. All hosts in the cluster must support the desired compatibility level.
Procedure 17.9. Changing the Cluster Compatibility Version
1. Log in to the Administration Portal as the administrative user. By default this is the adm in user.
2. Click the Hosts tab.
3. Select all the hosts from the cluster you wish to change.
4. Click the Maintenance button to put the hosts in maintenance mode.
5. Click the Clusters tab.
6. 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.
7. Click the Edit button.
8. Change the Com patibility Version to the desired value.
9. Click OK.
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.
Report a bug
17.2.4. Changing the Data Center Compatibility Version
Prerequisites:
Section 17.2.3, “Changing the Cluster Compatibility Version”
Summary
Red Hat Enterprise Virtualization data centers have a compatibility version. T he 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 17.10. Changing the Data Center Compatibility Version
1. Log in to the Administration Portal as the administrative user. By default this is the adm in user.
321
Red Hat Enterprise Virtualization 3.2 Administration Guide
2. A.
a. If you can endure virtual machine downtime, you will put all of your hosts in maintenance
mode at once. Click the Hosts tab.
b. Select all the hosts from the data center you wish to change.
c. Click the Maintenance button to put the hosts in maintenance mode.
B. Upgrade each cluster's compatibility level individually before upgrading the data center's
compatibility level if you cannot put all of your hosts into maintenance mode at once.
T his process is described in Changing the Cluster Compatibility Version.
3. Click the Data Centers tab.
4. 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.
5. Click the Edit button.
6. Change the Com patibility Version to the desired value.
7. Click OK.
Result
You have updated the compatibility version of the data center.
Report a bug
322
Chapter 18. Backups
Chapter 18. Backups
18.1. Backing Up the Engine Database Using the backup.sh Script
Summary
T he 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 18.1. Backing up the engine database using the backup.sh script
1. Change into the /usr/share/ovirt-engine/dbscripts/ directory.
2. Invoke backup.sh with the -h parameter to see the available options.
Usage: backup.sh [-h] [-s SERVERNAME] [-p PORT] [-d DATABASE] [-l DIR] -u
USERNAME [-v]
-s
-p
-d
-u
-v
-l
-h
SERVERNAME
PORT
DATABASE
USERNAME
DIR
-
The database servername for the database (def. localhost)
The database port for the database
(def. 5432)
The database name
(def. engine)
The username for the database.
Turn on verbosity (WARNING: lots of output)
Backup file directory.
This help text.
for more options please run pg_dump --help
3. Invoke the backup.sh command again with parameters appropriate for your environment. If you
are backing up the local engine database, the -s, -p, and -d parameters are not necessary.
Use the -l to specify the backup directory. T his will cause a .sql file to be created in the
directory you give.
4. Copy the .sql you 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.
Report a bug
18.2. Restoring the Engine Database Using the restore.sh Script
Summary
T he 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.
323
Red Hat Enterprise Virtualization 3.2 Administration Guide
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 18.2. Restoring the Engine Database Using the restore.sh Script
1. Change into the /usr/share/ovirt-engine/dbscripts/ directory.
2. Invoke restore.sh with the -h parameter to see the available options.
Usage: restore.sh [-h] [-s SERVERNAME] [-p PORT] -u USERNAME -d DATABASE -f
FILE [-r]
-s
-p
-u
-d
-f
-r
-h
SERVERNAME
PORT
USERNAME
DATABASE
File
-
The database servername for the database (def. localhost)
The database port for the database
(def. 5432)
The username for the database.
The database name
Backup file name to restore from.
Remove existing database with same name
This help text.
for more options please run pg_restore --help
3. Invoke the restore.sh command again with parameters appropriate for your environment. If you
are restoring the local engine database, the -s and -p parameters are not necessary. Use the d to specify name of the database you are creating. Red Hat Enterprise Virtualization expects a
primary database named engine. Use the -f to specify the .sql file you are restoring from.
Result
You have used the restore.sh script to restore your engine database.
Report a bug
18.3. Backing Up Manager Configuration Files
T he Red Hat Enterprise Virtualization Manager stores customized configurations as configuration files.
T hese 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.
324
Chapter 18. Backups
T able 18.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/rhevm002dadmin.xml
Contains plain-text, unencrypted 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.
Report a bug
18.4. Restoring Red Hat Enterprise Virtualization Manager
Configuration Files
Prerequisites:
325
Red Hat Enterprise Virtualization 3.2 Administration Guide
Section 18.3, “Backing Up Manager Configuration Files”
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 18.3. Restoring Red Hat Enterprise Virtualization Manager Configuration Files
1. Stop the Engine service:
# service ovirt-engine stop
2. Completely remove all previous installations of the Red Hat Enterprise Virtualization Manager:
# yum remove rhevm
3. Remove /etc/pki/ovirt-engine:
# rm -rf /etc/pki/ovirt-engine
4. Remove the main rhevm directory:
# rm -rf /etc/ovirt-engine
5. Install the Red Hat Enterprise Virtualization Manager:
# yum install -y rhevm
6. Run rhevm-setup, giving the same answers as when you originally installed rhevm:
# rhevm-setup
Your answers can be found in /var/log/engine-setup-SETUP-DATE.log, which you backed
up.
7. Stop the Engine service, which was restarted as a part of the previous command:
# service ovirt-engine stop
8. Restore the backed up configuration files to their original locations.
9. Make sure the ownership of the .keystore file is correct:
# chown ovirt:ovirt /etc/pki/ovirt-engine/.keystore
10. Make sure the permissions of the notifier.conf file is correct:
# chmod 640 /etc/ovirt-engine/notifier/notifier.conf
326
Chapter 18. Backups
11. 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.
Report a bug
327
Red Hat Enterprise Virtualization 3.2 Administration Guide
Part III. Gathering Information About the Environment
328
Chapter 19. Reports, History D atabase Reports, and D ashboards
Chapter 19. Reports, History Database Reports, and
Dashboards
19.1. Reports
19.1.1. Reports
Red Hat Enterprise Virtualization includes a comprehensive management history database, which any
reporting application utilizes to generate a range of reports at data center, cluster and host levels. T his
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. T racking 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
T he replication of data in the ovirt_engine_history database is performed by the Red Hat
Enterprise Virtualization Manager Extract T ransform Load Service, ovirt-engine-dwhd. T he
service is based on T alend Open Studio, a data integration tool. T his 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.
T he ovirt-engine-dwhd service must not be stopped.
T he ovirt_engine_history database schema changes over time. T he 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. T he database stores the definition of a view as a
SELECT statement. T he 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.
Report a bug
19.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, RT F, 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.
329
Red Hat Enterprise Virtualization 3.2 Administration Guide
Report a bug
19.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. T his section provides information on the
reports available for Red Hat Enterprise Virtualization and the customizations that integrate
JasperServer with Red Hat Enterprise Virtualization. T o navigate to the online help facility, click on Help
in the top right-hand corner of the browser.
Figure 19.1. Red Hat Enterprise Virtualization Reports online help
Report a bug
19.1.4. Jasper Reports System Requirements
T he 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
Report a bug
19.1.5. Users in the Red Hat Enterprise Virtualization Reports Portal
T he Red Hat Enterprise Virtualization Reports Portal does not use your directory server for
authentication.
By default, there are two Reports Portal users: rhevm -adm in and superuser. T he 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. T his user cannot login to the Reports Portal directly, but is able to view all the reports
accessible from the Administration portal.
Report a bug
19.1.6. Logging in to Access the Reports Portal
You were prompted to set a password for the superuser and rhevm -adm in accounts when you
installed Red Hat Enterprise Virtualization Reports. Red Hat Enterprise Virtualization Reports does not
provide default passwords.
T o access reports, navigate to the reports portal at: https://YOUR.MANAGER.URL/rhevm reports/login.htm l. A login screen for Red Hat Enterprise Virtualization Reports is displayed.
330
Chapter 19. Reports, History D atabase Reports, and D ashboards
Note
You can also access the reports portal from your Red Hat Enterprise Virtualization landing page.
Figure 19.2. Red Hat Enterprise Virtualization Reports login screen
Enter your login credentials. If this is the first time you are connecting to the reports portal, log in as
ovirt-user. Click the Login button.
Figure 19.3. Red Hat Enterprise Virtualization Reports main screen
331
Red Hat Enterprise Virtualization 3.2 Administration Guide
T he Reports Portal does not use your directory service for authentication. By default, the Reports Portal
includes two users: rhevm -adm in and superuser. Generally, additional users need to be created
within the Reports Portal.
Report a bug
19.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 -adm in.
1. In to Red Hat Enterprise Virtualization reports portal, hover over the Manage button on the top
menu bar.
2. Click on Users in the drop-down menu that appears to access the Manage Users interface. It
contains three panes:
Organizations
Users
Properties
3. Select a user in the Users pane by clicking on the name of the user. Information about the user
displays in the Properties pane.
4. Click the Edit button at the bottom of the user's Properties pane.
T he Properties pane contains these fields:
User nam e,
User ID,
Em ail,
Password (required),
Confirm Password (required),
A User is enabled check box,
A T he user is defined externally check box,
A list of Roles Available to the user, and
A list of Roles Assigned to the user.
5. Click the Save button.
Result
You have given more users permissions to access the reports portal.
Report a bug
19.1.8. Reports Portal User Roles
T here are three roles, each of which provides a different level of permissions:
1. ROLE_ADMINIST RAT OR - Can create/edit/delete reports, dashboards, ad hoc reports, and
manage the server.
332
Chapter 19. Reports, History D atabase Reports, and D ashboards
2. ROLE_USER - Can create/edit/delete ad hoc reports and view reports and dashboards.
3. 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.
Figure 19.4 . JasperReports user roles
Report a bug
19.1.9. Navigating Reports and Dashboards
Select the View Reports button on the reports portal home page.
Figure 19.5. Red Hat Enterprise Virtualization Reports home screen
You can use the smaller Hom e (
return to this page.
) button in the navigation bar at the top of the reports portal to
Use the Filter pane on the left of the screen to select a subset of reports you would like to view.
333
Red Hat Enterprise Virtualization 3.2 Administration Guide
Figure 19.6. Red Hat Enterprise Virtualization Reports Filter pane
You can use filters to select from the available reports.
T able 19.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.
T im efram e
Choose a time frame you'd like to see information
from.
Schedule
Filter by data collection schedule.
334
Chapter 19. Reports, History D atabase Reports, and D ashboards
Report a bug
19.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.
T o view the required parameters for a report, click the report in the reports list.
Figure 19.7. Red Hat Enterprise Virtualization Reports - Reports List
Select a report from the list to display the Input Controls window. T he Input Controls window
consists of a number of drop-down menus allow you to define the report's parameters.
Note
T he dialog is contextual and differs from report to report. Parameters marked with an asterisk (* )
are required.
335
Red Hat Enterprise Virtualization 3.2 Administration Guide
Figure 19.8. Report Parameter Selection
Cascading parameters
Many report parameters are cascading input fields. T his means the selection made for one parameter
changes the options available for another parameter. T he 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 T ype 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.
T he 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.
Report a bug
19.1.11. Right-click Reporting Integration with the Red Hat Enterprise
Virtualization Administration Portal
T he Administration portal provides integrated access to reports on most resources.
336
Chapter 19. Reports, History D atabase Reports, and D ashboards
T o 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. T his expands to show
all of the available reports on the selected resource.
Figure 19.9. Right-click Reporting
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.
Figure 19.10. Alternative to Right-click Reporting
Report a bug
19.1.12. Executive Reports
19.1.12.1. Executive reports: Active Virtual Machines by OS
T he 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. T he following parameters are
provided to run this report:
337
Red Hat Enterprise Virtualization 3.2 Administration Guide
T able 19.2. Active Virtual Machines by OS Parameters
Parameter
Description
Show Deleted Entities?
T he report includes deleted objects, such as data
centers, clusters, and hosts removed from the
environment.
Period Range
T he report is for the period range selected. Daily
reports cover a single day. Monthly reports cover
a single month. Quarterly reports cover a threemonth 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
T he 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
T he report includes only virtual machines in the
selected data center. T he options list shows only
data centers that contain virtual machines.
Cluster
T he report only includes virtual machines in the
selected cluster. T he 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 T ype
T he report only includes virtual machines of the
selected type. Possible types are Server and
Desktop. T he 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.
Report a bug
19.1.12.2. Executive Reports: Cluster Capacity Vs Usage
T he 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. T he following parameters
must be provided to run this report:
338
Chapter 19. Reports, History D atabase Reports, and D ashboards
T able 19.3. Cluster Capacity Vs Usage Parameters
Parameter
Description
Show Deleted Entities?
T he report includes deleted objects, such as data
centers, clusters, and hosts removed from the
environment.
Period Range
T he report is for the period range selected. Daily
reports cover a single day. Monthly reports cover
a single month. Quarterly reports cover a threemonth 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
T he 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
T he list of options for the Cluster parameter
includes only clusters in the selected data center.
T he options list contains only data centers that
contain clusters.
Cluster
T he report only includes the selected cluster. T he
options list shows only clusters in the selected
data center. If All is selected, the report includes
all clusters in the selected data center.
Report a bug
19.1.12.3. Executive Reports: Host Operating System Break Down
T he Host OS Break Down report indicates the number of hosts running each operating system
version over a given time period. T he following parameters must be provided to run this report:
339
Red Hat Enterprise Virtualization 3.2 Administration Guide
T able 19.4 . Host OS Break Down Parameters
Parameter
Description
Show Deleted Entities?
T he report includes deleted objects, such as data
centers, clusters, and hosts removed from the
environment.
Period Range
T he report is for the period range selected. Daily
reports cover a single day. Monthly reports cover
a single month. Quarterly reports cover a threemonth 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
T he 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
T he list of options for the Cluster parameter
includes only clusters in the selected data center.
T he options list shows only data centers that
contain clusters.
Cluster
T he report includes only hosts in the selected
cluster. T he options list shows only clusters in
the selected data center. If All is selected, the
report includes all hosts in the selected data
center.
Report a bug
19.1.12.4 . Executive Reports: Summary of Host Usage Resources
T he Sum m ary 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. T he following parameters must be
provided to run this report:
34 0
Chapter 19. Reports, History D atabase Reports, and D ashboards
T able 19.5. Summary of Host Usage Resources Parameters
Parameter
Description
Show Deleted Entities?
T he report includes deleted objects, such as data
centers, clusters, and hosts removed from the
environment.
Period Range
T he report is for the period range selected. Daily
reports cover a single day. Monthly reports cover
a single month. Quarterly reports cover a threemonth 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
T he 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
T he list of options for the Cluster parameter
includes only clusters in the selected data center.
T he options list shows only data centers that
contain clusters.
Cluster
T he report includes only hosts in the selected
cluster. T he options list shows only clusters in
the selected data center. If All is selected, the
report includes all hosts in the selected data
center.
Report a bug
19.1.13. Inventory Reports
19.1.13.1. Inventory Reports: Hosts Inventory
T he Hosts Inventory report shows a list of all hosts in the selected data center and cluster. T he
following parameters must be provided to run this report:
34 1
Red Hat Enterprise Virtualization 3.2 Administration Guide
T able 19.6. Hosts Inventory Parameters
Parameter
Description
Show Deleted Entities?
T he report includes deleted objects, such as data
centers, clusters, and hosts removed from the
environment.
Data Center
T he list of options for the Cluster parameter
includes only clusters in the selected data center.
T he options list shows only data centers that
contain clusters.
Cluster
T he report includes only hosts in the selected
cluster. T he 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 T ype
T he report includes only hosts of the selected
type. T he options list shows only host types
present in the selected data center and cluster. If
All is selected, the report includes all host types.
Report a bug
19.1.13.2. Inventory Reports: Storage Domain Over T ime
T he Storage Dom ain Size Over T im e report shows a line graph contrasting the total available
and total used space for a single storage domain over time for a given period. T he following parameters
must be provided to run this report:
34 2
Chapter 19. Reports, History D atabase Reports, and D ashboards
T able 19.7. Storage Domain Size Over T ime Parameters
Parameter
Description
Show Deleted Entities?
T he report includes deleted objects, such as data
centers, clusters, and hosts removed from the
environment.
Period Range
T he 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
T he 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. T he list of
options for the Storage Domain name parameter
includes only storage domains that were attached
during the specified period.
Data Center
T he options list for the Storage Domain Name
parameter shows only storage domains in this
selected data center.
Storage Dom ain T ype
T he options list for the Storage Domain Name
parameter shows only storage domains of this
selected type.
Storage Dom ain Nam e
T he report refers to the storage domain selected.
A report is only for a single storage domain and
the user must select a storage domain. T he list of
options shows only storage domains that were
attached to the data center during the selected
period.
Report a bug
19.1.13.3. Inventory Reports: Virtual Machines Inventory
T he Virtual Machines Inventory report shows a list of all virtual machines in the selected data
center and cluster. T he following parameters must be provided to run this report:
34 3
Red Hat Enterprise Virtualization 3.2 Administration Guide
T able 19.8. Virtual Machines Inventory Parameters
Parameter
Description
Show Deleted Entities?
T he report includes deleted objects, such as data
centers, clusters, and hosts removed from the
environment.
Data Center
T he list of options for the Cluster parameter
includes only clusters in the selected data center.
T he options list shows only data centers that
contain clusters.
Cluster
T he report includes only virtual machines in the
selected cluster. T he 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 T ype
T he report includes only virtual machines of the
selected type. T he 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.
Report a bug
19.1.13.4 . Inventory Reports: Cloud Provider Virtual Machine Inventory
T he 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. T he following parameters
must be provided to run this report:
34 4
Chapter 19. Reports, History D atabase Reports, and D ashboards
T able 19.9. Cloud Provider Virtual Machine Inventory Parameters
Parameter
Description
Show Deleted Entities?
T he report includes deleted objects, such as data
centers, clusters, and hosts removed from the
environment.
Period Range
T he report is for the period range selected. Daily
reports cover a single day. Monthly reports cover
a single month. Quarterly reports cover a threemonth 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
T he 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
T he list of options for the Cluster parameter
includes only clusters in the selected data center.
T he options list shows only data centers that
contain clusters.
Cluster
T he report includes only virtual machines in the
selected cluster. T he 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 T ype
T he report includes only virtual machines of the
selected type. T he 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.
Report a bug
19.1.14. Service Level Reports
19.1.14 .1. Service Level Reports: Cluster Host Uptime
T he Cluster Host Uptim e report shows the weighted average uptime of hosts within a cluster for a
given period of time. T his report also provides a table listing the total planned (maintenance) and
unplanned down time for each host. T he following parameters must be provided to run this report:
34 5
Red Hat Enterprise Virtualization 3.2 Administration Guide
T able 19.10. Cluster Host Uptime Parameters
Parameter
Description
Show Deleted Entities?
T he report includes deleted objects, such as data
centers, clusters, and hosts removed from the
environment.
Period Range
T he report is for the period range selected. Daily
reports cover a single day. Monthly reports cover
a single month. Quarterly reports cover a threemonth 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
T he 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
T he list of options for the Cluster parameter
includes only clusters in the selected data center.
T he options list shows only data centers that
contain clusters.
Cluster
T he report includes only hosts in the selected
cluster. T he 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 T ype
T he report includes only hosts of the selected
type. T he options list shows only host types
present in the selected data center and cluster. If
All is selected, the report includes all host types.
Report a bug
19.1.14 .2. Service Level Reports: Cluster Quality of Service - Hosts
T he 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. T he following parameters must be provided to run this report:
34 6
Chapter 19. Reports, History D atabase Reports, and D ashboards
T able 19.11. Cluster Quality of Service - Hosts Parameters
Parameter
Description
Show Deleted Entities?
T he report includes deleted objects, such as data
centers, clusters, and hosts removed from the
environment.
Period Range
T he report is for the period range selected. Daily
reports cover a single day. Monthly reports cover
a single month. Quarterly reports cover a threemonth 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
T he 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
T he list of options for the Cluster parameter
includes only clusters in the selected data center.
T he options list shows only data centers that
contain clusters.
Cluster
T he report includes only hosts in the selected
cluster. T he 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 T ype
T he report includes only hosts of the selected
type. T he 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 T hreshold
T he report measures the quality of service as the
amount of time hosts sustain load above a given
threshold. T he CPU Threshold defines a load
threshold as a percentage of total CPU usage on
the host. T he load is measured by one-minute
samples, averaged over an hour. T he 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.
Mem ory T hreshold
T he report measures the quality of service as the
amount of time hosts sustain load above a given
threshold. T he Memory Threshold defines a
load threshold as a percentage of total memory
usage on the host. T he load is measured by oneminute samples, averaged over an hour. T he
report therefore shows sustained load, not short
term peaks. A Memory Threshold of 60 per cent
34 7
Red Hat Enterprise Virtualization 3.2 Administration Guide
is a suggested starting point to produce a
meaningful quality of service report.
Report a bug
19.1.14 .3. Service Level Reports: Cluster Quality of Service - Virtual Machines
T he 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. T he following parameters must be provided to
run this report:
34 8
Chapter 19. Reports, History D atabase Reports, and D ashboards
T able 19.12. Cluster Quality of Service - Virtual Machines Parameters
Parameter
Description
Show Deleted Entities?
T he report includes deleted objects, such as data
centers, clusters, and hosts removed from the
environment.
Period Range
T he report is for the period range selected. Daily
reports cover a single day. Monthly reports cover
a single month. Quarterly reports cover a threemonth 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
T he 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
T he list of options for the Cluster parameter
includes only clusters in the selected data center.
T he options list shows only data centers that
contain clusters.
Cluster
T he report includes only virtual machines in the
selected cluster. T he 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 T ype
T he report includes only virtual machines of the
selected type. T he 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 T hreshold
T he report measures quality of service as the
amount of time virtual machines sustain load
above a given threshold. T he CPU Threshold
defines a load threshold as a percentage of total
CPU usage on the virtual machine. T he load is
measured by one-minute samples, averaged over
an hour. T he 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.
Mem ory T hreshold
T he reports measures quality of service as the
amount of time virtual machines sustain load
above a given threshold. T he Memory
Threshold defines a load threshold as a
percentage of total memory usage on the virtual
machine. T he load is measured by one-minute
samples, averaged over an hour. T he report
34 9
Red Hat Enterprise Virtualization 3.2 Administration Guide
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.
Report a bug
19.1.14 .4 . Service Level Reports: Single Host Uptime
T he Single Host Uptim e report shows the total proportion of uptime, planned downtime and
unplanned downtime for a single host. T he following parameters must be provided to run this report:
T able 19.13. Single Host Uptime Parameters
Parameter
Description
Show Deleted Entities?
T he report includes deleted objects, such as data
centers, clusters, and hosts removed from the
environment.
Period Range
T he report is for the period range selected. Daily
reports cover a single day. Monthly reports cover
a single month. Quarterly reports cover a threemonth 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
T he 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
T he list of options for the Cluster parameter
includes only clusters in the selected data center.
T he options list shows only data centers that
contain clusters.
Cluster
T he list of options for the Host Name parameter
includes only hosts in the selected cluster. T he
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 T ype
T he list of options for the Host Name parameter
includes only hosts of the selected type. T he
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 Nam e
T he report refers to the host selected. A report is
only for a single host and a user must select a
host.
350
Chapter 19. Reports, History D atabase Reports, and D ashboards
Report a bug
19.1.14 .5. Service Level Reports: T op 10 Downtime Hosts
T he T op 10 Downtim e Hosts report shows the total proportion of uptime, planned downtime and
unplanned downtime for the 10 hosts with the greatest amount of downtime. T he following parameters
must be provided to run this report:
T able 19.14 . T op 10 Downtime Hosts Parameters
Param eter
Description
Show Deleted Entities?
T he report includes deleted objects, such as data
centers, clusters, and hosts removed from the
environment.
Period Range
T he report is for the period range selected. Daily
reports cover a single day. Monthly reports cover
a single month. Quarterly reports cover a threemonth 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
T he 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
T he list of options for the Cluster parameter
includes only clusters in the selected data center.
T he options list contains only data centers that
contain clusters.
Cluster
T he report includes only hosts in the selected
cluster. T he 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 T ype
T he report includes only hosts of the selected
type. T he options list shows only host types
present in the selected data center and cluster. If
All is selected, the report includes all host types.
Report a bug
19.1.14 .6. Service Level Reports: High Availability Virtual Servers Uptime
T he High Availability Virtual Servers Uptim e report shows the weighted average uptime
of high availability virtual servers within a cluster for a given period of time. T he report also provides a
table listing the total uptime and unplanned down time for each virtual server. T he following parameters
must be provided to run this report:
351
Red Hat Enterprise Virtualization 3.2 Administration Guide
T able 19.15. High Availability Virtual Servers Uptime Parameters
Parameter
Description
Show Deleted Entities?
T he report includes deleted objects, such as data
centers, clusters, and hosts removed from the
environment.
Period Range
T he report is for the period range selected. Daily
reports cover a single day. Monthly reports cover
a single month. Quarterly reports cover a threemonth 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
T he 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
T he list of options for the Cluster parameter
includes only clusters in the selected data center.
T he options list shows only data centers that
contain clusters.
Cluster
T he report includes only virtual servers in the
selected cluster. T he 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.
Report a bug
19.1.15. Trend Reports
19.1.15.1. T rend Reports: Five Least Utilized Hosts (Over T ime)
T he Five Least Utilized Hosts (Over T im e) 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. T he following parameters must be provided to run this report:
352
Chapter 19. Reports, History D atabase Reports, and D ashboards
T able 19.16. Five Least Utilized Hosts (Over T ime) Parameters
Parameter
Description
Show Deleted Entities?
T he report includes deleted objects, such as data
centers, clusters, and hosts removed from the
environment.
Period Range
T he report is for the period range selected. Daily
reports cover a single day. Monthly reports cover
a single month. Quarterly reports cover a threemonth 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
T he 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
T he list of options for the Cluster parameter
includes only clusters in the selected data center.
T he options list shows only data centers that
contain clusters.
Cluster
T he report includes only hosts in the selected
cluster. T he 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 T ype
T he report includes only hosts of the selected
type. T he options list shows only host types
present in the selected data center and cluster. If
All is selected, the report includes all host types.
Report a bug
19.1.15.2. T rend Reports: Five Least Utilized Virtual Machines (Over T ime)
T he Five Least Utilized Virtual Machines (Over T im e) 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. T he following parameters must be provided to run this report:
353
Red Hat Enterprise Virtualization 3.2 Administration Guide
T able 19.17. Five Least Utilized Virtual Machines (Over T ime) Parameters
Parameter
Description
Show Deleted Entities?
T he report includes deleted objects, such as data
centers, clusters, and hosts removed from the
environment.
Period Range
T he report is for the period range selected. Daily
reports cover a single day. Monthly reports cover
a single month. Quarterly reports cover a threemonth 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
T he 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
T he list of options for the Cluster parameter
includes only clusters in the selected data center.
T he options list shows only data centers that
contain clusters.
Cluster
T he report includes only virtual machines in the
selected cluster. T he 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 T ype
T he report includes only virtual machines of the
selected type. T he 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.
Report a bug
19.1.15.3. T rend Reports: Five Most Utilized Hosts (Over T ime)
T he Five Most Utilized Hosts (Over T im e) 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. T he following parameters must be provided to run this report:
354
Chapter 19. Reports, History D atabase Reports, and D ashboards
T able 19.18. Five Most Utilized Hosts (Over T ime) Parameters
Parameter
Description
Show Deleted Entities?
T he report includes deleted objects, such as data
centers, clusters, and hosts removed from the
environment.
Period Range
T he report is for the period range selected. Daily
reports cover a single day. Monthly reports cover
a single month. Quarterly reports cover a threemonth 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
T he 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
T he list of options for the Cluster parameter
includes only clusters in the selected data center.
T he options list shows only data centers that
contain clusters.
Cluster
T he report includes only hosts in the selected
cluster. T he 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 T ype
T he report includes only hosts of the selected
type. T he options list shows only host types
present in the selected data center and cluster. If
All is selected, the report includes all host types.
Report a bug
19.1.15.4 . T rend Reports: Five Most Utilized Virtual Machines (Over T ime)
T he Five Most Utilized Virtual Machines (Over T im e) 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. T he following parameters must be provided to run this
report:
355
Red Hat Enterprise Virtualization 3.2 Administration Guide
T able 19.19. Five Most Utilized Virtual Machines (Over T ime) Parameters
Parameter
Description
Show Deleted Entities?
T he report includes deleted objects, such as data
centers, clusters, and hosts removed from the
environment.
Period Range
T he report is for the period range selected. Daily
reports cover a single day. Monthly reports cover
a single month. Quarterly reports cover a threemonth 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
T he 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
T he list of options for the Cluster parameter
includes only clusters in the selected data center.
T he options list shows only data centers which
contain clusters.
Cluster
T he report includes only virtual machines in the
selected cluster. T he 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 T ype
T he report includes only virtual machines of the
selected type. T he 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.
Report a bug
19.1.15.5. T rend Reports: Multiple Hosts Resource Usage (Over T ime)
T he Multiple Hosts Resource Usage (Over T im e) 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. T he following
parameters must be provided to run this report:
356
Chapter 19. Reports, History D atabase Reports, and D ashboards
T able 19.20. Multiple Hosts Resource Usage (Over T ime) Parameters
Parameter
Description
Show Deleted Entities?
T he report includes deleted objects, such as data
centers, clusters, and hosts removed from the
environment.
Period Range
T he report is for the period range selected. Daily
reports cover a single day. Monthly reports cover
a single month. Quarterly reports cover a threemonth 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
T he 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
T he list of options for the Cluster parameter
includes only clusters in the selected data center.
T he options list shows only data centers that
contain clusters.
Cluster
T he list of options for the Hosts list parameter
includes only hosts in the selected cluster. T he
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 T ype
T he list of options for the Hosts list parameter
includes only hosts of the selected type. T he
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
T he report includes all hosts selected in the host
list. Select any number of hosts up to a maximum
of five.
Report a bug
19.1.15.6. T rend Reports: Multiple Virtual Machines Resource Usage (Over T ime)
T he Multiple Virtual Machines Resource Usage (Over T im e) 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. T he following parameters must be provided to run this report:
357
Red Hat Enterprise Virtualization 3.2 Administration Guide
T able 19.21. Multiple Virtual Machines Resource Usage (Over T ime) Parameters
Parameter
Description
Show Deleted Entities?
T he report includes deleted objects, such as data
centers, clusters, and hosts removed from the
environment.
Period Range
T he report is for the period range selected. Daily
reports cover a single day. Monthly reports cover
a single month. Quarterly reports cover a threemonth 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
T he 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
T he list of options for the Cluster parameter
includes only clusters in the selected data center.
T he options list shows only data centers that
contain clusters.
Cluster
T he list of options for the VM List parameter
include only virtual machines in the selected
cluster. T he 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 T ype
T he list of options for the VM List parameter
includes only virtual machines of the selected
type. T he 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
T he report includes all virtual machines selected
in the virtual machine list. Select any number of
virtual machines up to a maximum of five.
Report a bug
19.1.15.7. T rend Reports: Single Host Resource Usage (Days of Week)
T he 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. T he metrics
include CPU usage, memory usage, number of active virtual machines and network usage. T he following
parameters must be provided to run this report:
358
Chapter 19. Reports, History D atabase Reports, and D ashboards
T able 19.22. Single Host Resource Usage (Days of Week) Parameters
Parameter
Description
Show Deleted Entities?
T he report includes deleted objects, such as data
centers, clusters, and hosts removed from the
environment.
Period Range
T he report is for the period range selected. Daily
reports cover a single day. Monthly reports cover
a single month. Quarterly reports cover a threemonth 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
T he 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
T he list of options for the Cluster parameter
includes only clusters in the selected data center.
T he options list shows only data centers that
contain clusters.
Cluster
T he list of options for the Host Name parameter
includes only hosts in the selected cluster. T he
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 T ype
T he list of options for the Host Name parameter
includes only hosts of the selected type. T he
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 Nam e
T he report refers to the host selected. A report is
only for a single host and the user must select a
host.
Report a bug
19.1.15.8. T rend Reports: Single Host Resource Usage (Hour of Day)
T he 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). T he metrics
include CPU usage, memory usage, number of active virtual machines and network usage. T he following
parameters must be provided to run this report:
359
Red Hat Enterprise Virtualization 3.2 Administration Guide
T able 19.23. Single Host Resource Usage (Hour of Day) Parameters
Parameter
Description
Show Deleted Entities?
T he report includes deleted objects, such as data
centers, clusters, and hosts removed from the
environment.
Period Range
T he report is for the period range selected. Daily
reports cover a single day. Monthly reports cover
a single month. Quarterly reports cover a threemonth 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
T he 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
T he list of options for the Cluster parameter
includes only clusters in the selected data center.
T he options list shows only data centers that
contain clusters.
Cluster
T he list of options for the Host Name parameter
includes only hosts in the selected cluster. T he
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 T ype
Only hosts of the selected type will be included in
the list of options for the Host Name parameter.
T he 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 Nam e
T he report refers to the host selected. A report is
only for a single host and the user must select a
host.
Report a bug
19.1.15.9. T rend Reports: Single Virtual Machine Resources (Days of Week)
T he 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. T he metrics include CPU usage, memory usage, disk usage and network usage. T he following
parameters must be provided to run this report:
360
Chapter 19. Reports, History D atabase Reports, and D ashboards
T able 19.24 . Single Virtual Machine Resources (Days of Week) Parameters
Parameter
Description
Show Deleted Entities?
T he report includes deleted objects, such as data
centers, clusters, and hosts removed from the
environment.
Period Range
T he report is for the period range selected. Daily
reports cover a single day. Monthly reports cover
a single month. Quarterly reports cover a threemonth 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
T he 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
T he list of options for the Cluster parameter
includes only clusters in the selected data center.
T he options list shows only data centers that
contain clusters.
Cluster
T he list of options for the VM Name parameter
includes only virtual machines in the selected
cluster. T he 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 T ype
T he list of options for the VM Name parameter
includes only virtual machines of the selected
type. T he 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 Nam e
T he report refers to the virtual machine selected.
A report is only for a single virtual machine and
the user must select a virtual machine.
Report a bug
19.1.15.10. T rend Reports: Single Virtual Machine Resources (Hour of Day)
T he 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). T he metrics include CPU usage, memory usage, disk usage and network usage. T he following
parameters must be provided to run this report:
361
Red Hat Enterprise Virtualization 3.2 Administration Guide
T able 19.25. Single Virtual Machine Resources (Hour of Day) Parameters
Parameter
Description
Show Deleted Entities?
T he report includes deleted objects, such as data
centers, clusters, and hosts removed from the
environment.
Period Range
T he report is for the period range selected. Daily
reports cover a single day. Monthly reports cover
a single month. Quarterly reports cover a threemonth 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
T he 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
T he list of options for the Cluster parameter
includes only clusters in the selected data center.
T he options list shows only data centers which
contain clusters.
Cluster
T he list of options for the VM Name parameter
includes only virtual machines in the selected
cluster. T he 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 T ype
T he list of options for the VM Name parameter
includes only virtual machines of the selected
type. T he 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 Nam e
T he report refers to the virtual machine selected.
A report is only for a single virtual machine and
the user must select a virtual machine.
Report a bug
19.1.15.11. T rend Reports: Single Virtual Machine Resources (Over T ime)
T he Single Virtual Machine Resources (Over T im e) report shows a variety of resource
utilization metrics for a single virtual machine over a given period of time. T he metrics include CPU
usage, memory usage, disk usage and network usage. T he following parameters must be provided to
run this report:
362
Chapter 19. Reports, History D atabase Reports, and D ashboards
T able 19.26. Single Virtual Machine Resources (Over T ime) Parameters
Parameter
Description
Show Deleted Entities?
T he report includes deleted objects, such as data
centers, clusters, and hosts removed from the
environment.
Period Range
T he report is for the period range selected. Daily
reports cover a single day. Monthly reports cover
a single month. Quarterly reports cover a threemonth 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
T he 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
T he list of options for the Cluster parameter
includes only clusters in the selected data center.
T he options list shows only data centers that
contain clusters.
Cluster
T he list of options for the VM Name parameter
includes only virtual machines in the selected
cluster. T he 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 T ype
T he list of options for the VM Name parameter
lists only virtual machines of the selected type.
T he 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 Nam e
T he report refers to the virtual machine selected.
A report is only for a single virtual machine and
the user must select a virtual machine.
Report a bug
19.1.16. Ad Hoc Reports
Red Hat Enterprise Virtualization Reports provides you with a tool to create customized ad hoc reports.
T his tool is a component of JasperServer. T o 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.
363
Red Hat Enterprise Virtualization 3.2 Administration Guide
Figure 19.11. Create Ad Hoc Report - Administrator's View
T he Working with the Ad Hoc Editor section of the online help explains the ad hoc report
interface in detail.
Report a bug
19.1.17. Reports Schema: Tag History and ENUM Views
T his 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.
T ag relations and latest tag relations history views
T able 19.27. T ag Relations History in the System
Name
T ype
Description
history_id
integer
T he 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
T he date the entity or tag was attached
to the entity or tag.
detach_date
timestamp with
time zone
T he date the entity or tag was
detached from the entity or tag.
T ag details and latest tag details views
T ag details history in the system.
364
2 - VM
3 - Host
5 - VM pool
18 - T ag
Chapter 19. Reports, History D atabase Reports, and D ashboards
T able 19.28. v3_2_tag_details_view\v3_2_latest_tag_details_view
Name
T ype
Description
history_id
integer
T he 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)
T he path to the tag in the tree.
tag_level
smallint
T he tag level in the tree.
create_date
timestamp with
time zone
T he date this tag was added to the
system.
update_date
timestamp with
time zone
T he date this tag was changed in the
system.
delete_date
timestamp with
time zone
T he date this tag was deleted from the
system.
Enum translator view
T he ENUM table is used to easily translate column numeric types to their meanings and lists ENUM
values for columns in the history database.
T able 19.29. v3_2_enum_translator_view
Name
T ype
Description
enum_type
varchar(40)
T he type of ENUM.
enum_key
smallint
T he key of the ENUM.
value
varchar(40)
T he value of the ENUM.
Report a bug
19.2. History Database Reports
19.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.
Report a bug
365
Red Hat Enterprise Virtualization 3.2 Administration Guide
19.2.2. Tracking Configuration History
T he ET L service, ovirt-engine-dwhd, tracks three types of changes:
A new entity is added to the engine database - the ET L Service replicates the change to the
ovirt_engine_history database as a new entry.
An existing entity is updated - the ET L 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.
T o maintain correctness of historical reports and representations, they are not physically removed.
T he configuration tables in the ovirt_engine_history database differ from the corresponding tables in
the engine database in several ways. T he most apparent difference is they contain fewer
configuration columns. T his 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_id to indicate the configuration version of the entity;
a create_date field to indicate when the entity was added to the system;
an update_date field to indicate when the entity was changed; and
a delete_date field to indicate the date the entity was removed from the system.
Report a bug
19.2.3. Recording Statistical History
T he ET L 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. T ables reference the
configuration version of a host in order to enable reports on statistics of an entity in relation to its past
configuration.
Report a bug
19.2.4. Tracking Tag History
T he ET L Service collects tag information as displayed in the Administration Portal every minute and
stores this data in the tags historical tables. T he ET L Service tracks five types of changes:
A tag is created in the Administration Portal - the ET L 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 ET L Service replicates the
addition to the ovirt_engine_history database as a new entry.
A tag is updated - the ET L 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
366
Chapter 19. Reports, History D atabase Reports, and D ashboards
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.
Report a bug
19.2.5. Connecting to the History Database
T he 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
T he 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 19.1. Enabling Remote Access to the History Database
1. Edit the postgresql.conf file, and add two parameters.
listen_addresses = &quot;*&quot;
If you want to allow access by specific hosts, use a comma seperated list of IP addresses or
hostnames instead of &quot;*&quot;.
ssl=on
2. Edit pg_hba.conf to add:
hostssl
md5
all
all
&lt;net address/mask&gt;
Replace &lt;net address/mask&gt; with the IP address and netmask of allowed hosts. For example,
192.168.0.0/24.
3. A. You can use the certificate and key created by the Red Hat Enterprise Virtualization Manager
at installation, /etc/pki/ovirt-engine/certs/engine.cer and /etc/pki/ovirtengine/keys/engine_id_rsa respectively.
a. PostgreSQL requires that the certificate and key be named server.crt and server.key,
respectively. You can use the ln -s to create a soft link to put the Manager's cerificate
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
b. Alternatively, you can create a new certificate and key file. Using the commands
documented in the PostgreSQL Manual, create server.crt and server.key files.
367
Red Hat Enterprise Virtualization 3.2 Administration Guide
4. Stop the engine service.
# service ovirt-engine stop
5. Restart the PostgreSQL service
# service postgresql restart
6. Un-deploy and re-deploy the Jasper WAR files
a. Remove the .deployed file:
# rm /var/lib/ovirt-engine/deployments/rhevm-reports.war.deployed
T his causes an .undeployed file to be created: /var/lib/ovirtengine/deploym ents/rhevm -reports.war.undeployed
b. When the .undeployed file is there, you know the app is down. Remove the
.undeployed file:
# rm /var/lib/ovirt-engine/deployments/rhevm-reports.war.undeployed
c. T hen you can redeploy:
# touch /var/lib/ovirt-engine/deployments/rhevm-reports.war.dodeploy
Which causes a .deployed file to be created: /var/lib/ovirtengine/deploym ents/rhevm -reports.war.deployed
7. Add an iptables rule to allow external machines to connect to the Manager and access
PosgreSQL. 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
8. 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.
Report a bug
19.2.6. Allowing Read-only Access to the History Database
Summary
You want to allow access to your history database without allowing edits. You need to create a read-only
Postgres user that can log in and read from the ovirt_engine_history database. T his procedure
assumes the Postgres 8 series database, and should be executed locally to your database.
Procedure 19.2. Allowing Read-only Access to the History Database
368
Chapter 19. Reports, History D atabase Reports, and D ashboards
1. Create the user that you will grant read-only access to the history database with, called historyreadonly.
# psql -U postgres -c &quot;CREATE ROLE history-readonly WITH LOGIN;&quot;
ovirt_engine_history
2. Grant the history-readonly user permssion to connect to the history database.
# psql -U postgres -c &quot;GRANT CONNECT ON DATABASE mydb TO history-readonly;&quot;
ovirt_engine_history
3. Grant usage of the public schema to the history-readonly user.
# psql -U postgres -c &quot;GRANT USAGE ON SCHEMA public TO history-readonly;&quot;
ovirt_engine_history
4. Generate the rest of the permissions to grant to the history-readonly user and save them to a file.
# psql -U postgres -c &quot;SELECT 'GRANT SELECT ON ' || relname || ' TO historyreadonly;' FROM pg_class JOIN pg_namespace ON pg_namespace.oid =
pg_class.relnamespace WHERE nspname = 'public' AND relkind IN ('r', 'v');&quot; -pset=tuples_only=on ovirt_engine_history &gt; grant.sql
5. Use the file you generated in the previous step to grant permissions to the history-readonly user.
# psql -U postgres -f grant.sql ovirt_engine_history
6. Remove the file you used to grant permissions to history-readonly user.
# rm grant.sql
Result
You can now access the ovirt_engine_history database with the history-readonly user name using the
psql -U history-readonly ovirt_engine_history command. Select statements against
tables and views in the ovirt_engine_history database succeed, while modifications fail.
Report a bug
19.2.7. History Database Report Examples
T he following examples provide an introduction to reports produced from queries to the
ovirt_engine_history database. T he database gives users access to a rich data set and enables a
variety of complex reporting scenarios. T hese examples illustrate only basic reporting requirements.
Resource Utilization on a Single Host
T his example produces a resource utilization report for a single host. T he resource utilization report
provides CPU- and memory-usage percentage information from readings taken at one-minute intervals.
T his kind of report is useful for gaining insight into the load factor of an individual host over a short
period of time. T he 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.
369
Red Hat Enterprise Virtualization 3.2 Administration Guide
Example 19.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 &gt;= '2011-07-01 18:45'
and history_datetime &lt;= '2011-07-31 21:45'
T his query returns a table of data with one row per minute:
T able 19.30. Resource Utilization for a Single Host Example Data
DateT ime
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 19.12, “Single host utilization line graph” was
produced using the Chart Wizard tool in OpenOffice.org Calc.
Figure 19.12. Single host utilization line graph
370
Chapter 19. Reports, History D atabase Reports, and D ashboards
Resource Utilization Across All Hosts
T his 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. T his kind of report reveals utilization trends for the entire
environment over a long period of time and is useful for capacity planning purposes. T he 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 19.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 &gt;= '2011-07-01' and history_datetime &lt; '2011-07-31'
group by extract(hour from history_datetime)
order by extract(hour from history_datetime)
T his query returns a table of data with one row per hour:
T able 19.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 19.13, “T otal system utilization line graph” was
produced using the Chart Wizard tool in OpenOffice.org Calc.
371
Red Hat Enterprise Virtualization 3.2 Administration Guide
Figure 19.13. T otal system utilization line graph
T ag Filter of Latest VM Configuration
T his example filters the latest virtual machine configuration list using the history tag tables. T his kind of
report demonstrates usage of the tags tree built in the Red Hat Enterprise Virtualization Manager to filter
lists. T he following SQL query defines this report. T his 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 19.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%'
T his query returns a table of data with all virtual machine names that are attached to this tag:
T able 19.32. T ag Filtering of Latest VM Configuration
vm_name
RHEL6-Pool-67
RHEL6-Pool-5
RHEL6-Pool-6
RHEL6-23
372
Chapter 19. Reports, History D atabase Reports, and D ashboards
List Current Virtual Machines' Names, T ypes, and Operating Systems
T his example produces a list of all current virtual machines names, types and operating systems in the
Red Hat Enterprise Virtualization Manager environment. T his kind of report demonstrates the usage of
the ENUM table. T he following SQL query defines this report:
Example 19.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)
T his query returns a table of virtual machines with OS and VM T ype data:
T able 19.33. Current Virtual Machines' Names, T ypes, 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
Report a bug
19.2.8. Statistics History Views
19.2.8.1. Statistics History Views
T his section describes the statistics history views available to the user for querying and generating
reports.
Report a bug
19.2.8.2. Datacenter Statistics Views
Historical statistics for each data center in the system.
373
Red Hat Enterprise Virtualization 3.2 Administration Guide
T able 19.34 . Historical Statistics for Each Data Center in the System
Name
T ype
Description
history_id
integer
T he unique ID of this row in the table.
history_datetime
timestamp with
time zone
T he timestamp of this history row
(rounded to minute, hour, day as per
the aggregation level).
datacenter_id
uuid
T he unique ID of the data center.
datacenter_status
smallint
minutes_in_status
decimal
T he 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
T he data center configuration version
at the time of sample.
Report a bug
19.2.8.3. Storage Domain Statistics Views
374
-1 - Unknown Status (used only
to indicate a problem with the ET L -PLEASE NOT IFY SUPPORT )
1 - Up
2 - Maintenance
3 - Problem atic
Chapter 19. Reports, History D atabase Reports, and D ashboards
T able 19.35. Historical Statistics for Each Storage Domain in the System
Name
T ype
Description
history_id
integer
T he unique ID of this row in the table.
history_datetime
timestamp with
time zone
T he 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
T he total available (unused) capacity
on the disk, expressed in gigabytes
(GB).
used_disk_size_gb
integer
T he total used capacity on the disk,
expressed in gigabytes (GB).
storage_configuration_version
integer
T he storage domain configuration
version at the time of sample.
Report a bug
19.2.8.4 . Host Statistics Views
375
Red Hat Enterprise Virtualization 3.2 Administration Guide
T able 19.36. Historical Statistics for Each Storage Domain in the System
Name
T ype
Description
history_id
integer
T he unique ID of this row in the table.
history_datetime
timestamp with
time zone
T he 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
T he 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
T he 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
T he 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
T he average number of active virtual
machines for this aggregation.
max_active_vms
smallint
T he maximum active number of virtual
machines for the aggregation period.
For hourly aggregations, this is the
376
-1 - Unknown Status (used only
to indicate a problem with the ET L -PLEASE NOT IFY SUPPORT )
1 - Up
2 - Maintenance
3 - Problem atic
Chapter 19. Reports, History D atabase Reports, and D ashboards
maximum collected sample value. For
daily aggregations, it is the maximum
hourly average value.
total_vms
smallint
T he average number of all virtual
machines on the host for this
aggregation.
max_total_vms
smallint
T he 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
T otal number of VCPUs allocated to
the host.
max_total_vms_vcpus
smallint
T he 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
T he CPU load of the host.
max_cpu_load
smallint
T he 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
T he 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
T he 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
T he 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.
377
Red Hat Enterprise Virtualization 3.2 Administration Guide
host_configuration_version
integer
T he host configuration version at the
time of sample.
Report a bug
19.2.8.5. Host Interface Statistics Views
Historical Statistics for Each Host Network Interface in the System
T able 19.37. Historical Statistics for Each Host Network Interface in the System
Name
T ype
Description
history_id
integer
T he unique ID of this row in the table.
history_datetime
timestamp with
time zone
T he 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
T he 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
T he 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
T he host interface configuration
version at the time of sample.
Report a bug
19.2.8.6. Virtual Machine Statistics Views
378
Chapter 19. Reports, History D atabase Reports, and D ashboards
T able 19.38. Historical statistics for the virtual machines in the system
Name
T ype
Description
history_id
integer
T he unique ID of this row in the table.
history_datetime
timestamp with
time zone
T he 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
T he 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
T he percentage of the CPU in use by
the virtual machine.
max_cpu_usage
smallint
T he 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. T he guest tools must
be installed on the virtual machine for
memory usage to be recorded.
max_memory_usage
smallint
T he 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. T he
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
-1 - Unknown Status (used only to
indicate problems with the ET L -PLEASE NOT IFY SUPPORT )
0 - Down
1 - Up
2 - Paused
3 - Problematic
379
Red Hat Enterprise Virtualization 3.2 Administration Guide
host.
max_user_cpu_usage_percent
smallint
T he 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
T he 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)
T he 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
T he unique ID of the host the virtual
machine is running on.
vm_configuration_version
integer
T he virtual machine configuration
version at the time of sample.
current_host_configuration_version
integer
T he current host the virtual machine is
running on.
Report a bug
19.2.8.7. Virtual Machine Interface Statistics Views
380
Chapter 19. Reports, History D atabase Reports, and D ashboards
T able 19.39. Historical Statistics for the Virtual Machine Network Interfaces in the System
Name
T ype
Description
history_id
integer
T he unique ID of this row in the table.
history_datetime
timestamp with
time zone
T he 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
T he 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
T he 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
T he virtual machine interface
configuration version at the time of
sample.
Report a bug
19.2.8.8. Virtual Machine Disk Statistics Views
381
Red Hat Enterprise Virtualization 3.2 Administration Guide
T able 19.4 0. Historical Statistics for the Virtual Disks in the System
Name
T ype
Description
history_id
integer
T he unique ID of this row in the table.
history_datetime
timestamp with
time zone
T he 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
T he 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
T he 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
T he 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
T he virtual machine disk read latency
measured in seconds.
max_read_latency_seconds
decimal
T he 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
T he 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
T he virtual machine disk write latency
measured in seconds.
382
0
1
2
3
4
- Unassigned
- OK
- Locked
- Invalid
- Illegal
Chapter 19. Reports, History D atabase Reports, and D ashboards
max_write_latency_seconds
decimal
T he 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
T he virtual machine disk flush latency
measured in seconds.
max_flush_latency_seconds
decimal
T he 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
T he virtual machine disk configuration
version at the time of sample.
Report a bug
19.2.9. Configuration History Views
19.2.9.1. Configuration History Views
T his 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.
Report a bug
19.2.9.2. Data Center Configuration
Data centers configuration history in the system.
383
Red Hat Enterprise Virtualization 3.2 Administration Guide
T able 19.4 1. v3_2_configuration_history_datacenters
Name
T ype
Description
history_id
integer
T he ID of the configuration version in
the history database.
datacenter_id
uuid
T he 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
T he date this entity was added to the
system.
update_date
timestamp with
time zone
T he date this entity was changed in the
system.
delete_date
timestamp with
time zone
T he date this entity was deleted from
the system.
0
1
2
3
4
6
-Unknown
- NFS
- FCP
- iSCSI
- Local
- All
Report a bug
19.2.9.3. Datacenter Storage Domain Map
A historical map showing the relationships between storage domains and data centers in the system.
T able 19.4 2. v3_2_map_history_datacenters_storage_domains
Name
T ype
Description
history_id
integer
T he ID of the configuration version in
the history database.
storage_domain_id
uuid
T he unique ID of this storage domain in
the system.
datacenter_id
uuid
T he unique ID of the data center in the
system.
attach_date
timestamp with
time zone
T he date the storage domain was
attached to the data center.
detach_date
timestamp with
time zone
T he date the storage domain was
detached from the data center.
Report a bug
19.2.9.4 . Storage Domain Configuration
Storage domains configuration history in the system.
384
Chapter 19. Reports, History D atabase Reports, and D ashboards
T able 19.4 3. v3_2_configuration_history_storage_domains
Name
T ype
Description
history_id
integer
T he ID of the configuration version in
the history database.
storage_domain_id
uuid
T he 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
T he date this entity was added to the
system.
update_date
timestamp with
time zone
T he date this entity was changed in the
system.
delete_date
timestamp with
time zone
T he date this entity was deleted from
the system.
0
1
2
3
- Data (Master)
- Data
- ISO
- Export
0
1
2
3
4
6
- Unknown
- NFS
- FCP
- iSCSI
- Local
- All
Report a bug
19.2.9.5. Cluster Configuration
Clusters configuration history in the system.
385
Red Hat Enterprise Virtualization 3.2 Administration Guide
T able 19.4 4 . v3_2_configuration_history_clusters
Name
T ype
Description
history_id
integer
T he ID of the configuration version in
the history database.
cluster_id
uuid
T he 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
T he 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
T he data center configuration version
at the time of creation or update.
create_date
timestamp with
time zone
T he date this entity was added to the
system.
update_date
timestamp with
time zone
T he date this entity was changed in the
system.
delete_date
timestamp with
time zone
T he date this entity was deleted from
the system.
Report a bug
19.2.9.6. Host Configuration
Host configuration history in the system.
386
Chapter 19. Reports, History D atabase Reports, and D ashboards
T able 19.4 5. v3_2_configuration_history_hosts
Name
T ype
Description
history_id
integer
T he ID of the configuration version in
the history database.
host_id
uuid
T he unique ID of the host in the
system.
host_unique_id
varchar(128)
T his 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
T he unique ID of the cluster that this
host belongs to.
host_type
smallint
fqdn_or_ip
varchar(255)
T he 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
T he host's physical memory capacity,
expressed in megabytes (MB).
swap_size_mb
integer
T he host swap partition size.
cpu_model
varchar(255)
T he host's CPU model.
number_of_cores
smallint
T otal number of CPU cores in the host.
host_os
varchar(255)
T he host's operating system version.
pm_ip_address
varchar(255)
Power Management server IP address.
kernel_version
varchar(255)
T he host's kernel version.
kvm_version
varchar(255)
T he host's KVM version.
vdsm_version
varchar(40)
T he host's VDSM version.
vdsm_port
integer
As displayed in the edit dialog.
cluster_configuration_version
integer
T he cluster configuration version at the
time of creation or update.
create_date
timestamp with
time zone
T he date this entity was added to the
system.
update_date
timestamp with
time zone
T he date this entity was changed in the
system.
delete_date
timestamp with
time zone
T he date this entity was deleted from
the system.
0 - RHEL Host
2 - RHEV Hypervisor Node
Report a bug
19.2.9.7. Host Interface Configuration
Host interface configuration history in the system.
387
Red Hat Enterprise Virtualization 3.2 Administration Guide
T able 19.4 6. v3_2_configuration_history_hosts_interfaces
Name
T ype
Description
history_id
integer
T he ID of the configuration version in
the history database.
host_interface_id
uuid
T he unique ID of this interface in the
system.
host_interface_name
varchar(50)
T he 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
T he interface speed in bits per second.
mac_address
varchar(20)
T he interface MAC address.
network_name
varchar(50)
T he 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)
T he 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
T he host configuration version at the
time of creation or update.
create_date
timestamp with
time zone
T he date this entity was added to the
system.
update_date
timestamp with
time zone
T he date this entity was changed in the
system.
delete_date
timestamp with
time zone
T he date this entity was deleted from
the system.
Report a bug
19.2.9.8. Virtual Machine Configuration
A list of all virtual machines in the system.
388
0
1
2
3
- rt18139_pv
- rt18139
- e1000
- pv
Chapter 19. Reports, History D atabase Reports, and D ashboards
T able 19.4 7. v3_2_configuration_history_vms
Name
T ype
Description
history_id
integer
T he ID of the configuration version in
the history database.
vm_id
uuid
T he unique ID of this VM in the system.
vm_name
varchar(255)
T he name of the VM.
vm_description
varchar(4000)
As displayed in the edit dialog.
vm_type
smallint
cluster_id
uuid
T he unique ID of the cluster this VM
belongs to.
template_id
uuid
T he unique ID of the template this VM
is derived from. T he 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
T otal number of virtual CPU sockets.
memory_size_mb
integer
T otal 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
0 - Desktop
1 - Server
0 - Unknown
1 - Windows XP
3 - Windows 2003
4 - Windows 2008
5 - Other Linux
6 - Other
7 - RHEL 5
8 - RHEL 4
9 - RHEL 3
10 - Windows2003 x64
11 - Windows 7
12 - Windows 7 x64
13 - RHEL 5 x64
14 - RHEL 4 x64
15 - RHEL 3 x64
16 - Windows 2008 x64
17 - Windows 2008R2 x64
18 - RHEL 6
19 - RHEL 6 x64
389
Red Hat Enterprise Virtualization 3.2 Administration Guide
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
T he cluster configuration version at the
time of creation or update.
default_host_configuration_version
integer
T he host configuration version at the
time of creation or update.
create_date
timestamp with
time zone
T he date this entity was added to the
system.
update_date
timestamp with
time zone
T he date this entity was changed in the
system.
delete_date
timestamp with
time zone
T he date this entity was deleted from
the system.
Report a bug
19.2.9.9. Virtual Machine Interface Configuration History
Virtual interfaces configuration history in the system
390
Chapter 19. Reports, History D atabase Reports, and D ashboards
T able 19.4 8. v3_2_configuration_history_vms_interfaces
Name
T ype
Description
history_id
integer
T he ID of the configuration version in
the history database.
vm_interface_id
uuid
T he unique ID of this interface in the
system.
vm_interface_name
varchar(50)
As displayed in the edit dialog.
vm_id
uuid
T he ID of the virtual machine this
interface belongs to.
vm_interface_type
smallint
T he type of the virtual interface.
0
1
2
3
- rt18139_pv
- rt18139
- e1000
- pv
vm_interface_speed_bps
integer
T he 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
T he virtual machine configuration
version at the time of creation or
update.
create_date
timestamp with
time zone
T he date this entity was added to the
system.
update_date
timestamp with
time zone
T he date this entity was changed in the
system.
delete_date
timestamp with
time zone
T he date this entity was deleted from
the system.
Report a bug
19.2.9.10. Disks to Virtual Machine Map
A historical map showing the relationships between virtual disks and virtual machines in the system.
391
Red Hat Enterprise Virtualization 3.2 Administration Guide
T able 19.4 9. disks_vm_map table
Name
T ype
Description
history_id
integer
T he ID of the configuration version in
the history database.
vm_disk_id
uuid
T he unique ID of this virtual disk in the
system.
vm_id
uuid
T he unique ID of the virtual machine in
the system.
attach_date
timestamp with
time zone
T he date the virtual disk was attached
to the virtual machine.
detach_date
timestamp with
time zone
T he date the virtual disk was detached
from the virtual machine.
Report a bug
19.2.9.11. Virtual Machine Disk Configuration
Virtual disks configuration history in the system.
392
Chapter 19. Reports, History D atabase Reports, and D ashboards
T able 19.50. v3_2_configuration_history_vms_disks
Name
T ype
Description
history_id
integer
T he ID of the configuration version in
the history database.
vm_disk_id
uuid
T he unique ID of this disk in the
system.
vm_disk_description
varchar(4000)
As displayed in the edit dialog.
storage_domain_id
uuid
T he ID of the storage domain this disk
image belongs to.
vm_disk_size_mb
integer
T he 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.
0
1
2
3
4
5
vm_disk_format
integer
- Unassigned
- System
- Data
- Shared
- Swap
- T emp
As displayed in the edit dialog.
3 - Unassigned
4 - COW
5 - RAW
vm_disk_interface
integer
create_date
timestamp with
time zone
T he date this entity was added to the
system.
update_date
timestamp with
time zone
T he date this entity was changed in the
system.
delete_date
timestamp with
time zone
T he date this entity was deleted from
the system.
0 - IDE
1 - SCSI (not supported)
2 - VirtIO
Report a bug
19.3. Dashboards
19.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. T hough 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.
393
Red Hat Enterprise Virtualization 3.2 Administration Guide
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 Help in the top
menu bar of the Reports Portal.
Report a bug
19.3.2. Header Inventory Dashboard
T he Inventory Dashboard provides an executive summary of the inventory of a data center over a
given period of time. T he dashboard includes average disk use, number of active virtual machines, and a
breakdown of host operating systems. T he following parameters can be modified for this dashboard:
T able 19.51. Inventory Dashboard Parameters
Parameter
Description
Show Deleted Entities?
T he report includes deleted objects, such as data
centers, clusters, and hosts removed from the
environment.
Period Range
T he dashboard shows data for the period range
selected. Monthly dashboards cover a single
month. Quarterly dashboards cover a threemonth quarter, beginning on the month specified
in the Dates parameter.
Dates
T he 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
T he report refers to the selected data center. T he
list of options shows only data centers containing
either hosts, storage domains or virtual machines.
T he list of options for the Cluster parameter
includes only clusters in the selected data center.
Report a bug
19.3.3. Header Trends Dashboard
T he T rends Dashboard provides an executive summary of the trends in a data center over a given
period of time. T he dashboard includes graphs of CPU and memory usage over time for the most highly
utilized hosts and virtual machines in the data center. T he following parameters can be modified for this
dashboard:
394
Chapter 19. Reports, History D atabase Reports, and D ashboards
T able 19.52. T rends Dashboard Parameters
Parameter
Description
Show Deleted Entities?
T he report includes deleted objects, such as data
centers, clusters, and hosts removed from the
environment.
Period Range
T he dashboard shows data for the period range
selected. Monthly dashboards cover a single
month. Quarterly dashboards cover a threemonth quarter, beginning on the month specified
in the Dates parameter.
Dates
T he 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
T he report refers to the selected data center. T he
list of options shows only data centers containing
either hosts, storage domains or virtual machines.
T he list of options for the Cluster parameter
includes only clusters in the selected data center.
Report a bug
19.3.4. Header Uptime Dashboard
T he Uptim e Dashboard provides an executive summary of the service level and uptime for a data
center over a given period of time. T he dashboard includes details on total uptime for each cluster in the
data center for the period. T he following parameters can be modified for this dashboard:
395
Red Hat Enterprise Virtualization 3.2 Administration Guide
Report a bug
19.3.5. Integrated Reporting Dashboard in the Red Hat Enterprise Virtualization
Administration Portal
T he Administration Portal also features dashboards for data centers, clusters, and the overall
environment. Select the appropriate resource in tree mode and click the Dashboard resource tab to
display the dashboard information in the results list.
Figure 19.14 . Reports Dashboard
T he 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.
Report a bug
396
Firewalls
Firewalls
A.1. Red Hat Enterprise Virtualization Manager Firewall
Requirements
T he Red Hat Enterprise Virtualization Manager requires that a number of ports be opened to allow
network traffic through the system's firewall. T he rhevm -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. T he rhevm -setup command will save a list of the iptables rules
required in the /usr/share/ovirt-engine/conf/iptables.exam ple file.
T he firewall configuration documented here assumes a default configuration. Where non-default HT T P
and HT T PS 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 4 4 3) listed here.
397
Red Hat Enterprise Virtualization 3.2 Administration Guide
T able A.1. Red Hat Enterprise Virtualization Manager Firewall Requirements
Port(s)
Protocol
-
ICMP
22
T CP
80, 443
T CP
398
Source
Destination
Red Hat
Enterprise
Virtualization
Hypervisor(s)
Red Hat
Enterprise
Linux host(s)
Red Hat
Enterprise
Virtualization
Manager
System(s)
used for
maintenance of
the Manager
including
backend
configuration,
and software
upgrades.
Red Hat
Enterprise
Virtualization
Manager
Administration
Portal clients
User Portal
clients
Red Hat
Enterprise
Virtualization
Hypervisor(s)
Red Hat
Enterprise
Linux host(s)
REST API
clients
Red Hat
Enterprise
Virtualization
Manager
Purpose
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.
SSH (optional)
Provides HT T P
and HT T PS
access to the
Manager.
Firewalls
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
T CP port 204 9 for NFS.
NFSv3
T CP and UDP port 204 9 for NFS.
T CP and UDP port 111 (rpcbind/sunrpc).
T CP and UDP port specified with MOUNT D_PORT =&quot;port&quot;
T CP and UDP port specified with ST AT D_PORT =&quot;port&quot;
T CP port specified with LOCKD_T CPPORT =&quot;port&quot;
UDP port specified with LOCKD_UDPPORT =&quot;port&quot;
T he MOUNT D_PORT , ST AT D_PORT , LOCKD_T CPPORT , and LOCKD_UDPPORT ports are
configured in the /etc/sysconfig/nfs file.
Report a bug
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.
399
Red Hat Enterprise Virtualization 3.2 Administration Guide
T able A.2. Virtualization Host Firewall Requirements
Port(s)
Protocol
22
T CP
5900 - 6411
T CP
5989
T CP, UDP
16514
T CP
49152 - 49216
T CP
4 00
Source
Destination
Red Hat
Enterprise
Virtualization
Manager
Red Hat
Enterprise
Virtualization
Hypervisor(s)
Red Hat
Enterprise
Linux host(s)
Administration
Portal clients
User Portal
clients
Red Hat
Enterprise
Virtualization
Hypervisor(s)
Red Hat
Enterprise
Linux host(s)
Common
Information
Model Object
Manager
(CIMOM)
Red Hat
Enterprise
Virtualization
Hypervisor(s)
Red Hat
Enterprise
Linux host(s)
Red Hat
Enterprise
Virtualization
Hypervisor(s)
Red Hat
Enterprise
Linux host(s)
Red Hat
Enterprise
Virtualization
Hypervisor(s)
Red Hat
Enterprise
Linux host(s)
Red Hat
Enterprise
Linux
Hypervisor(s)
Red Hat
Enterprise
Red Hat
Enterprise
Linux
Hypervisor(s)
Red Hat
Enterprise
Purpose
Secure Shell
(SSH) access.
Remote guest
console access
via VNC and
SPICE. T hese
ports must be
open to facilitate
client access to
virtual machines.
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.
Virtual machine
migration using
libvirt.
Virtual machine
migration and
fencing using
VDSM. T hese
ports must be
open facilitate
Firewalls
54321
T CP
Enterprise
Linux host(s)
Enterprise
Linux host(s)
Red Hat
Enterprise
Virtualization
Manager
Red Hat
Enterprise
Virtualization
Hypervisor(s)
Red Hat
Enterprise
Linux host(s)
Red Hat
Enterprise
Virtualization
Hypervisor(s)
Red Hat
Enterprise
Linux host(s)
both automated
and manually
initiated migration
of virtual
machines.
VDSM
communications
with the Manager
and other
virtualization
hosts.
Example A.1. Option Name: IPT ablesConfig
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-hostprohibited
COMMIT
Report a bug
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
4 01
Red Hat Enterprise Virtualization 3.2 Administration Guide
Red Hat Enterprise Virtualization Manager.
T able A.3. Host Firewall Requirements
Port(s)
Protocol
88, 464
T CP, UDP
389, 636
T CP
Source
Destination
Red Hat
Enterprise
Virtualization
Manager
Directory
server
Red Hat
Enterprise
Virtualization
Manager
Directory
server
Purpose
Kerberos
authentication.
Lightweight
Directory Access
Protocol (LDAP)
and LDAP over
SSL.
Report a bug
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.
T able A.4 . Host Firewall Requirements
Port(s)
Protocol
5432
T CP, UDP
Source
Red Hat
Enterprise
Virtualization
Manager
Destination
PostgreSQL
database
server
Purpose
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.
Report a bug
4 02
VD SM and Hooks
VDSM and Hooks
B.1. VDSM
T he 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. T he Red Hat Enterprise Virtualization Manager functions as a VDSM client.
Report a bug
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. T he Hooks API is new and subject to
significant change in the future.
Report a bug
B.3. Extending VDSM with Hooks
T his 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.
Report a bug
B.4. Supported VDSM Events
4 03
Red Hat Enterprise Virtualization 3.2 Administration Guide
T able 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 de-hibernates.
after_vm_dehibernate
After virtual machine de-hibernates.
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.
Report a bug
4 04
VD SM and Hooks
B.5. The VDSM Hook Environment
Most hook scripts are run as the vdsm user and inherit the environment of the VDSM process. T he
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.
Report a bug
B.6. The VDSM Hook Domain XML Object
When hook scripts are started the _hook_dom xm l variable is appended to the environment. T his
variable contains the path of the libvirt domain XML representation of the relevant virtual machine. T he
exceptions to this rule are * _nic_hotplug_* and * _nic_hotunplug_* hooks, in which the
_hook_dom xm l variable contains the XML representation of the NIC, not the virtual machine.
T he 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. T he uuid of the virtual machine may be
deduced from the domain XML, but it is also available as the environment variable vm Id.
Important
T he before_m igration_destination and before_dehibernation hooks currently
receive the XML of the domain from the source host. T he XML of the domain at the destination will
have various differences.
Report a bug
B.7. Defining Virtual Machine Custom Properties
T he custom properties that are accepted by the Red Hat Enterprise Virtualization Manager — and in
turn passed to custom hooks — are defined using the configuration tool, rhevm -config. Run this
command as the root user on the host where Red Hat Enterprise Virtualization Manager is installed.
T he configuration key UserDefinedVMProperties is 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 this configuration key.
Where multiple custom properties are defined they 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 it is necessary to include all of the custom properties in the command used to
set the key's value.
Once the configuration key has been updated the ovirt-engine service must be restarted for it to
take effect.
4 05
Red Hat Enterprise Virtualization 3.2 Administration Guide
Example B.1. Defining smartcard Custom Property
1. Check the existing custom properties defined by the UserDefinedVMProperties
configuration key using rhevm -config -g UserDefinedVMProperties.
In this case the custom property memory is already defined. T he regular expression ^[0-9]+$
ensures that the custom property will only ever contain numeric characters.
# rhevm-config -g UserDefinedVMProperties
UserDefinedVMProperties : version: general
UserDefinedVMProperties : version: 2.2
UserDefinedVMProperties : memory=^[0-9]+$ version: 3.2
2. As the memory custom property is already defined in the UserDefinedVMProperties
configuration key the new custom property must be appended to it. T he additional custom
property, smartcard, is added to the configuration key's value. T he new custom property is
able to hold a value of true or false.
# rhevm-config -s UserDefinedVMProperties='memory=^[09]+$;smartcard=^(true|false)$' --cver=3.2
3. Verify that the custom properties defined by the UserDefinedVMProperties configuration
key now match your expectations.
# rhevm-config -g UserDefinedVMProperties
UserDefinedVMProperties : version: general
UserDefinedVMProperties : version: 2.2
UserDefinedVMProperties : memory=^[0-9]+$;smartcard=^(true|false)$
version: 3.2
4. Finally, the ovirt-engine service must be restarted for the configuration change to take
effect.
# service ovirt-engine restart
Report a bug
B.8. Setting Virtual Machine Custom Properties
Prerequisites:
Section B.7, “Defining Virtual Machine Custom Properties”
Once custom properties are defined to Red Hat Enterprise Virtualization Manager you are able to begin
setting them on virtual machines. Custom properties are set on the Custom Properties tab of the
New Server Virtual Machine, New Desktop Virtual Machine, Edit Server Virtual
Machine, and Edit Desktop Virtual Machine dialog boxes in the Administration Portal.
You are also able to 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.
T he 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
4 06
VD SM and Hooks
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.
See Also:
Section 8.4.3.8, “Virtual Machine Custom Properties Settings Explained”
Report a bug
B.9. Evaluating Virtual Machine Custom Properties in a VDSM Hook
Prerequisites:
Section B.7, “Defining Virtual Machine Custom Properties”
Section B.8, “Setting Virtual Machine Custom Properties”
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.2. Evaluating Custom Properties
T his 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)
Report a bug
B.10. Using the VDSM Hooking Module
VDSM ships with a Python hooking module, providing helper functions for VDSM hook scripts. T his
module is provided as an example, and is only relevant to VDSM hooks written in Python.
T he hooking module supports reading of a virtual machine's libvirt XML into a DOM object. Hook scripts
can then use Python's built in xm l.dom library (http://docs.python.org/release/2.6/library/xml.dom.html)
to manipulate the object.
T he modified object can then be saved back to libvirt XML using the hooking module. T he hooking
module provides the following functions to support hook development:
4 07
Red Hat Enterprise Virtualization 3.2 Administration Guide
T able B.2. Hooking module functions
Name
Argument
Description
tobool
string
Converts a string &quot;true&quot; or
&quot;false&quot; to a Boolean value
read_dom xm l
-
Reads the virtual machine's
libvirt XML into a DOM object
write_dom xm l
DOM object
Writes the virtual machine's
libvirt XML from a DOM object
Report a bug
B.11. 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. T o support this the /etc/sudoers must be updated to allow the vdsm user to use
sudo without reentering a password. T his is required as hook scripts are executed non-interactively.
Example B.3. 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.
1. Log into the virtualization host as root.
2. Open the /etc/sudoers file in a text editor.
3. Add this line to the file:
vdsm ALL=(ALL) NOPASSWD: /bin/chown
T his specifies that the vdsm user has the ability to run the /bin/chown command as the
root user. T he NOPASSWD parameter indicates that the user will not be prompted to enter their
password when calling sudo.
Once this configuration change has been made VDSM hooks are able to use the sudo command to
run /bin/chown as root. T his Python code uses sudo to execute /bin/chown as root on the
file /m y_file.
retcode = subprocess.call( [&quot;/usr/bin/sudo&quot;, &quot;/bin/chown&quot;, &quot;root&quot;, &quot;/my_file&quot;]
)
T he standard error stream of hook scripts is collected in VDSM's log. T his information is used to debug
hook scripts.
4 08
VD SM and Hooks
Report a bug
B.12. VDSM Hook Return Codes
Hook scripts must return one of the return codes shown in T able B.3, “Hook Return Codes”. T he return
code will determine whether further hook scripts are processed by VDSM.
T able B.3. Hook Return Codes
Code
Description
0
T he hook script ended successfully
1
T he hook script failed, other hooks should be
processed
2
T he hook script failed, no further hooks should be
processed
&gt;2
Reserved
Report a bug
B.13. VDSM Hook Examples
T he 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.
4 09
Red Hat Enterprise Virtualization 3.2 Administration Guide
Example B.4 . NUMA Node T uning
Purpose:
T his hook script allows for tuning the allocation of memory on a NUMA host based on the num aset
custom property. Where the custom property is not set no action is taken.
Configuration String:
numaset=^(interleave|strict|preferred):[\^]?\d+(-\d+)?(,[\^]?\d+(-\d+)?)*$
T he 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. T he two
values are separated by a colon (:). T he regular expression allows specification of the nodeset as:
that a specific node (num aset=strict:1, specifies that only node 1 be used), or
that a range of nodes be used (num aset=strict:1-4 , specifies that nodes 1 through 4 be
used), or
that a specific node not be used (num aset=strict:^3, specifies that node 3 not be used), or
any comma-separated combination of the above (num aset=strict:1-4 ,6, specifies that nodes
1 to 4, and 6 be used).
Script:
/usr/libexec/vdsm /hooks/before_vm _start/50_num a
4 10
VD SM and Hooks
#!/usr/bin/python
import
import
import
import
os
sys
hooking
traceback
'''
numa hook
=========
add numa support for domain xml:
&lt;numatune&gt;
&lt;memory mode=&quot;strict&quot; nodeset=&quot;1-4,^3&quot; /&gt;
&lt;/numatune&gt;
memory=interleave|strict|preferred
numaset=&quot;1&quot; (use one NUMA node)
numaset=&quot;1-4&quot; (use 1-4 NUMA nodes)
numaset=&quot;^3&quot; (don't use NUMA node 3)
numaset=&quot;1-4,^3,6&quot; (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) &gt; 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)
Report a bug
4 11
Red Hat Enterprise Virtualization 3.2 Administration Guide
Red Hat Enterprise Virtualization User Interface Plugins
C.1. Red Hat Enterprise Virtualization User Interface Plugins
Red Hat Enterprise Virtualization supports plugins that expose non-standard features. T his 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.
T o 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.
Report a bug
C.2. Red Hat Enterprise Virtualization User Interface Plugin
Lifecycle
C.2.1. Red Hat Enterprise Virtualization User Interface Plugin Lifecycle
T he basic lifecycle of a User Interface Plugin divides into three stages:
1. Plugin discovery.
2. Plugin loading.
3. Plugin bootstrapping.
Report a bug
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 HT ML page requests (HT T P 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 HT ML page
for runtime evaluation.
4 12
Red Hat Enterprise Virtualization User Interface Plugins
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_ET C/ui-plugins, with a default mapping
of ENGINE_ET C=/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 &lt;descriptorFileNam e&gt;-config.json
naming convention.
Report a bug
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 HT ML 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 HT ML iframe element that
is used to load its host page. T he 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. T he 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.
Report a bug
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
1. Obtain pluginApi instance for the given plugin
2. Obtain runtime plugin configuration object (optional)
3. Register relevant event handler functions
4. Notify UI plugin infrastructure to proceed with plugin initialization
T he following code snippet illustrates the above mentioned steps in practice:
4 13
Red Hat Enterprise Virtualization 3.2 Administration Guide
// 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();
Report a bug
C.3. User Interface Plugin-related Files and their Locations
T able C.1. UI Plugin-related Files and their Locations
File
Location
Plugin descriptor files (metadata)
/usr/share/ovirtengine/ui-plugins/m yplugin.json
Plugin user configuration files
/etc/ovirt-engine/uiplugins/m y-pluginconfig.json
Plugin resource files
/usr/share/ovirtenging/uiplugins/&lt;resourcePath&gt;/
PluginHostPage.htm l
Remarks
&lt;resourcePath&gt; is defined
by the corresponding attribute in
the plugin descriptor.
Report a bug
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
1. Create a plugin descriptor by creating the following file in the Manager at /usr/share/ovirt-
4 14
Red Hat Enterprise Virtualization User Interface Plugins
engine/ui-plugins/helloWorld.json:
{
&quot;name&quot;: &quot;HelloWorld&quot;,
&quot;url&quot;: &quot;/webadmin/webadmin/plugin/HelloWorld/start.html&quot;,
&quot;resourcePath&quot;: &quot;hello-files&quot;
}
2. Create the plugin host page by creating the following file in the Manager at /usr/share/ovirtengine/ui-plugins/hello-files/start.htm l:
&lt;!DOCTYPE html&gt;&lt;html&gt;&lt;head&gt;
&lt;script&gt;
var api = parent.pluginApi('HelloWorld');
api.register({
UiInit: function() { window.alert('Hello world'); }
});
api.ready();
&lt;/script&gt;
&lt;/head&gt;&lt;body&gt;&lt;/body&gt;&lt;/html&gt;
If you have successfully implemented the Hello World! plugin, you will see this screen when you sign
in to the administration portal:
Figure C.1. A Successful Implementation of the Hello World! Plugin
Report a bug
C.5. Installing Red Hat Support Plugin
T he Red Hat Support Plugin provides access to Red Hat Access services from the Red Hat Enterprise
Virtualization Administration Portal.
Procedure C.3. Installing the Red Hat Support Plugin
Note
T he Red Hat Support Plugin is installed by default in Red Hat Enterprise Virtualization 3.3. T he
Red Hat Support Plugin is not installed by default in Red Hat Enterprise Virtualization 3.2. It is not
necessary to run this procedure in Red Hat Enterprise Virtualization 3.3.
4 15
Red Hat Enterprise Virtualization 3.2 Administration Guide
Use yum to install the redhat-support-plugin-rhev plugin:
# yum install redhat-support-plugin-rhev
Report a bug
C.6. Using Red Hat Support Plugin
T he 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. T he 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.
Figure C.2. Red Hat Support Plugin - Login Window
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.
4 16
Red Hat Enterprise Virtualization User Interface Plugins
Figure C.3. Red Hat Support Plugin - Query Results in the Left-Hand Navigation List
Right click on context menus in the Red Hat Enterprise Virtualization Administrator Portal to access the
Red Hat Support Plugin.
Figure C.4 . Right-clicking on a Context Menu to Access Red Hat Support Plugin
Select Red Hat Access from the context menu, and a window opens that allows you to search for
solutions in the knowledge base.
4 17
Red Hat Enterprise Virtualization 3.2 Administration Guide
Figure C.5. Red Hat Support Plugin - Solution Search Window
Open a new support case by selecting the Open New Support Case radio button.
Figure C.6. Red Hat Support Plugin - Opening a New Support Case
Modify an existing support case by selecting the Modify Existing Case radio button.
4 18
Red Hat Enterprise Virtualization User Interface Plugins
Figure C.7. Red Hat Support Plugin - Modifying a Support Case
Select the Red Hat Docum entation tab to open the documentation relevant to the part of the
Administration Portal currently on the screen.
Figure C.8. Red Hat Support Plugin - Accessing Documentation
Report a bug
4 19
Red Hat Enterprise Virtualization 3.2 Administration Guide
Red Hat Enterprise Virtualization and SSL
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
T his procedure requires a PEM formatted certificate from your commercial certificate issuing authority, a
.nokey file, and a .cer file. T he .nokey and .cer files are sometimes distributed as a certificate-key bundle
in the P12 format.
T his 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
1. T he 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
2. 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
3. Move your P12 bundle to /etc/pki/ovirt-engine/keys/apache.p12.
4. Extract the key from the bundle.
# openssl pkcs12 -in /etc/pki/ovirt-engine/keys/apache.p12 -nocerts -nodes &gt;
/etc/pki/ovirt-engine/keys/apache.key.nopass
5. Extract the certificate from the bundle.
# openssl pkcs12 -in /etc/pki/ovirt-engine/keys/apache.p12 -nokeys &gt;
/etc/pki/ovirt-engine/certs/apache.cer
6. Restart the Apache server.
# service httpd restart
4 20
Red Hat Enterprise Virtualization and SSL
Result
Your users can now connect to the portals without being warned about the authenticity of the certificate
used to encrypt https traffic.
Report a bug
4 21
Red Hat Enterprise Virtualization 3.2 Administration Guide
Using Search, Bookmarks, and Tags to Find Your Way Around
E.1. Search
E.1.1. Performing Searches in Red Hat Enterprise Virtualization
T he Administration Portal enables the management of thousands of resources, such as virtual
machines, hosts, users, and more. T o perform a search, enter the search query (free-text or syntaxbased) 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.
Report a bug
E.1.2. Search Syntax and Examples
T he syntax of the search queries for Red Hat Enterprise Virtualization resources is as follows:
result type: {criteria} [sortby sort_spec]
Syntax Examples
T he following examples describe how the search query is used and help you to understand how Red
Hat Enterprise Virtualization assists with building search queries.
T able E.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 username Mary.
Events: severity &gt; normal sortby time
Displays the list of all Events whose severity is
higher than Normal, sorted by time.
Report a bug
E.1.3. Search Auto-Completion
T he 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.
T he following table specifies by example how the Administration Portal auto-completion assists in
constructing a query:
Hosts: Vm s.status = down
4 22
Using Search, Bookmarks, and Tags to Find Your Way Around
T able E.2. Example Search Queries Using Auto-Completion
Input
List Items Displayed
Action
h
Hosts (1 option only)
Select Hosts or;
T ype Hosts
Hosts:
All host properties
T ype v
Hosts: v
host properties starting with a v
Select Vm s or type Vm s
Hosts: Vm s
All virtual machine properties
T ype s
Hosts: Vm s.s
All virtual machine properties
beginning with s
Select status or type status
Hosts: Vm s.status
=
Select or type =
=!
Hosts: Vm s.status =
All status values
Select or type down
Report a bug
E.1.4. Search Result Type Options
T he result type allows you to search for resources of any of the following types:
Vm s for a list of virtual machines
Host for a list of hosts
Pools for a list of pools
T em plate 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 autocomplete feature to create valid queries easily.
Report a bug
E.1.5. Search Criteria
You can specify the search criteria after the colon in the query. T he syntax of {criteria} is as
follows:
&lt;prop&gt;&lt;operator&gt;&lt;value&gt;
or
&lt;obj-type&gt;&lt;prop&gt;&lt;operator&gt;&lt;value&gt;
Examples
4 23
Red Hat Enterprise Virtualization 3.2 Administration Guide
T he following table describes the parts of the syntax:
T able E.3. Example Search Criteria
Part
Description
Values
Example
Note
prop
T he 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.
T hese are system
objects, like data
centers and virtual
machines.
Users
--
operator
Comparison
operators.
=
--
Value options
depend on objtype.
!= (not equal)
&gt;
&lt;
&gt;=
&lt;=
Value
What the
expression is
being compared
to.
String
Jones
Integer
256
Ranking
normal
Date (formatted
according to
Regional Settings)
Report a bug
4 24
Wildcards can
be used within
strings.
&quot;&quot; (two sets of
quotation
marks with no
space
between them)
can be used to
represent an
un-initialized
(empty) string.
Double quotes
should be
used around a
string or date
containing
spaces
Using Search, Bookmarks, and Tags to Find Your Way Around
E.1.6. Search: Multiple Criteria and Wildcards
Wildcards can be used in the &lt;value&gt; 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:
Vm s: users.nam e = m * AND status = Up
T his query returns all running virtual machines for users whose names begin with &quot;m&quot;.
Vm s: users.nam e = m * AND tag = &quot;paris-loc&quot;
T his query returns all virtual machines tagged with &quot;paris-loc&quot; for users whose names begin with &quot;m&quot;.
When two criteria are specified without AND or OR, AND is implied. AND precedes OR, and OR precedes
implied AND.
Report a bug
E.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 &gt; norm al sortby tim e desc
T his query returns all Events whose severity is higher than Normal, sorted by time (descending order).
Report a bug
E.1.8. Searching for Data Centers
T he following table describes all search options for Data Centers.
T able E.4 . Searching for Data Centers
Property (of resource or
resource-type)
T ype
Description (Reference)
Clusters.clusters-prop
Depends on property type
T he property of the clusters
associated with the data center.
name
String
T he name of the data center.
description
String
A description of the data center.
type
String
T he type of data center.
status
List
T he availability of the data
center.
sortby
List
Sorts the returned results by
one of the resource properties.
page
Integer
T he number of results to display
per page.
Example
4 25
Red Hat Enterprise Virtualization 3.2 Administration Guide
Datacenter: type = nfs and status != up
returns a list of data centers with:
A storage type of NFS and status other than up
Report a bug
E.1.9. Searching for Clusters
T he following table describes all search options for clusters.
T able E.5. Searching Clusters
Property (of resource or
resource-type)
T ype
Description (Reference)
Datacenter.datacenter-prop
Depends on property type
T he property of the data center
associated with the cluster.
Datacenter
String
T he data center to which the
cluster belongs.
name
String
T he unique name that identifies
the clusters on the network.
description
String
T he description of the cluster.
initialized
String
T rue or False indicating the
status of the cluster.
sortby
List
Sorts the returned results by
one of the resource properties.
page
Integer
T he number of results to diplay
per page.
Example
Clusters: initialized = true or nam e = Default
returns a list of clusters which are:
initialized; or
named Default
Report a bug
E.1.10. Searching for Hosts
T he following table describes all search options for hosts.
4 26
Using Search, Bookmarks, and Tags to Find Your Way Around
T able E.6. Searching for Hosts
Property (of resource or
resource-type)
T ype
Description (Reference)
Vms.Vms-prop
Depends on property type
T he property of the virtual
machines associated with the
host.
T emplates.templates-prop
Depends on property type
T he property of the templates
associated with the host.
Events.events-prop
Depends on property type
T he property of the events
associated with the host.
Users.users-prop
Depends on property type
T he property of the users
associated with the host.
name
String
T he name of the host.
status
List
T he availability of the host.
cluster
String
T he cluster to which the host
belongs.
address
String
T he unique name that identifies
the host on the network.
cpu_usage
Integer
T he percent of processing
power used.
mem_usage
Integer
T he percentage of memory
used.
network_usage
Integer
T he percentage of network
usage.
load
Integer
Jobs waiting to be executed in
the run-queue per processor, in
a given time slice.
version
Integer
T he version number of the
operating system.
cpus
Integer
T he number of CPUs on the
host.
memory
Integer
T he amount of memory
available.
cpu_speed
Integer
T he processing speed of the
CPU.
cpu_model
String
T he type of CPU.
active_vms
Integer
T he number of Vms currently
running.
migrating_vms
Integer
T he number of Vms currently
being migrated.
committed_mem
Integer
T he percentage of committed
memory.
tag
String
T he tag assigned to the host.
type
String
T he type of host.
datacenter
String
T he data center to which the
host belongs.
sortby
List
Sorts the returned results by
4 27
Red Hat Enterprise Virtualization 3.2 Administration Guide
one of the resource properties.
page
Integer
T he number of results to display
per page.
Example
Hosts: cluster = Default and Vm s.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.
Report a bug
E.1.11. Searching for Networks
T he following table describes all search options for networks.
T able E.7. Searching for Networks
Property (of resource or
resource-type)
T ype
Description (Reference)
Cluster_network.clusternetwo
rk-prop
Depends on property type
T he property of the cluster
associated with the network.
Host_Network.hostnetworkprop
Depends on property type
T he property of the host
associated with the network.
name
String
T he human readable name that
identifies the network.
description
String
Keywords or text describing the
network, optionally used when
creating the network.
vlanid
Integer
T he VLAN ID of the network.
stp
String
Whether Spanning T ree
Protocol (ST P) is enabled or
disabled for the network.
mtu
Integer
T he maximum transmission unit
for the logical network.
vmnetwork
String
Whether the network is only
used for virtual machine traffic.
datacenter
String
T he data center to which the
network is attached.
sortby
List
Sorts the returned results by
one of the resource properties.
page
Integer
T he page number of results to
display.
Example
Network: m tu &gt; 1500 and vm network = true
4 28
Using Search, Bookmarks, and Tags to Find Your Way Around
returns a list of networks:
with a maximum transmission unit greater than 1500 bytes
which are set up for use by only virtual machines.
Report a bug
E.1.12. Searching for Storage
T he following table describes all search options for storage.
T able E.8. Searching for Storage
Property (of resource or
resource-type)
T ype
Description (Reference)
Hosts.hosts-prop
Depends on property type
T he property of the hosts
associated with the storage.
Clusters.clusters-prop
Depends on property type
T he property of the clusters
associated with the storage.
name
String
T he unique name that identifies
the storage on the network.
status
String
T he status of the storage
domain.
datacenter
String
T he data center to which the
storage belongs.
type
String
T he type of the storage.
size
Integer
T he size of the storage.
used
Integer
T he amount of the storage that
is used.
committed
Integer
T he amount of the storage that
is committed.
sortby
List
Sorts the returned results by
one of the resource properties.
page
Integer
T he number of results to display
per page.
Example
Storage: size &gt; 200 or used &lt; 50
returns a list of storage with:
total storage space greater than 200 GB; or
used storage space less than 50 GB.
Report a bug
E.1.13. Searching for Disks
T he following table describes all search options for disks.
4 29
Red Hat Enterprise Virtualization 3.2 Administration Guide
T able E.9. Searching for Disks
Property (of resource or
resource-type)
T ype
Description (Reference)
Datacenters.datacentersprop
Depends on property type
T he property of the data centers
associated with the disk.
Storages.storages-prop
Depends on property type
T he property of the storage
associated with the disk.
alias
String
T he 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
T he virtual size of the disk.
size
Integer
T he size of the disk.
actual_size
Integer
T he actual size allocated to the
disk.
creation_date
Integer
T he 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
T he format of the disk. Can be
one of unused, unassigned,
cow, or raw.
status
String
T he status of the disk. Can be
one of unassigned, ok,
locked, invalid, or
illegal.
disk_type
String
T he type of the disk. Can be
one of im age or lun.
number_of_vms
Integer
T he number of virtual
machine(s) to which the disk is
attached.
vm_names
String
T he name(s) of the virtual
machine(s) to which the disk is
attached.
quota
String
T he name of the quota enforced
on the virtual disk.
sortby
List
Sorts the returned results by
one of the resource properties.
page
Integer
T he page number of results to
display.
4 30
Using Search, Bookmarks, and Tags to Find Your Way Around
Example
Disks: form at = cow and provisioned_size &gt; 8
returns a list of virtual disks with:
Qcow, also known as thin provisioning, format; and
an allocated disk size greater than 8 GB.
Report a bug
E.1.14. Searching for Volumes
T he following table describes all search options for volumes.
T able E.10. Searching for Volumes
Property (of resource or
resource-type)
T ype
Description (Reference)
Volume.cluster-prop
Depends on property type
T he property of the clusters
associated with the volume.
Cluster
String
T he name of the cluster
associated with the volume.
name
String
T he 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
T he 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
T he page number of results to
display.
Example
Volum e: transport_type = rdm a and stripe_count &gt;= 2
returns a list of volumes with:
T ransport type set to RDMA; and
with 2 or more stripes.
Report a bug
E.1.15. Searching for Virtual Machines
4 31
Red Hat Enterprise Virtualization 3.2 Administration Guide
T he following table describes all search options for virtual machines (Vms). Vms can be either virtual
servers or virtual desktops.
4 32
Using Search, Bookmarks, and Tags to Find Your Way Around
T able E.11. Searching for Virtual Machines
Property (of resource or
resource-type)
T ype
Description (Reference)
Hosts.hosts-prop
Depends on property type
T he property of the hosts
associated with the virtual
machine.
T emplates.templates-prop
Depends on property type
T he property of the templates
associated with the virtual
machine.
Events.events-prop
Depends on property type
T he property of the events
associated with the virtual
machine.
Users.users-prop
Depends on property type
T he property of the users
associated with the virtual
machine.
name
String
T he name of the virtual machine.
status
List
T he availability of the virtual
machine.
ip
Integer
T he IP address of the virtual
machine.
uptime
Integer
T he number of minutes that the
virtual machine has been
running.
domain
String
T he domain (usually Active
Directory domain) that groups
these machines.
os
String
T he operating system selected
when the virtual machine was
created.
creationdate
Date
T he date on which the virtual
machine was created.
address
String
T he unique name that identifies
the virtual machine on the
network.
cpu_usage
Integer
T he percent of processing
power used.
mem_usage
Integer
T he percentage of memory
used.
network_usage
Integer
T he percentage of network
used.
memory
Integer
T he maximum memory defined.
apps
String
T he applications currently
installed on the virtual machine.
cluster
List
T he cluster to which the virtual
machine belongs.
pool
List
T he virtual machine pool to
which the virtual machine
belongs.
4 33
Red Hat Enterprise Virtualization 3.2 Administration Guide
loggedinuser
String
T he name of the user currently
logged in to the virtual machine.
tag
List
T he tags to which the virtual
machine belongs.
datacenter
String
T he data center to which the
virtual machine belongs.
type
List
T he virtual machine type (server
or desktop).
quota
String
T he name of the quota
associated with the virtual
machine.
sortby
List
Sorts the returned results by
one of the resource properties.
page
Integer
T he page number of results to
display.
Example
Vm s: tem plate.nam e = Win* and user.nam e = &quot;&quot;
returns a list of VMs, where:
T he template on which the virtual machine is based begins with Win and the virtual machine is
assigned to any user.
Example
Vm s: cluster = Default and os = windowsxp
returns a list of VMs, where:
T he cluster to which the virtual machine belongs is named Default and the virtual machine is running
the Windows XP operating system.
Report a bug
E.1.16. Searching for Pools
T he following table describes all search options for Pools.
T able E.12. Searching for Pools
Property (of resource or
resource-type)
T ype
Description (Reference)
name
String
T he name of the pool.
description
String
T he description of the pool.
type
String
T he type of pool.
sortby
List
Sorts the returned results by
one of the resource properties.
page
Integer
T he page number of results to
display.
4 34
Using Search, Bookmarks, and Tags to Find Your Way Around
Example
Pools: type = autom atic
returns a list of pools with:
T ype of automatic
Report a bug
E.1.17. Searching for Templates
T he following table describes all search options for templates.
T able E.13. Searching for T emplates
Property (of resource or
resource-type)
T ype
Description (Reference)
Vms.Vms-prop
String
T he property of the virtual
machines associated with the
template.
Hosts.hosts-prop
String
T he property of the hosts
associated with the template.
Events.events-prop
String
T he property of the events
associated with the template.
Users.users-prop
String
T he property of the users
associated with the template.
name
String
T he name of the template.
domain
String
T he domain of the template.
os
String
T he type of operating system.
creationdate
Integer
T he date on which the template
was created.
Date format is mm/dd/yy.
childcount
Integer
T he number of Vms created
from the template.
mem
Integer
Defined memory.
description
String
T he description of the template.
status
String
T he status of the template.
cluster
String
T he cluster associated with the
template.
datacenter
String
T he data center associated with
the template.
quota
String
T he quota associated with the
template.
sortby
List
Sorts the returned results by
one of the resource properties.
page
Integer
T he page number of results to
display.
4 35
Red Hat Enterprise Virtualization 3.2 Administration Guide
Example
T em plate: Events.severity &gt;= norm al and Vm s.uptim e &gt; 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.
Report a bug
E.1.18. Searching for Users
T he following table describes all search options for users.
T able E.14 . Searching for Users
Property (of resource or
resource-type)
T ype
Description (Reference)
Vms.Vms-prop
Depends on property type
T he property of the virtual
machines associated with the
user.
Hosts.hosts-prop
Depends on property type
T he property of the hosts
associated with the user.
T emplates.templates-prop
Depends on property type
T he property of the templates
associated with the user.
Events.events-prop
Depends on property type
T he property of the events
associated with the user.
name
String
T he name of the user.
lastname
String
T he last name of the user.
usrname
String
T he unique name of the user.
department
String
T he department to which the
user belongs.
group
String
T he group to which the user
belongs.
title
String
T he title of the user.
status
String
T he status of the user.
role
String
T he role of the user.
tag
String
T he tag to which the user
belongs.
pool
String
T he pool to which the user
belongs.
sortby
List
Sorts the returned results by
one of the resource properties.
page
Integer
T he page number of results to
display.
Example
Users: Events.severity &gt; norm al and Vm s.status = up or Vm s.status = pause
4 36
Using Search, Bookmarks, and Tags to Find Your Way Around
returns a list of users where:
Events of greater than normal severity have occurred on their Vms AND the Vms are still running; or
T he users’ VMs are paused.
Report a bug
E.1.19. Searching for Events
T he following table describes all search options you can use to search for events. Auto-completion is
offered for many options as appropriate.
4 37
Red Hat Enterprise Virtualization 3.2 Administration Guide
T able E.15. Searching for Events
Property (of resource or
resource-type)
T ype
Description (Reference)
Vms.Vms-prop
Depends on property type
T he property of the virtual
machines associated with the
event.
Hosts.hosts-prop
Depends on property type
T he property of the hosts
associated with the event.
T emplates.templates-prop
Depends on property type
T he property of the templates
associated with the event.
Users.users-prop
Depends on property type
T he property of the users
associated with the event.
Clusters.clusters-prop
Depends on property type
T he property of the clusters
associated with the event.
Volumes.Volumes-prop
Depends on property type
T he property of the volumes
associated with the event.
type
List
T ype of the event.
severity
List
T he severity of the event:
Warning/Error/Normal.
message
String
Description of the event type.
time
Integer
T ime at which the event
occurred.
usrname
String
T he username associated with
the event.
event_host
String
T he host associated with the
event.
event_vm
String
T he virtual machine associated
with the event.
event_template
String
T he template associated with
the event.
event_storage
String
T he storage associated with the
event.
event_datacenter
String
T he data center associated with
the event.
event_volume
String
T he volume associated with the
event.
correlation_id
Integer
T he identification number of the
event.
sortby
List
Sorts the returned results by
one of the resource properties.
page
Integer
T he page number of results to
display.
Example
Events: Vm s.nam e = testdesktop and Hosts.nam e = gonzo.exam ple.com
4 38
Using Search, Bookmarks, and Tags to Find Your Way Around
returns a list of events, where:
T he event occurred on the virtual machine named testdesktop while it was running on the host
gonzo.exam ple.com .
Report a bug
E.2. Bookmarks
E.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 E.1. Saving a Query String as a Bookmark
1. Enter the desired search query in the search bar and perform the search.
2. Click the star-shaped Bookm ark button to the right of the search bar to open the New
Bookm ark window.
Figure E.1. Bookmark Icon
3. Enter the Nam e of the bookmark.
4. Edit the Search string field (if applicable).
5. Click OK to save the query as a bookmark and close the window.
6. T he search query is saved and displays in the Bookm arks pane.
Result
You have saved a search query as a bookmark for future reuse. Use the Bookm ark pane to find and
select the bookmark.
Report a bug
E.2.2. Editing a Bookmark
Summary
You can modify the name and search string of a bookmark.
Procedure E.2. Editing a Bookmark
4 39
Red Hat Enterprise Virtualization 3.2 Administration Guide
1. Click the Bookm arks tab on the far left side of the screen.
2. Select the bookmark you wish to edit.
3. Click the Edit button to open the Edit Bookm ark window.
4. Change the Nam e and Search string fields as necessary.
5. Click OK to save the edited bookmark.
Result
You have edited a bookmarked search query.
Report a bug
E.2.3. Deleting a Bookmark
Summary
When a bookmark is no longer needed, remove it.
Procedure E.3. Deleting a Bookmark
1. Click the Bookm arks tab on the far left side of the screen.
2. Select the bookmark you wish to remove.
3. Click the Rem ove button to open the Rem ove Bookm ark window.
4. Click OK to remove the selected bookmark.
Result
You have removed a bookmarked search query.
Report a bug
E.3. Tags
E.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. T ags provide one key advantage to system
administrators: they allow system resources to be arranged into groups or categories. T his is useful
when many objects exist in the virtualization environment and the administrator would like to concentrate
on a specific set of them.
T his section describes how to create and edit tags, assign them to hosts or virtual machines and search
using the tags as criteria. T ags can be arranged in a hierarchy that matches a structure, to fit the needs
of the enterprise.
Administration Portal T ags can be created, modified, and removed using the T ags pane.
Report a bug
E.3.2. Creating a Tag
Summary
440
Using Search, Bookmarks, and Tags to Find Your Way Around
You can edit the name and description of a tag.
Procedure E.4 . Creating a T ag
1. Click the T ags tab on the left side of the screen.
2. Select the node under which you wish to create the tag. For example, to create it at the highest
level, click the root node.
3. Click the New button to open the New T ag window.
4. Enter the Nam e and Description of the new tag.
5. Click OK to create the tag.
Result
T he new tag is created and displays on the T ags tab.
Report a bug
E.3.3. Modifying a Tag
Summary
You can edit the name and description of a tag.
Procedure E.5. Modifying a T ag
1. Click the T ags tab on the left side of the screen.
2. Select the tag you wish to modify.
3. Click Edit to open the Edit T ag window.
4. Change the Nam e and Description fields as necessary.
5. Click OK to save the edited tag.
Result
You have modified the properties of a tag.
Report a bug
E.3.4. Deleting a Tag
Summary
When a tag is no longer needed, remove it.
Procedure E.6. Deleting a T ag
1. Click the T ags tab on the left side of the screen.
2. Select the tag you wish to delete.
3. Click Rem ove to open the Rem ove T ag(s) window. T he message warns you that removing the
tag will also remove all descendants of the tag.
4. Click OK to delete the selected tag.
Result
441
Red Hat Enterprise Virtualization 3.2 Administration Guide
You have removed the tag and all its descendants. T he tag is also removed from all the objects that it
was attached to.
Report a bug
E.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 E.7. Adding and Removing T ags to and from Objects
1. Use the resource tab, tree mode, or the search function to find and select the object(s) you wish
to tag or untag.
2. Click the Assign T ags button to open the Assign T ags window.
3. Select the check box to assign a tag to the object, or deselect the check box to detach the tag
from the object.
4. Click OK.
Result
T he specified tag is now added or removed as a custom property of the selected object(s).
Report a bug
E.3.6. Searching for Objects using Tags
Enter a search query using tag as the property and the desired value or set of values as criteria for
the search.
T he objects tagged with the specified criteria are listed in the results list.
See Also:
Section E.1, “Search”
Report a bug
442
Revision History
Revision History
Revision 3.2-55.4 02
Rebuild with Publican 4.0.0
T ue Nov 12 2013
R&uuml;diger Landmann
Revision 3.2-55
Wed Nov 06 2013
Z ac Dover
BZ #1026104 - SUSE Enterprise Linux Server 10 and SUSE Enterprise Linux Server 11 support
documented
Revision 3.2-54
Fri Oct 25 2013
Jodi Biddle
BZ #1014950 - Fixed yet more long strings that were causing the PDF to render at 75% size.
Revision 3.2-53
Mon Oct 14 2013
Jodi Biddle
BZ #1014950 - Fixed more long strings that were causing the PDF to render at half size.
Revision 3.2-52
Wed 25 Sep 2013
Jodi Biddle
BZ #1004698 - Fixed issue that was causing text in the PDF to appear tiny/unreadable.
Revision 3.2-51
Wed 21 Aug 2013
T im Hildred
Corrected &quot;Virtual Machine Run Once Settings&quot; to note that SPICE is a not supported display protocol
for connecting to Windows 8 virtual machines.
Revision 3.2-50
Mon 19 Aug 2013
Andrew Burden
BZ #996439 - Included distinction between clusters that run virtual machines and clusters that run Red
Hat Storage servers.
Revision 3.2-4 9
Mon 19 Aug 2013
T im Hildred
BZ #612810 - Resolved a confusing typo in &quot;Preparing iSCSI Storage&quot;.
Revision 3.2-4 8
Fri 16 Aug 2013
T im Hildred
BZ #921114 - Added procedure allowing use of VirtIO devices with Windows virtual machines.
BZ #719765 - Updated selector to send specific messages to server.
BZ #719765 - Updated semanage command.
BZ #988619 - Made it clear that Windows 8 and Server 2012 virtual machines do not have SPICE
support.
BZ #974515 - Updated clone from snapshot content.
BZ #965039 - Hypervisor hosts cannot be added to Gluster-enabled clusters.
BZ #612810 - Added &quot;Preparing iSCSI Storage&quot;.
BZ #985018 - T he log file created at engine-setup time was incorrectly shown with hyphen rather than
an underscore.
BZ #977212 - Differentiation between hypervisor clusters and storage clusters
BZ #986735 - Updated host firewall ports to reflect change SPICE range.
Revision 3.2-4 7
Fri 16 Aug 2013
Z ac Dover
BZ #965337 - adding a full stop, the absence of which was caught by QE
Revision 3.2-4 6
T hu 15 Aug 2013
BZ #978799 - adding Spice proxy configuration information
Z ac Dover
Revision 3.2-4 5
Z ac Dover
Wed 14 Aug 2013
443
Red Hat Enterprise Virtualization 3.2 Administration Guide
No BZ # - test
Revision 3.2-4 4
Wed 14 Aug 2013
No BZ # - restaging to pick up recent changes
Z ac Dover
Revision 3.2-4 3
T hu 01 Aug 2013
BZ #976169 - documenting Red Hat Support Plugin
Z ac Dover
Revision 3.2-4 3
T ue Jun 25 2013
T im Hildred
BZ #974366, added cli example of rhn-channel to step 1
BZ #958909, added step requiring user to remove Red Hat Enterprise Virtualization 3.0 channels before
upgrading to 3.1
Revision 3.2-4 2
Fixes from localization.
Mon 24 Jun 2013
Cheryn T an
Revision 3.2-4 1
Wed 12 Jun 2013
Jodi Biddle
BZ #956777 - Updated out of date information regarding edit template window
Revision 3.2-4 0
T ue 11 Jun 2013
Andrew Burden
BZ #954215 - Updated Introduction topic to T emplates to be more relevant
Revision 3.2-39
T ue 11 Jun 2013
BZ #973010 - the hazards of running services on RHEV nodes
Z ac Dover
Revision 3.2-38
T hu 30 May 2013
BZ #957299 - added admonition about stateless virtual machines
Jodi Biddle
Revision 3.2-37
Mon 27 May 2013
BZ #875500 - specified 'user' subject for 'history-readonly' user
Andrew Burden
Revision 3.2-36
Mon 20 May 2013
Andrew Burden
Fixed Reports section parameters
Corrected instances of 'rhev-hypervisor-advanced' to 'rhev-hypervisor'
Revision 3.2-35
Fri 10 May 2013
Fixed a few minor localisation syncing issues
Andrew Burden
Revision 3.2-34
Corrected several typos
Andrew Burden
T ue 07 May 2013
Revision 3.2-33
T ue 23 Apr 2013
Z ac Dover
BZ #871531 - added &lt;guilabel&gt; tags to &quot;Max free Memory for scheduling new VMs&quot;
Revision 3.2-32
T ue 23 Apr 2013
BZ #871531 - moved an admonition into a table where it belongs
Z ac Dover
Revision 3.2-31
Wed Apr 17 2013
T im Hildred
BZ #949360 - added program name to the APT topic, and made itclear the APT stands for Application
444
Revision History
Provisioning T ool
Revision 3.2-30
Mon Apr 15 2013
BZ #950861 - removed unsupported fence agents
T im Hildred
Revision 3.2-29
T hu 11 Apr 2013
Z ac Dover
BZ #871531 - documenting &quot;Max free Memory for scheduling new VMs&quot;
BZ #889052 - documenting User Spice Session Activity Reports
Revision 3.2-28
T hu 11 Apr 2013
Cheryn T an
Changed references of Gluster to Red Hat Storage, minor RHN changes, reports updates.
Revision 3.2-27
Mon 08 Apr 2013
T im Hildred
Updated screenshots, moved the utilities content out of appendix, and added part 3 for the reports
content.
Revision 3.2-26
T hu 04 Apr 2013
T im Hildred
BZ #929350 - added notes to backups content about upgraded environments
Revision 3.2-25
T ue 02 Apr 2013
BZ #891732 - information about pinning CPUs to hosts
Z ac Dover
Revision 3.2-24
BZ #857789 - one typo
Sun 31 March 2013
Z ac Dover
Revision 3.2-23
Wed 27 March 2013
BZ #857789 - numerous small issues
Z ac Dover
Revision 3.2-22
T ue 26 March 2013
BZ #892824 - corrected filepaths for rhevm backup
Andrew Burden
Revision 3.2-21
Mon 25 March 2013
Cheryn T an
Red Hat Storage content for review -- BZ #892437, 887385, 892435, 892376
Revision 3.2-20
Fri 22 March 2013
BZ #854247 - s/excced/exceed
Z ac Dover
Revision 3.2-19
Fri 22 March 2013
Z ac Dover
BZ #924535 - splitting one topic into several to improve granularity and likelihood of reuse
Revision 3.2-18
Fri 22 March 2013
BZ #857790 - various minor corrections
Z ac Dover
Revision 3.2-17
T hu 21 March 2013
BZ #888481 installation update
Andrew Burden
Revision 3.2-16
T ue 19 March 2013
Z ac Dover
BZ #893210 - Correcting the name of the guest agent package from &quot;rhev-guest-agent&quot; to &quot;rhevmguest-agent&quot;
445
Red Hat Enterprise Virtualization 3.2 Administration Guide
Revision 3.2-15
BZ #889107 - minor fixes
Mon 18 March 2013
Z ac Dover
Revision 3.2-14
BZ #889107 - minor fixes
Fri 15 March 2013
Z ac Dover
Revision 3.2-13
T hu 14 March 2013
BZ #912181 - IPA Admin User admonition
BZ #912185 - Update VM Resource allocation table
BZ #892023 - host installation with tuned
BZ #889403 - hotplugging networks
Andrew Burden
Revision 3.2-12
T ue 12 March 2013
Cheryn T an
BZ #889403 - Documented network linking and hotplug options.
BZ #889406 - Deleting virtual machines and leaving floating disks.
BZ #892390 - Added multi-tier fencing options.
BZ #892429 - Documented network permissions.
Revision 3.2-11
s/UI/User Interface/g
T hu 07 March 2013
Z ac Dover
Revision 3.2-10
BZ #889107
T hu 07 March 2013
Z ac Dover
Revision 3.2-9
Staging for Beta 1.
Fri 01 March 2013
T im Hildred
Revision 3.2-8
T hu 28 Feb 2013
T im Hildred
Updated Connecting to the History Database content (8281). Added procedure for remote connections.
BZ #875500.
Revision 3.2-7
T ue 26 Feb 2013
Changed revision numbers for consistency with other books.
T im Hildred
Revision 3.2-6
T ue 26 Feb 2013
Z ac Dover
BZ #889107 - Added topic describing the deployment of ShellInABox User Interface Plugin
Revision 3.2-5
Fri 22 Feb 2013
BZ #891712 - Added VDSM hooks for hot unplug NIC.
BZ #889409 - Documented search functions for networks.
BZ #889061 - Added iLO2 and iLO4 as fencing options.
BZ #889503 - Edited description of vhost custom property.
BZ #888515 - Updated rhevm-config values.
Andrew Burden
Revision 3.2-4
Wed 20 Feb 2013
BZ #889107 - RHEV UI Plugins - adding bootstrapping material
Z ac Dover
Revision 3.2-3
Fri 15 Feb 2013
Andrew Burden
BZ # 892009 - Added topic to better address events and logs when a VM is restarted due to High
446
Revision History
Availability
Revision 3.2-2
Mon 11 Feb 2013
BZ # 881502 - added Windows 8 to supported guest OS list
Jodi Biddle
Revision 3.2-1
Fri 10 Feb 2013
BZ #889107 - RHEV UI Plugins
Branched from 3.1 docs.
Z ac Dover
447
">

Hello! I am the AI assistant for the Red Hat Enterprise Virtualization 3.2 Administration Guide. I have read through this document and can answer your questions about managing your virtualization environment, from setting up data centers to deploying virtual machines. Ask me anything!

Show related prompts

Assistant typing

Assistant is out of keyboard. Please, try again later.

Key features

Data center management
Cluster configuration
Host management
Storage administration
Virtual machine deployment
Template creation
User role configuration

Frequently asked questions

The Storage Pool Manager (SPM) is responsible for managing storage resources within a data center.

You can create a new virtual machine from an existing template or from a blank template using the Administration Portal.

Live Migration is the process of moving a running virtual machine from one host to another without significant downtime.

What is the purpose of the Storage Pool Manager (SPM)?

How do I create a new virtual machine?

What is Live Migration?

Related

Red Hat Virtualization 3.2 Guide: AI Chat & PDF

Red Hat Enterprise Virtualization 2.2 Servers Administration Guide

Red Hat Enterprise Virtualization 3.0 Guide | AI Chat & PDF Download

Red Hat Enterprise Virtualization 3.0 Quick Start Guide

eG Innovations RHEV Manual: AI Chat & PDF Download

Red Hat Enterprise Virtualization 3.0 Guide | AI Chat & PDF

EayunOS 4.0 安装指南 | AI 聊天 & PDF 下载

Red Hat Virtualization 4.0 Administration Guide

Red Hat Virtualization 4.1 Guide: AI Chat & PDF Access

Red Hat Virtualization 4.1 Administration Guide

Red Hat Enterprise Virtualization 3.0 REST API Guide

Red Hat Enterprise Virtualization User Guide