3.2 Beta
Administration Guide
Administrating Red Hat Enterprise Virtualization Environments.
Jodi Biddle
Andrew Burden
Zac Dover
Steve Gordon
Tim Hildred
Dayle Parker
Anjana Sriram
Cheryn Tan
Jodi Biddle
jbiddle@redhat .com
Andrew Burden
aburden@redhat .com
Zac Dover
zdover@redhat .com
St eve Gordon
sgordon@redhat .com
Tim Hildred
t hildred@redhat .com
Dayle Parker
dayparke@redhat .com
Anjana Sriram
Red Hat Engineering Cont ent Services
asriram@redhat .com
Cheryn Tan
chet an@redhat .com
Legal Notice
Copyright 2013 Red Hat, Inc. The text of and illustrations in this document are licensed by Red Hat under
a Creative Commons AttributionShare Alike 3.0 Unported license ("CC-BY-SA"). An explanation of CCBY-SA is available at . In accordance with CC-BY-SA, if you distribute this document or an adaptation of
it, you must provide the URL for the original version. Red Hat, as the licensor of this document, waives the
right to enforce, and agrees not to assert, Section 4d of CC-BY-SA to the fullest extent permitted by
applicable law. Red Hat, Red Hat Enterprise Linux, the Shadowman logo, JBoss, MetaMatrix, Fedora, the
Infinity Logo, and RHCE are trademarks of Red Hat, Inc., registered in the United States and other
countries. Linux is the registered trademark of Linus Torvalds in the United States and other countries.
Java is a registered trademark of Oracle and/or its affiliates. XFS is a trademark of Silicon Graphics
International Corp. or its subsidiaries in the United States and/or other countries. MySQL is a registered
trademark of MySQL AB in the United States, the European Union and other countries. All other
trademarks are the property of their respective owners. 1801 Varsity Drive Raleigh, NC 27 606-207 2 USA
Phone: +1 919 7 54 37 00 Phone: 888 7 33 4281 Fax: +1 919 7 54 37 01
Keywords
Abstract
This book contains information and procedures relevant to Red Hat Enterprise Virtualization
administrators. Note: This document is under development, is subject to substantial change, and is
provided only as a preview. The included information and instructions should not be considered complete,
and should be used with caution.
Table of Contents
Table of Contents
.Preface
...............................................................................
1. Document Conventions
1.1. T ypographic Conventions
1.2. Pull-quote Conventions
1.3. Notes and Warnings
2. Getting Help and Giving Feedback
2.1. Do You Need Help?
2.2. We Need Feedback!
14
14
14
15
15
15
15
15
.Chapter
. . . . . . . . 1.
. . .Using
. . . . . . this
. . . . .Guide
.........................................................
1.1. Administration Guide Prerequisites
1.2. Administration Guide Layout
1.3. Example Workflows
1.3.1. Administration Guide Example Workflows Overview
1.3.2. Administration Guide Example Workflow: New iSCSI Data Center
1.3.3. Administration Guide Example Workflow: Newly Virtualized Workload
1.3.4. Administration Guide Example Workflow: T emplate for Group Use
17
17
17
17
17
17
18
18
.Chapter
. . . . . . . . 2.
. . .Basics
....................................................................
2.1. Introduction
2.1.1. Red Hat Enterprise Virtualization Architecture
2.1.2. Red Hat Enterprise Virtualization System Components
2.1.3. Red Hat Enterprise Virtualization Resources
2.1.4. Red Hat Enterprise Virtualization API Support Statement
2.1.5. SPICE
2.1.6. Administering and Maintaining the Red Hat Enterprise Virtualization Environment
19
19
19
19
19
20
21
21
22
22
22
23
24
24
. . . . . I.
Part
. . Administering
. . . . . . . . . . . . . . .the
. . . .Resources
......................................................
26
.Chapter
. . . . . . . . 3.
. . .Data
. . . . . Centers
...............................................................
3.1. Introduction to Data Centers
3.2. T he Storage Pool Manager (SPM)
3.3. SPM Priority
3.4. Using the Events T ab to Identify Problem Objects in Data Centers
3.5. Data Center T asks
3.5.1. Creating a New Data Center
3.5.2. Explanation of Settings in the New Data Center and Edit Data Center Windows
3.5.3. Editing a Resource
3.5.4. Creating a New Logical Network in a Data Center or Cluster
3.5.5. Re-Initializing a Data Center: Recovery Procedure
3.5.6. Removing a Data Center
3.5.7. Force Removing a Data Center
3.6. Data Centers and Storage Domains
3.6.1. Attaching an Existing Data Domain to a Data Center
3.6.2. Attaching an Existing ISO domain to a Data Center
3.6.3. Attaching an Existing Export Domain to a Data Center
27
27
28
28
28
28
28
29
29
30
30
31
31
31
31
32
32
32
33
33
33
34
34
34
.Chapter
........4
. ...Clusters
....................................................................
36
4.1. Introduction to Clusters
36
4.2. Cluster T asks
36
4.2.1. Creating a New Cluster
36
4.2.2. Explanation of Settings and Controls in the New Cluster and Edit Cluster Windows
37
4.2.2.1. General Cluster Settings Explained
37
4.2.2.2. Optimization Settings Explained
38
4.2.2.3. Resilience Policy Settings Explained
39
4.2.2.4. Cluster Policy Settings Explained
40
4.2.3. Editing a Resource
41
4.2.4. Importing an Existing Red Hat Storage Cluster
41
4.2.5. Explanation of Settings in the Add Hosts Window
43
4.2.6. Setting Load and Power Management Policies for Hosts in a Cluster
43
4.2.7. Creating a New Logical Network in a Data Center or Cluster
44
4.2.8. Removing a Cluster
45
4.2.9. Designate a Specific T raffic T ype for a Logical Network with the Assign/UnAssign Window
46
4.2.10. Explanation of Settings in the Assign/UnAssign Window
46
4.3. Clusters and Permissions
47
4.3.1. Managing System Permissions for a Cluster
47
4.3.2. Cluster Administrator Roles Explained
47
4.3.3. Assigning an Administrator or User Role to a Resource
47
4.3.4. Removing an Administrator or User Role from a Resource
48
.Chapter
. . . . . . . . 5.
. . .Logical
. . . . . . . .Networks
............................................................
49
5.1. Introduction to Logical Networks
49
5.2. Port Mirroring
49
5.3. Required Networks, Optional Networks, and Virtual Machine Networks
50
5.4. Logical Network T asks
50
5.4.1. Creating a New Logical Network in a Data Center or Cluster
50
5.4.2. Explanation of Settings and Controls in the New Logical Network and Edit Logical Network
Windows
51
5.4.3. Editing a Logical Network
53
5.4.4. Designate a Specific T raffic T ype for a Logical Network with the Assign/UnAssign Window
53
5.4.5. Explanation of Settings in the Assign/UnAssign Window
54
5.4.6. Adding Multiple VLANs to a Single Network Interface using Logical Networks
54
5.4.7. Using the Networks T ab
55
5.5. Logical Networks and Permissions
56
5.5.1. Managing System Permissions for a Network
56
5.5.2. Network Administrator and User Roles Explained
56
5.5.3. Assigning an Administrator or User Role to a Resource
57
5.5.4. Removing an Administrator or User Role from a Resource
57
.Chapter
. . . . . . . . 6.
. . .Hosts
....................................................................
6.1. Introduction to Red Hat Enterprise Virtualization Hosts
6.2. Red Hat Enterprise Virtualization Hypervisor Hosts
6.3. Red Hat Enterprise Linux Hosts
6.4. Host T asks
6.4.1. Adding a Red Hat Enterprise Linux Host
59
59
59
60
60
60
Table of Contents
6.4.2. Explanation of Settings and Controls in the New Host and Edit Host Windows
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
60
60
61
64
64
64
65
65
65
66
66
66
67
67
67
68
69
70
70
70
70
71
72
72
73
73
73
74
74
.Chapter
. . . . . . . . 7.
. . .Storage
....................................................................
7.1. Introduction to Storage in Red Hat Enterprise Virtualization
7.2. Understanding Storage Domains
7.3. Storage Metadata Versions in Red Hat Enterprise Virtualization
7.4. Preparing and Adding File-based Storage
7.4.1. Preparing NFS Storage
7.4.2. Attaching NFS Storage
7.4.3. Preparing Local Storage
7.4.4. Adding Local Storage
7.5. Adding POSIX Compliant File System Storage
7.5.1. POSIX Compliant File System Storage in Red Hat Enterprise Virtualization
7.5.2. Attaching POSIX Compliant File System Storage
7.6. Adding Block-based Storage
7.6.1. Storage multipathing
7.6.2. Adding iSCSI Storage
7.6.3. Adding FCP Storage
7.6.4. Un-useable LUNs in Red Hat Enterprise Virtualization
7.7. Storage T asks
7.7.1. Importing existing ISO or export storage domains
7.7.2. Populating the ISO Storage Domain
7.7.3. Moving storage domains to maintenance mode
7.7.4. Editing a Resource
7.7.5. Activating storage domains
7.7.6. Removing a storage domain
7.7.7. Destroying a storage domain
7.7.8. Detaching the Export Domain
75
75
75
76
76
76
77
78
79
79
80
80
81
81
81
82
83
84
84
85
86
86
87
87
87
87
88
88
88
88
90
91
92
92
93
93
93
94
94
94
95
95
95
95
95
96
.Chapter
. . . . . . . . 8.
. . .Virtual
. . . . . . . Machines
.............................................................
97
8.1. Introduction to Virtual Machines
97
8.2. Supported Virtual Machine Operating Systems
97
8.3. Virtual Machine Performance Parameters
97
8.4. Creating Virtual Machines
97
8.4.1. Creating a New Virtual Machine from an Existing T emplate
97
8.4.2. Creating a New Virtual Machine from a Blank T emplate
98
8.4.3. Explanation of Settings and Controls in the New Virtual Machine and Edit Virtual Machine
Windows
99
8.4.3.1. Virtual Machine General Settings Explained
99
8.4.3.2. Virtual Machine Initial Run Settings Explained
100
8.4.3.3. Virtual Machine Console Settings Explained
101
8.4.3.4. Virtual Machine Host Settings Explained
102
8.4.3.5. Virtual Machine High Availability Settings Explained
103
8.4.3.6. Virtual Machine Resource Allocation Settings Explained
104
8.4.3.7. Virtual Machine Boot Options Settings Explained
104
8.4.3.8. Virtual Machine Custom Properties Settings Explained
105
8.4.4. Creating a Cloned Virtual Machine from an Existing T emplate
106
8.4.5. Completing the Configuration of a Virtual Machine by Defining Network Interfaces and Hard
Disks
107
8.4.6. Installing a Guest Operating System onto a Virtual Machine
109
8.4.7. Virtual Machine Run Once Settings Explained
109
8.5. Using Virtual Machines
111
8.5.1. SPICE
111
8.5.2. Powering on a Virtual Machine
111
8.5.3. Installing SPICE Plugins in Windows and Linux
111
8.5.4. Logging in to a Virtual Machine
112
8.6. Shutting Down or Pausing Virtual Machines
112
8.6.1. Shutting Down or Pausing Virtual Machines
112
8.6.2. Shutting Down a Virtual Machine
113
8.6.3. Pausing a Virtual Machine
113
8.7. Managing Virtual Machines
113
8.7.1. Editing a Resource
113
8.7.2. Removing a Virtual Machine
114
8.7.3. Adding and Editing Virtual Machine Disks
114
Table of Contents
139
139
139
139
140
140
140
141
141
141
141
142
142
143
143
143
143
144
144
144
145
145
146
.Chapter
. . . . . . . . 10.
. . . . Pools
...................................................................
10.1. Introduction to Virtual Machine Pools
10.2. Virtual Machine Pool T asks
10.2.1. Creating a Virtual Machine Pool
10.2.2. Editing a Resource
10.2.3. Prestarting Virtual Machines in a Pool
10.2.4. Adding Virtual Machines to a Virtual Machine Pool
10.2.5. Detaching Virtual Machines from a Virtual Machine Pool
10.2.6. Removing a Virtual Machine Pool
10.3. Pools and Permissions
10.3.1. Managing System Permissions for a Virtual Machine Pool
10.3.2. Virtual Machine Pool Administrator Roles Explained
10.3.3. Assigning an Administrator or User Role to a Resource
10.3.4. Removing an Administrator or User Role from a Resource
14 7
147
147
147
148
148
148
149
149
149
149
150
150
150
.Chapter
. . . . . . . . 11.
. . . . Virtual
. . . . . . . Machine
. . . . . . . . . .Disks
..................................................
11.1. Understanding Virtual Machine Storage
11.2. Understanding Virtual Disks
11.3. Shareable Disks in Red Hat Enterprise Virtualization
11.4. Creating Unassociated Virtual Machine Hard Disks
11.5. Explanation of Settings in the New Virtual Machine Disk and Edit Virtual Machine Disk
Windows
11.6. Moving a Virtual Machine Hard Disk Between Data Domains
11.7. Virtual Disks and Permissions
11.7.1. Managing System Permissions for a Virtual Disk
11.7.2. Virtual Disk User Roles Explained
11.7.3. Assigning an Administrator or User Role to a Resource
11.7.4. Removing an Administrator or User Role from a Resource
152
152
152
153
153
. . . . . II.
Part
. . .Administering
. . . . . . . . . . . . . . the
. . . . Environment
......................................................
158
.Chapter
. . . . . . . . 12.
. . . . Users
. . . . . . .and
. . . .Roles
........................................................
12.1. Introduction to Users
12.2. Directory Users
12.2.1. Directory Services Support in Red Hat Enterprise Virtualization
12.3. User Authorization
12.3.1. User Authorization Model
12.3.2. User Actions
12.3.3. User Permissions
12.4. Red Hat Enterprise Virtualization Manager User Properties and Roles
159
159
159
159
160
160
160
161
161
10
154
156
156
156
156
157
157
Table of Contents
161
162
162
163
164
164
165
165
166
166
166
167
167
.Chapter
. . . . . . . . 13.
. . . .Quotas
...................................................................
13.1. Introduction to Quota
13.2. Shared Quota and Individually-defined Quota
13.3. Quota Accounting
13.4. Enabling and Changing a Quota Mode in a Data Center
13.5. Creating a New Quota Policy
13.6. Explanation of Quota T hreshold Settings
13.7. Assigning a Quota to an Object
13.8. Using Quota to Limit Resources by User
13.9. Editing Quotas
13.10. Removing Quotas
170
170
170
171
171
171
172
172
173
175
176
.Chapter
. . . . . . . . 14
. . . .. Event
. . . . . . .Notifications
............................................................
14.1. Configuring Event Notifications
14.2. Parameters for event notifications in notifier.conf
14.3. Canceling Event Notifications
177
177
177
178
.Chapter
. . . . . . . . 15.
. . . . Utilities
...................................................................
179
15.1. Managing Domains with the Domain Management T ool
179
15.1.1. What is the Domain Management T ool?
179
15.1.2. Syntax for the Domain Management T ool
179
15.1.3. Using the Domain Management T ool
180
15.1.4. Adding Domains to Configuration
180
15.1.5. Editing a Domain in the Configuration
180
15.1.6. Deleting a Domain from the Configuration
181
15.1.7. Validating Domain Configuration
181
15.1.8. Listing Domains in Configuration
181
15.1.9. Getting a Configuration Value
181
15.1.10. Setting a Configuration Value
182
15.2. Editing the Configuration of the Red Hat Virtualization Manager with the Configuration T ool
182
15.2.1. Configuration T ool
182
15.2.2. Syntax for rhevm-config Command
182
15.2.3. T he admin@internal user
183
15.2.4. Changing the password for admin@internal
183
15.2.5. Configuration tool examples
183
15.2.6. Red Hat Enterprise Virtualization Manager Configuration Options
Explanations, Limitations, and Best Practices
183
15.3. Uploading Virtual Machine Images with the Image Uploader T ool
195
15.3.1. Virtual Machine Image Uploader
195
15.3.2. Syntax for the rhevm-image-uploader Command
196
15.3.3. Creating an OVF Archive T hat Is Compatible with the Image Uploader
197
15.3.4. Basic rhevm-image-uploader Usage Examples
197
11
216
216
216
216
217
217
218
218
219
219
220
222
222
.Chapter
. . . . . . . . 18.
. . . . Backups
...................................................................
18.1. Backing Up the Engine Database Using the backup.sh Script
18.2. Restoring the Engine Database Using the restore.sh Script
18.3. Backing Up Manager Configuration Files
224
224
224
225
12
Table of Contents
225
227
.Chapter
. . . . . . . . 19.
. . . . Reports,
. . . . . . . . . History
. . . . . . . . Database
. . . . . . . . . . .Reports,
. . . . . . . . . and
. . . . .Dashboards
.........................
228
19.1. Reports
228
19.1.1. Reports
228
19.1.2. JasperReports and JasperServer in Red Hat Enterprise Virtualization
228
19.1.3. Online Help for JasperReports
228
19.1.4. Jasper Reports System Requirements
228
19.1.5. Users in the Red Hat Enterprise Virtualization Reports Portal
229
19.1.6. Logging in to Access the Reports Portal
229
19.1.7. Accessing the Red Hat Enterprise Virtualization Reports User Management Menu
230
19.1.8. Reports Portal User Roles
230
19.1.9. Navigating Reports and Dashboards
230
19.1.10. Report Parameters
231
19.1.11. Right-click Reporting Integration with the Red Hat Enterprise Virtualization Administration
Portal
233
19.1.12. Executive Reports
233
19.1.12.1. Executive reports: active virtual machines by operating system
233
19.1.12.2. Executive Reports: Cluster Capacity Versus Usage
234
19.1.12.3. Executive Reports: Host Operating System Break Down
235
19.1.12.4. Executive Reports: Summary of Host Usage Resources
235
19.1.13. Inventory Reports
236
19.1.13.1. Inventory Reports: Hosts Inventory
236
19.1.13.2. Inventory Reports: Storage Domain Over T ime
236
19.1.13.3. Inventory Reports: Virtual Machines Inventory
236
19.1.13.4. Inventory Reports: Virtual Machine Inventory for Cloud and Hosting Service Provider
237
19.1.14. Service Level Reports
237
19.1.14.1. Service Level Reports: Cluster Host Uptime
237
19.1.14.2. Service Level Reports: Cluster Quality of Service for Hosts
238
19.1.14.3. Service Level Reports: Cluster Quality of Service for Virtual Machines
239
19.1.14.4. Service Level Reports: Single Host Uptime
240
19.1.14.5. Service Level Reports: T op 10 Downtime Hosts
241
19.1.14.6. Service Level Reports: High Availability Virtual Servers Uptime
242
19.1.15. T rend Reports
243
19.1.15.1. T rend Reports: Five Least Utilized Hosts Over T ime
243
19.1.15.2. T rend Reports: Five Least Utilized Virtual Machines Over T ime
243
19.1.15.3. T rend Reports: Five Most Utilized Hosts Over T ime
244
19.1.15.4. T rend Reports: Five Most Utilized Virtual Machines Over T ime
245
19.1.15.5. T rend Reports: Multiple Hosts Resource Usage Over T ime
246
19.1.15.6. T rend Reports: Multiple Virtual Machines Resource Usage Over T ime
247
19.1.15.7. T rend Reports: Single Host Resource Usage by Days of the Week
248
19.1.15.8. T rend Reports: Single Host Resource Usage by Hour of the Day
249
19.1.15.9. T rend Reports: Single Virtual Machine Resource Usage by Day of the Week
250
19.1.15.10. T rend Reports: Single Virtual Machine Resource Usage by Hour of the
Day
251
19.1.15.11. T rend Reports: Single Virtual Machine Resource Usage Over T ime
252
19.1.16. Ad Hoc Reports
253
19.1.17. Reports Schema: T ag History and ENUM Views
253
19.2. History Database Reports
254
19.2.1. Red Hat Enterprise Virtualization History Database
254
19.2.2. T racking Configuration History
255
19.2.3. Recording Statistical History
255
19.2.4. T racking T ag History
255
13
277
277
278
280
280
.VDSM
. . . . . .and
. . . . Hooks
.....................................................................
B.1. VDSM
B.2. VDSM Hooks
B.3. Extending VDSM with Hooks
B.4. Supported VDSM Events
B.5. T he VDSM Hook Environment
B.6. T he VDSM Hook Domain XML Object
B.7. Defining Virtual Machine Custom Properties
B.8. Setting Virtual Machine Custom Properties
B.9. Evaluating Virtual Machine Custom Properties in a VDSM Hook
B.10. Using the VDSM Hooking Module
B.11. VDSM Hook Execution
B.12. VDSM Hook Return Codes
B.13. VDSM Hook Examples
281
281
281
281
281
282
282
283
283
284
284
284
285
285
. . . . .Hat
Red
. . . . Enterprise
. . . . . . . . . . . .Virtualization
. . . . . . . . . . . . . .User
. . . . . Interface
. . . . . . . . . .Plugins
..............................
287
14
Preface
287
287
287
287
287
288
288
288
289
.Red
. . . .Hat
. . . . Enterprise
. . . . . . . . . . . .Virtualization
. . . . . . . . . . . . . .and
. . . . SSL
.........................................
D.1. Replacing the Red Hat Enterprise Virtualization Manager SSL Certificate
291
291
.Using
. . . . . .Search,
. . . . . . . . Bookmarks,
. . . . . . . . . . . . .and
. . . . T. .ags
. . . .to
. . .Find
. . . . .Your
. . . . .Way
. . . . .Around
........................
E.1. Search
E.1.1. Performing Searches in Red Hat Enterprise Virtualization
E.1.2. Search Syntax and Examples
E.1.3. Search Auto-Completion
E.1.4. Search Result T ype Options
E.1.5. Search Criteria
E.1.6. Search: Multiple Criteria and Wildcards
E.1.7. Search: Determining Search Order
E.1.8. Searching for Data Centers
E.1.9. Searching for Clusters
E.1.10. Searching for Hosts
E.1.11. Searching for Networks
E.1.12. Searching for Storage
E.1.13. Searching for Disks
E.1.14. Searching for Volumes
E.1.15. Searching for Virtual Machines
E.1.16. Searching for Pools
E.1.17. Searching for T emplates
E.1.18. Searching for Users
E.1.19. Searching for Events
E.2. Bookmarks
E.2.1. Saving a Query String as a Bookmark
E.2.2. Editing a Bookmark
E.2.3. Deleting a Bookmark
E.3. T ags
E.3.1. Using T ags to Customize Interactions with Red Hat Enterprise Virtualization
E.3.2. Creating a T ag
E.3.3. Modifying a T ag
E.3.4. Deleting a T ag
E.3.5. Adding and Removing T ags to and from Objects
E.3.6. Searching for Objects using T ags
292
292
292
292
292
292
293
294
294
294
294
295
296
297
298
298
299
301
301
302
303
304
304
305
305
305
305
306
306
306
306
307
. . . . . . . . . .History
Revision
......................................................................
308
15
16
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 includes the
Liberation Fonts set by default.
1.1. T ypographic 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, click 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
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.
17
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:
package org.jboss.book.jca.ex1;
import javax.naming.InitialContext;
public class ExClient
{
public static void main(String args[])
throws Exception
{
InitialContext iniCtx = new InitialContext();
Object
ref
= iniCtx.lookup("EchoBean");
EchoHome
home
= (EchoHome) ref;
Echo
echo
= home.create();
System.out.println("Created Echo");
System.out.println("Echo.echo('Hello') = " + echo.echo("Hello"));
}
}
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.
18
Chapter 2. Basics
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.
19
20
Chapter 2. Basics
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: T emplate 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
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
21
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.
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.
22
Chapter 2. Basics
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
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.
23
Direct interaction with these interfaces is supported and encouraged only for read access. Use of these
interfaces for write access is not supported unless explicitly requested by Red Hat Support:
Red Hat Enterprise Virtualization Manager History Database
Read access to the Red Hat Enterprise Virtualization Manager history database using the
database views specified in the Administration Guide is supported. Write access is not
supported.
Libvirt on Virtualization Hosts
Read access to 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
Report a bug
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
24
Chapter 2. Basics
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. T ree 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
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.
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
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.
26
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
Bookm ark window.
27
Report a bug
28
29
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.
Report a bug
30
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
can be resumed by selecting the data center and clicking the Guide Me button.
31
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.
T able 3.1. Data Center Properties
Field
Description/Action
Nam e
Description
T ype
Quota Mode
Report a bug
3.5.3. Editing a Resource
Summary
Edit the properties of a resource. T he Edit window is identical to the New window, except that some
fields are disabled.
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.
32
33
Summary
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
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
34
35
Data, such as virtual machines and templates, remains attached to the storage domain.
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
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
36
Chapter 4. Clusters
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
NetworkAdmin
Network Administrator
See Also:
Section 12.4.2, User and Administrator Roles
Report a bug
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
37
38
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.
T he Red Hat Enterprise Virtualization platform contains a default cluster in the default data center at
installation.
See Also:
Chapter 3, Data Centers
Chapter 5, Logical Networks
Chapter 6, Hosts
Chapter 7, Storage
Report a bug
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.
39
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.
40
Chapter 4. Clusters
Description/Action
Data Center
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
CPU Nam e
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.
41
T he table below describes the settings for the Optim ization tab in the New Cluster and Edit
Cluster windows.
T able 4 .2. Optimization Settings
Field
Mem ory Optim ization
CPU T hreads
Description/Action
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.
42
Chapter 4. Clusters
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.
T able 4 .3. Resilience Policy Settings
Field
Description/Action
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.
T he table below describes the settings for the Edit Policy window.
43
Description/Action
None
Even Distribution
Power Saving
Report a bug
4 .2.3. Editing a Resource
Summary
Edit the properties of a resource. T he Edit window is identical to the New window, except that some
fields are disabled.
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.
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.
44
Chapter 4. Clusters
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.
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.
45
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.
Description
Name
Hostname/IP
Root Password
Fingerprint
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
46
Chapter 4. Clusters
Summary
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.
47
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
48
4 .2.9. Designate a Specific T raffic T ype 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 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.
Description/Action
Assign
Required
VM Network
Display Network
Report a bug
49
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
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
NetworkAdmin
Network Administrator
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
50
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
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
51
Warning
Do not change networking in a data center or a cluster if any hosts are running as this risks
making the host unreachable.
See Also:
Chapter 3, Data Centers
Chapter 4, Clusters
Chapter 6, Hosts
Chapter 7, Storage
Chapter 8, Virtual Machines
Report a bug
52
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
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
53
54
T he table below describes the settings for the New Logical Network window.
T able 5.1. New Logical Network Settings
Field Name
Description
Nam e
Description
VM Network
Override MT U
55
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
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 T raffic T ype 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.
56
Description/Action
Assign
Required
VM Network
Display Network
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.
57
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:
Section 6.5, Hosts and Networking
Report a bug
5.4 .7. Using the Networks T ab
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.
58
Chapter 6. Hosts
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
59
Privileges
Notes
NetworkAdmin
NetworkUser
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
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.
60
Chapter 6. Hosts
Result
You have removed the user's role, and the associated permissions, from the resource.
Report a bug
61
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/
See Also:
Chapter 3, Data Centers
Chapter 4, Clusters
Chapter 5, Logical Networks
Chapter 8, Virtual Machines
Report a bug
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.
62
Chapter 6. Hosts
Report a bug
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.
63
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
Data Center
Host Cluster
Root password
Report a bug
6.4 .2.2. Host Power Management Settings Explained
64
Chapter 6. Hosts
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.
65
Description
Concurrent
Address
User Nam e
Password
T ype
Port
Options
Secure
Source
66
Chapter 6. Hosts
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
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.
T able 6.4 . Console settings
Field Name
Description
Display address
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.
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.
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.
67
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
6.4 .5. Editing a Resource
Summary
Edit the properties of a resource. T he Edit window is identical to the New window, except that some
fields are disabled.
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.
68
Chapter 6. Hosts
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.
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.
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.
69
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 T ags
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.
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
70
Chapter 6. Hosts
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.
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.
71
Alternatively, right-click the interface and select another interface from the drop-down menu.
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
72
Chapter 6. Hosts
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:
"Network Changes were saved on host <Hostname>."
Result
T he host's network configuration is saved persistently and will survive reboots.
Report a bug
73
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.
12. Click OK to save the changes and close the window.
Result
74
Chapter 7. Storage
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.
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.
Summary
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.
75
4. A message displays prompting you to ensure that the host has been shut down or rebooted.
Select the Approve Operation check box and click OK.
Result
You have manually rebooted your host, allowing highly available virtual machines to be started on active
hosts. You confirmed your manual fencing action in the Administrator Portal, and the host is back online.
Report a bug
Privileges
Notes
HostAdmin
Host Administrator
See Also:
Section 12.4.2, User and Administrator Roles
Report a bug
76
Chapter 7. Storage
77
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
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
78
Chapter 7. Storage
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
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
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
79
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.
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.
80
Chapter 7. Storage
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.
81
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
# 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.
4. Click the Edit buttons next to the Data Center, Cluster, and Storage fields to configure
and name the local storage domain.
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
82
Chapter 7. 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.
83
Note
You can only add an iSCSI storage domain to a data center that is set up for iSCSI storage type.
Procedure 7.6. 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.
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).
84
Chapter 7. Storage
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.
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.7. 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
85
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.
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.
86
Chapter 7. Storage
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
forcefully over ride the contents of these LUNs, but the operation is not guaranteed to succeed.
Report a bug
87
3. Select the appropriate Dom ain Function / Storage T ype from the following:
ISO
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.9. 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
88
Chapter 7. Storage
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
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.10. 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. T he Edit window is identical to the New window, except that some
fields are disabled.
Procedure 7.11. 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.
89
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.12. 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.
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.13. 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.
90
Chapter 7. Storage
Note
Bricks must be created externally on Red Hat Storage nodes.
Report a bug
7.8.2. Gluster Storage T erminology
91
Definition
Brick
Block Storage
Cluster
Client
Geo-Replication
glusterd
Metadata
N-way Replication
Namespace
POSIX
RAID
RRDNS
Server
Scale-Up Storage
92
Chapter 7. Storage
computer in a trusted storage pool.
Scale-Out Storage
Subvolume
T ranslator
User Space
Volfile
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.
Procedure 7.16. 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.
93
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.
94
Chapter 7. Storage
Report a bug
7.8.5. Explanation of Settings in the Add Bricks window
T able 7.2. Add Bricks T ab Properties
Field Name
Description
Volum e T ype
Server
Brick Directory
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.18. 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
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
95
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.21. 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.
96
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.22. 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
Summary
After a volume has been started, it can be stopped.
Procedure 7.23. 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
97
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
GlusterAdmin
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.
98
99
Number
Note
Virtualized CPUs
160
Virtualized RAM
2T B
Virtualized RAM
4GB
32
Report a bug
100
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.
Note
In the Host tab, a field called 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.
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 T emplate
Summary
You can create a virtual machine using a blank template and configure all of its settings.
Procedure 8.2. Creating a New Virtual Machine from a Blank 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
101
102
Description
Data Center
Host Cluster
Nam e
Description
Based on T em plate
Virtual Sockets
Operating System
Delete protection
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.
103
Description
General - T im e Zone
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.
104
Description
Protocol
USB Support
Monitors
Enable Sm artcard
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.
105
Description
Run On
Migration Options
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.6. Virtual Machine: High Availability Settings
Field Name
Description
Highly Available
Report a bug
106
Sub-element
Description
Storage Allocation
T he T em plate
Provisioning option is only
available when the virtual
machine is created from a
template.
T hin
Clone
Alias
Allocation policy
T arget
Quota
Report a bug
8.4 .3.7. Virtual Machine Boot Options Settings Explained
T hese settings apply to adding or editing new 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.
107
Description
First Device
Second Device
Attach CD
Boot Options
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.
108
Description
Recommendations and
Limitations
sap_agent
sndbuf
vhost
LogicalNetworkName:
false
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 T emplate
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
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.
109
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.
Note
It may take some time for the virtual machine to be created because a new copy of the
template's disk. During this time, the status of the virtual machine displays as Im age
Locked, followed by 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.
110
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.
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.
111
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.
Report a bug
8.4 .7. 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.
112
Description
Boot Options
Initial Run
Display Protocol
Custom Properties
113
Report a bug
icon.
114
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.9. 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.
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
115
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.10. 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.
) button.
116
117
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
8.7.4 . Adding and Editing Virtual Machine Network Interfaces
Summary
You can add network interfaces to virtual machines. Doing so allows you to put your virtual machine on
multiple logical networks. You can also edit a virtual machine's network interface 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.15. 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.
118
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.
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.
119
Description
Nam e
Network
Link State
T ype
Port Mirroring
Card Status
Report a bug
120
121
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.12. Red Hat Enterprise Virtualization System Administrator Roles
Role
Privileges
Notes
DataCenterAdmin
ClusterAdmin
Cluster Administrator
NetworkAdmin
Network Administrator
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.
122
Privileges
Notes
UserRole
PowerUserRole
UserVmManager
UserT emplateBasedVm
VmCreator
NetworkUser
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.19. 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.
123
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.21. 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.
124
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.22. 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.
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.
125
126
127
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.
Procedure 8.25. Performing an export-import of virtual resources
1. Attach the export domain to the source data center.
128
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
129
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.26. 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.
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.27. 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.
4. Use the drop-down menus to select the Default Storage Dom ain, Cluster, and Cluster
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.
130
131
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
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.28. 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.
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. Select the appropriate check boxes to affect the Run/Migration Options.
132
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
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.30. 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.
133
Report a bug
134
Note
You can only set high availability for virtual servers. You can not set high availability for virtual
desktops.
Procedure 8.32. 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.
135
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
136
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.
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.34 . 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:
137
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
You can configure qxl drivers using either a graphical interface or the command line. Perform only one of
the following procedures.
Procedure 8.35. 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.36. Configuring qxl drivers on the command line:
1. Back up /etc/X11/xorg.conf:
# cp /etc/X11/xorg.conf /etc/X11/xorg.conf.$$.backup
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.37. 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
138
Chapter 9. Templates
Section "ServerLayout"
Identifier
"single head configuration"
Screen
0 "Screen0" 0 0
InputDevice
"Keyboard0" "CoreKeyboard"
InputDevice
"Tablet" "SendCoreEvents"
InputDevice
"Mouse" "CorePointer"
EndSection
Section "InputDevice"
Identifier "Mouse"
Driver
"void"
#Option
"Device" "/dev/input/mice"
#Option
"Emulate3Buttons" "yes"
EndSection
Section "InputDevice"
Identifier "Tablet"
Driver
"evdev"
Option
"Device" "/dev/input/event2"
Option "CorePointer" "true"
EndSection
4. Log out and log back into the virtual machine to restart X-Windows.
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.
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
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
139
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
"processor.m ax_cstate=1" to the kernel boot options in the grub.conf file on the host:
term Red Hat Enterprise Linux Server (2.6.18-159.el5)
root (hd0,0)
kernel /vmlinuz-2.6.18-159.el5 ro root=/dev/VolGroup00/LogVol00 rhgb quiet
processor.max_cstate=1
Disable cpufreq (only necessary on hosts without the constant_tsc) by editing the
/etc/sysconfig/cpuspeed configuration file and change the MIN_SPEED and MAX_SPEED variables
to the highest frequency available. Valid limits can be found in the
/sys/devices/system /cpu/cpu* /cpufreq/scaling_available_frequencies files.
Using the 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
notsc lpj=n
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
3.9 x86
14 0
Chapter 9. Templates
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
14 1
Chapter 9. Templates
9.1. Introduction to Templates
A template is a copy of a virtual machine for the purpose of reproducing the virtual machine. Virtual
machines created from a template are identical to the model virtual machine from which the template was
taken, eliminating the need to configure each one individually.
When creating a template, select a model virtual machine that is general enough for mass production. A
virtual machine that is too specific to a particular user or group is not practical for use as a template.
Note
Before a Windows template is ready for application, you must first run Sysprep (or a similar tool)
to seal the virtual machine and remove "specific" personalization. Failure to do so will cause
conflicts when running multiple virtual machines from an unsealed Windows template. In general,
templates of Linux virtual machines do not require sealing.
Report a bug
Note
T ake a snapshot of the virtual machine at this stage if you wish to use the virtual machine
(as a virtual machine) after using it to create a template.
3. Click Make T em plate to open the New T em plate window.
14 2
Chapter 9. Templates
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.
See Also:
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 T emplate 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
Description
Host Cluster
T arget
Report a bug
9.2.3. Editing a Resource
Summary
Edit the properties of a resource. T he Edit window is identical to the New window, except that some
fields are disabled.
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
9.2.4 . Deleting a T emplate
Summary
Delete a template from your Red Hat Enterprise Virtualization environment.
14 3
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.5. Exporting T emplates
9.2.5.1. Migrating T emplates to the Export Domain
Summary
Export templates into the export domain for migration.
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
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.6. Importing T emplates
9.2.6.1. Importing a T emplate into a Data Center
Prerequisites:
Section 9.2.6, 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
14 4
Chapter 9. Templates
across with the export domain.
3. Select a template and click Restore to open the Im port T em plate(s) window.
Result
14 5
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 T emplate
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 VM 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:
# rhevm-config --set ProductKeyWindow7=<validproductkey> --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
14 6
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.
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
Note
You can only assign roles and permissions to existing users.
See Also:
Section 9.4.2, T emplate Administrator Roles Explained
Report a bug
9.4 .2. T emplate 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.2. Red Hat Enterprise Virtualization System Administrator Roles
Role
Privileges
Notes
T emplateAdmin
NetworkAdmin
Network Administrator
14 7
See Also:
Section 12.4.2, User and Administrator Roles
Report a bug
9.4 .3. T emplate 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.
T able 9.3. Red Hat Enterprise Virtualization T emplate User Roles
Role
Privileges
Notes
T emplateCreator
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
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
NetworkUser
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.
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
14 8
14 9
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
150
151
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.
Result
You have detached the virtual machine from the virtual machine pool.
Report a bug
10.2.6. Removing a Virtual Machine Pool
Summary
You can remove a virtual machine pool from a data center. You must first either delete or detach all of
the virtual machines in the pool. Detaching virtual machines from the pool will preserve them as
independent virtual machines.
Procedure 10.6. Removing a Virtual Machine Pool
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
152
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.
T able 10.1. Red Hat Enterprise Virtualization System Administrator Roles
Role
Privileges
Notes
VmPoolAdmin
ClusterAdmin
Cluster Administrator
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
153
Remove an administrator or user role from a resource; the user loses the inherited permissions
associated with the role for that resource.
Procedure 10.8. Removing a Role from a Resource
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
154
155
Format
T ype
Note
NFS or iSCSI/FCP
RAW or Qcow2
Sparse or
Preallocated
NFS
RAW
Preallocated
NFS
RAW
Sparse
NFS
Qcow2
Sparse
SAN
RAW
Preallocated
SAN
Qcow2
Preallocated
SAN
Qcow2
Sparse
Report a bug
156
157
Description
Size(GB)
Alias
Description
Interface
Form at
Data Center
Is bootable
Is shareable
T he External(Direct LUN) settings include all of the entries from the Internal except for
Size(GB) and some additional entries.
T able 11.3. Add a disk settings: External(Direct LUN)
Field Name
Description
Use Host
Storage T ype
Discover T argets
Address
Port
User Authentication
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:
158
Note
It is not presently possible to concurrently migrate multiple virtual machine disk images 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.
Report a bug
Note
You can only assign roles and permissions to existing users.
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
159
Privileges
Notes
DiskOperator
DiskCreator
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.
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
160
161
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.
162
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.
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
163
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.
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.
Report a bug
164
Privileges
Notes
UserRole
PowerUserRole
UserVmManager
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
for resources in the User Portal.
165
Privileges
Notes
UserT emplateBasedVm
DiskOperator
VmCreator
T emplateCreator
DiskCreator
T emplateOwner
NetworkUser
Report a bug
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
ClusterAdmin
Cluster Administrator.
DataCenterAdmin
166
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.
T able 12.4 . Red Hat Enterprise Virtualization System Administrator Roles - Advanced
Role
Privileges
Notes
T emplateAdmin
Administrator of a virtual
machine template.
StorageAdmin
Storage Administrator.
HostAdmin
Host Administrator.
NetworkAdmin
Network Administrator.
VmPoolAdmin
GlusterAdmin
Report a bug
167
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.
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
168
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
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.
169
170
171
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
172
Definition
Run-time Quota
Storage Quota
Function
Enforced
Audit
Disabled
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
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 "grace" amount by which the threshold
can be briefly exceeded. Exceeding the threshold results in a warning sent to the customer.
Important
Quota imposes limitations upon the running of virtual machines. Ignoring these limitations is likely
to result in a situation in which you cannot use your virtual machines and virtual disks.
When quota is running in enforced mode, virtual machines and disks that do not have quotas
assigned cannot be used.
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
173
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
Report a bug
174
Definition
Cluster T hreshold
Cluster Grace
Storage T hreshold
Storage Grace
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 "T hreshold" and "Grace" are set relative to the quota.
"T hreshold" may be thought of as the "soft limit", and exceeding it generates a warning. "Grace" may be
thought of as the "hard limit", and exceeding it makes it impossible to consume any more storage
resources.
Report a bug
175
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
176
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
177
After a short time, the user will appear in the Consum ers tab of the details pane.
Report a bug
178
179
5. Use the Expand All button, or the subject-specific expansion buttons, to view the events.
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
180
Default
Remarks
INT ERVAL_IN_SECONDS
120
MAIL_SERVER
none
MAIL_PORT
25
MAIL_USER
none
MAIL_PASSWORD
none
MAIL_ENABLE_SSL
false
HT ML_MESSAGE_FORMAT
false
MAIL_FROM
none
MAIL_REPLY_T O
none
none
Report a bug
181
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.
-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.
182
-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:
# rhevm-manage-domains --help
Report a bug
15.1.3. Using the Domain Management T ool
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.
183
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: admin@DIRECTORY.DEMO.REDHAT.COM
This domain is a remote domain.
Report a bug
15.1.9. Getting a Configuration Value
184
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
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, 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
185
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. T he 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.
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
Report a bug
15.2.5. Configuration tool examples
Example 15.8. Getting a Configuration Value
# rhevm-config --get=SearchResultsLimit --cver=general
100
Report a bug
15.2.6. Red Hat Enterprise Virtualization Manager Configuration Options Explanations,
Limitations, and Best Practices
186
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
Z ombie tasks
lifetime in minutes
Integer
3000
AuditLogAgingT hr
eshold
Integer
30
AuditLogCleanupT
ime
T ime
03:35:35
AuthenticationMet
hod
Authentication
Method used by
RHEV-M
String
LDAP
BlockMigrationOn
SwapUsagePerce
ntage
Host swap
percentage
threshold (for
scheduling)
Integer
T he maximum
percentage of
swap on the host
that a VM run or
migration is
allowed on this
host. If the host is
swapping beyond
this percentage a
VM will not migrate
over and will not
be started.
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
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
Integer
187
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
EmulatedMachine
Supported
machine types
String
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
Integer
16
T he color depth
used by the
SPICE. Possible
values are 16 and
32.
EnableSpiceRoot
CertificateValidatio
n
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
188
Integer
Produces an alert
when a Storage
Domain has this
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
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
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
Minimum number
of virtual
machines per host
in the Evenly
Distribute
189
Low Utilization
Limit for Power
Save selection
algorithm
Integer
20
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
Integer
16384
T he maximum
size (in GB) for a
new virtual disk
image assigned to
virtual machines.
Integer
100000
Maximum number
of MAC
addresses
allowed in the
MAC pool.
MaxNumberofHost
sInStoragePool
Maximum number
of hosts in
Storage Pool
Integer
250
Limits the
maximum number
of hosts assigned
to the clusters of
a single Data
Center. T his can
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
Maximum number
of attempts to
start a virtual
machine on a host
before an error
("unable to start
VM") is reported.
MaxStorageVdsD
elayCheckSec
Integer
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 "lastCheck"
value for each
domain. T his
setting is used to
190
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
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
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
Number of
attempts to run
virtual machines
on hosts before
setting host
status to "Error".
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
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
T he number of
host monitor
iterations between
refreshing virtual
machines from
VDSM
(determines if
virtual machines
should be
refreshed one
191
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
String
Windows serial
key to be used
with sysprepped
virtual machines
created from a
template.
ProductKey2003x
64
String
Windows serial
key to be used
with sysprepped
virtual machines
created from a
template.
ProductKey2008
String
Windows serial
key to be used
with sysprepped
virtual machines
created from a
template.
ProductKey2008R
2
String
Windows serial
key to be used
with sysprepped
virtual machines
created from a
template.
ProductKey2008x
64
String
Windows serial
key to be used
with sysprepped
virtual machines
created from a
template.
ProductKey
String
Windows serial
key to be used
with sysprepped
virtual machines
created from a
template.
ProductKeyWindo
w7
String
Windows serial
key to be used
with sysprepped
virtual machines
created from a
template.
ProductKeyWindo
w7x64
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 "wipe
after delete"
check box in the
"New Virtual Disk"
dialog if the newlycreated Disk
belongs to a SAN
(FC/iSCSI) Data
192
Integer
100
T he number of
results to return
for search queries
if no specific
figure is given in
the web
administration
portal or REST .
ServerRebootT im
eout
Host Reboot
T imeout (in
seconds)
Integer
300
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 "Enable
USB Auto-Share"
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
commands
Integer
Number of SPM
selection failover
retries. In case an
SPM command
fails, backend
performs a
failover - it selects
a new SPM and
re-runs the
command.
SPMFailOverAttem Number of
pts
attempts to
connect to the
Storage Pool
Manager before
Failover
Integer
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
Integer
When a host is
T he CPI
193
consumption of
SPM embodied as
number of VCPUs
on the Host
SSHInactivityT ime
outSeconds
SSH Inactivity
T imeout (in
seconds)
Integer
600
SSHInactivityHard
T imoutSeconds
SSH Inactivity
Hard T imeout (in
seconds)
Integer
NumberOfUSBSlot
s
Number of USB
slots in VMs with
native USB
support
Integer
SSLEnabled
SPICE SSL
Enabled
String
true
Whether SPICE
Secure channels
should be SSL
encrypted.
StorageDomainFai
lureT imeoutInMinu
tes
Storage Domain
failure timeout
Integer
Defines the
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
194
the SPM, it is
considered to be
using this amount
of extra virtual
CPUs, to make up
for the overhead
that SPM
operations
generate.
T he maximum
amount of time
backend allows
for an SSH
session to remote
hosts. After this
timeout the
session is killed.
Path to a Windows
XP machine
sysprep file
string
/etc/ovirtengine/sysprep/sy
sprep.xp
Path to the
operating system
specific sysprep
file template.
T imeoutT oResetV
dsInSeconds
Communication
timeout in
seconds before
attempting reset
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.
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
UserRefreshRate
Refresh Rate of
Users' Data from
Active Directory (in
seconds)
Integer
3600
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
T he amount of
times to retry
communications
with a host before
a fence command
is issued. Used in
conjunction with
TimeoutToReset
VdsInSeconds.
VdsLoadBalancing
IntervalInMinutes
Host Load
Balancing Interval
(in minutes)
Integer
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
When VDSM
fails/restarts, it
can sometimes be
in recovering
mode (VDSM
reports
"initializing" or
"recovering from
reports").
195
VdsRefreshRate
T ime interval in
seconds to poll a
Host's status
Integer
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
Integer
60
T his is a timeout
for initializing host
as in
VdsRecoveryTim
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
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
196
Iptables
configuration used
to autoconfigure
the Manager.
String
T he complete set
of iptables rules
that are used
when automatic
firewall
configuration is
selected during
rhevm-setup
OvirtIsoPrefix
String
rhevh
OvirtInitialSupport
edIsoVersion
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
VdsLocalDisksCrit
icallyLowFreeSpac
e
Amount of free
disk space on a
host local storage
domain that
should be
considered
critically low, in
MB.
Integer
500
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
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
Integer
197
Maximum number
of Vms that the
Vm Pool Monitor
will attempt to
Prestart in a
single cycle
Integer
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
If enabled, MAC
anti-spoofing
rules are set on
each virtual NIC,
enforcing that the
ethernet frames
this NIC sends
have the source
MAC that is
assigned to it in
the engine.
EnableHostT imeD
rift
Indicates if host
time-drift validation
is enabled
String
false
If time drift
validation is
enabled, the
Manager will
require that host
system time be
within a given
variation of the
Manager system
time. T he allowed
difference is set
by
HostT imeDriftInSe
c
EngineMode
Engine working
mode
String
Active
HostT imeDriftInSe
c
Integer
300
Report a bug
198
|-|
|
|
|-|
|
|
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:
rhevm-image-uploader [options] list
rhevm-image-uploader [options] upload [file].[file]...[file]
199
Report a bug
15.3.3. Creating an OVF Archive T hat 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
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:
200
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
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. T he USB Filter Editor Interface
Double-click the USB Filter Editor shortcut icon on your desktop.
201
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
Vendor
Product
Revision
Action
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.
Procedure 15.3. Adding a USB Policy
1. Click the Add button. T he Edit USB Criteria window opens:
202
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.
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 & Multim edia to the
list of allowed devices.
2. Click Rem ove. A message displays prompting you to confirm that you want to remove the policy.
203
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
204
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
205
206
-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.
-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.
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.
207
--max-connections=MAX_CONNECTIONS
Sets MAX_CONNECTIONS as the maximum concurrent SSH connections for logs from
virtualization hosts. T he default is 10.
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):
admin@directory.demo.redhat.com
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):
admin@directory.demo.redhat.com
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
208
209
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
15.6.3. Specifying an NFS Server
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):
admin@directory.demo.redhat.com
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):
admin@directory.demo.redhat.com
Please provide the REST API password for RHEV-M (CTRL+D to abort):
Report a bug
15.6.5. Uploading the VirtIO and Guest T ool 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
210
See Also:
Section 15.7.4, Subscribing to channels
Section 15.7.2, Automating Guest Additions on Windows Guests with Red Hat Enterprise
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 T ool(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.
211
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.
T able 15.3. Red Hat Enterprise Virtualization Guest Drivers
Driver
Description
Works on
virtio-net
virtio-block
virtio-serial
virtio-balloon
qxl
212
T able 15.4 . Red Hat Enterprise Virtualization Guest Agents and T ools
Guest agent/tool
Description
Works on
rhevm -guest-agent
rhev-sso
Desktop.
rhev-usb
Desktop.
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.
213
# subscription-manager register
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
214
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
215
Description
/var/log/ovirt-engine/enginecleanup_yyyy_mm_dd_hh_mm_ss.log
/var/log/ovirt-engine/engine-dbinstall-yyyy_mm_dd_hh_mm_ss.log
/var/log/ovirt-engine/rhevm -dwhsetup-yyyy_mm_dd_hh_mm_ss.log
/var/log/ovirt-engine/ovirt-enginereports-setup-yyyy_mm_dd_hh_mm_ss.log
/var/log/ovirt-engine/enginesetup-yyyy_mm_dd_hh_mm.log
/var/log/ovirt-engine/ovirt-engineupgrade-yyyy_mm_dd_hh_mm_ss.log
Report a bug
Description
/var/log/ovirt-engine/engine.log
/var/log/ovirt-engine/host-deploy
Report a bug
Description
/var/log/vdsm /libvirt.log
/tm p/ovirt-host-deploy-@DATE@.log
216
Report a bug
?TmplMsg
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
Prerequisites:
Section 16.4.1, Setting up a Virtualization Host Logging Server
217
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
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 single @ specifies the UDP protocol for transmission. Use a double @ @ to specify the T CP
protocol for transmission.
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
218
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
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
219
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.
# yum update -y rhevm-reports rhevm-dwh
2. Run the rhevm -dwh-setup command to update the rhevm _history database.
# rhevm-dwh-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
220
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-advanced.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.
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
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. Run the yum command with the update parameter on the Red Hat Enterprise Linux virtualization
host to update all installed packages.
# yum update
221
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.
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
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
user.
# yum-config-manager --enable=rhel-6-server-rhevm-3.2-rpms
222
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.
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
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
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.
223
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
5. 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).
224
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.
6. 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
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
225
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.
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
226
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
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
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
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 -
227
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.
T able 18.1. Configuration files and directories requiring backup.
Location
What is it?
/etc/ovirt-engine/
/etc/sysconfig/ovirt-engine
/etc/yum/pluginconf.d/versionlock.list
/etc/pki/ovirt-engine/
/usr/share/jasperreports-server-pro/buildomatic
/var/lib/ovirt-engine/backups
/var/lib/ovirt-engine/deployments
/usr/share/ovirt-engine-reports/reports/users/rhevm002dadmin.xml
/usr/share/ovirt-engine-reports/default_master.properties
/root/.rnd
/var/log/ovirt-engine/engine-setup-SETUPDATE.log
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
228
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
6. Run rhevm-setup, giving the same answers as when you originally installed rhevm:
# rhevm-setup
Result
You have restored a backed up copy of configuration files to the Red Hat Enterprise Virtualization
Manager.
Report a bug
229
230
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.
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
231
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.
Note
You can also access the reports portal from your Red Hat Enterprise Virtualization landing page.
Enter your login credentials. If this is the first time you are connecting to the reports portal, log in as
ovirt-user. Click the Login button.
232
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.
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.
Report a bug
19.1.9. Navigating Reports and Dashboards
Select the View Reports button on the reports portal home page.
233
Use the Filter pane on the left of the screen to select a subset of reports you would like to view.
Description
Available Resources
Resource type
T im efram e
Schedule
Report a bug
19.1.10. Report Parameters
Report parameters are user-defined at report run time. Report parameters define the scope and
234
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.
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.
235
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.
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.
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.
Report a bug
19.1.12. Executive Reports
19.1.12.1. Executive reports: active virtual machines by operating system
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:
236
Description
Period Range
Dates
Data Center
Cluster
VM T ype
Report a bug
19.1.12.2. Executive Reports: Cluster Capacity Versus 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:
T able 19.3. Cluster Capacity Vs Usage Parameters
Parameter
Description
Period Range
Dates
Data Center
Cluster
237
Description
Period Range
Dates
Data Center
Cluster
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:
T able 19.5. Summary of Host Usage Resources Parameters
Parameter
Description
Period Range
Dates
Data Center
Cluster
238
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:
T able 19.6. Hosts Inventory Parameters
Parameter
Description
Data Center
Cluster
Host T ype
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:
T able 19.7. Storage Domain Size Over T ime Parameters
Parameter
Description
Period Range
Dates
Data Center
Storage T ype
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:
239
Description
Data Center
Cluster
VM T ype
Report a bug
19.1.13.4 . Inventory Reports: Virtual Machine Inventory for Cloud and Hosting Service
Provider
T he Virtual Machine Inventory for Cloud and Hosting Service Providers 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:
T able 19.9. Virtual Machines Inventory Parameters
Parameter
Description
VM Name
VM UUID
VM IP address
VM description
OS type
Number of sockets
Time in existence
VM Created-by
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:
24 0
Description
Period Range
Dates
Data Center
Cluster
Host T ype
Report a bug
19.1.14 .2. Service Level Reports: Cluster Quality of Service for 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:
24 1
Description
Period Range
Dates
Data Center
Cluster
Host T ype
CPU T hreshold
Report a bug
19.1.14 .3. Service Level Reports: Cluster Quality of Service for 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:
24 2
Description
Period Range
Dates
Data Center
Cluster
VM T ype
CPU T hreshold
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:
24 3
Description
Period Range
Dates
Data Center
Cluster
Host T ype
Host Nam e
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:
24 4
Description
Period Range
Dates
Data Center
Cluster
Host T ype
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:
T able 19.15. High Availability Virtual Servers Uptime Parameters
Parameter
Description
Period Range
Dates
Data Center
Cluster
24 5
Description
Period Range
Dates
Data Center
Cluster
Host T ype
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:
24 6
T able 19.17. Five Least Utilized Virtual Machines (Over T ime) Parameters
Parameter
Description
Period Range
Dates
Data Center
Cluster
VM T ype
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:
24 7
Description
Period Range
Dates
Data Center
Cluster
Host T ype
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:
24 8
T able 19.19. Five Most Utilized Virtual Machines (Over T ime) Parameters
Parameter
Description
Period Range
Dates
Data Center
Cluster
VM T ype
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:
24 9
Description
Period Range
Dates
Data Center
Cluster
Host T ype
Host List
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:
250
T able 19.21. Multiple Virtual Machines Resource Usage (Over T ime) Parameters
Parameter
Description
Period Range
Dates
Data Center
Cluster
VM T ype
VM List
Report a bug
19.1.15.7. T rend Reports: Single Host Resource Usage by Days of the 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:
251
Description
Period Range
Dates
Data Center
Cluster
Host T ype
Host Nam e
Report a bug
19.1.15.8. T rend Reports: Single Host Resource Usage by Hour of the 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:
252
Description
Period Range
Dates
Data Center
Cluster
Host T ype
Host Nam e
Report a bug
19.1.15.9. T rend Reports: Single Virtual Machine Resource Usage by Day of the 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:
253
Description
Period Range
Dates
Data Center
Cluster
VM T ype
VM Nam e
Report a bug
19.1.15.10. T rend Reports: Single Virtual Machine Resource Usage by Hour of the 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:
254
Description
Period Range
Dates
Data Center
Cluster
VM T ype
VM Nam e
Report a bug
19.1.15.11. T rend Reports: Single Virtual Machine Resource Usage 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:
255
Description
Period Range
Dates
Data Center
Cluster
VM T ype
VM Nam e
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.
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: T ag 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 ag relations history in the system.
256
T ype
Description
history_id
integer
entity_id
uuid
entity_type
smallint
parent_id
uuid
attach_date
timestamp with
time zone
detach_date
timestamp with
time zone
2 - VM
3 - Host
5 - VM pool
18 - T ag
T ype
Description
history_id
integer
tag_id
uuid
tag_name
varchar(50)
tag_description
varchar(4000)
tag_path
varchar(4000)
tag_level
smallint
create_date
timestamp with
time zone
update_date
timestamp with
time zone
delete_date
timestamp with
time zone
T ype
Description
enum_type
varchar(40)
T he type of ENUM.
enum_key
smallint
value
varchar(40)
Report a bug
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
257
258
If you want to allow access by specific hosts, use a comma seperated list of IP addresses or
hostnames instead of "*".
ssl=on
all
all
<net address/mask>
Replace <net address/mask> 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/certs/engine.cer, 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/certs/engine.cer
/var/lib/pgsql/data/server.crt
b. Alternatively, you can create a new certificate and key file. Using the commands
documented in the PostgreSQL Manual, create server.key and server.crt files.
4. Stop the engine service.
# service ovirt-engine stop
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 role 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.
259
4. Generate the rest of the permissions to grant to the history-readonly, and save them to a file.
# psql -U postgres -c "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');" -pset=tuples_only=on ovirt_engine_history > grant.sql
5. Use the file you generated in the previous step to grant permissions to the history-readonly.
# psql -U postgres -f grant.sql ovirt_engine_history
Result
You can now access the ovirt_engine_history database as the history-readonly 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.
Example 19.1. Report query for resource utilization on a single host
T his query returns a table of data with one row per minute:
260
CPU
Memory
2010-07-01 18:45
42
2010-07-01 18:46
42
2010-07-01 18:47
42
2010-07-01 18:48
33
2010-07-01 18:49
33
2010-07-01 18:50
25
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.
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
39
40
38
38
37
32
35
45
35
37
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.
261
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
T his query returns a table of virtual machines with OS and VM T ype data:
262
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
Note
T he Red Hat Enterprise Virtualization Technical Reference Guide provides a detailed reference
that describes all the configuration and history views available for reporting.
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 Daily History View
Historical statistics for each data center in the system.
T able 19.34 . v3_1_datacenter_samples_history_view\v3_1_datacenter_hourly_history_view\v3_1_datacenter_daily_history_view
Name
T ype
Description
history_id
integer
history_datetime
timestamp with
time zone
datacenter_id
uuid
datacenter_status
smallint
minutes_in_status
decimal
datacenter_configuration_version
integer
Report a bug
19.2.8.3. Storage Domain Daily History View
Historical statistics for each storage domain in the system.
263
T able 19.35. Storage domain hourly history, daily history, and samples history view
Name
T ype
Description
history_id
integer
history_datetime
timestamp with
time zone
storage_domain_id
uuid
available_disk_size_gb
integer
used_disk_size_gb
integer
storage_configuration_version
integer
Report a bug
19.2.8.4 . Host Hourly and Daily History Views
Historical statistics for each host in the system.
264
T ype
Description
history_id
integer
history_datetime
timestamp with
time zone
host_id
uuid
host_status
smallint
minutes_in_status
decimal
memory_usage_percent
smallint
max_memory_usage
smallint
cpu_usage_percent
smallint
max_cpu_usage
smallint
ksm_cpu_percent
smallint
max_ksm_cpu_percent
smallint
active_vms
smallint
max_active_vms
smallint
total_vms
smallint
max_total_vms
smallint
total_vms_vcpus
smallint
max_total_vms_vcpus
smallint
cpu_load
smallint
max_cpu_load
smallint
265
smallint
max_cpu_usage_percent
smallint
user_cpu_usage_percent
smallint
max_user_cpu_usage_percent
smallint
swap_used_mb
integer
max_swap_used_mb
integer
host_configuration_version
integer
Report a bug
19.2.8.5. Host Interface Hourly and Daily History Views
Historical statistics for each host network interface in the system.
T able 19.37. v3_1_host_interface_samples_history_view\v3_1_host_interface_hourly_history_view\v3_1_host_interface_daily_history_view
Name
T ype
Description
history_id
integer
history_datetime
timestamp with
time zone
host_interface_id
uuid
receive_rate_percent
smallint
max_receive_rate_percent
smallint
transmit_rate_percent
smallint
max_transmit_rate_percent
smallint
host_interface_configuration_version
integer
Report a bug
19.2.8.6. Virtual Machine Hourly and Daily History Views
Historical statistics for the virtual machines in the system.
266
T ype
Description
history_id
integer
history_datetime
timestamp with
time zone
vm_id
uuid
vm_status
smallint
minutes_in_status
decimal
cpu_usage_percent
smallint
max_cpu_usage
smallint
memory_usage_percent
smallint
max_memory_usage
smallint
user_cpu_usage_percent
smallint
max_user_cpu_usage_percent
smallint
system_cpu_usage_percent
smallint
max_system_cpu_usage_percent
smallint
vm_ip
varchar(255)
current_user_name
varchar(255)
currently_running_on_host
uuid
vm_configuration_version
integer
267
integer
Report a bug
19.2.8.7. Virtual Machine Interface Hourly and Daily History Views
Historical statistics for the virtual machine network interfaces in the system.
T able 19.39. v3_1_vm_interface_samples_history_view\v3_1_vm_interface_hourly_history_view\v3_1_vm_interface_daily_history_view
Name
T ype
Description
history_id
integer
history_datetime
timestamp with
time zone
vm_interface_id
uuid
receive_rate_percent
smallint
max_receive_rate_percent
smallint
transmit_rate_percent
smallint
max_transmit_rate_percent
smallint
vm_interface_configuration_version
integer
Report a bug
19.2.8.8. Virtual Machine Disk Hourly and Samples History Views
Historical statistics for the virtual disks in the system.
268
T ype
Description
history_id
integer
history_datetime
timestamp with
time zone
vm_disk_id
uuid
vm_disk_status
integer
minutes_in_status
decimal
vm_actual_disk_size_mb
integer
read_rate_bytes_per_second
integer
max_read_rate_bytes_per_second
integer
write_rate_bytes_per_second
integer
max_write_rate_bytes_per_second
integer
read_latency_seconds
decimal
max_read_latency_seconds
decimal
write_latency_seconds
decimal
max_write_latency_seconds
decimal
flush_latency_seconds
decimal
max_flush_latency_seconds
decimal
vm_disk_configuration_version
integer
0
1
2
3
4
- Unassigned
- OK
- Locked
- Invalid
- Illegal
Report a bug
19.2.8.9. User Session Activity Reports
T his report contains a table detailing user SPICE activity. It includes information about how much time the
user was logged in to the SPICE sesion, and it includes information about the resources used during the
269
Description
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. Latest Datacenter Configuration View
Data centers configuration history in the system.
T able 19.4 2. v3_1_datacenter_configuration_view\v3_1_latest_datacenter_configuration_view
Name
T ype
Description
history_id
integer
datacenter_id
uuid
datacenter_name
varchar(40)
datacenter_description
varchar(4000)
storage_type
smallint
create_date
timestamp with
time zone
update_date
timestamp with
time zone
delete_date
timestamp with
time zone
Report a bug
270
0
1
2
3
4
6
-Unknown
- NFS
- FCP
- iSCSI
- Local
- All
T ype
Description
history_id
integer
storage_domain_id
uuid
datacenter_id
uuid
attach_date
timestamp with
time zone
detach_date
timestamp with
time zone
Report a bug
19.2.9.4 . Latest Storage Domain Configuration View
Storage domains configuration history in the system.
T able 19.4 4 . v3_1_storage_domain_configuration_view\v3_1_latest_storage_domain_configuration_view
Name
T ype
Description
history_id
integer
storage_domain_id
uuid
storage_domain_name
varchar(250)
storage_domain_type
smallint
storage_type
smallint
create_date
timestamp with
time zone
update_date
timestamp with
time zone
delete_date
timestamp with
time zone
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. Latest Cluster Configuration View
Clusters configuration history in the system.
271
T ype
Description
history_id
integer
cluster_id
uuid
cluster_name
varchar(40)
cluster_description
varchar(4000)
datacenter_id
uuid
cpu_name
varchar(255)
compatibility_version
varchar(40)
datacenter_configuration_version
integer
create_date
timestamp with
time zone
update_date
timestamp with
time zone
delete_date
timestamp with
time zone
Report a bug
19.2.9.6. Latest Host Configuration View
Host configuration history in the system.
T able 19.4 6. v3_1_host_configuration_view\v3_1_latest_host_configuration_view
Name
T ype
Description
history_id
integer
host_id
uuid
host_unique_id
varchar(128)
host_name
varchar(255)
cluster_id
uuid
host_type
smallint
fqn_or_ip
varchar(255)
memory_size_mb
integer
swap_size_mb
integer
cpu_model
varchar(255)
number_of_cores
smallint
host_os
varchar(255)
pm_ip_address
varchar(255)
kernel_version
varchar(255)
kvm_version
varchar(255)
vdsm_version
varchar(40)
vdsm_port
integer
cluster_configuration_version
integer
create_date
timestamp with
time zone
update_date
timestamp with
time zone
delete_date
timestamp with
time zone
272
0 - RHEL Host
2 - RHEV Hypervisor Node
Report a bug
19.2.9.7. Latest Host Interface Configuration View
Host interface configuration history in the system.
T able 19.4 7. v3_1_host_configuration_view\v3_1_latest_host_configuration_view
Name
T ype
Description
history_id
integer
host_interface_id
uuid
host_interface_name
varchar(50)
host_id
uuid
host_interface_type
smallint
host_interface_speed_bps
integer
mac_address
varchar(20)
network_name
varchar(50)
ip_address
varchar(50)
gateway
varchar(20)
bond
Boolean
bond_name
varchar(50)
vlan_id
integer
host_configuration_version
integer
create_date
timestamp with
time zone
update_date
timestamp with
time zone
delete_date
timestamp with
time zone
0
1
2
3
- rt18139_pv
- rt18139
- e1000
- pv
Report a bug
19.2.9.8. Latest Virtual Machine Configuration View
A list of all virtual machines in the system.
273
T ype
Description
history_id
integer
vm_id
uuid
vm_name
varchar(255)
vm_description
varchar(4000)
vm_type
smallint
cluster_id
uuid
template_id
uuid
template_name
varchar(40)
cpu_per_socket
smallint
number_of_sockets
smallint
memory_size_mb
integer
operating_system
smallint
ad_domain
varchar(40)
default_host
uuid
high_availability
Boolean
initialized
Boolean
stateless
Boolean
fail_back
Boolean
auto_suspend
Boolean
usb_policy
smallint
time_zone
varchar(40)
cluster_configuration_version
integer
default_host_configuration_version
integer
create_date
timestamp with
time zone
update_date
timestamp with
time zone
delete_date
timestamp with
time zone
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
Report a bug
19.2.9.9. Latest Virtual Machine Interface Configuration View
274
T ype
Description
history_id
integer
vm_interface_id
uuid
vm_interface_name
varchar(50)
vm_id
uuid
vm_interface_type
smallint
- rt18139_pv
- rt18139
- e1000
- pv
vm_interface_speed_bps
integer
mac_address
varchar(20)
network_name
varchar(50)
vm_configuration_version
integer
create_date
timestamp with
time zone
update_date
timestamp with
time zone
delete_date
timestamp with
time zone
Report a bug
19.2.9.10. Latest disks-to-virtual-machine-map view
A historical map showing the relationships between virtual disks and virtual machines in the system.
T able 19.50. v3_1_disks_vm_map_view\v3_1_latest_disks_vm_map_view
Name
T ype
Description
history_id
integer
vm_disk_id
uuid
vm_id
uuid
attach_date
timestamp with
time zone
detach_date
timestamp with
time zone
Report a bug
19.2.9.11. Latest virtual machine disk configuration view
Virtual disks configuration history in the system.
275
T ype
Description
history_id
integer
vm_disk_id
uuid
storage_domain_id
uuid
vm_internal_drive_mapping
varchar
vm_disk_description
varchar(4000)
vm_disk_space_size_mb
integer
disk_type
integer
vm_disk_format
integer
- Unassigned
- System
- Data
- Shared
- Swap
- T emp
vm_disk_interface
integer
create_date
timestamp with
time zone
update_date
timestamp with
time zone
delete_date
timestamp with
time zone
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.
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. 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:
276
Firewalls
Description
Period Range
Dates
Data Center
Cluster
Report a bug
19.3.3. T rends 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:
T able 19.53. T rends Dashboard Parameters
Parameter
Description
Period Range
Dates
Data Center
Cluster
Report a bug
19.3.4 . 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:
277
Description
Period Range
Dates
Data Center
Report a bug
19.3.5. System Overview Dashboard
T he System Overview Dashboard provides an executive summary of the hosts in a data center
over a given period of time. T he dashboard includes:
A quality of service (QoS) view for each cluster, which shows the proportion of period where CPU
and memory exceeded thresholds on the hosts in the cluster;
A break down of host operating systems; and
A summary of average host resource utilization over the period.
T he following parameters can be modified for this dashboard:
T able 19.55. System Overview Dashboard Parameters
Parameter
Description
Period Range
Dates
Data Center
Cluster
Report a bug
19.3.6. 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.
278
Firewalls
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
279
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.
T able A.1. Red Hat Enterprise Virtualization Manager Firewall Requirements
Port(s)
Protocol
ICMP
22
T CP
80, 443
T CP
280
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.
VD SM and Hooks
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 ="port"
T CP and UDP port specified with ST AT D_PORT ="port"
T CP port specified with LOCKD_T CPPORT ="port"
UDP port specified with LOCKD_UDPPORT ="port"
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
281
Protocol
22
T CP
5634 - 6166
T CP
5989
T CP, UDP
16514
T CP
49152 - 49216
T CP
54321
T CP
282
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
Linux host(s)
Red Hat
Enterprise
Linux
Hypervisor(s)
Red Hat
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)
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
both automated
and manually
initiated migration
of virtual
machines.
VDSM
communications
with the Manager
and other
virtualization
hosts.
VD SM and Hooks
Report a bug
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
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
283
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
284
VD SM and Hooks
Description
before_vm_start
after_vm_start
before_vm_cont
after_vm_cont
before_vm_pause
after_vm_pause
before_vm_hibernate
after_vm_hibernate
before_vm_dehibernate
after_vm_dehibernate
before_vm_migrate_source
after_vm_migrate_source
before_vm_migrate_destination
after_vm_migrate_destination
after_vm_destroy
before_vdsm_start
after_vdsm_stop
before_nic_hotplug
after_nic_hotplug
before_nic_hotunplug
after_nic_hotunplug
after_nic_hotplug_fail
after_nic_hotunplug_fail
Report a bug
285
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
4. Finally, the ovirt-engine service must be restarted for the configuration change to take
effect.
# service ovirt-engine restart
Report a bug
286
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
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
Report a bug
Argument
Description
tobool
string
read_dom xm l
write_dom xm l
DOM object
Report a bug
287
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( ["/usr/bin/sudo", "/bin/chown", "root", "/my_file"] )
T he standard error stream of hook scripts is collected in VDSM's log. T his information is used to debug
hook scripts.
Report a bug
Description
>2
Reserved
Report a bug
288
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
#!/usr/bin/python
import
import
import
import
os
sys
hooking
traceback
'''
numa hook
=========
add numa support for domain xml:
<numatune>
<memory mode="strict" nodeset="1-4,^3" />
</numatune>
memory=interleave|strict|preferred
numaset="1" (use one NUMA node)
numaset="1-4" (use 1-4 NUMA nodes)
numaset="^3" (don't use NUMA node 3)
numaset="1-4,^3,6" (or combinations)
syntax:
numa=strict:1-4
'''
if os.environ.has_key('numa'):
try:
mode, nodeset = os.environ['numa'].split(':')
domxml = hooking.read_domxml()
domain = domxml.getElementsByTagName('domain')[0]
numas = domxml.getElementsByTagName('numatune')
if not len(numas) > 0:
numatune = domxml.createElement('numatune')
domain.appendChild(numatune)
memory = domxml.createElement('memory')
memory.setAttribute('mode', mode)
memory.setAttribute('nodeset', nodeset)
numatune.appendChild(memory)
hooking.write_domxml(domxml)
else:
sys.stderr.write('numa: numa already exists in domain xml')
sys.exit(2)
except:
sys.stderr.write('numa: [unexpected error]: %s\n' %
traceback.format_exc())
sys.exit(2)
Report a bug
289
Note
Plugin user configuration files generally follow the <descriptorFileNam e>-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
290
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:
// 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
Location
/usr/share/ovirtengine/ui-plugins/m yplugin.json
/etc/ovirt-engine/uiplugins/m y-pluginconfig.json
/usr/share/ovirtenging/uiplugins/<resourcePath>/
PluginHostPage.htm l
Remarks
<resourcePath> is defined
by the corresponding attribute in
the plugin descriptor.
Report a bug
291
{
"name": "HelloWorld",
"url": "/webadmin/webadmin/plugin/HelloWorld/start.html",
"resourcePath": "hello-files"
}
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:
<!DOCTYPE html><html><head>
<script>
var api = parent.pluginApi('HelloWorld');
api.register({
UiInit: function() { window.alert('Hello world'); }
});
api.ready();
</script>
</head><body></body></html>
If you have successfully implemented the Hello World! plugin, you will see this screen when you sign
in to the administration portal:
Report a bug
2. Create /usr/share/ovirt-engine/shellbox-file/start.htm l:
292
<!DOCTYPE html>
<html>
<head>
<script type='text/javascript'>
var api = parent.pluginApi('ShellBoxPlugin');
api.register({
UiInit : function() {
// Add 'Shell Box' sub-tab under 'Hosts' main-tab
api.addSubTab('Host', 'Shell Box', 'shell-box', '');
// Add 'Shell Box' button (+ context menu)
// to 'Hosts' main-tab
api.addMainTabActionButton('Host', 'Shell Box', {
onClick : function() {
window.open(getShellBoxUrl(arguments), '_blank');
},
isEnabled : function() {
// The button is enabled only when a
// single host is selected
return arguments.length == 1;
},
isAccessible : function() {
// The button is always visible
return true;
}
});
},
HostSelectionChange : function() {
if (arguments.length == 1) {
// Update iframe URL on host selection
api.setTabContentUrl(
'shell-box', getShellBoxUrl(arguments));
}
},
});
api.ready();
// Get 'Shell Box' URL using specified host address
var getShellBoxUrl = function(arguments) {
var hostAddress = arguments[0].name;
var port = '4200';
var shellUrl = 'http://' + hostAddress + ':' + port;
return shellUrl;
}
</script>
</head>
<body>
</body>
</html>
with this:
OPTS="--disable-ssl --service /:SSH
Result
T he shellinabox user interface plugin is now installed in your Red Hat Enterprise Virtualization
environment.
Report a bug
293
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
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
294
Result
Hosts: Vms.status = up
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
T able E.2. Example Search Queries Using Auto-Completion
Input
h
Action
Hosts:
T ype v
Hosts: v
Select Vm s or type Vm s
Hosts: Vm s
T ype s
Hosts: Vm s.s
Hosts: Vm s.status
Select or type =
=!
Hosts: Vm s.status =
Report a bug
E.1.4 . Search Result T ype 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
295
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).
Status
--
obj-type
A resource type
that can be
associated with
the searched-for
resource.
Users
--
operator
Comparison
operators.
--
Value options
depend on objtype.
!= (not equal)
>
<
>=
<=
Value
What the
expression is
being compared
to.
String
Jones
Integer
256
Ranking
normal
Date (formatted
according to
Regional Settings)
296
Wildcards can
be used within
strings.
"" (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
Report a bug
E.1.6. Search: Multiple Criteria and Wildcards
Wildcards can be used in the <value> part of the syntax for strings. For example, to find all users
beginning with m, enter m * .
You can perform a search having two criteria by using the Boolean operators AND and OR. For example:
Vm s: users.nam e = m * AND status = Up
T his query returns all running virtual machines for users whose names begin with "m".
Vm s: users.nam e = m * AND tag = "paris-loc"
T his query returns all virtual machines tagged with "paris-loc" for users whose names begin with "m".
When two criteria are specified without AND or OR, AND is implied. AND precedes OR, and OR precedes
implied AND.
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 > 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
name
String
description
String
type
String
status
List
sortby
List
page
Integer
Example
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.
297
T ype
Description (Reference)
Datacenter.datacenter-prop
Datacenter
String
name
String
description
String
initialized
String
sortby
List
page
Integer
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.
298
T ype
Description (Reference)
Vms.Vms-prop
T emplates.templates-prop
Events.events-prop
Users.users-prop
name
String
status
List
cluster
String
address
String
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
version
Integer
cpus
Integer
memory
Integer
T he amount of memory
available.
cpu_speed
Integer
cpu_model
String
T he type of CPU.
active_vms
Integer
migrating_vms
Integer
committed_mem
Integer
T he percentage of committed
memory.
tag
String
type
String
T he type of host.
datacenter
String
sortby
List
page
Integer
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.
299
T ype
Description (Reference)
Cluster_network.clusternetwo
rk-prop
Host_Network.hostnetworkprop
name
String
description
String
vlanid
Integer
stp
String
mtu
Integer
vmnetwork
String
datacenter
String
sortby
List
page
Integer
Example
Network: m tu > 1500 and vm network = true
returns a list of networks:
with a maximum transmission unit greater than 1500 bytes
which are set up for use by only virtual machines.
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
Clusters.clusters-prop
name
String
status
String
datacenter
String
type
String
size
Integer
used
Integer
committed
Integer
sortby
List
page
Integer
Example
Storage: size > 200 or used < 50
returns a list of storage with:
300
T ype
Description (Reference)
Datacenters.datacentersprop
Storages.storages-prop
alias
String
description
String
provisioned_size
Integer
size
Integer
actual_size
Integer
creation_date
Integer
bootable
String
shareable
String
format
String
status
String
disk_type
String
number_of_vms
Integer
T he number of virtual
machine(s) to which the disk is
attached.
vm_names
String
quota
String
sortby
List
page
Integer
Example
Disks: form at = cow and provisioned_size > 8
returns a list of virtual disks with:
Qcow, also known as thin provisioning, format; and
an allocated disk size greater than 8 GB.
Report a bug
E.1.14 . Searching for Volumes
T he following table describes all search options for volumes.
301
T ype
Description (Reference)
Volume.cluster-prop
Cluster
String
name
String
type
String
transport_type
Integer
replica_count
Integer
Number of replica.
stripe_count
Integer
Number of stripes.
status
String
sortby
List
page
Integer
Example
Volum e: transport_type = rdm a and stripe_count >= 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
T he following table describes all search options for virtual machines (Vms). Vms can be either virtual
servers or virtual desktops.
302
T ype
Description (Reference)
Hosts.hosts-prop
T emplates.templates-prop
Events.events-prop
Users.users-prop
name
String
status
List
ip
Integer
uptime
Integer
domain
String
os
String
creationdate
Date
address
String
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
apps
String
T he applications currently
installed on the virtual machine.
cluster
List
pool
List
loggedinuser
String
tag
List
datacenter
String
type
List
quota
String
sortby
List
page
Integer
Example
Vm s: tem plate.nam e = Win* and user.nam e = ""
returns a list of VMs, where:
T he template on which the virtual machine is based begins with Win and the virtual machine is
303
T ype
Description (Reference)
name
String
description
String
type
String
T he type of pool.
sortby
List
page
Integer
Example
Pools: type = autom atic
returns a list of pools with:
T ype of automatic
Report a bug
E.1.17. Searching for T emplates
T he following table describes all search options for templates.
304
T ype
Description (Reference)
Vms.Vms-prop
String
Hosts.hosts-prop
String
Events.events-prop
String
Users.users-prop
String
name
String
domain
String
os
String
creationdate
Integer
childcount
Integer
mem
Integer
Defined memory.
description
String
status
String
cluster
String
datacenter
String
quota
String
sortby
List
page
Integer
Example
T em plate: Events.severity >= norm al and Vm s.uptim e > 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.
305
T ype
Description (Reference)
Vms.Vms-prop
Hosts.hosts-prop
T emplates.templates-prop
Events.events-prop
name
String
lastname
String
usrname
String
department
String
group
String
title
String
status
String
role
String
tag
String
pool
String
sortby
List
page
Integer
Example
Users: Events.severity > norm al and Vm s.status = up or Vm s.status = pause
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.
306
T ype
Description (Reference)
Vms.Vms-prop
Hosts.hosts-prop
T emplates.templates-prop
Users.users-prop
Clusters.clusters-prop
Volumes.Volumes-prop
type
List
severity
List
message
String
time
Integer
usrname
String
event_host
String
event_vm
String
event_template
String
event_storage
String
event_datacenter
String
event_volume
String
correlation_id
Integer
sortby
List
page
Integer
Example
Events: Vm s.nam e = testdesktop and Hosts.nam e = gonzo.exam ple.com
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.
307
E.3. T ags
E.3.1. Using T ags 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.
308
Revision History
Administration Portal T ags can be created, modified, and removed using the T ags pane.
Report a bug
E.3.2. Creating a T ag
Summary
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 T ag
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 T ag
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
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 T ags 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.
309
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 T ags
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
310
Revision History
Revision History
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
Provisioning T ool
Revision 3.2-30
Monday 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 "Max free Memory for scheduling new VMs"
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 hurs 04 Apr 2013
T im Hildred
BZ #929350 - added notes to backups content about upgraded environments
Revision 3.2-25
T ue 2 Apr 2013
BZ #891732 - information about pinning CPUs to hosts
Z ac Dover
Revision 3.2-24
BZ #857789 - one typo
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 "rhev-guest-agent" to "rhevmguest-agent"
Revision 3.2-15
BZ #889107 - minor fixes
Z ac Dover
Revision 3.2-14
BZ #889107 - minor fixes
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
T hu 07 March 2013
Z ac Dover
311
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-09
Staging for Beta 1.
T im Hildred
Revision 3.2-08
T hurs 28 Feb 2013
T im Hildred
Updated Connecting to the History Database content (8281). Added procedure for remote connections.
BZ #875500.
Revision 3.2-07
T ue 26 Feb 2013
Changed revision numbers for consistency with other books.
T im Hildred
Revision 3-6
T ue 26 Feb 2013
Z ac Dover
BZ #889107 - Added topic describing the deployment of ShellInABox User Interface Plugin
Revision 3-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-4
Wed Feb 20 2013
BZ #889107 - RHEV UI Plugins - adding bootstrapping material
Z ac Dover
Revision 3-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
Availability
Revision 3-2
Mon 11 Feb 2013
BZ # 881502 - added Windows 8 to supported guest OS list
Jodi Biddle
Revision 3-1:
Fri Feb 10 2013
BZ #889107 - RHEV UI Plugins
Z ac Dover
Revision 2-101
Minor edits from localization.
T hu Oct 11 2012
Cheryn T an
Revision 2-100
Bug fixes from QE review.
T ue Oct 9 2012
Cheryn T an
Revision 2-99
Mon Oct 3 2012
Updated reports content for dashboards, reports portal users.
Updated virtual machine import content to reflect updated UI.
T im Hildred
Revision 2-98
Mon Oct 1 2012
Added backup.sh and restore.sh content.
Added quota accounting content.
T im Hildred
Revision 2-97
T ues Sept 25 2012
Fixed up reporting content.
Added additional images.
Fixed a number of bugs.
Added content on registering to channels in RHN.
T im Hildred
Revision 2-96
T ues Sept 18 2012
Integrated SME feedback on Hosts chapter.
Removed Monitoring content, as the tab has been replaced..
Updated virtual machine timing management content.
Added explaination of un-useable LUNs.
Added additional Quota content.
Many bugfixes.
T im Hildred
Revision 2-95
Wed Sept 12 2012
Many bugfixes.
Added "Cancelling virtual machine migrations" content.
Added "Removing virtual hard disks" content.
T im Hildred
Revision 2-94
Many bugfixes.
T im Hildred
312
Revision History
Revision 2-93
T ues Sept 4 2012
T im Hildred
Added reporting history views content.
Rearranged many of the reports related tables so that period range and date come first.
Revision 2-92
T ues Sept 4 2012
T im Hildred
Rearranged Reports content to seperate out History Database stuff.
Seperated Installing Guests and Agents from description of them.
Revision 2-91
T ues Aug 28 2012
Users and roles sections were updated.
T im Hildred
Revision 2-90
Mon Aug 27 2012
Integrated SME feedback on Storage related content.
T im Hildred
Revision 2-89
T hu Aug 24 2012
Added notifierd parameters.
Fixed linux template deployment topic.
T im Hildred
Revision 2-88
T hu Aug 23 2012
Integrated SME feedback on networking content.
Improved truthiness of Basics chapter.
Updated most screenshots.
T im Hildred
Revision 2-87
Mon Aug 20 2012
T im Hildred
Many bug fixes.
Updated quota section.
Added storage metadata, optional networks, vm networks information.
Revision 2-86
T ue Aug 14 2012
Many small changes.
Improved accuracy of storage chapter.
T im Hildred
Revision 2-85
Wed July 25 2012
T im Hildred
Applied unified structure to all chapters.
Made the topic titles for dialog windows more specific and meaningful.
Removed more duplicate/redundant topics.
Divided the book into 2 parts.
Added "Summary" and "Result" to most tasks.
Revision 2-84
T ues July 17 2012
Gave chapters a more unified structure.
Changed chapter titles.
Made a number of chapters appendixes.
Removed as much duplicated content as I could find
T im Hildred
Revision 2-83
T hurs June 28 2012
T im Hildred
Added "Using this guide" chapter with workflows.
Moved "Search" information into separate chapter.
Moved reference materials to the end of "Data centers" and "Clusters" chapters.
Revision 2-82
Wed June 06 2012
T im Hildred
Initial staging of topic based version of guide for review by product management.
Revision 2-81
T ue May 01 2012
BZ #798843 - admonition title overruns and picture correction
Z ac Dover
Revision 2-73
Wed Mar 28 2012
BZ #789934 - Chapter 5.4.1 - Configuring MT A
Z ac Dover
Revision 2-72
Wed Mar 28 2012
Z ac Dover
BZ #798843 - Appendix D: ensuring that headers do not overrun the pages
Revision 2-71
Mon Mar 26 2012
T im Hildred
Updated screenshot depicting cluster memory optimization for BZ #765872.
Updated title of section detailing Linux template preparation for BZ #765872.
Added clarity to the consequences of a loss of storage connectivity for BZ #791095.
Added "Upgrading Hosts" section pointing users to the Hypervisor Deployment Guide for BZ #756885.
Revision 2-68
T ues Feb 28 2012
T im Hildred
Updated Chapter 12.3 which incorrectly described circumstances under which virtual machines were
automatically migrated for BZ #782370
Fixed psqql restore command for BZ #791337
313
T im Hildred
Revision 2-22
Bug fixes.
Kate Grainger
Revision 2-21
Bug fixes.
T hu Nov 17 2011
Kate Grainger
Revision 2-20
T hu Nov 10 2011
Removing references to internal resources in images.
Z ac Dover
Revision 2-19
Bug fixes.
Z ac Dover
Revision 2-19
Bug fixes.
Z ac Dover
Revision 2-18
QE and translation updates.
T hu Nov 03 2011
Kate Grainger
Revision 2-17
QE updates.
Kate Grainger
Revision 2-16
QE updates.
Kate Grainger
Revision 2-15
T ranslation and QE updates.
Kate Grainger
Revision 2-14
T ranslation and QE updates.
Kate Grainger
Revision 2-13
Publishing book.
Shikha Nansi
Revision 2-12
QA edits.
Shikha Nansi
Revision 2-11
QA edits.
Shikha Nansi
Revision 2-10
Publishing book.
Shikha Nansi
Revision 2-9
Publishing book.
Z ac Dover
Revision 2-8
Fri Sep 30 2011
QA corrections in History database tables.
Z ac Dover
Revision 2-7
Changes from email feedback.
Shikha Nansi
Revision 2-6
Changes from email feedback.
Shikha Nansi
Revision 2-5
Changes from email feedback.
T hu Sep 15 2011
Shikha Nansi
Revision 2-4
Wed Sep 14 2011
Z ac Dover
Corrections to History and ENUM Views and vm_disk_history tables.
Revision 2-3
Spell Check.
Shikha Nansi
Revision 2-2
Updated Hosts and Storage.
T hu Sep 08 2011
Shikha Nansi
Revision 1-1
T hu Sep 01 2011
Updated Clusters and Logical Networks.
Shikha Nansi
314
Revision History
Revision 1-0
Restructured Guide for 3.0.
T ue Aug 23 2011
Susan Burgess
315