Administration Tasks in Red Hat Enterprise Virtualization
Legal Notice
Abstract
- 1. Introduction
- 2. Using the Administration Portal
- I. Administering the Resources
- 3. Quality of Service
- 4. Data Centers
- 5. Clusters
- 6. Logical Networks
- 7. Hosts
- 8. Storage
- 8.1. Understanding Storage Domains
- 8.2. Storage Metadata Versions in Red Hat Enterprise Virtualization
- 8.3. Preparing and Adding NFS Storage
- 8.4. Preparing and Adding Local Storage
- 8.5. Preparing and Adding POSIX Compliant File System Storage
- 8.6. Preparing and Adding Block Storage
- 8.7. Importing Existing Storage Domains
- 8.8. Storage Tasks
- 8.9. Storage and Permissions
- 9. Working with Red Hat Gluster Storage
- 10. Virtual Machines
- 10.1. Introduction to Virtual Machines
- 10.2. Supported Virtual Machine Operating Systems
- 10.3. Virtual Machine Performance Parameters
- 10.4. Creating Virtual Machines
- 10.5. Explanation of Settings and Controls in the New Virtual Machine and Edit Virtual Machine Windows
- 10.6. Configuring Virtual Machines
- 10.7. Editing Virtual Machines
- 10.8. Running Virtual Machines
- 10.9. Removing Virtual Machines
- 10.10. Cloning Virtual Machines
- 10.11. Virtual Machines and Permissions
- 10.12. Snapshots
- 10.13. Affinity Groups
- 10.14. Exporting and Importing Virtual Machines and Templates
- 10.15. Migrating Virtual Machines Between Hosts
- 10.16. Improving Uptime with Virtual Machine High Availability
- 10.17. Other Virtual Machine Tasks
- 11. Templates
- 12. Pools
- 13. Virtual Machine Disks
- 13.1. Understanding Virtual Machine Storage
- 13.2. Understanding Virtual Disks
- 13.3. Settings to Wipe Virtual Disks After Deletion
- 13.4. Shareable Disks in Red Hat Enterprise Virtualization
- 13.5. Read Only Disks in Red Hat Enterprise Virtualization
- 13.6. Virtual Disk Tasks
- 13.7. Virtual Disks and Permissions
- 14. External Providers
- II. Administering the Environment
- 15. Updating the Red Hat Enterprise Virtualization Environment
- 15.1. Updates between Minor Releases
- 15.2. Upgrading to Red Hat Enterprise Virtualization 3.5
- 15.3. Upgrading to Red Hat Enterprise Virtualization 3.4
- 15.4. Upgrading to Red Hat Enterprise Virtualization 3.3
- 15.5. Upgrading to Red Hat Enterprise Virtualization Manager 3.2
- 15.6. Upgrading to Red Hat Enterprise Virtualization Manager 3.1
- 15.7. Post-upgrade Tasks
- 16. Backups and Migration
- 17. Users and Roles
- 18. Quotas and Service Level Agreement Policy
- 18.1. Introduction to Quota
- 18.2. Shared Quota and Individually Defined Quota
- 18.3. Quota Accounting
- 18.4. Enabling and Changing a Quota Mode in a Data Center
- 18.5. Creating a New Quota Policy
- 18.6. Explanation of Quota Threshold Settings
- 18.7. Assigning a Quota to an Object
- 18.8. Using Quota to Limit Resources by User
- 18.9. Editing Quotas
- 18.10. Removing Quotas
- 18.11. Service Level Agreement Policy Enforcement
- 19. Event Notifications
- 20. Utilities
- III. Gathering Information About the Environment
- A. Firewalls
- B. VDSM and Hooks
- B.1. VDSM
- B.2. VDSM Hooks
- B.3. Extending VDSM with Hooks
- B.4. Supported VDSM Events
- B.5. The VDSM Hook Environment
- B.6. The VDSM Hook Domain XML Object
- B.7. Defining Custom Properties
- B.8. Setting 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
- C. Explanation of Network Bridge Parameters
- D. Red Hat Enterprise Virtualization User Interface Plugins
- D.1. Red Hat Enterprise Virtualization User Interface Plug-ins
- D.2. Red Hat Enterprise Virtualization User Interface Plugin Lifecycle
- D.3. User Interface Plugin-related Files and Their Locations
- D.4. Example User Interface Plug-in Deployment
- D.5. Installing the Red Hat Support Plug-in
- D.6. Using Red Hat Support Plug-in
- E. Red Hat Enterprise Virtualization and SSL
- F. Using Search, Bookmarks, and Tags
- G. Branding
- H. Revision History
Chapter 1. Introduction
1.1. Red Hat Enterprise Virtualization Architecture
- Virtual machine hosts using the Kernel-based Virtual Machine (KVM).
- Agents and tools running on hosts including VDSM, QEMU, and libvirt. These tools provide local management for virtual machines, networks and storage.
- The Red Hat Enterprise Virtualization Manager; a centralized management platform for the Red Hat Enterprise Virtualization environment. It provides a graphical interface where you can view, provision and manage resources.
- Storage domains to hold virtual resources like virtual machines, templates, ISOs.
- A database to track the state of and changes to the environment.
- Access to an external Directory Server to provide users and authentication.
- Networking to link the environment together. This includes physical network links, and logical networks.
1.2. Red Hat Enterprise Virtualization System Components
1.3. Red Hat Enterprise Virtualization Resources
- Data Center - A data center is the highest level container for all physical and logical resources within a managed virtual environment. It is a collection of clusters, virtual machines, storage, and networks.
- Clusters - A cluster is a set of physical hosts that are treated as a resource pool for virtual machines. Hosts in a cluster share the same network infrastructure and storage. They form a migration domain within which virtual machines can be moved from host to host.
- Logical Networks - A logical network is a logical representation of a physical network. Logical networks group network traffic and communication between the Manager, hosts, storage, and virtual machines.
- Hosts - A host is a physical server that runs one or more virtual machines. Hosts are grouped into clusters. Virtual machines can be migrated from one host to another within a cluster.
- Storage Pool - The storage pool is a logical entity that contains a standalone image repository of a certain type, either iSCSI, Fibre Channel, NFS, or POSIX. Each storage pool can contain several domains, for storing virtual machine disk images, ISO images, and for the import and export of virtual machine images.
- Virtual Machines - A virtual machine is a virtual desktop or virtual server containing an operating system and a set of applications. Multiple identical virtual machines can be created in a Pool. Virtual machines are created, managed, or deleted by power users and accessed by users.
- Template - A template is a model virtual machine with predefined settings. A virtual machine that is based on a particular template acquires the settings of the template. Using templates is the quickest way of creating a large number of virtual machines in a single step.
- Virtual Machine Pool - A virtual machine pool is a group of identical virtual machines that are available on demand by each group member. Virtual machine pools can be set up for different purposes. For example, one pool can be for the Marketing department, another for Research and Development, and so on.
- Snapshot - A snapshot is a view of a virtual machine's operating system and all its applications at a point in time. It can be used to save the settings of a virtual machine before an upgrade or installing new applications. In case of problems, a snapshot can be used to restore the virtual machine to its original state.
- User Types - Red Hat Enterprise Virtualization supports multiple levels of administrators and users with distinct levels of permissions. System administrators can manage objects of the physical infrastructure, such as data centers, hosts, and storage. Users access virtual machines available from a virtual machine pool or standalone virtual machines made accessible by an administrator.
- Events and Monitors - Alerts, warnings, and other notices about activities help the administrator to monitor the performance and status of resources.
- Reports - A range of reports either from the reports module based on JasperReports, or from the data warehouse. Preconfigured or ad hoc reports can be generated from the reports module. Users can also generate reports using any query tool that supports SQL from a data warehouse that collects monitoring data for hosts, virtual machines, and storage.
1.4. Red Hat Enterprise Virtualization API Support Statement
Supported Interfaces for Read and Write Access
- Representational State Transfer (REST) API
- The REST API exposed by the Red Hat Enterprise Virtualization Manager is a fully supported interface for interacting with Red Hat Enterprise Virtualization Manager.
- Software Development Kit (SDK)
- The Python SDK and Java SDK are fully supported interfaces for interacting with Red Hat Enterprise Virtualization Manager.
- Command Line Shell
- The command line shell provided by the rhevm-cli package is a fully supported interface for interacting with the Red Hat Enterprise Virtualization Manager.
- VDSM Hooks
- The creation and use of VDSM hooks to trigger modification of virtual machines based on custom properties specified in the Administration Portal is supported on Red Hat Enterprise Linux virtualization hosts. The use of VDSM Hooks on virtualization hosts running Red Hat Enterprise Virtualization Hypervisor is not currently supported.
Supported Interfaces for Read Access
- Red Hat Enterprise Virtualization Manager History Database
- Read access to the Red Hat Enterprise Virtualization Manager history database using the database views specified in the Administration Guide is supported. Write access is not supported.
- Libvirt on Virtualization Hosts
- Read access to
libvirtusing thevirsh -rcommand is a supported method of interacting with virtualization hosts. Write access is not supported.
Unsupported Interfaces
- The vdsClient Command
- Use of the
vdsClientcommand to interact with virtualization hosts is not supported unless explicitly requested by Red Hat Support. - Red Hat Enterprise Virtualization Hypervisor Console
- Console access to Red Hat Enterprise Virtualization Hypervisor outside of the provided text user interface for configuration is not supported unless explicitly requested by Red Hat Support.
- Red Hat Enterprise Virtualization Manager Database
- Direct access to and manipulation of the Red Hat Enterprise Virtualization Manager database is not supported unless explicitly requested by Red Hat Support.
Important
1.5. Administering and Maintaining the Red Hat Enterprise Virtualization Environment
- Managing physical and virtual resources such as hosts and virtual machines. This includes upgrading and adding hosts, importing domains, converting virtual machines created on foreign hypervisors, and managing virtual machine pools.
- Monitoring the overall system resources for potential problems such as extreme load on one of the hosts, insufficient memory or disk space, and taking any necessary actions (such as migrating virtual machines to other hosts to lessen the load or freeing resources by shutting down machines).
- Responding to the new requirements of virtual machines (for example, upgrading the operating system or allocating more memory).
- Managing customized object properties using tags.
- Managing searches saved as public bookmarks.
- Managing user setup and setting permission levels.
- Troubleshooting for specific users or virtual machines for overall system functionality.
- Generating general and specific reports.
Chapter 2. Using the Administration Portal
2.1. Browser and Client Requirements
| Operating System Family | Browser | Portal Access | Supported SPICE Client? |
|---|---|---|---|
| Red Hat Enterprise Linux | Mozilla Firefox 38 | Administration Portal and User Portal | Yes |
| Windows | Internet Explorer 9 or later | Administration Portal | Yes |
| Internet Explorer 8 or later | User Portal | Yes |
2.2. Graphical User Interface Elements
Key Graphical User Interface Elements
Header
The header bar contains the name of the currently logged in user, the button, the button, the button, and the button. The shows information on the version of Red Hat Enterprise Virtualization, the button allows you to configure user roles, and the button provides a shortcut to the book you are reading now.
Search Bar
The search bar allows you to build queries for finding resources such as hosts and clusters in the Red Hat Enterprise Virtualization environment. Queries can be as simple as a list of all the hosts in the system, or more complex, such as a list of resources that match certain conditions. As you type each part of the search query, you are offered choices to assist you in building the search. The star icon can be used to save the search as a bookmark.
Resource Tabs
All resources can be managed using their associated tab. Moreover, the Events tab allows you to view events for each resource. The Administration Portal provides the following tabs: Data Centers, Clusters, Hosts, Networks, Storage, Disks, Virtual Machines, Pools, Templates, Volumes, Users, and Events, and a Dashboard tab if you have installed the data warehouse and reports.
Results List
You can perform a task on an individual item, multiple items, or all the items in the results list by selecting the items and clicking the relevant action button. Information on a selected item is displayed in the details pane.
Details Pane
The details pane shows detailed information about a selected item in the results list. If no items are selected, this pane is hidden. If multiple items are selected, the details pane displays information on the first selected item only.
System/Bookmarks/Tags Pane
The system pane displays a navigable hierarchy of the resources in the virtualized environment. Bookmarks are used to save frequently used or complicated searches for repeated use. Bookmarks can be added, edited, or removed. Tags are applied to groups of resources and are used to search for all resources associated with that tag. The System/Bookmarks/Tags Pane can be minimized using the arrow in the upper right corner of the panel.
Alerts/Events Pane
The Alerts tab lists all high severity events such as errors or warnings. The Events tab shows a list of events for all resources. The Tasks tab lists the currently running tasks. You can view this panel by clicking the maximize/minimize button.
Refresh Rate
The refresh rate drop-down menu allows you to set the time, in seconds, between Administration Portal refreshes. To avoid the delay between a user performing an action and the result appearing the portal, the portal will automatically refresh upon an action or event regardless of the chosen refresh interval. You can set this interval by clicking the refresh symbol in top right of the portal.
2.3. Tree Mode and Flat Mode
2.4. Using the Guide Me Facility
2.5. Performing Searches in Red Hat Enterprise Virtualization
Note
2.6. Saving a Query String as a Bookmark
Procedure 2.1. Saving a Query String as a Bookmark
- Enter the desired search query in the search bar and perform the search.
- Click the star-shaped button to the right of the search bar to open the New Bookmark window.
- Enter the Name of the bookmark.
- Edit the Search string field (if applicable).
- Click to save the query as a bookmark and close the window.
- The search query is saved and displays in the Bookmarks pane.
2.7. The Configure Window
2.7.1. Roles
2.7.1.1. Creating a New Role
Procedure 2.2. Creating a New Role
- On the header bar, click the Configure button to open the Configure window. The window shows a list of default User and Administrator roles, and any custom roles.
- Click New. The New Role dialog box displays.
- Enter the Name and Description of the new role.
- Select either Admin or User as the Account Type.
- Use the or buttons to view more or fewer of the permissions for the listed objects in the Check Boxes to Allow Action list. You can also expand or collapse the options for each object.
- For each of the objects, select or clear the actions you wish to permit or deny for the role you are setting up.
- Click to apply the changes you have made. The new role displays on the list of roles.
2.7.1.2. Editing or Copying a Role
Procedure 2.3. Editing or Copying a Role
- On the header bar, click the Configure button to open the Configure window. The window shows a list of default User and Administrator roles, and any custom roles.
- Select the role you wish to change. Click Edit to open the Edit Role window, or click Copy to open the Copy Role window.
- If necessary, edit the Name and Description of the role.
- Use the or buttons to view more or fewer of the permissions for the listed objects. You can also expand or collapse the options for each object.
- For each of the objects, select or clear the actions you wish to permit or deny for the role you are editing.
- Click to apply the changes you have made.
2.7.1.3. User Role and Authorization Examples
Example 2.1. Cluster Permissions
cluster called Accounts. She is assigned the ClusterAdmin role on the accounts cluster. This enables her to manage all virtual machines in the cluster, since the virtual machines are child objects of the cluster. Managing the virtual machines includes editing, adding, or removing virtual resources such as disks, and taking snapshots. It does not allow her to manage any resources outside this cluster. Because ClusterAdmin is an administrator role, it allows her to use the Administration Portal to manage these resources, but does not give her any access via the User Portal.
Example 2.2. VM PowerUser Permissions
johndesktop for him. John is assigned the UserVmManager role on the johndesktop virtual machine. This allows him to access this single virtual machine using the User Portal. Because he has UserVmManager permissions, he can modify the virtual machine and add resources to it, such as new virtual disks. Because UserVmManager is a user role, it does not allow him to use the Administration Portal.
Example 2.3. Data Center Power User Role Permissions
PowerUserRole permissions for the data center in which her new virtual machine will reside. This is because to create a new virtual machine, she needs to make changes to several components within the data center, including creating the virtual machine disk image in the storage domain.
DataCenterAdmin privileges to Penelope. As a PowerUser for a data center, Penelope can log in to the User Portal and perform virtual machine-specific actions on virtual machines within the data center. She cannot perform data center-level operations such as attaching hosts or storage to a data center.
Example 2.4. Network Administrator Permissions
NetworkAdmin privileges on the IT department's data center, she can add and remove networks in the data center, and attach and detach networks for all virtual machines belonging to the data center.
NetworkUser permissions and UserVmManager permissions for the virtual machines used by the internal training department. With these permissions, Pat can perform simple administrative tasks such as adding network interfaces onto virtual machines in the Extended tab of the User Portal. However, he does not have permissions to alter the networks for the hosts on which the virtual machines run, or the networks on the data center to which the virtual machines belong.
Example 2.5. Custom Role Permissions
System - the top level object of the hierarchy shown in Figure 2.8, “UserManager Custom Role”. This means they apply to all other objects in the system. The role is set to have an Account Type of Admin. This means that when she is assigned this role, Rachel can only use the Administration Portal, not the User Portal.
2.7.2. System Permissions
2.7.2.1. User Properties
2.7.2.2. User and Administrator Roles
- Administrator Role: Allows access to the Administration Portal for managing physical and virtual resources. An administrator role confers permissions for actions to be performed in the User Portal; however, it has no bearing on what a user can see in the User Portal.
- User Role: Allows access to the User Portal for managing and accessing virtual machines and templates. A user role determines what a user can see in the User Portal. Permissions granted to a user with an administrator role are reflected in the actions available to that user in the User Portal.
administrator role on a cluster, you can manage all virtual machines in the cluster using the Administration Portal. However, you cannot access any of these virtual machines in the User Portal; this requires a user role.
2.7.2.3. User Roles Explained
Table 2.1. Red Hat Enterprise Virtualization User Roles - Basic
| Role | Privileges | Notes |
|---|---|---|
| UserRole | Can access and use virtual machines and pools. | Can log in to the User Portal, use assigned virtual machines and pools, view virtual machine state and details. |
| PowerUserRole | Can create and manage virtual machines and templates. | Apply this role to a user for the whole environment with the Configure window, or for specific data centers or clusters. For example, if a PowerUserRole is applied on a data center level, the PowerUser can create virtual machines and templates in the data center. |
| UserVmManager | System administrator of a virtual machine. | Can manage virtual machines and create and use snapshots. A user who creates a virtual machine in the User Portal is automatically assigned the UserVmManager role on the machine. |
Table 2.2. Red Hat Enterprise Virtualization User Roles - Advanced
| Role | Privileges | Notes |
|---|---|---|
| UserTemplateBasedVm | Limited privileges to only use Templates. | Can use templates to create virtual machines. |
| DiskOperator | Virtual disk user. | Can use, view and edit virtual disks. Inherits permissions to use the virtual machine to which the virtual disk is attached. |
| VmCreator | Can create virtual machines in the User Portal. | This role is not applied to a specific virtual machine; apply this role to a user for the whole environment with the Configure window. Alternatively apply this role for specific data centers or clusters. When applying this role to a cluster, you must also apply the DiskCreator role on an entire data center, or on specific storage domains. |
| TemplateCreator | Can create, edit, manage and remove virtual machine templates within assigned resources. | This role is not applied to a specific template; apply this role to a user for the whole environment with the Configure window. Alternatively apply this role for specific data centers, clusters, or storage domains. |
| DiskCreator | Can create, edit, manage and remove virtual machine disks within assigned clusters or data centers. | This role is not applied to a specific virtual disk; apply this role to a user for the whole environment with the Configure window. Alternatively apply this role for specific data centers or storage domains. |
| TemplateOwner | Can edit and delete the template, assign and manage user permissions for the template. | This role is automatically assigned to the user who creates a template. Other users who do not have TemplateOwner permissions on a template cannot view or use the template. |
| NetworkUser | Logical network and network interface user for virtual machine and template. | Can attach or detach network interfaces from specific logical networks. |
2.7.2.4. Administrator Roles Explained
Table 2.3. Red Hat Enterprise Virtualization System Administrator Roles - Basic
| Role | Privileges | Notes |
|---|---|---|
| SuperUser | System Administrator of the Red Hat Enterprise Virtualization environment. | Has full permissions across all objects and levels, can manage all objects across all data centers. |
| ClusterAdmin | Cluster Administrator. | Possesses administrative permissions for all objects underneath a specific cluster. |
| DataCenterAdmin | Data Center Administrator. | Possesses administrative permissions for all objects underneath a specific data center except for storage. |
Important
Table 2.4. Red Hat Enterprise Virtualization System Administrator Roles - Advanced
| Role | Privileges | Notes |
|---|---|---|
| TemplateAdmin | Administrator of a virtual machine template. | Can create, delete, and configure the storage domains and network details of templates, and move templates between domains. |
| StorageAdmin | Storage Administrator. | Can create, delete, configure, and manage an assigned storage domain. |
| HostAdmin | Host Administrator. | Can attach, remove, configure, and manage a specific host. |
| NetworkAdmin | Network Administrator. | Can configure and manage the network of a particular data center or cluster. A network administrator of a data center or cluster inherits network permissions for virtual pools within the cluster. |
| VmPoolAdmin | System Administrator of a virtual pool. | Can create, delete, and configure a virtual pool; assign and remove virtual pool users; and perform basic operations on a virtual machine in the pool. |
| GlusterAdmin | Gluster Storage Administrator. | Can create, delete, configure, and manage Gluster storage volumes. |
2.7.3. Cluster Policies
2.7.3.1. Creating a Cluster Policy
Procedure 2.4. Creating a Cluster Policy
- Click the button in the header bar of the Administration Portal to open the Configure window.
- Click Cluster Policies to view the cluster policies tab.
- Click to open the New Cluster Policy window.
- Enter a Name and Description for the cluster policy.
- Configure filter modules:
- In the Filter Modules section, drag and drop the preferred filter modules to apply to the cluster policy from the Disabled Filters section into the Enabled Filters section.
- Specific filter modules can also be set as the First, to be given highest priority, or Last, to be given lowest priority, for basic optimization.To set the priority, right-click any filter module, hover the cursor over Position and select First or Last.
- Configure weight modules:
- In the Weights Modules section, drag and drop the preferred weights modules to apply to the cluster policy from the Disabled Weights section into the Enabled Weights & Factors section.
- Use the and buttons to the left of the enabled weight modules to increase or decrease the weight of those modules.
- Specify a load balancing policy:
- From the drop-down menu in the Load Balancer section, select the load balancing policy to apply to the cluster policy.
- From the drop-down menu in the Properties section, select a load balancing property to apply to the cluster policy and use the text field to the right of that property to specify a value.
- Use the and buttons to add or remove additional properties.
- Click .
2.7.3.2. Explanation of Settings in the New Cluster Policy and Edit Cluster Policy Window
Table 2.5. New Cluster Policy Settings
|
Field Name
|
Description
|
|---|---|
|
Name
|
The name of the cluster policy. This is the name used to refer to the cluster policy in the Red Hat Enterprise Virtualization Manager.
|
|
Description
|
A description of the cluster policy. This field is recommended but not mandatory.
|
|
Filter Modules
|
A set of filters for controlling the hosts on which a virtual machine in a cluster can run. Enabling a filter will filter out hosts that do not meet the conditions specified by that filter, as outlined below:
|
|
Weights Modules
|
A set of weightings for controlling the relative priority of factors considered when determining the hosts in a cluster on which a virtual machine can run.
|
|
Load Balancer
|
This drop-down menu allows you to select a load balancing module to apply. Load balancing modules determine the logic used to migrate virtual machines from hosts experiencing high usage to hosts experiencing lower usage.
|
|
Properties
|
This drop-down menu allows you to add or remove properties for load balancing modules, and is only available when you have selected a load balancing module for the cluster policy. No properties are defined by default, and the properties that are available are specific to the load balancing module that is selected. Use the and buttons to add or remove additional properties to or from the load balancing module.
|
2.7.4. Instance Types
Table 2.6. Predefined Instance Types
|
Name
|
Memory
|
vCPUs
|
|---|---|---|
|
Tiny
|
512 MB
|
1
|
|
Small
|
2 GB
|
1
|
|
Medium
|
4 GB
|
2
|
|
Large
|
8 GB
|
2
|
|
XLarge
|
16 GB
|
4
|
). If the value of one of these fields is changed, the virtual machine will be detached from the instance type, changing to Custom, and the chain will appear broken (
). However, if the value is changed back, the chain will relink and the instance type will move back to the selected one.
2.7.4.1. Creating Instance Types
Procedure 2.5. Creating an Instance Type
- On the header bar, click the Configure button to open the window.
- Click the Instance Types tab.
- Click the button to open the New Instance Type window.
- On the General tab, fill in the Name and Description fields. You can accept the default settings for other fields, or change them if required.
- Click the System, Console, Host, High Availability, Resource Allocation, Boot Options, and Random Generator tabs in turn to define your instance configuration as required. The settings that appear under these tabs are identical to those in the New Virtual Machine window, but with the relevant fields only.
- Click to create the instance type and close the window.
2.7.4.2. Editing Instance Types
Procedure 2.6. Editing Instance Type Properties
- Select the instance type to be edited.
- Click the button to open the Edit Instance Type window.
- Change the General, System, Console, Host, High Availability, Resource Allocation, Boot Options, and Random Generator fields as required.
- Click to save your changes.
2.7.4.3. Removing Instance Types
Procedure 2.7. Removing an Instance Type
- Select the instance type to be removed.
- Click the button to open the Remove Instance Type window.
- If any virtual machines are based on the instance type to be removed, a warning window listing the attached virtual machines will appear. To continue removing the instance type, click the Approve Operation checkbox. Otherwise click .
- Click .
Part I. Administering the Resources
Table of Contents
- 3. Quality of Service
- 4. Data Centers
- 5. Clusters
- 6. Logical Networks
- 7. Hosts
- 8. Storage
- 8.1. Understanding Storage Domains
- 8.2. Storage Metadata Versions in Red Hat Enterprise Virtualization
- 8.3. Preparing and Adding NFS Storage
- 8.4. Preparing and Adding Local Storage
- 8.5. Preparing and Adding POSIX Compliant File System Storage
- 8.6. Preparing and Adding Block Storage
- 8.7. Importing Existing Storage Domains
- 8.8. Storage Tasks
- 8.9. Storage and Permissions
- 9. Working with Red Hat Gluster Storage
- 10. Virtual Machines
- 10.1. Introduction to Virtual Machines
- 10.2. Supported Virtual Machine Operating Systems
- 10.3. Virtual Machine Performance Parameters
- 10.4. Creating Virtual Machines
- 10.5. Explanation of Settings and Controls in the New Virtual Machine and Edit Virtual Machine Windows
- 10.6. Configuring Virtual Machines
- 10.7. Editing Virtual Machines
- 10.8. Running Virtual Machines
- 10.9. Removing Virtual Machines
- 10.10. Cloning Virtual Machines
- 10.11. Virtual Machines and Permissions
- 10.12. Snapshots
- 10.13. Affinity Groups
- 10.14. Exporting and Importing Virtual Machines and Templates
- 10.15. Migrating Virtual Machines Between Hosts
- 10.16. Improving Uptime with Virtual Machine High Availability
- 10.17. Other Virtual Machine Tasks
- 11. Templates
- 12. Pools
- 13. Virtual Machine Disks
- 13.1. Understanding Virtual Machine Storage
- 13.2. Understanding Virtual Disks
- 13.3. Settings to Wipe Virtual Disks After Deletion
- 13.4. Shareable Disks in Red Hat Enterprise Virtualization
- 13.5. Read Only Disks in Red Hat Enterprise Virtualization
- 13.6. Virtual Disk Tasks
- 13.7. Virtual Disks and Permissions
- 14. External Providers
Chapter 3. Quality of Service
3.1. Storage Quality of Service
3.1.1. Creating a Storage Quality of Service Entry
Procedure 3.1. Creating a Storage Quality of Service Entry
- Click the Data Centers resource tab and select a data center.
- Click QoS in the details pane.
- Click Storage.
- Click .
- Enter a name for the quality of service entry in the QoS Name field.
- Enter a description for the quality of service entry in the Description field.
- Specify the throughput quality of service:
- Select the Throughput check box.
- Enter the maximum permitted total throughput in the Total field.
- Enter the maximum permitted throughput for read operations in the Read field.
- Enter the maximum permitted throughput for write operations in the Write field.
- Specify the input and output quality of service:
- Select the IOps check box.
- Enter the maximum permitted number of input and output operations per second in the Total field.
- Enter the maximum permitted number of input operations per second in the Read field.
- Enter the maximum permitted number of output operations per second in the Write field.
- Click .
3.1.2. Removing a Storage Quality of Service Entry
Procedure 3.2. Removing a Storage Quality of Service Entry
- Click the Data Centers resource tab and select a data center.
- Click QoS in the details pane.
- Click Storage.
- Select the storage quality of service entry to remove.
- Click .
- Click when prompted.
[unlimited].
3.2. Network Quality of Service
Important
3.2.1. Creating a Network Quality of Service Entry
Procedure 3.3. Creating a Network Quality of Service Entry
- Click the Data Centers resource tab and select a data center.
- Click the QoS tab in the details pane.
- Click .
- Click .
- Enter a name for the network quality of service entry in the Name field.
- Enter the limits for the Inbound and Outbound network traffic.
- Click .
3.2.2. Settings in the New Network QoS and Edit Network QoS Windows Explained
Table 3.1. Network QoS Settings
|
Field Name
|
Description
|
|---|---|
|
Data Center
|
The data center to which the Network QoS policy is to be added. This field is configured automatically according to the selected data center.
|
|
Name
|
A name to represent the network QoS policy within the Manager.
|
|
Inbound
|
The settings to be applied to inbound traffic. Select or clear the Inbound check box to enable or disable these settings.
|
|
Outbound
|
The settings to be applied to outbound traffic. Select or clear the Outbound check box to enable or disable these settings.
|
3.2.3. Removing a Network Quality of Service Entry
Procedure 3.4. Removing a Network Quality of Service Entry
- Click the Data Centers resource tab and select a data center.
- In the details pane, click QoS.
- Click Network.
- Select the network quality of service entry to remove.
- Click .
- Click when prompted.
3.3. CPU Quality of Service
3.3.1. Creating a CPU Quality of Service Entry
Procedure 3.5. Creating a CPU Quality of Service Entry
- Click the Data Centers resource tab and select a data center.
- Click QoS in the details pane.
- Click CPU.
- Click .
- Enter a name for the quality of service entry in the QoS Name field.
- Enter a description for the quality of service entry in the Description field.
- Enter the maximum processing capability the quality of service entry permits in the Limit field, in percentage. Do not include the
%symbol. - Click .
3.3.2. Removing a CPU Quality of Service Entry
Procedure 3.6. Removing a CPU Quality of Service Entry
- Click the Data Centers resource tab and select a data center.
- Click QoS in the details pane.
- Click CPU.
- Select the CPU quality of service entry to remove.
- Click .
- Click when prompted.
[unlimited].
Chapter 4. Data Centers
4.1. Introduction to Data Centers
4.2. The Storage Pool Manager
4.3. SPM Priority
4.4. Using the Events Tab to Identify Problem Objects in Data Centers
4.5. Data Center Tasks
- 4.5.1. Creating a New Data Center
- 4.5.2. Explanation of Settings in the New Data Center and Edit Data Center Windows
- 4.5.3. Editing a Resource
- 4.5.4. Creating a New Logical Network in a Data Center or Cluster
- 4.5.5. Removing a Logical Network
- 4.5.6. Re-Initializing a Data Center: Recovery Procedure
- 4.5.7. Removing a Data Center
- 4.5.8. Force Removing a Data Center
- 4.5.9. Changing the Data Center Compatibility Version
4.5.1. Creating a New Data Center
Note
Procedure 4.1. Creating a New Data Center
- Select the Data Centers resource tab to list all data centers in the results list.
- Click to open the New Data Center window.
- Enter the Name and Description of the data center.
- Select the storage Type, Compatibility Version, and Quota Mode of the data center from the drop-down menus.
- Click to create the data center and open the New Data Center - Guide Me window.
- The Guide Me window lists the entities that need to be configured for the data center. Configure these entities or postpone configuration by clicking the button; configuration can be resumed by selecting the data center and clicking the button.
4.5.2. Explanation of Settings in the New Data Center and Edit Data Center Windows
Table 4.1. Data Center Properties
|
Field
|
Description/Action
|
|---|---|
|
Name
|
The name of the data center. This text field has a 40-character limit and must be a unique name with any combination of uppercase and lowercase letters, numbers, hyphens, and underscores.
|
|
Description
| The description of the data center. This field is recommended but not mandatory. |
|
Type
|
The storage type. Choose one of the following:
The type of data domain dictates the type of the data center and cannot be changed after creation without significant disruption. Multiple types of storage domains (iSCSI, NFS, FC, POSIX, and Gluster) can be added to the same data center, though local and shared domains cannot be mixed.
|
|
Compatibility Version
|
The version of Red Hat Enterprise Virtualization. Choose one of the following:
|
|
Quota Mode
| Quota is a resource limitation tool provided with Red Hat Enterprise Virtualization. Choose one of:
|
4.5.3. Editing a Resource
Procedure 4.2. Editing a Resource
- Use the resource tabs, tree mode, or the search function to find and select the resource in the results list.
- Click to open the Edit window.
- Change the necessary properties and click .
4.5.4. Creating a New Logical Network in a Data Center or Cluster
Procedure 4.3. Creating a New Logical Network in a Data Center or Cluster
- Use the Data Centers or Clusters resource tabs, tree mode, or the search function to find and select a data center or cluster in the results list.
- Click the Logical Networks tab of the details pane to list the existing logical networks.
- From the Data Centers details pane, click to open the New Logical Network window.
- From the Clusters details pane, click to open the New Logical Network window.
- Enter a Name, Description, and Comment for the logical network.
- Optionally select the Create on external provider check box. Select the External Provider from the drop-down list and provide the IP address of the Physical Network.If Create on external provider is selected, the Network Label, VM Network, and MTU options are disabled.
- Enter a new label or select an existing label for the logical network in the Network Label text field.
- Optionally enable Enable VLAN tagging.
- Optionally disable VM Network.
- Set the MTU value to Default (1500) or Custom.
- From the Cluster tab, select the clusters to which the network will be assigned. You can also specify whether the logical network will be a required network.
- If Create on external provider is selected, the Subnet tab will be visible. From the Subnet tab, select the Create subnet and enter a Name, CIDR, and Gateway address, and select an IP Version for the subnet that the logical network will provide. You can also add DNS servers as required.
- From the vNIC Profiles tab, add vNIC profiles to the logical network as required.
- Click OK.
Note
4.5.5. Removing a Logical Network
Procedure 4.4. Removing Logical Networks
- Use the Data Centers resource tab, tree mode, or the search function to find and select the data center of the logical network in the results list.
- Click the Logical Networks tab in the details pane to list the logical networks in the data center.
- Select a logical network and click to open the Remove Logical Network(s) window.
- Optionally, select the Remove external network(s) from the provider(s) as well check box to remove the logical network both from the Manager and from the external provider if the network is provided by an external provider.
- Click OK.
4.5.6. Re-Initializing a Data Center: Recovery Procedure
Procedure 4.5. Re-Initializing a Data Center
- Click the Data Centers resource tab and select the data center to re-initialize.
- Ensure that any storage domains attached to the data center are in maintenance mode.
- Right-click the data center and select Re-Initialize Data Center from the drop-down menu to open the Data Center Re-Initialize window.
- The Data Center Re-Initialize window lists all available (detached; in maintenance mode) storage domains. Click the radio button for the storage domain you are adding to the data center.
- Select the Approve operation check box.
- Click to close the window and re-initialize the data center.
4.5.7. Removing a Data Center
Procedure 4.6. Removing a Data Center
- Ensure the storage domains attached to the data center is in maintenance mode.
- Click the Data Centers resource tab and select the data center to remove.
- Click to open the Remove Data Center(s) confirmation window.
- Click .
4.5.8. Force Removing a Data Center
Non Responsive if the attached storage domain is corrupt or if the host becomes Non Responsive. You cannot Remove the data center under either circumstance.
Procedure 4.7. Force Removing a Data Center
- Click the Data Centers resource tab and select the data center to remove.
- Click Force Remove to open the Force Remove Data Center confirmation window.
- Select the Approve operation check box.
- Click OK
4.5.9. Changing the Data Center Compatibility Version
Note
Procedure 4.8. Changing the Data Center Compatibility Version
- Log in to the Administration Portal as the administrative user. By default this is the
adminuser. - Click the Data Centers tab.
- Select the data center to change from the list displayed. If the list of data centers is too long to filter visually then perform a search to locate the desired data center.
- Click the button.
- Change the Compatibility Version to the desired value.
- Click .
Warning
4.6. Data Centers and Storage Domains
4.6.1. Attaching an Existing Data Domain to a Data Center
Procedure 4.9. Attaching an Existing Data Domain to a Data Center
- Click the Data Centers resource tab and select the appropriate data center.
- Select the Storage tab in the details pane to list the storage domains already attached to the data center.
- Click to open the Attach Storage window.
- Select the check box for the data domain to attach to the data center. You can select multiple check boxes to attach multiple data domains.
- Click .
Note
4.6.2. Attaching an Existing ISO domain to a Data Center
Procedure 4.10. Attaching an Existing ISO Domain to a Data Center
- Click the Data Centers resource tab and select the appropriate data center.
- Select the Storage tab in the details pane to list the storage domains already attached to the data center.
- Click to open the Attach ISO Library window.
- Click the radio button for the appropriate ISO domain.
- Click .
4.6.3. Attaching an Existing Export Domain to a Data Center
Procedure 4.11. Attaching an Existing Export Domain to a Data Center
- Click the Data Centers resource tab and select the appropriate data center.
- Select the Storage tab in the details pane to list the storage domains already attached to the data center.
- Click to open the Attach Export Domain window.
- Click the radio button for the appropriate Export domain.
- Click .
4.6.4. Detaching a Storage Domain from a Data Center
Note
Procedure 4.12. Detaching a Storage Domain from a Data Center
- Click the Data Centers resource tab and select the appropriate data center.
- Select the Storage tab in the details pane to list the storage domains attached to the data center.
- Select the storage domain to detach. If the storage domain is
Active, click to open the Maintenance Storage Domain(s) confirmation window. - Click to initiate maintenance mode.
- Click to open the Detach Storage confirmation window.
- Click .
4.6.5. Activating a Storage Domain from Maintenance Mode
Procedure 4.13. Activating a Data Domain from Maintenance Mode
- Click the Data Centers resource tab and select the appropriate data center.
- Select the Storage tab in the details pane to list the storage domains attached to the data center.
- Select the appropriate storage domain and click .
4.7. Data Centers and Permissions
4.7.1. Managing System Permissions for a Data Center
- Create and remove clusters associated with the data center.
- Add and remove hosts, virtual machines, and pools associated with the data center.
- Edit user permissions for virtual machines associated with the data center.
Note
4.7.2. Data Center Administrator Roles Explained
Table 4.2. Red Hat Enterprise Virtualization System Administrator Roles
| Role | Privileges | Notes |
|---|---|---|
| DataCenterAdmin | Data Center Administrator | Can use, create, delete, manage all physical and virtual resources within a specific data center except for storage, including clusters, hosts, templates and virtual machines. |
| NetworkAdmin | Network Administrator | Can configure and manage the network of a particular data center. A network administrator of a data center inherits network permissions for virtual machines within the data center as well. |
4.7.3. Assigning an Administrator or User Role to a Resource
Procedure 4.14. Assigning a Role to a Resource
- Use the resource tabs, tree mode, or the search function to find and select the resource in the results list.
- Click the tab of the details pane to list the assigned users, the user's role, and the inherited permissions for the selected resource.
- Click to open the Add Permission to User window.
- Enter the name or user name of an existing user into the Search text box and click . Select a user from the resulting list of possible matches.
- Select a role from the Role to Assign: drop-down menu.
- Click to assign the role and close the window.
4.7.4. Removing an Administrator or User Role from a Resource
Procedure 4.15. Removing a Role from a Resource
- Use the resource tabs, tree mode, or the search function to find and select the resource in the results list.
- Click the tab of the details pane to list the assigned users, the user's role, and the inherited permissions for the selected resource.
- Select the user to remove from the resource.
- Click . The Remove Permission window opens to confirm permissions removal.
- Click to remove the user role.
Chapter 5. Clusters
5.1. Introduction to Clusters
5.2. Cluster Tasks
- 5.2.1. Creating a New Cluster
- 5.2.2. Explanation of Settings and Controls in the New Cluster and Edit Cluster Windows
- 5.2.3. Editing a Resource
- 5.2.4. Setting Load and Power Management Policies for Hosts in a Cluster
- 5.2.5. Updating the MoM Policy on Hosts in a Cluster
- 5.2.6. CPU Profiles
- 5.2.7. Importing an Existing Red Hat Gluster Storage Cluster
- 5.2.8. Explanation of Settings in the Add Hosts Window
- 5.2.9. Creating a New Logical Network in a Data Center or Cluster
- 5.2.10. Removing a Cluster
- 5.2.11. Designate a Specific Traffic Type for a Logical Network with the Manage Networks Window
- 5.2.12. Explanation of Settings in the Manage Networks Window
- 5.2.13. Changing the Cluster Compatibility Version
5.2.1. Creating a New Cluster
Procedure 5.1. Creating a New Cluster
- Select the Clusters resource tab.
- Click to open the New Cluster window.
- Select the Data Center the cluster will belong to from the drop-down list.
- Enter the Name and Description of the cluster.
- Select the CPU Type and Compatibility Version from the drop-down lists. It is important to match the CPU processor family with the minimum CPU processor type of the hosts you intend to attach to the cluster, otherwise the host will be non-operational.
Note
For both Intel and AMD CPU types, the listed CPU models are in logical order from the oldest to the newest. If your cluster includes hosts with different CPU models, select the oldest CPU model. For more information on each CPU model, see https://access.redhat.com/solutions/634853. - Select either the Enable Virt Service or Enable Gluster Service radio button to define whether the cluster will be populated with virtual machine hosts or with Gluster-enabled nodes. Note that you cannot add Red Hat Enterprise Virtualization Hypervisor hosts to a Gluster-enabled cluster.
- Optionally select the Enable to set VM maintenance reason check box to enable an optional reason field when a virtual machine is shut down from the Manager, allowing the administrator to provide an explanation for the maintenance.
- Select either the /dev/random source (Linux-provided device) or /dev/hwrng source (external hardware device) check box to specify the random number generator device that all hosts in the cluster must use.
- Click the Optimization tab to select the memory page sharing threshold for the cluster, and optionally enable CPU thread handling and memory ballooning on the hosts in the cluster.
- Click the Resilience Policy tab to select the virtual machine migration policy.
- Click the Cluster Policy tab to optionally configure a cluster policy, configure scheduler optimization settings, enable trusted service for hosts in the cluster, enable HA Reservation, and add a custom serial number policy.
- Click the Console tab to optionally override the global SPICE proxy, if any, and specify the address of a SPICE proxy for hosts in the cluster.
- Click the Fencing policy tab to enable or disable fencing in the cluster, and select fencing options.
- Click to create the cluster and open the New Cluster - Guide Me window.
- The Guide Me window lists the entities that need to be configured for the cluster. Configure these entities or postpone configuration by clicking the button; configuration can be resumed by selecting the cluster and clicking the button.
5.2.2. Explanation of Settings and Controls in the New Cluster and Edit Cluster Windows
5.2.2.1. General Cluster Settings Explained
Table 5.1. General Cluster Settings
|
Field
|
Description/Action
|
|---|---|
|
Data Center
|
The data center that will contain the cluster. The data center must be created before adding a cluster.
|
|
Name
|
The name of the cluster. This text field has a 40-character limit and must be a unique name with any combination of uppercase and lowercase letters, numbers, hyphens, and underscores.
|
|
Description / Comment
| The description of the cluster or additional notes. These fields are recommended but not mandatory. |
|
CPU Type
| The CPU type of the cluster. Choose one of:
|
|
Compatibility Version
| The version of Red Hat Enterprise Virtualization. Choose one of:
|
| CPU Architecture | The CPU architecture of the cluster. Choose one of:
|
|
Enable Virt Service
| If this radio button is selected, hosts in this cluster will be used to run virtual machines. |
|
Enable Gluster Service
| If this radio button is selected, hosts in this cluster will be used as Red Hat Gluster Storage Server nodes, and not for running virtual machines. You cannot add a Red Hat Enterprise Virtualization Hypervisor host to a cluster with this option enabled. |
|
Import existing gluster configuration
|
This check box is only available if the Enable Gluster Service radio button is selected. This option allows you to import an existing Gluster-enabled cluster and all its attached hosts to Red Hat Enterprise Virtualization Manager.
The following options are required for each host in the cluster that is being imported:
|
| Enable to set VM maintenance reason | If this check box is selected, an optional reason field will appear when a virtual machine in the cluster is shut down from the Manager. This allows you to provide an explanation for the maintenance, which will appear in the logs and when the virtual machine is powered on again. |
| Required Random Number Generator sources: |
If one of the following check boxes is selected, all hosts in the cluster must have that device available. This enables passthrough of entropy from the random number generator device to virtual machines.
|
5.2.2.2. Optimization Settings Explained
Table 5.2. Optimization Settings
|
Field
|
Description/Action
|
|---|---|
|
Memory Optimization
|
|
|
CPU Threads
|
Selecting the Count Threads As Cores check box allows hosts to run virtual machines with a total number of processor cores greater than the number of cores in the host.
The exposed host threads would be treated as cores which can be utilized by virtual machines. For example, a 24-core system with 2 threads per core (48 threads total) can run virtual machines with up to 48 cores each, and the algorithms to calculate host CPU load would compare load against twice as many potential utilized cores.
|
|
Memory Balloon
|
Selecting the Enable Memory Balloon Optimization check box enables memory overcommitment on virtual machines running on the hosts in this cluster. When this option is set, the Memory Overcommit Manager (MoM) will start ballooning where and when possible, with a limitation of the guaranteed memory size of every virtual machine.
To have a balloon running, the virtual machine needs to have a balloon device with relevant drivers. Each virtual machine in cluster level 3.2 and higher includes a balloon device, unless specifically removed. Each host in this cluster receives a balloon policy update when its status changes to
Up. If necessary, you can manually update the balloon policy on a host without having to change the status. See Section 5.2.5, “Updating the MoM Policy on Hosts in a Cluster”.
It is important to understand that in some scenarios ballooning may collide with KSM. In such cases MoM will try to adjust the balloon size to minimize collisions. Additionally, in some scenarios ballooning may cause sub-optimal performance for a virtual machine. Administrators are advised to use ballooning optimization with caution.
|
|
KSM control
|
Selecting the Enable KSM check box enables MoM to run Kernel Same-page Merging (KSM) when necessary and when it can yield a memory saving benefit that outweighs its CPU cost.
|
5.2.2.3. Resilience Policy Settings Explained
Table 5.3. Host Failure State Explained
|
State
|
Description
|
|---|---|
|
Non Operational
|
Non-operational hosts can be communicated with by the Manager, but have an incorrect configuration, for example a missing logical network. If a host becomes non-operational, the migration of virtual machines depends on the cluster resilience policy.
|
|
Non Responsive
|
Non-responsive hosts cannot be communicated with by the Manager. If a host becomes non-responsive, all virtual machines with high availability are restarted on a different host in the cluster.
|
Table 5.4. Resilience Policy Settings
|
Field
|
Description/Action
|
|---|---|
|
Migrate Virtual Machines
|
Migrates all virtual machines in order of their defined priority.
|
|
Migrate only Highly Available Virtual Machines
|
Migrates only highly available virtual machines to prevent overloading other hosts.
|
|
Do Not Migrate Virtual Machines
| Prevents virtual machines from being migrated. |
5.2.2.4. Cluster Policy Settings Explained
Table 5.5. Cluster Policy Tab Properties
|
Field
|
Description/Action
|
|---|---|
|
Select Policy
|
Select a policy from the drop-down list.
|
|
Properties
|
The following properties appear depending on the selected policy, and can be edited if necessary:
|
|
Scheduler Optimization
|
Optimize scheduling for host weighing/ordering.
|
|
Enable Trusted Service
|
Enable integration with an OpenAttestation server. Before this can be enabled, use the
engine-config tool to enter the OpenAttestation server's details.
|
|
Enable HA Reservation
|
Enable the Manager to monitor cluster capacity for highly available virtual machines. The Manager ensures that appropriate capacity exists within a cluster for virtual machines designated as highly available to migrate in the event that their existing host fails unexpectedly.
|
|
Provide custom serial number policy
|
This check box allows you to specify a serial number policy for the virtual machines in the cluster. Select one of the following options:
|
mom.Controllers.Balloon - INFO Ballooning guest:half1 from 1096400 to 1991580 are logged to /var/log/vdsm/mom.log. /var/log/vdsm/mom.log is the Memory Overcommit Manager log file.
5.2.2.5. Cluster Console Settings Explained
Table 5.6. Console Settings
|
Field
|
Description/Action
|
|---|---|
|
Define SPICE Proxy for Cluster
|
Select this check box to enable overriding the SPICE proxy defined in global configuration. This feature is useful in a case where the user (who is, for example, connecting via the User Portal) is outside of the network where the hypervisors reside.
|
|
Overridden SPICE proxy address
|
The proxy by which the SPICE client will connect to virtual machines. The address must be in the following format:
protocol://[host]:[port] |
5.2.2.6. Fencing Policy Settings Explained
Table 5.7. Fencing Policy Settings
| Field | Description/Action |
|---|---|
| Enable fencing | Enables fencing on the cluster. Fencing is enabled by default, but can be disabled if required; for example, if temporary network issues are occurring or expected, administrators can disable fencing until diagnostics or maintenance activities are completed. Note that if fencing is disabled, highly available virtual machines running on non-responsive hosts will not be restarted elsewhere. |
| Skip fencing if host has live lease on storage | If this check box is selected, any hosts in the cluster that are Non Responsive and still connected to storage will not be fenced. |
| Skip fencing on cluster connectivity issues | If this check box is selected, fencing will be temporarily disabled if the percentage of hosts in the cluster that are experiencing connectivity issues is greater than or equal to the defined Threshold. The Threshold value is selected from the drop-down list; available values are 25, 50, 75, and 100. |
5.2.3. Editing a Resource
Procedure 5.2. Editing a Resource
- Use the resource tabs, tree mode, or the search function to find and select the resource in the results list.
- Click to open the Edit window.
- Change the necessary properties and click .
5.2.4. Setting Load and Power Management Policies for Hosts in a Cluster
Procedure 5.3. Setting Load and Power Management Policies for Hosts
- Use the resource tabs, tree mode, or the search function to find and select the cluster in the results list.
- Click to open the Edit Cluster window.
- Select one of the following policies:
- none
- vm_evenly_distributed
- Set the maximum number of virtual machines that can run on each host in the HighVmCount field.
- Define the maximum acceptable difference between the number of virtual machines on the most highly-utilized host and the number of virtual machines on the least-utilized host in the MigrationThreshold field.
- Define the number of slots for virtual machines to be reserved on SPM hosts in the SpmVmGrace field.
- evenly_distributed
- Set the time (in minutes) that a host can run a CPU load outside of the defined utilization values before the cluster policy takes action in the CpuOverCommitDurationMinutes field.
- Enter the CPU utilization percentage at which virtual machines start migrating to other hosts in the HighUtilization field.
- power_saving
- Set the time (in minutes) that a host can run a CPU load outside of the defined utilization values before the cluster policy takes action in the CpuOverCommitDurationMinutes field.
- Enter the CPU utilization percentage below which the host will be considered under-utilized in the LowUtilization field.
- Enter the CPU utilization percentage at which virtual machines start migrating to other hosts in the HighUtilization field.
- Choose one of the following as the Scheduler Optimization for the cluster:
- Select Optimize for Utilization to include weight modules in scheduling to allow best selection.
- Select Optimize for Speed to skip host weighting in cases where there are more than ten pending requests.
- If you are using an OpenAttestation server to verify your hosts, and have set up the server's details using the
engine-configtool, select the Enable Trusted Service check box. - Optionally select the Enable HA Reservation check box to enable the Manager to monitor cluster capacity for highly available virtual machines.
- Optionally select the Provide custom serial number policy check box to specify a serial number policy for the virtual machines in the cluster, and then select one of the following options:
- Select Host ID to set the host's UUID as the virtual machine's serial number.
- Select Vm ID to set the virtual machine's UUID as its serial number.
- Select Custom serial number, and then specify a custom serial number in the text field.
- Click .
5.2.5. Updating the MoM Policy on Hosts in a Cluster
Procedure 5.4. Synchronizing MoM Policy on a Host
- Click the Clusters tab and select the cluster to which the host belongs.
- Click the Hosts tab in the details pane and select the host that requires an updated MoM policy.
- Click .
5.2.6. CPU Profiles
5.2.6.1. Creating a CPU Profile
Procedure 5.5. Creating a CPU Profile
- Click the Clusters resource tab and select a cluster.
- Click the CPU Profiles sub tab in the details pane.
- Click .
- Enter a name for the CPU profile in the Name field.
- Enter a description for the CPU profile in the Description field.
- Select the quality of service to apply to the CPU profile from the QoS list.
- Click .
5.2.6.2. Removing a CPU Profile
Procedure 5.6. Removing a CPU Profile
- Click the Clusters resource tab and select a cluster.
- Click the CPU Profiles sub tab in the details pane.
- Select the CPU profile to remove.
- Click .
- Click .
default CPU profile.
5.2.7. Importing an Existing Red Hat Gluster Storage Cluster
gluster peer status command is executed on that host through SSH, then displays a list of hosts that are a part of the cluster. You must manually verify the fingerprint of each host and provide passwords for them. You will not be able to import the cluster if one of the hosts in the cluster is down or unreachable. As the newly imported hosts do not have VDSM installed, the bootstrap script installs all the necessary VDSM packages on the hosts after they have been imported, and reboots them.
Important
Procedure 5.7. Importing an Existing Red Hat Gluster Storage Cluster to Red Hat Enterprise Virtualization Manager
- Select the Clusters resource tab to list all clusters in the results list.
- Click to open the New Cluster window.
- Select the Data Center the cluster will belong to from the drop-down menu.
- Enter the Name and Description of the cluster.
- Select the Enable Gluster Service radio button and the Import existing gluster configuration check box.The Import existing gluster configuration field is displayed only if you select Enable Gluster Service radio button.
- In the Address field, enter the hostname or IP address of any server in the cluster.The host Fingerprint displays to ensure you are connecting with the correct host. If a host is unreachable or if there is a network error, an error Error in fetching fingerprint displays in the Fingerprint field.
- Enter the Root Password for the server, and click OK.
- The Add Hosts window opens, and a list of hosts that are a part of the cluster displays.
- For each host, enter the Name and the Root Password.
- If you wish to use the same password for all hosts, select the Use a Common Password check box to enter the password in the provided text field.Click to set the entered password all hosts.Make sure the fingerprints are valid and submit your changes by clicking .
5.2.8. Explanation of Settings in the Add Hosts Window
Table 5.8. Add Gluster Hosts Settings
| Field | Description |
|---|---|
| Use a common password | Tick this check box to use the same password for all hosts belonging to the cluster. Enter the password in the Password field, then click the Apply button to set the password on all hosts. |
| Name | Enter the name of the host. |
| Hostname/IP | This field is automatically populated with the fully qualified domain name or IP of the host you provided in the New Cluster window. |
| Root Password | Enter a password in this field to use a different root password for each host. This field overrides the common password provided for all hosts in the cluster. |
| Fingerprint | The host fingerprint is displayed to ensure you are connecting with the correct host. This field is automatically populated with the fingerprint of the host you provided in the New Cluster window. |
5.2.9. Creating a New Logical Network in a Data Center or Cluster
Procedure 5.8. Creating a New Logical Network in a Data Center or Cluster
- Use the Data Centers or Clusters resource tabs, tree mode, or the search function to find and select a data center or cluster in the results list.
- Click the Logical Networks tab of the details pane to list the existing logical networks.
- From the Data Centers details pane, click to open the New Logical Network window.
- From the Clusters details pane, click to open the New Logical Network window.
- Enter a Name, Description, and Comment for the logical network.
- Optionally select the Create on external provider check box. Select the External Provider from the drop-down list and provide the IP address of the Physical Network.If Create on external provider is selected, the Network Label, VM Network, and MTU options are disabled.
- Enter a new label or select an existing label for the logical network in the Network Label text field.
- Optionally enable Enable VLAN tagging.
- Optionally disable VM Network.
- Set the MTU value to Default (1500) or Custom.
- From the Cluster tab, select the clusters to which the network will be assigned. You can also specify whether the logical network will be a required network.
- If Create on external provider is selected, the Subnet tab will be visible. From the Subnet tab, select the Create subnet and enter a Name, CIDR, and Gateway address, and select an IP Version for the subnet that the logical network will provide. You can also add DNS servers as required.
- From the vNIC Profiles tab, add vNIC profiles to the logical network as required.
- Click OK.
Note
5.2.10. Removing a Cluster
Note
Procedure 5.9. Removing a Cluster
- Use the resource tabs, tree mode, or the search function to find and select the cluster in the results list.
- Ensure there are no hosts in the cluster.
- Click to open the Remove Cluster(s) confirmation window.
- Click
5.2.11. Designate a Specific Traffic Type for a Logical Network with the Manage Networks Window
Procedure 5.10. Specifying Traffic Types for Logical Networks
- Use the Clusters resource tab, tree mode, or the search function to find and select the cluster in the results list.
- Select the Logical Networks tab in the details pane to list the logical networks assigned to the cluster.
- Click to open the Manage Networks window.
- Select appropriate check boxes.
- Click to save the changes and close the window.
Note
5.2.12. Explanation of Settings in the Manage Networks Window
Table 5.9. Manage Networks Settings
|
Field
|
Description/Action
|
|---|---|
|
Assign
|
Assigns the logical network to all hosts in the cluster.
|
|
Required
|
A Network marked "required" must remain operational in order for the hosts associated with it to function properly. If a required network ceases to function, any hosts associated with it become non-operational.
|
|
VM Network
| A logical network marked "VM Network" carries network traffic relevant to the virtual machine network. |
|
Display Network
| A logical network marked "Display Network" carries network traffic relevant to SPICE and to the virtual network controller. |
|
Migration Network
| A logical network marked "Migration Network" carries virtual machine and storage migration traffic. |
5.2.13. Changing the Cluster Compatibility Version
Note
Procedure 5.11. Changing the Cluster Compatibility Version
- Log in to the Administration Portal as the administrative user. By default this is the
adminuser. - Click the Clusters tab.
- Select the cluster to change from the list displayed. If the list of clusters is too long to filter visually then perform a search to locate the desired cluster.
- Click the button.
- Change the Compatibility Version to the desired value.
- Click to open the Change Cluster Compatibility Version confirmation window.
- Click to confirm.
Warning
5.3. Clusters and Permissions
5.3.1. Managing System Permissions for a Cluster
- Create and remove associated clusters.
- Add and remove hosts, virtual machines, and pools associated with the cluster.
- Edit user permissions for virtual machines associated with the cluster.
Note
5.3.2. Cluster Administrator Roles Explained
Table 5.10. Red Hat Enterprise Virtualization System Administrator Roles
| Role | Privileges | Notes |
|---|---|---|
| ClusterAdmin | Cluster Administrator |
Can use, create, delete, manage all physical and virtual resources in a specific cluster, including hosts, templates and virtual machines. Can configure network properties within the cluster such as designating display networks, or marking a network as required or non-required.
However, a ClusterAdmin does not have permissions to attach or detach networks from a cluster, to do so NetworkAdmin permissions are required.
|
| NetworkAdmin | Network Administrator | Can configure and manage the network of a particular cluster. A network administrator of a cluster inherits network permissions for virtual machines within the cluster as well. |
5.3.3. Assigning an Administrator or User Role to a Resource
Procedure 5.12. Assigning a Role to a Resource
- Use the resource tabs, tree mode, or the search function to find and select the resource in the results list.
- Click the tab of the details pane to list the assigned users, the user's role, and the inherited permissions for the selected resource.
- Click to open the Add Permission to User window.
- Enter the name or user name of an existing user into the Search text box and click . Select a user from the resulting list of possible matches.
- Select a role from the Role to Assign: drop-down menu.
- Click to assign the role and close the window.
5.3.4. Removing an Administrator or User Role from a Resource
Procedure 5.13. Removing a Role from a Resource
- Use the resource tabs, tree mode, or the search function to find and select the resource in the results list.
- Click the tab of the details pane to list the assigned users, the user's role, and the inherited permissions for the selected resource.
- Select the user to remove from the resource.
- Click . The Remove Permission window opens to confirm permissions removal.
- Click to remove the user role.
Chapter 6. Logical Networks
6.1. Introduction to Logical Networks
rhevm. The rhevm network carries all traffic, until another logical network is created. It is meant especially for management communication between the Red Hat Enterprise Virtualization Manager and hosts.
Warning
Important
- Directory Services
- DNS
- Storage
6.2. Required Networks, Optional Networks, and Virtual Machine Networks
Note
6.3. Logical Network Tasks
- 6.3.1. Using the Networks Tab
- 6.3.2. Creating a New Logical Network in a Data Center or Cluster
- 6.3.3. Editing a Logical Network
- 6.3.4. Explanation of Settings and Controls in the New Logical Network and Edit Logical Network Windows
- 6.3.5. Designate a Specific Traffic Type for a Logical Network with the Manage Networks Window
- 6.3.6. Explanation of Settings in the Manage Networks Window
- 6.3.7. Network Labels
6.3.1. Using the Networks Tab
- 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
6.3.2. Creating a New Logical Network in a Data Center or Cluster
Procedure 6.1. Creating a New Logical Network in a Data Center or Cluster
- Use the Data Centers or Clusters resource tabs, tree mode, or the search function to find and select a data center or cluster in the results list.
- Click the Logical Networks tab of the details pane to list the existing logical networks.
- From the Data Centers details pane, click to open the New Logical Network window.
- From the Clusters details pane, click to open the New Logical Network window.
- Enter a Name, Description, and Comment for the logical network.
- Optionally select the Create on external provider check box. Select the External Provider from the drop-down list and provide the IP address of the Physical Network.If Create on external provider is selected, the Network Label, VM Network, and MTU options are disabled.
- Enter a new label or select an existing label for the logical network in the Network Label text field.
- Optionally enable Enable VLAN tagging.
- Optionally disable VM Network.
- Set the MTU value to Default (1500) or Custom.
- From the Cluster tab, select the clusters to which the network will be assigned. You can also specify whether the logical network will be a required network.
- If Create on external provider is selected, the Subnet tab will be visible. From the Subnet tab, select the Create subnet and enter a Name, CIDR, and Gateway address, and select an IP Version for the subnet that the logical network will provide. You can also add DNS servers as required.
- From the vNIC Profiles tab, add vNIC profiles to the logical network as required.
- Click OK.
Note
6.3.3. Editing a Logical Network
Procedure 6.2. Editing a Logical Network
Important
- Use the Data Centers resource tab, tree mode, or the search function to find and select the data center of the logical network in the results list.
- Click the Logical Networks tab in the details pane to list the logical networks in the data center.
- Select a logical network and click to open the Edit Logical Network window.
- Edit the necessary settings.
- Click OK to save the changes.
Note
6.3.4. Explanation of Settings and Controls in the New Logical Network and Edit Logical Network Windows
6.3.4.1. Logical Network General Settings Explained
Table 6.1. New Logical Network and Edit Logical Network Settings
|
Field Name
|
Description
|
|---|---|
|
Name
|
The name of the logical network. This text field has a 15-character limit and must be a unique name with any combination of uppercase and lowercase letters, numbers, hyphens, and underscores.
|
|
Description
|
The description of the logical network. This text field has a 40-character limit.
|
|
Comment
|
A field for adding plain text, human-readable comments regarding the logical network.
|
|
Create on external provider
|
Allows you to create the logical network to an OpenStack Networking instance that has been added to the Manager as an external provider.
External Provider - Allows you to select the external provider on which the logical network will be created.
|
|
Enable VLAN tagging
|
VLAN tagging is a security feature that gives all network traffic carried on the logical network a special characteristic. VLAN-tagged traffic cannot be read by interfaces that do not also have that characteristic. Use of VLANs on logical networks also allows a single network interface to be associated with multiple, differently VLAN-tagged logical networks. Enter a numeric value in the text entry field if VLAN tagging is enabled.
|
|
VM Network
|
Select this option if only virtual machines use this network. If the network is used for traffic that does not involve virtual machines, such as storage communications, do not select this check box.
|
|
MTU
|
Choose either Default, which sets the maximum transmission unit (MTU) to the value given in the parenthesis (), or Custom to set a custom MTU for the logical network. You can use this to match the MTU supported by your new logical network to the MTU supported by the hardware it interfaces with. Enter a numeric value in the text entry field if Custom is selected.
|
|
Network Label
|
Allows you to specify a new label for the network or select from existing labels already attached to host network interfaces. If you select an existing label, the logical network will be automatically assigned to all host network interfaces with that label.
|
6.3.4.2. Logical Network Cluster Settings Explained
Table 6.2. New Logical Network Settings
|
Field Name
|
Description
|
|---|---|
|
Attach/Detach Network to/from Cluster(s)
|
Allows you to attach or detach the logical network from clusters in the data center and specify whether the logical network will be a required network for individual clusters.
Name - the name of the cluster to which the settings will apply. This value cannot be edited.
Attach All - Allows you to attach or detach the logical network to or from all clusters in the data center. Alternatively, select or clear the Attach check box next to the name of each cluster to attach or detach the logical network to or from a given cluster.
Required All - Allows you to specify whether the logical network is a required network on all clusters. Alternatively, select or clear the Required check box next to the name of each cluster to specify whether the logical network is a required network for a given cluster.
|
6.3.4.3. Logical Network vNIC Profiles Settings Explained
Table 6.3. New Logical Network Settings
|
Field Name
|
Description
|
|---|---|
|
vNIC Profiles
|
Allows you to specify one or more vNIC profiles for the logical network. You can add or remove a vNIC profile to or from the logical network by clicking the plus or minus button next to the vNIC profile. The first field is for entering a name for the vNIC profile.
Public - Allows you to specify whether the profile is available to all users.
QoS - Allows you to specify a network quality of service (QoS) profile to the vNIC profile.
|
6.3.5. Designate a Specific Traffic Type for a Logical Network with the Manage Networks Window
Procedure 6.3. Specifying Traffic Types for Logical Networks
- Use the Clusters resource tab, tree mode, or the search function to find and select the cluster in the results list.
- Select the Logical Networks tab in the details pane to list the logical networks assigned to the cluster.
- Click to open the Manage Networks window.
- Select appropriate check boxes.
- Click to save the changes and close the window.
Note
6.3.6. Explanation of Settings in the Manage Networks Window
Table 6.4. Manage Networks Settings
|
Field
|
Description/Action
|
|---|---|
|
Assign
|
Assigns the logical network to all hosts in the cluster.
|
|
Required
|
A Network marked "required" must remain operational in order for the hosts associated with it to function properly. If a required network ceases to function, any hosts associated with it become non-operational.
|
|
VM Network
| A logical network marked "VM Network" carries network traffic relevant to the virtual machine network. |
|
Display Network
| A logical network marked "Display Network" carries network traffic relevant to SPICE and to the virtual network controller. |
|
Migration Network
| A logical network marked "Migration Network" carries virtual machine and storage migration traffic. |
6.3.7. Network Labels
6.3.7.1. Network Labels
Network Label Associations
- When you attach a label to a logical network, that logical network will be automatically associated with any physical host network interfaces with the given label.
- When you attach a label to a physical host network interface, any logical networks with the given label will be automatically associated with that physical host network interface.
- Changing the label attached to a logical network or physical host network interface acts in the same way as removing a label and adding a new label. The association between related logical networks or physical host network interfaces is updated.
Network Labels and Clusters
- When a labeled logical network is added to a cluster and there is a physical host network interface in that cluster with the same label, the logical network is automatically added to that physical host network interface.
- When a labeled logical network is detached from a cluster and there is a physical host network interface in that cluster with the same label, the logical network is automatically detached from that physical host network interface.
Network Labels and Logical Networks With Roles
- When a labeled logical network is assigned to act as a display network or migration network, that logical network is then configured on the physical host network interface using DHCP so that the logical network can be assigned an IP address.
6.4. Virtual Network Interface Cards
6.4.1. vNIC Profile Overview
Note
6.4.2. Creating or Editing a vNIC Profile
Note
Procedure 6.4. Creating or editing a vNIC Profile
- Use the Networks resource tab, tree mode, or the search function to select a logical network in the results pane.
- Select the vNIC Profiles tab in the details pane. If you selected the logical network in tree mode, you can select the vNIC Profiles tab in the results list.
- Click or to open the VM Interface Profile window.
- Enter the Name and Description of the profile.
- Select the relevant Quality of Service policy from the QoS list.
- Use the Port Mirroring and Allow all users to use this Profile check boxes to toggle these options.
- Select a custom property from the custom properties list, which displays Please select a key... by default. Use the and buttons to add or remove custom properties.
- Click .
6.4.3. Explanation of Settings in the VM Interface Profile Window
Table 6.5. VM Interface Profile Window
|
Field Name
|
Description
|
|---|---|
|
Network
|
A drop-down menu of the available networks to apply the vNIC profile.
|
|
Name
|
The name of the vNIC profile. This must be a unique name with any combination of uppercase and lowercase letters, numbers, hyphens, and underscores between 1 and 50 characters.
|
| Description |
The description of the vNIC profile. This field is recommended but not mandatory.
|
| QoS |
A drop-down menu of the available Network Quality of Service policies to apply to the vNIC profile. QoS policies regulate inbound and outbound network traffic of the vNIC.
|
| Port Mirroring |
A check box to toggle port mirroring. Port mirroring copies layer 3 network traffic on the logical network to a virtual interface on a virtual machine. It it not selected by default.
|
| Device Custom Properties |
A drop-down menu to select available custom properties to apply to the vNIC profile. Use the and buttons to add and remove properties respectively.
|
| Allow all users to use this Profile |
A check box to toggle the availability of the profile to all users in the environment. It is selected by default.
|
6.4.4. Port Mirroring
- Port mirroring requires an IPv4 IP address.
- Hot plugging profiles with port mirroring is not supported.
Important
6.4.5. Removing a vNIC Profile
Procedure 6.5. Removing a vNIC Profile
- Use the Networks resource tab, tree mode, or the search function to select a logical network in the results pane.
- Select the Profiles tab in the details pane to display available vNIC profiles. If you selected the logical network in tree mode, you can select the VNIC Profiles tab in the results list.
- Select one or more profiles and click to open the Remove VM Interface Profile(s) window.
- Click to remove the profile and close the window.
6.4.6. Assigning Security Groups to vNIC Profiles
Note
Note
# neutron security-group-list
Procedure 6.6. Assigning Security Groups to vNIC Profiles
- Click the Networks tab and select a logical network in the results list.
- Click the vNIC Profiles tab in the details pane.
- Click , or select an existing vNIC profile and click , to open the VM Interface Profile window.
- From the custom properties drop-down list, select SecurityGroups. Leaving the custom property drop-down blank applies the default security settings, which permit all outbound traffic and intercommunication but deny all inbound traffic from outside of the default security group. Note that removing the SecurityGroups property later will not affect the applied security group.
- In the text field, enter the ID of the security group to attach to the vNIC profile.
- Click .
6.4.7. User Permissions for vNIC Profiles
Procedure 6.7. User Permissions for vNIC Profiles
- Use tree mode to select a logical network.
- Select the vNIC Profiles resource tab to display the vNIC profiles.
- Select the Permissions tab in the details pane to show the current user permissions for the profile.
- Use the button to open the Add Permission to User window, and the button to open the Remove Permission window, to affect user permissions for the vNIC profile.
6.5. External Provider Networks
6.5.1. Importing Networks From External Providers
Procedure 6.8. Importing a Network From an External Provider
- Click the Networks tab.
- Click the button to open the Import Networks window.
- From the Network Provider drop-down list, select an external provider. The networks offered by that provider are automatically discovered and listed in the Provider Networks list.
- Using the check boxes, select the networks to import in the Provider Networks list and click the down arrow to move those networks into the Networks to Import list.
- It is possible to customize the name of the network that you are importing. To customize the name, click on the network's name in the Name column, and change the text.
- From the Data Center drop-down list, select the data center into which the networks will be imported.
- Optionally, clear the Allow All check box for a network in the Networks to Import list to prevent that network from being available to all users.
- Click the button.
Important
6.5.2. Limitations to Using External Provider Networks
- Logical networks offered by external providers must be used as virtual machine networks, and cannot be used as display networks.
- The same logical network can be imported more than once, but only to different data centers.
- You cannot edit logical networks offered by external providers in the Manager. To edit the details of a logical network offered by an external provider, you must edit the logical network directly from the OpenStack Networking instance that provides that logical network.
- Port mirroring is not available for virtual network interface cards connected to logical networks offered by external providers.
- If a virtual machine uses a logical network offered by an external provider, that provider cannot be deleted from the Manager while the logical network is still in use by the virtual machine.
- Networks offered by external providers are non-required. As such, scheduling for clusters in which such logical networks have been imported will not take those logical networks into account during host selection. Moreover, it is the responsibility of the user to ensure the availability of the logical network on hosts in clusters in which such logical networks have been imported.
Important
Important
6.5.3. Configuring Subnets on External Provider Logical Networks
6.5.3.1. Configuring Subnets on External Provider Logical Networks
6.5.3.2. Adding Subnets to External Provider Logical Networks
Procedure 6.9. Adding Subnets to External Provider Logical Networks
- Click the Networks tab.
- Click the logical network provided by an external provider to which the subnet will be added.
- Click the Subnets tab in the details pane.
- Click the button to open the New External Subnet window.
- Enter a Name and CIDR for the new subnet.
- From the IP Version drop-down menu, select either IPv4 or IPv6.
- Click .
6.5.3.3. Removing Subnets from External Provider Logical Networks
Procedure 6.10. Removing Subnets from External Provider Logical Networks
- Click the Networks tab.
- Click the logical network provided by an external provider from which the subnet will be removed.
- Click the Subnets tab in the details pane.
- Click the subnet to remove.
- Click the button and click when prompted.
6.6. Logical Networks and Permissions
6.6.1. Managing System Permissions for a Network
- Create, edit and remove networks.
- Edit the configuration of the network, including configuring port mirroring.
- Attach and detach networks from resources including clusters and virtual machines.
6.6.2. Network Administrator and User Roles Explained
Table 6.6. Red Hat Enterprise Virtualization Network Administrator and User Roles
| Role | Privileges | Notes |
|---|---|---|
| NetworkAdmin | Network Administrator for data center, cluster, host, virtual machine, or template. The user who creates a network is automatically assigned NetworkAdmin permissions on the created network. | Can configure and manage the network of a particular data center, cluster, host, virtual machine, or template. A network administrator of a data center or cluster inherits network permissions for virtual pools within the cluster. To configure port mirroring on a virtual machine network, apply the NetworkAdmin role on the network and the UserVmManager role on the virtual machine. |
| NetworkUser | Logical network and network interface user for virtual machine and template. | Can attach or detach network interfaces from specific logical networks. |
6.6.3. Assigning an Administrator or User Role to a Resource
Procedure 6.11. Assigning a Role to a Resource
- Use the resource tabs, tree mode, or the search function to find and select the resource in the results list.
- Click the tab of the details pane to list the assigned users, the user's role, and the inherited permissions for the selected resource.
- Click to open the Add Permission to User window.
- Enter the name or user name of an existing user into the Search text box and click . Select a user from the resulting list of possible matches.
- Select a role from the Role to Assign: drop-down menu.
- Click to assign the role and close the window.
6.6.4. Removing an Administrator or User Role from a Resource
Procedure 6.12. Removing a Role from a Resource
- Use the resource tabs, tree mode, or the search function to find and select the resource in the results list.
- Click the tab of the details pane to list the assigned users, the user's role, and the inherited permissions for the selected resource.
- Select the user to remove from the resource.
- Click . The Remove Permission window opens to confirm permissions removal.
- Click to remove the user role.
Chapter 7. Hosts
7.1. Introduction to Red Hat Enterprise Virtualization Hosts
- 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.
7.2. Red Hat Enterprise Virtualization Hypervisor Hosts
Important
7.3. Foreman Host Provider Hosts
Important
7.4. Red Hat Enterprise Linux Hosts
Red Hat Enterprise Linux Server entitlement and the Red Hat Enterprise Virtualization entitlement.
7.5. Host Tasks
- 7.5.1. Adding a Red Hat Enterprise Linux Host
- 7.5.2. Adding a Foreman Host Provider Host
- 7.5.3. Approving a Registered Hypervisor
- 7.5.4. Explanation of Settings and Controls in the New Host and Edit Host Windows
- 7.5.5. Configuring Host Power Management Settings
- 7.5.6. Configuring Host Storage Pool Manager Settings
- 7.5.7. Editing a Resource
- 7.5.8. Approving Newly Added Red Hat Enterprise Virtualization Hypervisor Hosts
- 7.5.9. Moving a Host to Maintenance Mode
- 7.5.10. Activating a Host from Maintenance Mode
- 7.5.11. Removing a Host
- 7.5.12. Reinstalling Virtualization Hosts
- 7.5.13. Customizing Hosts with Tags
- 7.5.14. Changing the IP Address of a Red Hat Enterprise Virtualization Hypervisor (RHEV-H)
- 7.5.15. Changing the FQDN of a Host
7.5.1. Adding a Red Hat Enterprise Linux Host
Important
Procedure 7.1. Adding a Red Hat Enterprise Linux Host
- Click the Hosts resource tab to list the hosts in the results list.
- Click to open the New Host window.
- Use the drop-down menus to select the Data Center and Host Cluster for the new host.
- Enter the Name, Address, and SSH Port of the new host.
- Select an authentication method to use with the host.
- Enter the root user's password to use password authentication.
- Copy the key displayed in the SSH PublicKey field to
/root/.ssh/authorized_keyson the host to use public key authentication.
- You have now completed the mandatory steps to add a Red Hat Enterprise Linux host. Click the button to expand the advanced host settings.
- Optionally disable automatic firewall configuration.
- Optionally disable use of JSON protocol.
Note
With Red Hat Enterprise Virtualization 3.5, the communication model between the Manager and VDSM now uses JSON protocol, which reduces parsing time. As a result, the communication message format has changed from XML format to JSON format. Web requests have changed from synchronous HTTP requests to asynchronous TCP requests. - Optionally add a host SSH fingerprint to increase security. You can add it manually, or fetch it automatically.
- You can configure the Power Management and SPM using the applicable tabs now; however, as these are not fundamental to adding a Red Hat Enterprise Linux host, they are not covered in this procedure.
- Click .
Installing, and you can view the progress of the installation in the details pane. After installation is complete, the status updates to Reboot. The host must be activated for the status to change to Up.
7.5.2. Adding a Foreman Host Provider Host
Procedure 7.2. Adding a Foreman Host Provider Host
- Click the Hosts resource tab to list the hosts in the results list.
- Click to open the New Host window.
- Use the drop-down menus to select the Data Center and Host Cluster for the new host.
- Select the Use Foreman Hosts Providers check box to display the options for adding a Foreman host provider host and select the provider from which the host is to be added.
- Select either Discovered Hosts or Provisioned Hosts.
- Discovered Hosts (default option): Select the host, host group, and compute resources from the drop-down lists.
- Provisioned Hosts: Select a host from the Providers Hosts drop-down list.
Any details regarding the host that can be retrieved from the external provider are automatically set, and can be edited as desired. - Enter the Name, Address, and SSH Port (Provisioned Hosts only) of the new host.
- Select an authentication method to use with the host.
- Enter the root user's password to use password authentication.
- Copy the key displayed in the SSH PublicKey field to
/root/.ssh/authorized_hostson the host to use public key authentication (Provisioned Hosts only).
- You have now completed the mandatory steps to add a Red Hat Enterprise Linux host. Click the drop-down button to show the advanced host settings.
- Optionally disable automatic firewall configuration.
- Optionally disable the use of JSON protocol.
- Optionally add a host SSH fingerprint to increase security. You can add it manually, or fetch it automatically.
- You can configure the Power Management, SPM, Console, and Network Provider using the applicable tabs now; however, as these are not fundamental to adding a Red Hat Enterprise Linux host, they are not covered in this procedure.
- Click to add the host and close the window.
Installing, and you can view the progress of the installation in the details pane. After installation is complete, the status will update to Reboot. The host must be activated for the status to change to Up.
7.5.3. Approving a Registered Hypervisor
Procedure 7.3. Approving a Registered Hypervisor
- From the Administration Portal, click the Hosts tab, and then click the host to be approved. The host is currently listed with the status of Pending Approval.
- Click Approve to open the Edit and Approve Hosts window. You can use the window to specify a name for the Hypervisor, fetch its SSH fingerprint before approving it, and configure power management. For information on power management configuration, refer to Section 7.5.4.2, “Host Power Management Settings Explained”.
- Click . If you have not configured power management, you are prompted to confirm whether to proceed without doing so; click .
7.5.4. Explanation of Settings and Controls in the New Host and Edit Host Windows
7.5.4.1. Host General Settings Explained
Table 7.1. General settings
|
Field Name
|
Description
|
|---|---|
|
Data Center
|
The data center to which the host belongs. Red Hat Enterprise Virtualization Hypervisor hosts cannot be added to Gluster-enabled clusters.
|
|
Host Cluster
|
The cluster to which the host belongs.
|
|
Use Foreman Hosts Providers
|
Select or clear this check box to view or hide options for adding hosts provided by Foreman hosts providers. The following options are also available:
Discovered Hosts
Provisioned Hosts
|
|
Name
|
The name of the cluster. This text field has a 40-character limit and must be a unique name with any combination of uppercase and lowercase letters, numbers, hyphens, and underscores.
|
|
Comment
|
A field for adding plain text, human-readable comments regarding the host.
|
|
Address
|
The IP address, or resolvable hostname of the host.
|
|
Password
|
The password of the host's root user. This can only be given when you add the host; it cannot be edited afterwards.
|
|
SSH PublicKey
|
Copy the contents in the text box to the
/root/.known_hosts file on the host to use the Manager's ssh key instead of using a password to authenticate with the host.
|
|
Automatically configure host firewall
|
When adding a new host, the Manager can open the required ports on the host's firewall. This is enabled by default. This is an Advanced Parameter.
|
|
Use JSON protocol
|
This is enabled by default. This is an Advanced Parameter.
|
|
SSH Fingerprint
|
You can the host's SSH fingerprint, and compare it with the fingerprint you expect the host to return, ensuring that they match. This is an Advanced Parameter.
|
7.5.4.2. Host Power Management Settings Explained
Table 7.2. Power Management Settings
|
Field Name
|
Description
|
|---|---|
|
Kdump integration
|
Prevents the host from fencing while performing a kernel crash dump, so that the crash dump is not interrupted. Kdump is available by default on new Red Hat Enterprise Linux 6.6 and 7.1 hosts and Hypervisors. If kdump is available on the host, but its configuration is not valid (the kdump service cannot be started), enabling Kdump integration will cause the host (re)installation to fail. If this is the case, see Section 7.7.4, “fence_kdump Advanced Configuration”.
|
|
Primary/ Secondary
|
Prior to Red Hat Enterprise Virtualization 3.2, a host with power management configured only recognized one fencing agent. Fencing agents configured on version 3.1 and earlier, and single agents, are treated as primary agents. The secondary option is valid when a second agent is defined.
|
|
Concurrent
|
Valid when there are two fencing agents, for example for dual power hosts in which each power switch has two agents connected to the same power switch.
|
|
Address
|
The address to access your host's power management device. Either a resolvable hostname or an IP address.
|
|
User Name
|
User account with which to access the power management device. You can set up a user on the device, or use the default user.
|
|
Password
|
Password for the user accessing the power management device.
|
|
Type
|
The type of power management device in your host.
Choose one of the following:
|
|
Port
|
The port number used by the power management device to communicate with the host.
|
|
Options
|
Power management device specific options. Enter these as 'key=value' or 'key'. See the documentation of your host's power management device for the options available.
For Red Hat Enterprise Linux 7 hosts, if you are using cisco_ucs as the power management device, you also need to append
ssl_insecure=1 to the Options field.
|
|
Secure
|
Select this check box to allow the power management device to connect securely to the host. This can be done via ssh, ssl, or other authentication protocols depending on and supported by the power management agent.
|
|
Source
|
Specifies whether the host will search within its cluster or data center for a fencing proxy. Use the and buttons to change the sequence in which the resources are used.
|
|
Disable policy control of power management
|
Power management is controlled by the Cluster Policy of the host's cluster. If power management is enabled and the defined low utilization value is reached, the Manager will power down the host machine, and restart it again when load balancing requires or there are not enough free hosts in the cluster. Select this check box to disable policy control.
|
7.5.4.3. SPM Priority Settings Explained
Table 7.3. SPM settings
|
Field Name
|
Description
|
|---|---|
|
SPM Priority
|
Defines the likelihood that the host will be given the role of Storage Pool Manager (SPM). The options are Low, Normal, and High priority. Low priority means that there is a reduced likelihood of the host being assigned the role of SPM, and High priority means there is an increased likelihood. The default setting is Normal.
|
7.5.4.4. Host Console Settings Explained
Table 7.4. Console settings
|
Field Name
|
Description
|
|---|---|
|
Override display address
|
Select this check box to override the display addresses of the host. This feature is useful in a case where the hosts are defined by internal IP and are behind a NAT firewall. When a user connects to a virtual machine from outside of the internal network, instead of returning the private address of the host on which the virtual machine is running, the machine returns a public IP or FQDN (which is resolved in the external network to the public IP).
|
|
Display address
|
The display address specified here will be used for all virtual machines running on this host. The address must be in the format of a fully qualified domain name or IP.
|
7.5.5. Configuring Host Power Management Settings
Important
maintenance mode before configuring power management settings. Otherwise, all running virtual machines on that host will be stopped ungracefully upon restarting the host, which can cause disruptions in production environments. A warning dialog will appear if you have not correctly set your host to maintenance mode.
Procedure 7.4. Configuring Power Management Settings
- Use the Hosts resource tab, tree mode, or the search function to find and select the host in the results list.
- Click to open the Edit Host window.
- Click the Power Management tab to display the Power Management settings.
- Select the Enable Power Management check box to enable the fields.
- Select the Kdump integration check box to prevent the host from fencing while performing a kernel crash dump.
Important
When you enable Kdump integration on an existing host, the host must be reinstalled for kdump to be configured. See Section 7.5.12, “Reinstalling Virtualization Hosts”. - The Primary option is selected by default if you are configuring a new power management device. If you are adding a new device, set it to Secondary.
- Select the Concurrent check box to enable multiple fence agents to be used concurrently.
- Enter the Address, User Name, and Password of the power management device into the appropriate fields.
- Use the drop-down menu to select the Type of power management device.
- Enter the Port number used by the power management device to communicate with the host.
- Enter the Options for the power management device. Use a comma-separated list of 'key=value' or 'key'.
- Select the Secure check box to enable the power management device to connect securely to the host.
- Click to ensure the settings are correct.
- Click to save your settings and close the window.
Note
7.5.6. Configuring Host Storage Pool Manager Settings
Procedure 7.5. Configuring SPM settings
- Use the Hosts resource tab, tree mode, or the search function to find and select the host in the results list.
- Click to open the Edit Host window.
- Click the SPM tab to display the SPM Priority settings.
- Use the radio buttons to select the appropriate SPM priority for the host.
- Click to save the settings and close the window.
7.5.7. Editing a Resource
Procedure 7.6. Editing a Resource
- Use the resource tabs, tree mode, or the search function to find and select the resource in the results list.
- Click to open the Edit window.
- Change the necessary properties and click .
7.5.8. Approving Newly Added Red Hat Enterprise Virtualization Hypervisor Hosts
Procedure 7.7. Approving newly added Red Hat Enterprise Virtualization Hypervisor hosts
- In the Hosts tab, select the host you recently installed using the Red Hat Enterprise Virtualization Hypervisor host installation media. This host shows a status of
Pending Approval. - Click the button.
Up and it can be used to run virtual machines.
Note
7.5.9. Moving a Host to Maintenance Mode
Procedure 7.8. Moving a Host to Maintenance Mode
- Use the Hosts resource tab, tree mode, or the search function to find and select the host in the results list.
- Click to open the Maintenance Host(s) confirmation window.
- Click to initiate maintenance mode.
Preparing for Maintenance, and finally Maintenance when the operation completes successfully.
7.5.10. Activating a Host from Maintenance Mode
Procedure 7.9. Activating a Host from Maintenance Mode
- Use the Hosts resource tab, tree mode, or the search function to find and select the host in the results list.
- Click .
Unassigned, and finally Up when the operation is complete. Virtual machines can now run on the host.
7.5.11. Removing a Host
Procedure 7.10. Removing a host
- Use the Hosts resource tab, tree mode, or the search function to find and select the host in the results list.
- Place the host into maintenance mode.
- Click to open the Remove Host(s) confirmation window.
- Select the Force Remove check box if the host is part of a Red Hat Gluster Storage cluster and has volume bricks on it, or if the host is non-responsive.
- Click .
7.5.12. Reinstalling Virtualization Hosts
Important
Procedure 7.11. Reinstalling Red Hat Enterprise Virtualization Hypervisors and Red Hat Enterprise Linux Hosts
- Use the Hosts resource tab, tree mode, or the search function to find and select the host in the results list.
- Click . If migration is enabled at cluster level, any virtual machines running on the host are migrated to other hosts. If the host is the SPM, this function is moved to another host. The status of the host changes as it enters maintenance mode.
- Click Reinstall to open the Install Host window.
- Click to reinstall the host.
Important
7.5.13. Customizing Hosts with Tags
Procedure 7.12. Customizing hosts with tags
- Use the Hosts resource tab, tree mode, or the search function to find and select the host in the results list.
- Click to open the Assign Tags window.
- The Assign Tags window lists all available tags. Select the check boxes of applicable tags.
- Click to assign the tags and close the window.
7.5.14. Changing the IP Address of a Red Hat Enterprise Virtualization Hypervisor (RHEV-H)
Procedure 7.13.
- Place the Hypervisor into maintenance mode so the virtual machines are live migrated to another Hypervisor. See Section 7.5.9, “Moving a Host to Maintenance Mode” for more information. Alternatively, manually shut down or migrate all the virtual machines to another Hypervisor. See Manually Migrating Virtual Machines for more information.
- Click , and click to remove the host from the Administration Portal.
- Log in to your Hypervisor as the
adminuser. - Press F2, select , and press Enter to enter the rescue shell.
- Modify the IP address by editing the
/etc/sysconfig/network-scripts/ifcfg-rhevmfile. For example:# vi /etc/sysconfig/network-scripts/ifcfg-rhevm ... BOOTPROTO=none IPADDR=10.x.x.x PREFIX=24 ...
- Restart the network service and verify that the IP address has been updated.
- For Red Hat Enterprise Linux 6:
# service network restart
# ifconfig rhevm
- For Red Hat Enterprise Linux 7:
# systemctl restart network.service
# ip addr show rhevm
- Type
exitto exit the rescue shell and return to the text user interface. - Re-register the host with the Manager. See Installation Guide, Manually Adding a Hypervisor from the Administration Portal for more information.
7.5.15. Changing the FQDN of a Host
Procedure 7.14. Updating the FQDN of a Hypervisor Host
- Place the Hypervisor into maintenance mode so the virtual machines are live migrated to another Hypervisor. See Section 7.5.9, “Moving a Host to Maintenance Mode” for more information. Alternatively, manually shut down or migrate all the virtual machines to another Hypervisor. See Manually Migrating Virtual Machines for more information.
- Click , and click to remove the host from the Administration Portal.
- For RHEL-based hosts:
- For Red Hat Enterprise Linux 6:Edit the
/etc/sysconfig/networkfile, update the host name, and save.# vi /etc/sysconfig/network HOSTNAME=NEW_FQDN
- For Red Hat Enterprise Linux 7:Use the hostnamectl tool to update the host name. For more options, see Red Hat Enterprise Linux 7 Networking Guide, Configure Host Names.
# hostnamectl set-hostname NEW_FQDN
- For Red Hat Enterprise Virtualization Hypervisors (RHEV-H):In the text user interface, select the Network screen, press the right arrow key and enter a new host name in the Hostname field. Select and press Enter.
- Reboot the host.
- Re-register the host with the Manager. See Installation Guide, Manually Adding a Hypervisor from the Administration Portal for more information.
7.6. Hosts and Networking
- 7.6.1. Refreshing Host Capabilities
- 7.6.2. Editing Host Network Interfaces and Assigning Logical Networks to Hosts
- 7.6.3. Adding Multiple VLANs to a Single Network Interface Using Logical Networks
- 7.6.4. Adding Network Labels to Host Network Interfaces
- 7.6.5. Bonds
- 7.6.6. Saving a Host Network Configuration
7.6.1. Refreshing Host Capabilities
Procedure 7.15. To Refresh Host Capabilities
- Use the resource tabs, tree mode, or the search function to find and select a host in the results list.
- Click the Refresh Capabilities button.
7.6.2. Editing Host Network Interfaces and Assigning Logical Networks to Hosts
Important
Procedure 7.16. Editing Host Network Interfaces and Assigning Logical Networks to Hosts
- Use the Hosts resource tab, tree mode, or the search function to find and select the host in the results.
- Click the Network Interfaces tab in the details pane.
- Click the button to open the Setup Host Networks window.
- Attach a logical network to a physical host network interface by selecting and dragging the logical network into the Assigned Logical Networks area next to the physical host network interface.Alternatively, right-click the logical network and select a network interface from the drop-down menu.
- Configure the logical network:
- Hover your cursor over an assigned logical network and click the pencil icon to open the Edit Management Network window.
- Select a Boot Protocol from:
- None,
- DHCP, or
- Static.If you selected Static, enter the IP, Subnet Mask, and the Gateway.
- To configure a network bridge, click the Custom Properties drop-down menu and select . Enter a valid key and value with the following syntax: [key]=[value]. Separate multiple entries with a whitespace character. The following keys are valid, with the values provided as examples. For more information on these parameters, see Section C.1, “Explanation of bridge_opts Parameters”.
forward_delay=1500 gc_timer=3765 group_addr=1:80:c2:0:0:0 group_fwd_mask=0x0 hash_elasticity=4 hash_max=512 hello_time=200 hello_timer=70 max_age=2000 multicast_last_member_count=2 multicast_last_member_interval=100 multicast_membership_interval=26000 multicast_querier=0 multicast_querier_interval=25500 multicast_query_interval=13000 multicast_query_response_interval=1000 multicast_query_use_ifaddr=0 multicast_router=1 multicast_snooping=1 multicast_startup_query_count=2 multicast_startup_query_interval=3125
- If your logical network definition is not synchronized with the network configuration on the host, select the Sync network check box. A logical network cannot be edited or moved to another interface until it is synchronized.
Note
Networks are not considered synchronized if they have one of the following conditions:- The VM Network is different from the physical host network.
- The VLAN identifier is different from the physical host network.
- A Custom MTU is set on the logical network, and is different from the physical host network.
- Select the Verify connectivity between Host and Engine check box to check network connectivity; this action will only work if the host is in maintenance mode.
- Select the Save network configuration check box to make the changes persistent when the environment is rebooted.
- Click .
Note
7.6.3. Adding Multiple VLANs to a Single Network Interface Using Logical Networks
Important
Procedure 7.17. Adding Multiple VLANs to a Network Interface using Logical Networks
- Use the Hosts resource tab, tree mode, or the search function to find and select in the results list a host associated with the cluster to which your VLAN-tagged logical networks are assigned.
- Click the Network Interfaces tab in the details pane to list the physical network interfaces attached to the data center.
- Click to open the Setup Host Networks window.
- Drag your VLAN-tagged logical networks into the Assigned Logical Networks area next to the physical network interface. The physical network interface can have multiple logical networks assigned due to the VLAN tagging.
- Edit the logical networks by hovering your cursor over an assigned logical network and clicking the pencil icon to open the Edit Network window.If your logical network definition is not synchronized with the network configuration on the host, select the Sync network check box.Select a Boot Protocol from:Click OK.
- None,
- DHCP, or
- Static,Provide the IP and Subnet Mask.
- Select the Verify connectivity between Host and Engine check box to run a network check; this will only work if the host is in maintenance mode.
- Select the Save network configuration check box
- Click .
7.6.4. Adding Network Labels to Host Network Interfaces
Procedure 7.18. Adding Network Labels to Host Network Interfaces
- Use the Hosts resource tab, tree mode, or the search function to find and select in the results list a host associated with the cluster to which your VLAN-tagged logical networks are assigned.
- Click the Network Interfaces tab in the details pane to list the physical network interfaces attached to the data center.
- Click to open the Setup Host Networks window.
- Edit a physical network interface by hovering your cursor over a physical network interface and clicking the pencil icon to open the Edit Interface window.
- Enter a name for the network label in the Label text field and use the + and - buttons to add or remove additional network labels.
- Click .
7.6.5. Bonds
7.6.5.1. Bonding Logic in Red Hat Enterprise Virtualization
- Are either of the devices already carrying logical networks?
- Are the devices carrying compatible logical networks? A single device cannot carry both VLAN tagged and non-VLAN tagged logical networks.
Table 7.5. Bonding Scenarios and Their Results
| Bonding Scenario | Result |
|---|---|
|
NIC + NIC
|
The Create New Bond window is displayed, and you can configure a new bond device.
If the network interfaces carry incompatible logical networks, the bonding operation fails until you detach incompatible logical networks from the devices forming your new bond.
|
|
NIC + Bond
|
The NIC is added to the bond device. Logical networks carried by the NIC and the bond are all added to the resultant bond device if they are compatible.
If the bond devices carry incompatible logical networks, the bonding operation fails until you detach incompatible logical networks from the devices forming your new bond.
|
|
Bond + Bond
|
If the bond devices are not attached to logical networks, or are attached to compatible logical networks, a new bond device is created. It contains all of the network interfaces, and carries all logical networks, of the component bond devices. The Create New Bond window is displayed, allowing you to configure your new bond.
If the bond devices carry incompatible logical networks, the bonding operation fails until you detach incompatible logical networks from the devices forming your new bond.
|
7.6.5.2. Bonds
Important
Bonding Modes
Mode 0 (round-robin policy)- Transmits packets through network interface cards in sequential order. Packets are transmitted in a loop that begins with the first available network interface card in the bond and end with the last available network interface card in the bond. All subsequent loops then start with the first available network interface card. Mode 0 offers fault tolerance and balances the load across all network interface cards in the bond. However, Mode 0 cannot be used in conjunction with bridges, and is therefore not compatible with virtual machine logical networks.
Mode 1 (active-backup policy)- Sets all network interface cards to a backup state while one network interface card remains active. In the event of failure in the active network interface card, one of the backup network interface cards replaces that network interface card as the only active network interface card in the bond. The MAC address of the bond in Mode 1 is visible on only one port to prevent any confusion that might otherwise be caused if the MAC address of the bond changed to reflect that of the active network interface card. Mode 1 provides fault tolerance and is supported in Red Hat Enterprise Virtualization.
Mode 2 (XOR policy)- Selects the network interface card through which to transmit packets based on the result of an XOR operation on the source and destination MAC addresses modulo network interface card slave count. This calculation ensures that the same network interface card is selected for each destination MAC address used. Mode 2 provides fault tolerance and load balancing and is supported in Red Hat Enterprise Virtualization.
Mode 3 (broadcast policy)- Transmits all packets to all network interface cards. Mode 3 provides fault tolerance and is supported in Red Hat Enterprise Virtualization.
Mode 4 (IEEE 802.3ad policy)- Creates aggregation groups in which the interfaces share the same speed and duplex settings. Mode 4 uses all network interface cards in the active aggregation group in accordance with the IEEE 802.3ad specification and is supported in Red Hat Enterprise Virtualization.
Mode 5 (adaptive transmit load balancing policy)- Ensures the distribution of outgoing traffic accounts for the load on each network interface card in the bond and that the current network interface card receives all incoming traffic. If the network interface card assigned to receive traffic fails, another network interface card is assigned to the role of receiving incoming traffic. Mode 5 cannot be used in conjunction with bridges, therefore it is not compatible with virtual machine logical networks.
Mode 6 (adaptive load balancing policy)- Combines Mode 5 (adaptive transmit load balancing policy) with receive load balancing for IPv4 traffic without any special switch requirements. ARP negotiation is used for balancing the receive load. Mode 6 cannot be used in conjunction with bridges, therefore it is not compatible with virtual machine logical networks.
7.6.5.3. Creating a Bond Device Using the Administration Portal
Procedure 7.19. Creating a Bond Device using the Administration Portal
- Use the Hosts resource tab, tree mode, or the search function to find and select the host in the results list.
- Click the Network Interfaces tab in the details pane to list the physical network interfaces attached to the host.
- Click to open the Setup Host Networks window.
- Select and drag one of the devices over the top of another device and drop it to open the Create New Bond window. Alternatively, right-click the device and select another device from the drop-down menu.If the devices are incompatible, for example one is VLAN tagged and the other is not, the bond operation fails with a suggestion on how to correct the compatibility issue.
- Select the Bond Name and Bonding Mode from the drop-down menus.Bonding modes 1, 2, 4, and 5 can be selected. Any other mode can be configured using the Custom option.
- Click to create the bond and close the Create New Bond window.
- Assign a logical network to the newly created bond device.
- Optionally choose to Verify connectivity between Host and Engine and Save network configuration.
- Click accept the changes and close the Setup Host Networks window.
7.6.5.4. Example Uses of Custom Bonding Options with Host Interfaces
Example 7.1. xmit_hash_policy
mode=4 xmit_hash_policy=layer2+3
Example 7.2. ARP Monitoring
arp_interval on the bond device of the host by selecting a Custom bonding mode, and entering the following into the text field:
mode=1 arp_interval=1 arp_ip_target=192.168.0.2
Example 7.3. Primary
mode=1 primary=eth0
7.6.6. Saving a Host Network Configuration
Procedure 7.20. Saving a host network configuration
- Use the Hosts resource tab, tree mode, or the search function to find and select the host in the results list.
- Click the tab on the Details pane to list the NICs on the host, their address, and other specifications.
- Click the button.
- The host network configuration is saved and the following message is displayed on the task bar: "Network changes were saved on host [Hostname]."
Note
7.7. Host Resilience
- 7.7.1. Host High Availability
- 7.7.2. Power Management by Proxy in Red Hat Enterprise Virtualization
- 7.7.3. Setting Fencing Parameters on a Host
- 7.7.4. fence_kdump Advanced Configuration
- 7.7.5. Soft-Fencing Hosts
- 7.7.6. Using Host Power Management Functions
- 7.7.7. Manually Fencing or Isolating a Non Responsive Host
7.7.1. Host High Availability
7.7.2. Power Management by Proxy in Red Hat Enterprise Virtualization
- Any host in the same cluster as the host requiring fencing.
- Any host in the same data center as the host requiring fencing.
7.7.3. Setting Fencing Parameters on a Host
Procedure 7.21. Setting fencing parameters on a host
- Use the Hosts resource tab, tree mode, or the search function to find and select the host in the results list.
- Click to open the Edit Host window.
- Click the Power Management tab.
- Select the Enable Power Management check box to enable the fields.
- Select the Kdump integration check box to prevent the host from fencing while performing a kernel crash dump.
Important
When you enable Kdump integration on an existing host, the host must be reinstalled for kdump to be configured. See Section 7.5.12, “Reinstalling Virtualization Hosts”. - The Primary option is selected by default if you are configuring a new power management device. If you are adding a new device, set it to Secondary.
- Select the Concurrent check box to enable multiple fence agents to be used concurrently.
- Enter the Address, User Name, and Password of the power management device.
- Select the power management device Type from the drop-down menu.
Note
With the Red Hat Enterprise Virtualization 3.5 release, you now have the option to use a custom power management device. For more information on how to set up a custom power management device, see https://access.redhat.com/articles/1238743. - Enter the Port number used by the power management device to communicate with the host.
- Enter the specific Options of the power management device. Use a comma-separated list of 'key=value' or 'key' entries.
- Click the button to test the power management device. Test Succeeded, Host Status is: on will display upon successful verification.
Warning
Power management parameters (userid, password, options, etc) are tested by Red Hat Enterprise Virtualization Manager only during setup and manually after that. If you choose to ignore alerts about incorrect parameters, or if the parameters are changed on the power management hardware without the corresponding change in Red Hat Enterprise Virtualization Manager, fencing is likely to fail when most needed. - Click to save the changes and close the window.
7.7.4. fence_kdump Advanced Configuration
- Enabled: kdump is configured properly and the kdump service is running.
- Disabled: the kdump service is not running (in this case kdump integration will not work properly).
- Unknown: happens only for hosts with an older VDSM version that does not report kdump status.
engine-config:
engine-config -s FenceKdumpDestinationAddress=A.B.C.D
- The Manager has two NICs, where one of these is public-facing, and the second is the preferred destination for fence_kdump messages.
- You need to execute the fence_kdump listener on a different IP or port.
- You need to set a custom interval for fence_kdump notification messages, to prevent possible packet loss.
7.7.4.1. fence_kdump listener Configuration
Procedure 7.22. Manually Configuring the fence_kdump Listener
- Create a new file (for example,
my-fence-kdump.conf) in/etc/ovirt-engine/ovirt-fence-kdump-listener.conf.d/ - Enter your customization with the syntax OPTION=value and save the file.
Important
The edited values must also be changed inengine-configas outlined in the fence_kdump Listener Configuration Options table in Section 7.7.4.2, “Configuring fence_kdump on the Manager”. - Restart the fence_kdump listener:
# service ovirt-fence-kdump-listener restart
Table 7.6. fence_kdump Listener Configuration Options
| Variable | Description | Default | Note |
|---|---|---|---|
| LISTENER_ADDRESS | Defines the IP address to receive fence_kdump messages on. | 0.0.0.0 | If the value of this parameter is changed, it must match the value of FenceKdumpDestinationAddress in engine-config. |
| LISTENER_PORT | Defines the port to receive fence_kdump messages on. | 7410 | If the value of this parameter is changed, it must match the value of FenceKdumpDestinationPort in engine-config. |
| HEARTBEAT_INTERVAL | Defines the interval in seconds of the listener's heartbeat updates. | 30 | If the value of this parameter is changed, it must be half the size or smaller than the value of FenceKdumpListenerTimeout in engine-config. |
| SESSION_SYNC_INTERVAL | Defines the interval in seconds to synchronize the listener's host kdumping sessions in memory to the database. | 5 | If the value of this parameter is changed, it must be half the size or smaller than the value of KdumpStartedTimeout in engine-config. |
| REOPEN_DB_CONNECTION_INTERVAL | Defines the interval in seconds to reopen the database connection which was previously unavailable. | 30 | - |
| KDUMP_FINISHED_TIMEOUT | Defines the maximum timeout in seconds after the last received message from kdumping hosts after which the host kdump flow is marked as FINISHED. | 60 | If the value of this parameter is changed, it must be double the size or higher than the value of FenceKdumpMessageInterval in engine-config. |
7.7.4.2. Configuring fence_kdump on the Manager
# engine-config -g OPTION
Procedure 7.23. Manually Configuring Kdump with engine-config
- Edit kdump's configuration using the
engine-configcommand:# engine-config -s OPTION=value
Important
The edited values must also be changed in the fence_kdump listener configuration file as outlined in theKdump Configuration Optionstable. See Section 7.7.4.1, “fence_kdump listener Configuration”. - Restart the
ovirt-engineservice:# service ovirt-engine restart
- Reinstall all hosts with Kdump integration enabled, if required (see the table below).
engine-config:
Table 7.7. Kdump Configuration Options
| Variable | Description | Default | Note |
|---|---|---|---|
| FenceKdumpDestinationAddress | Defines the hostname(s) or IP address(es) to send fence_kdump messages to. If empty, the Manager's FQDN is used. | Empty string (Manager FQDN is used) | If the value of this parameter is changed, it must match the value of LISTENER_ADDRESS in the fence_kdump listener configuration file, and all hosts with Kdump integration enabled must be reinstalled. |
| FenceKdumpDestinationPort | Defines the port to send fence_kdump messages to. | 7410 | If the value of this parameter is changed, it must match the value of LISTENER_PORT in the fence_kdump listener configuration file, and all hosts with Kdump integration enabled must be reinstalled. |
| FenceKdumpMessageInterval | Defines the interval in seconds between messages sent by fence_kdump. | 5 | If the value of this parameter is changed, it must be half the size or smaller than the value of KDUMP_FINISHED_TIMEOUT in the fence_kdump listener configuration file, and all hosts with Kdump integration enabled must be reinstalled. |
| FenceKdumpListenerTimeout | Defines the maximum timeout in seconds since the last heartbeat to consider the fence_kdump listener alive. | 90 | If the value of this parameter is changed, it must be double the size or higher than the value of HEARTBEAT_INTERVAL in the fence_kdump listener configuration file. |
| KdumpStartedTimeout | Defines the maximum timeout in seconds to wait until the first message from the kdumping host is received (to detect that host kdump flow has started). | 30 | If the value of this parameter is changed, it must be double the size or higher than the value of SESSION_SYNC_INTERVAL in the fence_kdump listener configuration file, and FenceKdumpMessageInterval. |
7.7.5. Soft-Fencing Hosts
- On the first network failure, the status of the host changes to "connecting".
- The Manager then makes three attempts to ask VDSM for its status, or it waits for an interval determined by the load on the host. The formula for determining the length of the interval is configured by the configuration values TimeoutToResetVdsInSeconds (the default is 60 seconds) + [DelayResetPerVmInSeconds (the default is 0.5 seconds)]*(the count of running VMs on host) + [DelayResetForSpmInSeconds (the default is 20 seconds)] * 1 (if host runs as SPM) or 0 (if the host does not run as SPM). To give VDSM the maximum amount of time to respond, the Manager chooses the longer of the two options mentioned above (three attempts to retrieve the status of VDSM or the interval determined by the above formula).
- If the host does not respond when that interval has elapsed,
vdsm restartis executed via SSH. - If
vdsm restartdoes not succeed in re-establishing the connection between the host and the Manager, the status of the host changes toNon Responsiveand, if power management is configured, fencing is handed off to the external fencing agent.
Note
7.7.6. Using Host Power Management Functions
Procedure 7.24. Using Host Power Management Functions
- Use the Hosts resource tab, tree mode, or the search function to find and select the host in the results list.
- Click the Power Management drop-down menu.
- Select one of the following options:
- Restart: This option stops the host and waits until the host's status changes to
Down. When the agent has verified that the host is down, the highly available virtual machines are restarted on another host in the cluster. The agent then restarts this host. When the host is ready for use its status displays asUp. - Start: This option starts the host and lets it join a cluster. When it is ready for use its status displays as
Up. - Stop: This option powers off the host. Before using this option, ensure that the virtual machines running on the host have been migrated to other hosts in the cluster. Otherwise the virtual machines will crash and only the highly available virtual machines will be restarted on another host. When the host has been stopped its status displays as
Non-Operational.
Important
When two fencing agents are defined on a host, they can be used concurrently or sequentially. For concurrent agents, both agents have to respond to the Stop command for the host to be stopped; and when one agent responds to the Start command, the host will go up. For sequential agents, to start or stop a host, the primary agent is used first; if it fails, the secondary agent is used. - Selecting one of the above options opens a confirmation window. Click OK to confirm and proceed.
7.7.7. Manually Fencing or Isolating a Non Responsive Host
Warning
Procedure 7.25. Manually fencing or isolating a non-responsive host
- On the Hosts tab, select the host. The status must display as
non-responsive. - Manually reboot the host. This could mean physically entering the lab and rebooting the host.
- On the Administration Portal, right-click the host entry and select the button.
- A message displays prompting you to ensure that the host has been shut down or rebooted. Select the Approve Operation check box and click OK.
7.8. Hosts and Permissions
7.8.1. Managing System Permissions for a Host
- Edit the configuration of the host.
- Set up the logical networks.
- Remove the host.
7.8.2. Host Administrator Roles Explained
Table 7.8. Red Hat Enterprise Virtualization System Administrator Roles
| Role | Privileges | Notes |
|---|---|---|
| HostAdmin | Host Administrator | Can configure, manage, and remove a specific host. Can also perform network-related operations on a specific host. |
7.8.3. Assigning an Administrator or User Role to a Resource
Procedure 7.26. Assigning a Role to a Resource
- Use the resource tabs, tree mode, or the search function to find and select the resource in the results list.
- Click the tab of the details pane to list the assigned users, the user's role, and the inherited permissions for the selected resource.
- Click to open the Add Permission to User window.
- Enter the name or user name of an existing user into the Search text box and click . Select a user from the resulting list of possible matches.
- Select a role from the Role to Assign: drop-down menu.
- Click to assign the role and close the window.
7.8.4. Removing an Administrator or User Role from a Resource
Procedure 7.27. Removing a Role from a Resource
- Use the resource tabs, tree mode, or the search function to find and select the resource in the results list.
- Click the tab of the details pane to list the assigned users, the user's role, and the inherited permissions for the selected resource.
- Select the user to remove from the resource.
- Click . The Remove Permission window opens to confirm permissions removal.
- Click to remove the user role.
Chapter 8. Storage
- 8.1. Understanding Storage Domains
- 8.2. Storage Metadata Versions in Red Hat Enterprise Virtualization
- 8.3. Preparing and Adding NFS Storage
- 8.4. Preparing and Adding Local Storage
- 8.5. Preparing and Adding POSIX Compliant File System Storage
- 8.6. Preparing and Adding Block Storage
- 8.7. Importing Existing Storage Domains
- 8.8. Storage Tasks
- 8.9. Storage and Permissions
- Network File System (NFS)
- GlusterFS exports
- Other POSIX compliant file systems
- Internet Small Computer System Interface (iSCSI)
- Local storage attached directly to the virtualization hosts
- Fibre Channel Protocol (FCP)
- Parallel NFS (pNFS)
- Data Domain: A data domain holds the virtual hard disks and OVF files of all the virtual machines and templates in a data center. In addition, snapshots of the virtual machines are also stored in the data domain.The data domain cannot be shared across data centers. Data domains of multiple types (iSCSI, NFS, FC, POSIX, and Gluster) can be added to the same data center, provided they are all shared, rather than local, domains.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 domains can only be NFS-based. Only one ISO domain can be added to a data center.
- 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. Export domains can only be NFS-based. Only one export domain can be added to a data center.
Important
8.1. Understanding Storage Domains
8.2. Storage Metadata Versions in Red Hat Enterprise Virtualization
- V1 metadata (Red Hat Enterprise Virtualization 2.x series)Each storage domain contains metadata describing its own structure, and all of the names of physical volumes that are used to back virtual machine disk images.Master domains additionally contain metadata for all the domains and physical volume names in the storage pool. The total size of this metadata is limited to 2 KB, limiting the number of storage domains that can be in a pool.Template and virtual machine base images are read only.V1 metadata is applicable to NFS, iSCSI, and FC storage domains.
- V2 metadata (Red Hat Enterprise Virtualization 3.0)All storage domain and pool metadata is stored as logical volume tags rather than written to a logical volume. Metadata about virtual machine disk volumes is still stored in a logical volume on the domains.Physical volume names are no longer included in the metadata.Template and virtual machine base images are read only.V2 metadata is applicable to iSCSI, and FC storage domains.
- V3 metadata (Red Hat Enterprise Virtualization 3.1+)All storage domain and pool metadata is stored as logical volume tags rather than written to a logical volume. Metadata about virtual machine disk volumes is still stored in a logical volume on the domains.Virtual machine and template base images are no longer read only. This change enables live snapshots, live storage migration, and clone from snapshot.Support for unicode metadata is added, for non-English volume names.V3 metadata is applicable to NFS, GlusterFS, POSIX, iSCSI, and FC storage domains.
8.3. Preparing and Adding NFS Storage
8.3.1. Preparing NFS Storage
- Install nfs-utils, the package that provides NFS tools:
# yum install nfs-utils
- Configure the boot scripts to make shares available every time the system boots:
# chkconfig --add rpcbind # chkconfig --add nfs # chkconfig rpcbind on # chkconfig nfs on
- Start the rpcbind service and the nfs service:
# service rpcbind start # service nfs start
- Create the data directory and the export directory:
# mkdir -p /exports/data # mkdir -p /exports/export
- Add the newly created directories to the
/etc/exportsfile. Add the following to/etc/exports:/exports/data *(rw) /exports/export *(rw)
- Export the storage domains:
# exportfs -r
- Reload the NFS service:
# service nfs reload
- Create the group
kvm:# groupadd kvm -g 36
- Create the user
vdsmin the groupkvm:# useradd vdsm -u 36 -g 36
- Set the ownership of your exported directories to 36:36, which gives vdsm:kvm ownership. This makes it possible for the Manager to store data in the storage domains represented by these exported directories:
# chown -R 36:36 /exports/data # chown -R 36:36 /exports/export
- Change the mode of the directories so that read and write access is granted to the owner, and so that read and execute access is granted to the group and other users:
# chmod 0755 /exports/data # chmod 0755 /exports/export
8.3.2. Attaching NFS Storage
- In the Red Hat Enterprise Virtualization Manager Administration Portal, click the resource tab.
- Click .
- Enter a Name for the storage domain.
- Accept the default values for the Data Center, Domain Function / Storage Type, Format, and Use Host lists.
- Enter the Export Path to be used for the storage domain.The export path should be in the format of 192.168.0.10:/data or domain.example.com:/data.
- Click OK.The new NFS data domain is displayed in the Storage tab with a status of
Lockeduntil the disk is prepared. The data domain is then automatically attached to the data center.
8.3.3. Increasing NFS Storage
Procedure 8.1. Increasing an Existing NFS Storage Domain
- Click the Storage resource tab and select an NFS storage domain.
- In the details pane, click the Data Center tab and click the button to place the storage domain into maintenance mode. This unmounts the existing share and makes it possible to resize the storage domain.
- On the NFS server, resize the storage. For Red Hat Enterprise Linux 6 systems, see Red Hat Enterprise Linux 6 Storage Administration Guide. For Red Hat Enterprise Linux 7 systems, see Red Hat Enterprise Linux 7 Storage Administration Guide.
- In the details pane, click the Data Center tab and click the button to mount the storage domain.
8.4. Preparing and Adding Local Storage
8.4.1. Preparing Local Storage
Important
/data/images. This directory already exists with the correct permissions on Hypervisor installations. The steps in this procedure are only required when preparing local storage on Red Hat Enterprise Linux virtualization hosts.
Procedure 8.2. Preparing Local Storage
- On the virtualization host, create the directory to be used for the local storage.
# mkdir -p /data/images
- Ensure that the directory has permissions allowing read/write access to the
vdsmuser (UID 36) andkvmgroup (GID 36).# chown 36:36 /data /data/images
# chmod 0755 /data /data/images
8.4.2. Adding Local Storage
Procedure 8.3. Adding Local Storage
- Use the Hosts resource tab, tree mode, or the search function to find and select the host in the results list.
- Click to open the Maintenance Host(s) confirmation window.
- Click to initiate maintenance mode.
- Click to open the Configure Local Storage window.
- Click the buttons next to the Data Center, Cluster, and Storage fields to configure and name the local storage domain.
- Set the path to your local storage in the text entry field.
- If applicable, select the Optimization tab to configure the memory optimization policy for the new local storage cluster.
- Click to save the settings and close the window.
8.5. Preparing and Adding POSIX Compliant File System Storage
Important
8.5.1. Attaching POSIX Compliant File System Storage
Procedure 8.4. Attaching POSIX Compliant File System Storage
- Click the Storage resource tab to list the existing storage domains in the results list.
- Click to open the New Domain window.
- Enter the Name for the storage domain.
- Select the Data Center to be associated with the storage domain. The Data Center selected must be of type POSIX (POSIX compliant FS). Alternatively, select
(none). - Select
Data / POSIX compliant FSfrom the Domain Function / Storage Type drop-down menu.If applicable, select the Format from the drop-down menu. - Select a host from the Use Host drop-down menu. Only hosts within the selected data center will be listed. The host that you select will be used to connect the storage domain.
- Enter the Path to the POSIX file system, as you would normally provide it to the
mountcommand. - Enter the VFS Type, as you would normally provide it to the
mountcommand using the-targument. Seeman mountfor a list of valid VFS types. - Enter additional Mount Options, as you would normally provide them to the
mountcommand using the-oargument. The mount options should be provided in a comma-separated list. Seeman mountfor a list of valid mount options. - Click to attach the new Storage Domain and close the window.
8.6. Preparing and Adding Block Storage
8.6.1. Preparing iSCSI Storage
Procedure 8.5. Preparing iSCSI Storage
- Install the scsi-target-utils package using the
yumcommand as root on your storage server.# yum install -y scsi-target-utils
- Add the devices or files you want to export to the
/etc/tgt/targets.conffile. Here is a generic example of a basic addition to thetargets.conffile:<target iqn.YEAR-MONTH.com.EXAMPLE:SERVER.targetX> backing-store /PATH/TO/DEVICE1 # Becomes LUN 1 backing-store /PATH/TO/DEVICE2 # Becomes LUN 2 backing-store /PATH/TO/DEVICE3 # Becomes LUN 3 </target>Targets are conventionally defined using the year and month they are created, the reversed fully qualified domain that the server is in, the server name, and a target number. - Start the tgtd service.
# service tgtd start
- Make the tgtd start persistently across reboots.
# chkconfig tgtd on
- Open an iptables firewall port to allow clients to access your iSCSI export. By default, iSCSI uses port 3260. This example inserts a firewall rule at position 6 in the INPUT table.
# iptables -I INPUT 6 -p tcp --dport 3260 -j ACCEPT
- Save the iptables rule you just created.
# service iptables save
8.6.2. Adding iSCSI Storage
Procedure 8.6. Adding iSCSI Storage
- Click the Storage resource tab to list the existing storage domains in the results list.
- Click the button to open the New Domain window.
- Enter the Name of the new storage domain.
- Use the Data Center drop-down menu to select an data center.If you do not yet have an appropriate iSCSI data center, select
(none). - Use the drop-down menus to select the Domain Function / Storage Type and the Format. The storage domain types that are not compatible with the chosen domain function are not available.
- Select an active host in the Use Host field. If this is not the first data domain in a data center, you must select the data center's SPM host.
Important
All communication to the storage domain is through 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. All hosts must have access to the storage device before the storage domain can be configured. - The Red Hat Enterprise Virtualization Manager is able to map either iSCSI targets to LUNs, or LUNs to iSCSI targets. The New Domain window automatically displays known targets with unused LUNs when iSCSI is selected as the storage type. If the target that you are adding storage from is not listed then you can use target discovery to find it, otherwise proceed to the next step.
iSCSI Target Discovery
- Click Discover Targets to enable target discovery options. When targets have been discovered and logged in to, the New Domain window automatically displays targets with LUNs unused by the environment.
Note
LUNs used externally to the environment are also displayed.You can use the Discover Targets options to add LUNs on many targets, or multiple paths to the same LUNs. - Enter the fully qualified domain name or IP address of the iSCSI host in the Address field.
- Enter the port to connect to the host on when browsing for targets in the Port field. The default is
3260. - If the Challenge Handshake Authentication Protocol (CHAP) is being used to secure the storage, select the User Authentication check box. Enter the CHAP user name and CHAP password.
- Click the button.
- Select the target to use from the discovery results and click the button.Alternatively, click the to log in to all of the discovered targets.
Important
If more than one path access is required, ensure to discover and log in to the target through all the required paths. Modifying a storage domain to add additional paths is currently not supported.
- Click the + button next to the desired target. This will expand the entry and display all unused LUNs attached to the target.
- Select the check box for each LUN that you are using to create the storage domain.
- Click to create the storage domain and close the window.
8.6.3. Configuring iSCSI Multipathing
Prerequisites
- Ensure you have created an iSCSI storage domain and discovered and logged into all the paths to the iSCSI target(s).
- Ensure you have created Non-Required logical networks to bond with the iSCSI storage connections. You can configure multiple logical networks or bond networks to allow network failover.
Procedure 8.7. Configuring iSCSI Multipathing
- Click the Data Centers tab and select a data center from the results list.
- In the details pane, click the iSCSI Multipathing tab.
- Click .
- In the Add iSCSI Bond window, enter a Name and a Description for the bond.
- Select the networks to be used for the bond from the Logical Networks list. The networks must be Non-Required networks.
- Select the storage domain to be accessed via the chosen networks from the Storage Targets list. Ensure to select all paths to the same target.
- Click .
8.6.4. Adding FCP Storage
Note
Procedure 8.8. Adding FCP Storage
- Click the resource tab to list all storage domains in the virtualized environment.
- Click to open the New Domain window.
- Enter the Name of the storage domain.
- Use the Data Center drop-down menu to select an FCP data center.If you do not yet have an appropriate FCP data center, select
(none). - Use the drop-down menus to select the Domain Function / Storage Type and the Format. The storage domain types that are not compatible with the chosen data center are not available.
- Select an active host in the Use Host field. If this is not the first data domain in a data center, you must select the data center's SPM host.
Important
All communication to the storage domain is through 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. All hosts must have access to the storage device before the storage domain can be configured. - The New Domain window automatically displays known targets with unused LUNs when Data / Fibre Channel is selected as the storage type. Select the LUN ID check box to select all of the available LUNs.
- Click to create the storage domain and close the window.
Locked status while it is being prepared for use. When ready, it is automatically attached to the data center.
8.6.5. Increasing iSCSI or FCP Storage
Note
Procedure 8.9. Increasing an Existing iSCSI or FCP Storage Domain
- Create a new LUN on the SAN. For Red Hat Enterprise Linux 6 systems, see Red Hat Enterprise Linux 6 Storage Administration Guide. For Red Hat Enterprise Linux 7 systems, see Red Hat Enterprise Linux 7 Storage Administration Guide.
- Click the resource tab and select an iSCSI or FCP domain. Click the button.
- Click on Targets > LUNs, and click the expansion button.
- Enter the connection information for the storage server and click the button to initiate the connection.
- Click on LUNs > Targets and select the check box of the newly available LUN.
- Click to add the LUN to the selected storage domain.
8.6.6. Unusable LUNs in Red Hat Enterprise Virtualization
- LUNs that are already part of the current Red Hat Enterprise Virtualization environment are automatically prevented from being used.
- LUNs that are already being used by the SPM host will also display as in use. You can choose to forcefully over ride the contents of these LUNs, but the operation is not guaranteed to succeed.
8.7. Importing Existing Storage Domains
8.7.1. Overview of Importing Existing Storage Domains
- Data
- Importing an existing data storage domain allows you to access all of the virtual machines and templates that the data storage domain contains. After you import the storage domain, you must manually import each virtual machine and template into the destination data center. The process for importing the virtual machines and templates that a data storage domain contains is similar to that for an export storage domain. However, because data storage domains contain all the virtual machines and templates in a given data center, importing data storage domains is recommended for data recovery or large-scale migration of virtual machines between data centers or environments.
Important
You can only import existing data storage domains that were attached to data centers with a compatibility level of 3.5 or higher. - ISO
- Importing an existing ISO storage domain allows you to access all of the ISO files and virtual diskettes that the ISO storage domain contains. No additional action is required after importing the storage domain to access these resources; you can attach them to virtual machines as required.
- Export
- Importing an existing export storage domain allows you to access all of the virtual machine images and templates that the export storage domain contains. Because export domains are designed for exporting and importing virtual machine images and templates, importing export storage domains is recommended method of migrating small numbers of virtual machines and templates inside an environment or between environments. For information on exporting and importing virtual machines and templates to and from export storage domains, see Section 10.14, “Exporting and Importing Virtual Machines and Templates”.
8.7.2. Importing a Storage Domain
Procedure 8.10. Importing a Storage Domain
- Click the Storage resource tab.
- Click .
- Select the data center to which to attach the storage domain from the Data Center list.
- Optionally, select the Activate Domain in Data Center check box to activate the storage domain after attaching it to the selected data center.
- Select the function and type of the domain from the Domain Function / Storage Type list.
- Select the SPM host from the Use host list.
Important
All communication to the storage domain is through 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. All hosts must have access to the storage device before the storage domain can be configured. - Enter the details of the storage domain.
Note
The fields for specifying the details of the storage domain change in accordance with the value you select in the Domain Function / Storage Type list. These options are the same as those available for adding a new storage domain. For more information on these options, see Section 8.1, “Understanding Storage Domains”. - Click .
8.7.3. Importing Virtual Machines from an Imported Data Storage Domain
Procedure 8.11. Importing Virtual Machines from an Imported Data Storage Domain
- Click the Storage resource tab.
- Click the imported data storage domain.
- Click the VM Import tab in the details pane.
- Select one or more virtual machines to import.
- Click .
- Select the cluster into which the virtual machines are imported from the Cluster list.
- Click .
8.7.4. Importing Templates from Imported Data Storage Domains
Procedure 8.12. Importing Templates from an Imported Data Storage Domain
- Click the Storage resource tab.
- Click the imported data storage domain.
- Click the Template Import tab in the details pane.
- Select one or more templates to import.
- Click .
- Select the cluster into which the templates are imported from the Cluster list.
- Click .
8.8. Storage Tasks
- 8.8.1. Populating the ISO Storage Domain
- 8.8.2. Moving Storage Domains to Maintenance Mode
- 8.8.3. Editing Storage Domains
- 8.8.4. Activating Storage Domains
- 8.8.5. Removing a Storage Domain
- 8.8.6. Destroying a Storage Domain
- 8.8.7. Detaching the Export Domain
- 8.8.8. Attaching an Export Domain to a Data Center
- 8.8.9. Disk Profiles
8.8.1. Populating the ISO Storage Domain
Procedure 8.13. Populating the ISO Storage Domain
- Copy the required ISO image to a temporary directory on the system running Red Hat Enterprise Virtualization Manager.
- Log in to the system running Red Hat Enterprise Virtualization Manager as the
rootuser. - Use the
engine-iso-uploadercommand to upload the ISO image. This action will take some time. The amount of time varies depending on the size of the image being uploaded and available network bandwidth.Example 8.1. ISO Uploader Usage
In this example the ISO imageRHEL6.isois uploaded to the ISO domain calledISODomainusing NFS. The command will prompt for an administrative user name and password. The user name must be provided in the form user name@domain.#
engine-iso-uploader--iso-domain=ISODomainuploadRHEL6.iso
8.8.2. Moving Storage Domains to Maintenance Mode
Procedure 8.14. Moving storage domains to maintenance mode
- Shut down all the virtual machines running on the storage domain.
- Click the Storage resource tab and select a storage domain.
- Click the Data Centers tab in the details pane.
- Click to open the Maintenance Storage Domain(s) confirmation window.
- Click to initiate maintenance mode. The storage domain is deactivated and has an
Inactivestatus in the results list.
Note
8.8.3. Editing Storage Domains
- Active: When the storage domain is in an active state, the Name, Description, and Comment fields can be edited. This is supported for all storage types.
- Inactive: When the storage domain is in maintenance mode or unattached, thus in an inactive state, you can edit storage connections, mount options, and other advanced parameters. This is only supported for NFS, POSIX, and Local storage types.
Note
iSCSI storage connections cannot be edited via the Administration Portal, but can be edited via the REST API. See Updating an iSCSI Storage Connection.
Procedure 8.15. Editing an Active Storage Domain
- Click the Storage resource tab and select a storage domain in the results list.
- Click .
- Edit the Name, Description, and Comment fields as required.
- Click .
Procedure 8.16. Editing an Inactive Storage Domain
- Click the Storage resource tab and select a storage domain in the results list. if the storage domain is active, put it into maintenance mode.
- Click .
- Edit the storage path and other details as required. The new connection details must be of the same storage type as the original connection.
- Click .
- Click the Data Center tab in the details pane and click Activate.
8.8.4. Activating Storage Domains
- Click the Storage resource tab and select an inactive storage domain in the results list.
- Click the Data Centers tab in the details pane.
- Select the appropriate storage domain and click .
Important
If you attempt to activate the ISO domain before activating the data domain, an error message displays and the domain is not activated.
8.8.5. Removing a Storage Domain
Procedure 8.17. Removing a Storage Domain
- Use the Storage resource tab, tree mode, or the search function to find and select the appropriate storage domain in the results list.
- Move the domain into maintenance mode to deactivate it.
- Detach the domain from the data center.
- Click to open the Remove Storage confirmation window.
- Select a host from the list.
- Click to remove the storage domain and close the window.
8.8.6. Destroying a Storage Domain
Procedure 8.18. Destroying a Storage Domain
- Use the Storage resource tab, tree mode, or the search function to find and select the appropriate storage domain in the results list.
- Right-click the storage domain and select to open the Destroy Storage Domain confirmation window.
- Select the Approve operation check box and click to destroy the storage domain and close the window.
8.8.7. Detaching the Export Domain
Procedure 8.19. Detaching an Export Domain from the Data Center
- Use the Storage resource tab, tree mode, or the search function to find and select the export domain in the results list.
- Click the Data Centers tab in the details pane and select the export domain.
- Click to open the Maintenance Storage Domain(s) confirmation window.
- Click to initiate maintenance mode.
- Click to open the Detach Storage confirmation window.
- Click to detach the export domain.
8.8.8. Attaching an Export Domain to a Data Center
Procedure 8.20. Attaching an Export Domain to a Data Center
- Use the Storage resource tab, tree mode, or the search function to find and select the export domain in the results list.
- Click the Data Centers tab in the details pane.
- Click to open the Attach to Data Center window.
- Select the radio button of the appropriate data center.
- Click to attach the export domain.
8.8.9. Disk Profiles
8.8.9.1. Creating a Disk Profile
Procedure 8.21. Creating a Disk Profile
- Click the Storage resource tab and select a data storage domain.
- Click the Disk Profiles sub tab in the details pane.
- Click .
- Enter a name for the disk profile in the Name field.
- Enter a description for the disk profile in the Description field.
- Select the quality of service to apply to the disk profile from the QoS list.
- Click .
8.8.9.2. Removing a Disk Profile
Procedure 8.22. Removing a Disk Profile
- Click the Storage resource tab and select a data storage domain.
- Click the Disk Profiles sub tab in the details pane.
- Select the disk profile to remove.
- Click .
- Click .
8.9. Storage and Permissions
8.9.1. Managing System Permissions for a Storage Domain
- Edit the configuration of the storage domain.
- Move the storage domain into maintenance mode.
- Remove the storage domain.
Note
8.9.2. Storage Administrator Roles Explained
Table 8.1. Red Hat Enterprise Virtualization System Administrator Roles
| Role | Privileges | Notes |
|---|---|---|
| StorageAdmin | Storage Administrator | Can create, delete, configure and manage a specific storage domain. |
| GlusterAdmin | Gluster Storage Administrator | Can create, delete, configure and manage Gluster storage volumes. |
8.9.3. Assigning an Administrator or User Role to a Resource
Procedure 8.23. Assigning a Role to a Resource
- Use the resource tabs, tree mode, or the search function to find and select the resource in the results list.
- Click the tab of the details pane to list the assigned users, the user's role, and the inherited permissions for the selected resource.
- Click to open the Add Permission to User window.
- Enter the name or user name of an existing user into the Search text box and click . Select a user from the resulting list of possible matches.
- Select a role from the Role to Assign: drop-down menu.
- Click to assign the role and close the window.
8.9.4. Removing an Administrator or User Role from a Resource
Procedure 8.24. Removing a Role from a Resource
- Use the resource tabs, tree mode, or the search function to find and select the resource in the results list.
- Click the tab of the details pane to list the assigned users, the user's role, and the inherited permissions for the selected resource.
- Select the user to remove from the resource.
- Click . The Remove Permission window opens to confirm permissions removal.
- Click to remove the user role.
Chapter 9. Working with Red Hat Gluster Storage
9.1. Red Hat Gluster Storage Nodes
9.1.1. Adding Red Hat Gluster Storage Nodes
Procedure 9.1. Adding a Red Hat Gluster Storage Node
- Click the Hosts resource tab to list the hosts in the results list.
- Click to open the New Host window.
- Use the drop-down menus to select the Data Center and Host Cluster for the Red Hat Gluster Storage node.
- Enter the Name, Address, and SSH Port of the Red Hat Gluster Storage node.
- Select an authentication method to use with the Red Hat Gluster Storage node.
- Enter the root user's password to use password authentication.
- Copy the key displayed in the SSH PublicKey field to
/root/.ssh/authorized_keyson the Red Hat Gluster Storage node to use public key authentication.
- Click to add the node and close the window.
9.1.2. Removing a Red Hat Gluster Storage Node
Procedure 9.2. Removing a Red Hat Gluster Storage Node
- Use the Hosts resource tab, tree mode, or the search function to find and select the Red Hat Gluster Storage node in the results list.
- Click to open the Maintenance Host(s) confirmation window.
- Click to move the host to maintenance mode.
- Click to open the Remove Host(s) confirmation window.
- Select the Force Remove check box if the node has volume bricks on it, or if the node is non-responsive.
- Click to remove the node and close the window.
9.2. Using Red Hat Gluster Storage as a Storage Domain
- 9.2.1. Introduction to Red Hat Gluster Storage (GlusterFS) Volumes
- 9.2.2. Gluster Storage Terminology
- 9.2.3. Creating a Storage Volume
- 9.2.4. Adding Bricks to a Volume
- 9.2.5. Explanation of Settings in the Add Bricks Window
- 9.2.6. Optimizing Red Hat Gluster Storage Volumes to Store Virtual Machine Images
- 9.2.7. Starting Volumes
- 9.2.8. Tuning Volumes
- 9.2.9. Editing Volume Options
- 9.2.10. Reset Volume Options
- 9.2.11. Removing Bricks from a Volume
- 9.2.12. Stopping Red Hat Gluster Storage Volumes
- 9.2.13. Deleting Red Hat Gluster Storage Volumes
- 9.2.14. Rebalancing Volumes
9.2.1. Introduction to Red Hat Gluster Storage (GlusterFS) Volumes
9.2.2. Gluster Storage Terminology
Table 9.1. Data Center Properties
|
Term
|
Definition
|
|---|---|
|
Brick
|
A brick is the GlusterFS basic unit of storage, represented by an export directory on a server in the trusted storage pool. A Brick is expressed by combining a server with an export directory in the following format:
SERVER:EXPORT
For example:
myhostname:/exports/myexportdir/
|
|
Block Storage
|
Block special files or block devices correspond to devices through which the system moves data in the form of blocks. These device nodes often represent addressable devices such as hard disks, CD-ROM drives, or memory-regions. Red Hat Gluster Storage supports XFS file system with extended attributes.
|
|
Cluster
|
A trusted pool of linked computers, working together closely thus in many respects forming a single computer. In Red Hat Gluster Storage terminology a cluster is called a trusted storage pool.
|
|
Client
|
The machine that mounts the volume (this may also be a server).
|
|
Distributed File System
|
A file system that allows multiple clients to concurrently access data spread across multiple servers/bricks in a trusted storage pool. Data sharing among multiple locations is fundamental to all distributed file systems.
|
|
Geo-Replication
|
Geo-replication provides a continuous, asynchronous, and incremental replication service from site to another over Local Area Networks (LAN), Wide Area Network (WAN), and across the Internet.
|
|
glusterd
|
The Gluster management daemon that needs to run on all servers in the trusted storage pool.
|
|
Metadata
|
Metadata is data providing information about one or more other pieces of data.
|
|
N-way Replication
|
Local synchronous data replication typically deployed across campus or Amazon Web Services Availability Zones.
|
|
Namespace
|
Namespace is an abstract container or environment created to hold a logical grouping of unique identifiers or symbols. Each Red Hat Gluster Storage trusted storage pool exposes a single namespace as a POSIX mount point that contains every file in the trusted storage pool.
|
|
POSIX
|
Portable Operating System Interface (for Unix) is the name of a family of related standards specified by the IEEE to define the application programming interface (API), along with shell and utilities interfaces for software compatible with variants of the UNIX operating system. Red Hat Gluster Storage exports a fully POSIX compatible file system.
|
|
RAID
|
Redundant Array of Inexpensive Disks (RAID) is a technology that provides increased storage reliability through redundancy, combining multiple low-cost, less-reliable disk drives components into a logical unit where all drives in the array are interdependent.
|
|
RRDNS
|
Round Robin Domain Name Service (RRDNS) is a method to distribute load across application servers. RRDNS is implemented by creating multiple A records with the same name and different IP addresses in the zone file of a DNS server.
|
|
Server
|
The machine (virtual or bare-metal) which hosts the actual file system in which data will be stored.
|
|
Scale-Up Storage
|
Increases the capacity of the storage device, but only in a single dimension. An example might be adding additional disk capacity to a single computer in a trusted storage pool.
|
|
Scale-Out Storage
|
Increases the capability of a storage device in multiple dimensions. For example adding a server to a trusted storage pool increases CPU, disk capacity, and throughput for the trusted storage pool.
|
|
Subvolume
|
A subvolume is a brick after being processed by at least one translator.
|
|
Translator
|
A translator connects to one or more subvolumes, does something with them, and offers a subvolume connection.
|
|
Trusted Storage Pool
|
A storage pool is a trusted network of storage servers. When you start the first server, the storage pool consists of that server alone.
|
|
User Space
|
Applications running in user space do not directly interact with hardware, instead using the kernel to moderate access. User Space applications are generally more portable than applications in kernel space. Gluster is a user space application.
|
|
Virtual File System (VFS)
|
VFS is a kernel software layer that handles all system calls related to the standard Linux file system. It provides a common interface to several kinds of file systems.
|
|
Volume File
|
The volume file is a configuration file used by GlusterFS process. The volume file will usually be located at:
/var/lib/glusterd/vols/VOLNAME.
|
|
Volume
|
A volume is a logical collection of bricks. Most of the Gluster management operations happen on the volume.
|
9.2.3. Creating a Storage Volume
Important
Procedure 9.3. Creating A Storage Volume
- Click the Volumes resource tab to list existing volumes in the results list.
- Click to open the New Volume window.
- Use the drop-down menus to select the Data Center and Volume Cluster.
- Enter the Name of the volume.
- Use the drop-down menu to select the Type of the volume.
- If active, select the appropriate Transport Type check box.
- Click the button to select bricks to add to the volume. Bricks must be created externally on the Red Hat Gluster Storage nodes.
- If active, use the Gluster, NFS, and CIFS check boxes to select the appropriate access protocols used for the volume.
- Enter the volume access control as a comma-separated list of IP addresses or hostnames in the Allow Access From field.You can use the * wildcard to specify ranges of IP addresses or hostnames.
- Select the Optimize for Virt Store option to set the parameters to optimize your volume for virtual machine storage. Select this if you intend to use this volume as a storage domain.
- Click to create the volume. The new volume is added and displays on the Volume tab.
9.2.4. Adding Bricks to a Volume
Procedure 9.4. Adding Bricks to a Volume
- On the Volumes tab on the navigation pane, select the volume to which you want to add bricks.
- Click the tab from the Details pane.
- Click to open the Add Bricks window.
- Use the Server drop-down menu to select the server on which the brick resides.
- Enter the path of the Brick Directory. The directory must already exist.
- Click . The brick appears in the list of bricks in the volume, with server addresses and brick directory names.
- Click .
9.2.5. Explanation of Settings in the Add Bricks Window
Table 9.2. Add Bricks Tab Properties
|
Field Name
|
Description
|
|---|---|
|
Volume Type
|
Displays the type of volume. This field cannot be changed; it was set when you created the volume.
|
|
Server
|
The server where the bricks are hosted.
|
| Brick Directory |
The brick directory or mountpoint.
|
9.2.6. Optimizing Red Hat Gluster Storage Volumes to Store Virtual Machine Images
Important
Important
virt. This sets the cluster.quorum-type parameter to auto, and the cluster.server-quorum-type parameter to server.
# gluster volume set VOLUME_NAME group virt
# gluster volume info VOLUME_NAME
9.2.7. Starting Volumes
Procedure 9.5. Starting Volumes
- In the Volumes tab, select the volume to be started.You can select multiple volumes to start by using
ShiftorCtrlkey. - Click the button.
Up.
9.2.8. Tuning Volumes
Procedure 9.6. Tuning Volumes
- Click the Volumes tab.A list of volumes displays.
- Select the volume that you want to tune, and click the tab from the Details pane.The Volume Options tab displays a list of options set for the volume.
- Click to set an option. The Add Option dialog box displays. Select the Option Key from the drop down list and enter the option value.
- Click .The option is set and displays in the Volume Options tab.
9.2.9. Editing Volume Options
Procedure 9.7. Editing Volume Options
- Click the Volumes tab.A list of volumes displays.
- Select the volume that you want to edit, and click the Volume Options tab from the Details pane.The Volume Options tab displays a list of options set for the volume.
- Select the option you want to edit. Click . The Edit Option dialog box displays. Enter a new value for the option.
- Click .The edited option displays in the Volume Options tab.
9.2.10. Reset Volume Options
- Click the Volumes tab.A list of volumes displays.
- Select the volume and click the tab from the Details pane.The Volume Options tab displays a list of options set for the volume.
- Select the option you want to reset. Click . A dialog box displays, prompting to confirm the reset option.
- Click .The selected option is reset.
Note
9.2.11. Removing Bricks from a Volume
Procedure 9.8. Removing Bricks from a Volume
- On the Volumes tab on the navigation pane, select the volume from which you wish to remove bricks.
- Click the tab from the Details pane.
- Select the bricks you wish to remove. Click .
- A window opens, prompting to confirm the deletion. Click OK to confirm.
9.2.12. Stopping Red Hat Gluster Storage Volumes
Procedure 9.9. Stopping Volumes
- In the Volumes tab, select the volume to be stopped.You can select multiple volumes to stop by using
ShiftorCtrlkey. - Click .
9.2.13. Deleting Red Hat Gluster Storage Volumes
- In the Volumes tab, select the volume to be deleted.
- Click . A dialog box displays, prompting to confirm the deletion. Click .
9.2.14. Rebalancing Volumes
Procedure 9.10. Rebalancing a Volume
- Click the Volumes tab.A list of volumes displays.
- Select the volume to rebalance.
- Click Rebalance.
9.3. Clusters and Gluster Hooks
- 9.3.1. Managing Gluster Hooks
- 9.3.2. Listing Hooks
- 9.3.3. Viewing the Content of Hooks
- 9.3.4. Enabling or Disabling Hooks
- 9.3.5. Refreshing Hooks
- 9.3.6. Resolving Conflicts
- 9.3.7. Resolving Content Conflicts
- 9.3.8. Resolving Missing Hook Conflicts
- 9.3.9. Resolving Status Conflicts
- 9.3.10. Resolving Multiple Conflicts
- 9.3.11. Managing Gluster Sync
9.3.1. Managing Gluster Hooks
- View a list of hooks available in the hosts.
- View the content and status of hooks.
- Enable or disable hooks.
- Resolve hook conflicts.
9.3.2. Listing Hooks
Procedure 9.11. Listing a Hook
- Use the Cluster resource tab, tree mode, or the search function to find and select a cluster in the results list.
- Select the Gluster Hooks sub-tab to list the hooks in the details pane.
9.3.3. Viewing the Content of Hooks
Procedure 9.12. Viewing the Content of a Hook
- Use the Cluster resource tab, tree mode, or the search function to find and select a cluster in the results list.
- Select the Gluster Hooks sub-tab to list the hooks in the details pane.
- Select a hook with content type Text and click the button to open the Hook Content window.
9.3.4. Enabling or Disabling Hooks
Procedure 9.13. Enabling or Disabling a Hook
- Use the Cluster resource tab, tree mode, or the search function to find and select a cluster in the results list.
- Select the Gluster Hooks sub-tab to list the hooks in the details pane.
- Select a hook and click one of the or buttons. The hook is enabled or disabled on all nodes of the cluster.
9.3.5. Refreshing Hooks
Procedure 9.14. Refreshing a Hook
- Use the Cluster resource tab, tree mode, or the search function to find and select a cluster in the results list.
- Select the Gluster Hooks sub-tab to list the hooks in the details pane.
- Click the button.
9.3.6. Resolving Conflicts
- Content Conflict - the content of the hook is different across servers.
- Missing Conflict - one or more servers of the cluster do not have the hook.
- Status Conflict - the status of the hook is different across servers.
- Multiple Conflicts - a hook has a combination of two or more of the aforementioned conflicts.
9.3.7. Resolving Content Conflicts
Procedure 9.15. Resolving a Content Conflict
- Use the Cluster resource tab, tree mode, or the search function to find and select a cluster in the results list.
- Select the Gluster Hooks sub-tab to list the hooks in the details pane.
- Select the conflicting hook and click the button to open the Resolve Conflicts window.
- Select the engine or a server from the list of sources to view the content of that hook and establish which version of the hook to copy.
Note
The content of the hook will be overwritten in all servers and in the engine. - Use the Use content from drop-down menu to select the preferred server or the engine.
- Click OK to resolve the conflict and close the window.
9.3.8. Resolving Missing Hook Conflicts
Procedure 9.16. Resolving a Missing Hook Conflict
- Use the Cluster resource tab, tree mode, or the search function to find and select a cluster in the results list.
- Select the Gluster Hooks sub-tab to list the hooks in the details pane.
- Select the conflicting hook and click the button to open the Resolve Conflicts window.
- Select any source with a status of Enabled to view the content of the hook.
- Select the appropriate radio button, either Copy the hook to all the servers or Remove the missing hook. The latter will remove the hook from the engine and all servers.
- Click OK to resolve the conflict and close the window.
9.3.9. Resolving Status Conflicts
Procedure 9.17. Resolving a Status Conflict
- Use the Cluster resource tab, tree mode, or the search function to find and select a cluster in the results list.
- Select the Gluster Hooks sub-tab to list the hooks in the details pane.
- Select the conflicting hook and click the button to open the Resolve Conflicts window.
- Set Hook Status to Enable or Disable.
- Click OK to resolve the conflict and close the window.
9.3.10. Resolving Multiple Conflicts
Procedure 9.18. Resolving Multiple Conflicts
- Use the Cluster resource tab, tree mode, or the search function to find and select a cluster in the results list.
- Select the Gluster Hooks sub-tab to list the hooks in the details pane.
- Select the conflicting hook and click the button to open the Resolve Conflicts window.
- Choose a resolution to each of the affecting conflicts, as per the appropriate procedure.
- Click OK to resolve the conflicts and close the window.
9.3.11. Managing Gluster Sync
Note
Chapter 10. Virtual Machines
- 10.1. Introduction to Virtual Machines
- 10.2. Supported Virtual Machine Operating Systems
- 10.3. Virtual Machine Performance Parameters
- 10.4. Creating Virtual Machines
- 10.5. Explanation of Settings and Controls in the New Virtual Machine and Edit Virtual Machine Windows
- 10.6. Configuring Virtual Machines
- 10.7. Editing Virtual Machines
- 10.8. Running Virtual Machines
- 10.9. Removing Virtual Machines
- 10.10. Cloning Virtual Machines
- 10.11. Virtual Machines and Permissions
- 10.12. Snapshots
- 10.13. Affinity Groups
- 10.14. Exporting and Importing Virtual Machines and Templates
- 10.15. Migrating Virtual Machines Between Hosts
- 10.16. Improving Uptime with Virtual Machine High Availability
- 10.17. Other Virtual Machine Tasks
10.1. Introduction to Virtual Machines
10.2. Supported Virtual Machine Operating Systems
Table 10.1. Operating systems that can be used as guest operating systems
| Operating System | Architecture | SPICE option support |
|---|---|---|
|
Red Hat Enterprise Linux 3
|
32-bit, 64-bit
|
Yes
|
|
Red Hat Enterprise Linux 4
|
32-bit, 64-bit
|
Yes
|
|
Red Hat Enterprise Linux 5
|
32-bit, 64-bit
|
Yes
|
|
Red Hat Enterprise Linux 6
|
32-bit, 64-bit
|
Yes
|
|
Red Hat Enterprise Linux 7
|
64-bit
|
Yes
|
|
SUSE Linux Enterprise Server 10 (select for the guest type in the user interface)
|
32-bit, 64-bit
|
No
|
|
SUSE Linux Enterprise Server 11 (SPICE drivers (QXL) are not supplied by Red Hat. However, the distribution's vendor may provide SPICE drivers as part of their distribution.)
|
32-bit, 64-bit
|
No
|
|
Ubuntu 12.04 (Precise Pangolin LTS)
|
32-bit, 64-bit
|
Yes
|
|
Ubuntu 12.10 (Quantal Quetzal)
|
32-bit, 64-bit
|
Yes
|
|
Ubuntu 13.04 (Raring Ringtail)
|
32-bit, 64-bit
|
No
|
|
Ubuntu 13.10 (Saucy Salamander)
|
32-bit, 64-bit
|
Yes
|
|
Windows XP Service Pack 3 and newer
|
32-bit
|
Yes
|
|
Windows 7
|
32-bit, 64-bit
|
Yes
|
|
Windows 8
|
32-bit, 64-bit
|
Yes
|
|
Windows 8.1
|
32-bit, 64-bit
|
Yes
|
|
Windows Server 2003 Service Pack 2 and newer
| |
Yes
|
|
Windows Server 2003 R2
| |
Yes
|
|
Windows Server 2008
|
32-bit, 64-bit
|
Yes
|
|
Windows Server 2008 R2
|
64-bit
|
Yes
|
|
Windows Server 2012
|
64-bit
|
Yes
|
|
Windows Server 2012 R2
|
64-bit
|
No
|
Table 10.2. Guest operating systems that are supported by Global Support Services
| Operating System | Architecture |
|---|---|
|
Red Hat Enterprise Linux 3
|
32-bit, 64-bit
|
|
Red Hat Enterprise Linux 4
|
32-bit, 64-bit
|
|
Red Hat Enterprise Linux 5
|
32-bit, 64-bit
|
|
Red Hat Enterprise Linux 6
|
32-bit, 64-bit
|
|
Red Hat Enterprise Linux 7
|
64-bit
|
|
SUSE Linux Enterprise Server 10 (select for the guest type in the user interface)
|
32-bit, 64-bit
|
|
SUSE Linux Enterprise Server 11 (SPICE drivers (QXL) are not supplied by Red Hat. However, the distribution's vendor may provide SPICE drivers as part of their distribution.)
|
32-bit, 64-bit
|
|
Windows XP Service Pack 3 and newer
|
32-bit
|
|
Windows 7
|
32-bit, 64-bit
|
|
Windows 8
|
32-bit, 64-bit
|
|
Windows 8.1
|
32-bit, 64-bit
|
|
Windows Server 2003 Service Pack 2 and newer
| |
|
Windows Server 2003 R2
| |
|
Windows Server 2008
|
32-bit, 64-bit
|
|
Windows Server 2008 R2
|
64-bit
|
|
Windows Server 2012
|
64-bit
|
|
Windows Server 2012 R2
|
64-bit
|
Note
Note
10.3. Virtual Machine Performance Parameters
Table 10.3. Supported virtual machine parameters
| Parameter | Number | Note |
|---|---|---|
| Virtualized CPUs | 160 | Per virtual machine running on a Red Hat Enterprise Linux 6 host. |
| Virtualized CPUs | 240 | Per virtual machine running on a Red Hat Enterprise Linux 7 host. |
| Virtualized RAM | 4000 GB | For a 64 bit virtual machine. |
| Virtualized RAM | 4GB | Per 32 bit virtual machine. Note, the virtual machine may not register the entire 4 GB. The amount of RAM that the virtual machine recognizes is limited by its operating system. |
| Virtualized storage devices | 8 | Per virtual machine. |
| Virtualized network interface controllers | 8 | Per virtual machine. |
| Virtualized PCI devices | 32 | Per virtual machine. |
10.4. Creating Virtual Machines
10.4.1. Creating a Virtual Machine
Procedure 10.1. Creating a Virtual Machine
- Click the tab.
- Click the button to open the New Virtual Machine window.
- On the General tab, fill in the Name and Operating System fields. You can accept the default settings for other fields, or change them if required.
- Alternatively, click the Initial Run, Console, Host, Resource Allocation, Boot Options, Random Generator, and Custom Properties tabs in turn to define options for your virtual machine.
- Click to create the virtual machine and close the window.The New Virtual Machine - Guide Me window opens.
- Use the Guide Me buttons to complete configuration or click to close the window.
Down. Before you can use this virtual machine, add at least one network interface and one virtual disk, and install an operating system.
10.4.2. Creating a Virtual Machine Based on a Template
Note
Procedure 10.2. Creating a Virtual Machine Based on a Template
- Click the Virtual Machines tab.
- Click the button to open the New Virtual Machine window.
- Select the Cluster on which the virtual machine will run.
- Select a template from the Based on Template list.
- Select a template sub version from the Template Sub Version list.
- Enter a Name, Description, and any Comments, and accept the default values inherited from the template in the rest of the fields. You can change them if needed.
- Click the Resource Allocation tab.
- Select the Thin radio button in the Storage Allocation area.
- Select the disk provisioning policy from the Allocation Policy list. This policy affects the speed of the clone operation and the amount of disk space the new virtual machine initially requires.
- Selecting Thin Provision results in a faster clone operation and provides optimized usage of storage capacity. Disk space is allocated only as it is required. This is the default selection.
- Selecting Preallocated results in a slower clone operation and provides optimized virtual machine read and write operations. All disk space requested in the template is allocated at the time of the clone operation.
- Use the Target list to select the storage domain on which the virtual machine's virtual disk will be stored.
- Click .
10.4.3. Creating a Cloned Virtual Machine Based on a Template
Note
Procedure 10.3. Cloning a Virtual Machine Based on a Template
- Click the Virtual Machines tab.
- Click the button to open the New Virtual Machine window.
- Select the Cluster on which the virtual machine will run.
- Select a template from the Based on Template drop-down menu.
- Select a template sub version from the Template Sub Version drop-down menu.
- Enter a Name, Description and any Comments. You can accept the default values inherited from the template in the rest of the fields, or change them if required.
- Click the Resource Allocation tab.
- Select the Clone radio button in the Storage Allocation area.
- Select the disk provisioning policy from the Allocation Policy drop-down menu. This policy affects the speed of the clone operation and the amount of disk space the new virtual machine initially requires.
- Selecting Thin Provision results in a faster clone operation and provides optimized usage of storage capacity. Disk space is allocated only as it is required. This is the default selection.
- Selecting Preallocated results in a slower clone operation and provides optimized virtual machine read and write operations. All disk space requested in the template is allocated at the time of the clone operation.
- Use the Target drop-down menu to select the storage domain on which the virtual machine's virtual disk will be stored.
- Click .
Note
10.5. Explanation of Settings and Controls in the New Virtual Machine and Edit Virtual Machine Windows
- 10.5.1. Virtual Machine General Settings Explained
- 10.5.2. Virtual Machine System Settings Explained
- 10.5.3. Virtual Machine Initial Run Settings Explained
- 10.5.4. Virtual Machine Console Settings Explained
- 10.5.5. Virtual Machine Host Settings Explained
- 10.5.6. Virtual Machine High Availability Settings Explained
- 10.5.7. Virtual Machine Resource Allocation Settings Explained
- 10.5.8. Virtual Machine Boot Options Settings Explained
- 10.5.9. Virtual Machine Random Generator Settings Explained
- 10.5.10. Virtual Machine Custom Properties Settings Explained
10.5.1. Virtual Machine General Settings Explained
Table 10.4. Virtual Machine: General Settings
|
Field Name
|
Description
|
|---|---|
|
Cluster
|
The name of the host cluster to which the virtual machine is attached. Virtual machines are hosted on any physical machine in that cluster in accordance with policy rules.
|
|
Based on Template
|
The template on which the virtual machine can be based. This field is set to
Blank by default, which allows you to create a virtual machine on which an operating system has not yet been installed.
|
|
Template Sub Version
|
The version of the template on which the virtual machine can be based. This field is set to the most recent version for the given template by default. If no versions other than the base template are available, this field is set to
base template by default. Each version is marked by a number in brackets that indicates the relative order of the versions, with higher numbers indicating more recent versions.
|
|
Operating System
|
The operating system. Valid values include a range of Red Hat Enterprise Linux and Windows variants.
|
|
Instance Type
|
The instance type on which the virtual machine's hardware configuration can be based. This field is set to Custom by default, which means the virtual machine is not connected to an instance type. The other options available from this drop down menu are Large, Medium, Small, Tiny, XLarge, and any custom instance types that the Administrator has created.
Other settings that have a chain link icon next to them are pre-filled by the selected instance type. If one of these values is changed, the virtual machine will be detached from the instance type and the chain icon will appear broken. However, if the changed setting is restored to its original value, the virtual machine will be reattached to the instance type and the links in the chain icon will rejoin.
|
|
Optimized for
|
The type of system for which the virtual machine is to be optimized. There are two options: Server, and Desktop; by default, the field is set to Server. Virtual machines optimized to act as servers have no sound card, use a cloned disk image, and are not stateless. In contrast, virtual machines optimized to act as desktop machines do have a sound card, use an image (thin allocation), and are stateless.
|
|
Name
|
The name of the virtual machine. Names must not contain any spaces, and must contain at least one character from A-Z or 0-9. The maximum length of a virtual machine name is 255 characters.
|
|
Description
|
A meaningful description of the new virtual machine.
|
|
Comment
|
A field for adding plain text human-readable comments regarding the virtual machine.
|
|
Stateless
|
Select this check box to run the virtual machine in stateless mode. This mode is used primarily for desktop VMs. Running a stateless desktop or server creates a new COW layer on the VM hard disk image where new and changed data is stored. Shutting down the stateless VM deletes the new COW layer, which returns the VM to its original state. Stateless VMs are useful when creating machines that need to be used for a short time, or by temporary staff.
|
|
Start in Pause Mode
|
Select this check box to always start the virtual machine in pause mode. This option is suitable for VMs which require a long time to establish a SPICE connection; for example, VMs in remote locations.
|
|
Delete Protection
|
Select this check box to make it impossible to delete the virtual machine. It is only possible to delete the virtual machine if this check box is not selected.
|
10.5.2. Virtual Machine System Settings Explained
Table 10.5. Virtual Machine: System Settings
|
Field Name
|
Description
|
|---|---|
|
Memory Size
|
The amount of memory assigned to the virtual machine. When allocating memory, consider the processing and storage needs of the applications that are intended to run on the virtual machine.
Maximum guest memory is constrained by the selected guest architecture and the cluster compatibility level.
|
|
Total Virtual CPUs
|
The processing power allocated to the virtual machine as CPU Cores. Do not assign more cores to a virtual machine than are present on the physical host.
|
|
Cores per Virtual Socket
|
The number of cores assigned to each virtual socket.
|
|
Virtual Sockets
|
The number of CPU sockets for the virtual machine. Do not assign more sockets to a virtual machine than are present on the physical host.
|
|
Time Zone
|
This option sets the time zone offset of the guest hardware clock. For Windows, this should correspond to the time zone set in the guest. Most default Linux installations expect the hardware clock to be GMT+00:00.
|
|
Provide custom serial number policy
|
This checkbox allows you to specify a serial number for the virtual machine. Select either:
|
10.5.3. Virtual Machine Initial Run Settings Explained
Table 10.6. Virtual Machine: Initial Run Settings
|
Field Name
|
Operating System
|
Description
|
|---|---|---|
|
Use Cloud-Init/Sysprep
|
Linux, Windows
|
This check box toggles whether Cloud-Init or Sysprep will be used to initialize the virtual machine.
|
|
VM Hostname
|
Linux, Windows
|
The host name of the virtual machine.
|
| Domain |
Windows
|
The Active Directory domain to which the virtual machine belongs.
|
| Organization Name |
Windows
|
The name of the organization to which the virtual machine belongs. This option corresponds to the text field for setting the organization name displayed when a machine running Windows is started for the first time.
|
| Active Directory OU |
Windows
|
The organizational unit in the Active Directory domain to which the virtual machine belongs.
|
|
Configure Time Zone
|
Linux, Windows
|
The time zone for the virtual machine. Select this check box and select a time zone from the Time Zone list.
|
| Admin Password |
Windows
|
The administrative user password for the virtual machine. Click the disclosure arrow to display the settings for this option.
|
| Authentication |
Linux
|
The authentication details for the virtual machine. Click the disclosure arrow to display the settings for this option.
|
| Custom Locale |
Windows
|
Custom locale options for the virtual machine. Locales must be in a format such as
en-US. Click the disclosure arrow to display the settings for this option.
|
|
Networks
|
Linux
|
Network-related settings for the virtual machine. Click the disclosure arrow to display the settings for this option.
|
|
Custom Script
|
Linux
|
Custom scripts that will be run on the virtual machine when it starts. The scripts entered in this field are custom YAML sections that are added to those produced by the Manager, and allow you to automate tasks such as creating users and files, configuring yum repositories and running commands. For more information on the format of scripts that can be entered in this field, see the Custom Script documentation.
|
| Sysprep |
Windows
|
A custom Sysprep definition. The definition must be in the format of a complete unattended installation answer file. You can copy and paste the default answer files in the
/usr/share/ovirt-engine/conf/sysprep/ directory on the machine on which the Red Hat Enterprise Virtualization Manager is installed and alter the fields as required.
|
10.5.4. Virtual Machine Console Settings Explained
Table 10.7. Virtual Machine: Console Settings
|
Field Name
|
Description
|
|---|---|
|
Protocol
|
Defines which display protocol to use. SPICE is the recommended protocol for Linux and Windows virtual machines. Optionally, select VNC for Linux virtual machines. A VNC client is required to connect to a virtual machine using the VNC protocol.
|
|
VNC Keyboard Layout
|
Defines the keyboard layout for the virtual machine. This option is only available when using the VNC protocol.
|
|
USB Support
|
Defines whether USB devices can be used on the virtual machine. This option is only available for virtual machines using the SPICE protocol. Select either:
|
|
Monitors
|
The number of monitors for the virtual machine. This option is only available for virtual desktops using the SPICE display protocol. You can choose 1, 2 or 4. Note that multiple monitors are not supported for Windows 8 and Windows Server 2012 virtual machines.
|
|
Smartcard Enabled
|
Smart cards are an external hardware security feature, most commonly seen in credit cards, but also used by many businesses as authentication tokens. Smart cards can be used to protect Red Hat Enterprise Virtualization virtual machines. Tick or untick the check box to activate and deactivate Smart card authentication for individual virtual machines.
|
|
Disable strict user checking
|
Click the Advanced Parameters arrow and select the check box to use this option. With this option selected, the virtual machine does not need to be rebooted when a different user connects to it.
By default, strict checking is enabled so that only one user can connect to the console of a virtual machine. No other user is able to open a console to the same virtual machine until it has been rebooted. The exception is that a
SuperUser can connect at any time and replace a existing connection. When a SuperUser has connected, no normal user can connect again until the virtual machine is rebooted.
Disable strict checking with caution, because you can expose the previous user's session to the new user.
|
|
Soundcard Enabled
|
A sound card device is not necessary for all virtual machine use cases. If it is for yours, enable a sound card here.
|
|
VirtIO Console Device Enabled
|
The VirtIO console device is a console over VirtIO transport for communication between the host user space and guest user space. It has two parts: device emulation in QEMU that presents a virtio-pci device to the guest, and a guest driver that presents a character device interface to user space applications. Tick the check box to attach a VirtIO console device to your virtual machine.
|
|
Enable SPICE clipboard copy and paste
|
Defines whether a user is able to copy and paste content from an external host into the virtual machine's SPICE console. This option is only available for virtual machines using the SPICE protocol. This check box is selected by default.
|
10.5.5. Virtual Machine Host Settings Explained
Table 10.8. Virtual Machine: Host Settings
|
Field Name
|
Description
|
|---|---|
|
Start Running On
|
Defines the preferred host on which the virtual machine is to run. Select either:
|
|
Migration Options
|
Defines options to run and migrate the virtual machine. If the options here are not used, the virtual machine will run or migrate according to its cluster's policy.
The Use custom migration downtime check box allows you to specify the maximum number of milliseconds the virtual machine can be down during live migration. Configure different maximum downtimes for each virtual machine according to its workload and SLA requirements. The VDSM default value is 0.
The Pass-Through Host CPU check box allows virtual machines to take advantage of the features of the physical CPU of the host on which they are situated. This option can only be enabled when Do not allow migration is selected.
|
|
Configure NUMA
|
Defines options for virtual NUMA nodes. These options are only available if the virtual machine's host has at least two NUMA nodes.
NUMA Node Count allows you to specify the number of virtual NUMA nodes to assign to the virtual machine. If the Tune Mode is Preferred, this value must be set to
1.
Tune Mode defines the method used to allocate memory. Choose one of the following from the drop-down list:
The button opens the NUMA Topology window. This window shows the host's total CPUs, memory, and NUMA nodes, and the virtual machine's virtual NUMA nodes. Pin virtual NUMA nodes to host NUMA nodes by clicking and dragging each vNUMA from the box on the right to a NUMA node on the left.
|
10.5.6. Virtual Machine High Availability Settings Explained
Table 10.9. Virtual Machine: High Availability Settings
|
Field Name
|
Description
|
|---|---|
|
Highly Available
|
Select this check box if the virtual machine is to be highly available. For example, in cases of host maintenance, all virtual machines are automatically live migrated to another host. If the host crashed and is in a non-responsive state, only virtual machines with high availability are restarted on another host. If the host is manually shut down by the system administrator, the virtual machine is not automatically live migrated to another host.
Note that this option is unavailable if the Migration Options setting in the Hosts tab is set to either Allow manual migration only or Do not allow migration. For a virtual machine to be highly available, it must be possible for the Manager to migrate the virtual machine to other available hosts as necessary.
|
|
Priority for Run/Migration queue
|
Sets the priority level for the virtual machine to be migrated or restarted on another host.
|
|
Watchdog
|
Allows users to attach a watchdog card to a virtual machine. A watchdog is a timer that is used to automatically detect and recover from failures. Once set, a watchdog timer continually counts down to zero while the system is in operation, and is periodically restarted by the system to prevent it from reaching zero. If the timer reaches zero, it signifies that the system has been unable to reset the timer and is therefore experiencing a failure. Corrective actions are then taken to address the failure. This functionality is especially useful for servers that demand high availability.
Watchdog Model: The model of watchdog card to assign to the virtual machine. At current, the only supported model is i6300esb.
Watchdog Action: The action to take if the watchdog timer reaches zero. The following actions are available:
|
10.5.7. Virtual Machine Resource Allocation Settings Explained
Table 10.10. Virtual Machine: Resource Allocation Settings
|
Field Name
|
Sub-element
|
Description
|
|---|---|---|
|
CPU Allocation
| CPU Profile |
The CPU profile assigned to the virtual machine. CPU profiles define the maximum amount of processing capability a virtual machine can access on the host on which it runs, expressed as a percent of the total processing capability available to that host. CPU profiles are defined on the cluster level based on quality of service entries created for data centers.
|
|
CPU Shares
|
Allows users to set the level of CPU resources a virtual machine can demand relative to other virtual machines.
| |
|
CPU Pinning topology
|
Enables the virtual machine's virtual CPU (vCPU) to run on a specific physical CPU (pCPU) in a specific host. This option is not supported if the virtual machine's cluster compatibility version is set to 3.0. The syntax of CPU pinning is
v#p[_v#p], for example:
In order to pin a virtual machine to a host, you must also select the following on the Host tab:
| |
|
Memory Allocation
| The amount of physical memory guaranteed for this virtual machine. | |
|
Storage Allocation
|
The Template Provisioning option is only available when the virtual machine is created from a template.
| |
|
Thin
|
Provides optimized usage of storage capacity. Disk space is allocated only as it is required.
| |
|
Clone
|
Optimized for the speed of guest read and write operations. All disk space requested in the template is allocated at the time of the clone operation.
| |
|
VirtIO-SCSI Enabled
|
Allows users to enable or disable the use of VirtIO-SCSI on the virtual machines.
|
10.5.8. Virtual Machine Boot Options Settings Explained
Table 10.11. Virtual Machine: Boot Options Settings
|
Field Name
|
Description
|
|---|---|
|
First Device
|
After installing a new virtual machine, the new virtual machine must go into Boot mode before powering up. Select the first device that the virtual machine must try to boot:
|
|
Second Device
|
Select the second device for the virtual machine to use to boot if the first device is not available. The first device selected in the previous option does not appear in the options.
|
|
Attach CD
|
If you have selected CD-ROM as a boot device, tick this check box and select a CD-ROM image from the drop-down menu. The images must be available in the ISO domain.
|
10.5.9. Virtual Machine Random Generator Settings Explained
Table 10.12. Virtual Machine: Random Generator
|
Field Name
|
Description
|
|---|---|
|
Random Generator enabled
|
Selecting this check box enables a paravirtualized Random Number Generator PCI device (virtio-rng). This device allows entropy to be passed from the host to the virtual machine in order to generate a more sophisticated random number. Note that this check box can only be selected if the RNG device exists on the host and is enabled in the host's cluster.
|
|
Period duration (ms)
|
Specifies the duration of a period in milliseconds. If omitted, the libvirt default of 1000 milliseconds (1 second) is used. If this field is filled, Bytes per period must be filled also.
|
|
Bytes per period
|
Specifies how many bytes are permitted to be consumed per period.
|
|
Device source:
|
The source of the random number generator. This is automatically selected depending on the source supported by the host's cluster.
|
Important
10.5.10. Virtual Machine Custom Properties Settings Explained
Table 10.13. Virtual Machine: Custom Properties Settings
|
Field Name
|
Description
|
Recommendations and Limitations
|
|---|---|---|
|
sap_agent
|
Enables SAP monitoring on the virtual machine. Set to true or false.
|
-
|
|
sndbuf
|
Enter the size of the buffer for sending the virtual machine's outgoing data over the socket. Default value is 0.
|
-
|
|
vhost
|
Disables vhost-net, which is the kernel-based virtio network driver on virtual network interface cards attached to the virtual machine. To disable vhost, the format for this property is:
LogicalNetworkName: falseThis will explicitly start the virtual machine without the vhost-net setting on the virtual NIC attached to LogicalNetworkName. |
vhost-net provides better performance than virtio-net, and if it is present, it is enabled on all virtual machine NICs by default. Disabling this property makes it easier to isolate and diagnose performance issues, or to debug vhost-net errors; for example, if migration fails for virtual machines on which vhost does not exist.
|
|
viodiskcache
|
Caching mode for the virtio disk. writethrough writes data to the cache and the disk in parallel, writeback does not copy modifications from the cache to the disk, and none disables caching.
|
For Red Hat Enterprise Virtualization 3.1, if viodiskcache is enabled, the virtual machine cannot be live migrated.
|
Warning
10.6. Configuring Virtual Machines
10.6.1. Completing the Configuration of a Virtual Machine by Defining Network Interfaces and Hard Disks
Procedure 10.4. Completing the Configuration of a Virtual Machine by Defining Network Interfaces and Hard Disks
- On the New Virtual Machine - Guide Me window, click the button to open the New Network Interface window. You can accept the default values or change them as necessary.Enter the Name of the network interface.
- Use the drop-down menus to select the Network and the Type of network interface for the new virtual machine. The Link State is set to Up by default when the NIC is defined on the virtual machine and connected to the network.
Note
The options on the Network and Type fields are populated by the networks available to the cluster, and the NICs available to the virtual machine. - If applicable, select the Specify custom MAC address check box and enter the network interface's MAC address.
- Click the arrow next to Advanced Parameters to configure the Port Mirroring and Card Status fields, if necessary.
- Click to close the New Network Interface window and open the New Virtual Machine - Guide Me window.
- Click the button to open the Add Virtual Disk window.
- Add either an Internal virtual disk or an External LUN to the virtual machine.
- Click to close the Add Virtual Disk window. The New Virtual Machine - Guide Me window opens with changed context. There is no further mandatory configuration.
- Click to close the window.
10.6.2. Installing Windows on VirtIO-Optimized Hardware
virtio-win.vfd diskette image contains Windows drivers for VirtIO-optimized disk and network devices. These drivers provide a performance improvement over emulated device drivers.
virtio-win.vfd is placed automatically on ISO storage domains that are hosted on the Manager server. It must be manually uploaded using the engine-iso-uploader tool to other ISO storage domains.
Red Hat VirtIO network interface and a disk that uses the VirtIO interface to your virtual machine.
Procedure 10.5. Installing VirtIO Drivers during Windows Installation
- Click the Virtual Machines tab and select a virtual machine.
- Click the button, and the Run Once window displays.
- Click Boot Options to expand the Boot Options configuration options.
- Click the Attach Floppy check box, and select
virtio-win.vfdfrom the drop down selection box. - Click the Attach CD check box, and select from the drop down selection box the ISO containing the version of Windows you want to install.
- Move CD-ROM in the Boot Sequence field.
- Configure the rest of your Run Once options as required, and click OK to start your virtual machine, and then click the button to open a graphical console to your virtual machine.
virtio-win.vfd diskette that was attached to your virtual machine as A:.
10.6.3. Virtual Machine Run Once Settings Explained
Boot Options
- Attach Floppy
- Attaches a diskette image to the virtual machine. Use this option to install Windows drivers. The diskette image must reside in the ISO domain.
- Attach CD
- Attaches an ISO image to the virtual machine. Use this option to install the virtual machine's operating system and applications. The CD image must reside in the ISO domain.
- Boot Sequence
- Determines the order in which the boot devices are used to boot the virtual machine. Select either Hard Disk, CD-ROM or Network, and use and to move the option up or down in the list.
- Run Stateless
- Deletes all changes to the virtual machine upon shutdown. This option is only available if a virtual disk is attached to the virtual machine.
- Start in Pause Mode
- Starts then pauses the virtual machine to enable connection to the console, suitable for virtual machines in remote locations.
Linux Boot Options
- kernel path
- A fully qualified path to a kernel image to boot the virtual machine. The kernel image must be stored on either the ISO domain (path name in the format of
iso://path-to-image) or on the host's local storage domain (path name in the format of/data/images). - initrd path
- A fully qualified path to a ramdisk image to be used with the previously specified kernel. The ramdisk image must be stored on the ISO domain (path name in the format of
iso://path-to-image) or on the host's local storage domain (path name in the format of/data/images). - kernel parameters
- Kernel command line parameter strings to be used with the defined kernel on boot.
Initial Run
[sysprep] floppy by selecting the Attach Floppy check box in the Boot Options tab and selecting the floppy from the list. Certain options are only available on Linux-based or Windows-based virtual machines, as noted below.
- VM Hostname
- The host name of the virtual machine.
- Domain
- The Active Directory domain to which the virtual machine belongs. (Windows)
- Organization Name
- The name of the organization to which the virtual machine belongs. This option corresponds to the text field for setting the organization name displayed when a machine running Windows is started for the first time. (Windows)
- Active Directory OU
- The organizational unit in the Active Directory domain to which the virtual machine belongs. (Windows)
- Configure Time Zone
- The time zone for the virtual machine. Select this check box and select a time zone from the Time Zone list.
- Alternate Credentials
- Selecting this check box allows you to set a User Name and Password as alternative credentials. (Windows)
Admin Password
- Use already configured password
- This check box is automatically selected after you specify an initial administrative user password. You must clear this check box to enable the Admin Password and Verify Admin Password fields and specify a new password.
- Admin Password
- The administrative user password for the virtual machine. Enter the password in this text field and the Verify Admin Password text field to verify the password.
Authentication
- User Name
- Creates a new user account on the virtual machine. If this field is not filled in, the default user is
root. - Use already configured password
- This check box is automatically selected after you specify an initial root password. You must clear this check box to enable the Password and Verify Password fields and specify a new password.
- Password
- The root password for the virtual machine. Enter the password in this text field and the Verify Password text field to verify the password.
- SSH Authorized Keys
- SSH keys to be added to the authorized keys file of the virtual machine.
- Regenerate SSH Keys
- Regenerates SSH keys for the virtual machine.
Custom Locale
en-US. Click the disclosure arrow to display the settings for this option. (Windows)
- Input Locale
- The locale for user input.
- UI Language
- The language used for user interface elements such as buttons and menus.
- System Locale
- The locale for the overall system.
- User Locale
- The locale for users.
Networks
- DNS Servers
- The DNS servers to be used by the virtual machine.
- DNS Search Domains
- The DNS search domains to be used by the virtual machine.
- Network
- Configures network interfaces for the virtual machine. Select this check box and click + or - to add or remove network interfaces to or from the virtual machine. When you click +, a set of fields becomes visible that can specify whether to use DHCP, and configure an IP address, netmask, and gateway, and specify whether the network interface will start on boot.
Custom Script
- Custom Scripts
- The scripts entered in this field are custom YAML sections that are added to those produced by the Manager, and allow you to automate tasks such as creating users and files, configuring yum repositories and running commands. For more information on the format of scripts that can be entered in this field, see the Custom Script documentation. (Linux)
Sysprep
- Sysprep
- The definition must be in the format of a complete unattended installation answer file. You can copy and paste the default answer files in the
/usr/share/ovirt-engine/conf/sysprep/directory on the machine on which the Red Hat Enterprise Virtualization Manager is installed and alter the fields as required. (Windows)
Host
- Any host in cluster
- Allocates the virtual machine to any available host.
- Specific
- Specifies a user-defined host for the virtual machine.
Display Protocol
- VNC
- Can be used for Linux virtual machines. Requires a VNC client to connect to a virtual machine using VNC. Optionally, specify VNC Keyboard Layout from the drop-down list.
- SPICE
- Recommended protocol for Linux and Windows virtual machines. Using SPICE protocol without QXL drivers is a Tech Preview feature for Windows 8 and Server 2012 virtual machines (BZ#1217494).
Custom Properties
- sap_agent
- Enables SAP monitoring on the virtual machine. Set to true or false.
- sndbuf
- Enter the size of the buffer for sending the virtual machine's outgoing data over the socket.
- vhost
- Enter the name of the virtual host on which this virtual machine should run. The name can contain any combination of letters and numbers.
- viodiskcache
- Caching mode for the virtio disk. writethrough writes data to the cache and the disk in parallel, writeback does not copy modifications from the cache to the disk, and none disables caching.
10.6.4. Configuring a Watchdog
10.6.4.1. Adding a Watchdog Card to a Virtual Machine
Procedure 10.6. Adding a Watchdog Card to a Virtual Machine
- Click the Virtual Machines tab and select a virtual machine.
- Click to open the Edit Virtual Machine window.
- Click to display all tabs and click the High Availability tab.
- Select the watchdog model to use from the Watchdog Model drop-down menu.
- Select an action from the Watchdog Action drop-down menu. This is the action that the virtual machine takes when the watchdog is triggered.
- Click .
10.6.4.2. Installing a Watchdog
watchdog service.
Procedure 10.7. Installing a Watchdog
- Log on to the virtual machine on which the watchdog card is attached.
- Run the following command to install the watchdog package and dependencies:
# yum install watchdog
- Edit the
/etc/watchdog.conffile and uncomment the following line:watchdog-device = /dev/watchdog
- Save the changes.
- Run the following commands to start the
watchdogservice and ensure this service starts on boot:# service watchdog start # chkconfig watchdog on
watchdog service on a virtual machine.
10.6.4.3. Confirming Watchdog Functionality
watchdog service is active.
Warning
Procedure 10.8. Confirming Watchdog Functionality
- Log on to the virtual machine on which the watchdog card is attached.
- Run the following command to confirm that the watchdog card has been identified by the virtual machine:
# lspci | grep watchdog -i
- Run one of the following commands to confirm that the watchdog is active:
- Run the following command to trigger a kernel panic:
# echo c > /proc/sysrq-trigger
- Run the following command to terminate the
watchdogservice:# kill -9 `pgrep watchdog`
10.6.4.4. Parameters for Watchdogs in watchdog.conf
watchdog service available in the /etc/watchdog.conf file. To configure an option, you must ensure that option is uncommented and restart the watchdog service after saving the changes.
Note
watchdog service and using the watchdog command, see the watchdog man page.
Table 10.14. watchdog.conf variables
| Variable name | Default Value | Remarks |
|---|---|---|
ping | N/A | An IP address that the watchdog attempts to ping to verify whether that address is reachable. You can specify multiple IP addresses by adding additional ping lines. |
interface | N/A | A network interface that the watchdog will monitor to verify the presence of network traffic. You can specify multiple network interfaces by adding additional interface lines. |
file | /var/log/messages | A file on the local system that the watchdog will monitor for changes. You can specify multiple files by adding additional file lines. |
change | 1407 | The number of watchdog intervals after which the watchdog checks for changes to files. A change line must be specified on the line directly after each file line, and applies to the file line directly above that change line. |
max-load-1 | 24 | The maximum average load that the virtual machine can sustain over a one-minute period. If this average is exceeded, then the watchdog is triggered. A value of 0 disables this feature. |
max-load-5 | 18 | The maximum average load that the virtual machine can sustain over a five-minute period. If this average is exceeded, then the watchdog is triggered. A value of 0 disables this feature. By default, the value of this variable is set to a value approximately three quarters that of max-load-1. |
max-load-15 | 12 | The maximum average load that the virtual machine can sustain over a fifteen-minute period. If this average is exceeded, then the watchdog is triggered. A value of 0 disables this feature. By default, the value of this variable is set to a value approximately one half that of max-load-1. |
min-memory | 1 | The minimum amount of virtual memory that must remain free on the virtual machine. This value is measured in pages. A value of 0 disables this feature. |
repair-binary | /usr/sbin/repair | The path and file name of a binary file on the local system that will be run when the watchdog is triggered. If the specified file resolves the issues preventing the watchdog from resetting the watchdog counter, then the watchdog action is not triggered. |
test-binary | N/A | The path and file name of a binary file on the local system that the watchdog will attempt to run during each interval. A test binary allows you to specify a file for running user-defined tests. |
test-timeout | N/A | The time limit, in seconds, for which user-defined tests can run. A value of 0 allows user-defined tests to continue for an unlimited duration. |
temperature-device | N/A | The path to and name of a device for checking the temperature of the machine on which the watchdog service is running. |
max-temperature | 120 | The maximum allowed temperature for the machine on which the watchdog service is running. The machine will be halted if this temperature is reached. Unit conversion is not taken into account, so you must specify a value that matches the watchdog card being used. |
admin | root | The email address to which email notifications are sent. |
interval | 10 | The interval, in seconds, between updates to the watchdog device. The watchdog device expects an update at least once every minute, and if there are no updates over a one-minute period, then the watchdog is triggered. This one-minute period is hard-coded into the drivers for the watchdog device, and cannot be configured. |
logtick | 1 | When verbose logging is enabled for the watchdog service, the watchdog service periodically writes log messages to the local system. The logtick value represents the number of watchdog intervals after which a message is written. |
realtime | yes | Specifies whether the watchdog is locked in memory. A value of yes locks the watchdog in memory so that it is not swapped out of memory, while a value of no allows the watchdog to be swapped out of memory. If the watchdog is swapped out of memory and is not swapped back in before the watchdog counter reaches zero, then the watchdog is triggered. |
priority | 1 | The schedule priority when the value of realtime is set to yes. |
pidfile | /var/run/syslogd.pid | The path and file name of a PID file that the watchdog monitors to see if the corresponding process is still active. If the corresponding process is not active, then the watchdog is triggered. |
10.6.5. Configuring Virtual NUMA
numactl --hardware. The output of this command should show at least two NUMA nodes. You can also view the host's NUMA topology by selecting the host from the Hosts tab and clicking . This button is only available when the selected host has at least two NUMA nodes.
Procedure 10.9. Configuring Virtual NUMA
- Click the Virtual Machines tab and select a virtual machine.
- Click .
- Click the Host tab.
- Select the Specific radio button and select a host from the list. The selected host must have at least two NUMA nodes.
- Select Do not allow migration from the Migration Options drop-down list.
- Enter a number into the NUMA Node Count field to assign virtual NUMA nodes to the virtual machine.
- Select Strict, Preferred, or Interleave from the Tune Mode drop-down list. If the selected mode is Preferred, the NUMA Node Count must be set to
1. - Click .
- In the NUMA Topology window, click and drag virtual NUMA nodes from the box on the right to host NUMA nodes on the left as required, and click .
- Click .
Note
10.7. Editing Virtual Machines
- 10.7.1. Editing Virtual Machine Properties
- 10.7.2. Network Interfaces
- 10.7.3. Virtual Disks
- 10.7.4. Extending the Available Size of a Virtual Disk
- 10.7.5. Floating Disks
- 10.7.6. Associating a Virtual Disk with a Virtual Machine
- 10.7.7. Changing the CD for a Virtual Machine
- 10.7.8. Smart card Authentication
- 10.7.9. Enabling and Disabling Smart cards
10.7.1. Editing Virtual Machine Properties
Procedure 10.10. Editing a virtual machine:
- Select the virtual machine to be edited.
- Click the button to open the Edit Virtual Machine window.
- Change the General, System, Initial Run, Console, Host, High Availability, Resource Allocation, Boot Options, Random Generator, Custom Properties, and Icon fields as required.Changes to the following fields are applied immediately:
- Name
- Description
- Comment
- Optimized for (Desktop/Server)
- Delete Protection
- Network Interfaces
- Use custom migration downtime
- Highly Available
- Priority for Run/Migration queue
- Disable strict user checking
- Virtual Sockets (On supported guest operating systems only. For more information on hot plugging CPUs, see https://access.redhat.com/articles/1339413)
To apply changes to all other settings, the virtual machine must be restarted or shut down. - If the Next Restart Configuration pop-up window appears, click .
- Click .
) appears as a reminder of the pending changes.
10.7.2. Network Interfaces
10.7.2.1. Adding and Editing Virtual Machine Network Interfaces
Procedure 10.11. Adding Network Interfaces to Virtual Machines
- Click the Virtual Machines tab and select a virtual machine.
- Select the Network Interfaces tab in the details pane to display a list of network interfaces that are currently associated with the virtual machine.
- Click to open the New Network Interface window.
- Enter the Name of the network interface.
- Use the drop-down lists to select the Profile and the Type of network interface for the new network interface.The Link State is set to Up by default when the network interface card is defined on the virtual machine and connected to the network.
Note
The Profile and Type fields are populated in accordance with the profiles and network types available to the cluster and the network interface cards available to the virtual machine. - Select the Custom MAC address check box and enter a MAC address for the network interface card as required.
- Click .
10.7.2.2. Editing a Network Interface
Procedure 10.12. Editing a Network Interface
- Click the Virtual Machines tab and select a virtual machine.
- Click the Network Interfaces tab of the details pane and select the network interface to edit.
- Click to open the Edit Network Interface window. This dialog contains the same fields as the New Network Interface dialog.
- Click to save your changes once you are finished.
10.7.2.3. Removing a Network Interface
Procedure 10.13. Removing a Network Interface
- Click the Virtual Machines tab and select a virtual machine.
- Click the Network Interfaces tab of the details pane and select the network interface to remove.
- Click and click when prompted.
10.7.2.4. Explanation of Settings in the Virtual Machine Network Interface Window
Table 10.15. Add a network interface to a virtual machine entries
|
Field Name
|
Description
|
|---|---|
|
Name
|
The name of the network interface. This text field has a 21-character limit and must be a unique name with any combination of uppercase and lowercase letters, numbers, hyphens, and underscores.
|
|
Network
|
Logical network that the network interface is placed on. By default, all network interfaces are put on the rhevm management network.
|
|
Link State
|
Whether or not the network interface is connected to the logical network.
|
|
Type
|
The virtual interface the network interface presents to virtual machines. VirtIO is faster but requires VirtIO drivers. Red Hat Enterprise Linux 5 and higher includes VirtIO drivers. Windows does not include VirtIO drivers, but they can be installed from the guest tools ISO or virtual floppy disk. rtl8139 and e1000 device drivers are included in most operating systems.
|
|
Specify custom MAC address
|
Choose this option to set a custom MAC address. The Red Hat Enterprise Virtualization Manager automatically generates a MAC address that is unique to the environment to identify the network interface. Having two devices with the same MAC address online in the same network causes networking conflicts.
|
|
Port Mirroring
|
A security feature that allows all network traffic going to or leaving from virtual machines on a given logical network and host to be copied (mirrored) to the network interface. If the host also uses the network, then traffic going to or leaving from the host is also copied.
Port mirroring only works on network interfaces with IPv4 IP addresses.
|
|
Card Status
|
Whether or not the network interface is defined on the virtual machine.
|
10.7.2.5. Hot Plugging Network Interfaces
Procedure 10.14. Hot plugging network interfaces
- Click the Virtual Machines tab and select a virtual machine.
- Select the Network Interfaces tab from the details pane of the virtual machine.
- Select the network interface you would like to hot plug and click to open the Edit Network Interface window.
- Click the Advanced Parameters arrow to access the Card Status option. Set the Card Status to Plugged to enable the network interface, or set it to Unplugged to disable the network interface.
10.7.2.6. Removing Network Interfaces From Virtual Machines
Procedure 10.15. Removing Network Interfaces From Virtual Machines
- Click the Virtual Machines tab and select a virtual machine.
- Select the Network Interfaces tab in the virtual machine details pane.
- Select the network interface to remove.
- Click the button and click when prompted.
10.7.3. Virtual Disks
10.7.3.1. Adding and Editing Virtual Machine Disks
Procedure 10.16. Adding Disks to Virtual Machines
- Click the Virtual Machines tab and select a virtual machine.
- Click the Disks tab in the details pane to display a list of virtual disks currently associated with the virtual machine.
- Click to open the Add Virtual Disk window.
- Use the appropriate radio buttons to switch between Internal and the External (Direct Lun) disks.
- Select the Attach Disk check box to choose an existing disk from the list and select the Activate check box.Alternatively, enter the Size, Alias, and Description of a new disk and use the drop-down menus and check boxes to configure the disk.
- Click to add the disk and close the window.
10.7.3.2. Hot Plugging Virtual Machine Disks
Procedure 10.17. Hot Plugging Virtual Machine Disks
- Click the Virtual Machines tab and select a virtual machine.
- Select the Disks tab from the details pane of the virtual machine.
- Select the virtual machine disk you would like to hot plug.
- Click the button, or click the button and click OK when prompted.
10.7.3.3. Removing Virtual Disks From Virtual Machines
Procedure 10.18. Removing Virtual Disks From Virtual Machines
- Click the Virtual Machines tab and select a virtual machine.
- Select the Disks tab in the virtual machine details pane.
- Select the virtual disk to remove.
- Click the button and click when prompted.
- Click the button and click when prompted. Optionally, select the Remove Permanently option to completely remove the virtual disk from the environment. If you do not select this option - for example, because the disk is a shared disk - the virtual disk will remain in the Disks resource tab.
10.7.4. Extending the Available Size of a Virtual Disk
fdisk utility to resize the partitions and file systems as required. See How to Resize a Partition using fdisk for more information.
Procedure 10.19. Extending the Available Size of a Virtual Disk
- Click the Virtual Machines tab and select a virtual machine.
- Select the Disks tab in the details pane.
- Select a target disk from the list in the details pane.
- Click in the details pane.
- Enter a value in the
Extend size by(GB)field. - Click .
locked for a short time, during which the drive is resized. When the resizing of the drive is complete, the status of the drive becomes OK.
10.7.5. Floating Disks
10.7.6. Associating a Virtual Disk with a Virtual Machine
Procedure 10.20. Associating a Virtual Disk with a Virtual Machine
- Click the Virtual Machines tab and select a virtual machine.
- In the details pane, select the Disks tab.
- Click in the menu at the top of the Details Pane.
- Type the size in GB of the disk into the Size(GB) field.
- Type the disk alias into the Alias field.
- Click in the bottom right corner of the Add Virtual Disk window.The disk you have associated with the virtual machine appears in the details pane after a short time.
Note
Note
10.7.7. Changing the CD for a Virtual Machine
Note
Procedure 10.21. Changing the CD for a Virtual Machine
- From the Virtual Machines tab, select a virtual machine that is currently running.
- Click to open the Change CD window.
- In the Change CD window do one of the following:
- Select an ISO file from the list to eject the CD currently accessible to the virtual machine and mount that ISO file as a CD.Or,
- Select from the ISO list to eject the CD currently accessible to the virtual machine.
- Click .
10.7.8. Smart card Authentication
10.7.9. Enabling and Disabling Smart cards
Procedure 10.22. Enabling Smart cards
- Ensure that the Smart card hardware is plugged into the client machine and is installed according to manufacturer's directions.
- Select the desired virtual machine.
- Click the button. The window appears.
- Select the tab, and select the check box labeled , then click .
- Run the virtual machine by clicking the icon or through the User Portal. Smart card authentication is now passed from the client hardware to the virtual machine.
Important
Procedure 10.23. Disabling Smart cards
- Select the desired virtual machine.
- Click the button. The window appears.
- Select the tab, and clear the check box labeled , then click .
10.8. Running Virtual Machines
10.8.1. Installing Console Components
10.8.1.1. Console Components
10.8.1.2. Installing Remote Viewer on Linux
Red Hat Enterprise Linux Workstation (v. 6 for x86_64) repository.
Procedure 10.24. Installing Remote Viewer on Linux
- Install the spice-xpi package and dependencies:
# yum install spice-xpi
- Check whether the virt-viewer package has already been installed on your system:
# rpm -q virt-viewer virt-viewer-0.5.2-18.el6_4.2.x86_64
- If the virt-viewer package has not been installed, install the package and its dependencies:
# yum install virt-viewer
- Restart your browser for the changes to take effect.
10.8.1.3. Installing Remote Viewer for Internet Explorer on Windows
SpiceX.cab file.
Procedure 10.25. Installing Remote Viewer for Internet Explorer on Windows
- Open Internet Explorer and log in to the User Portal.
- Start a virtual machine and attempt to connect to the virtual machine using the Browser plugin console option.
- Click the warning banner and click when prompted.
- Click when prompted.
- Restart Internet Explorer for your changes to take effect.
10.8.1.4. Installing Remote Viewer on Windows
Procedure 10.26. Installing Remote Viewer on Windows
- Open a web browser and download one of the following installers according to the architecture of your system.
- Virt Viewer for 32-bit Windows:
https://your-manager-fqdn/ovirt-engine/services/files/spice/virt-viewer-x86.msi
- Virt Viewer for 64-bit Windows:
https://your-manager-fqdn/ovirt-engine/services/files/spice/virt-viewer-x64.msi
- Open the folder where the file was saved.
- Double-click the file.
- Click Run if prompted by a security warning.
- Click Yes if prompted by User Account Control.
10.8.2. Guest Agents and Drivers
10.8.2.1. Red Hat Enterprise Virtualization Guest Agents and Drivers
Table 10.16. Red Hat Enterprise Virtualization Guest Drivers
|
Driver
|
Description
|
Works on
|
|---|---|---|
virtio-net
|
Paravirtualized network driver provides enhanced performance over emulated devices like rtl.
|
Server and Desktop.
|
virtio-block
|
Paravirtualized HDD driver offers increased I/O performance over emulated devices like IDE by optimizing the coordination and communication between the guest and the hypervisor. The driver complements the software implementation of the virtio-device used by the host to play the role of a hardware device.
|
Server and Desktop.
|
virtio-scsi
|
Paravirtualized iSCSI HDD driver offers similar functionality to the virtio-block device, with some additional enhancements. In particular, this driver supports adding hundreds of devices, and names devices using the standard SCSI device naming scheme.
|
Server and Desktop.
|
virtio-serial
|
Virtio-serial provides support for multiple serial ports. The improved performance is used for fast communication between the guest and the host that avoids network complications. This fast communication is required for the guest agents and for other features such as clipboard copy-paste between the guest and the host and logging.
|
Server and Desktop.
|
virtio-balloon
|
Virtio-balloon is used to control the amount of memory a guest actually accesses. It offers improved memory over-commitment. The balloon drivers are installed for future compatibility but not used by default in Red Hat Enterprise Virtualization 3.1 or higher.
|
Server and Desktop.
|
qxl
|
A paravirtualized display driver reduces CPU usage on the host and provides better performance through reduced network bandwidth on most workloads.
|
Server and Desktop.
|
Table 10.17. Red Hat Enterprise Virtualization Guest Agents and Tools
|
Guest agent/tool
|
Description
|
Works on
|
|---|---|---|
rhevm-guest-agent-common
|
Allows the Red Hat Enterprise Virtualization Manager to receive guest internal events and information such as IP address and installed applications. Also allows the Manager to execute specific commands, such as shut down or reboot, on a guest.
On Red Hat Enterprise Linux 6 and higher guests, the rhevm-guest-agent-common installs tuned on your virtual machine and configures it to use an optimized, virtualized-guest profile.
|
Server and Desktop.
|
spice-agent
|
The SPICE agent supports multiple monitors and is responsible for client-mouse-mode support to provide a better user experience and improved responsiveness than the QEMU emulation. Cursor capture is not needed in client-mouse-mode. The SPICE agent reduces bandwidth usage when used over a wide area network by reducing the display level, including color depth, disabling wallpaper, font smoothing, and animation. The SPICE agent enables clipboard support allowing cut and paste operations for both text and images between client and guest, and automatic guest display setting according to client-side settings. On Windows guests, the SPICE agent consists of vdservice and vdagent.
|
Server and Desktop.
|
rhev-sso
|
An agent that enables users to automatically log in to their virtual machines based on the credentials used to access the Red Hat Enterprise Virtualization Manager.
|
Desktop.
|
rhev-usb
|
A component that contains drivers and services for Legacy USB support (version 3.0 and earlier) on guests. It is needed for accessing a USB device that is plugged into the client machine.
RHEV-USB Client is needed on the client side.
|
Desktop.
|
10.8.2.2. Installing the Guest Agents and Drivers on Red Hat Enterprise Linux
Procedure 10.27. Installing the Guest Agents and Drivers on Red Hat Enterprise Linux
- Log in to the Red Hat Enterprise Linux virtual machine.
- Enable the Red Hat Enterprise Virtualization Agent repository:
- For Red Hat Enterprise Linux 6
# subscription-manager repos --enable=rhel-6-server-rhev-agent-rpms
- For Red Hat Enterprise Linux 7
# subscription-manager repos --enable=rhel-7-server-rh-common-rpms
- Install the rhevm-guest-agent-common package and dependencies:
# yum install rhevm-guest-agent-common
- Start and enable the service:
- For Red Hat Enterprise Linux 6
# service ovirt-guest-agent start # chkconfig ovirt-guest-agent on
- For Red Hat Enterprise Linux 7
# systemctl start ovirt-guest-agent.service # systemctl enable ovirt-guest-agent.service
ovirt-guest-agent that you can configure via the ovirt-guest-agent.conf configuration file in the /etc/ directory.
10.8.2.3. Installing the Guest Agents and Drivers on Windows
rhev-tools-setup.iso ISO file, which is provided by the rhev-guest-tools-iso package installed as a dependency to the Red Hat Enterprise Virtualization Manager. This ISO file is located in /usr/share/rhev-guest-tools-iso/rhev-tools-setup.iso on the system on which the Red Hat Enterprise Virtualization Manager is installed.
Note
rhev-tools-setup.iso ISO file is automatically copied to the default ISO storage domain, if any, when you run engine-setup, or must be manually uploaded to an ISO storage domain.
Note
rhev-tools-setup.iso ISO file must be manually attached to running Windows virtual machines to install updated versions of the tools and drivers. If the APT service is enabled on virtual machines, the updated ISO files will be automatically attached.
Note
ISSILENTMODE and ISNOREBOOT to RHEV-toolsSetup.exe to silently install the guest agents and drivers and prevent the machine on which they have been installed from rebooting immediately after installation. The machine can then be rebooted later once the deployment process is complete.
D:\RHEV-toolsSetup.exe ISSILENTMODE ISNOREBOOT
Procedure 10.28. Installing the Guest Agents and Drivers on Windows
- Log in to the virtual machine.
- Select the CD Drive containing the
rhev-tools-setup.isofile. - Double-click RHEV-toolsSetup.
- Click at the welcome screen.
- Follow the prompts on the RHEV-Tools InstallShield Wizard window. Ensure all check boxes in the list of components are selected.
- Once installation is complete, select
Yes, I want to restart my computer nowand click to apply the changes.
RHEV Agent that you can configure using the rhev-agent configuration file located in C:\Program Files\Redhat\RHEV\Drivers\Agent.
10.8.2.4. Updating the Guest Agents and Drivers on Red Hat Enterprise Linux
Procedure 10.29. Updating the Guest Agents and Drivers on Red Hat Enterprise Linux
- Log in to the Red Hat Enterprise Linux virtual machine.
- Update the rhevm-guest-agent-common package:
# yum update rhevm-guest-agent-common
- Restart the service:
- For Red Hat Enterprise Linux 6
# service ovirt-guest-agent restart
- For Red Hat Enterprise Linux 7
# systemctl restart ovirt-guest-agent.service
10.8.2.5. Updating the Guest Agents and Drivers on Windows
Procedure 10.30. Updating the Guest Agents and Drivers on Windows
- On the Red Hat Enterprise Virtualization Manager, update the Red Hat Enterprise Virtualization Guest Tools to the latest version:
# yum update -y rhev-guest-tools-iso*
- Upload the ISO file to your ISO domain, replacing [ISODomain] with the name of your ISO domain:
engine-iso-uploader --iso-domain=[ISODomain] upload /usr/share/rhev-guest-tools-iso/rhev-tools-setup.iso
Note
Therhev-tools-setup.isofile is a symbolic link to the most recently updated ISO file. The link is automatically changed to point to the newest ISO file every time you update the rhev-guest-tools-iso package. - In the Administration or User Portal, if the virtual machine is running, use the Change CD button to attach the latest
rhev-tools-setup.isofile to each of your virtual machines. If the virtual machine is powered off, click the Run Once button and attach the ISO as a CD. - Select the CD Drive containing the updated ISO and execute the
RHEV-ToolsSetup.exefile.
10.8.2.6. Automating Guest Additions on Windows Guests with Red Hat Enterprise Virtualization Application Provisioning Tool(APT)
rhev-tools-setup.iso ISO file to the virtual machine.
Procedure 10.31. Installing the APT Service on Windows
- Log in to the virtual machine.
- Select the CD Drive containing the
rhev-tools-setup.isofile. - Double-click RHEV-Application Provisioning Tool.
- Click in the User Account Control window.
- Once installation is complete, ensure the
Start RHEV-apt Servicecheck box is selected in the RHEV-Application Provisioning Tool InstallShield Wizard window, and click to apply the changes.
Note
Start RHEV-apt Service check box. You can stop, start, or restart the service at any time using the Services window.
10.8.3. Subscribing to Channels
10.8.3.1. Subscribing to the Required Entitlements
Procedure 10.32. Subscribing to the Required Entitlements Using Subscription Manager
- Register your system with the Content Delivery Network, entering your Customer Portal user name and password when prompted:
# subscription-manager register
- Locate the relevant subscription pools and note down the pool identifiers.
# subscription-manager list --available
- Use the pool identifiers located in the previous step to attach the required entitlements.
# subscription-manager attach --pool=pool_id
- Disable all existing repositories:
# subscription-manager repos --disable=*
- When a system is subscribed to a subscription pool with multiple repositories, only the main repository is enabled by default. Others are available, but disabled. Enable any additional repositories:
# subscription-manager repos --enable=repository
- Ensure that all packages currently installed are up to date:
# yum update
10.8.4. Accessing Virtual machines
10.8.4.1. Starting a Virtual Machine
Procedure 10.33. Starting a Virtual Machine
- Click the Virtual Machines tab and select a virtual machine with a status of
Down. - Click the run (
) button.
Alternatively, right-click the virtual machine and select .
Up, and the console protocol of the selected virtual machine is displayed. If the guest agent is installed on the virtual machine, the IP address of that virtual machine is also displayed.
10.8.4.2. Opening a Console to a Virtual Machine
Procedure 10.34. Connecting to a Virtual Machine
- Install Remote Viewer if it is not already installed. See Installing Console Components
- Click the Virtual Machines tab and select a virtual machine.
- Click the console button or right-click the virtual machine and select Console.
- If the connection protocol is set to SPICE, a console window will automatically open for the virtual machine.
- If the connection protocol is set to VNC, a
console.vvfile will be downloaded. Click on the file and a console window will automatically open for the virtual machine.
10.8.4.3. Shutting Down a Virtual Machine
Procedure 10.35. Shutting Down a Virtual Machine
- Click the Virtual Machines tab and select a running virtual machine.
- Click the shut down (
) button.
Alternatively, right-click the virtual machine and select Shutdown.
Down.
10.8.4.4. Pausing a Virtual Machine
Procedure 10.36. Pausing a Virtual Machine
- Click the Virtual Machines tab and select a running virtual machine.
- Click the Suspend (
) button.
Alternatively, right-click the virtual machine and select Suspend.
Paused.
10.8.4.5. Rebooting a Virtual Machine
Procedure 10.37. Rebooting a Virtual Machine
- Click the Virtual Machines tab and select a running virtual machine.
- Click the Reboot (
) button.
Alternatively, right-click the virtual machine and select Reboot. - Click in the Reboot Virtual Machine(s) confirmation window.
Reboot In Progress before returning to Up.
10.8.5. Console Options
10.8.5.1. Introduction to Connection Protocols
Note
10.8.5.2. Accessing Console Options
Procedure 10.38. Accessing Console Options
- Select a running virtual machine.
- Right-click the virtual machine and select Console Options to open the Console Options window.
Note
10.8.5.3. SPICE Console Options
Console Invocation
- Auto: The Manager automatically selects the method for invoking the console.
- Native client: When you connect to the console of the virtual machine, a file download dialog provides you with a file that opens a console to the virtual machine via Remote Viewer.
- Browser plugin: When you connect to the console of the virtual machine, you are connected directly via Remote Viewer.
- SPICE HTML5 browser client (Tech preview): When you connect to the console of the virtual machine, a browser tab is opened that acts as the console.
SPICE Options
- Map control-alt-del shortcut to ctrl+alt+end: Select this check box to map the Ctrl+Alt+Del key combination to Ctrl+Alt+End inside the virtual machine.
- Enable USB Auto-Share: Select this check box to automatically redirect USB devices to the virtual machine. If this option is not selected, USB devices will connect to the client machine instead of the guest virtual machine. To use the USB device on the guest machine, manually enable it in the SPICE client menu.
- Open in Full Screen: Select this check box for the virtual machine console to automatically open in full screen when you connect to the virtual machine. Press SHIFT+F11 to toggle full screen mode on or off.
- Enable SPICE Proxy: Select this check box to enable the SPICE proxy.
- Enable WAN options: Select this check box to set the parameters
WANDisableEffectsandWANColorDepthtoanimationand16bits respectively on Windows virtual machines. Bandwidth in WAN environments is limited and this option prevents certain Windows settings from consuming too much bandwidth.
Important
SpiceX.cab installation program. For all other browsers, the Native client console option is the default. This console option uses the version of Remote Viewer provided by the virt-viewer-x86.msi and virt-viewer-x64.msi installation files.
10.8.5.4. VNC Console Options
Console Invocation
- Native Client: When you connect to the console of the virtual machine, a file download dialog provides you with a file that opens a console to the virtual machine via Remote Viewer.
- noVNC: When you connect to the console of the virtual machine, a browser tab is opened that acts as the console.
VNC Options
- Map control-alt-delete shortcut to ctrl+alt+end: Select this check box to map the Ctrl+Alt+Del key combination to Ctrl+Alt+End inside the virtual machine.
10.8.5.5. RDP Console Options
Console Invocation
- Auto: The Manager automatically selects the method for invoking the console.
- Native client: When you connect to the console of the virtual machine, a file download dialog provides you with a file that opens a console to the virtual machine via Remote Desktop.
RDP Options
- Use Local Drives: Select this check box to make the drives on the client machine accessible on the guest virtual machine.
10.8.6. Remote Viewer Options
10.8.6.1. Remote Viewer Options
Table 10.18. Remote Viewer Options
| Option | Hotkey |
|---|---|
| File |
|
| View |
|
| Send key |
|
| Help | The About entry displays the version details of Virtual Machine Viewer that you are using. |
| Release Cursor from Virtual Machine | SHIFT+F12 |
10.8.6.2. Remote Viewer Hotkeys
Note
10.9. Removing Virtual Machines
10.9.1. Removing a Virtual Machine
Important
Procedure 10.39. Removing a Virtual Machine
- Click the Virtual Machines tab and select the virtual machine to remove.
- Click to open the Remove Virtual Machine(s) window.
- Optionally, select the Remove Disk(s) check box to remove the virtual disks attached to the virtual machine together with the virtual machine. If the Remove Disk(s) check box is cleared, then the virtual disks remain in the environment as floating disks.
- Click .
10.10. Cloning Virtual Machines
10.10.1. Cloning a Virtual Machine
Important
Procedure 10.40. Cloning a Virtual Machine
- Click the Virtual Machines tab and select the virtual machine to clone.
- Click the button to open the Clone Virtual Machine window.
- Enter a name for the new virtual machine.
- Click .
10.11. Virtual Machines and Permissions
10.11.1. Managing System Permissions for a Virtual Machine
- Create, edit, and remove virtual machines.
- Run, suspend, shutdown, and stop virtual machines.
Note
10.11.2. Virtual Machines Administrator Roles Explained
Table 10.19. Red Hat Enterprise Virtualization System Administrator Roles
| Role | Privileges | Notes |
|---|---|---|
| DataCenterAdmin | Data Center Administrator | Possesses administrative permissions for all objects underneath a specific data center except for storage. |
| ClusterAdmin | Cluster Administrator | Possesses administrative permissions for all objects underneath a specific cluster. |
| NetworkAdmin | Network Administrator | Possesses administrative permissions for all operations on a specific logical network. Can configure and manage networks attached to virtual machines. To configure port mirroring on a virtual machine network, apply the NetworkAdmin role on the network and the UserVmManager role on the virtual machine. |
10.11.3. Virtual Machine User Roles Explained
Table 10.20. Red Hat Enterprise Virtualization System User Roles
| Role | Privileges | Notes |
|---|---|---|
| UserRole | Can access and use virtual machines and pools. | Can log in to the User Portal and use virtual machines and pools. |
| PowerUserRole | Can create and manage virtual machines and templates. | Apply this role to a user for the whole environment with the Configure window, or for specific data centers or clusters. For example, if a PowerUserRole is applied on a data center level, the PowerUser can create virtual machines and templates in the data center. Having a PowerUserRole is equivalent to having the VmCreator, DiskCreator, and TemplateCreator roles. |
| UserVmManager | System administrator of a virtual machine. | Can manage virtual machines and create and use snapshots. A user who creates a virtual machine in the User Portal is automatically assigned the UserVmManager role on the machine. |
| UserTemplateBasedVm | Limited privileges to only use Templates. | Level of privilege to create a virtual machine by means of a template. |
| VmCreator | Can create virtual machines in the User Portal. | This role is not applied to a specific virtual machine; apply this role to a user for the whole environment with the Configure window. When applying this role to a cluster, you must also apply the DiskCreator role on an entire data center, or on specific storage domains. |
| NetworkUser | Logical network and network interface user for virtual machines. | If the Allow all users to use this Network option was selected when a logical network is created, NetworkUser permissions are assigned to all users for the logical network. Users can then attach or detach virtual machine network interfaces to or from the logical network. |
10.11.4. Assigning Virtual Machines to Users
- A User can connect to and use virtual machines. This role is suitable for desktop end users performing day-to-day tasks.
- A PowerUser can create virtual machines and view virtual resources. This role is suitable if you are an administrator or manager who needs to provide virtual resources for your employees.
- A UserVmManager can edit and remove virtual machines, assign user permissions, use snapshots and use templates. It is suitable if you need to make configuration changes to your virtual environment.
Procedure 10.41. Assigning Permissions to Users
- Click the Virtual Machines tab and select a virtual machine.
- On the details pane, select the Permissions tab.
- Click . The Add Permission to User dialog displays. Enter a Name, or User Name, or part thereof in the Search text box, and click . A list of possible matches display in the results list.
- Select the check box of the user to be assigned the permissions. Scroll through the Role to Assign list and select UserRole. Click .
- The user's name and role display in the list of users permitted to access this virtual machine.
Note
10.11.5. Removing Access to Virtual Machines from Users
Procedure 10.42. Removing Access to Virtual Machines from Users
- Click the Virtual Machines tab and select a virtual machine.
- On the details pane, select the Permissions tab.
- Click . A warning message displays, asking you to confirm removal of the selected permissions.
- To proceed, click . To abort, click .
10.12. Snapshots
10.12.1. Creating a Snapshot of a Virtual Machine
Note
Procedure 10.43. Creating a Snapshot of a Virtual Machine
- Click the Virtual Machines tab and select a virtual machine.
- Click to open the Create Snapshot window.
- Enter a description for the snapshot.
- Select Disks to include using the check boxes.
- Use the Save Memory check box to denote whether to include the virtual machine's memory in the snapshot.
- Click to create the snapshot and close the window.
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.
10.12.2. Using a Snapshot to Restore a Virtual Machine
Procedure 10.44. Using a snapshot to restore a virtual machine
- Click the Virtual Machines tab and select a virtual machine.
- Click the Snapshots tab in the details pane to list the available snapshots.
- Select a snapshot to restore in the left side-pane. The snapshot details display in the right side-pane.
- Click the drop-down list beside to open the Custom Preview Snapshot window.
- Use the check boxes to select the VM Configuration, Memory, and disk(s) you want to restore, then click . This allows you to create and restore from a customized snapshot using the configuration and disk(s) from multiple snapshots.The status of the snapshot changes to
Preview Mode. The status of the virtual machine briefly changes toImage Lockedbefore returning toDown. - Start the virtual machine; it runs using the disk image of the snapshot.
- Click Commit to permanently restore the virtual machine to the condition of the snapshot. Any subsequent snapshots are erased.Alternatively, click the Undo button to deactivate the snapshot and return the virtual machine to its previous state.
10.12.3. Creating a Virtual Machine from a Snapshot
Procedure 10.45. Creating a virtual machine from a snapshot
- Click the Virtual Machines tab and select a virtual machine.
- Click the Snapshots tab in the details pane to list the available snapshots for the virtual machines.
- Select a snapshot in the list displayed and click to open the Clone VM from Snapshot window.
- Enter the Name and Description of the virtual machine to be created.
- Click to create the virtual machine and close the window.
Image Locked. The virtual machine will remain in this state until Red Hat Enterprise Virtualization completes the creation of the virtual machine. A virtual machine with a preallocated 20 GB hard drive takes about fifteen minutes to create. Sparsely-allocated virtual disks take less time to create than do preallocated virtual disks.
Image Locked to Down in the Virtual Machines tab in the navigation pane.
10.12.4. Deleting a Snapshot
Important
- If the snapshot being deleted is contained in a RAW (preallocated) base image, a new volume is created that is the same size as the base image.
- If the snapshot being deleted is contained in a QCOW2 (thin provisioned) base image, the volume subsequent to the volume containing the snapshot being deleted is extended to the cumulative size of the successor volume and the base volume.
- If the snapshot being deleted is contained in a QCOW2 (thin provisioned), non-base image hosted on internal storage, the successor volume is extended to the cumulative size of the successor volume and the volume containing the snapshot being deleted.
Procedure 10.46. Deleting a Snapshot
- Click the Virtual Machines tab and select a virtual machine.
- Click the Snapshots tab in the details pane to list the snapshots for that virtual machine.
- Select the snapshot to delete.
- Optionally shut down the running virtual machine associated with the snapshot to be deleted.
- Click .
- Click .
10.13. Affinity Groups
10.13.1. Introduction to Virtual Machine Affinity
Note
Important
VmAffinityGroups filter module or weights module is enabled in the cluster policy applied to clusters in which affinity groups are defined. The VmAffinityGroups filter module is used to implement hard enforcement, and the VmAffinityGroups weights module is used to implement soft enforcement.
10.13.2. Creating an Affinity Group
Procedure 10.47. Creating an Affinity Group
- Click the Virtual Machines tab and select a virtual machine.
- Click the Affinity Groups tab in the details pane.
- Click the New button to open the New Affinity Group window.
- Enter a name and description for the affinity group in the Name text field and Description text field.
- Select the Positive check box to apply positive affinity, or ensure this check box is cleared to apply negative affinity.
- Select the Enforcing check box to apply hard enforcement, or ensure this check box is cleared to apply soft enforcement.
- Use the drop-down menu to select the virtual machines to be added to the affinity group. Use the + and - buttons to add or remove additional virtual machines.
- Click OK.
10.13.3. Editing an Affinity Group
Procedure 10.48. Editing an Affinity Group
- Click the Virtual Machines tab and select a virtual machine.
- Click the Affinity Groups tab in the details pane.
- Click the Edit button to open the Edit Affinity Group window.
- Change the Positive and Enforcing check boxes to the preferred values and use the + and - buttons to add or remove virtual machines to or from the affinity group.
- Click OK.
10.13.4. Removing an Affinity Group
Procedure 10.49. Removing an Affinity Group
- Click the Virtual Machines tab and select a virtual machine.
- Click the Affinity Groups tab in the details pane.
- Click the Remove button and click OK when prompted to remove the affinity group.
10.14. Exporting and Importing Virtual Machines and Templates
- Export the virtual machine or template to an export domain.
- Detach the export domain from one data center, and attach it to another. You can attach it to a different data center in the same Red Hat Enterprise Virtualization environment, or attach it to a data center in a separate Red Hat Enterprise Virtualization environment that is managed by another installation of the Red Hat Enterprise Virtualization Manager.
Note
An export domain can only be active in one data center at a given time. This means that the export domain must be attached to either the source data center or the destination data center. - Import the virtual machine or template into the data center to which the export domain is attached.
10.14.1. Graphical Overview for Exporting and Importing Virtual Machines and Templates
Procedure 10.50. Exporting and Importing Virtual Machines and Templates
- Attach the export domain to the source data center.
- Export the virtual machine or template to the export domain.
- Detach the export domain from the source data center.
- Attach the export domain to the destination data center.
- Import the virtual machine or template into the destination data center.
10.14.2. Exporting a Virtual Machine to the Export Domain
Procedure 10.51. Exporting a Virtual Machine to the Export Domain
- Click the Virtual Machines tab and select a virtual machine.
- Click to open the Export Virtual Machine window.
- Optionally select the following check boxes:
- Force Override: overrides existing images of the virtual machine on the export domain.
- Collapse Snapshots: creates a single export volume per disk. This option removes snapshot restore points and includes the template in a template-based virtual machine, and removes any dependencies a virtual machine has on a template. For a virtual machine that is dependent on a template, either select this option, export the template with the virtual machine, or make sure the template exists in the destination data center.
Note
When you create a virtual machine from a template, two storage allocation options are available under → → .- If Clone was selected, the virtual machine is not dependent on the template. The template does not have to exist in the destination data center.
- If Thin was selected, the virtual machine is dependent on the template, so the template must exist in the destination data center or be exported with the virtual machine. Alternatively, select the Collapse Snapshots check box to collapse the template disk and virtual machine disk into a single disk.
To check which option was selected, select a virtual machine and click the General tab in the details pane.
- Click to export the virtual machine and close the window.
Image Locked status while it is exported. Depending on the size of your virtual machine hard disk images, and your storage hardware, this can take up to an hour. Use the Events tab to view the progress. When complete, the virtual machine has been exported to the export domain and displays on the VM Import tab of the export domain's details pane.
10.14.3. Importing a Virtual Machine into the Destination Data Center
Procedure 10.52. Importing a Virtual Machine into the Destination Data Center
- Click the Storage tab, and select the export domain in the results list. The export domain must have a status of
Active. - Select the VM Import tab in the details pane to list the available virtual machines to import.
- Select one or more virtual machines to import and click .
- Select the Default Storage Domain and Cluster.
- Select the Collapse Snapshots check box to remove snapshot restore points and include templates in template-based virtual machines.
- Click the virtual machine to be imported and click on the Disks sub-tab. From this tab, you can use the Allocation Policy and Storage Domain drop-down lists to select whether the disk used by the virtual machine will be thinly provisioned or preallocated, and can also select the storage domain on which the disk will be stored. An icon is also displayed to indicate which of the disks to be imported acts as the boot disk for that virtual machine.
- Click to import the virtual machines.The Import Virtual Machine Conflict window opens if the virtual machine exists in the virtualized environment.
- Choose one of the following radio buttons:
- Don't import
- Import as cloned and enter a unique name for the virtual machine in the New Name field.
- Optionally select the Apply to all check box to import all duplicated virtual machines with the same suffix, and then enter a suffix in the Suffix to add to the cloned VMs field.
- Click OK.
Important
10.15. Migrating Virtual Machines Between Hosts
- 10.15.1. What is Live Migration?
- 10.15.2. Live Migration Prerequisites
- 10.15.3. Automatic Virtual Machine Migration
- 10.15.4. Preventing Automatic Migration of a Virtual Machine
- 10.15.5. Manually Migrating Virtual Machines
- 10.15.6. Setting Migration Priority
- 10.15.7. Canceling Ongoing Virtual Machine Migrations
- 10.15.8. Event and Log Notification upon Automatic Migration of Highly Available Virtual Servers
10.15.1. What is Live Migration?
10.15.2. Live Migration Prerequisites
- The source and destination host should both be members of the same cluster, ensuring CPU compatibility between them.
Note
Live migrating virtual machines between different clusters is generally not recommended. The currently only supported use case is documented at https://access.redhat.com/articles/1390733. - The source and destination host must have a status of
Up. - The source and destination host must have access to the same virtual networks and VLANs.
- The source and destination host must have access to the data storage domain on which the virtual machine resides.
- There must be enough CPU capacity on the destination host to support the virtual machine's requirements.
- There must be enough RAM on the destination host that is not in use to support the virtual machine's requirements.
- The migrating virtual machine must not have the
cache!=nonecustom property set.
10.15.3. Automatic Virtual Machine Migration
10.15.4. Preventing Automatic Migration of a Virtual Machine
Procedure 10.53. Preventing automatic migration of a virtual machine
- Click the Virtual Machines tab and select a virtual machine.
- Click Edit to open the Edit Virtual Machine window.
- Click the Host tab.
- Use the Start Running On radio buttons to designate the virtual machine to run on Any Host in Cluster or a Specific host. If applicable, select a specific host from the drop-down menu.
Warning
Explicitly assigning a virtual machine to a specific host and disabling migration is mutually exclusive with Red Hat Enterprise Virtualization high availability. Virtual machines that are assigned to a specific host can only be made highly available using third party high availability products like Red Hat High Availability. - Use the drop-down menu to affect the Migration Options. Select Do not allow migration to enable the Pass-Through Host CPU check box.
- If applicable, enter relevant CPU Pinning topology commands in the text field.
- Click to save the changes and close the window.
10.15.5. Manually Migrating Virtual Machines
Note
Note
Procedure 10.54. Manually Migrating Virtual Machines
- Click the Virtual Machines tab and select a running virtual machine.
- Click to open the Migrate Virtual Machine(s) window.
- Use the radio buttons to select whether to Select Host Automatically or to Select Destination Host, specifying the host using the drop-down list.
Note
When the Select Host Automatically option is selected, the system determines the host to which the virtual machine is migrated according to the load balancing and power management rules set up in the cluster policy. - Click to commence migration and close the window.
10.15.6. Setting Migration Priority
Procedure 10.55. Setting Migration Priority
- Click the Virtual Machines tab and select a virtual machine.
- Click to open the Edit Virtual Machine window.
- Select the High Availability tab.
- Use the radio buttons to set the Priority for Run/Migrate Queue of the virtual machine to one of Low, Medium, or High.
- Click to save changes and close the window.
10.15.7. Canceling Ongoing Virtual Machine Migrations
Procedure 10.56. Canceling Ongoing Virtual Machine Migrations
- Select the migrating virtual machine. It is displayed in the Virtual Machines resource tab with a status of Migrating from.
- Click the button at the top of the results list. Alternatively, right-click on the virtual machine and select Cancel Migration from the context menu.
10.15.8. Event and Log Notification upon Automatic Migration of Highly Available Virtual Servers
Example 10.1. Notification in the Events Tab of the Web Admin Portal
Example 10.2. Notification in the Manager engine.log
/var/log/ovirt-engine/engine.log:
10.16. Improving Uptime with Virtual Machine High Availability
10.16.1. Why Use High Availability?
- When a host becomes non-operational due to hardware failure.
- When a host is put into maintenance mode for scheduled downtime.
- When a host becomes unavailable because it has lost communication with an external storage resource.
10.16.2. What is High Availability?
10.16.3. High Availability Considerations
- Power management must be configured for the hosts running the highly available virtual machines.
- The host running the highly available virtual machine must be part of a cluster which has other available hosts.
- The destination host must be running.
- The source and destination host must have access to the data domain on which the virtual machine resides.
- The source and destination host must have access to the same virtual networks and VLANs.
- There must be enough CPUs on the destination host that are not in use to support the virtual machine's requirements.
- There must be enough RAM on the destination host that is not in use to support the virtual machine's requirements.
10.16.4. Configuring a Highly Available Virtual Machine
Procedure 10.57. Configuring a Highly Available Virtual Machine
- Click the Virtual Machines tab and select a virtual machine.
- Click to open the Edit Virtual Machine window.
- Click the High Availability tab.
- Select the Highly Available check box to enable high availability for the virtual machine.
- Use the radio buttons to set the Priority for Run/Migrate Queue of the virtual machine to one of Low, Medium, or High. When migration is triggered, a queue is created in which the high priority virtual machines are migrated first. If a cluster is running low on resources, only the high priority virtual machines are migrated.
- Click .
10.17. Other Virtual Machine Tasks
10.17.1. Enabling SAP monitoring for a virtual machine from the Administration Portal
Procedure 10.58. Enabling SAP monitoring for a Virtual Machine from the Administration Portal
- Click the Virtual Machines tab and select a virtual machine.
- Click button to open the Edit Virtual Machine window.
- Select the Custom Properties tab.
- Use the drop-down menu to select
sap_agent. Ensure the secondary drop-down menu is set to True.If previous properties have been set, select the plus sign to add a new property rule and selectsap_agent. - Click to save changes and close the window.
10.17.2. Configuring Red Hat Enterprise Linux 5.4 or Higher Virtual Machines to use SPICE
10.17.2.1. Using SPICE on virtual machines running versions of Red Hat Enterprise Linux released prior to 5.4
Note
10.17.2.2. Installing QXL drivers on virtual machines
Procedure 10.59. Installing QXL drivers on a virtual machine
- Log in to a Red Hat Enterprise Linux virtual machine.
- Open a terminal.
- Run the following command as root:
#
yum install xorg-x11-drv-qxl
10.17.2.3. Configuring QXL drivers on virtual machines
Note
Procedure 10.60. Configuring QXL drivers in GNOME
- Click System.
- Click Administration.
- Click Display.
- Click the Hardware tab.
- Click Video Cards Configure.
- Select qxl and click OK.
- Restart X-Windows by logging out of the virtual machine and logging back in.
Procedure 10.61. Configuring QXL drivers on the command line:
- Back up
/etc/X11/xorg.conf:#
cp /etc/X11/xorg.conf /etc/X11/xorg.conf.$$.backup - Make the following change to the Device section of
/etc/X11/xorg.conf:Section "Device" Identifier "Videocard0" Driver "qxl" Endsection
10.17.2.4. Configuring a virtual machine's tablet and mouse to use SPICE
/etc/X11/xorg.conf file to enable SPICE for your virtual machine's tablet devices.
Procedure 10.62. Configuring a virtual machine's tablet and mouse to use SPICE
- Verify that the tablet device is available on your guest:
#
If there is no output from the command, do not continue configuring the tablet./sbin/lsusb -v | grep 'QEMU USB Tablet' - Back up
/etc/X11/xorg.confby running this command:#
cp /etc/X11/xorg.conf /etc/X11/xorg.conf.$$.backup - Make the following changes to /etc/X11/xorg.conf:
Section "ServerLayout" Identifier "single head configuration" Screen 0 "Screen0" 0 0 InputDevice "Keyboard0" "CoreKeyboard" InputDevice "Tablet" "SendCoreEvents" InputDevice "Mouse" "CorePointer" EndSection Section "InputDevice" Identifier "Mouse" Driver "void" #Option "Device" "/dev/input/mice" #Option "Emulate3Buttons" "yes" EndSection Section "InputDevice" Identifier "Tablet" Driver "evdev" Option "Device" "/dev/input/event2" Option "CorePointer" "true" EndSection
- Log out and log back into the virtual machine to restart X-Windows.
10.17.3. KVM virtual machine timing management
pvclock provides a stable source of timing for KVM guests that support it.
- 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.
Important
ntpd service:
# service ntpd start
# chkconfig ntpd on
ntpd service should minimize the affects of clock skew in all cases.
constant_tsc flag is present. To determine if your CPU has the constant_tsc flag run the following command:
$ cat /proc/cpuinfo | grep constant_tsc
constant_tsc bit. If no output is given follow the instructions below.
Important
constant_tsc bit, disable all power management features (BZ#513138). Each system has several timers it uses to keep time. The TSC is not stable on the host, which is sometimes caused by cpufreq changes, deep C state, or migration to a host with a faster TSC. Deep C sleep states can stop the TSC. To prevent the kernel using deep C states append "processor.max_cstate=1" to the kernel boot options in the grub.conf file on the host:
term Red Hat Enterprise Linux Server (2.6.18-159.el5)
root (hd0,0)
kernel /vmlinuz-2.6.18-159.el5 ro root=/dev/VolGroup00/LogVol00 rhgb quiet processor.max_cstate=1cpufreq (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.
engine-config tool to receive alerts when hosts drift out of sync.engine-config tool to configure alerts when your hosts drift out of sync.
EnableHostTimeDrift and HostTimeDriftInSec. EnableHostTimeDrift, with a default value of false, can be enabled to receive alert notifications of host time drift. The HostTimeDriftInSec parameter is used to set the maximum allowable drift before alerts start being sent.
Note
ktune package
ktune package provides an interactive Bourne shell script, fix_clock_drift.sh. When run as the superuser, this script inspects various system parameters to determine if the virtual machine on which it is run is susceptible to clock drift under load. If so, it then creates a new grub.conf.kvm file in the /boot/grub/ directory. This file contains a kernel boot line with additional kernel parameters that allow the kernel to account for and prevent significant clock drift on the KVM virtual machine. After running fix_clock_drift.sh as the superuser, and once the script has created the grub.conf.kvm file, then the virtual machine's current grub.conf file should be backed up manually by the system administrator, the new grub.conf.kvm file should be manually inspected to ensure that it is identical to grub.conf with the exception of the additional boot line parameters, the grub.conf.kvm file should finally be renamed grub.conf, and the virtual machine should be rebooted.
| Red Hat Enterprise Linux | Additional virtual machine kernel parameters |
|---|---|
| 5.4 AMD64/Intel 64 with the paravirtualized clock | Additional parameters are not required |
| 5.4 AMD64/Intel 64 without the paravirtualized clock | notsc lpj=n |
| 5.4 x86 with the paravirtualized clock | Additional parameters are not required |
| 5.4 x86 without the paravirtualized clock | clocksource=acpi_pm lpj=n |
| 5.3 AMD64/Intel 64 | notsc |
| 5.3 x86 | clocksource=acpi_pm |
| 4.8 AMD64/Intel 64 | notsc |
| 4.8 x86 | clock=pmtmr |
| 3.9 AMD64/Intel 64 | Additional parameters are not required |
| 3.9 x86 | Additional parameters are not required |
boot.ini file:
/use pmtimer
10.17.4. Monitoring Virtual Machine Login Activity Using the Sessions Tab
Procedure 10.63. Monitoring a virtual machine's activity
- Select a virtual machine with any of the following tabs or modes: the Virtual Machines resource tab, Tree mode, or Search function.
- Select the Sessions tab in the details pane to display Logged-in User, Console User, and Console Client IP.
Chapter 11. Templates
11.1. Introduction to Templates
11.2. Sealing Virtual Machines in Preparation for Deployment as Templates
11.2.1. Sealing a Linux Virtual Machine for Deployment as a Template
sys-unconfig command. Sealing a Linux virtual machine manually requires you to create a file on the virtual machine that acts as a flag for initiating various configuration tasks the next time you start that virtual machine. The sys-unconfig command allows you to automate this process. However, both of these methods also require you to manually delete files on the virtual machine that are specific to that virtual machine or might cause conflicts amongst virtual machines created based on the template you will create based on that virtual machine. As such, both are valid methods for sealing a Linux virtual machine and will achieve the same result.
11.2.1.1. Sealing a Linux Virtual Machine Manually for Deployment as a Template
Procedure 11.1. Sealing a Linux Virtual Machine
- Log in to the virtual machine.
- Flag the system for re-configuration by running the following command as root:
# touch /.unconfigured
- Run the following command to remove ssh host keys:
# rm -rf /etc/ssh/ssh_host_*
- Set
HOSTNAME=localhost.localdomainin/etc/sysconfig/networkfor Red Hat Enterprise Linux 6 or/etc/hostnamefor Red Hat Enterprise Linux 7. - Run the following command to remove
/etc/udev/rules.d/70-*:# rm -rf /etc/udev/rules.d/70-*
- Remove the
HWADDRline andUUIDline from/etc/sysconfig/network-scripts/ifcfg-eth*. - Optionally, delete all the logs from
/var/logand build logs from/root. - Run the following command to shut down the virtual machine:
# poweroff
Note
11.2.1.2. Sealing a Linux Virtual Machine for Deployment as a Template using sys-unconfig
Procedure 11.2. Sealing a Linux Virtual Machine using sys-unconfig
- Log in to the virtual machine.
- Run the following command to remove ssh host keys:
# rm -rf /etc/ssh/ssh_host_*
- Set
HOSTNAME=localhost.localdomainin/etc/sysconfig/networkfor Red Hat Enterprise Linux 6 or/etc/hostnamefor Red Hat Enterprise Linux 7. - Remove the
HWADDRline andUUIDline from/etc/sysconfig/network-scripts/ifcfg-eth*. - Optionally, delete all the logs from
/var/logand build logs from/root. - Run the following command:
# sys-unconfig
11.2.2. Sealing a Windows Virtual Machine for Deployment as a Template
Important
- The Windows Sysprep parameters have been correctly defined.If not, click and enter the required information in the Operating System and Domain fields.
- The correct product key has been defined in an override file on the Manager.The override file needs to be created under
/etc/ovirt-engine/osinfo.conf.d/, have a filename that puts it after/etc/ovirt-engine/osinfo.conf.d/00-defaults.properties, and end in.properties. For example,/etc/ovirt-engine/osinfo.conf.d/10-productkeys.properties. The last file will have precedent and override any other previous file.If not, copy the default values for your Windows operating system from/etc/ovirt-engine/osinfo.conf.d/00-defaults.propertiesinto the override file, and input your values in theproductKey.valueandsysprepPath.valuefields.Example 11.1. Windows 7 Default Configuration Values
# Windows7(11, OsType.Windows, false),false os.windows_7.id.value = 11 os.windows_7.name.value = Windows 7 os.windows_7.derivedFrom.value = windows_xp os.windows_7.sysprepPath.value = ${ENGINE_USR}/conf/sysprep/sysprep.w7 os.windows_7.productKey.value = os.windows_7.devices.audio.value = ich6 os.windows_7.devices.diskInterfaces.value.3.3 = IDE, VirtIO_SCSI, VirtIO os.windows_7.devices.diskInterfaces.value.3.4 = IDE, VirtIO_SCSI, VirtIO os.windows_7.devices.diskInterfaces.value.3.5 = IDE, VirtIO_SCSI, VirtIO os.windows_7.isTimezoneTypeInteger.value = false
11.2.2.1. Sealing a Windows XP Template
Note
Procedure 11.3. Sealing a Windows XP Template
- Download
sysprepto the virtual machine to be used as a template.The Windows XP Sysprep tool is available at http://www.microsoft.com/download/en/details.aspx?id=11282 - Create a new directory:
c:\sysprep. - Open the
deploy.cabfile and add its contents toc:\sysprep. - Execute
sysprep.exefrom within the folder and click on the welcome message to display the Sysprep tool. - Select the following check boxes:
- Don't reset grace period for activation
- Use Mini-Setup
- Ensure that the shutdown mode is set to
Shut downand click . - Acknowledge the pop-up window to complete the sealing process; the virtual machine shuts down automatically upon completion.
11.2.2.2. Sealing a Windows 7, Windows 2008, or Windows 2012 Template
Procedure 11.4. Sealing a Windows 7, Windows 2008, or Windows 2012 Template
- Launch Sysprep from
C:\Windows\System32\sysprep\sysprep.exe. - Enter the following information into the Sysprep tool:
- Under System Cleanup Action, select Enter System Out-of-Box-Experience (OOBE).
- Select the Generalize check box if you need to change the computer's system identification number (SID).
- Under Shutdown Options, select Shutdown.
Click to complete the sealing process; the virtual machine shuts down automatically upon completion.
11.2.3. Using Cloud-Init to Automate the Configuration of Virtual Machines
11.2.3.1. Cloud-Init Use Case Scenarios
- Virtual Machines Created Based on Templates
- You can use the Cloud-Init options in the Initial Run section of the Run Once window to initialize a virtual machine that was created based on a template. This allows you to customize the virtual machine the first time that virtual machine is started.
- Virtual Machine Templates
- You can use the Use Cloud-Init/Sysprep options in the Initial Run tab of the New Template and Edit Template windows to specify options for customizing virtual machines created based on that template.
- Virtual Machine Pools
- You can use the Use Cloud-Init/Sysprep options in the Initial Run tab of the New Pool window to specify options for customizing virtual machines taken from that virtual machine pool. This allows you to specify a set of standard settings that will be applied every time a virtual machine is taken from that virtual machine pool. You can inherit or override the options specified for the template on which the virtual machine is based, or specify options for the virtual machine pool itself.
11.2.3.2. Installing Cloud-Init
Procedure 11.5. Installing Cloud-Init
- Log on to the virtual machine.
- Enable the Red Hat Common repository.
# subscription-manager repos --enable=rhel-6-server-rh-common-rpms
- Install the cloud-init package and dependencies:
# yum install cloud-init
11.2.3.3. Using Cloud-Init to Initialize a Virtual Machine
Procedure 11.6. Using Cloud-Init to Initialize a Virtual Machine
- Click the Virtual Machines tab and select a virtual machine.
- Click to open the Run Virtual Machine(s) window.
- Expand the Initial Run section and select the Cloud-Init check box.
- Enter a host name in the VM Hostname text field.
- Select the Configure Time Zone check box and select a time zone from the Time Zone drop-down menu.
- Select the Use already configured password check box to use the existing credentials, or clear that check box and enter a root password in the Password and Verify Password text fields to specify a new root password.
- Enter any SSH keys to be added to the authorized hosts file on the virtual machine in the SSH Authorized Keys text area.
- Select the Regenerate SSH Keys check box to regenerate SSH keys for the virtual machine.
- Enter any DNS servers in the DNS Servers text field.
- Enter any DNS search domains in the DNS Search Domains text field.
- Select the Network check box and use the + and - buttons to add or remove network interfaces to or from the virtual machine.
- Enter any custom scripts in the Custom Script text area.
- Click .
Important
11.2.3.4. Using Cloud-Init to Prepare a Template
Note
Procedure 11.7. Using Cloud-Init to Prepare a Template
- Click the Virtual Machines tab and select a virtual machine.
- Click to open the Edit Virtual Machine window.
- Click the Initial Run tab and select the Use Cloud-Init/Sysprep check box.
- Enter a host name in the VM Hostname text field.
- Select the Configure Time Zone check box and select a time zone from the Time Zone drop-down menu.
- Expand the Authentication section and select the Use already configured password check box to user the existing credentials, or clear that check box and enter a root password in the Password and Verify Password text fields to specify a new root password.
- Enter any SSH keys to be added to the authorized hosts file on the virtual machine in the SSH Authorized Keys text area.
- Select the Regenerate SSH Keys check box to regenerate SSH keys for the virtual machine.
- Expand the Networks section and enter any DNS servers in the DNS Servers text field.
- Enter any DNS search domains in the DNS Search Domains text field.
- Select the Network check box and use the and buttons to add or remove network interfaces to or from the virtual machine.
- Expand the Custom Script section and enter any custom scripts in the Custom Script text area.
- Click .
Important
11.3. Template Tasks
11.3.1. Creating a Template
Important
Procedure 11.8. Creating a Template
- Click the Virtual Machines tab.
- Select the source virtual machine.
- Ensure the virtual machine is powered down and has a status of
Down. - Click .
- Enter a Name, Description, and Comment for the template.
- Select the cluster with which to associate the template from the Cluster list. By default, this is the same as that of the source virtual machine.
- Optionally, select a CPU profile for the template from the CPU Profile list.
- Optionally, select the Create as a Sub Template version check box, select a Root Template, and enter a Sub Version Name to create the new template as a sub template of an existing template.
- In the Disks Allocation section, enter an alias for the disk in the Alias text field, and select the storage domain on which to store the disk from the Target list. By default, these are the same as those of the source virtual machine.
- Select the Allow all users to access this Template check box to make the template public.
- Select the Copy VM permissions check box to copy the permissions of the source virtual machine to the template.
- Click .
Image Locked while the template is being created. The process of creating a template may take up to an hour depending on the size of the virtual machine disk and the capabilities of your storage hardware. When complete, the template is added to the Templates tab. You can now create new virtual machines based on the template.
Note
11.3.2. Explanation of Settings and Controls in the New Template Window
Table 11.1. New Template and Edit Template Settings
|
Field
|
Description/Action
|
|---|---|
|
Name
|
The name of the template. This is the name by which the template is listed in the Templates tab in the Administration Portal and is accessed via the REST API. This text field has a 40-character limit and must be a unique name with any combination of uppercase and lowercase letters, numbers, hyphens, and underscores.
|
|
Description
|
A description of the template. This field is recommended but not mandatory.
|
|
Comment
|
A field for adding plain text, human-readable comments regarding the template.
|
|
Cluster
|
The cluster with which the template is associated. This is the same as the original virtual machines by default. You can select any cluster in the data center.
|
| CPU Profile | The CPU profile assigned to the template. CPU profiles define the maximum amount of processing capability a virtual machine can access on the host on which it runs, expressed as a percent of the total processing capability available to that host. CPU profiles are defined on the cluster level based on quality of service entries created for data centers. |
|
Create as a Sub Template version
|
Specifies whether the template is created as a new version of an existing template. Select this check box to access the settings for configuring this option.
|
|
Disks Allocation
|
Alias - An alias for the virtual machine disk used by the template. By default, the alias is set to the same value as that of the source virtual machine.
Virtual Size - The total amount of disk space that a virtual machine based on the template can use. This value cannot be edited, and is provided for reference only. This value corresponds with the size, in GB, that was specified when the disk was created or edited.
Target - The storage domain on which the virtual disk used by the template is stored. By default, the storage domain is set to the same value as that of the source virtual machine. You can select any storage domain in the cluster.
|
|
Allow all users to access this Template
|
Specifies whether a template is public or private. A public template can be accessed by all users, whereas a private template can only be accessed by users with the TemplateAdmin or SuperUser roles.
|
|
Copy VM permissions
|
Copies explicit permissions that have been set on the source virtual machine to the template.
|
11.3.3. Editing a Template
Procedure 11.9. Editing a Template
- Use the Templates resource tab, tree mode, or the search function to find and select the template in the results list.
- Click to open the Edit Template window.
- Change the necessary properties and click .
11.3.4. Deleting a Template
Warning
Procedure 11.10. Deleting a Template
- Use the resource tabs, tree mode, or the search function to find and select the template in the results list.
- Click to open the Remove Template(s) window.
- Click to remove the template.
11.3.5. Exporting Templates
11.3.5.1. Migrating Templates to the Export Domain
Procedure 11.11. Exporting Individual Templates to the Export Domain
- Use the Templates resource tab, tree mode, or the search function to find and select the template in the results list.
- Click to open the Export Template window.
Note
Select the Force Override check box to replace any earlier version of the template on the export domain. - Click to begin exporting the template; this may take up to an hour, depending on the virtual machine disk image size and your storage hardware.
- Repeat these steps until the export domain contains all the templates to migrate before you start the import process.Use the Storage resource tab, tree mode, or the search function to find and select the export domain in the results list and click the Template Import tab in the details pane to view all exported templates in the export domain.
11.3.5.2. Copying a Template's Virtual Hard Disk
Procedure 11.12. Copying a Virtual Hard Disk
- Select the Disks tab.
- Select the template disk or disks to copy.
- Click the Copy button to display the Copy Disk window.
- Use the drop-down menu or menus to select the Target data domain.
11.3.6. Importing Templates
11.3.6.1. Importing a Template into a Data Center
Procedure 11.13. Importing a Template into a Data Center
- Use the resource tabs, tree mode, or the search function to find and select the newly attached export domain in the results list.
- Select the Template Import tab of the details pane to display the templates that migrated across with the export domain.
- Select a template and click to open the Import Template(s) window.
- Select the templates to import.
- Use the drop-down menus to select the Destination Cluster and Storage domain. Alter the Suffix if applicable.Alternatively, clear the Clone All Templates check box.
- Click to import templates and open a notification window. Click to close the notification window.
11.3.6.2. Importing a Virtual Disk Image from an OpenStack Image Service as a Template
- Click the Storage resource tab and select the OpenStack Image Service domain from the results list.
- Select the image to import in the Images tab of the details pane.
- Click to open the Import Image(s) window.
- From the Data Center drop-down menu, select the data center into which the virtual disk image will be imported.
- From the Domain Name drop-down menu, select the storage domain in which the virtual disk image will be stored.
- Optionally, select a quota from the Quota drop-down menu to apply a quota to the virtual disk image.
- Select the Import as Template check box.
- From the Cluster drop-down menu, select the cluster in which the virtual disk image will be made available as a template.
- Click to import the virtual disk image.
11.4. Templates and Permissions
11.4.1. Managing System Permissions for a Template
- Create, edit, export, and remove associated templates.
- Import and export templates.
Note
11.4.2. Template Administrator Roles Explained
Table 11.2. Red Hat Enterprise Virtualization System Administrator Roles
| Role | Privileges | Notes |
|---|---|---|
| TemplateAdmin | Can perform all operations on templates. | Has privileges to create, delete and configure a template's storage domain and network details, and to move templates between domains. |
| NetworkAdmin | Network Administrator | Can configure and manage networks attached to templates. |
11.4.3. Template User Roles Explained
Table 11.3. Red Hat Enterprise Virtualization Template User Roles
| Role | Privileges | Notes |
|---|---|---|
| TemplateCreator | Can create, edit, manage and remove virtual machine templates within assigned resources. | The TemplateCreator role is not applied to a specific template; apply this role to a user for the whole environment with the Configure window. Alternatively apply this role for specific data centers, clusters, or storage domains. |
| TemplateOwner | Can edit and delete the template, assign and manage user permissions for the template. | The TemplateOwner role is automatically assigned to the user who creates a template. Other users who do not have TemplateOwner permissions on a template cannot view or use the template. |
| UserTemplateBasedVm | Can use the template to create virtual machines. | Cannot edit template properties. |
| NetworkUser | Logical network and network interface user for templates. | If the Allow all users to use this Network option was selected when a logical network is created, NetworkUser permissions are assigned to all users for the logical network. Users can then attach or detach template network interfaces to or from the logical network. |
11.4.4. Assigning an Administrator or User Role to a Resource
Procedure 11.14. Assigning a Role to a Resource
- Use the resource tabs, tree mode, or the search function to find and select the resource in the results list.
- Click the tab of the details pane to list the assigned users, the user's role, and the inherited permissions for the selected resource.
- Click to open the Add Permission to User window.
- Enter the name or user name of an existing user into the Search text box and click . Select a user from the resulting list of possible matches.
- Select a role from the Role to Assign: drop-down menu.
- Click to assign the role and close the window.
11.4.5. Removing an Administrator or User Role from a Resource
Procedure 11.15. Removing a Role from a Resource
- Use the resource tabs, tree mode, or the search function to find and select the resource in the results list.
- Click the tab of the details pane to list the assigned users, the user's role, and the inherited permissions for the selected resource.
- Select the user to remove from the resource.
- Click . The Remove Permission window opens to confirm permissions removal.
- Click to remove the user role.
Chapter 12. Pools
12.1. Introduction to Virtual Machine Pools
Note
12.2. Virtual Machine Pool Tasks
- 12.2.1. Creating a Virtual Machine Pool
- 12.2.2. Explanation of Settings and Controls in the New Pool Window
- 12.2.3. Editing a Virtual Machine Pool
- 12.2.4. Explanation of Settings and Controls in the Edit Pool Window
- 12.2.5. Prestarting Virtual Machines in a Pool
- 12.2.6. Adding Virtual Machines to a Virtual Machine Pool
- 12.2.7. Detaching Virtual Machines from a Virtual Machine Pool
- 12.2.8. Removing a Virtual Machine Pool
12.2.1. Creating a Virtual Machine Pool
Procedure 12.1. Creating a Virtual Machine Pool
- Click the Pools tab.
- Click the button to open the New Pool window.
- Use the drop down-list to select the Cluster or use the selected default.
- Use the Based on Template drop-down menu to select a template or use the selected default. If you have selected a template, optionally use the Template Sub Version drop-down menu to select a version of that template. A template provides standard settings for all the virtual machines in the pool.
- Use the Operating System drop-down list to select an Operating System or use the default provided by the template.
- Use the Optimized for drop-down list to optimize virtual machines for either Desktop use or Server use.
- Enter a Name and Description, any Comments and the Number of VMs for the pool.
- Select the Maximum number of VMs per user that a single user is allowed to run in a session. The minimum is one.
- Optionally, click the Show Advanced Options button and perform the following steps:
- Select the Console tab. At the bottom of the tab window, select the Override SPICE Proxy check box to enable the Overridden SPICE proxy address text field and specify the address of a SPICE proxy to override the global SPICE proxy, if any.
- Click the Pool tab and select a Pool Type:
- Manual - The administrator is responsible for explicitly returning the virtual machine to the pool. The virtual machine reverts to the original base image after the administrator returns it to the pool.
- Automatic - When the virtual machine is shut down, it automatically reverts to its base image and is returned to the virtual machine pool.
- Click .
12.2.2. Explanation of Settings and Controls in the New Pool Window
12.2.2.1. New Pool General Settings Explained
Table 12.1. General settings
|
Field Name
|
Description
|
|---|---|
|
Number of VMs
|
Allows you to specify the number of virtual machines to be created and made available in the virtual machine pool. By default, the maximum number of virtual machines you can create in a pool is 1000. This value can be configured using the
MaxVmsInPool key of the engine-config command.
|
|
Maximum number of VMs per user
|
Allows you to specify the maximum number of virtual machines a single user can take from the virtual machine pool at any one time. The value of this field must be between
1 and 32,767.
|
12.2.2.2. New Pool Pool Settings Explained
Table 12.2. Console settings
|
Field Name
|
Description
|
|---|---|
|
Pool Type
|
This drop-down menu allows you to specify the type of the virtual machine pool. The following options are available:
|
12.2.2.3. New Pool and Edit Pool Console Settings Explained
Table 12.3. Console settings
|
Field Name
|
Description
|
|---|---|
|
Override SPICE proxy
|
Select this check box to enable overriding the SPICE proxy defined in global configuration. This feature is useful in a case where the user (who is, for example, connecting via the User Portal) is outside of the network where the hypervisors reside.
|
|
Overridden SPICE proxy address
|
The proxy by which the SPICE client will connect to virtual machines. This proxy overrides both the global SPICE proxy defined for the Red Hat Enterprise Virtualization environment and the SPICE proxy defined for the cluster to which the virtual machine pool belongs, if any. The address must be in the following format:
protocol://[host]:[port] |
12.2.3. Editing a Virtual Machine Pool
Procedure 12.2. Editing a Virtual Machine Pool
- Click the Pools resource tab and select a virtual machine pool in the results list.
- Click to open the Edit Pool window.
- Edit the properties of the virtual machine pool.
- Click .
12.2.4. Explanation of Settings and Controls in the Edit Pool Window
12.2.4.1. Edit Pool General Settings Explained
Table 12.4. General settings
|
Field Name
|
Description
|
|---|---|
|
Description
|
A meaningful description of the virtual machine pool.
|
|
Prestarted VMs
|
Allows you to specify the number of virtual machines in the virtual machine pool that will be started before they are taken and kept in that state to be taken by users. The value of this field must be between
0 and the total number of virtual machines in the virtual machine pool.
|
|
Increase number of VMs in pool by
|
Allows you to increase the number of virtual machines in the virtual machine pool by the specified number.
|
|
Maximum number of VMs per user
|
Allows you to specify the maximum number of virtual machines a single user can take from the virtual machine at any one time. The value of this field must be between
1 and 32,767.
|
12.2.5. Prestarting Virtual Machines in a Pool
Procedure 12.3. Prestarting Virtual Machines in a Pool
- Use the Pools resource tab, tree mode, or the search function to find and select the virtual machine pool in the results list.
- Click to open the Edit Pool window.
- Enter the number of virtual machines to be prestarted in the Prestarted VMs field.
- Select the Pool tab. Ensure Pool Type is set to Automatic.
- Click .
12.2.6. Adding Virtual Machines to a Virtual Machine Pool
Procedure 12.4. Adding Virtual Machines to a Virtual Machine Pool
- Use the Pools resource tab, tree mode, or the search function to find and select the virtual machine pool in the results list.
- Click to open the Edit Pool window.
- Enter the number of additional virtual machines to add in the Increase number of VMs in pool by field.
- Click .
12.2.7. Detaching Virtual Machines from a Virtual Machine Pool
Procedure 12.5. Detaching Virtual Machines from a Virtual Machine Pool
- Use the Pools resource tab, tree mode, or the search function to find and select the virtual machine pool in the results list.
- Ensure the virtual machine has a status of
Downbecause you cannot detach a running virtual machine.Click the Virtual Machines tab in the details pane to list the virtual machines in the pool. - Select one or more virtual machines and click to open the Detach Virtual Machine(s) confirmation window.
- Click to detach the virtual machine from the pool.
Note
12.2.8. Removing a Virtual Machine Pool
Procedure 12.6. Removing a Virtual Machine Pool
- Use the Pools resource tab, tree mode, or the search function to find and select the virtual machine pool in the results list.
- Click to open the Remove Pool(s) confirmation window.
- Click to remove the pool.
12.3. Pools and Permissions
12.3.1. Managing System Permissions for a Virtual Machine Pool
- Create, edit, and remove pools.
- Add and detach virtual machines from the pool.
Note
12.3.2. Virtual Machine Pool Administrator Roles Explained
Table 12.5. Red Hat Enterprise Virtualization System Administrator Roles
| Role | Privileges | Notes |
|---|---|---|
| VmPoolAdmin | System Administrator role of a virtual pool. | Can create, delete, and configure a virtual pool, assign and remove virtual pool users, and perform basic operations on a virtual machine. |
| ClusterAdmin | Cluster Administrator | Can use, create, delete, manage all virtual machine pools in a specific cluster. |
12.3.3. Assigning an Administrator or User Role to a Resource
Procedure 12.7. Assigning a Role to a Resource
- Use the resource tabs, tree mode, or the search function to find and select the resource in the results list.
- Click the tab of the details pane to list the assigned users, the user's role, and the inherited permissions for the selected resource.
- Click to open the Add Permission to User window.
- Enter the name or user name of an existing user into the Search text box and click . Select a user from the resulting list of possible matches.
- Select a role from the Role to Assign: drop-down menu.
- Click to assign the role and close the window.
12.3.4. Removing an Administrator or User Role from a Resource
Procedure 12.8. Removing a Role from a Resource
- Use the resource tabs, tree mode, or the search function to find and select the resource in the results list.
- Click the tab of the details pane to list the assigned users, the user's role, and the inherited permissions for the selected resource.
- Select the user to remove from the resource.
- Click . The Remove Permission window opens to confirm permissions removal.
- Click to remove the user role.
12.4. Trusted Compute Pools
12.4.1. Creating a Trusted Cluster
Note
Procedure 12.9. Creating a Trusted Cluster
- In the navigation pane, select the Clusters tab.
- Click the button.
- In the General tab, set the cluster name.
- In the General tab, select the Enable Virt Service radio button.
- In the Cluster Policy tab, select Enable Trusted Service check box.
- Click .
12.4.2. Adding a Trusted Host
Procedure 12.10.
- Select the Hosts tab.
- Click the button.
- In the General tab, set the host's name.
- In the General tab, set the host's address.
Note
The host designated here must be trusted by the attestation server. - In the General tab, in the Host Cluster drop-down menu, select a trusted cluster.
- Click .
Chapter 13. Virtual Machine Disks
- 13.1. Understanding Virtual Machine Storage
- 13.2. Understanding Virtual Disks
- 13.3. Settings to Wipe Virtual Disks After Deletion
- 13.4. Shareable Disks in Red Hat Enterprise Virtualization
- 13.5. Read Only Disks in Red Hat Enterprise Virtualization
- 13.6. Virtual Disk Tasks
- 13.7. Virtual Disks and Permissions
13.1. Understanding Virtual Machine Storage
kpartx, vgscan, vgchange or mount to investigate the virtual machine's processes or problems.
13.2. Understanding Virtual Disks
- PreallocatedA preallocated virtual disk allocates all the storage required for a virtual machine up front. For example, a 20 GB preallocated logical volume created for the data partition of a virtual machine will take up 20 GB of storage space immediately upon creation.
- SparseA sparse allocation allows an administrator to define the total storage to be assigned to the virtual machine, but the storage is only allocated when required.For example, a 20 GB thin provisioned logical volume would take up 0 GB of storage space when first created. When the operating system is installed it may take up the size of the installed file, and would continue to grow as data is added up to a maximum of 20 GB size.
Table 13.1. Permitted Storage Combinations
| Storage | Format | Type | Note |
|---|---|---|---|
| NFS or iSCSI/FCP | RAW or Qcow2 | Sparse or Preallocated | |
| NFS | RAW | Preallocated | A file with an initial size which equals the amount of storage defined for the virtual disk, and has no formatting. |
| NFS | RAW | Sparse | A file with an initial size which is close to zero, and has no formatting. |
| NFS | Qcow2 | Sparse | A file with an initial size which is close to zero, and has Qcow2 formatting. Subsequent layers will be Qcow2 formatted. |
| SAN | RAW | Preallocated | A block device with an initial size which equals the amount of storage defined for the virtual disk, and has no formatting. |
| SAN | Qcow2 | Sparse | A block device with an initial size which is much smaller than the size defined for the VDisk (currently 1 GB), and has Qcow2 formatting for which space is allocated as needed (currently in 1 GB increments). |
13.3. Settings to Wipe Virtual Disks After Deletion
wipe_after_delete flag, viewed in the Administration Portal as the Wipe After Delete check box, enables the initialization of the virtual disk upon deletion. If it is set to false, which is the default, deleting the disk will open up those blocks for re-use but will not specifically wipe the data. It is possible for this data to be recovered because the blocks have not been returned to zero.
wipe_after_delete for virtual disks will wipe the blocks when the virtual disk is deleted, reverting the blocks to zero. This is more secure, and is recommended if the virtual disk has contained any sensitive data. This is a more intensive operation and users may experience degradation in performance and prolonged delete times.
wipe_after_delete flag default can be changed to true using the engine configuration tool on the Red Hat Enterprise Virtualization Manager. Restart the engine for the setting change to take effect.
Procedure 13.1. Setting SANWipeAfterDelete to Default to True Using the Engine Configuration Tool
- Run the engine configuration tool with the
--setaction:# engine-config --set SANWipeDelete=true
- Restart the engine for the change to take effect:
# service ovirt-engine restart
13.4. Shareable Disks in Red Hat Enterprise Virtualization
13.5. Read Only Disks in Red Hat Enterprise Virtualization
Important
EXT3, EXT4, or XFS).
13.6. Virtual Disk Tasks
- 13.6.1. Creating Floating Virtual Disks
- 13.6.2. Explanation of Settings in the Add Virtual Disk Window
- 13.6.3. Overview of Live Storage Migration
- 13.6.4. Moving a Virtual Disk
- 13.6.5. Copying a Virtual Disk
- 13.6.6. Importing a Virtual Disk Image from an OpenStack Image Service
- 13.6.7. Exporting a Virtual Machine Disk to an OpenStack Image Service
13.6.1. Creating Floating Virtual Disks
Procedure 13.2. Creating Floating Virtual Disks
- Select the Disks resource tab.
- Click .
- Use the radio buttons to specify whether the virtual disk will be an Internal or External (Direct Lun) disk.
- Enter the Size(GB) of the virtual disk.
- Enter a name for the virtual disk in the Alias field.
- Enter a Description for the virtual disk.
- Select the virtual interface that the virtual disk will present to virtual machines from the Interface list.
- Select the provisioning policy for the virtual disk from the Allocation Policy list.
- Select the data center in which the virtual disk will be available from the Data Center list.
- Select the storage domain in which the virtual disk will be stored from the Storage Domain list.
- Select the disk profile to apply to the virtual disk from the Disk Profile list.
- Select the Wipe After Delete check box if you require the disk to be initialized after it is deleted. This increases security but is a more intensive operation and may prolong delete times.
- Select the Bootable check box to enable the bootable flag on the virtual disk.
- Select the Shareable check box to allow the virtual disk to be attached to more than one virtual machine at a time.
- Click OK.
13.6.2. Explanation of Settings in the Add Virtual Disk Window
Table 13.2. Add Virtual Disk Settings: Internal
|
Field Name
|
Description
|
|---|---|
|
Size(GB)
|
The size of the new virtual disk in GB.
|
|
Alias
|
The name of the virtual disk, limited to 40 characters.
|
|
Description
|
A description of the virtual disk. This field is recommended but not mandatory.
|
|
Interface
|
The virtual interface the disk presents to virtual machines. VirtIO is faster, but requires drivers. Red Hat Enterprise Linux 5 and higher include these drivers. Windows does not include these drivers, but they can be installed from the guest tools ISO or virtual floppy disk. IDE devices do not require special drivers.
|
|
Allocation Policy
|
The provisioning policy for the new virtual disk.
|
|
Data Center
|
The data center in which the virtual disk will be available.
|
|
Storage Domain
|
The storage domain in which the virtual disk will be stored. The drop-down list shows all storage domains available in the given cluster, and also shows the total space and currently available space in the storage domain.
|
|
Disk Profile
|
The disk profile assigned to the virtual disk. Disk profiles define the maximum amount of throughput and the maximum level of input and output operations for a virtual disk in a storage domain. Disk profiles are defined on the storage domain level based on storage quality of service entries created for data centers.
|
|
Wipe After Delete
|
Allows you to enable enhanced security for deletion of sensitive material when the virtual disk is deleted.
|
|
Bootable
|
Allows you to enable the bootable flag on the virtual disk.
|
|
Shareable
|
Allows you to attach the virtual disk to more than one virtual machine at a time.
|
|
Read Only
|
Allows you to set the disk as read-only. The same disk can be attached as read-only to one virtual machine, and as rewritable to another.
|
Table 13.3. Add Virtual Disk Settings: External (Direct Lun)
|
Field Name
|
Description
|
|---|---|
|
Alias
|
The name of the virtual disk, limited to 40 characters.
|
|
Description
|
A description of the virtual disk. This field is recommended but not mandatory.
|
|
Interface
|
The virtual interface the disk presents to virtual machines. VirtIO is faster, but requires drivers. Red Hat Enterprise Linux 5 and higher include these drivers. Windows does not include these drivers, but they can be installed from the guest tools ISO or virtual floppy disk. IDE devices do not require special drivers.
|
|
Data Center
|
The data center in which the virtual disk will be available.
|
|
Use Host
|
The host on which the LUN will be mounted. You can select any host in the data center.
|
|
Storage Type
|
The type of external LUN to add. You can select from either iSCSI or Fibre Channel.
|
|
Discover Targets
|
This section can be expanded when you are using iSCSI external LUNs and Targets > LUNs is selected.
Address - The host name or IP address of the target server.
Port - The port by which to attempt a connection to the target server. The default port is 3260.
User Authentication - The iSCSI server requires User Authentication. The User Authentication field is visible when you are using iSCSI external LUNs.
CHAP user name - The user name of a user with permission to log in to LUNs. This field is accessible when the User Authentication check box is selected.
CHAP password - The password of a user with permission to log in to LUNs. This field is accessible when the User Authentication check box is selected.
|
|
Bootable
|
Allows you to enable the bootable flag on the virtual disk.
|
|
Shareable
|
Allows you to attach the virtual disk to more than one virtual machine at a time.
|
|
Read Only
|
Allows you to set the disk as read-only. The same disk can be attached as read-only to one virtual machine, and as rewritable to another.
|
- Live storage migration of direct LUN hard disk images is not supported.
- Direct LUN disks are not included in virtual machine exports.
- Direct LUN disks are not included in virtual machine snapshots.
Important
EXT3, EXT4, or XFS).
13.6.3. Overview of Live Storage Migration
Important
- Live storage migration creates a snapshot.
- You can live migrate multiple disks at one time.
- Multiple disks for the same virtual machine can reside across more than one storage domain, but the image chain for each disk must reside on a single storage domain.
- You can live migrate disks only between two file-based domains (NFS, POSIX, and GlusterFS) or between two block-based domains (FCP and iSCSI).
- You cannot live migrate direct LUN hard disk images or disks marked as shareable.
13.6.4. Moving a Virtual Disk
- You can move multiple disks at the same time.
- If the virtual machine is shut down, you can move disks between any two storage domains in the same data center. If the virtual machine is running, you can move disks only between two file-based domains (NFS, POSIX, and GlusterFS) or between two block-based domains (FCP and iSCSI).
- If the virtual disk is attached to a virtual machine that was created based on a template and used the thin provisioning storage allocation option, you must copy the disks for the template on which the virtual machine was based to the same storage domain as the virtual disk.
Procedure 13.3. Moving a Virtual Disk
- Select the Disks tab.
- Select one or more virtual disks to move.
- Click to open the Move Disk(s) window.
- From the Target list, select the storage domain to which the virtual disk(s) will be moved.
- From the Disk Profile list, select a profile for the disk(s), if applicable.
- Click .
Locked while being moved. If you moved a disk that is connected to a running virtual machine, a snapshot of that disk is created automatically, and is visible in the Snapshots tab of the details pane for that virtual machine. For information on removing the snapshot, see Section 10.12.4, “Deleting a Snapshot”.
13.6.5. Copying a Virtual Disk
Procedure 13.4. Copying a Virtual Disk
- Select the Disks tab.
- Select the virtual disks to copy.
- Click the button to open the Copy Disk(s) window.
- Use the Target drop-down menus to select the storage domain to which the virtual disk will be copied.
- Click .
Locked while being copied.
13.6.6. Importing a Virtual Disk Image from an OpenStack Image Service
- Click the Storage resource tab and select the OpenStack Image Service domain from the results list.
- Select the image to import in the Images tab of the details pane.
- Click to open the Import Image(s) window.
- From the Data Center drop-down menu, select the data center into which the virtual disk image will be imported.
- From the Domain Name drop-down menu, select the storage domain in which the virtual disk image will be stored.
- Optionally, select a quota from the Quota drop-down menu to apply a quota to the virtual disk image.
- Click to import the image.
13.6.7. Exporting a Virtual Machine Disk to an OpenStack Image Service
- Click the Disks resource tab.
- Select the disks to export.
- Click the Export button to open the Export Image(s) window.
- From the Domain Name drop-down list, select the OpenStack Image Service to which the disks will be exported.
- From the Quota drop-down list, select a quota for the disks if a quota is to be applied.
- Click OK.
Important
13.7. Virtual Disks and Permissions
13.7.1. Managing System Permissions for a Virtual Disk
- Create, edit, and remove virtual disks associated with a virtual machine or other resources.
- Edit user permissions for virtual disks.
Note
13.7.2. Virtual Disk User Roles Explained
Table 13.4. Red Hat Enterprise Virtualization System Administrator Roles
| Role | Privileges | Notes |
|---|---|---|
| DiskOperator | Virtual disk user. | Can use, view and edit virtual disks. Inherits permissions to use the virtual machine to which the virtual disk is attached. |
| DiskCreator | Can create, edit, manage and remove virtual machine disks within assigned clusters or data centers. | This role is not applied to a specific virtual disk; apply this role to a user for the whole environment with the Configure window. Alternatively apply this role for specific data centers, clusters, or storage domains. |
13.7.3. Assigning an Administrator or User Role to a Resource
Procedure 13.5. Assigning a Role to a Resource
- Use the resource tabs, tree mode, or the search function to find and select the resource in the results list.
- Click the tab of the details pane to list the assigned users, the user's role, and the inherited permissions for the selected resource.
- Click to open the Add Permission to User window.
- Enter the name or user name of an existing user into the Search text box and click . Select a user from the resulting list of possible matches.
- Select a role from the Role to Assign: drop-down menu.
- Click to assign the role and close the window.
13.7.4. Removing an Administrator or User Role from a Resource
Procedure 13.6. Removing a Role from a Resource
- Use the resource tabs, tree mode, or the search function to find and select the resource in the results list.
- Click the tab of the details pane to list the assigned users, the user's role, and the inherited permissions for the selected resource.
- Select the user to remove from the resource.
- Click . The Remove Permission window opens to confirm permissions removal.
- Click to remove the user role.
Chapter 14. External Providers
14.1. Introduction to External Providers in Red Hat Enterprise Virtualization
- Foreman for Host Provisioning
- Foreman is a tool for managing all aspects of the life cycle of both physical and virtual hosts. In Red Hat Enterprise Virtualization, hosts managed by Foreman can be added to and used by the Red Hat Enterprise Virtualization Manager as virtualization hosts. After you add a Foreman instance to the Manager, the hosts managed by the Foreman instance can be added by searching for available hosts on that Foreman instance when adding a new host.
- OpenStack Image Service (Glance) for Image Management
- OpenStack Image Service provides a catalog of virtual machine images. In Red Hat Enterprise Virtualization, these images can be imported into the Red Hat Enterprise Virtualization Manager and used as floating disks or attached to virtual machines and converted into templates. After you add an OpenStack Image Service to the Manager, it appears as a storage domain that is not attached to any data center. Virtual machine disks in a Red Hat Enterprise Virtualization environment can also be exported to an OpenStack Image Service as virtual machine disk images.
- OpenStack Networking (Neutron) for Network Provisioning
- OpenStack Networking provides software-defined networks. In Red Hat Enterprise Virtualization, networks provided by OpenStack Networking can be imported into the Red Hat Enterprise Virtualization Manager and used to carry all types of traffic and create complicated network topologies. After you add OpenStack Networking to the Manager, you can access the networks provided by OpenStack Networking by manually importing them.
Note
14.2. Enabling the Authentication of OpenStack Providers
Procedure 14.1. Configuring the Location of a Keystone Endpoint
- Log in to the system running Red Hat Enterprise Virtualization Manager as the
rootuser. - Configure the location of the Keystone server, including the port number and API version:
# engine-config --set KeystoneAuthUrl=http://[address to the endpoint]:35357/v2.0
- Configure the Manager to only consider required networks for VM scheduling:
# engine-config --set OnlyRequiredNetworksMandatoryForVdsSelection=true
- Restart the engine service:
# service ovirt-engine restart
Note
14.3. Adding External Providers
- 14.3.1. Adding an External Provider
- 14.3.2. Adding a Foreman Instance for Host Provisioning
- 14.3.3. Adding an OpenStack Networking (Neutron) Instance for Network Provisioning
- 14.3.4. Adding an OpenStack Image Service (Glance) Instance for Image Management
- 14.3.5. Add Provider General Settings Explained
- 14.3.6. Add Provider Agent Configuration Settings Explained
14.3.1. Adding an External Provider
14.3.2. Adding a Foreman Instance for Host Provisioning
Procedure 14.2. Adding a Foreman Instance for Host Provisioning
- Select the External Providers entry in the tree pane.
- Click the button to open the Add Provider window.
- Enter a Name and Description.
- From the Type drop-down menu, ensure that Foreman is selected.
- Enter the URL or fully qualified domain name of the machine on which the Foreman instance is installed in the Provider URL text field. You do not need to specify a port number.
- Enter the Username and Password for the Foreman instance. You must use the same username and password as you would use to log in to the Foreman provisioning portal.
- Test the credentials:
- Click the Test button to test whether you can authenticate successfully with the Foreman instance using the provided credentials.
- If the Foreman instance uses SSL, the Import provider certificates window opens; click OK to import the certificate that the Foreman instance provides.
Important
You must import the certificate that the Foreman instance provides to ensure the Manager can communicate with the instance.
- Click .
14.3.3. Adding an OpenStack Networking (Neutron) Instance for Network Provisioning
Procedure 14.3. Adding an OpenStack Networking (Neutron) Instance for Network Provisioning
- Select the External Providers entry in the tree pane.
- Click the button to open the Add Provider window.
- Enter a Name and Description.
- From the Type drop-down menu, select OpenStack Networking.
- Click the text field for Networking Plugin and select Open vSwitch.
- Enter the URL or fully qualified domain name of the machine on which the OpenStack Networking instance is installed in the Provider URL text field, followed by the port number.
- Optionally, select the Requires Authentication check box and enter the Username, Password and Tenant Name for the OpenStack Networking instance. You must use the username and password for the OpenStack Networking user registered in Keystone, and the tenant of which the OpenStack Networking instance is a member.
- Test the credentials:
- Click the Test button to test whether you can authenticate successfully with the Neutron instance using the provided credentials.
- If the Neutron instance uses SSL, the Import provider certificates window opens; click OK to import the certificate that the Neutron instance provides.
Important
You must import the certificate that the Neutron instance provides to ensure the Manager can communicate with the instance.
- Click the Agent Configuration tab.
- Enter the URL or fully qualified domain name of the host on which the QPID server is hosted in the Host text field.
- Enter the port number by which to connect to the QPID instance. This port number will be 5762 by default if QPID is not configured to use SSL, and 5761 if QPID is configured to use SSL.
- Enter the Username and Password of the OpenStack Networking user registered in the QPID instance.
- Click .
14.3.4. Adding an OpenStack Image Service (Glance) Instance for Image Management
Procedure 14.4. Adding an OpenStack Image Service (Glance) Instance for Image Management
- Select the External Providers entry in the tree pane.
- Click the button to open the Add Provider window.
- Enter a Name and Description.
- From the Type drop-down menu, select OpenStack Image.
- Enter the URL or fully qualified domain name of the machine on which the Glance instance is installed in the Provider URL text field.
- Optionally, select the Requires Authentication check box and enter the Username, Password and Tenant Name for the Glance instance. You must use the username and password for the Glance user registered in Keystone, and the tenant of which the Glance instance is a member.
- Test the credentials:
- Click the Test button to test whether you can authenticate successfully with the Glance instance using the provided credentials.
- If the Glance instance uses SSL, the Import provider certificates window opens; click OK to import the certificate that the Glance instance provides.
Important
You must import the certificate that the Glance instance provides to ensure the Manager can communicate with the instance.
- Click .
14.3.5. Add Provider General Settings Explained
Table 14.1. Add Provider: General Settings
|
Setting
|
Explanation
|
|---|---|
|
Name
|
A name to represent the provider in the Manager.
|
|
Description
|
A plain text, human-readable description of the provider.
|
|
Type
|
The type of the provider. Changing this setting alters the available fields for configuring the provider.
Foreman
OpenStack Image
OpenStack Network
|
|
Test
|
Allows users to test the specified credentials. This button is available to all provider types.
|
14.3.6. Add Provider Agent Configuration Settings Explained
Table 14.2. Add Provider: General Settings
|
Setting
|
Explanation
|
|---|---|
|
Interface Mappings
|
A comma-separated list of mappings in the format of label:interface.
|
|
Host
|
The URL or fully qualified domain name of the machine on which the QPID instance is installed.
|
|
Port
|
The remote port by which a connection with the above host is to be made. By default, this port will be 5762 if SSL is not enabled on the host, and 5761 if SSL is enabled.
|
|
Username
|
A username for authenticating the OpenStack Networking instance with the above QPID instance. By default, this username will be
neutron
|
|
Password
|
The password against which the above username is to be authenticated.
|
14.4. Editing External Providers
14.4.1. Editing an External Provider
Procedure 14.5. Editing an External Provider
- Select the External Providers entry in the tree pane.
- Select the external provider to edit.
- Click the button to open the Edit Provider window.
- Change the current values for the provider to the preferred values.
- Click .
14.5. Removing External Providers
14.5.1. Removing an External Provider
Procedure 14.6. Removing an External Provider
- Select the External Providers entry in the tree pane.
- Select the external provider to remove.
- Click .
- Click in the Remove Provider(s) window to confirm the removal of this provider.
Part II. Administering the Environment
Table of Contents
- 15. Updating the Red Hat Enterprise Virtualization Environment
- 15.1. Updates between Minor Releases
- 15.2. Upgrading to Red Hat Enterprise Virtualization 3.5
- 15.3. Upgrading to Red Hat Enterprise Virtualization 3.4
- 15.4. Upgrading to Red Hat Enterprise Virtualization 3.3
- 15.5. Upgrading to Red Hat Enterprise Virtualization Manager 3.2
- 15.6. Upgrading to Red Hat Enterprise Virtualization Manager 3.1
- 15.7. Post-upgrade Tasks
- 16. Backups and Migration
- 17. Users and Roles
- 18. Quotas and Service Level Agreement Policy
- 18.1. Introduction to Quota
- 18.2. Shared Quota and Individually Defined Quota
- 18.3. Quota Accounting
- 18.4. Enabling and Changing a Quota Mode in a Data Center
- 18.5. Creating a New Quota Policy
- 18.6. Explanation of Quota Threshold Settings
- 18.7. Assigning a Quota to an Object
- 18.8. Using Quota to Limit Resources by User
- 18.9. Editing Quotas
- 18.10. Removing Quotas
- 18.11. Service Level Agreement Policy Enforcement
- 19. Event Notifications
- 20. Utilities
Chapter 15. Updating the Red Hat Enterprise Virtualization Environment
- 15.1. Updates between Minor Releases
- 15.2. Upgrading to Red Hat Enterprise Virtualization 3.5
- 15.3. Upgrading to Red Hat Enterprise Virtualization 3.4
- 15.4. Upgrading to Red Hat Enterprise Virtualization 3.3
- 15.5. Upgrading to Red Hat Enterprise Virtualization Manager 3.2
- 15.6. Upgrading to Red Hat Enterprise Virtualization Manager 3.1
- 15.7. Post-upgrade Tasks
15.1. Updates between Minor Releases
15.1.1. Checking for Red Hat Enterprise Virtualization Manager Updates
Important
Procedure 15.1. Checking for Red Hat Enterprise Virtualization Manager Updates
- Run the following command on the machine on which the Red Hat Enterprise Virtualization Manager is installed:
# engine-upgrade-check
- If there are no updates are available, the command will output the text
No upgrade:# engine-upgrade-check VERB: queue package rhevm-setup for update VERB: package rhevm-setup queued VERB: Building transaction VERB: Empty transaction VERB: Transaction Summary: No upgrade
- If updates are available, the command will list the packages to be updated:
# engine-upgrade-check VERB: queue package rhevm-setup for update VERB: package rhevm-setup queued VERB: Building transaction VERB: Transaction built VERB: Transaction Summary: VERB: updated - rhevm-lib-3.3.2-0.50.el6ev.noarch VERB: update - rhevm-lib-3.4.0-0.13.el6ev.noarch VERB: updated - rhevm-setup-3.3.2-0.50.el6ev.noarch VERB: update - rhevm-setup-3.4.0-0.13.el6ev.noarch VERB: install - rhevm-setup-base-3.4.0-0.13.el6ev.noarch VERB: install - rhevm-setup-plugin-ovirt-engine-3.4.0-0.13.el6ev.noarch VERB: updated - rhevm-setup-plugins-3.3.1-1.el6ev.noarch VERB: update - rhevm-setup-plugins-3.4.0-0.5.el6ev.noarch Upgrade available Upgrade available
15.1.2. Updating the Red Hat Enterprise Virtualization Manager
- Stopping the
ovirt-engineservice. - Downloading and installing the updated packages.
- Backing up and updating the database.
- Performing post-installation configuration.
- Starting the
ovirt-engineservice.
Procedure 15.2. Updating Red Hat Enterprise Virtualization Manager
- Run the following command to update the rhevm-setup package:
# yum update rhevm-setup
- Run the following command to update the Red Hat Enterprise Virtualization Manager:
# engine-setup
Important
Important
15.1.3. Updating Red Hat Enterprise Virtualization Hypervisors
Important
Procedure 15.3. Updating Red Hat Enterprise Virtualization Hypervisors
- Log in to the system hosting Red Hat Enterprise Virtualization Manager as the
rootuser. - Enable the
Red Hat Enterprise Virtualization Hypervisor (v.6 x86_64)repository:# subscription-manager repos --enable=rhel-6-server-rhevh-rpms
- Ensure that you have the most recent version of the rhev-hypervisor6 package installed:
# yum update rhev-hypervisor6
- From the Administration Portal, click the Hosts tab, and then select the Hypervisor that you intend to upgrade.
- If the Hypervisor requires updating, an alert message in the details pane indicates that a new version of the Red Hat Enterprise Virtualization Hypervisor is available.
- If the Hypervisor does not require updating, no alert message is displayed and no further action is required.
- Click . If automatic migration is enabled, this causes any virtual machines running on the Hypervisor to be migrated to other hosts. If the Hypervisor is the SPM, this function is moved to another host.
- Click Upgrade to open the Upgrade Host confirmation window.
- Select
rhev-hypervisor.iso, which is symbolically linked to the most recent Hypervisor image. - Click to update and reinstall the Hypervisor. The details of the Hypervisor are updated in the Hosts tab, and the status will transition through these stages:These are all expected, and each stage will take some time.
- Maintenance
- Installing
- Non Responsive
- Up
- Restart the Hypervisor to ensure all updates are correctly applied.
Important
15.1.4. Updating Red Hat Enterprise Linux Virtualization Hosts
yum command in the same way as regular Red Hat Enterprise Linux systems. It is highly recommended that you use yum to update your systems regularly, to ensure timely application of security and bug fixes. Updating a host includes stopping and restarting the host. If migration is enabled at cluster level, virtual machines are automatically migrated to another host in the cluster; as a result, it is recommended that host updates are performed at a time when the host's usage is relatively low.
Important
Procedure 15.4. Updating Red Hat Enterprise Linux Hosts
- From the Administration Portal, click the Hosts tab and select the host to be updated.
- Click to place the host into maintenance mode.
- On the Red Hat Enterprise Linux host machine, run the following command:
# yum update
- Restart the host to ensure all updates are correctly applied.
15.2. Upgrading to Red Hat Enterprise Virtualization 3.5
15.2.1. Red Hat Enterprise Virtualization Manager 3.5 Upgrade Overview
Important
- Subscribing to entitlements.
- Updating the required packages.
- Performing the upgrade.
engine-setup, which provides an interactive interface. While the upgrade is in process, virtualization hosts and the virtual machines running on those virtualization hosts continue to operate independently. When the upgrade is complete, you can then upgrade your hosts to the latest versions of Red Hat Enterprise Linux or Red Hat Enterprise Virtualization Hypervisor.
15.2.2. Features Requiring a Compatibility Upgrade to Red Hat Enterprise Virtualization 3.5
Table 15.1. Features Requiring a Compatibility Upgrade to Red Hat Enterprise Virtualization 3.5
| Feature | Description |
|---|---|
|
Paravirtualized random number generator (RNG) device support
|
This feature adds support for enabling a paravirtualized random number generator in virtual machines. To use this feature, the random number generator source must be set at cluster level to ensure all hosts support and report desired RNG device sources. This feature is supported in Red Hat Enterprise Linux hosts of version 6.6 and higher.
|
|
Serial number policy support
|
This feature adds support for setting a custom serial number for virtual machines. Serial number policy can be specified at cluster level, or for an individual virtual machine.
|
|
Save OVF files on any data domain
|
This feature adds support for Open Virtualization Format files, including virtual machine templates, to be stored on any domain in a supported pool.
|
|
Boot menu support
|
This feature adds support for enabling a boot device menu in a virtual machine.
|
|
Import data storage domains
|
This feature adds support for users to add existing data storage domains to their environment. The Manager then detects and adds all the virtual machines in that storage domain.
|
|
SPICE copy and paste support
|
This feature adds support for users to enable or disable SPICE clipboard copy and paste.
|
|
Storage pool metadata removal
|
This feature adds support for storage pool metadata to be stored and maintained in the engine database only.
|
|
Network custom properties support
|
This feature adds support for users to define custom properties when a network is provisioned on a host.
|
15.2.3. Red Hat Enterprise Virtualization 3.5 Upgrade Considerations
Important
- Upgrading to version 3.5 can only be performed from version 3.4
- To upgrade a previous version of Red Hat Enterprise Virtualization earlier than Red Hat Enterprise Virtualization 3.4 to Red Hat Enterprise Virtualization 3.5, you must sequentially upgrade to any newer versions of Red Hat Enterprise Virtualization before upgrading to the latest version. For example, if you are using Red Hat Enterprise Virtualization 3.3, you must upgrade to the latest minor version of Red Hat Enterprise Virtualization 3.4 before you can upgrade to Red Hat Enterprise Virtualization 3.5.
- Red Hat Enterprise Virtualization Manager cannot be installed on the same machine as IPA
- An error message displays if the ipa-server package is installed. Red Hat Enterprise Virtualization Manager 3.5 does not support installation on the same machine as Identity Management (IdM). To resolve this issue, you must migrate the IdM configuration to another system before re-attempting the upgrade.
- Red Hat Enterprise Virtualization Manager 3.5 is supported to run on Red Hat Enterprise Linux 6.6
- Upgrading to version 3.5 involves also upgrading the base operating system of the machine that hosts the Manager.
15.2.4. Upgrading to Red Hat Enterprise Virtualization Manager 3.5
Important
engine-setup command will attempt to roll your Red Hat Enterprise Virtualization Manager installation back to its previous state. For this reason, the repositories required by Red Hat Enterprise Virtualization 3.4 must not be removed until after the upgrade is complete as outlined below. If the upgrade fails, detailed instructions display that explain how to restore your installation.
Procedure 15.5. Upgrading to Red Hat Enterprise Virtualization Manager 3.5
- Subscribe the system on which the Red Hat Enterprise Virtualization Manager is installed to the required entitlements for receiving Red Hat Enterprise Virtualization Manager 3.5 packages:
- With RHN Classic:
# rhn-channel --add --channel=rhel-x86_64-server-6-rhevm-3.5
- With Subscription Manager:
# subscription-manager repos --enable=rhel-6-server-rhevm-3.5-rpms
- Update the base operating system:
# yum update
- Update the rhevm-setup package:
# yum update rhevm-setup
- Run the following command and follow the prompts to upgrade the Red Hat Enterprise Virtualization Manager:
# engine-setup
- Remove or disable the Red Hat Enterprise Virtualization Manager 3.4 channel to ensure the system does not use any Red Hat Enterprise Virtualization Manager 3.4 packages:
- With RHN Classic:
# rhn-channel --remove --channel=rhel-x86_64-server-6-rhevm-3.4
- With Subscription Manager:
# subscription-manager repos --disable=rhel-6-server-rhevm-3.4-rpms
15.3. Upgrading to Red Hat Enterprise Virtualization 3.4
15.3.1. Red Hat Enterprise Virtualization Manager 3.4 Upgrade Overview
Important
- Subscribing to entitlements.
- Updating the required packages.
- Performing the upgrade.
engine-setup, which provides an interactive interface. While the upgrade is in process, virtualization hosts and the virtual machines running on those virtualization hosts continue to operate independently. When the upgrade is complete, you can then upgrade your hosts to the latest versions of Red Hat Enterprise Linux or Red Hat Enterprise Virtualization Hypervisor.
15.3.2. Features Requiring a Compatibility Upgrade to Red Hat Enterprise Virtualization 3.4
Table 15.2. Features Requiring a Compatibility Upgrade to Red Hat Enterprise Virtualization 3.4
| Feature | Description |
|---|---|
|
Abort migration on error
|
This feature adds support for handling errors encountered during the migration of virtual machines.
|
|
Forced Gluster volume creation
|
This feature adds support for allowing the creation of Gluster bricks on root partitions. With this feature, you can choose to override warnings against creating bricks on root partitions.
|
|
Management of asynchronous Gluster volume tasks
|
This feature provides support for managing asynchronous tasks on Gluster volumes, such as rebalancing volumes or removing bricks. To use this feature, you must use GlusterFS version 3.5 or above.
|
|
Import Glance images as templates
|
This feature provides support for importing images from an OpenStack image service as templates.
|
|
File statistic retrieval for non-NFS ISO domains
|
This feature adds support for retrieving statistics on files stored in ISO domains that use a storage format other than NFS, such as a local ISO domain.
|
|
Default route support
|
This feature adds support for ensuring that the default route of the management network is registered in the main routing table and that registration of the default route for all other networks is disallowed. This ensures the management network gateway is set as the default gateway for hosts.
|
|
Virtual machine reboot
|
This feature adds support for rebooting virtual machines from the User Portal or Administration Portal via a new button. To use this action on a virtual machine, you must install the guest tools on that virtual machine.
|
15.3.3. Red Hat Enterprise Virtualization 3.4 Upgrade Considerations
Important
- Upgrading to version 3.4 can only be performed from version 3.3
- To upgrade a previous version of Red Hat Enterprise Virtualization earlier than Red Hat Enterprise Virtualization 3.3 to Red Hat Enterprise Virtualization 3.4, you must sequentially upgrade to any newer versions of Red Hat Enterprise Virtualization before upgrading to the latest version. For example, if you are using Red Hat Enterprise Virtualization 3.2, you must upgrade to Red Hat Enterprise Virtualization 3.3 before you can upgrade to Red Hat Enterprise Virtualization 3.4.
- Red Hat Enterprise Virtualization Manager cannot be installed on the same machine as IPA
- An error message displays if the ipa-server package is installed. Red Hat Enterprise Virtualization Manager 3.4 does not support installation on the same machine as Identity Management (IdM). To resolve this issue, you must migrate the IdM configuration to another system before re-attempting the upgrade.
- Upgrading to JBoss Enterprise Application Platform 6.2 is recommended
- Although Red Hat Enterprise Virtualization Manager 3.4 supports Enterprise Application Platform 6.1.0, upgrading to the latest supported version of JBoss is recommended.
- Reports and the Data Warehouse are now installed via
engine-setup - From Red Hat Enterprise Virtualization 3.4, the Reports and Data Warehouse features are configured and upgraded using the
engine-setupcommand. If you have configured the Reports and Data Warehouse features in your Red Hat Enterprise Virtualization 3.3 environment, you must install the rhevm-reports-setup and rhevm-dwh-setup packages prior to upgrading to Red Hat Enterprise Virtualization 3.4 to ensure these features are detected byengine-setup.
15.3.4. Upgrading to Red Hat Enterprise Virtualization Manager 3.4
Important
engine-setup command will attempt to roll your Red Hat Enterprise Virtualization Manager installation back to its previous state. For this reason, the repositories required by Red Hat Enterprise Virtualization 3.3 must not be removed until after the upgrade is complete as outlined below. If the upgrade fails, detailed instructions display that explain how to restore your installation.
Procedure 15.6. Upgrading to Red Hat Enterprise Virtualization Manager 3.4
- Subscribe the system on which the Red Hat Enterprise Virtualization Manager is installed to the required entitlements for receiving Red Hat Enterprise Virtualization Manager 3.4 packages.
- With RHN Classic:
# rhn-channel --add --channel=rhel-x86_64-server-6-rhevm-3.4
- With Subscription Manager:
# subscription-manager repos --enable=rhel-6-server-rhevm-3.4-rpms
- Update the base operating system:
# yum update
- Update the rhevm-setup package:
# yum update rhevm-setup
- Run the following command and follow the prompts to upgrade the Red Hat Enterprise Virtualization Manager:
# engine-setup
- Remove or disable the Red Hat Enterprise Virtualization Manager 3.3 repositories to ensure the system does not use any Red Hat Enterprise Virtualization Manager 3.3 packages.
- With RHN Classic:
# rhn-channel --remove --channel=rhel-x86_64-server-6-rhevm-3.3
- With Subscription Manager:
# subscription-manager repos --disable=rhel-6-server-rhevm-3.3-rpms
15.4. Upgrading to Red Hat Enterprise Virtualization 3.3
15.4.1. Red Hat Enterprise Virtualization Manager 3.3 Upgrade Overview
- Subscribing to entitlements.
- Updating the required packages.
- Performing the upgrade.
engine-setup, which provides an interactive interface. While the upgrade is in process, virtualization hosts and the virtual machines running on those virtualization hosts continue to operate independently. When the upgrade is complete, you can then upgrade your hosts to the latest versions of Red Hat Enterprise Linux or Red Hat Enterprise Virtualization Hypervisor.
15.4.2. Features Requiring a Compatibility Upgrade to Red Hat Enterprise Virtualization 3.3
Table 15.3. Features Requiring a Compatibility Upgrade to Red Hat Enterprise Virtualization 3.3
| Feature | Description |
|---|---|
|
Libvirt-to-libvirt virtual machine migration
|
Perform virtual machine migration using libvirt-to-libvirt communication. This is safer, more secure, and has less host configuration requirements than native KVM migration, but has a higher overhead on the host CPU.
|
|
Isolated network to carry virtual machine migration traffic
|
Separates virtual machine migration traffic from other traffic types, like management and display traffic. Reduces chances of migrations causing a network flood that disrupts other important traffic types.
|
|
Define a gateway per logical network
|
Each logical network can have a gateway defined as separate from the management network gateway. This allows more customizable network topologies.
|
|
Snapshots including RAM
|
Snapshots now include the state of a virtual machine's memory as well as disk.
|
|
Optimized iSCSI device driver for virtual machines
|
Virtual machines can now consume iSCSI storage as virtual hard disks using an optimized device driver.
|
|
Host support for MOM management of memory overcommitment
|
MOM is a policy-driven tool that can be used to manage overcommitment on hosts. Currently MOM supports control of memory ballooning and KSM.
|
|
GlusterFS data domains.
|
Native support for the GlusterFS protocol was added as a way to create storage domains, allowing Gluster data centers to be created.
|
|
Custom device property support
|
In addition to defining custom properties of virtual machines, you can also define custom properties of virtual machine devices.
|
|
Multiple monitors using a single virtual PCI device
|
Drive multiple monitors using a single virtual PCI device, rather than one PCI device per monitor.
|
|
Updatable storage server connections
|
It is now possible to edit the storage server connection details of a storage domain.
|
|
Check virtual hard disk alignment
|
Check if a virtual disk, the filesystem installed on it, and its underlying storage are aligned. If it is not aligned, there may be a performance penalty.
|
|
Extendable virtual machine disk images
|
You can now grow your virtual machine disk image when it fills up.
|
|
OpenStack Image Service integration
|
Red Hat Enterprise Virtualization supports the OpenStack Image Service. You can import images from and export images to an Image Service repository.
|
|
Gluster hook support
|
You can manage Gluster hooks, which extend volume life cycle events, from Red Hat Enterprise Virtualization Manager.
|
|
Gluster host UUID support
|
This feature allows a Gluster host to be identified by the Gluster server UUID generated by Gluster in addition to identifying a Gluster host by IP address.
|
|
Network quality of service (QoS) support
|
Limit the inbound and outbound network traffic at the virtual NIC level.
|
|
Cloud-Init support
|
Cloud-Init allows you to automate early configuration tasks in your virtual machines, including setting hostnames, authorized keys, and more.
|
15.4.3. Red Hat Enterprise Virtualization 3.3 Upgrade Considerations
Important
- Upgrading to version 3.3 can only be performed from version 3.2
- Users of Red Hat Enterprise Virtualization 3.1 must migrate to Red Hat Enterprise Virtualization 3.2 before attempting to upgrade to Red Hat Enterprise Virtualization 3.3.
- Red Hat Enterprise Virtualization Manager cannot be installed on the same machine as IPA
- An error message displays if the ipa-server package is installed. Red Hat Enterprise Virtualization Manager 3.3 does not support installation on the same machine as Identity Management (IdM). To resolve this issue, you must migrate the IdM configuration to another system before re-attempting the upgrade. For further information, see https://access.redhat.com/knowledge/articles/233143.
Error: IPA was found to be installed on this machine. Red Hat Enterprise Virtualization Manager 3.3 does not support installing IPA on the same machine. Please remove ipa packages before you continue.
- Upgrading to JBoss Enterprise Application Platform 6.1.0 is recommended
- Although Red Hat Enterprise Virtualization Manager 3.3 supports Enterprise Application Platform 6.0.1, upgrading to the latest supported version of JBoss is recommended. For more information on upgrading to JBoss Enterprise Application Platform 6.1.0, see Upgrade the JBoss EAP 6 RPM Installation.
- The rhevm-upgrade command has been replaced by engine-setup
- From Version 3.3, installation of Red Hat Enterprise Virtualization Manager supports
otopi, a standalone, plug-in-based installation framework for setting up system components. Under this framework, therhevm-upgradecommand used during the installation process has been updated toengine-setupand is now obsolete.
15.4.4. Upgrading to Red Hat Enterprise Virtualization Manager 3.3
engine-setup command will attempt to roll your Red Hat Enterprise Virtualization Manager installation back to its previous state. For this reason, the repositories required by Red Hat Enterprise Virtualization 3.2 must not be removed until after the upgrade is complete as outlined below. If the upgrade fails, detailed instructions display that explain how to restore your installation.
Procedure 15.7. Upgrading to Red Hat Enterprise Virtualization Manager 3.3
- Subscribe the system to the required entitlements for receiving Red Hat Enterprise Virtualization Manager 3.3 packages.Subscription ManagerRed Hat Enterprise Virtualization 3.3 packages are provided by the
rhel-6-server-rhevm-3.3-rpmsrepository associated with theRed Hat Enterprise Virtualizationentitlement. Use thesubscription-managercommand to enable the repository in youryumconfiguration.# subscription-manager repos --enable=rhel-6-server-rhevm-3.3-rpms
Red Hat Network ClassicThe Red Hat Enterprise Virtualization 3.3 packages are provided by theRed Hat Enterprise Virtualization Manager (v.3.3 x86_64)channel. Use therhn-channelcommand or the Red Hat Network web interface to subscribe to theRed Hat Enterprise Virtualization Manager (v.3.3 x86_64)channel:# rhn-channel --add --channel=rhel-x86_64-server-6-rhevm-3.3
- Update the base operating system:
# yum update
In particular, if you are using the JBoss Application Server from JBoss Enterprise Application Platform 6.0.1, you must run the above command to upgrade to Enterprise Application Platform 6.1. - Update the rhevm-setup package to ensure you have the most recent version of
engine-setup.# yum update rhevm-setup
- Run the
engine-setupcommand and follow the prompts to upgrade Red Hat Enterprise Virtualization Manager.# engine-setup [ INFO ] Stage: Initializing Welcome to the RHEV 3.3.0 upgrade. Please read the following knowledge article for known issues and updated instructions before proceeding with the upgrade. RHEV 3.3.0 Upgrade Guide: Tips, Considerations and Roll-back Issues https://access.redhat.com/articles/408623 Would you like to continue with the upgrade? (Yes, No) [Yes]: - Remove Red Hat Enterprise Virtualization Manager 3.2 repositories to ensure the system does not use any Red Hat Enterprise Virtualization Manager 3.2 packages.Subscription ManagerUse the
subscription-managercommand to disable the Red Hat Enterprise Virtualization 3.2 repository in youryumconfiguration.# subscription-manager repos --disable=rhel-6-server-rhevm-3.2-rpms
Red Hat Network ClassicUse therhn-channelcommand or the Red Hat Network web interface to remove theRed Hat Enterprise Virtualization Manager (v.3.2 x86_64)channels.# rhn-channel --remove --channel=rhel-x86_64-server-6-rhevm-3.2
- Ensure all of your virtualization hosts are up to date and running the most recent Red Hat Enterprise Linux packages or Hypervisor images.
- Change all of your clusters to use compatibility version 3.3.
- Change all of your data centers to use compatibility version 3.3.
15.5. Upgrading to Red Hat Enterprise Virtualization Manager 3.2
15.5.1. Upgrading to Red Hat Enterprise Virtualization Manager 3.2
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
Note
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 15.8. Upgrading to Red Hat Enterprise Virtualization Manager 3.2
- Ensure that the system is subscribed to the required entitlements to receive Red Hat Enterprise Virtualization Manager 3.2 packages. This procedure assumes that the system is already subscribed to required entitlements to receive Red Hat Enterprise Virtualization 3.1 packages. These must also be available to complete the upgrade process.Certificate-based Red Hat NetworkThe Red Hat Enterprise Virtualization 3.2 packages are provided by the
rhel-6-server-rhevm-3.2-rpmsrepository associated with theRed Hat Enterprise Virtualizationentitlement. Use thesubscription-managercommand to enable the repository in youryumconfiguration.# subscription-manager repos --enable=rhel-6-server-rhevm-3.2-rpms
Red Hat Network ClassicThe Red Hat Enterprise Virtualization 3.2 packages are provided by theRed Hat Enterprise Virtualization Manager (v.3.2 x86_64)channel. Use therhn-channelcommand, or the Red Hat Network Web Interface, to subscribe to theRed Hat Enterprise Virtualization Manager (v.3.2 x86_64)channel.# rhn-channel --add --channel=rhel-x86_64-server-6-rhevm-3.2
- Ensure that the system does not use any Red Hat Enterprise Virtualization Manager 3.1 packages by removing the Red Hat Enterprise Virtualization Manager 3.1 entitlements.Certificate-based Red Hat NetworkUse the
subscription-managercommand to disable the Red Hat Enterprise Virtualization 3.1 repository in youryumconfiguration. Thesubscription-managercommand must be run while logged in as therootuser.# subscription-manager repos --disable=rhel-6-server-rhevm-3.1-rpms
Red Hat Network ClassicUse therhn-channelcommand, or the Red Hat Network Web Interface, to remove theRed Hat Enterprise Virtualization Manager (v.3.1 x86_64)channels.# rhn-channel --remove --channel=rhel-6-server-rhevm-3.1
- Update the base operating system:
# yum update
- To ensure that you have the most recent version of the
rhevm-upgradecommand installed you must update the rhevm-setup package.# yum update rhevm-setup
- To upgrade Red Hat Enterprise Virtualization Manager run the
rhevm-upgradecommand.# rhevm-upgrade Loaded plugins: product-id, rhnplugin Info: RHEV Manager 3.1 to 3.2 upgrade detected Checking pre-upgrade conditions...(This may take several minutes)
- If the ipa-server package is installed then an error message is displayed. Red Hat Enterprise Virtualization Manager 3.2 does not support installation on the same machine as Identity Management (IdM).
Error: IPA was found to be installed on this machine. Red Hat Enterprise Virtualization Manager 3.2 does not support installing IPA on the same machine. Please remove ipa packages before you continue.
To resolve this issue you must migrate the IdM configuration to another system before re-attempting the upgrade. For further information see https://access.redhat.com/knowledge/articles/233143.
- 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.
15.6. Upgrading to Red Hat Enterprise Virtualization Manager 3.1
15.6.1. Upgrading to Red Hat Enterprise Virtualization Manager 3.1
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
Important
Note
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 15.9. Upgrading to Red Hat Enterprise Virtualization Manager 3.1
- Ensure that the system is subscribed to the required entitlements to receive Red Hat JBoss Enterprise Application Platform 6 packages. Red Hat JBoss Enterprise Application Platform 6 is a required dependency of Red Hat Enterprise Virtualization Manager 3.1.Certificate-based Red Hat NetworkThe Red Hat JBoss Enterprise Application Platform 6 packages are provided by the
Red Hat JBoss Enterprise Application Platformentitlement in certificate-based Red Hat Network.Use thesubscription-managercommand to ensure that the system is subscribed to theRed Hat JBoss Enterprise Application Platformentitlement.# subscription-manager list
Red Hat Network ClassicThe Red Hat JBoss Enterprise Application Platform 6 packages are provided by theRed Hat JBoss Application Platform (v 6) for 6Server x86_64channel. The Channel Entitlement Name for this channel isRed Hat JBoss Enterprise Application Platform (v 4, zip format).Use therhn-channelcommand, or the Red Hat Network Web Interface, to subscribe to theRed Hat JBoss Application Platform (v 6) for 6Server x86_64channel. - Ensure that the system is subscribed to the required channels and entitlements to receive Red Hat Enterprise Virtualization Manager 3.1 packages.Certificate-based Red Hat NetworkThe Red Hat Enterprise Virtualization 3.1 packages are provided by the
rhel-6-server-rhevm-3.1-rpmsrepository associated with theRed Hat Enterprise Virtualizationentitlement. Use thesubscription-managercommand to enable the repository in youryumconfiguration. Thesubscription-managercommand must be run while logged in as therootuser.# subscription-manager repos --enable=rhel-6-server-rhevm-3.1-rpms
Red Hat Network ClassicThe Red Hat Enterprise Virtualization 3.1 packages are provided by theRed Hat Enterprise Virtualization Manager (v.3.1 x86_64)channel.Use therhn-channelcommand, or the Red Hat Network Web Interface, to subscribe to theRed Hat Enterprise Virtualization Manager (v.3.1 x86_64)channel. - Ensure that the system does not use any Red Hat Enterprise Virtualization Manager 3.0 packages by removing the Red Hat Enterprise Virtualization Manager 3.0 channels and entitlements.Certificate-based Red Hat NetworkUse the
subscription-managercommand to disable the Red Hat Enterprise Virtualization 3.0 repositories in youryumconfiguration.# subscription-manager repos --disable=rhel-6-server-rhevm-3-rpms
# subscription-manager repos --disable=jb-eap-5-for-rhel-6-server-rpms
Red Hat Network ClassicUse therhn-channelcommand, or the Red Hat Network Web Interface, to remove theRed Hat Enterprise Virtualization Manager (v.3.0 x86_64)channels.# rhn-channel --remove --channel=rhel-6-server-rhevm-3
# rhn-channel --remove --channel=jbappplatform-5-x86_64-server-6-rpm
- Update the base operating system.
# yum update
- To ensure that you have the most recent version of the
rhevm-upgradecommand installed you must update the rhevm-setup package.# yum update rhevm-setup
- To upgrade Red Hat Enterprise Virtualization Manager run the
rhevm-upgradecommand.# rhevm-upgrade Loaded plugins: product-id, rhnplugin Info: RHEV Manager 3.0 to 3.1 upgrade detected Checking pre-upgrade conditions...(This may take several minutes)
- If the ipa-server package is installed then an error message is displayed. Red Hat Enterprise Virtualization Manager 3.1 does not support installation on the same machine as Identity Management (IdM).
Error: IPA was found to be installed on this machine. Red Hat Enterprise Virtualization Manager 3.1 does not support installing IPA on the same machine. Please remove ipa packages before you continue.
To resolve this issue you must migrate the IdM configuration to another system before re-attempting the upgrade. For further information see https://access.redhat.com/knowledge/articles/233143. - A list of packages that depend on Red Hat JBoss Enterprise Application Platform 5 is displayed. These packages must be removed to install Red Hat JBoss Enterprise Application Platform 6, required by Red Hat Enterprise Virtualization Manager 3.1.
Warning: the following packages will be removed if you proceed with the upgrade: * objectweb-asm Would you like to proceed? (yes|no):You must enteryesto proceed with the upgrade, removing the listed packages.
- 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.
15.7. Post-upgrade Tasks
15.7.1. Changing the Cluster Compatibility Version
Note
Procedure 15.10. Changing the Cluster Compatibility Version
- Log in to the Administration Portal as the administrative user. By default this is the
adminuser. - Click the Clusters tab.
- Select the cluster to change from the list displayed. If the list of clusters is too long to filter visually then perform a search to locate the desired cluster.
- Click the button.
- Change the Compatibility Version to the desired value.
- Click to open the Change Cluster Compatibility Version confirmation window.
- Click to confirm.
Warning
15.7.2. Changing the Data Center Compatibility Version
Note
Procedure 15.11. Changing the Data Center Compatibility Version
- Log in to the Administration Portal as the administrative user. By default this is the
adminuser. - Click the Data Centers tab.
- Select the data center to change from the list displayed. If the list of data centers is too long to filter visually then perform a search to locate the desired data center.
- Click the button.
- Change the Compatibility Version to the desired value.
- Click .
Warning
Chapter 16. Backups and Migration
16.1. Backing Up and Restoring the Red Hat Enterprise Virtualization Manager
- 16.1.1. Backing up Red Hat Enterprise Virtualization Manager - Overview
- 16.1.2. Syntax for the engine-backup Command
- 16.1.3. Creating a Backup with the engine-backup Command
- 16.1.4. Restoring a Backup with the engine-backup Command
- 16.1.5. Restoring a Backup to a Fresh Installation
- 16.1.6. Restoring a Backup to Overwrite an Existing Installation
- 16.1.7. Restoring a Backup with Different Credentials
- 16.1.8. Migrating the Engine Database to a Remote Server Database
- 16.1.9. Migrating the Data Warehouse Database to a Remote Server Database
- 16.1.10. Migrating the Reports Database to a Remote Server Database
16.1.1. Backing up Red Hat Enterprise Virtualization Manager - Overview
engine-backup command - can be used to rapidly back up the engine database and configuration files into a single file that can be easily stored.
16.1.2. Syntax for the engine-backup Command
engine-backup command works in one of two basic modes:
# engine-backup --mode=backup
# engine-backup --mode=restore
Basic Options
--mode- Specifies whether the command will perform a backup operation or a restore operation. Two options are available -
backup, andrestore. This is a required parameter. --file- Specifies the path and name of a file into which backups are to be taken in backup mode, and the path and name of a file from which to read backup data in restore mode. This is a required parameter in both backup mode and restore mode.
--log- Specifies the path and name of a file into which logs of the backup or restore operation are to be written. This parameter is required in both backup mode and restore mode.
--scope- Specifies the scope of the backup or restore operation. There are five options:
all, which backs up or restores all databases and configuration data;files, which backs up or restores only files on the system;db, which backs up or restores only the Manager database;dwhdb, which backs up or restores only the Data Warehouse database; andreportsdb, which backs up or restores only the Reports database. The default scope isall.
Manager Database Options
engine-backup command in restore mode. The option syntax below applies to restoring the Manager database. The same options exist for restoring the Data Warehouse database and the Reports database. See engine-backup --help for the option syntax.
--change-db-credentials- Allows you to specify alternate credentials for restoring the Manager database using credentials other than those stored in the backup itself. Specifying this parameter allows you to add the following parameters.
--db-host- Specifies the IP address or fully qualified domain name of the host on which the database resides. This is a required parameter.
--db-port- Specifies the port by which a connection to the database will be made.
--db-user- Specifies the name of the user by which a connection to the database will be made. This is a required parameter.
--db-passfile- Specifies a file containing the password by which a connection to the database will be made. Either this parameter or the
--db-passwordparameter must be specified. --db-password- Specifies the plain text password by which a connection to the database will be made. Either this parameter or the
--db-passfileparameter must be specified. --db-name- Specifies the name of the database to which the database will be restored. This is a required parameter.
--db-secured- Specifies that the connection with the database is to be secured.
--db-secured-validation- Specifies that the connection with the host is to be validated.
Help
--help- Provides an overview of the available modes, parameters, sample usage, how to create a new database and configure the firewall in conjunction with backing up and restoring the Red Hat Enterprise Virtualization Manager.
16.1.3. Creating a Backup with the engine-backup Command
engine-backup command can be performed while the Manager is active. Append one of the following options to --scope to specify which backup to perform:
all: A full backup of all databases and configuration files on the Managerfiles: A backup of only the files on the systemdb: A backup of only the Manager databasedwhdb: A backup of only the Data Warehouse databasereportsdb: A backup of only the Reports database
Important
all, must be accompanied by another backup using the files scope, or a filesystem backup.
Procedure 16.1. Example Usage of the engine-backup Command
- Log on to the machine running the Red Hat Enterprise Virtualization Manager.
- Create a backup:
Example 16.1. Creating a Full Backup
# engine-backup --scope=all --mode=backup --log=file name --file=file name
Example 16.2. Creating a Manager Database Backup
# engine-backup --scope=files --mode=backup --log=file name --file=file name # engine-backup --scope=db --mode=backup --log=file name --file=file name
Replace thedboption withdwhdborreportsdbto back up the Data Warehouse database or the Reports database.
tar file containing a backup is created using the path and file name provided.
16.1.4. Restoring a Backup with the engine-backup Command
engine-backup command is straightforward, it involves several additional steps in comparison to that for creating a backup depending on the destination to which the backup is to be restored. For example, the engine-backup command can be used to restore backups to fresh installations of Red Hat Enterprise Virtualization, on top of existing installations of Red Hat Enterprise Virtualization, and using local or remote databases.
Important
version file located in the root directory of the unpacked files.
16.1.5. Restoring a Backup to a Fresh Installation
engine-backup command can be used to restore a backup to a fresh installation of the Red Hat Enterprise Virtualization Manager. The following procedure must be performed on a machine on which the base operating system has been installed and the required packages for the Red Hat Enterprise Virtualization Manager have been installed, but the engine-setup command has not yet been run. This procedure assumes that the backup file can be accessed from the machine on which the backup is to be restored.
Note
engine-backup command does not handle the actual creation of the engine database or the initial configuration of the postgresql service. Therefore, these tasks must be performed manually as outlined below when restoring a backup to a fresh installation.
Procedure 16.2. Restoring a Backup to a Fresh Installation
- Log on to the machine on which the Red Hat Enterprise Virtualization Manager is installed. If you are restoring the engine database to a remote host, you will need to log on to and perform the relevant actions on that host. Likewise, if also restoring Reports and the Data Warehouse to a remote host, you will need to log on to and perform the relevant actions on that host.
- If you are using a remote database, install the postgresql-server package. This is not required for local databases as this package is included with the rhevm installation.
# yum install postgesql-server
- Manually create an empty database to which the database in the backup can be restored and configure the
postgresqlservice:- Initialize the
postgresqldatabase, start thepostgresqlservice, and ensure this service starts on boot:# service postgresql initdb # service postgresql start # chkconfig postgresql on
- Enter the postgresql command line:
# su postgres $ psql
- Create the
engineuser:postgres=# create role engine with login encrypted password 'password';
If you are also restoring the Reports and Data Warehouse, create theovirt_engine_reportsandovirt_engine_historyusers on the relevant host:postgres=# create role ovirt_engine_reports with login encrypted password 'password';
postgres=# create role ovirt_engine_history with login encrypted password 'password';
- Create the new database:
postgres=# create database database_name owner engine template template0 encoding 'UTF8' lc_collate 'en_US.UTF-8' lc_ctype 'en_US.UTF-8';
If you are also restoring the Reports and Data Warehouse, create the databases on the relevant host:postgres=# create database database_name owner ovirt_engine_reports template template0 encoding 'UTF8' lc_collate 'en_US.UTF-8' lc_ctype 'en_US.UTF-8';
postgres=# create database database_name owner ovirt_engine_history template template0 encoding 'UTF8' lc_collate 'en_US.UTF-8' lc_ctype 'en_US.UTF-8';
- Exit the postgresql command line and log out of the postgres user:
postgres=# \q $ exit
- Edit the
/var/lib/pgsql/data/pg_hba.conffile as follows:- For each local database, replace the existing directives in the section starting with
localat the bottom of the file with the following directives:host database_name user_name 0.0.0.0/0 md5 host database_name user_name ::0/0 md5
- For each remote database:
- Add the following line immediately underneath the line starting with
Localat the bottom of the file, replacing X.X.X.X with the IP address of the Manager:host database_name user_name X.X.X.X/32 md5
- Allow TCP/IP connections to the database. Edit the
/var/lib/pgsql/data/postgresql.conffile and add the following line:listen_addresses='*'
This example configures thepostgresqlservice to listen for connections on all interfaces. You can specify an interface by giving its IP address. - Open the default port used for PostgreSQL database connections, and save the updated firewall rules:
# iptables -I INPUT 5 -p tcp -s Manager_IP_Address --dport 5432 -j ACCEPT # service iptables save
- Restart the
postgresqlservice:# service postgresql restart
- Restore a complete backup or a database-only backup with the
--change-db-credentialsparameter to pass the credentials of the new database. The database_location for a database local to the Manager islocalhost.Note
The following examples use a--*passwordoption for each database without specifying a password, which will prompt for a password for each database. Passwords can be supplied for these options in the command itself, however this is not recommended as the password will then be stored in the shell history. Alternatively,--*passfile=password_file options can be used for each database to securely pass the passwords to theengine-backuptool without the need for interactive prompts.- Restore a complete backup:
# engine-backup --mode=restore --file=file_name --log=log_file_name --change-db-credentials --db-host=database_location --db-name=database_name --db-user=engine --db-password
If Reports and Data Warehouse are also being restored as part of the complete backup, include the revised credentials for the two additional databases:engine-backup --mode=restore --file=file_name --log=log_file_name --change-db-credentials --db-host=database_location --db-name=database_name --db-user=engine --db-password --change-reports-db-credentials --reports-db-host=database_location --reports-db-name=database_name --reports-db-user=ovirt_engine_reports --reports-db-password --change-dwh-db-credentials --dwh-db-host=database_location --dwh-db-name=database_name --dwh-db-user=ovirt_engine_history --dwh-db-password
- Restore a database-only backup by first restoring the configuration files backup and then restoring the database backup:
# engine-backup --mode=restore --scope=files --file=file_name --log=log_file_name
# engine-backup --mode=restore --scope=db --file=file_name --log=log_file_name --change-db-credentials --db-host=database_location --db-name=database_name --db-user=engine --db-password
The example above restores a backup of the Manager database.# engine-backup --mode=restore --scope=reportsdb --file=file_name --log=log_file_name --change-reports-db-credentials --reports-db-host=database_location --reports-db-name=database_name --reports-db-user=ovirt_engine_reports --reports-db-password
The example above restores a backup of the Reports database.# engine-backup --mode=restore --scope=dwhdb --file=file_name --log=log_file_name --change-dwh-db-credentials --dwh-db-host=database_location --dwh-db-name=database_name --dwh-db-user=ovirt_engine_history --dwh-db-password
The example above restores a backup of the Data Warehouse database.
If successful, the following output displays:You should now run engine-setup. Done.
- Log on to the Manager machine. Run the following command and follow the prompts to configure the restored Manager:
# engine-setup
16.1.6. Restoring a Backup to Overwrite an Existing Installation
engine-backup command can restore a backup to a machine on which the Red Hat Enterprise Virtualization Manager has already been installed and set up. This is useful when you have taken a backup up of an installation, performed changes on that installation and then want to restore the installation from the backup.
Important
engine-cleanup command to clean up the existing installation before using the engine-backup command. Because the engine-cleanup command only cleans the engine database, and does not drop the database or delete the user that owns that database, you do not need to create a new database or specify the database credentials because the user and database already exist.
Procedure 16.3. Restoring a Backup to Overwrite an Existing Installation
- Log on to the machine on which the Red Hat Enterprise Virtualization Manager is installed.
- Run the following command and follow the prompts to remove the configuration files for and clean the database associated with the Manager:
# engine-cleanup
- Restore a full backup or a database-only backup:
- Restore a full backup:
# engine-backup --mode=restore --file=file_name --log=log_file_name
- Restore a database-only backup by first restoring the configuration files backup and then restoring the database backup:
# engine-backup --mode=restore --scope=files --file=file_name --log=log_file_name
# engine-backup --mode=restore --scope=db --file=file_name --log=log_file_name
The example above restores a backup of the Manager database. If necessary, also restore the Reports and Data Warehouse databases:# engine-backup --mode=restore --scope=reportsdb --file=file_name --log=log_file_name
# engine-backup --mode=restore --scope=dwhdb --file=file_name --log=log_file_name
If successful, the following output displays:You should now run engine-setup. Done.
- Run the following command and follow the prompts to reconfigure the firewall and ensure the
ovirt-engineservice is correctly configured:# engine-setup
16.1.7. Restoring a Backup with Different Credentials
engine-backup command can restore a backup to a machine on which the Red Hat Enterprise Virtualization Manager has already been installed and set up, but the credentials of the database in the backup are different to those of the database on the machine on which the backup is to be restored. This is useful when you have taken a backup of an installation and want to restore the installation from the backup to a different system.
Important
engine-cleanup command to clean up the existing installation before using the engine-backup command. Because the engine-cleanup command only cleans the engine database, and does not drop the database or delete the user that owns that database, you do not need to create a new database or specify the database credentials because the user and database already exist. However, if the credentials for the owner of the engine database are not known, you must change them before you can restore the backup.
Procedure 16.4. Restoring a Backup with Different Credentials
- Log on to the machine on which the Red Hat Enterprise Virtualization Manager is installed.
- Run the following command and follow the prompts to remove the configuration files for and clean the database associated with the Manager:
# engine-cleanup
- Change the password for the owner of the engine database if the credentials of that user are not known:
- Enter the postgresql command line:
# su postgres $ psql
- Change the password of the user that owns the
enginedatabase:postgres=# alter role user_name encrypted password 'new_password';
Repeat this for the users that own theovirt_engine_reportsandovirt_engine_dwhdatabases if necessary.
- Restore a complete backup or a database-only backup with the
--change-db-credentialsparameter to pass the credentials of the new database. The database_location for a database local to the Manager islocalhost.Note
The following examples use a--*passwordoption for each database without specifying a password, which will prompt for a password for each database. Passwords can be supplied for these options in the command itself, however this is not recommended as the password will then be stored in the shell history. Alternatively,--*passfile=password_file options can be used for each database to securely pass the passwords to theengine-backuptool without the need for interactive prompts.- Restore a complete backup:
# engine-backup --mode=restore --file=file_name --log=log_file_name --change-db-credentials --db-host=database_location --db-name=database_name --db-user=engine --db-password
If Reports and Data Warehouse are also being restored as part of the complete backup, include the revised credentials for the two additional databases:engine-backup --mode=restore --file=file_name --log=log_file_name --change-db-credentials --db-host=database_location --db-name=database_name --db-user=engine --db-password --change-reports-db-credentials --reports-db-host=database_location --reports-db-name=database_name --reports-db-user=ovirt_engine_reports --reports-db-password --change-dwh-db-credentials --dwh-db-host=database_location --dwh-db-name=database_name --dwh-db-user=ovirt_engine_history --dwh-db-password
- Restore a database-only backup by first restoring the configuration files backup and then restoring the database backup:
# engine-backup --mode=restore --scope=files --file=file_name --log=log_file_name
# engine-backup --mode=restore --scope=db --file=file_name --log=log_file_name --change-db-credentials --db-host=database_location --db-name=database_name --db-user=engine --db-password
The example above restores a backup of the Manager database.# engine-backup --mode=restore --scope=reportsdb --file=file_name --log=log_file_name --change-reports-db-credentials --reports-db-host=database_location --reports-db-name=database_name --reports-db-user=ovirt_engine_reports --reports-db-password
The example above restores a backup of the Reports database.# engine-backup --mode=restore --scope=dwhdb --file=file_name --log=log_file_name --change-dwh-db-credentials --dwh-db-host=database_location --dwh-db-name=database_name --dwh-db-user=ovirt_engine_history --dwh-db-password
The example above restores a backup of the Data Warehouse database.
If successful, the following output displays:You should now run engine-setup. Done.
- Run the following command and follow the prompts to reconfigure the firewall and ensure the
ovirt-engineservice is correctly configured:# engine-setup
16.1.8. Migrating the Engine Database to a Remote Server Database
engine database to a remote database server after the Red Hat Enterprise Virtualization Manager has been initially configured.
pg_dump and pg_restore commands to handle the database backup and restore. As such, it is necessary to edit the /etc/ovirt-engine/engine.conf.d/10-setup-database.conf file with the updated information. At a minimum, you must update the location of the new database server. If the database name, role name, or password are modified for the new database server, these values must also be updated in the 10-setup-database.conf file. This procedure uses the default engine database settings to minimize modification of this file.
Note
10-setup-database.conf file also uses the address of the engine database. If Data Warehouse is installed, update the engine database values in both the /etc/ovirt-engine/engine.conf.d/10-setup-database.conf and the /etc/ovirt-engine-dwh/ovirt-engine-dwhd.conf.d/10-setup-database.conf file.
Procedure 16.5. Preparing the Remote PostgreSQL Database for use with the Red Hat Enterprise Virtualization Manager
- Log in to the remote database server and install the PostgreSQL server package:
# yum install postgresql-server
- Initialize the PostgreSQL database, start the
postgresqlservice, and ensure that this service starts on boot:# service postgresql initdb # service postgresql start # chkconfig postgresql on
- Connect to the psql command line interface as the
postgresuser:# su - postgres $ psql
- Create a user for the Manager to use when it writes to and reads from the database. The default user name on the Manager is
engine:postgres=# create role user_name with login encrypted password 'password';
Note
The password for theengineuser is located in plain text in/etc/ovirt-engine/engine.conf.d/10-setup-database.conf. Any password can be used when creating the role on the new server, however if a different password is used then this file must be updated with the new password. - Create a database in which to store data about the Red Hat Enterprise Virtualization environment. The default database name on the Manager is
engine, and the default user name isengine:postgres=# create database database_name owner user_name template template0 encoding 'UTF8' lc_collate 'en_US.UTF-8' lc_ctype 'en_US.UTF-8';
- Ensure the database can be accessed remotely by enabling md5 client authentication. Edit the
/var/lib/pgsql/data/pg_hba.conffile, and add the following line immediately underneath the line starting withlocalat the bottom of the file, replacing X.X.X.X with the IP address of the Manager:host database_name user_name X.X.X.X/32 md5
- Allow TCP/IP connections to the database. Edit the
/var/lib/pgsql/data/postgresql.conffile and add the following line:listen_addresses='*'
This example configures thepostgresqlservice to listen for connections on all interfaces. You can specify an interface by giving its IP address. - Open the default port used for PostgreSQL database connections, and save the updated firewall rules:
# iptables -I INPUT 5 -p tcp --dport 5432 -j ACCEPT # service iptables save
- Restart the
postgresqlservice:# service postgresql restart
Procedure 16.6. Migrating the Database
- Log in to the Red Hat Enterprise Virtualization Manager machine and stop the
ovirt-engineservice so that it does not interfere with the engine backup:# service ovirt-engine stop
- Create the
enginedatabase backup using the PostgreSQLpg_dumpcommand:# su - postgres -c 'pg_dump -F c engine -f /tmp/engine.dump'
- Copy the backup file to the new database server. The target directory must allow write access for the
postgresuser:# scp /tmp/engine.dump root@new.database.server.com:/tmp/engine.dump
- Log in to the new database server and restore the database using the PostgreSQL
pg_restorecommand:# su - postgres -c 'pg_restore -d engine /tmp/engine.dump'
- Log in to the Manager server and update the
/etc/ovirt-engine/engine.conf.d/10-setup-database.confand replace thelocalhostvalue ofENGINE_DB_HOSTwith the IP address of the new database server. If the engine name, role name, or password differ on the new database server, update those values in this file.If Data Warehouse is installed, these values also need to be updated in the/etc/ovirt-engine-dwh/ovirt-engine-dwhd.conf.d/10-setup-database.conffile. - Now that the database has been migrated, start the
ovirt-engineservice:# service ovirt-engine start
16.1.9. Migrating the Data Warehouse Database to a Remote Server Database
ovirt_engine_history database to a remote database server after the Red Hat Enterprise Virtualization Manager has been initially configured.
pg_dump and pg_restore commands to handle the database backup and restore. As such, it is necessary to edit the /etc/ovirt-engine-reports/ovirt-engine-reports.conf.d/10-setup-database.conf and /etc/ovirt-engine-dwh/ovirt-engine-dwhd.conf.d/10-setup-database.conf files with the updated information. At a minimum, you must update the location of the new database server. If the database name, role name, or password are modified for the new database server, these values must also be updated in both 10-setup-database.conf files. This procedure uses the default ovirt_engine_history database settings to minimize modification of this file.
Procedure 16.7. Preparing the Remote PostgreSQL Database for use with the Red Hat Enterprise Virtualization Manager
- Log in to the remote database server and install the PostgreSQL server package:
# yum install postgresql-server
- Initialize the PostgreSQL database, start the
postgresqlservice, and ensure that this service starts on boot:# service postgresql initdb # service postgresql start # chkconfig postgresql on
- Connect to the psql command line interface as the
postgresuser:# su - postgres $ psql
- Create a user for the Manager to use when it writes to and reads from the database. The default user name for the
ovirt_engine_historydatabase isovirt_engine_history:postgres=# create role user_name with login encrypted password 'password';
Note
The password for theovirt_engine_historyuser is located in plain text in/etc/ovirt-engine-dwh/ovirt-engine-dwhd.conf.d/10-setup-database.conf. Any password can be used when creating the role on the new server, however if a different password is used then this file, and the/etc/ovirt-engine-reports/ovirt-engine-reports.conf.d/10-setup-database.conffile, must be updated with the new password. - Create a database in which to store the history of the Red Hat Enterprise Virtualization environment. The default database name is
ovirt_engine_history, and the default user name isovirt_engine_history:postgres=# create database database_name owner user_name template template0 encoding 'UTF8' lc_collate 'en_US.UTF-8' lc_ctype 'en_US.UTF-8';
- Ensure the database can be accessed remotely by enabling md5 client authentication. Edit the
/var/lib/pgsql/data/pg_hba.conffile, and add the following line immediately underneath the line starting withlocalat the bottom of the file, replacing X.X.X.X with the IP address of the Manager:host database_name user_name X.X.X.X/32 md5
- Allow TCP/IP connections to the database. Edit the
/var/lib/pgsql/data/postgresql.conffile and add the following line:listen_addresses='*'
This example configures thepostgresqlservice to listen for connections on all interfaces. You can specify an interface by giving its IP address. - Open the default port used for PostgreSQL database connections, and save the updated firewall rules:
# iptables -I INPUT 5 -p tcp --dport 5432 -j ACCEPT # service iptables save
- Restart the
postgresqlservice:# service postgresql restart
Procedure 16.8. Migrating the Database
- Log in to the Red Hat Enterprise Virtualization Manager machine and stop the
ovirt-engine-dwhdservice so that it does not interfere with the engine backup:# service ovirt-engine-dwhd stop
- Create the
ovirt_engine_historydatabase backup using the PostgreSQLpg_dumpcommand:# su - postgres -c 'pg_dump -F c ovirt_engine_history -f /tmp/ovirt_engine_history.dump'
- Copy the backup file to the new database server. The target directory must allow write access for the
postgresuser:# scp /tmp/ovirt_engine_history.dump root@new.database.server.com:/tmp/ovirt_engine_history.dump
- Log in to the new database server and restore the database using the PostgreSQL
pg_restorecommand:# su - postgres -c 'pg_restore -d ovirt_engine_history /tmp/ovirt_engine_history.dump'
- Log in to the Manager server and update the
/etc/ovirt-engine-reports/ovirt-engine-reports.conf.d/10-setup-database.confand/etc/ovirt-engine-dwh/ovirt-engine-dwhd.conf.d/10-setup-database.conffiles, replacing thelocalhostvalue ofDWH_DB_HOSTwith the IP address of the new database server. If theDWH_DB_DATABASE,DWH_DB_USER, orDWH_DB_PASSWORDdiffer on the new database server, update those values in these files.If the Manager database has also been migrated, these values must also be updated in the/etc/ovirt-engine-dwh/ovirt-engine-dwhd.conf.d/10-setup-database.conffile. - Use a web browser to log in to the Reports portal atusing the
https://hostname.example.com/ovirt-engine-reports
superuseruser name. Click → to open the Folders side pane. - In the Folders side pane, select → → → .
- Select oVirt History and click .
- Update the Host (required) field with the IP address of the new database server and click .
- Now that the database has been migrated and the Reports portal connects to it, start the
ovirt-engine-dwhdservice:# service ovirt-engine-dwhd start
16.1.10. Migrating the Reports Database to a Remote Server Database
ovirt_engine_reports database to a remote database server after the Red Hat Enterprise Virtualization Manager has been initially configured.
pg_dump and pg_restore commands to handle the database backup and restore. As such, it is necessary to edit the /var/lib/ovirt-engine-reports/build-conf/master.properties file with the updated information. At a minimum, you must update the location of the new database server. If the database name, role name, or password are modified for the new database server, these values must also be updated in both master.properties files. This procedure uses the default ovirt_engine_reports database settings to minimize modification of this file.
Procedure 16.9. Preparing the Remote PostgreSQL Database for use with the Red Hat Enterprise Virtualization Manager
- Log in to the remote database server and install the PostgreSQL server package:
# yum install postgresql-server
- Initialize the PostgreSQL database, start the
postgresqlservice, and ensure that this service starts on boot:# service postgresql initdb # service postgresql start # chkconfig postgresql on
- Connect to the psql command line interface as the
postgresuser:# su - postgres $ psql
- Create a user for the Manager to use when it writes to and reads from the database. The default user name for the
ovirt_engine_reportsdatabase isovirt_engine_reports:postgres=# create role user_name with login encrypted password 'password';
Note
The password for theovirt_engine_reportsuser is located in plain text in/var/lib/ovirt-engine-reports/build-conf/master.properties. Any password can be used when creating the role on the new server, however if a different password is used then this file must be updated with the new password. - Create a database in which to store the history of the Red Hat Enterprise Virtualization environment. The default database name is
ovirt_engine_reports, and the default user name isovirt_engine_reports:postgres=# create database database_name owner user_name template template0 encoding 'UTF8' lc_collate 'en_US.UTF-8' lc_ctype 'en_US.UTF-8';
- Ensure the database can be accessed remotely by enabling md5 client authentication. Edit the
/var/lib/pgsql/data/pg_hba.conffile, and add the following line immediately underneath the line starting withlocalat the bottom of the file, replacing X.X.X.X with the IP address of the Manager:host database_name user_name X.X.X.X/32 md5
- Allow TCP/IP connections to the database. Edit the
/var/lib/pgsql/data/postgresql.conffile and add the following line:listen_addresses='*'
This example configures thepostgresqlservice to listen for connections on all interfaces. You can specify an interface by giving its IP address. - Open the default port used for PostgreSQL database connections, and save the updated firewall rules:
# iptables -I INPUT 5 -p tcp --dport 5432 -j ACCEPT # service iptables save
- Restart the
postgresqlservice:# service postgresql restart
Procedure 16.10. Migrating the Database
- Log in to the Red Hat Enterprise Virtualization Manager machine and stop the
ovirt-engine-reportsdservice so that it does not interfere with the engine backup:# service ovirt-engine-reportsd stop
- Create the
ovirt_engine_reportsdatabase backup using the PostgreSQLpg_dumpcommand:# su - postgres -c 'pg_dump -F c ovirt_engine_reports -f /tmp/ovirt_engine_reports.dump'
- Copy the backup file to the new database server. The target directory must allow write access for the
postgresuser:# scp /tmp/ovirt_engine_reports.dump root@new.database.server.com:/tmp/ovirt_engine_reports.dump
- Log in to the new database server and restore the database using the PostgreSQL
pg_restorecommand:# su - postgres -c 'pg_restore -d ovirt_engine_reports /tmp/ovirt_engine_reports.dump'
- Log in to the Manager server and update
/var/lib/ovirt-engine-reports/build-conf/master.properties, replacing thelocalhostvalue ofdbHostwith the IP address of the new database server. If the ovirt_engine_reportsjs.dbName,dbUsername, ordbPassworddiffer on the new database server, update those values in this file. - Now that the database has been migrated, you must run
engine-setupto rebuild reports with the new credentials:# engine-setup
16.2. Backing Up and Restoring Virtual Machines Using the Backup and Restore API
16.2.1. The Backup and Restore API
Note
16.2.2. Backing Up a Virtual Machine
Procedure 16.11. Backing Up a Virtual Machine
- Using the REST API, create a snapshot of the virtual machine to back up:
POST /api/vms/11111111-1111-1111-1111-111111111111/snapshots/ HTTP/1.1 Accept: application/xml Content-type: application/xml <snapshot> <description>BACKUP</description> </snapshot>Note
When you take a snapshot of a virtual machine, a copy of the configuration data of the virtual machine as at the time the snapshot was taken is stored in thedataattribute of theconfigurationattribute ininitializationunder the snapshot.Important
You cannot take snapshots of disks that are marked as shareable or that are based on direct LUN disks. - Retrieve the configuration data of the virtual machine from the
dataattribute under the snapshot:GET /api/vms/11111111-1111-1111-1111-111111111111/snapshots/11111111-1111-1111-1111-111111111111 HTTP/1.1 Accept: application/xml Content-type: application/xml
- Identify the disk ID and snapshot ID of the snapshot:
GET /api/vms/11111111-1111-1111-1111-111111111111/snapshots/11111111-1111-1111-1111-111111111111/disks HTTP/1.1 Accept: application/xml Content-type: application/xml
- Attach the snapshot to the backup virtual machine and activate the disk:
POST /api/vms/22222222-2222-2222-2222-222222222222/disks/ HTTP/1.1 Accept: application/xml Content-type: application/xml <disk id="11111111-1111-1111-1111-111111111111"> <snapshot id="11111111-1111-1111-1111-111111111111"/> <active>true</active> </disk> - Use the backup software on the backup virtual machine to back up the data on the snapshot disk.
- Detach the snapshot disk from the backup virtual machine:
DELETE /api/vms/22222222-2222-2222-2222-222222222222/disks/11111111-1111-1111-1111-111111111111 HTTP/1.1 Accept: application/xml Content-type: application/xml <action> <detach>true</detach> </action> - Optionally, delete the snapshot:
DELETE /api/vms/11111111-1111-1111-1111-111111111111/snapshots/11111111-1111-1111-1111-111111111111 HTTP/1.1 Accept: application/xml Content-type: application/xml
16.2.3. Restoring a Virtual Machine
Procedure 16.12. Restoring a Virtual Machine
- In the Administration Portal, create a floating disk on which to restore the backup. See Section 13.6.1, “Creating Floating Virtual Disks” for details on how to create a floating disk.
- Attach the disk to the backup virtual machine:
POST /api/vms/22222222-2222-2222-2222-222222222222/disks/ HTTP/1.1 Accept: application/xml Content-type: application/xml <disk id="11111111-1111-1111-1111-111111111111"> </disk>
- Use the backup software to restore the backup to the disk.
- Detach the disk from the backup virtual machine:
DELETE /api/vms/22222222-2222-2222-2222-222222222222/disks/11111111-1111-1111-1111-111111111111 HTTP/1.1 Accept: application/xml Content-type: application/xml <action> <detach>true</detach> </action> - Create a new virtual machine using the configuration data of the virtual machine being restored:
POST /api/vms/ HTTP/1.1 Accept: application/xml Content-type: application/xml <vm> <cluster> <name>cluster_name</name> </cluster> <name>NAME</name> ... </vm> - Attach the disk to the new virtual machine:
POST /api/vms/33333333-3333-3333-3333-333333333333/disks/ HTTP/1.1 Accept: application/xml Content-type: application/xml <disk id="11111111-1111-1111-1111-111111111111"> </disk>
Chapter 17. Users and Roles
17.1. Introduction to Users
admin user which resides in the internal domain created during installation.
User roles and admin roles can be assigned to Red Hat Enterprise Virtualization Manager users for individual resources like virtual machines and hosts, or on a hierarchy of objects like clusters and data centers.
17.2. Directory Users
17.2.1. Directory Services Support in Red Hat Enterprise Virtualization
admin. This account is intended for use when initially configuring the environment, and for troubleshooting. To add other users to Red Hat Enterprise Virtualization you must attach a directory server to the Manager. For diectory servers implemented prior to Red Hat Enterprise Virtualization 3.5, use the Domain Management Tool with the engine-manage-domains command to manage your domains. See the The Domain Management Tool section of the Red Hat Enterprise Virtualization Administration Guide for more information. With Red Hat Enterprise Virtualization 3.5, use the new generic LDAP provider implementation. See Configuring a Generic LDAP Provider section of the Red Hat Enterprise Virtualization Administration Guide for more information.
user@domain. Attachment of more than one directory server to the Manager is also supported.
- Active Directory
- Identity Management (IdM)
- Red Hat Directory Server 9 (RHDS 9)
- OpenLDAP
- A valid pointer record (PTR) for the directory server's reverse lookup address.
- A valid service record (SRV) for LDAP over TCP port
389. - A valid service record (SRV) for Kerberos over TCP port
88. - A valid service record (SRV) for Kerberos over UDP port
88.
engine-manage-domains.
- Active Directory - http://technet.microsoft.com/en-us/windowsserver/dd448614.
- Identity Management (IdM) - http://docs.redhat.com/docs/en-US/Red_Hat_Enterprise_Linux/6/html/Identity_Management_Guide/index.html
- Red Hat Directory Server (RHDS) - http://docs.redhat.com/docs/en-US/Red_Hat_Directory_Server/index.html
- OpenLDAP - http://www.openldap.org/doc/
Important
Important
Important
sysprep in the creation of Templates and Virtual Machines, then the Red Hat Enterprise Virtualization administrative user must be delegated control over the Domain to:
- Join a computer to the domain
- Modify the membership of a group
Note
- Configure the
memberOfplug-in for RHDS to allow group membership. In particular ensure that the value of thememberofgroupattrattribute of thememberOfplug-in is set touniqueMember. In OpenLDAP, thememberOffunctionality is not called a "plugin". It is called an "overlay" and requires no configuration after installation.Consult the Red Hat Directory Server 9.0 Plug-in Guide for more information on configuring thememberOfplug-in. - Define the directory server as a service of the form
ldap/hostname@REALMNAMEin the Kerberos realm. Replace hostname with the fully qualified domain name associated with the directory server and REALMNAME with the fully qualified Kerberos realm name. The Kerberos realm name must be specified in capital letters. - Generate a
keytabfile for the directory server in the Kerberos realm. Thekeytabfile contains pairs of Kerberos principals and their associated encrypted keys. These keys allow the directory server to authenticate itself with the Kerberos realm.Consult the documentation for your Kerberos principle for more information on generating akeytabfile. - Install the
keytabfile on the directory server. Then configure RHDS to recognize thekeytabfile and accept Kerberos authentication using GSSAPI.Consult the Red Hat Directory Server 9.0 Administration Guide for more information on configuring RHDS to use an externalkeytabfile. - Test the configuration on the directory server by using the
kinitcommand to authenticate as a user defined in the Kerberos realm. Once authenticated run theldapsearchcommand against the directory server. Use the-Y GSSAPIparameters to ensure the use of Kerberos for authentication.
17.2.2. Configuring a Generic LDAP Provider
Note
Procedure 17.1. Configuring a Generic LDAP Provider
- On the Red Hat Enterprise Virtualization Manager, install the LDAP extension package:
# yum install ovirt-engine-extension-aaa-ldap
- Copy the LDAP configuration template file into the
/etc/ovirt-enginedirectory. Template files are available for active directories (ad) and other directory types (simple). This example uses the simple configuration template.# cp -r /usr/share/ovirt-engine-extension-aaa-ldap/examples/simple/. /etc/ovirt-engine
- Edit the LDAP property configuration file by uncommenting an LDAP server type and updating the domain and passwords fields.
# vi /etc/ovirt-engine/aaa/profile1.properties
Example 17.1. Example profile: LDAP server section
# # Select one # include = <openldap.properties> #include = <389ds.properties> #include = <rhds.properties> #include = <ipa.properties> #include = <iplanet.properties> #include = <rfc2307.properties> # # Server # vars.server = ldap1.company.com # # Search user and its password. # vars.user = uid=search,cn=users,cn=accounts,dc=company,dc=com vars.password = 123456 pool.default.serverset.single.server = ${global:vars.server} pool.default.auth.simple.bindDN = ${global:vars.user} pool.default.auth.simple.password = ${global:vars.password}To use TLS or SSL protocol to interact with the LDAP server, obtain the LDAP server's root CA certificate, and use it to create a public keystore file. Uncomment the following lines and specify the full path to the public keystore file and the password to access the file.Note
For more information on creating a public keystore file, see Section E.2, “Setting Up SSL or TLS Connections between the Manager and an LDAP Server”.Example 17.2. Example profile: keystore section
# Create keystore, import certificate chain and uncomment # if using tls. pool.default.ssl.startTLS = true pool.default.ssl.truststore.file = /full/path/to/myrootca.jks pool.default.ssl.truststore.password = changeit
- Review the authentication configuration file. The profile name is visible to users on the Administration Portal and the User Portal login pages. The configuration profile location must match the LDAP configuration file location. All fields can be left as default.
# vi /etc/ovirt-engine/extensions.d/profile1-authn.properties
Example 17.3. Example authentication configuration file
ovirt.engine.extension.name = profile1-authn ovirt.engine.extension.bindings.method = jbossmodule ovirt.engine.extension.binding.jbossmodule.module = org.ovirt.engine-extensions.aaa.ldap ovirt.engine.extension.binding.jbossmodule.class = org.ovirt.engineextensions.aaa.ldap.AuthnExtension ovirt.engine.extension.provides = org.ovirt.engine.api.extensions.aaa.Authn ovirt.engine.aaa.authn.profile.name = profile1 ovirt.engine.aaa.authn.authz.plugin = profile1-authz config.profile.file.1 = ../aaa/profile1.properties
- Review the authorization configuration file. The configuration profile location must match the LDAP configuration file location. All fields can be left as default.
# vi /etc/ovirt-engine/extensions.d/profile1-authz.properties
Example 17.4. Example authorization configuration file
ovirt.engine.extension.name = profile1-authz ovirt.engine.extension.bindings.method = jbossmodule ovirt.engine.extension.binding.jbossmodule.module = org.ovirt.engine-extensions.aaa.ldap ovirt.engine.extension.binding.jbossmodule.class = org.ovirt.engineextensions.aaa.ldap.AuthzExtension ovirt.engine.extension.provides = org.ovirt.engine.api.extensions.aaa.Authz config.profile.file.1 = ../aaa/profile1.properties
- Ensure that the ownership and permissions of the configuration profile are appropriate:
# chown ovirt:ovirt /etc/ovirt-engine/aaa/profile1.properties
# chmod 600 /etc/ovirt-engine/aaa/profile1.properties
- Restart the engine service.
# service ovirt-engine restart
- The ldap1 profile you have created is now available on the Administration Portal and the User Portal login pages. To give the user accounts on the LDAP server appropriate permissions, for example to log in to the User Portal, see the Red Hat Enterprise Virtualization Manager User Tasks section of the Red Hat Enterprise Virtualization Administration Guide.
Note
/usr/share/doc/ovirt-engine-extension-aaa-ldap-version.
17.2.3. Single Sign-On to the Administration and User Portal
Note
17.2.3.1. Configuring LDAP and Kerberos for Single Sign-on
- The existing Key Distribution Center (KDC) server uses the MIT version of Kerberos 5.
- You have administrative rights to the KDC server.
- The Kerberos client is installed on the Red Hat Enterprise Virtualization Manager and user machines.
- The
kadminutility is used to create Kerberos service principals andkeytabfiles.
On the KDC server
- Create a service principal and a
keytabfile for the Apache service on the Red Hat Enterprise Virtualization Manager.
On the Red Hat Enterprise Virtualization Manager
- Install the Manager's authentication and authorization extension packages and the Apache Kerberos authentication module.
- Configure the extension files.
Procedure 17.2. Configuring Kerberos for the Apache Service
- On the KDC server, use the
kadminutility to create a service principal for the Apache service on the Red Hat Enterprise Virtualization Manager. The service principal is a reference ID to the KDC for the Apache service.# kadmin kadmin> addprinc -randkey HTTP/fqdn-of-rhevm@REALM.COM
- Generate a
keytabfile for the Apache service. Thekeytabfile stores the shared secret key.kadmin> ktadd -k /tmp/http.keytab HTTP/fqdn-of-rhevm@REALM.COM
kadmin> quit
- Copy the
keytabfile from the KDC server to the Red Hat Enterprise Virtualization Manager:# scp /tmp/http.keytab root@rhevm.example.com:/etc/httpd
Procedure 17.3. Configuring Single Sign-on to the User Portal or Administration Portal
- On the Red Hat Enterprise Virtualization Manager, ensure that the ownership and permissions for the keytab are appropriate:
# chown apache /etc/httpd/http.keytab
# chmod 400 /etc/httpd/http.keytab
- Install the authentication extension package, LDAP extension package, and the
mod_auth_kerbauthentication module:# yum install ovirt-engine-extension-aaa-misc ovirt-engine-extension-aaa-ldap mod_auth_kerb
- Copy the SSO configuration template file into the
/etc/ovirt-enginedirectory. Template files are available for Active Directory (ad-sso) and other directory types (simple-sso). This example uses the simple SSO configuration template# cp -r /usr/share/ovirt-engine-extension-aaa-ldap/examples/simple-sso/. /etc/ovirt-engine
- Create a symbolic link for the
/etc/httpd/conf.ddirectory for Apache to use the SSO configuration files:# ln -s /etc/ovirt-engine/aaa/ovirt-sso.conf /etc/httpd/conf.d
- Edit the authentication method file for Apache to use Kerberos for authentication:
# vi /etc/ovirt-engine/aaa/ovirt-sso.conf
Example 17.5. Example authentication method file
<LocationMatch ^(/ovirt-engine/(webadmin|userportal|api)|/api)> RewriteEngine on RewriteCond %{LA-U:REMOTE_USER} ^(.*)$ RewriteRule ^(.*)$ - [L,P,E=REMOTE_USER:%1] RequestHeader set X-Remote-User %{REMOTE_USER}s AuthType Kerberos AuthName "Kerberos Login" Krb5Keytab /etc/httpd/http.keytab KrbAuthRealms REALM.COM Require valid-user </LocationMatch> - Edit the LDAP property configuration file by uncommenting an LDAP server type and updating the domain and passwords fields:
# vi /etc/ovirt-engine/aaa/profile1.properties
Example 17.6. Example profile: LDAP server section
# # Select one # include = <openldap.properties> #include = <389ds.properties> #include = <rhds.properties> #include = <ipa.properties> #include = <iplanet.properties> #include = <rfc2307.properties> # # Server # vars.server = ldap1.company.com # # Search user and its password. # vars.user = uid=search,cn=users,cn=accounts,dc=company,dc=com vars.password = 123456 pool.default.serverset.single.server = ${global:vars.server} pool.default.auth.simple.bindDN = ${global:vars.user} pool.default.auth.simple.password = ${global:vars.password}To use TLS or SSL protocol to interact with the LDAP server, obtain the LDAP server's root CA certificate, and use it to create a public keystore file. Uncomment the following lines and specify the full path to the public keystore file and the password to access the file.Note
For more information on creating a public keystore file, see Section E.2, “Setting Up SSL or TLS Connections between the Manager and an LDAP Server”.Example 17.7. Example profile: keystore section
# Create keystore, import certificate chain and uncomment # if using ssl/tls. pool.default.ssl.startTLS = true pool.default.ssl.truststore.file = /full/path/to/myrootca.jks pool.default.ssl.truststore.password = changeit
- Review the authentication configuration file. The profile name is visible to users on the Administration Portal and the User Portal login pages. The configuration profile location must match the LDAP configuration file location. All fields can be left as default.
# vi /etc/ovirt-engine/extensions.d/profile1-http-authn.properties
Example 17.8. Example authentication configuration file
ovirt.engine.extension.name = profile1-authn ovirt.engine.extension.bindings.method = jbossmodule ovirt.engine.extension.binding.jbossmodule.module = org.ovirt.engine-extensions.aaa.ldap ovirt.engine.extension.binding.jbossmodule.class = org.ovirt.engineextensions.aaa.ldap.AuthnExtension ovirt.engine.extension.provides = org.ovirt.engine.api.extensions.aaa.Authn ovirt.engine.aaa.authn.profile.name = profile1-http ovirt.engine.aaa.authn.authz.plugin = profile1-authz ovirt.engine.aaa.authn.mapping.plugin = http-mapping config.artifact.name = HEADER config.artifact.arg = X-Remote-User
- Review the authorization configuration file. The configuration profile location must match the LDAP configuration file location. All fields can be left as default.
# vi /etc/ovirt-engine/extensions.d/profile1-authz.properties
Example 17.9. Example authorization configuration file
ovirt.engine.extension.name = profile1-authz ovirt.engine.extension.bindings.method = jbossmodule ovirt.engine.extension.binding.jbossmodule.module = org.ovirt.engine-extensions.aaa.ldap ovirt.engine.extension.binding.jbossmodule.class = org.ovirt.engineextensions.aaa.ldap.AuthzExtension ovirt.engine.extension.provides = org.ovirt.engine.api.extensions.aaa.Authz config.profile.file.1 = ../aaa/profile1.properties
- Ensure that the ownership and permissions of the configuration profile are appropriate:
# chown ovirt:ovirt /etc/ovirt-engine/aaa/profile1.properties
# chmod 600 /etc/ovirt-engine/aaa/profile1.properties
- Restart the Apache service and the engine service:
# service httpd restart
# service ovirt-engine restart
17.3. User Authorization
17.3.1. User Authorization Model
- The user performing the action
- The type of action being performed
- The object on which the action is being performed
17.3.2. User Actions
user must have the appropriate permission for the object being acted upon. Each type of action corresponds to a permission. There are many different permissions in the system, so for simplicity:
Important
17.4. Red Hat Enterprise Virtualization Manager User Tasks
17.4.1. Adding Users
Procedure 17.4. Adding Users to Red Hat Enterprise Virtualization
- Click the Users tab to display the list of authorized users.
- Click . The Add Users and Groups window opens.
- In the Search drop down menu, select the appropriate domain. Enter a name or part of a name in the search text field, and click . Alternatively, click to view a list of all users and groups.
- Select the check boxes for the appropriate users or groups.
- Click .
17.4.2. Viewing User Information
Procedure 17.5. Viewing User Information
- Click the Users tab to display the list of authorized users.
- Select the user, or perform a search if the user is not visible on the results list.
- The details pane displays for the selected user, usually with the General tab displaying general information, such as the domain name, email and status of the user.
- The other tabs allow you to view groups, permissions, quotas, and events for the user.For example, to view the groups to which the user belongs, click the Directory Groups tab.
17.4.3. Viewing User Permissions on Resources
Procedure 17.6. Viewing User Permissions on Resources
- Use the resource tabs, tree mode, or the search function to find and select the resource in the results list.
- Click the Permissions tab of the details pane to list the assigned users, the user's role, and the inherited permissions for the selected resource.
17.4.4. Removing Users
Procedure 17.7. Removing Users
- Click the Users tab to display the list of authorized users.
- Select the user to be removed. Ensure the user is not running any virtual machines.
- Click the button. A message displays prompting you to confirm the removal. Click .
17.4.5. Resetting the Password for the Internal Administrative User
admin@internal), you must use the engine configuration tool in interactive mode.
Procedure 17.8. Resetting the Password for the Internal Administrative User
- Log in to the machine on which the Red Hat Enterprise Virtualization Manager is installed.
- Change the password in interactive mode:
# engine-config -s AdminPassword=interactive
- Apply the changes:
# service ovirt-engine restart
Chapter 18. Quotas and Service Level Agreement Policy
- 18.1. Introduction to Quota
- 18.2. Shared Quota and Individually Defined Quota
- 18.3. Quota Accounting
- 18.4. Enabling and Changing a Quota Mode in a Data Center
- 18.5. Creating a New Quota Policy
- 18.6. Explanation of Quota Threshold Settings
- 18.7. Assigning a Quota to an Object
- 18.8. Using Quota to Limit Resources by User
- 18.9. Editing Quotas
- 18.10. Removing Quotas
- 18.11. Service Level Agreement Policy Enforcement
18.1. Introduction to Quota
Table 18.1. The Two Different Kinds of Quota
| Quota type | Definition |
|---|---|
| Run-time Quota | This quota limits the consumption of runtime resources, like CPU and memory. |
| Storage Quota | This quota limits the amount of storage available. |
Table 18.2. Quota Modes
| Quota Mode | Function |
|---|---|
| Enforced | This mode puts into effect the Quota that you have set in audit mode, limiting resources to the group or user affected by the quota. |
| Audit | This mode allows you to change Quota settings. Choose this mode to increase or decrease the amount of runtime quota and the amount of storage quota available to users affected by it. |
| Disabled | This mode turns off the runtime and storage limitations defined by the quota. |
Important
18.2. Shared Quota and Individually Defined Quota
18.3. Quota Accounting
Example 18.1. Accounting example
18.4. Enabling and Changing a Quota Mode in a Data Center
Procedure 18.1. Enabling and Changing Quota in a Data Center
- Click the Data Centers tab in the Navigation Pane.
- From the list of data centers displayed in the Navigation Pane, choose the data center whose quota policy you plan to edit.
- Click in the top left of the Navigation Pane.An Edit Data Center window opens.
- In the Quota Mode drop-down, change the quota mode to Enforced.
- Click OK.
18.5. Creating a New Quota Policy
Procedure 18.2. Creating a New Quota Policy
- In tree mode, select the data center. The Quota tab appears in the Navigation Pane.
- Click the Quota tab in the Navigation Pane.
- Click in the Navigation Pane. The New Quota window opens.
- Fill in the Name field with a meaningful name.Fill in the Description field with a meaningful name.
- In the Memory & CPU section of the New Quota window, use the green slider to set Cluster Threshold.
- In the Memory & CPU section of the New Quota window, use the blue slider to set Cluster Grace.
- Click on the bottom-right of the Memory & CPU field. An Edit Quota window opens.
- Under the Memory field, select either the Unlimited radio button (to allow limitless use of Memory resources in the cluster), or select the limit to radio button to set the amount of memory set by this quota. If you select the limit to radio button, input a memory quota in megabytes (MB) in the MB field.
- Under the CPU field, select either the Unlimited radio button or the limit to radio button to set the amount of CPU set by this quota. If you select the limit to radio button, input a number of vCPUs in the vCpus field.
- Click in the Edit Quota window.
- In the Storage section of the New Quota window, use the green slider to set Storage Threshold.
- In the Storage section of the New Quota window, use the blue slider to set Storage Grace.
- Click in the Storage field. The Edit Quota window opens.
- Under the Storage Quota field, select either the Unlimited radio button (to allow limitless use of Storage) or the limit to radio button to set the amount of storage to which quota will limit users. If you select the limit to radio button, input a storage quota size in gigabytes (GB) in the GB field.
- Click in the Edit Quota window. You are returned to the New Quota window.
- Click in the New Quota window.
18.6. Explanation of Quota Threshold Settings
Table 18.3. Quota thresholds and grace
| Setting | Definition |
|---|---|
| Cluster Threshold | The amount of cluster resources available per data center. |
| Cluster Grace | The amount of the cluster available for the data center after exhausting the data center's Cluster Threshold. |
| Storage Threshold | The amount of storage resources available per data center. |
| Storage Grace | The amount of storage available for the data center after exhausting the data center's Storage Threshold. |
18.7. Assigning a Quota to an Object
Procedure 18.3. Assigning a Quota to a Virtual Machine
- In the navigation pane, select the Virtual Machine to which you plan to add a quota.
- Click . The Edit Virtual Machine window appears.
- Select the quota you want the virtual machine to consume. Use the Quota drop-down to do this.
- Click .
Procedure 18.4. Assigning a Quota to a Virtual Disk
- In the navigation pane, select the Virtual Machine whose disk(s) you plan to add a quota.
- In the details pane, select the disk you plan to associate with a quota.
- Click . The Edit Virtual Disk window appears.
- Select the quota you want the virtual disk to consume.
- Click .
Important
18.8. Using Quota to Limit Resources by User
Procedure 18.5. Assigning a User to a Quota
- In the tree, click the Data Center with the quota you want to associate with a User.
- Click the Quota tab in the navigation pane.
- Select the target quota in the list in the navigation pane.
- Click the tab in the details pane.
- Click at the top of the details pane.
- In the Search field, type the name of the user you want to associate with the quota.
- Click .
- Select the check box at the left side of the row containing the name of the target user.
- Click in the bottom right of the Assign Users and Groups to Quota window.
18.9. Editing Quotas
Procedure 18.6. Editing Quotas
- On the tree pane, click on the data center whose quota you want to edit.
- Click on the Quota tab in the Navigation Pane.
- Click the name of the quota you want to edit.
- Click Edit in the Navigation pane.
- An Edit Quota window opens. If required, enter a meaningful name in the Name field.
- If required, you can enter a meaningful description in the Description field.
- Select either the All Clusters radio button or the Specific Clusters radio button. Move the Cluster Threshold and Cluster Grace sliders to the desired positions on the Memory & CPU slider.
- Select either the All Storage Domains radio button or the Specific Storage Domains radio button. Move the Storage Threshold and Storage Grace sliders to the desired positions on the Storage slider.
- Click in the Edit Quota window to confirm the new quota settings.
18.10. Removing Quotas
Procedure 18.7. Removing Quotas
- On the tree pane, click on the data center whose quota you want to edit.
- Click on the Quota tab in the Navigation Pane.
- Click the name of the quota you want to remove.
- Click at the top of the Navigation pane, under the row of tabs.
- Click in the Remove Quota(s) window to confirm the removal of this quota.
18.11. Service Level Agreement Policy Enforcement
Procedure 18.8. Setting a Service Level Agreement CPU Policy
- Select in the Navigation Pane.
- Select .
- Select the Resource Allocation tab.
- Specify CPU Shares. Possible options are Low, Medium, High, Custom, and Disabled. Virtual machines set to High receive twice as many shares as Medium, and virtual machines set to Medium receive twice as many shares as virtual machines set to Low. Disabled instructs VDSM to use an older algorithm for determining share dispensation; usually the number of shares dispensed under these conditions is 1020.
Chapter 19. Event Notifications
19.1. Configuring Event Notifications in the Administration Portal
Procedure 19.1. Configuring Event Notifications
- Ensure you have set up the mail transfer agent with the appropriate variables.
- Use the Users resource tab, tree mode, or the search function to find and select the user to which event notifications will be sent.
- Click the Event Notifier tab in the details pane to list the events for which the user will be notified. This list is blank if you have not configured any event notifications for that user.
- Click to open the Add Event Notification window.
- Use the button or the subject-specific expansion buttons to view the events.
- Select the appropriate check boxes.
- Enter an email address in the Mail Recipient field.
- Click to save changes and close the window.
- Add and start the ovirt-engine-notifier service on the Red Hat Enterprise Virtualization Manager. This activates the changes you have made:
# chkconfig --add ovirt-engine-notifier# chkconfig ovirt-engine-notifier on# service ovirt-engine-notifier restart
19.2. Canceling Event Notifications in the Administration Portal
Procedure 19.2. Canceling Event Notifications
- In the Users tab, select the user or the user group.
- Select the Event Notifier tab in the details pane to list events for which the user receives email notifications.
- Click to open the Add Event Notification window.
- Use the button, or the subject-specific expansion buttons, to view the events.
- Clear the appropriate check boxes to remove notification for that event.
- Click to save changes and close the window.
19.3. Parameters for Event Notifications in ovirt-engine-notifier.conf
/usr/share/ovirt-engine/services/ovirt-engine-notifier/ovirt-engine-notifier.conf.
Table 19.1. ovirt-engine-notifier.conf variables
| Variable Name | Default | Remarks |
|---|---|---|
| SENSITIVE_KEYS | none | A comma-separated list of keys that will not be logged. |
| JBOSS_HOME | /usr/share/jbossas | The location of the JBoss application server used by the Manager. |
| ENGINE_ETC | /etc/ovirt-engine | The location of the etc directory used by the Manager. |
| ENGINE_LOG | /var/log/ovirt-engine | The location of the logs directory used by the Manager. |
| ENGINE_USR | /usr/share/ovirt-engine | The location of the usr directory used by the Manager. |
| ENGINE_JAVA_MODULEPATH | ${ENGINE_USR}/modules | The file path to which the JBoss modules are appended. |
| NOTIFIER_DEBUG_ADDRESS | none | The address of a machine that can be used to perform remote debugging of the Java virtual machine that the notifier uses. |
| NOTIFIER_STOP_TIME | 30 | The time, in seconds, after which the service will time out. |
| NOTIFIER_STOP_INTERVAL | 1 | The time, in seconds, by which the timeout counter will be incremented. |
| INTERVAL_IN_SECONDS | 120 | The interval in seconds between instances of dispatching messages to subscribers. |
| IDLE_INTERVAL | 30 | The interval, in seconds, between which low-priority tasks will be performed. |
| DAYS_TO_KEEP_HISTORY | 0 | This variable sets the number of days dispatched events will be preserved in the history table. If this variable is not set, events remain on the history table indefinitely. |
| FAILED_QUERIES_NOTIFICATION_THRESHOLD | 30 | The number of failed queries after which a notification email is sent. A notification email is sent after the first failure to fetch notifications, and then once every time the number of failures specified by this variable is reached. If you specify a value of 0 or 1, an email will be sent with each failure. |
| FAILED_QUERIES_NOTIFICATION_RECIPIENTS | none | The email addresses of the recipients to which notification emails will be sent. Email addresses must be separated by a comma. This entry has been deprecated by the FILTER variable. |
| DAYS_TO_SEND_ON_STARTUP | 0 | The number of days of old events that will be processed and sent when the notifier starts. |
| FILTER | exclude:* | The algorithm used to determine the triggers for and recipients of email notifications. The value for this variable comprises a combination of include or exclude, the event, and the recipient. For example, include:VDC_START(smtp:mail@example.com) ${FILTER} |
| MAIL_SERVER | none | The SMTP mail server address. Required. |
| MAIL_PORT | 25 | The port used for communication. Possible values include 25 for plain SMTP, 465 for SMTP with SSL, and 587 for SMTP with TLS. |
| MAIL_USER | none | If SSL is enabled to authenticate the user, then this variable must be set. This variable is also used to specify the "from" user address when the MAIL_FROM variable is not set. Some mail servers do not support this functionality. The address is in RFC822 format. |
| SENSITIVE_KEYS | ${SENSITIVE_KEYS},MAIL_PASSWORD | Required to authenticate the user if the mail server requires authentication or if SSL or TLS is enabled. |
| MAIL_PASSWORD | none | Required to authenticate the user if the mail server requires authentication or if SSL or TLS is enabled. |
| MAIL_SMTP_ENCRYPTION | none | The type of encryption to be used in communication. Possible values are none, ssl, tls. |
| HTML_MESSAGE_FORMAT | false | The mail server sends messages in HTML format if this variable is set to true. |
| MAIL_FROM | none | This variable specifies a sender address in RFC822 format, if supported by the mail server. |
| MAIL_REPLY_TO | none | This variable specifies reply-to addresses in RFC822 format on sent mail, if supported by the mail server. |
| MAIL_SEND_INTERVAL | 1 | The number of SMTP messages to be sent for each IDLE_INTERVAL |
| MAIL_RETRIES | 4 | The number of times to attempt to send an email before failing. |
| SNMP_MANAGER | none | The IP addresses or fully qualified domain names of machines that will act as the SNMP managers. Entries must be separated by a space and can contain a port number. For example, manager1.example.com manager2.example.com:164 |
| SNMP_COMMUNITY | public | The default SNMP community. |
| SNMP_OID | 1.3.6.1.4.1.2312.13.1.1 | The default trap object identifiers for alerts. All trap types are sent, appended with event information, to the SNMP manager when this OID is defined. Note that changing the default trap prevents generated traps from complying with the Manager's management information base. |
| ENGINE_INTERVAL_IN_SECONDS | 300 | The interval, in seconds, between monitoring the machine on which the Manager is installed. The interval is measured from the time the monitoring is complete. |
| ENGINE_MONITOR_RETRIES | 3 | The number of times the notifier attempts to monitor the status of the machine on which the Manager is installed in a given interval after a failure. |
| ENGINE_TIMEOUT_IN_SECONDS | 30 | The time, in seconds, to wait before the notifier attempts to monitor the status of the machine on which the Manager is installed in a given interval after a failure. |
| IS_HTTPS_PROTOCOL | false | This entry must be set to true if JBoss is being run in secured mode. |
| SSL_PROTOCOL | TLS | The protocol used by JBoss configuration connector when SSL is enabled. |
| SSL_IGNORE_CERTIFICATE_ERRORS | false | This value must be set to true if JBoss is running in secure mode and SSL errors is to be ignored. |
| SSL_IGNORE_HOST_VERIFICATION | false | This value must be set to true if JBoss is running in secure mode and host name verification is to be ignored. |
| REPEAT_NON_RESPONSIVE_NOTIFICATION | false | This variable specifies whether repeated failure messages will be sent to subscribers if the machine on which the Manager is installed is non-responsive. |
| ENGINE_PID | /var/lib/ovirt-engine/ovirt-engine.pid | The path and file name of the PID of the Manager. |
19.4. Configuring the Red Hat Enterprise Virtualization Manager to Send SNMP Traps
- The IP addresses or fully qualified domain names of machines that will act as SNMP managers. Optionally, determine the port through which the manager receives trap notifications; by default, this is UDP port 162.
- The SNMP community. Multiple SNMP managers can belong to a single community. Management systems and agents can communicate only if they are within the same community. The default community is
public. - The trap object identifier for alerts. The Red Hat Enterprise Virtualization Manager provides a default OID of 1.3.6.1.4.1.2312.13.1.1. All trap types are sent, appended with event information, to the SNMP manager when this OID is defined. Note that changing the default trap prevents generated traps from complying with the Manager's management information base.
Note
/usr/share/doc/ovirt-engine/mibs/OVIRT-MIB.txt and /usr/share/doc/ovirt-engine/mibs/REDHAT-MIB.txt. Load the MIBs in your SNMP manager before proceeding.
/usr/share/ovirt-engine/services/ovirt-engine-notifier/ovirt-engine-notifier.conf. The values outlined in the following procedure are based on the default or example values provided in that file. It is recommended that you define an override file, rather than edit the ovirt-engine-notifier.conf file, to persist your configuration options across system changes, like upgrades.
Procedure 19.3. Configuring SNMP Traps on the Manager
- On the Manager, create the SNMP configuration file:
# touch /etc/ovirt-engine/notifier/notifier.conf.d/20-snmp.conf
- Specify the SNMP manager(s), the SNMP community, and the OID in the following format:
SNMP_MANAGERS="manager1.example.com manager2.example.com:162" SNMP_COMMUNITY=public SNMP_OID=1.3.6.1.4.1.2312.13.1.1
- Define which events to send to the SNMP manager:
FILTER="include:*(snmp:) ${FILTER}" FILTER="include:AUDIT_LOG_MSG(snmp:) ${FILTER}" FILTER="exclude:AUDIT_LOG_MSG include:*(snmp:) ${FILTER}" FILTER="exclude:*"The first line in the example above sends all alerts to the default SNMP profile. The second line sends alerts for AUDIT_LOG_MSG to the default SNMP profile. The third line sends alerts for everything but AUDIT_LOG_MSG to the default SNMP profile. The fourth line is the default filter defined inovirt-engine-notifier.conf; if you do not disable this filter or apply overriding filters, no notifications will be sent. A full list of audit log messages is available in/usr/share/doc/ovirt-engine/AuditLogMessages.properties. Alternatively, filter results within your SNMP manager. - Save the file.
- Start the
ovirt-engine-notifierservice, and ensure that this service starts on boot:# service ovirt-engine-notifier start # chkconfig ovirt-engine-notifier on
Note
SNMP_MANAGERS, MAIL_SERVER, or both must be properly defined in ovirt-engine-notifier.conf or in an override file in order for the notifier service to run.
Chapter 20. Utilities
20.1. The oVirt Engine Rename Tool
20.1.1. The oVirt Engine Rename Tool
engine-setup command is run in a clean environment, the command generates a number of certificates and keys that use the fully qualified domain name of the Manager supplied during the setup process. If the fully qualified domain name of the Manager must be changed later on (for example, due to migration of the machine hosting the Manager to a different domain), the records of the fully qualified domain name must be updated to reflect the new name. The ovirt-engine-rename command automates this task.
ovirt-engine-rename command updates records of the fully qualified domain name of the Manager in the following locations:
- /etc/ovirt-engine/engine.conf.d/10-setup-protocols.conf
- /etc/ovirt-engine/imageuploader.conf.d/10-engine-setup.conf
- /etc/ovirt-engine/isouploader.conf.d/10-engine-setup.conf
- /etc/ovirt-engine/logcollector.conf.d/10-engine-setup.conf
- /etc/pki/ovirt-engine/cert.conf
- /etc/pki/ovirt-engine/cert.template
- /etc/pki/ovirt-engine/certs/apache.cer
- /etc/pki/ovirt-engine/keys/apache.key.nopass
- /etc/pki/ovirt-engine/keys/apache.p12
Warning
ovirt-engine-rename command creates a new certificate for the web server on which the Manager runs, it does not affect the certificate for the engine or the certificate authority. Due to this, there is some risk involved in using the ovirt-engine-rename command, particularly in environments that have been upgraded from Red Hat Enterprise Virtualization version 3.2 and earlier. Therefore, changing the fully qualified domain name of the Manager by running engine-cleanup and engine-setup is recommended where possible.
20.1.2. Syntax for the oVirt Engine Rename Command
ovirt-engine-rename command is:
# /usr/share/ovirt-engine/setup/bin/ovirt-engine-rename
--newname=[new name]- Allows you to specify the new fully qualified domain name for the Manager without user interaction.
--log=[file]- Allows you to specify the path and name of a file into which logs of the rename operation are to be written.
--config=[file]- Allows you to specify the path and file name of a configuration file to load into the rename operation.
--config-append=[file]- Allows you to specify the path and file name of a configuration file to append to the rename operation. This option can be used to specify the path and file name of an answer file.
--generate-answer=[file]- Allows you to specify the path and file name of a file into which your answers to and the values changed by the
ovirt-engine-renamecommand are recorded.
20.1.3. Using the oVirt Engine Rename Tool
ovirt-engine-rename command to update records of the fully qualified domain name of the Manager.
Procedure 20.1. Renaming the Red Hat Enterprise Virtualization Manager
- Prepare all DNS and other relevant records for the new fully qualified domain name.
- Update the DHCP server configuration if DHCP is used.
- Update the host name on the Manager.
- Run the following command:
# /usr/share/ovirt-engine/setup/bin/ovirt-engine-rename
- When prompted, press Enter to stop the engine service:
During execution engine service will be stopped (OK, Cancel) [OK]:
- When prompted, enter the new fully qualified domain name for the Manager:
New fully qualified server name:[new name]
ovirt-engine-rename command updates records of the fully qualified domain name of the Manager.
20.2. The Domain Management Tool
- 20.2.1. The Domain Management Tool
- 20.2.2. Syntax for the Domain Management Tool
- 20.2.3. Using the Domain Management Tool
- 20.2.4. Listing Domains in Configuration
- 20.2.5. Adding Domains to Configuration
- 20.2.6. Editing a Domain in the Configuration
- 20.2.7. Validating Domain Configuration
- 20.2.8. Deleting a Domain from the Configuration
20.2.1. The Domain Management Tool
admin user to add the directory service that the users must be authenticated against. You add and remove directory services domains using the included domain management tool, engine-manage-domains.
engine-manage-domains command is only accessible on the machine on which Red Hat Enterprise Virtualization Manager is installed. The engine-manage-domains command must be run as the root user.
Important
engine-manage-domains tool continue to use that existing implementation.
20.2.2. Syntax for the Domain Management Tool
engine-manage-domains ACTION [options]add- Add a domain to Red Hat Enterprise Virtualization Manager's directory services configuration.
edit- Edit a domain in Red Hat Enterprise Virtualization Manager's directory services configuration.
delete- Delete a domain from Red Hat Enterprise Virtualization Manager's directory services configuration.
validate- Validate Red Hat Enterprise Virtualization Manager's directory services configuration. This command attempts to authenticate each domain in the configuration using the configured user name and password.
list- List Red Hat Enterprise Virtualization Manager's current directory services configuration.
--add-permissions- Specifies that the domain user will be given the SuperUser role in Red Hat Enterprise Virtualization Manager. By default, if the
--add-permissionsparameter is not specified, the SuperUser role is not assigned to the domain user. The--add-permissionsoption is optional. It is only valid when used in combination with theaddandeditactions. --change-password-msg=[MSG]- Specifies the message that is returned to the user at login when their password has expired. This allows you to direct users to a specific URL (must begin with http or https) where their password can be changed. The
--change-password-msgoption is optional, and is only valid when used in combination with theaddandeditactions. --config-file=[FILE]- Specifies an alternate configuration file that the command must use. The
--config-fileparameter is always optional. --domain=[DOMAIN]- The domain on which the action will be performed. The
--domainparameter is mandatory for theadd,edit, anddeleteactions. --force- Forces the command to skip confirmation of delete operations.
--ldap-servers=[SERVERS]- A comma delimited list of LDAP servers to be set to the domain.
--log-file=[LOG_FILE]- The name of a file into which to write logs for an operation.
--log-level=[LOG_LEVEL]- The log level. You can choose either
DEBUG(the default option),INFO,WARN, orERROR. These options are case insensitive. --log4j-config=[LOG4J_FILE]- A
log4j.xmlfile from which to read logging configuration information. --provider=[PROVIDER]- The LDAP provider type of the directory server for the domain. Valid values are:
ad- Microsoft 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. Red Hat Directory Server must be running as a service inside a Kerberos domain to provide directory services to the Manager.Note
To use Red Hat Directory Server as your directory server, you must have thememberofplug-in installed in Red Hat Directory Server. To use thememberofplug-in, your users must beinetuser.itds- IBM Tivoli Directory Server.oldap- OpenLDAP.
--report- When used in conjunction with the
validateaction, this command outputs a report of all validation errors encountered. --resolve-kdc- Resolve key distribution center servers using DNS.
--user=[USER]- Specifies the domain user to use. The
--userparameter is mandatory foradd, and optional foredit. --password-file=[FILE]- Specifies that the domain user's password is on the first line of the provided file. This option, or the
--interactiveoption, must be used to provide the password for use with theaddaction.
engine-manage-domains command's help output:
# engine-manage-domains --help
20.2.3. Using the Domain Management Tool
engine-manage-domains command to perform basic manipulation of the Red Hat Enterprise Virtualization Manager domain configuration.
20.2.4. Listing Domains in Configuration
engine-manage-domains command lists the directory services domains defined in the Red Hat Enterprise Virtualization Manager configuration. This command prints the domain, the user name in User Principal Name (UPN) format, and whether the domain is local or remote for each configuration entry.
Example 20.1. engine-manage-domains List Action
# engine-manage-domains list
Domain: directory.demo.redhat.com
User name: admin@DIRECTORY.DEMO.REDHAT.COM
This domain is a remote domain.20.2.5. Adding Domains to Configuration
engine-manage-domains command is used to add the IdM domain directory.demo.redhat.com to the Red Hat Enterprise Virtualization Manager configuration. The configuration is set to use the admin user when querying the domain; the password is provided interactively.
Example 20.2. engine-manage-domains Add Action
# engine-manage-domains add --domain=directory.demo.redhat.com --provider=IPA --user=admin 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).
20.2.6. Editing a Domain in the Configuration
engine-manage-domains command is used to edit the directory.demo.redhat.com domain in the Red Hat Enterprise Virtualization Manager configuration. The configuration is updated to use the admin user when querying this domain; the password is provided interactively.
Example 20.3. engine-manage-domains Edit Action
# engine-manage-domains -action=edit -domain=directory.demo.redhat.com -user=admin -interactive loaded template kr5.conf file setting default_tkt_enctypes setting realms setting domain realmo success User guide is: 80b71bae-98a1-11e0-8f20-525400866c73 Successfully edited domain directory.demo.redhat.com. oVirt Engine restart is required in order for the changes to take place (service ovirt-engine restart).
20.2.7. Validating Domain Configuration
engine-manage-domains command is used to validate the Red Hat Enterprise Virtualization Manager configuration. The command attempts to log into each listed domain with the credentials provided in the configuration. The domain is reported as valid if the attempt is successful.
Example 20.4. engine-manage-domains Validate Action
# engine-manage-domains validate User guide is: 80b71bae-98a1-11e0-8f20-525400866c73 Domain directory.demo.redhat.com is valid.
20.2.8. Deleting a Domain from the Configuration
engine-manage-domains command is used to remove the directory.demo.redhat.com domain from the Red Hat Enterprise Virtualization Manager configuration. Users defined in the removed domain will no longer be able to authenticate with the Red Hat Enterprise Virtualization Manager. The entries for the affected users will remain defined in the Red Hat Enterprise Virtualization Manager until they are explicitly removed.
admin user from the internal domain will be able to log in until another domain is added.
Example 20.5. engine-manage-domains Delete Action
# engine-manage-domains 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.
20.3. The Engine Configuration Tool
20.3.1. The Engine Configuration Tool
Note
postgresql service is running. Changes are then applied when the ovirt-engine service is restarted.
20.3.2. Syntax for the engine-config Command
# engine-config --helpCommon tasks
- List available configuration keys
#
engine-config--list- List available configuration values
#
engine-config--all- Retrieve value of configuration key
#
engine-config--get [KEY_NAME]Replace [KEY_NAME] with the name of the preferred key to retrieve the value for the given version of the key. Use the--cverparameter to specify the configuration version of the value to be retrieved. If no version is provided, values for all existing versions are returned.- Set value of configuration key
#
engine-config--set [KEY_NAME]=[KEY_VALUE]--cver=[VERSION]Replace [KEY_NAME] with the name of the specific key to set, and replace [KEY_VALUE] with the value to be set. You must specify the [VERSION] in environments with more than one configuration version.- Restart the ovirt-engine service to load changes
- The
ovirt-engineservice needs to be restarted for your changes to take effect.#
service ovirt-engine restart
20.3.3. Resetting the Password for the Internal Administrative User
admin@internal), you must use the engine configuration tool in interactive mode.
Procedure 20.2. Resetting the Password for the Internal Administrative User
- Log in to the machine on which the Red Hat Enterprise Virtualization Manager is installed.
- Change the password in interactive mode:
# engine-config -s AdminPassword=interactive
- Apply the changes:
# service ovirt-engine restart
20.4. The Image Uploader Tool
20.4.1. The Image Uploader Tool
engine-image-uploader command allows you to list export storage domains and upload virtual machine images in OVF format to an export storage domain and have them automatically recognized in the Red Hat Enterprise Virtualization Manager.
Note
|-- images | |-- [Image Group UUID] | |--- [Image UUID (this is the disk image)] | |--- [Image UUID (this is the disk image)].meta |-- master | |---vms | |--- [UUID] | |--- [UUID].ovf
20.4.2. Syntax for the engine-image-uploader Command
engine-image-uploader[options]listengine-image-uploader[options]upload[file].[file]...[file]
list, and upload.
- The
listaction lists the export storage domains to which images can be uploaded. - The
uploadaction uploads images to the specified export storage domain.
upload action.
engine-image-uploader command. You can set defaults for any of these parameters in the /etc/ovirt-engine/imageuploader.conf file.
General Options
-h,--help- Displays information on how to use the image uploader command.
--conf-file=[PATH]- Sets [PATH] as the configuration file the command will use. The default is
etc/ovirt-engine/imageuploader.conf. --log-file=[PATH]- Sets [PATH] as the specific file name the command will use to write log output. The default is
/var/log/ovirt-engine/ovirt-image-uploader/ovirt-image-uploader-[date].log. --cert-file=[PATH]- Sets [PATH] as the certificate for validating the engine. The default is
/etc/pki/ovirt-engine/ca.pem. --insecure- Specifies that no attempt will be made to verify the engine.
--quiet- Sets quiet mode, reducing console output to a minimum.
-v,--verbose- Sets verbose mode, providing more console output.
-f,--force- Force mode is necessary when the source file being uploaded has the same file name as an existing file in the destination export domain. This option forces the existing file to be overwritten.
Red Hat Enterprise Virtualization Manager Options
-u [USER],--user=[USER]- Specifies the user whose credentials will be used to execute the command. The [USER] is specified in the format [username]@[domain]. The user must exist in the specified domain and be known to the Red Hat Enterprise Virtualization Manager.
-r [FQDN],--engine=[FQDN]- Specifies the IP address or fully qualified domain name of the Red Hat Enterprise Virtualization Manager from which the images will be uploaded. It is assumed that the image uploader is being run from the same machine on which the Red Hat Enterprise Virtualization Manager is installed. The default value is
localhost:443.
Export Storage Domain Options
-e option or the -n option.
-e[EXPORT_DOMAIN],--export-domain=[EXPORT_DOMAIN]- Sets the storage domain EXPORT_DOMAIN as the destination for uploads.
-n[NFSSERVER],--nfs-server=[NFSSERVER]- Sets the NFS path [NFSSERVER] as the destination for uploads.
Import Options
-i,--ovf-id- Specifies that the UUID of the image will not be updated. By default, the command generates a new UUID for images that are uploaded. This ensures there is no conflict between the id of the image being uploaded and the images already in the environment.
-d,--disk-instance-id- Specifies that the instance ID for each disk in the image will not be renamed. By default, the command generates new UUIDs for disks in images that are uploaded. This ensures there are no conflicts between the disks on the image being uploaded and the disks already in the environment.
-m,--mac-address- Specifies that network components in the image will not be removed from the image. By default, the command removes network interface cards from image being uploaded to prevent conflicts with network cards on other virtual machines already in the environment. If you do not use this option, you can use the Administration Portal to add network interface cards to newly imported images and the Manager will ensure there are no MAC address conflicts.
-N [NEW_IMAGE_NAME],--name=[NEW_IMAGE_NAME]- Specifies a new name for the image being uploaded.
20.4.3. Creating an OVF Archive That is Compatible With the Image Uploader
engine-image-uploader tool.
Procedure 20.3. Creating an OVF Archive That is Compatible With the Image Uploader
- Use the Manager to create an empty export domain. An empty export domain makes it easy to see which directory contains your virtual machine.
- Export your virtual machine to the empty export domain you just created.
- Log in to the storage server that serves as the export domain, find the root of the NFS share and change to the subdirectory under that mount point. You started with a new export domain, there is only one directory under the exported directory. It contains the
images/andmaster/directories. - Run the
tar -zcvf my.ovf images/ master/command to create the tar/gzip OVF archive. - Anyone you give the resulting OVF file to (in this example, called
my.ovf) can import it to Red Hat Enterprise Virtualization Manager using theengine-image-uploadercommand.
engine-image-uploader command to upload your image into their Red Hat Enterprise Virtualization environment.
20.4.4. Basic engine-image-uploader Usage Examples
Example 20.6. Listing export storage domains using the image uploader
# engine-image-uploader list Please provide the REST API password for the admin@internal oVirt Engine user (CTRL+D to abort): Export Storage Domain Name | Datacenter | Export Domain Status myexportdom | Myowndc | active
Example 20.7. Uploading a file using the image uploader
# engine-image-uploader -e myexportdom upload myrhel6.ovf Please provide the REST API password for the admin@internal oVirt Engine user (CTRL+D to abort):
20.5. The USB Filter Editor
20.5.1. Installing the USB Filter Editor
usbfilter.txt policy file. The policy rules defined in this file allow or deny the pass-through of specific USB devices from client machines to virtual machines managed using the Red Hat Enterprise Virtualization Manager. The policy file resides on the Red Hat Enterprise Virtualization Manager in the following location:
/etc/ovirt-engine/usbfilter.txt
ovirt-engine service on the Red Hat Enterprise Virtualization Manager server is restarted.
USBFilterEditor.msi file from the Content Delivery Network: https://rhn.redhat.com/rhn/software/channel/downloads/Download.do?cid=20703. The file works with Red Hat Enterprise Virtualization 3.0, 3.1, 3.2, 3.3, 3.4, and 3.5.
Procedure 20.4. Installing the USB Filter Editor
- On a Windows machine, launch the
USBFilterEditor.msiinstaller obtained from the Content Delivery Network. - Follow the steps of the installation wizard. Unless otherwise specified, the USB Filter Editor will be installed by default in either
C:\Program Files\RedHat\USB Filter EditororC:\Program Files(x86)\RedHat\USB Filter Editordepending on your version of Windows. - A USB Filter Editor shortcut icon is created on your desktop.
Important
20.5.2. The USB Filter Editor Interface
- Double-click the USB Filter Editor shortcut icon on your desktop.
Table 20.1. USB Editor Fields
| Name | Description |
|---|---|
| Class | Type of USB device; for example, printers, mass storage controllers. |
| Vendor | The manufacturer of the selected type of device. |
| Product | The specific USB device model. |
| Revision | The revision of the product. |
| Action | Allow or block the specified device. |
20.5.3. Adding a USB Policy
Procedure 20.5. Adding a USB Policy
- Click the button. The Edit USB Criteria window opens:
- Use the USB Class, Vendor ID, Product ID, and Revision check boxes and lists to specify the device.Click the button to permit virtual machines use of the USB device; click the button to prohibit the USB device from virtual machines.Click to add the selected filter rule to the list and close the window.
Example 20.8. Adding a Device
The following is an example of how to add USB ClassSmartcard, deviceEP-1427X-2 Ethernet Adapter, from manufacturerAcer Communications & Multimediato the list of allowed devices.
- Click → to save the changes.
20.5.4. Removing a USB Policy
Procedure 20.6. Removing a USB Policy
- Select the policy to be removed.
- Click . A message displays prompting you to confirm that you want to remove the policy.
- Click to confirm that you want to remove the policy.
- Click → to save the changes.
20.5.5. Searching for USB Device Policies
Procedure 20.7. Searching for USB Device Policies
- Click . The Attached USB Devices window displays a list of all the attached devices.
- Select the device and click or as appropriate. Double-click the selected device to close the window. A policy rule for the device is added to the list.
- Use the Up and Down buttons to change the position of the new policy rule in the list.
- Click → to save the changes.
20.5.6. Exporting a USB Policy
ovirt-engine service.
Procedure 20.8. Exporting a USB Policy
- Click ; the window opens.
- Save the file with a file name of
usbfilter.txt. - Using a Secure Copy client, such as WinSCP, upload the
usbfilter.txtfile to the server running Red Hat Enterprise Virtualization Manager. The file must be placed in the following directory on the server:/etc/ovirt-engine/ - As the
rootuser on the server running Red Hat Enterprise Virtualization Manager, restart theovirt-engineservice.# service ovirt-engine restart
20.5.7. Importing a USB Policy
Procedure 20.9. Importing a USB Policy
- Using a Secure Copy client, such as WinSCP, upload the
usbfilter.txtfile to the server running Red Hat Enterprise Virtualization Manager. The file must be placed in the following directory on the server:/etc/ovirt-engine/ - Double-click the USB Filter Editor shortcut icon on your desktop to open the editor.
- Click to open the window.
- Open the
usbfilter.txtfile that was downloaded from the server.
20.6. The Log Collector Tool
20.6.1. Log Collector
engine-log-collector. You are required to log in as the root user and provide the administration credentials for the Red Hat Enterprise Virtualization environment. The engine-log-collector -h command displays usage information, including a list of all valid options for the engine-log-collector command.
20.6.2. Syntax for engine-log-collector Command
engine-log-collector[options]list[all, clusters, datacenters]engine-log-collector[options]collect
list and collect.
- The
listparameter lists either the hosts, clusters, or data centers attached to the Red Hat Enterprise Virtualization Manager. You are able to filter the log collection based on the listed objects. - The
collectparameter performs log collection from the Red Hat Enterprise Virtualization Manager. The collected logs are placed in an archive file under the/tmp/logcollectordirectory. Theengine-log-collectorcommand assigns each log a specific file name.
engine-log-collector command.
General options
--version- Displays the version number of the command in use and returns to prompt.
-h,--help- Displays command usage information and returns to prompt.
--conf-file=PATH- Sets PATH as the configuration file the tool is to use.
--local-tmp=PATH- Sets PATH as the directory in which logs are saved. The default directory is
/tmp/logcollector. --ticket-number=TICKET- Sets TICKET as the ticket, or case number, to associate with the SOS report.
--upload=FTP_SERVER- Sets FTP_SERVER as the destination for retrieved logs to be sent using FTP. Do not use this option unless advised to by a Red Hat support representative.
--log-file=PATH- Sets PATH as the specific file name the command should use for the log output.
--quiet- Sets quiet mode, reducing console output to a minimum. Quiet mode is off by default.
-v,--verbose- Sets verbose mode, providing more console output. Verbose mode is off by default.
Red Hat Enterprise Virtualization Manager Options
engine-log-collector --user=admin@internal --cluster ClusterA,ClusterB --hosts "SalesHost"* specifies the user as admin@internal and limits the log collection to only SalesHost hosts in clusters A and B.
--no-hypervisors- Omits virtualization hosts from the log collection.
-u USER,--user=USER- Sets the user name for login. The USER is specified in the format user@domain, where user is the user name and domain is the directory services domain in use. The user must exist in directory services and be known to the Red Hat Enterprise Virtualization Manager.
-r FQDN,--rhevm=FQDN- Sets the fully qualified domain name of the Red Hat Enterprise Virtualization Manager server from which to collect logs, where FQDN is replaced by the fully qualified domain name of the Manager. It is assumed that the log collector is being run on the same local host as the Red Hat Enterprise Virtualization Manager; the default value is
localhost. -c CLUSTER,--cluster=CLUSTER- Collects logs from the virtualization hosts in the nominated CLUSTER in addition to logs from the Red Hat Enterprise Virtualization Manager. The cluster(s) for inclusion must be specified in a comma-separated list of cluster names or match patterns.
-d DATACENTER,--data-center=DATACENTER- Collects logs from the virtualization hosts in the nominated DATACENTER in addition to logs from the Red Hat Enterprise Virtualization Manager. The data center(s) for inclusion must be specified in a comma-separated list of data center names or match patterns.
-H HOSTS_LIST,--hosts=HOSTS_LIST- Collects logs from the virtualization hosts in the nominated HOSTS_LIST in addition to logs from the Red Hat Enterprise Virtualization Manager. The hosts for inclusion must be specified in a comma-separated list of host names, fully qualified domain names, or IP addresses. Match patterns are also valid.
SOS Report Options
--jboss-home=JBOSS_HOME- JBoss installation directory path. The default is
/var/lib/jbossas. --java-home=JAVA_HOME- Java installation directory path. The default is
/usr/lib/jvm/java. --jboss-profile=JBOSS_PROFILE- Displays a quoted and space-separated list of server profiles; limits log collection to specified profiles. The default is
'rhevm-slimmed'. --enable-jmx- Enables the collection of run-time metrics from Red Hat Enterprise Virtualization's JBoss JMX interface.
--jboss-user=JBOSS_USER- User with permissions to invoke JBoss JMX. The default is
admin. --jboss-logsize=LOG_SIZE- Maximum size in MB for the retrieved log files.
--jboss-stdjar=STATE- Sets collection of JAR statistics for JBoss standard JARs. Replace STATE with
onoroff. The default ison. --jboss-servjar=STATE- Sets collection of JAR statistics from any server configuration directories. Replace STATE with
onoroff. The default ison. --jboss-twiddle=STATE- Sets collection of twiddle data on or off. Twiddle is the JBoss tool used to collect data from the JMX invoker. Replace STATE with
onoroff. The default ison. --jboss-appxml=XML_LIST- Displays a quoted and space-separated list of applications with XML descriptions to be retrieved. Default is
all.
SSH Configuration
--ssh-port=PORT- Sets PORT as the port to use for SSH connections with virtualization hosts.
-k KEYFILE,--key-file=KEYFILE- Sets KEYFILE as the public SSH key to be used for accessing the virtualization hosts.
--max-connections=MAX_CONNECTIONS- Sets MAX_CONNECTIONS as the maximum concurrent SSH connections for logs from virtualization hosts. The default is
10.
PostgreSQL Database Options
pg-user and dbname parameters, if they have been changed from the default values.
pg-dbhost parameter if the database is not on the local host. Use the optional pg-host-key parameter to collect remote logs. The PostgreSQL SOS plugin must be installed on the database server for remote log collection to be successful.
--no-postgresql- Disables collection of database. The log collector will connect to the Red Hat Enterprise Virtualization Manager PostgreSQL database and include the data in the log report unless the
--no-postgresqlparameter is specified. --pg-user=USER- Sets USER as the user name to use for connections with the database server. The default is
postgres. --pg-dbname=DBNAME- Sets DBNAME as the database name to use for connections with the database server. The default is
rhevm. --pg-dbhost=DBHOST- Sets DBHOST as the host name for the database server. The default is
localhost. --pg-host-key=KEYFILE- Sets KEYFILE as the public identity file (private key) for the database server. This value is not set by default; it is required only where the database does not exist on the local host.
20.6.3. Basic Log Collector Usage
engine-log-collector command is run without specifying any additional parameters, its default behavior is to collect all logs from the Red Hat Enterprise Virtualization Manager and its attached hosts. It will also collect database logs unless the --no-postgresql parameter is added. In the following example, log collector is run to collect all logs from the Red Hat Enterprise Virtualization Manager and three attached hosts.
Example 20.9. Log Collector Usage
# engine-log-collector
INFO: Gathering oVirt Engine information...
INFO: Gathering PostgreSQL the oVirt Engine database and log files from localhost...
Please provide REST API password for the admin@internal oVirt Engine user (CTRL+D to abort):
About to collect information from 3 hypervisors. Continue? (Y/n):
INFO: Gathering information from selected hypervisors...
INFO: collecting information from 192.168.122.250
INFO: collecting information from 192.168.122.251
INFO: collecting information from 192.168.122.252
INFO: finished collecting information from 192.168.122.250
INFO: finished collecting information from 192.168.122.251
INFO: finished collecting information from 192.168.122.252
Creating compressed archive...
INFO Log files have been collected and placed in /tmp/logcollector/sosreport-rhn-account-20110804121320-ce2a.tar.xz.
The MD5 for this file is 6d741b78925998caff29020df2b2ce2a and its size is 26.7M20.7. The ISO Uploader Tool
20.7.1. The ISO Uploader Tool
engine-iso-uploader. You must log in as the root user and provide the administration credentials for the Red Hat Enterprise Virtualization environment to use this command. The engine-iso-uploader -h command displays usage information, including a list of all valid options for the engine-iso-uploader command.
20.7.2. Syntax for the engine-iso-uploader Command
engine-iso-uploader[options]listengine-iso-uploader[options]upload[file].[file]...[file]
list, and upload.
- The
listaction lists the ISO storage domains to which ISO files can be uploaded. The Red Hat Enterprise Virtualization Manager creates this list on the machine on which the Manager is installed during the installation process. - The
uploadaction uploads a single ISO file or multiple ISO files separated by spaces to the specified ISO storage domain. NFS is used by default, but SSH is also available.
upload action.
engine-iso-uploader command.
General Options
--version- Displays the version of the ISO uploader command.
-h,--help- Displays information on how to use the ISO uploader command.
--conf-file=[PATH]- Sets [PATH] as the configuration file the command will to use. The default is
/etc/ovirt-engine/isouploader.conf. --log-file=[PATH]- Sets [PATH] as the specific file name the command will use to write log output. The default is
/var/log/ovirt-engine/ovirt-iso-uploader/ovirt-iso-uploader[date].log. --cert-file=[PATH]- Sets [PATH] as the certificate for validating the engine. The default is
/etc/pki/ovirt-engine/ca.pem. --insecure- Specifies that no attempt will be made to verify the engine.
--nossl- Specifies that SSL will not be used to connect to the engine.
--quiet- Sets quiet mode, reducing console output to a minimum.
-v,--verbose- Sets verbose mode, providing more console output.
-f,--force- Force mode is necessary when the source file being uploaded has the same file name as an existing file in the destination ISO domain. This option forces the existing file to be overwritten.
Red Hat Enterprise Virtualization Manager Options
-u [USER],--user=[USER]- Specifies the user whose credentials will be used to execute the command. The [USER] is specified in the format [username]@[domain]. The user must exist in the specified domain and be known to the Red Hat Enterprise Virtualization Manager.
-r [FQDN],--engine=[FQDN]- Specifies the IP address or fully qualified domain name of the Red Hat Enterprise Virtualization Manager from which the images will be uploaded. It is assumed that the image uploader is being run from the same machine on which the Red Hat Enterprise Virtualization Manager is installed. The default value is
localhost:443.
ISO Storage Domain Options
-i option or the -n option.
-i,--iso-domain=[ISODOMAIN]- Sets the storage domain [ISODOMAIN] as the destination for uploads.
-n,--nfs-server=[NFSSERVER]- Sets the NFS path [NFSSERVER] as the destination for uploads.
Connection Options
--ssh-user=[USER]- Sets [USER] as the SSH user name to use for the upload. The default is
root. --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.
20.7.3. Specifying an NFS Server
Example 20.10. Uploading to an NFS Server
# engine-iso-uploader --nfs-server=storage.demo.redhat.com:/iso/path upload RHEL6.0.iso20.7.4. Basic ISO Uploader Usage
admin@internal user is used because no user was specified in the command. The second command uploads an ISO file over NFS to the specified ISO domain.
Example 20.11. List Domains and Upload Image
# engine-iso-uploader list
Please provide the REST API password for the admin@internal oVirt Engine user (CTRL+D to abort):
ISO Storage Domain Name | Datacenter | ISO Domain Status
ISODomain | Default | active# engine-iso-uploader --iso-domain=[ISODomain] upload [RHEL6.iso]
Please provide the REST API password for the admin@internal oVirt Engine user (CTRL+D to abort):20.7.5. Uploading the VirtIO and Guest Tool Image Files to an ISO Storage Domain
virtio-win.iso, virtio-win_x86.vfd, virtio-win_amd64.vfd, and rhev-tools-setup.iso image files to the ISODomain.
Example 20.12. Uploading the VirtIO and Guest Tool Image Files
# engine-iso-uploader --iso-domain=[ISODomain] upload /usr/share/virtio-win/virtio-win.iso /usr/share/virtio-win/virtio-win_x86.vfd /usr/share/virtio-win/virtio-win_amd64.vfd /usr/share/rhev-guest-tools-iso/rhev-tools-setup.iso20.7.6. VirtIO and Guest Tool Image Files
/usr/share/virtio-win/virtio-win.iso/usr/share/virtio-win/virtio-win_x86.vfd/usr/share/virtio-win/virtio-win_amd64.vfd/usr/share/rhev-guest-tools-iso/rhev-tools-setup.iso
engine-iso-uploader command to upload these images to your ISO storage domain. Once uploaded, the image files can be attached to and used by virtual machines.
Part III. Gathering Information About the Environment
Chapter 21. Log Files
21.1. Red Hat Enterprise Virtualization Manager Installation Log Files
Table 21.1. Installation
| Log File | Description |
|---|---|
/var/log/ovirt-engine/engine-cleanup_yyyy_mm_dd_hh_mm_ss.log | Log from the engine-cleanup command. This is the command used to reset a Red Hat Enterprise Virtualization Manager installation. A log is generated each time the command is run. The date and time of the run is used in the filename to allow multiple logs to exist. |
/var/log/ovirt-engine/engine-db-install-yyyy_mm_dd_hh_mm_ss.log | Log from the engine-setup command detailing the creation and configuration of the rhevm database. |
/var/log/ovirt-engine/rhevm-dwh-setup-yyyy_mm_dd_hh_mm_ss.log | Log from the rhevm-dwh-setup command. This is the command used to create the ovirt_engine_history database for reporting. A log is generated each time the command is run. The date and time of the run is used in the filename to allow multiple logs to exist concurrently. |
/var/log/ovirt-engine/ovirt-engine-reports-setup-yyyy_mm_dd_hh_mm_ss.log | Log from the rhevm-reports-setup command. This is the command used to install the Red Hat Enterprise Virtualization Manager Reports modules. A log is generated each time the command is run. The date and time of the run is used in the filename to allow multiple logs to exist concurrently. |
/var/log/ovirt-engine/setup/ovirt-engine-setup-yyyymmddhhmmss.log | Log from the engine-setup command. A log is generated each time the command is run. The date and time of the run is used in the filename to allow multiple logs to exist concurrently. |
21.2. Red Hat Enterprise Virtualization Manager Log Files
Table 21.2. Service Activity
| Log File | Description |
|---|---|
/var/log/ovirt-engine/engine.log | Reflects all Red Hat Enterprise Virtualization Manager GUI crashes, Active Directory lookups, Database issues, and other events. |
/var/log/ovirt-engine/host-deploy | Log files from hosts deployed from the Red Hat Enterprise Virtualization Manager. |
/var/lib/ovirt-engine/setup-history.txt | Tracks the installation and upgrade of packages associated with the Red Hat Enterprise Virtualization Manager. |
21.3. SPICE Log Files
debugging. Then, identify the log location.
console.vv file is downloaded, use the remote-viewer command to enable debugging and generate log output.
21.3.1. SPICE Logs for Hypervisor SPICE Servers
Table 21.3. SPICE Logs for Hypervisor SPICE Servers
| Log Type | Log Location | To Change Log Level: |
|---|---|---|
|
Host/Hypervisor SPICE Server
|
/var/log/libvirt/qemu/(guest_name).log
|
Run
export SPICE_DEBUG_LEVEL=5 on the host/hypervisor prior to launching the guest.
|
21.3.2. SPICE Logs for Guest Machines
Table 21.4. SPICE Logs for Guest Machines
| Log Type | Log Location | To Change Log Level: |
|---|---|---|
|
Windows Guest
|
C:\Windows\Temp\vdagent.log
C:\Windows\Temp\vdservice.log
|
Not applicable
|
|
Red Hat Enterprise Linux Guest
|
/var/log/spice-vdagent.log
| Create a /etc/sysconfig/spice-vdagentd file with this entry: SPICE_VDAGENTD_EXTRA_ARGS=”-d -d” |
21.3.3. SPICE Logs for SPICE Clients Launched Using Browser Plug-ins
Table 21.5. SPICE Logs for Client Machines (Browser Plug-ins)
| Log Type | Log Location | To Change Log Level: |
|---|---|---|
|
SPICE Client (Windows 7)
|
C:\Windows\Temp\spicex.log
|
|
|
SPICE Client (Windows XP)
|
C:\Documents and Settings\(User Name)\Local Settings\Temp\spicex.log
|
|
|
SPICE Client (Red Hat Enterprise Linux 6)
|
~/home/.spicec/spice-xpi.log
|
Edit the
/etc/spice/logger.ini file and change the log4j.rootCategory variable from INFO, R to DEBUG, R.
|
|
SPICE Client (Red Hat Enterprise Linux 7)
|
~/.xsession-errors
|
Launch Firefox from the command line with debug options:
G_MESSAGES_DEBUG=all SPICE_DEBUG=1 firefox.
Touch the
~/.xsession-errors file.
|
|
USB Redirector on Windows Client
|
C:\Windows\Temp\usbclerk.log
|
Not applicable.
|
21.3.4. SPICE Logs for SPICE Clients Launched Using console.vv Files
- Enable SPICE debugging by running the
remote-viewercommand with the--spice-debugoption. When prompted, enter the connection URL, for example, spice://[virtual_machine_IP]:[port].# remote-viewer --spice-debug
- To view logs, download the
console.vvfile and run theremote-viewercommand with the--spice-debugoption and specify the full path to theconsole.vvfile.# remote-viewer --spice-debug /path/to/console.vv
- Download the
debug-helper.exefile and move it to the same directory as theremote-viewer.exefile. For example, theC:\Users\[user name]\AppData\Local\virt-viewer\bindirectory. - Execute the
debug-helper.exefile to install the GNU Debugger (GDB). - Enable SPICE debugging by executing the
debug-helper.exefile.debug-helper.exe remote-viewer.exe --spice-controller
- To view logs, connect to the virtual machine, and you will see a command prompt running GDB that prints standard output and standard error of remote-viewer.
21.4. Red Hat Enterprise Virtualization Host Log Files
Table 21.6.
| Log File | Description |
|---|---|
/var/log/vdsm/libvirt.log | Log file for libvirt. |
/var/log/vdsm/spm-lock.log | Log file detailing the host's ability to obtain a lease on the Storage Pool Manager role. The log details when the host has acquired, released, renewed, or failed to renew the lease. |
/var/log/vdsm/vdsm.log | Log file for VDSM, the Manager's agent on the virtualization host(s). |
/tmp/ovirt-host-deploy-@DATE@.log | Host deployment log, copied to engine as /var/log/ovirt-engine/host-deploy/ovirt-@DATE@-@HOST@-@CORRELATION_ID@.log after the host has been successfully deployed. |
21.5. Remotely Logging Host Activities
21.5.1. Setting Up a Virtualization Host Logging Server
Procedure 21.1. Setting up a Virtualization Host Logging Server
- Configure SELinux to allow rsyslog traffic.
# semanage port -a -t syslogd_port_t -p udp 514
- Edit
/etc/rsyslog.confand add the following lines:$template TmplAuth, "/var/log/%fromhost%/secure" $template TmplMsg, "/var/log/%fromhost%/messages" $RuleSet remote authpriv.* ?TmplAuth *.info,mail.none;authpriv.none,cron.none ?TmplMsg $RuleSet RSYSLOG_DefaultRuleset $InputUDPServerBindRuleset remote
Uncomment the following:#$ModLoad imudp #$UDPServerRun 514
- Restart the rsyslog service:
# service rsyslog restart
messages and secure logs from your virtualization hosts.
21.5.2. Configuring Red Hat Enterprise Virtualization Hypervisor Hosts to Use a Logging Server
Procedure 21.2. Configuring Red Hat Enterprise Virtualization Hypervisor Hosts to Use a Logging Server
- Log in to your Red Hat Enterprise Virtualization Hypervisor host as
adminto access the Hypervisors text user interface (TUI) setup screen. - Select Logging from the list of options on the left of the screen.
- Press the key to reach the text entry fields. Enter the IP address or FQDN of your centralized log server and the port it uses.
- Press the key to reach the , and press the Key.
Chapter 22. Proxies
22.1. SPICE Proxy
22.1.1. SPICE Proxy Overview
SpiceProxyDefault to a value consisting of the name and port of the proxy. Turning a SPICE Proxy off consists of using engine-config on the Manager to remove the value to which the key SpiceProxyDefault has been set.
Important
22.1.2. SPICE Proxy Machine Setup
Procedure 22.1. Installing Squid on Red Hat Enterprise Linux
- Install Squid on the Proxy machine:
#yum install squid - Open
/etc/squid/squid.conf. Change:http_access deny CONNECT !SSL_ports
to:http_access deny CONNECT !Safe_ports
- Restart the proxy:
#service squid restart - Open the default squid port:
#iptables -A INPUT -p tcp --dport 3128 -j ACCEPT - Make this iptables rule persistent:
#service iptables save
22.1.3. Turning on SPICE Proxy
Procedure 22.2. Activating SPICE Proxy
- On the Manager, use the engine-config tool to set a proxy:
#
engine-config -s SpiceProxyDefault=someProxy - Restart the ovirt-engine service:
#
service ovirt-engine restartThe proxy must have this form:protocol://[host]:[port]
Note
Only the HTTP protocol is supported by SPICE clients. If HTTPS is specified, the client will ignore the proxy setting and attempt a direct connection to the hypervisor.
22.1.4. Turning Off a SPICE Proxy
Procedure 22.3. Turning Off a SPICE Proxy
- Log in to the Manager:
$
ssh root@[IP of Manager] - Run the following command to clear the SPICE proxy:
#
engine-config -s SpiceProxyDefault="" - Restart the Manager:
#
service ovirt-engine restart
22.2. Squid Proxy
22.2.1. Installing and Configuring a Squid Proxy
Procedure 22.4. Configuring a Squid Proxy
- Obtain a keypair and certificate for the HTTPS port of the Squid proxy server. You can obtain this keypair the same way that you would obtain a keypair for another SSL/TLS service. The keypair is in the form of two PEM files which contain the private key and the signed certificate. For this procedure, we assume that they are named
proxy.keyandproxy.cer.Note
The keypair and certificate can also be generated using the certificate authority of the engine. If you already have the private key and certificate for the proxy and do not want to generate it with the engine certificate authority, skip to the next step. - Choose a host name for the proxy. Then, choose the other components of the distinguished name of the certificate for the proxy.
Note
It is good practice to use the same country and same organization name used by the engine itself. Find this information by logging in to the machine where the Manager is installed and running the following command:# openssl x509 -in /etc/pki/ovirt-engine/ca.pem -noout -subject
This command outputs something like this:subject= /C=US/O=Example Inc./CN=engine.example.com.81108
The relevant part here is/C=US/O=Example Inc.. Use this to build the complete distinguished name for the certificate for the proxy:/C=US/O=Example Inc./CN=proxy.example.com
- Log in to the proxy machine and generate a certificate signing request:
# openssl req -newkey rsa:2048 -subj '/C=US/O=Example Inc./CN=proxy.example.com' -nodes -keyout proxy.key -out proxy.req
Important
You must include the quotes around the distinguished name for the certificate. The-nodesoption ensures that the private key is not encrypted; this means that you do not need to enter the password to start the proxy server.The command generates two files:proxy.keyandproxy.req.proxy.keyis the private key. Keep this file safe.proxy.reqis the certificate signing request.proxy.reqdoes not require any special protection. - To generate the signed certificate, copy the certificate signing request file from the proxy machine to the Manager machine:
# scp proxy.req engine.example.com:/etc/pki/ovirt-engine/requests/.
- Log in to the Manager machine and sign the certificate:
# /usr/share/ovirt-engine/bin/pki-enroll-request.sh --name=proxy --days=3650 --subject='/C=US/O=Example Inc./CN=proxy.example.com'
This signs the certificate and makes it valid for 10 years (3650 days). Set the certificate to expire earlier, if you prefer. - The generated certificate file is available in the directory
/etc/pki/ovirt-engine/certsand should be namedproxy.cer. On the proxy machine, copy this file from the Manager machine to your current directory:# scp engine.example.com:/etc/pki/ovirt-engine/certs/proxy.cer .
- Ensure both
proxy.keyandproxy.cerare present on the proxy machine:# ls -l proxy.key proxy.cer
- Install the Squid proxy server package on the proxy machine:
# yum install squid
- Move the private key and signed certificate to a place where the proxy can access them, for example to the
/etc/squiddirectory:# cp proxy.key proxy.cer /etc/squid/.
- Set permissions so that the
squiduser can read these files:# chgrp squid /etc/squid/proxy.* # chmod 640 /etc/squid/proxy.*
- The Squid proxy must verify the certificate used by the engine. Copy the Manager certificate to the proxy machine. This example uses the file path
/etc/squid:# scp engine.example.com:/etc/pki/ovirt-engine/ca.pem /etc/squid/.
Note
The default CA certificate is located in/etc/pki/ovirt-engine/ca.pemon the Manager machine. - Set permissions so that the
squiduser can read the certificate file:# chgrp squid /etc/squid/ca.pem # chmod 640 /etc/squid/ca.pem
- If SELinux is in enforcing mode, change the context of port 443 using the semanage tool to permit Squid to use port 443:
# yum install policycoreutils-python # semanage port -m -p tcp -t http_cache_port_t 443
- Replace the existing Squid configuration file with the following:
https_port 443 key=/etc/squid/proxy.key cert=/etc/squid/proxy.cer ssl-bump defaultsite=engine.example.com cache_peer engine.example.com parent 443 0 no-query originserver ssl sslcafile=/etc/squid/ca.pem name=engine cache_peer_access engine allow all ssl_bump allow all http_access allow all
- Restart the Squid proxy server:
# service squid restart
- Connect to the User Portal using the complete URL, for instance:
https://proxy.example.com/UserPortal/org.ovirt.engine.ui.userportal.UserPortal/UserPortal.html
Note
Shorter URLs, for examplehttps://proxy.example.com/UserPortal, will not work. These shorter URLs are redirected to the long URL by the application server, using the 302 response code and the Location header. The version of Squid in Red Hat Enterprise Linux does not support rewriting these headers.
Note
read_timeout option in squid.conf (for instance read_timeout 10 hours).
Chapter 23. History Database, Reports, and Dashboards
23.1. Introduction
23.1.1. History Database Overview
Warning
SELECT statement. The result of the SELECT statement populates the virtual table that the view returns. A user references the view name in PL/PGSQL statements the same way a table is referenced.
23.1.2. Database Names in Red Hat Enterprise Virtualization 3.0 and 3.1
rhevm and a history database called rhevm_history.
ovirt-engine and history database is called ovirt-engine-history.
ovirt-engine database is equivalent to the rhevm database. The ovirt-engine-history database is equivalent to the rhevm_history database.
23.1.3. JasperReports and JasperServer in Red Hat Enterprise Virtualization
23.2. History Database
- 23.2.1. Red Hat Enterprise Virtualization History Database
- 23.2.2. Tracking Configuration History
- 23.2.3. Recording Statistical History
- 23.2.4. Application Settings for the Data Warehouse service in ovirt-engine-dwhd.conf
- 23.2.5. Tracking Tag History
- 23.2.6. Allowing Read-Only Access to the History Database
- 23.2.7. Reports Examples
- 23.2.8. Statistics History Views
- 23.2.9. Configuration History Views
23.2.1. Red Hat Enterprise Virtualization History Database
ovirt_engine_history) which tracks the engine database over time.
Important
23.2.2. Tracking Configuration History
ovirt-engine-dwhd, tracks three types of changes:
- A new entity is added to the engine database - the ETL Service replicates the change to the ovirt_engine_history database as a new entry.
- An existing entity is updated - the ETL Service replicates the change to the ovirt_engine_history database as a new entry.
- An entity is removed from the engine database - A new entry in the ovirt_engine_history database flags the corresponding entity as removed. Removed entities are only flagged as removed. To maintain correctness of historical reports and representations, they are not physically removed.
- a
history_idto indicate the configuration version of the entity; - a
create_datefield to indicate when the entity was added to the system; - an
update_datefield to indicate when the entity was changed; and - a
delete_datefield to indicate the date the entity was removed from the system.
23.2.3. Recording Statistical History
23.2.4. Application Settings for the Data Warehouse service in ovirt-engine-dwhd.conf
/usr/share/ovirt-engine-dwh/services/ovirt-engine-dwhd/ovirt-engine-dwhd.conf file. Configure any changes to the default values in an override file under /etc/ovirt-engine-dwh/ovirt-engine-dwhd.conf.d/. Restart the Data Warehouse service after saving the changes.
Table 23.1. ovirt-engine-dwhd.conf application settings variables
| Variable name | Default Value | Remarks |
|---|---|---|
DWH_DELETE_JOB_HOUR | 3 | The time at which a deletion job is run. Specify a value between 0 and 23, where 0 is midnight. |
DWH_SAMPLING | 60 | The interval, in seconds, at which data is collected into statistical tables. |
DWH_TABLES_KEEP_SAMPLES | 24 | The number of hours that data from DWH_SAMPLING is stored. Data more than two hours old is aggregated into hourly data. |
DWH_TABLES_KEEP_HOURLY | 1440 | The number of hours that hourly data is stored. The default is 60 days. Hourly data more than two days old is aggregated into daily data. |
DWH_TABLES_KEEP_DAILY | 43800 | The number of hours that daily data is stored. The default is five years. |
DWH_ERROR_EVENT_INTERVAL | 300000 | The minimum interval, in milliseconds, at which errors are pushed to the Manager's audit.log. |
23.2.5. Tracking Tag History
- A tag is created in the Administration Portal - the ETL Service copies the tag details, position in the tag tree and relation to other objects in the tag tree.
- A entity is attached to the tag tree in the Administration Portal - the ETL Service replicates the addition to the ovirt_engine_history database as a new entry.
- A tag is updated - the ETL Service replicates the change of tag details to the ovirt_engine_history database as a new entry.
- An entity or tag branch is removed from the Administration Portal - the ovirt_engine_history database flags the corresponding tag and relations as removed in new entries. Removed tags and relations are only flagged as removed or detached. In order to maintain correctness of historical reports and representations, they are not physically removed.
- A tag branch is moved - the corresponding tag and relations are updated as new entries. Moved tags and relations are only flagged as updated. In order to maintain correctness of historical reports and representations, they are not physically updated.
23.2.6. Allowing Read-Only Access to the History Database
ovirt_engine_history database. This procedure must be executed on the system on which the history database is installed.
Procedure 23.1. Allowing Read-Only Access to the History Database
- Create the user to be granted read-only access to the history database:
# psql -U postgres -c "CREATE ROLE [user name] WITH LOGIN ENCRYPTED PASSWORD '[password]';" -d ovirt_engine_history
- Grant the newly created user permission to connect to the history database:
# psql -U postgres -c "GRANT CONNECT ON DATABASE ovirt_engine_history TO [user name];"
- Grant the newly created user usage of the
publicschema:# psql -U postgres -c "GRANT USAGE ON SCHEMA public TO [user name];" ovirt_engine_history
- Generate the rest of the permissions that will be granted to the newly created user and save them to a file:
# psql -U postgres -c "SELECT 'GRANT SELECT ON ' || relname || ' TO [user name];' FROM pg_class JOIN pg_namespace ON pg_namespace.oid = pg_class.relnamespace WHERE nspname = 'public' AND relkind IN ('r', 'v');" --pset=tuples_only=on ovirt_engine_history > grant.sql - Use the file you created in the previous step to grant permissions to the newly created user:
# psql -U postgres -f grant.sql ovirt_engine_history
- Remove the file you used to grant permissions to the newly created user:
# rm grant.sql
ovirt_engine_history database with the newly created user using the following command:
# psql -U [user name] ovirt_engine_history
SELECT statements against tables and views in the ovirt_engine_history database succeed, while modifications fail.
23.2.7. Reports Examples
where clause are substituted with the appropriate values for your environment and that the latest configuration is in use.
Example 23.1. Report query for resource utilization on a single host
select history_datetime as DateTime, cpu_usage_percent as CPU, memory_usage_percent as Memory
from host_configuration, host_samples_history
where host_configuration.host_id = host_samples_history.host_id
and host_name = 'example.labname.abc.company.com'
and host_configuration.history_id in (select max(a.history_id)
from host_configuration as a
where host_configuration.host_id = a.host_id)
and history_datetime >= '2011-07-01 18:45'
and history_datetime <= '2011-07-31 21:45'
Table 23.2. Resource Utilization for a Single Host Example Data
| DateTime | CPU | Memory |
|---|---|---|
| 2010-07-01 18:45 | 42 | 0 |
| 2010-07-01 18:46 | 42 | 0 |
| 2010-07-01 18:47 | 42 | 1 |
| 2010-07-01 18:48 | 33 | 0 |
| 2010-07-01 18:49 | 33 | 0 |
| 2010-07-01 18:50 | 25 | 1 |
where clause are substituted with appropriate values for your environment.
Example 23.2. Report query for resource utilization across all hosts
select extract(hour from history_datetime) as Hour, avg(cpu_usage_percent) as CPU, avg(memory_usage_percent) as Memory
from host_hourly_history
where history_datetime >= '2011-07-01' and history_datetime < '2011-07-31'
group by extract(hour from history_datetime)
order by extract(hour from history_datetime)
Table 23.3. Resource utilization across all hosts example data
| Hour | CPU | Memory |
|---|---|---|
| 0 | 39 | 40 |
| 1 | 38 | 38 |
| 2 | 37 | 32 |
| 3 | 35 | 45 |
| 4 | 35 | 37 |
| 5 | 36 | 37 |
where clause are substituted with appropriate values for your environment.
Example 23.3.
SELECT vm_name FROM vm_configuration inner join latest_tag_relations_history on (vm_configuration.vm_id = latest_tag_relations_history.entity_id) inner join latest_tag_details on (latest_tag_details.tag_id = latest_tag_relations_history.parent_id) WHERE getpathinnames(latest_tag_details.history_id) like '/root/tlv%'
Table 23.4. Tag Filtering of Latest Virtual Machine Configuration
| vm_name |
|---|
| RHEL6-Pool-67 |
| RHEL6-Pool-5 |
| RHEL6-Pool-6 |
| RHEL6-23 |
Example 23.4.
SELECT vm_name, vm_type, operating_system FROM vm_configuration inner join enum_translator as vm_type_value on (vm_type_value.enum_type = 'VM_TYPE' and vm_configuration.vm_type = vm_type_value.enum_key) inner join enum_translator as os_value on (os_value.enum_type = 'OS_TYPE' and vm_configuration.operating_system = os_value.enum_key)
Table 23.5. Current Virtual Machines' Names, Types, and Operating Systems
| vm_name | vm_type | operating_system |
|---|---|---|
| RHEL6-Pool-2 | Desktop | RHEL 6 x64 |
| RHEL6-Pool-1 | Desktop | RHEL 6 x64 |
| RHEL6-Pool-3 | Desktop | RHEL 6 x64 |
| RHEL6-Pool-4 | Desktop | RHEL 6 x64 |
| RHEL6-Pool-5 | Desktop | RHEL 6 x64 |
23.2.8. Statistics History Views
23.2.8.1. Statistics History Views
23.2.8.2. Datacenter Statistics Views
Table 23.6. Historical Statistics for Each Data Center in the System
| Name | Type | Description |
|---|---|---|
| history_id | bigint | The unique ID of this row in the table. |
| history_datetime | timestamp with time zone | The timestamp of this history row (rounded to minute, hour, day as per the aggregation level). |
| datacenter_id | uuid | The unique ID of the data center. |
| datacenter_status | smallint |
|
| minutes_in_status | decimal | The total number of minutes that the data center was in the status shown in the datacenter_status column for the aggregation period. For example, if a data center was up for 55 minutes and in maintenance mode for 5 minutes during an hour, two rows will show for this hour. One will have a datacenter_status of Up and minutes_in_status of 55, the other will have a datacenter_status of Maintenance and a minutes_in_status of 5. |
| datacenter_configuration_version | integer | The data center configuration version at the time of sample. |
23.2.8.3. Storage Domain Statistics Views
Table 23.7. Historical Statistics for Each Storage Domain in the System
| Name | Type | Description |
|---|---|---|
| history_id | bigint | The unique ID of this row in the table. |
| history_datetime | timestamp with time zone | The timestamp of this history row (rounded to minute, hour, day as per the aggregation level). |
| storage_domain_id | uuid | Unique ID of the storage domain in the system. |
| available_disk_size_gb | integer | The total available (unused) capacity on the disk, expressed in gigabytes (GB). |
| used_disk_size_gb | integer | The total used capacity on the disk, expressed in gigabytes (GB). |
| storage_configuration_version | integer | The storage domain configuration version at the time of sample. |
| storage_domain_status | smallint | The storage domain status. |
| minutes_in_status | decimal | The total number of minutes that the storage domain was in the status shown state as shown in the status column for the aggregation period. For example, if a storage domain was "Active" for 55 minutes and "Inactive" for 5 minutes within an hour, two rows will be reported in the table for the same hour. One row will have a status of Active with minutes_in_status of 55, the other will have a status of Inactive and minutes_in_status of 5. |
23.2.8.4. Host Statistics Views
Table 23.8. Historical Statistics for Each Host in the System
| Name | Type | Description |
|---|---|---|
| history_id | bigint | The unique ID of this row in the table. |
| history_datetime | timestamp with time zone | The timestamp of this history row (rounded to minute, hour, day as per the aggregation level). |
| host_id | uuid | Unique ID of the host in the system. |
| host_status | smallint |
|
| minutes_in_status | decimal | The total number of minutes that the host was in the status shown in the status column for the aggregation period. For example, if a host was up for 55 minutes and down for 5 minutes during an hour, two rows will show for this hour. One will have a status of Up and minutes_in_status of 55, the other will have a status of Down and a minutes_in_status of 5. |
| memory_usage_percent | smallint | Percentage of used memory on the host. |
| max_memory_usage | smallint | The maximum memory usage for the aggregation period, expressed as a percentage. For hourly aggregations, this is the maximum collected sample value. For daily aggregations, it is the maximum hourly average value. |
| cpu_usage_percent | smallint | Used CPU percentage on the host. |
| max_cpu_usage | smallint | The maximum CPU usage for the aggregation period, expressed as a percentage. For hourly aggregations, this is the maximum collected sample value. For daily aggregations, it is the maximum hourly average value. |
| ksm_cpu_percent | smallint | CPU percentage ksm on the host is using. |
| max_ksm_cpu_percent | smallint | The maximum KSM usage for the aggregation period, expressed as a percentage. For hourly aggregations, this is the maximum collected sample value. For daily aggregations, it is the maximum hourly average value. |
| active_vms | smallint | The average number of active virtual machines for this aggregation. |
| max_active_vms | smallint | The maximum active number of virtual machines for the aggregation period. For hourly aggregations, this is the maximum collected sample value. For daily aggregations, it is the maximum hourly average value. |
| total_vms | smallint | The average number of all virtual machines on the host for this aggregation. |
| max_total_vms | smallint | The maximum total number of virtual machines for the aggregation period. For hourly aggregations, this is the maximum collected sample value. For daily aggregations, it is the maximum hourly average value. |
| total_vms_vcpus | smallint | Total number of VCPUs allocated to the host. |
| max_total_vms_vcpus | smallint | The maximum total virtual machine VCPU number for the aggregation period. For hourly aggregations, this is the maximum collected sample value. For daily aggregations, it is the maximum hourly average value. |
| cpu_load | smallint | The CPU load of the host. |
| max_cpu_load | smallint | The maximum CPU load for the aggregation period. For hourly aggregations, this is the maximum collected sample value. For daily aggregations, it is the maximum hourly average value. |
| system_cpu_usage_percent | smallint | Used CPU percentage on the host. |
| max_system_cpu_usage_percent | smallint | The maximum system CPU usage for the aggregation period, expressed as a percentage. For hourly aggregations, this is the maximum collected sample value. For daily aggregations, it is the maximum hourly average value. |
| user_cpu_usage_percent | smallint | Used user CPU percentage on the host. |
| max_user_cpu_usage_percent | smallint | The maximum user CPU usage for the aggregation period, expressed as a percentage. For hourly aggregations, this is the maximum collected sample value. For daily aggregations, it is the maximum hourly average value. |
| swap_used_mb | integer | Used swap size usage of the host in megabytes (MB). |
| max_swap_used_mb | integer | The maximum user swap size usage of the host for the aggregation period in megabytes (MB), expressed as a percentage. For hourly aggregations, this is the maximum collected sample value. For daily aggregations, it is the maximum hourly average value. |
| host_configuration_version | integer | The host configuration version at the time of sample. |
| ksm_shared_memory_mb | bigint | The Kernel Shared Memory size in megabytes (MB) that the host is using. |
| max_ksm_shared_memory_mb | bigint | The maximum KSM memory usage for the aggregation period expressed in megabytes (MB). For hourly aggregations, this is the maximum collected sample value. For daily aggregations, it is the maximum hourly average value. |
23.2.8.5. Host Interface Statistics Views
Table 23.9. Historical Statistics for Each Host Network Interface in the System
| Name | Type | Description |
|---|---|---|
| history_id | bigint | The unique ID of this row in the table. |
| history_datetime | timestamp with time zone | The timestamp of this history view (rounded to minute, hour, day as per the aggregation level). |
| host_interface_id | uuid | Unique identifier of the interface in the system. |
| receive_rate_percent | smallint | Used receive rate percentage on the host. |
| max_receive_rate_percent | smallint | The maximum receive rate for the aggregation period, expressed as a percentage. For hourly aggregations, this is the maximum collected sample value. For daily aggregations, it is the maximum hourly average value. |
| transmit_rate_percent | smallint | Used transmit rate percentage on the host. |
| max_transmit_rate_percent | smallint | The maximum transmit rate for the aggregation period, expressed as a percentage. For hourly aggregations, this is the maximum collected sample value. For daily aggregations, it is the maximum hourly average value. |
| host_interface_configuration_version | integer | The host interface configuration version at the time of sample. |
23.2.8.6. Virtual Machine Statistics Views
Table 23.10. Historical statistics for the virtual machines in the system
| Name | Type | Description |
|---|---|---|
| history_id | bigint | The unique ID of this row in the table. |
| history_datetime | timestamp with time zone | The timestamp of this history row (rounded to minute, hour, day as per the aggregation level). |
| vm_id | uuid | Unique ID of the virtual machine in the system. |
| vm_status | smallint |
|
| minutes_in_status | decimal | The total number of minutes that the virtual machine was in the status shown in the status column for the aggregation period. For example, if a virtual machine was up for 55 minutes and down for 5 minutes during an hour, two rows will show for this hour. One will have a status of Up and minutes_in_status, the other will have a status of Down and a minutes_in_status of 5. |
| cpu_usage_percent | smallint | The percentage of the CPU in use by the virtual machine. |
| max_cpu_usage | smallint | The maximum CPU usage for the aggregation period, expressed as a percentage. For hourly aggregations, this is the maximum collected sample value. For daily aggregations, it is the maximum hourly average value. |
| memory_usage_percent | smallint | Percentage of used memory in the virtual machine. The guest tools must be installed on the virtual machine for memory usage to be recorded. |
| max_memory_usage | smallint | The maximum memory usage for the aggregation period, expressed as a percentage. For hourly aggregations, this is the maximum collected sample value. For daily aggregations, it is the maximum hourly average value. The guest tools must be installed on the virtual machine for memory usage to be recorded. |
| user_cpu_usage_percent | smallint | Used user CPU percentage on the host. |
| max_user_cpu_usage_percent | smallint | The maximum user CPU usage for the aggregation period, expressed as a percentage. For hourly aggregations, this is the maximum collected sample value. For daily aggregation, it is the maximum hourly average value. |
| system_cpu_usage_percent | smallint | Used system CPU percentage on the host. |
| max_system_cpu_usage_percent | smallint | The maximum system CPU usage for the aggregation period, expressed as a percentage. For hourly aggregations, this is the maximum collected sample value. For daily aggregations, it is the maximum hourly average value. |
| vm_ip | varchar(255) | The IP address of the first NIC. Only shown if the guest agent is installed. |
| current_user_name | varchar(255) | Name of user logged into the virtual machine console, if a guest agent is installed. |
| currently_running_on_host | uuid | The unique ID of the host the virtual machine is running on. |
| vm_configuration_version | integer | The virtual machine configuration version at the time of sample. |
| current_host_configuration_version | integer | The current host the virtual machine is running on. |
| current_user_id | uuid | The unique ID of the user in the system. This ID is generated by the Manager. |
23.2.8.7. Virtual Machine Interface Statistics Views
Table 23.11. Historical Statistics for the Virtual Machine Network Interfaces in the System
| Name | Type | Description |
|---|---|---|
| history_id | bigint | The unique ID of this row in the table. |
| history_datetime | timestamp with time zone | The timestamp of this history row (rounded to minute, hour, day as per the aggregation level). |
| vm_interface_id | uuid | Unique identifier of the interface in the system. |
| receive_rate_percent | smallint | Used receive rate percentage on the host. |
| max_receive_rate_percent | smallint | The maximum receive rate for the aggregation period, expressed as a percentage. For hourly aggregations, this is the maximum collected sample value. For daily aggregations, it is the maximum hourly average value. |
| transmit_rate_percent | smallint | Used transmit rate percentage on the host. |
| max_transmit_rate_percent | smallint | The maximum transmit rate for the aggregation period, expressed as a percentage. For hourly aggregations, this is the maximum collected sample value. For daily aggregations, it is the maximum hourly average rate. |
| vm_interface_configuration_version | integer | The virtual machine interface configuration version at the time of sample. |
23.2.8.8. Virtual Machine Disk Statistics Views
Table 23.12. Historical Statistics for the Virtual Disks in the System
| Name | Type | Description |
|---|---|---|
| history_id | bigint | The unique ID of this row in the table. |
| history_datetime | timestamp with time zone | The timestamp of this history row (rounded to minute, hour, day as per the aggregation level). |
| vm_disk_id | uuid | Unique ID of the disk in the system. |
| vm_disk_status | integer |
|
| minutes_in_status | decimal | The total number of minutes that the virtual machine disk was in the status shown in the status column for the aggregation period. For example, if a virtual machine disk was locked for 55 minutes and OK for 5 minutes during an hour, two rows will show for this hour. One will have a status of Locked and minutes_in_status of 55, the other will have a status of OK and a minutes_in_status of 5. |
| vm_disk_actual_size_mb | integer | The actual size allocated to the disk. |
| read_rate_bytes_per_second | integer | Read rate to disk in bytes per second. |
| max_read_rate_bytes_per_second | integer | The maximum read rate for the aggregation period. For hourly aggregations, this is the maximum collected sample value. For daily aggregations, it is the maximum hourly average value. |
| read_latency_seconds | decimal | The virtual machine disk read latency measured in seconds. |
| max_read_latency_seconds | decimal | The maximum write latency for the aggregation period, measured in seconds. For hourly aggregations, this is the maximum collected sample value. For daily aggregations, it is the maximum hourly average value. |
| write_rate_bytes_per_second | integer | Write rate to disk in bytes per second. |
| max_write_rate_bytes_per_second | integer | The maximum write rate for the aggregation period. For hourly aggregations, this is the maximum collected sample value. For daily aggregations, it is the maximum hourly average value. |
| write_latency_seconds | decimal | The virtual machine disk write latency measured in seconds. |
| max_write_latency_seconds | decimal | The maximum write latency for the aggregation period, measured in seconds. For hourly aggregations, this is the maximum collected sample value. For daily aggregations, it is the maximum hourly average value. |
| flush_latency_seconds | decimal | The virtual machine disk flush latency measured in seconds. |
| max_flush_latency_seconds | decimal | The maximum flush latency for the aggregation period, measured in seconds. For hourly aggregations, this is the maximum collected sample value. For daily aggregations, it is the maximum hourly average value. |
| vm_disk_configuration_version | integer | The virtual machine disk configuration version at the time of sample. |
23.2.9. Configuration History Views
23.2.9.1. Configuration History Views
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.
23.2.9.2. Data Center Configuration
Table 23.13. v3_5_configuration_history_datacenters
| Name | Type | Description |
|---|---|---|
| history_id | integer | The ID of the configuration version in the history database. |
| datacenter_id | uuid | The unique ID of the data center in the system. |
| datacenter_name | varchar(40) | Name of the data center, as displayed in the edit dialog. |
| datacenter_description | varchar(4000) | Description of the data center, as displayed in the edit dialog. |
| storage_type | smallint |
|
| create_date | timestamp with time zone | The date this entity was added to the system. |
| update_date | timestamp with time zone | The date this entity was changed in the system. |
| delete_date | timestamp with time zone | The date this entity was deleted from the system. |
23.2.9.3. Datacenter Storage Domain Map
Table 23.14. v3_5_map_history_datacenters_storage_domains
| Name | Type | Description |
|---|---|---|
| history_id | integer | The ID of the configuration version in the history database. |
| storage_domain_id | uuid | The unique ID of this storage domain in the system. |
| datacenter_id | uuid | The unique ID of the data center in the system. |
| attach_date | timestamp with time zone | The date the storage domain was attached to the data center. |
| detach_date | timestamp with time zone | The date the storage domain was detached from the data center. |
23.2.9.4. Storage Domain Configuration
Table 23.15. v3_5_configuration_history_storage_domains
| Name | Type | Description |
|---|---|---|
| history_id | integer | The ID of the configuration version in the history database. |
| storage_domain_id | uuid | The unique ID of this storage domain in the system. |
| storage_domain_name | varchar(250) | Storage domain name. |
| storage_domain_type | smallint |
|
| storage_type | smallint |
|
| create_date | timestamp with time zone | The date this entity was added to the system. |
| update_date | timestamp with time zone | The date this entity was changed in the system. |
| delete_date | timestamp with time zone | The date this entity was deleted from the system. |
23.2.9.5. Cluster Configuration
Table 23.16. v3_5_configuration_history_clusters
| Name | Type | Description |
|---|---|---|
| history_id | integer | The ID of the configuration version in the history database. |
| cluster_id | uuid | The unique identifier of the datacenter this cluster resides in. |
| cluster_name | varchar(40) | Name of the cluster, as displayed in the edit dialog. |
| cluster_description | varchar(4000) | As defined in the edit dialog. |
| datacenter_id | uuid | The unique identifier of the datacenter this cluster resides in. |
| cpu_name | varchar(255) | As displayed in the edit dialog. |
| compatibility_version | varchar(40) | As displayed in the edit dialog. |
| datacenter_configuration_version | integer | The data center configuration version at the time of creation or update. |
| create_date | timestamp with time zone | The date this entity was added to the system. |
| update_date | timestamp with time zone | The date this entity was changed in the system. |
| delete_date | timestamp with time zone | The date this entity was deleted from the system. |
23.2.9.6. Host Configuration
Table 23.17. v3_5_configuration_history_hosts
| Name | Type | Description |
|---|---|---|
| history_id | integer | The ID of the configuration version in the history database. |
| host_id | uuid | The unique ID of the host in the system. |
| host_unique_id | varchar(128) | This field is a combination of the host physical UUID and one of its MAC addresses, and is used to detect hosts already registered in the system. |
| host_name | varchar(255) | Name of the host (same as in the edit dialog). |
| cluster_id | uuid | The unique ID of the cluster that this host belongs to. |
| host_type | smallint |
|
| fqdn_or_ip | varchar(255) | The host's DNS name or its IP address for Red Hat Enterprise Virtualization Manager to communicate with (as displayed in the edit dialog). |
| memory_size_mb | integer | The host's physical memory capacity, expressed in megabytes (MB). |
| swap_size_mb | integer | The host swap partition size. |
| cpu_model | varchar(255) | The host's CPU model. |
| number_of_cores | smallint | Total number of CPU cores in the host. |
| number_of_sockets | smallint | Total number of CPU sockets. |
| cpu_speed_mh | decimal | The host's CPU speed, expressed in megahertz (MHz). |
| host_os | varchar(255) | The host's operating system version. |
| pm_ip_address | varchar(255) | Power Management server IP address. |
| kernel_version | varchar(255) | The host's kernel version. |
| kvm_version | varchar(255) | The host's KVM version. |
| vdsm_version | varchar(40) | The host's VDSM version. |
| vdsm_port | integer | As displayed in the edit dialog. |
| cluster_configuration_version | integer | The cluster configuration version at the time of creation or update. |
| create_date | timestamp with time zone | The date this entity was added to the system. |
| update_date | timestamp with time zone | The date this entity was changed in the system. |
| delete_date | timestamp with time zone | The date this entity was deleted from the system. |
23.2.9.7. Host Interface Configuration
Table 23.18. v3_5_configuration_history_hosts_interfaces
| Name | Type | Description |
|---|---|---|
| history_id | integer | The ID of the configuration version in the history database. |
| host_interface_id | uuid | The unique ID of this interface in the system. |
| host_interface_name | varchar(50) | The interface name as reported by the host. |
| host_id | uuid | Unique ID of the host this interface belongs to. |
| host_interface_type | smallint |
|
| host_interface_speed_bps | integer | The interface speed in bits per second. |
| mac_address | varchar(20) | The interface MAC address. |
| logical_network_name | varchar(50) | The logical network associated with the interface. |
| ip_address | varchar(50) | As displayed in the edit dialog. |
| gateway | varchar(20) | As displayed in the edit dialog. |
| bond | Boolean | A flag to indicate if this interface is a bonded interface. |
| bond_name | varchar(50) | The name of the bond this interface is part of (if it is part of a bond). |
| vlan_id | integer | As displayed in the edit dialog. |
| host_configuration_version | integer | The host configuration version at the time of creation or update. |
| create_date | timestamp with time zone | The date this entity was added to the system. |
| update_date | timestamp with time zone | The date this entity was changed in the system. |
| delete_date | timestamp with time zone | The date this entity was deleted from the system. |
23.2.9.8. Virtual Machine Configuration
Table 23.19. v3_5_configuration_history_vms
| Name | Type | Description |
|---|---|---|
| history_id | integer | The ID of the configuration version in the history database. |
| vm_id | uuid | The unique ID of this VM in the system. |
| vm_name | varchar(255) | The name of the VM. |
| vm_description | varchar(4000) | As displayed in the edit dialog. |
| vm_type | smallint |
|
| cluster_id | uuid | The unique ID of the cluster this VM belongs to. |
| template_id | uuid | The unique ID of the template this VM is derived from. The field is for future use, as the templates are not synchronized to the history database in this version. |
| template_name | varchar(40) | Name of the template from which this VM is derived. |
| cpu_per_socket | smallint | Virtual CPUs per socket. |
| number_of_sockets | smallint | Total number of virtual CPU sockets. |
| memory_size_mb | integer | Total memory allocated to the VM, expressed in megabytes (MB). |
| operating_system | smallint |
|
| default_host | uuid | As displayed in the edit dialog, the ID of the default host in the system. |
| high_availability | Boolean | As displayed in the edit dialog. |
| initialized | Boolean | A flag to indicate if this VM was started at least once for Sysprep initialization purposes. |
| stateless | Boolean | As displayed in the edit dialog. |
| fail_back | Boolean | As displayed in the edit dialog. |
| usb_policy | smallint | As displayed in the edit dialog. |
| time_zone | varchar(40) | As displayed in the edit dialog. |
| cluster_configuration_version | integer | The cluster configuration version at the time of creation or update. |
| default_host_configuration_version | integer | The host configuration version at the time of creation or update. |
| create_date | timestamp with time zone | The date this entity was added to the system. |
| update_date | timestamp with time zone | The date this entity was changed in the system. |
| delete_date | timestamp with time zone | The date this entity was deleted from the system. |
| vm_pool_id | uuid | The virtual machine's pool unique ID. |
| vm_pool_name | varchar(255) | The name of the virtual machine's pool. |
23.2.9.9. Virtual Machine Interface Configuration History
Table 23.20. v3_5_configuration_history_vms_interfaces
| Name | Type | Description |
|---|---|---|
| history_id | integer | The ID of the configuration version in the history database. |
| vm_interface_id | uuid | The unique ID of this interface in the system. |
| vm_interface_name | varchar(50) | As displayed in the edit dialog. |
| vm_interface_type | smallint |
The type of the virtual interface.
|
| vm_interface_speed_bps | integer | The average speed of the interface during the aggregation in bits per second. |
| mac_address | varchar(20) | As displayed in the edit dialog. |
| logical_network_name | varchar(50) | As displayed in the edit dialog. |
| vm_configuration_version | integer | The virtual machine configuration version at the time of creation or update. |
| create_date | timestamp with time zone | The date this entity was added to the system. |
| update_date | timestamp with time zone | The date this entity was changed in the system. |
| delete_date | timestamp with time zone | The date this entity was deleted from the system. |
23.2.9.10. Virtual Machine Device Configuration
Table 23.21. v3_5_configuration_history_vms_devices
| Name | Type | Description |
|---|---|---|
| history_id | integer | The ID of the configuration version in the history database. |
| vm_id | uuid | The unique ID of the virtual machine in the system. |
| type | varchar(30) | VM Device Type which can be "disk" or "interface" |
| address | varchar(255) | The virtual machine's device physical address |
| is_managed | Boolean | Flag that indicates if the device is managed by the Manager |
| is_plugged | Boolean | Flag that indicates if the device is plugged into the virtual machine. |
| is_readonly | Boolean | Flag that indicates if the device is read only. |
| vm_configuration_version | integer | The virtual machine configuration version at the time the sample was taken. |
| device_configuration_version | integer | The device configuration version at the time the sample was taken. |
| create_date | timestamp with time zone | The date this entity was added to the system. |
| update_date timestamp | timestamp with time zone | The date this entity was added to the system. |
| delete_date | timestamp with time zone | The date this entity was added to the system. |
23.2.9.11. Virtual Machine Disk Configuration
Table 23.22. v3_5_configuration_history_vms_disks
| Name | Type | Description |
|---|---|---|
| history_id | integer | The ID of the configuration version in the history database. |
| vm_disk_id | uuid | The unique ID of this disk in the system. |
| vm_disk_description | varchar(4000) | As displayed in the edit dialog. |
| storage_domain_id | uuid | The ID of the storage domain this disk image belongs to. |
| vm_disk_size_mb | integer | The defined size of the disk in megabytes (MB). |
| vm_disk_type | integer |
As displayed in the edit dialog. Only System and data are currently used.
|
| vm_disk_format | integer |
As displayed in the edit dialog.
|
| vm_disk_interface | integer |
|
| create_date | timestamp with time zone | The date this entity was added to the system. |
| update_date | timestamp with time zone | The date this entity was changed in the system. |
| delete_date | timestamp with time zone | The date this entity was deleted from the system. |
| is_shared | Boolean | Flag that indicates if the virtual machine's disk is shared. |
| image_id | uuid | The unique ID of the image in the system. |
23.2.9.12. User Details History
Table 23.23. v3_6_users_details_history view
| Name | Type | Description |
|---|---|---|
| user_id | uuid | The unique ID of the user in the system as generated by Manager. |
| first_name | varchar(255) | The user's first name. |
| last_name | varchar(255) | The user's last name. |
| domain | varchar(255) | The name of the authorization extension. |
| username | varchar(255) | The account name |
| department | varchar(255) | The organizational department the user belongs to. |
| user_role_title | varchar(255) | The title or role of the user within the organization. |
| varchar(255) | The email of the user in the organization. | |
| external_id | text | The unique identifier of the user from the external system. |
| active | Boolean | If the user is active or not - this is being checked once in an hour, if the user can be found in the authorization extension then it will remain active. A user can be turned to active also on successful login. |
| create_date | timestamp with time zone | The date this entity was added to the system. |
| update_date | timestamp with time zone | The date this entity was changed in the system. |
| delete_date | timestamp with time zone | The date this entity was deleted from the system. |
23.3. Reports
- 23.3.1. Online Help for JasperReports
- 23.3.2. JasperReports System Requirements
- 23.3.3. Users in the Red Hat Enterprise Virtualization Reports Portal
- 23.3.4. Logging in to Access the Reports Portal
- 23.3.5. Accessing the Red Hat Enterprise Virtualization Reports User Management Menu
- 23.3.6. Reports Portal User Roles
- 23.3.7. Navigating Reports and Dashboards
- 23.3.8. Report Parameters
- 23.3.9. Right-click Reporting Integration with the Red Hat Enterprise Virtualization Administration Portal
- 23.3.10. Executive Reports
- 23.3.11. Inventory Reports
- 23.3.12. Service Level Reports
- 23.3.13. Trend Reports
- 23.3.14. Ad Hoc Reports
- 23.3.15. Reports Schema: Tag History and ENUM Views
23.3.1. Online Help for JasperReports
Note
/usr/share/jasperreports-server-pro/docs/
23.3.2. JasperReports System Requirements
Web Browsers in the table of contents.
23.3.3. Users in the Red Hat Enterprise Virtualization Reports Portal
admin and superuser. The passwords for these users were set during the installation of Red Hat Enterprise Virtualization Reports. Generally, additional users must be added manually.
Note
admin user name was rhevm-admin. If you are performing a clean installation, the user name is now admin. If you are performing an upgrade, the user name will remain rhevm-admin.
23.3.4. Logging in to Access the Reports Portal
superuser and admin accounts when you installed Red Hat Enterprise Virtualization Reports. Red Hat Enterprise Virtualization Reports does not provide default passwords.
https://YOUR.MANAGER.URL/ovirt-engine-reports/login.html. A login screen for Red Hat Enterprise Virtualization Reports is displayed.
Note
ovirt-user. Click the button.
admin and superuser. Generally, additional users need to be created within the Reports Portal.
23.3.5. Accessing the Red Hat Enterprise Virtualization Reports User Management Menu
admin.
- In to Red Hat Enterprise Virtualization reports portal, hover over the Manage button on the top menu bar.
- Click on Users in the drop-down menu that appears to access the Manage Users interface. It contains three panes:
- Organizations
- Users
- Properties
- Select a user in the Users pane by clicking on the name of the user. Information about the user displays in the Properties pane.
- Click the button at the bottom of the user's Properties pane.The Properties pane contains these fields:
- User name,
- User ID,
- Email,
- Password (required),
- Confirm Password (required),
- A User is enabled check box,
- A The user is defined externally check box,
- A list of Roles Available to the user, and
- A list of Roles Assigned to the user.
- Click the button.
23.3.6. Reports Portal User Roles
- ROLE_ADMINISTRATOR - Can create/edit/delete reports, dashboards, ad hoc reports, and manage the server.
- ROLE_USER - Can create/edit/delete ad hoc reports and view reports and dashboards.
- ROLE_ANONYMOUS - Can log in and look at reports and dashboards.
23.3.7. Navigating Reports and Dashboards
) button in the navigation bar at the top of the reports portal to return to this page.
Table 23.24. Navigation Filters
| Filter | Description |
|---|---|
Available Resources | Select from All, Modified by me, or Viewed by me. |
Resource type | Choose from the types of available resources including Reports, Ad Hoc views, Dashboards, and more. |
Timeframe | Choose a time frame you'd like to see information from. |
Schedule | Filter by data collection schedule. |
23.3.8. Report Parameters
Note
23.3.9. Right-click Reporting Integration with the Red Hat Enterprise Virtualization Administration Portal
23.3.10. Executive Reports
23.3.10.1. Executive reports: Active Virtual Machines by OS
Active Virtual Machines by OS report shows a summary of the number of active virtual machines in a given time period, broken down by operating system. The following parameters are provided to run this report:
Table 23.25. Active Virtual Machines by OS Parameters
| Parameter | Description |
|---|---|
Show Deleted Entities? | The report includes deleted objects, such as data centers, clusters, and hosts removed from the environment. |
Period Range | The report is for the period range selected. Daily reports cover a single day. Monthly reports cover a single month. Quarterly reports cover a three-month quarter, beginning on the month specified in the Dates parameter. Yearly reports cover a year, beginning on the month specified in the Dates parameter. |
Dates | The report covers the selected period range, beginning on this date. Daily period ranges pass in one day increments. For a Monthly period range, the selected month is used. For a Quarterly period range, the quarter is determined as beginning on the selected month. A yearly period range also starts on the selected month. |
Data Center | The report includes only virtual machines in the selected data center. The options list shows only data centers that contain virtual machines. |
Cluster | The report only includes virtual machines in the selected cluster. The options list shows only clusters in the selected data center. If All is selected, the report includes all virtual machines in the selected data center. |
Virtual Machine Type | The report only includes virtual machines of the selected type. Possible types are Server and Desktop. The options list shows only types that exist in the selected data center and cluster. If All is selected, the report includes all virtual machine types. |
23.3.10.2. Executive Reports: Cluster Capacity Vs Usage
Cluster Capacity Vs Usage report shows the relationship between system capacity and usage (workload) over a given time period. Capacity is expressed in terms of CPU cores and physical memory, while usage is expressed as vCPUs and virtual machine memory. The following parameters must be provided to run this report:
Table 23.26. Cluster Capacity Vs Usage Parameters
| Parameter | Description |
|---|---|
Show Deleted Entities? | The report includes deleted objects, such as data centers, clusters, and hosts removed from the environment. |
Period Range | The report is for the period range selected. Daily reports cover a single day. Monthly reports cover a single month. Quarterly reports cover a three-month quarter, beginning on the month specified in the Dates parameter. Yearly reports cover a year, beginning on the month specified in the Dates parameter. |
Dates | The report covers the selected period range, beginning on this date. Daily period ranges pass in one day increments. For a Monthly period range, the selected month is used. For a Quarterly period range, the quarter is determined as beginning on the selected month. A yearly period range also starts on the selected month. |
Data Center | The list of options for the Cluster parameter includes only clusters in the selected data center. The options list contains only data centers that contain clusters. |
Cluster | The report only includes the selected cluster. The options list shows only clusters in the selected data center. If All is selected, the report includes all clusters in the selected data center. |
23.3.10.3. Executive Reports: Host Operating System Break Down
Host OS Break Down report indicates the number of hosts running each operating system version over a given time period. The following parameters must be provided to run this report:
Table 23.27. Host OS Break Down Parameters
| Parameter | Description |
|---|---|
Show Deleted Entities? | The report includes deleted objects, such as data centers, clusters, and hosts removed from the environment. |
Period Range | The report is for the period range selected. Daily reports cover a single day. Monthly reports cover a single month. Quarterly reports cover a three-month quarter, beginning on the month specified in the Dates parameter. Yearly reports cover a year, beginning on the month specified in the Dates parameter. |
Dates | The report covers the selected period range, beginning on this date. Daily period ranges pass in one day increments. For a Monthly period range, the selected month is used. For a Quarterly period range, the quarter is determined as beginning on the selected month. A yearly period range also starts on the selected month. |
Data Center | The list of options for the Cluster parameter includes only clusters in the selected data center. The options list shows only data centers that contain clusters. |
Cluster | The report includes only hosts in the selected cluster. The options list shows only clusters in the selected data center. If All is selected, the report includes all hosts in the selected data center. |
23.3.10.4. Executive Reports: Summary of Host Usage Resources
Summary of Host Usage Resources report shows a scatter plot of average host resource utilization for a given time period in terms of CPU and memory usage. The following parameters must be provided to run this report:
Table 23.28. Summary of Host Usage Resources Parameters
| Parameter | Description |
|---|---|
Show Deleted Entities? | The report includes deleted objects, such as data centers, clusters, and hosts removed from the environment. |
Period Range | The report is for the period range selected. Daily reports cover a single day. Monthly reports cover a single month. Quarterly reports cover a three-month quarter, beginning on the month specified in the Dates parameter. Yearly reports cover a year, beginning on the month specified in the Dates parameter. |
Dates | The report covers the selected period range, beginning on this date. Daily period ranges pass in one day increments. For a Monthly period range, the selected month is used. For a Quarterly period range, the quarter is determined as beginning on the selected month. A yearly period range also starts on the selected month. |
Data Center | The list of options for the Cluster parameter includes only clusters in the selected data center. The options list shows only data centers that contain clusters. |
Cluster | The report includes only hosts in the selected cluster. The options list shows only clusters in the selected data center. If All is selected, the report includes all hosts in the selected data center. |
23.3.11. Inventory Reports
23.3.11.1. Inventory Reports: Hosts Inventory
Hosts Inventory report shows a list of all hosts in the selected data center and cluster. The following parameters must be provided to run this report:
Table 23.29. Hosts Inventory Parameters
| Parameter | Description |
|---|---|
Show Deleted Entities? | The report includes deleted objects, such as data centers, clusters, and hosts removed from the environment. |
Data Center | The list of options for the Cluster parameter includes only clusters in the selected data center. The options list shows only data centers that contain clusters. |
Cluster | The report includes only hosts in the selected cluster. The options list shows only clusters in the selected data center. If All is selected, the report includes all hosts in the selected data center. |
Host Type | The report includes only hosts of the selected type. The options list shows only host types present in the selected data center and cluster. If All is selected, the report includes all host types. |
23.3.11.2. Inventory Reports: Storage Domain Over Time
Storage Domain Size Over Time report shows a line graph contrasting the total available and total used space for a single storage domain over time for a given period. The following parameters must be provided to run this report:
Table 23.30. Storage Domain Size Over Time Parameters
| Parameter | Description |
|---|---|
Show Deleted Entities? | The report includes deleted objects, such as data centers, clusters, and hosts removed from the environment. |
Period Range | The report is for the period range selected. Monthly reports cover a single month. Quarterly reports cover a three-month quarter, beginning on the month specified in the Dates parameter. |
Dates | The report covers the selected period range, beginning on this date. For a Monthly period range, the selected month is used. For a Quarterly period range, the quarter is determined as beginning on the selected month. The list of options for the Storage Domain name parameter includes only storage domains that were attached during the specified period. |
Data Center | The options list for the Storage Domain Name parameter shows only storage domains in this selected data center. |
Storage Domain Type | The options list for the Storage Domain Name parameter shows only storage domains of this selected type. |
Storage Domain Name | The report refers to the storage domain selected. A report is only for a single storage domain and the user must select a storage domain. The list of options shows only storage domains that were attached to the data center during the selected period. |
23.3.11.3. Inventory Reports: Virtual Machines Inventory
Virtual Machines Inventory report shows a list of all virtual machines in the selected data center and cluster. The following parameters must be provided to run this report:
Table 23.31. Virtual Machines Inventory Parameters
| Parameter | Description |
|---|---|
Show Deleted Entities? | The report includes deleted objects, such as data centers, clusters, and hosts removed from the environment. |
Data Center | The list of options for the Cluster parameter includes only clusters in the selected data center. The options list shows only data centers that contain clusters. |
Cluster | The report includes only virtual machines in the selected cluster. The options list shows only clusters in the selected data center. If All is selected, the report includes all virtual machines in the selected data center. |
Virtual Machine Type | The report includes only virtual machines of the selected type. The options list shows only virtual machine types present in the selected data center and cluster. If All is selected, the report includes all virtual machine types. |
23.3.11.4. Inventory Reports: Cloud Provider Virtual Machine Inventory
Table 23.32. Cloud Provider Virtual Machine Inventory Parameters
| Parameter | Description |
|---|---|
Show Deleted Entities? | The report includes deleted objects, such as data centers, clusters, and hosts removed from the environment. |
Period Range | The report is for the period range selected. Daily reports cover a single day. Monthly reports cover a single month. Quarterly reports cover a three-month quarter, beginning on the month specified in the Dates parameter. Yearly reports cover a year, beginning on the month specified in the Dates parameter. |
Dates | The report covers the selected period range, beginning on this date. Daily period ranges pass in one day increments. For a Monthly period range, the selected month is used. For a Quarterly period range, the quarter is determined as beginning on the selected month. A yearly period range also starts on the selected month. |
Data Center | The list of options for the Cluster parameter includes only clusters in the selected data center. The options list shows only data centers that contain clusters. |
Cluster | The report includes only virtual machines in the selected cluster. The options list shows only clusters in the selected data center. If All is selected, the report includes all virtual machines in the selected data center. |
Virtual Machine Type | The report includes only virtual machines of the selected type. The options list shows only virtual machine types present in the selected data center and cluster. If All is selected, the report includes all virtual machine types. |
23.3.11.5. Inventory Reports: Storage Domains
Storage Domains Inventory report shows a list of storage domains in the selected data center and of the selected type. The following parameters must be provided to run this report:
Table 23.33. Storage Domain Inventory Parameters
| Parameter | Description |
|---|---|
Show DeletedDetached Entities? | The report includes deleted objects, such as data centers, clusters, and hosts removed from the environment. |
Data Center | The options list for the Storage Domain Name parameter shows only storage domains in this selected data center. |
Storage Domain Type | The options list for the Storage Domain Name parameter shows only storage domains of this selected type. |
23.3.12. Service Level Reports
23.3.12.1. Service Level Reports: Cluster Host Uptime
Cluster Host Uptime report shows the weighted average uptime of hosts within a cluster for a given period of time. This report also provides a table listing the total planned (maintenance) and unplanned down time for each host. The following parameters must be provided to run this report:
Table 23.34. Cluster Host Uptime Parameters
| Parameter | Description |
|---|---|
Show Deleted Entities? | The report includes deleted objects, such as data centers, clusters, and hosts removed from the environment. |
Period Range | The report is for the period range selected. Daily reports cover a single day. Monthly reports cover a single month. Quarterly reports cover a three-month quarter, beginning on the month specified in the Dates parameter. Yearly reports cover a year, beginning on the month specified in the Dates parameter. |
Dates | The report covers the selected period range, beginning on this date. Daily period ranges pass in one day increments. For a Monthly period range, the selected month is used. For a Quarterly period range, the quarter is determined as beginning on the selected month. A yearly period range also starts on the selected month. |
Data Center | The list of options for the Cluster parameter includes only clusters in the selected data center. The options list shows only data centers that contain clusters. |
Cluster | The report includes only hosts in the selected cluster. The options list shows only clusters in the selected data center. If All is selected, the report includes all hosts in the selected data center. |
Host Type | The report includes only hosts of the selected type. The options list shows only host types present in the selected data center and cluster. If All is selected, the report includes all host types. |
23.3.12.2. Service Level Reports: Cluster Quality of Service - Hosts
Cluster Quality of Services - Hosts report shows the amount of time hosts sustain load above a specified threshold for a given time period. Load is defined in terms of CPU usage percent and memory usage percent. The following parameters must be provided to run this report:
Table 23.35. Cluster Quality of Service - Hosts Parameters
| Parameter | Description |
|---|---|
Show Deleted Entities? | The report includes deleted objects, such as data centers, clusters, and hosts removed from the environment. |
Period Range | The report is for the period range selected. Daily reports cover a single day. Monthly reports cover a single month. Quarterly reports cover a three-month quarter, beginning on the month specified in the Dates parameter. Yearly reports cover a year, beginning on the month specified in the Dates parameter. |
Dates | The report covers the selected period range, beginning on this date. Daily period ranges pass in one day increments. For a Monthly period range, the selected month is used. For a Quarterly period range, the quarter is determined as beginning on the selected month. A yearly period range also starts on the selected month. |
Data Center | The list of options for the Cluster parameter includes only clusters in the selected data center. The options list shows only data centers that contain clusters. |
Cluster | The report includes only hosts in the selected cluster. The options list shows only clusters in the selected data center. If All is selected, the report includes all hosts in the selected data center. |
Host Type | The report includes only hosts of the selected type. The options list shows only host types present in the selected data center and cluster. If All is selected, the report includes all host types. |
CPU Threshold | The report measures the quality of service as the amount of time hosts sustain load above a given threshold. The CPU Threshold defines a load threshold as a percentage of total CPU usage on the host. The load is measured by one-minute samples, averaged over an hour. The report therefore shows sustained load, not short term peaks. A CPU Threshold of 60 per cent is a suggested starting point to produce a meaningful quality of service report. |
Memory Threshold | The report measures the quality of service as the amount of time hosts sustain load above a given threshold. The Memory Threshold defines a load threshold as a percentage of total memory usage on the host. The load is measured by one-minute samples, averaged over an hour. The report therefore shows sustained load, not short term peaks. A Memory Threshold of 60 per cent is a suggested starting point to produce a meaningful quality of service report. |
23.3.12.3. Service Level Reports: Cluster Quality of Service - Virtual Machines
Cluster Quality of Service - Virtual Machines report shows the amount of time virtual machines sustain load above a specified threshold for a given time period. Load is defined in terms of CPU usage percent and memory usage percent. The following parameters must be provided to run this report:
Table 23.36. Cluster Quality of Service - Virtual Machines Parameters
| Parameter | Description |
|---|---|
Show Deleted Entities? | The report includes deleted objects, such as data centers, clusters, and hosts removed from the environment. |
Period Range | The report is for the period range selected. Daily reports cover a single day. Monthly reports cover a single month. Quarterly reports cover a three-month quarter, beginning on the month specified in the Dates parameter. Yearly reports cover a year, beginning on the month specified in the Dates parameter. |
Dates | The report covers the selected period range, beginning on this date. Daily period ranges pass in one day increments. For a Monthly period range, the selected month is used. For a Quarterly period range, the quarter is determined as beginning on the selected month. A yearly period range also starts on the selected month. |
Data Center | The list of options for the Cluster parameter includes only clusters in the selected data center. The options list shows only data centers that contain clusters. |
Cluster | The report includes only virtual machines in the selected cluster. The options list shows only clusters in the selected data center. If All is selected, the report includes all virtual machines in the selected data center. |
Virtual Machine Type | The report includes only virtual machines of the selected type. The options list shows only virtual machine types present in the selected data center and cluster. If All is selected, the report includes all virtual machine types. |
CPU Threshold | The report measures quality of service as the amount of time virtual machines sustain load above a given threshold. The CPU Threshold defines a load threshold as a percentage of total CPU usage on the virtual machine. The load is measured by one-minute samples, averaged over an hour. The report therefore shows sustained load, not short term peaks. A CPU Threshold of 60 per cent is a suggested starting point to produce a meaningful quality of service report. |
Memory Threshold | The reports measures quality of service as the amount of time virtual machines sustain load above a given threshold. The Memory Threshold defines a load threshold as a percentage of total memory usage on the virtual machine. The load is measured by one-minute samples, averaged over an hour. The report therefore shows sustained load, not short term peaks. A Memory Threshold of 60 per cent is a suggested starting point to produce a meaningful quality of service report. |
23.3.12.4. Service Level Reports: Single Host Uptime
Single Host Uptime report shows the total proportion of uptime, planned downtime and unplanned downtime for a single host. The following parameters must be provided to run this report:
Table 23.37. Single Host Uptime Parameters
| Parameter | Description |
|---|---|
Show Deleted Entities? | The report includes deleted objects, such as data centers, clusters, and hosts removed from the environment. |
Period Range | The report is for the period range selected. Daily reports cover a single day. Monthly reports cover a single month. Quarterly reports cover a three-month quarter, beginning on the month specified in the Dates parameter. Yearly reports cover a year, beginning on the month specified in the Dates parameter. |
Dates | The report covers the selected period range, beginning on this date. Daily period ranges pass in one day increments. For a Monthly period range, the selected month is used. For a Quarterly period range, the quarter is determined as beginning on the selected month. A yearly period range also starts on the selected month. |
Data Center | The list of options for the Cluster parameter includes only clusters in the selected data center. The options list shows only data centers that contain clusters. |
Cluster | The list of options for the Host Name parameter includes only hosts in the selected cluster. The options list shows only clusters in the selected data center. If All is selected, the list of options for the Host Name parameter includes all hosts in the selected data center. |
Host Type | The list of options for the Host Name parameter includes only hosts of the selected type. The options list shows only host types present in the selected data center and cluster. If All is selected, the list of options for the Host Name parameter includes all host types. |
Host Name | The report refers to the host selected. A report is only for a single host and a user must select a host. |
23.3.12.5. Service Level Reports: Top 10 Downtime Hosts
Top 10 Downtime Hosts report shows the total proportion of uptime, planned downtime and unplanned downtime for the 10 hosts with the greatest amount of downtime. The following parameters must be provided to run this report:
Table 23.38. Top 10 Downtime Hosts Parameters
Parameter | Description |
|---|---|
Show Deleted Entities? | The report includes deleted objects, such as data centers, clusters, and hosts removed from the environment. |
Period Range | The report is for the period range selected. Daily reports cover a single day. Monthly reports cover a single month. Quarterly reports cover a three-month quarter, beginning on the month specified in the Dates parameter. Yearly reports cover a year, beginning on the month specified in the Dates parameter. |
Dates | The report covers the selected period range, beginning on this date. Daily period ranges pass in one day increments. For a Monthly period range, the selected month is used. For a Quarterly period range, the quarter is determined as beginning on the selected month. A yearly period range also starts on the selected month. |
Data Center | The list of options for the Cluster parameter includes only clusters in the selected data center. The options list contains only data centers that contain clusters. |
Cluster | The report includes only hosts in the selected cluster. The options list shows only clusters in the selected data center. If All is selected, the report includes all hosts in the selected data center. |
Host Type | The report includes only hosts of the selected type. The options list shows only host types present in the selected data center and cluster. If All is selected, the report includes all host types. |
23.3.12.6. Service Level Reports: High Availability Virtual Servers Uptime
High Availability Virtual Servers Uptime report shows the weighted average uptime of high availability virtual servers within a cluster for a given period of time. The report also provides a table listing the total uptime and unplanned down time for each virtual server. The following parameters must be provided to run this report:
Table 23.39. High Availability Virtual Servers Uptime Parameters
| Parameter | Description |
|---|---|
Show Deleted Entities? | The report includes deleted objects, such as data centers, clusters, and hosts removed from the environment. |
Period Range | The report is for the period range selected. Daily reports cover a single day. Monthly reports cover a single month. Quarterly reports cover a three-month quarter, beginning on the month specified in the Dates parameter. Yearly reports cover a year, beginning on the month specified in the Dates parameter. |
Dates | The report covers the selected period range, beginning on this date. Daily period ranges pass in one day increments. For a Monthly period range, the selected month is used. For a Quarterly period range, the quarter is determined as beginning on the selected month. A yearly period range also starts on the selected month. |
Data Center | The list of options for the Cluster parameter includes only clusters in the selected data center. The options list shows only data centers that contain clusters. |
Cluster | The report includes only virtual servers in the selected cluster. The options list shows only clusters in the selected data center. If All is selected, the report includes all virtual servers in the selected data center. |
23.3.13. Trend Reports
23.3.13.1. Trend Reports: Five Least Utilized Hosts (Over Time)
Five Least Utilized Hosts (Over Time) report shows the weighted average daily peak load, in terms of CPU and memory usage, for the five hosts with the lowest load factor for a given period of time. The following parameters must be provided to run this report:
Table 23.40. Five Least Utilized Hosts (Over Time) Parameters
| Parameter | Description |
|---|---|
Show Deleted Entities? | The report includes deleted objects, such as data centers, clusters, and hosts removed from the environment. |
Period Range | The report is for the period range selected. Daily reports cover a single day. Monthly reports cover a single month. Quarterly reports cover a three-month quarter, beginning on the month specified in the Dates parameter. Yearly reports cover a year, beginning on the month specified in the Dates parameter. |
Dates | The report covers the selected period range, beginning on this date. Daily period ranges pass in one day increments. For a Monthly period range, the selected month is used. For a Quarterly period range, the quarter is determined as beginning on the selected month. A yearly period range also starts on the selected month. |
Data Center | The list of options for the Cluster parameter includes only clusters in the selected data center. The options list shows only data centers that contain clusters. |
Cluster | The report includes only hosts in the selected cluster. The options list shows only clusters in the selected data center. If All is selected, the report includes all hosts in the selected data center. |
Host Type | The report includes only hosts of the selected type. The options list shows only host types present in the selected data center and cluster. If All is selected, the report includes all host types. |
23.3.13.2. Trend Reports: Five Least Utilized Virtual Machines (Over Time)
Five Least Utilized Virtual Machines (Over Time) report shows the weighted average daily peak load, in terms of CPU and memory usage, for the five virtual machines with the lowest load factor for a given period of time. The following parameters must be provided to run this report:
Table 23.41. Five Least Utilized Virtual Machines (Over Time) Parameters
| Parameter | Description |
|---|---|
Show Deleted Entities? | The report includes deleted objects, such as data centers, clusters, and hosts removed from the environment. |
Period Range | The report is for the period range selected. Daily reports cover a single day. Monthly reports cover a single month. Quarterly reports cover a three-month quarter, beginning on the month specified in the Dates parameter. Yearly reports cover a year, beginning on the month specified in the Dates parameter. |
Dates | The report covers the selected period range, beginning on this date. Daily period ranges pass in one day increments. For a Monthly period range, the selected month is used. For a Quarterly period range, the quarter is determined as beginning on the selected month. A yearly period range also starts on the selected month. |
Data Center | The list of options for the Cluster parameter includes only clusters in the selected data center. The options list shows only data centers that contain clusters. |
Cluster | The report includes only virtual machines in the selected cluster. The options list shows only clusters in the selected data center. If All is selected, the report includes all virtual machines in the selected data center. |
Virtual Machine Type | The report includes only virtual machines of the selected type. The options list shows only virtual machine types present in the selected data center and cluster. If All is selected, the report includes all virtual machine types. |
23.3.13.3. Trend Reports: Five Most Utilized Hosts (Over Time)
Five Most Utilized Hosts (Over Time) report shows the weighted average daily peak load, in terms of CPU and memory usage, for the five hosts with the highest load factor for a given period of time. The following parameters must be provided to run this report:
Table 23.42. Five Most Utilized Hosts (Over Time) Parameters
| Parameter | Description |
|---|---|
Show Deleted Entities? | The report includes deleted objects, such as data centers, clusters, and hosts removed from the environment. |
Period Range | The report is for the period range selected. Daily reports cover a single day. Monthly reports cover a single month. Quarterly reports cover a three-month quarter, beginning on the month specified in the Dates parameter. Yearly reports cover a year, beginning on the month specified in the Dates parameter. |
Dates | The report covers the selected period range, beginning on this date. Daily period ranges pass in one day increments. For a Monthly period range, the selected month is used. For a Quarterly period range, the quarter is determined as beginning on the selected month. A yearly period range also starts on the selected month. |
Data Center | The list of options for the Cluster parameter includes only clusters in the selected data center. The options list shows only data centers that contain clusters. |
Cluster | The report includes only hosts in the selected cluster. The options list shows only clusters in the selected data center. If All is selected, the report includes all hosts in the selected data center. |
Host Type | The report includes only hosts of the selected type. The options list shows only host types present in the selected data center and cluster. If All is selected, the report includes all host types. |
23.3.13.4. Trend Reports: Five Most Utilized Virtual Machines (Over Time)
Five Most Utilized Virtual Machines (Over Time) report shows the weighted average daily peak load, in terms of CPU and memory usage, for the five virtual machines with the highest load factor for a given period of time. The following parameters must be provided to run this report:
Table 23.43. Five Most Utilized Virtual Machines (Over Time) Parameters
| Parameter | Description |
|---|---|
Show Deleted Entities? | The report includes deleted objects, such as data centers, clusters, and hosts removed from the environment. |
Period Range | The report is for the period range selected. Daily reports cover a single day. Monthly reports cover a single month. Quarterly reports cover a three-month quarter, beginning on the month specified in the Dates parameter. Yearly reports cover a year, beginning on the month specified in the Dates parameter. |
Dates | The report covers the selected period range, beginning on this date. Daily period ranges pass in one day increments. For a Monthly period range, the selected month is used. For a Quarterly period range, the quarter is determined as beginning on the selected month. A yearly period range also starts on the selected month. |
Data Center | The list of options for the Cluster parameter includes only clusters in the selected data center. The options list shows only data centers which contain clusters. |
Cluster | The report includes only virtual machines in the selected cluster. The options list shows only clusters in the selected data center. If All is selected, the report includes all virtual machines in the selected data center. |
Virtual Machine Type | The report includes only virtual machines of the selected type. The options list shows only virtual machine types present in the selected data center and cluster. If All is selected, the report includes all virtual machine types. |
23.3.13.5. Trend Reports: Multiple Hosts Resource Usage (Over Time)
Multiple Hosts Resource Usage (Over Time) report shows the daily peak load, in terms of CPU and memory usage, for up to five selected hosts over a given period of time. The following parameters must be provided to run this report:
Table 23.44. Multiple Hosts Resource Usage (Over Time) Parameters
| Parameter | Description |
|---|---|
Show Deleted Entities? | The report includes deleted objects, such as data centers, clusters, and hosts removed from the environment. |
Period Range | The report is for the period range selected. Daily reports cover a single day. Monthly reports cover a single month. Quarterly reports cover a three-month quarter, beginning on the month specified in the Dates parameter. Yearly reports cover a year, beginning on the month specified in the Dates parameter. |
Dates | The report covers the selected period range, beginning on this date. Daily period ranges pass in one day increments. For a Monthly period range, the selected month is used. For a Quarterly period range, the quarter is determined as beginning on the selected month. A yearly period range also starts on the selected month. |
Data Center | The list of options for the Cluster parameter includes only clusters in the selected data center. The options list shows only data centers that contain clusters. |
Cluster | The list of options for the Hosts list parameter includes only hosts in the selected cluster. The options list shows only clusters in the selected data center. If All is selected, the list of options for the Hosts list parameter includes all hosts in the selected data center. |
Host Type | The list of options for the Hosts list parameter includes only hosts of the selected type. The options list shows only host types present in the selected data center and cluster. If All is selected, the list of options for the Hosts list parameter includes all host types. |
Hosts list | The report includes all hosts selected in the host list. Select any number of hosts up to a maximum of five. |
23.3.13.6. Trend Reports: Multiple Virtual Machines Resource Usage (Over Time)
Multiple Virtual Machines Resource Usage (Over Time) report shows the daily peak load, in terms of CPU and memory usage, for up to five selected virtual machines over a given period of time. The following parameters must be provided to run this report:
Table 23.45. Multiple Virtual Machines Resource Usage (Over Time) Parameters
| Parameter | Description |
|---|---|
Show Deleted Entities? | The report includes deleted objects, such as data centers, clusters, and hosts removed from the environment. |
Period Range | The report is for the period range selected. Daily reports cover a single day. Monthly reports cover a single month. Quarterly reports cover a three-month quarter, beginning on the month specified in the Dates parameter. Yearly reports cover a year, beginning on the month specified in the Dates parameter. |
Dates | The report covers the selected period range, beginning on this date. Daily period ranges pass in one day increments. For a Monthly period range, the selected month is used. For a Quarterly period range, the quarter is determined as beginning on the selected month. A yearly period range also starts on the selected month. |
Data Center | The list of options for the Cluster parameter includes only clusters in the selected data center. The options list shows only data centers that contain clusters. |
Cluster | The list of options for the VM List parameter include only virtual machines in the selected cluster. The options list shows only clusters in the selected data center. If All is selected, the list of options for the VM List parameter includes all virtual machines in the selected data center. |
Virtual Machine Type | The list of options for the VM List parameter includes only virtual machines of the selected type. The options list shows only virtual machine types present in the selected data center and cluster. If All is selected, the list of options for the VM List parameter includes all virtual machine types. |
Virtual Machine List | The report includes all virtual machines selected in the virtual machine list. Select any number of virtual machines up to a maximum of five. |
23.3.13.7. Trend Reports: Single Host Resource Usage (Days of Week)
Single Host Resource Usage (Days of Week) report shows various resource utilization metrics for a single host over a given period of time and broken down by day of the week. The metrics include CPU usage, memory usage, number of active virtual machines and network usage. The following parameters must be provided to run this report:
Table 23.46. Single Host Resource Usage (Days of Week) Parameters
| Parameter | Description |
|---|---|
Show Deleted Entities? | The report includes deleted objects, such as data centers, clusters, and hosts removed from the environment. |
Period Range | The report is for the period range selected. Daily reports cover a single day. Monthly reports cover a single month. Quarterly reports cover a three-month quarter, beginning on the month specified in the Dates parameter. Yearly reports cover a year, beginning on the month specified in the Dates parameter. |
Dates | The report covers the selected period range, beginning on this date. Daily period ranges pass in one day increments. For a Monthly period range, the selected month is used. For a Quarterly period range, the quarter is determined as beginning on the selected month. A yearly period range also starts on the selected month. |
Data Center | The list of options for the Cluster parameter includes only clusters in the selected data center. The options list shows only data centers that contain clusters. |
Cluster | The list of options for the Host Name parameter includes only hosts in the selected cluster. The options list shows only clusters in the selected data center. If All is selected, the list of options for the Host Name parameter includes all hosts in the selected data center. |
Host Type | The list of options for the Host Name parameter includes only hosts of the selected type. The options list shows only host types present in the selected data center and cluster. If All is selected, the list of options for the Host Name parameter includes all host types. |
Host Name | The report refers to the host selected. A report is only for a single host and the user must select a host. |
23.3.13.8. Trend Reports: Single Host Resource Usage (Hour of Day)
Single Host Resource Usage (Hour of Day) report shows a variety of resource utilization metrics for a single host over a given period of time, broken down by hour of the day (0-23). The metrics include CPU usage, memory usage, number of active virtual machines and network usage. The following parameters must be provided to run this report:
Table 23.47. Single Host Resource Usage (Hour of Day) Parameters
| Parameter | Description |
|---|---|
Show Deleted Entities? | The report includes deleted objects, such as data centers, clusters, and hosts removed from the environment. |
Period Range | The report is for the period range selected. Daily reports cover a single day. Monthly reports cover a single month. Quarterly reports cover a three-month quarter, beginning on the month specified in the Dates parameter. Yearly reports cover a year, beginning on the month specified in the Dates parameter. |
Dates | The report covers the selected period range, beginning on this date. Daily period ranges pass in one day increments. For a Monthly period range, the selected month is used. For a Quarterly period range, the quarter is determined as beginning on the selected month. A yearly period range also starts on the selected month. |
Data Center | The list of options for the Cluster parameter includes only clusters in the selected data center. The options list shows only data centers that contain clusters. |
Cluster | The list of options for the Host Name parameter includes only hosts in the selected cluster. The options list shows only clusters in the selected data center. If All is selected, the list of options for the Host Name parameter includes all hosts in the selected data center. |
Host Type | Only hosts of the selected type will be included in the list of options for the Host Name parameter. The options list shows only host types present in the selected data center and cluster. If All is selected, the list of options for the Host Name parameter includes all host types. |
Host Name | The report refers to the host selected. A report is only for a single host and the user must select a host. |
23.3.13.9. Trend Reports: Single Virtual Machine Resources (Days of Week)
Single Virtual Machine Resources (Days of Week) report shows a variety of resource utilization metrics for a single virtual machine over a given period of time, broken down by day of the week. The metrics include CPU usage, memory usage, disk usage and network usage. The following parameters must be provided to run this report:
Table 23.48. Single Virtual Machine Resources (Days of Week) Parameters
| Parameter | Description |
|---|---|
Show Deleted Entities? | The report includes deleted objects, such as data centers, clusters, and hosts removed from the environment. |
Period Range | The report is for the period range selected. Daily reports cover a single day. Monthly reports cover a single month. Quarterly reports cover a three-month quarter, beginning on the month specified in the Dates parameter. Yearly reports cover a year, beginning on the month specified in the Dates parameter. |
Dates | The report covers the selected period range, beginning on this date. Daily period ranges pass in one day increments. For a Monthly period range, the selected month is used. For a Quarterly period range, the quarter is determined as beginning on the selected month. A yearly period range also starts on the selected month. |
Data Center | The list of options for the Cluster parameter includes only clusters in the selected data center. The options list shows only data centers that contain clusters. |
Cluster | The list of options for the VM Name parameter includes only virtual machines in the selected cluster. The options list shows only clusters in the selected data center. If All is selected, the list of options for the VM Name parameter includes all virtual machines in the selected data center. |
Virtual Machine Type | The list of options for the VM Name parameter includes only virtual machines of the selected type. The options list shows only virtual machine types present in the selected data center and cluster. If All is selected, the list of options for the VM Name parameter includes all virtual machine types. |
Virtual Machine Name | The report refers to the virtual machine selected. A report is only for a single virtual machine and the user must select a virtual machine. |
23.3.13.10. Trend Reports: Single Virtual Machine Resources (Hour of Day)
Single Virtual Machine Resources (Hour of Day) report shows a variety of resource utilization metrics for a single virtual machine over a given period of time, broken down by hour of the day (0-23). The metrics include CPU usage, memory usage, disk usage and network usage. The following parameters must be provided to run this report:
Table 23.49. Single Virtual Machine Resources (Hour of Day) Parameters
| Parameter | Description |
|---|---|
Show Deleted Entities? | The report includes deleted objects, such as data centers, clusters, and hosts removed from the environment. |
Period Range | The report is for the period range selected. Daily reports cover a single day. Monthly reports cover a single month. Quarterly reports cover a three-month quarter, beginning on the month specified in the Dates parameter. Yearly reports cover a year, beginning on the month specified in the Dates parameter. |
Dates | The report covers the selected period range, beginning on this date. Daily period ranges pass in one day increments. For a Monthly period range, the selected month is used. For a Quarterly period range, the quarter is determined as beginning on the selected month. A yearly period range also starts on the selected month. |
Data Center | The list of options for the Cluster parameter includes only clusters in the selected data center. The options list shows only data centers which contain clusters. |
Cluster | The list of options for the VM Name parameter includes only virtual machines in the selected cluster. The options list shows only clusters in the selected data center. If All is selected, the list of options for the VM Name parameter includes all virtual machines in the selected data center. |
Virtual Machine Type | The list of options for the VM Name parameter includes only virtual machines of the selected type. The options list shows only virtual machine types present in the selected data center and cluster. If All is selected, the list of options for the VM Name parameter includes all virtual machine types. |
Virtual Machine Name | The report refers to the virtual machine selected. A report is only for a single virtual machine and the user must select a virtual machine. |
23.3.13.11. Trend Reports: Single Virtual Machine Resources (Over Time)
Single Virtual Machine Resources (Over Time) report shows a variety of resource utilization metrics for a single virtual machine over a given period of time. The metrics include CPU usage, memory usage, disk usage and network usage. The following parameters must be provided to run this report:
Table 23.50. Single Virtual Machine Resources (Over Time) Parameters
| Parameter | Description |
|---|---|
Show Deleted Entities? | The report includes deleted objects, such as data centers, clusters, and hosts removed from the environment. |
Period Range | The report is for the period range selected. Daily reports cover a single day. Monthly reports cover a single month. Quarterly reports cover a three-month quarter, beginning on the month specified in the Dates parameter. Yearly reports cover a year, beginning on the month specified in the Dates parameter. |
Dates | The report covers the selected period range, beginning on this date. Daily period ranges pass in one day increments. For a Monthly period range, the selected month is used. For a Quarterly period range, the quarter is determined as beginning on the selected month. A yearly period range also starts on the selected month. |
Data Center | The list of options for the Cluster parameter includes only clusters in the selected data center. The options list shows only data centers that contain clusters. |
Cluster | The list of options for the VM Name parameter includes only virtual machines in the selected cluster. The options list shows only clusters in the selected data center. If All is selected, the list of options for the VM Name parameter includes all virtual machines in the selected data center. |
Virtual Machine Type | The list of options for the VM Name parameter lists only virtual machines of the selected type. The options list shows only virtual machine types present in the selected data center and cluster. If All is selected, the list of options for the VM Name parameter includes all virtual machine types. |
Virtual Machine Name | The report refers to the virtual machine selected. A report is only for a single virtual machine and the user must select a virtual machine. |
23.3.14. Ad Hoc Reports
Working with the Ad Hoc Editor section of the online help explains the ad hoc report interface in detail.
23.3.15. Reports Schema: Tag History and ENUM Views
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.
Table 23.51. Tag Relations History in the System
| Name | Type | Description |
|---|---|---|
| history_id | integer | The unique ID of this row in the table. |
| entity_id | UUID | Unique ID of the entity or tag in the system. |
| entity_type | smallint |
|
| parent_id | UUID | Unique ID of the entity or tag in the system. |
| attach_date | timestamp with time zone | The date the entity or tag was attached to the entity or tag. |
| detach_date | timestamp with time zone | The date the entity or tag was detached from the entity or tag. |
Table 23.52. v3_5_tag_details_view\v3_5_latest_tag_details_view
| Name | Type | Description |
|---|---|---|
| history_id | integer | The unique ID of this row in the table. |
| tag_id | UUID | Unique ID of the tag in the system. |
| tag_name | varchar(50) | Name of the tag, as displayed in the tag tree. |
| tag_description | varchar(4000) | Description of the tag, as displayed in the edit dialog. |
| tag_path | varchar(4000) | The path to the tag in the tree. |
| tag_level | smallint | The tag level in the tree. |
| create_date | timestamp with time zone | The date this tag was added to the system. |
| update_date | timestamp with time zone | The date this tag was changed in the system. |
| delete_date | timestamp with time zone | The date this tag was deleted from the system. |
Table 23.53. v3_5_enum_translator_view
| Name | Type | Description |
|---|---|---|
| enum_type | varchar(40) | The type of ENUM. |
| enum_key | smallint | The key of the ENUM. |
| value | varchar(40) | The value of the ENUM. |
23.4. Dashboards
23.4.1. Dashboards
Designer, in the Reports Portal. For more information on dashboards, consult the JasperReports documentation by clicking the in the top menu bar of the Reports Portal.
23.4.2. Inventory Dashboard
Inventory Dashboard provides an executive summary of the inventory of a data center over a given period of time. The dashboard includes average disk use, number of active virtual machines, and a breakdown of host operating systems. The following parameters can be modified for this dashboard:
Table 23.54. Inventory Dashboard Parameters
| Parameter | Description |
|---|---|
Show Deleted Entities? | The report includes deleted objects, such as data centers, clusters, and hosts removed from the environment. |
Period Range | The dashboard shows data for the period range selected. Monthly dashboards cover a single month. Quarterly dashboards cover a three-month quarter, beginning on the month specified in the Dates parameter. |
Dates | The dashboard covers the selected period range, beginning on this date. For a Monthly period range, the selected month is used. For a Quarterly period range, the quarter is determined as beginning on the selected month. |
Data Center | The report refers to the selected data center. The list of options shows only data centers containing either hosts, storage domains or virtual machines. The list of options for the Cluster parameter includes only clusters in the selected data center. |
23.4.3. Trends Dashboard
Trends Dashboard provides an executive summary of the trends in a data center over a given period of time. The dashboard includes graphs of CPU and memory usage over time for the most highly utilized hosts and virtual machines in the data center. The following parameters can be modified for this dashboard:
Table 23.55. Trends Dashboard Parameters
| Parameter | Description |
|---|---|
Show Deleted Entities? | The report includes deleted objects, such as data centers, clusters, and hosts removed from the environment. |
Period Range | The dashboard shows data for the period range selected. Monthly dashboards cover a single month. Quarterly dashboards cover a three-month quarter, beginning on the month specified in the Dates parameter. |
Dates | The dashboard covers the selected period range, beginning on this date. For a Monthly period range, the selected month is used. For a Quarterly period range, the quarter is determined as beginning on the selected month. |
Data Center | The report refers to the selected data center. The list of options shows only data centers containing either hosts, storage domains or virtual machines. The list of options for the Cluster parameter includes only clusters in the selected data center. |
23.4.4. Uptime Dashboard
Uptime Dashboard provides an executive summary of the service level and uptime for a data center over a given period of time. The dashboard includes details on total uptime for each cluster in the data center for the period. The following parameters can be modified for this dashboard:
Table 23.56. Uptime Dashboard Parameters
| Parameter | Description |
|---|---|
Show Deleted Entities? | The report includes deleted objects, such as data centers, clusters, and hosts removed from the environment. |
Period Range | The dashboard shows data for the period range selected. Monthly dashboards cover a single month. Quarterly dashboards cover a three-month quarter, beginning on the month specified in the Dates parameter. |
Dates | The dashboard covers the selected period range, beginning on this date. For a Monthly period range, the selected month is used. For a Quarterly period range, the quarter is determined as beginning on the selected month. |
Data Center | The report refers to the selected data center. The list of options shows only data centers containing either hosts, storage domains or virtual machines. The list of options for the Cluster parameter includes only clusters in the selected data center. |
23.4.5. Integrated Reporting Dashboard in the Red Hat Enterprise Virtualization Administration Portal
Datacenter Dashboard, Cluster Dashboard, and System Dashboard.
Appendix A. Firewalls
A.1. Red Hat Enterprise Virtualization Manager Firewall Requirements
engine-setup script can configure the firewall automatically, but this overwrites any pre-existing firewall configuration.
engine-setup command saves a list of the iptables rules required in the /usr/share/ovirt-engine/conf/iptables.example file.
80 and 443) listed here.
Table A.1. Red Hat Enterprise Virtualization Manager Firewall Requirements
| Port(s) | Protocol | Source | Destination | Purpose |
|---|---|---|---|---|
| - | ICMP |
Red Hat Enterprise Virtualization Hypervisor(s)
Red Hat Enterprise Linux host(s)
|
Red Hat Enterprise Virtualization Manager
| When registering to the Red Hat Enterprise Virtualization Manager, virtualization hosts send an ICMP ping request to the Manager to confirm that it is online. |
| 22 | TCP |
System(s) used for maintenance of the Manager including backend configuration, and software upgrades.
|
Red Hat Enterprise Virtualization Manager
|
Secure Shell (SSH) access.
Optional.
|
| 80, 443 | TCP |
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
|
Provides HTTP and HTTPS access to the Manager.
|
| 6100 | TCP |
Administration Portal clients
User Portal clients
|
Red Hat Enterprise Virtualization Manager
|
Provides websocket proxy access for web-based console clients (
noVNC and spice-html5) when the websocket proxy is running on the Manager. If the websocket proxy is running on a different host, however, this port is not used.
|
| 7410 | UDP |
Red Hat Enterprise Virtualization Hypervisor(s)
Red Hat Enterprise Linux host(s)
|
Red Hat Enterprise Virtualization Manager
| Must be open for the Manager to receive Kdump notifications. |
Important
NFSv4
- TCP port
2049for NFS.
NFSv3
- TCP and UDP port
2049for NFS. - TCP and UDP port
111(rpcbind/sunrpc). - TCP and UDP port specified with
MOUNTD_PORT="port" - TCP and UDP port specified with
STATD_PORT="port" - TCP port specified with
LOCKD_TCPPORT="port" - UDP port specified with
LOCKD_UDPPORT="port"
MOUNTD_PORT, STATD_PORT, LOCKD_TCPPORT, and LOCKD_UDPPORT ports are configured in the /etc/sysconfig/nfs file.
A.2. Virtualization Host Firewall Requirements
Table A.2. Virtualization Host Firewall Requirements
| Port(s) | Protocol | Source | Destination | Purpose |
|---|---|---|---|---|
| 22 | TCP |
Red Hat Enterprise Virtualization Manager
|
Red Hat Enterprise Virtualization Hypervisor(s)
Red Hat Enterprise Linux host(s)
|
Secure Shell (SSH) access.
Optional.
|
| 161 | UDP |
Red Hat Enterprise Virtualization Hypervisor(s)
Red Hat Enterprise Linux host(s)
|
Red Hat Enterprise Virtualization Manager
|
Simple network management protocol (SNMP). Only required if you want Simple Network Management Protocol traps sent from the hypervisor to one or more external SNMP managers.
Optional.
|
| 5900 - 6923 | TCP |
Administration Portal clients
User Portal clients
|
Red Hat Enterprise Virtualization Hypervisor(s)
Red Hat Enterprise Linux host(s)
|
Remote guest console access via VNC and SPICE. These ports must be open to facilitate client access to virtual machines.
|
| 5989 | TCP, UDP |
Common Information Model Object Manager (CIMOM)
|
Red Hat Enterprise Virtualization Hypervisor(s)
Red Hat Enterprise Linux host(s)
|
Used by Common Information Model Object Managers (CIMOM) to monitor virtual machines running on the hypervisor. Only required if you want to use a CIMOM to monitor the virtual machines in your virtualization environment.
Optional.
|
| 16514 | TCP |
Red Hat Enterprise Virtualization Hypervisor(s)
Red Hat Enterprise Linux host(s)
|
Red Hat Enterprise Virtualization Hypervisor(s)
Red Hat Enterprise Linux host(s)
|
Virtual machine migration using
libvirt.
|
| 49152 - 49216 | TCP |
Red Hat Enterprise Virtualization Hypervisor(s)
Red Hat Enterprise Linux host(s)
|
Red Hat Enterprise Virtualization Hypervisor(s)
Red Hat Enterprise Linux host(s)
|
Virtual machine migration and fencing using VDSM. These ports must be open facilitate both automated and manually initiated migration of virtual machines.
|
| 54321 | TCP |
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)
|
VDSM communications with the Manager and other virtualization hosts.
|
A.3. Directory Server Firewall Requirements
Table A.3. Host Firewall Requirements
| Port(s) | Protocol | Source | Destination | Purpose |
|---|---|---|---|---|
| 88, 464 | TCP, UDP |
Red Hat Enterprise Virtualization Manager
|
Directory server
| Kerberos authentication. |
| 389, 636 | TCP |
Red Hat Enterprise Virtualization Manager
|
Directory server
| Lightweight Directory Access Protocol (LDAP) and LDAP over SSL. |
A.4. Database Server Firewall Requirements
Table A.4. Host Firewall Requirements
| Port(s) | Protocol | Source | Destination | Purpose |
|---|---|---|---|---|
| 5432 | TCP, UDP |
Red Hat Enterprise Virtualization Manager
|
PostgreSQL database server
| Default port for PostgreSQL database connections. |
Appendix B. VDSM and Hooks
B.1. VDSM
B.2. VDSM Hooks
/usr/libexec/vdsm/hooks/nn_event-name/ on the host in alphanumeric order. By convention each hook script is assigned a two digit number, included at the front of the file name, to ensure that the order in which the scripts will be run in is clear. You are able to create hook scripts in any programming language, Python will however be used for the examples contained in this chapter.
Warning
B.3. Extending VDSM with Hooks
B.4. Supported VDSM Events
Table B.1. Supported VDSM Events
| Name | Description |
|---|---|
| before_vm_start | Before virtual machine starts. |
| after_vm_start | After virtual machine starts. |
| before_vm_cont | Before virtual machine continues. |
| after_vm_cont | After virtual machine continues. |
| before_vm_pause | Before virtual machine pauses. |
| after_vm_pause | After virtual machine pauses. |
| before_vm_hibernate | Before virtual machine hibernates. |
| after_vm_hibernate | After virtual machine hibernates. |
| before_vm_dehibernate | Before virtual machine dehibernates. |
| after_vm_dehibernate | After virtual machine dehibernates. |
| before_vm_migrate_source | Before virtual machine migration, run on the source hypervisor host from which the migration is occurring. |
| after_vm_migrate_source | After virtual machine migration, run on the source hypervisor host from which the migration is occurring. |
| before_vm_migrate_destination | Before virtual machine migration, run on the destination hypervisor host to which the migration is occurring. |
| after_vm_migrate_destination | After virtual machine migration, run on the destination hypervisor host to which the migration is occurring. |
| after_vm_destroy | After virtual machine destruction. |
| before_vdsm_start | Before VDSM is started on the hypervisor host. before_vdsm_start hooks are executed as the user root, and do not inherit the environment of the VDSM process. |
| after_vdsm_stop | After VDSM is stopped on the hypervisor host. after_vdsm_stop hooks are executed as the user root, and do not inherit the environment of the VDSM process. |
| before_nic_hotplug | Before the NIC is hot plugged into the virtual machine. |
| after_nic_hotplug | After the NIC is hot plugged into the virtual machine. |
| before_nic_hotunplug | Before the NIC is hot unplugged from the virtual machine |
| after_nic_hotunplug | After the NIC is hot unplugged from the virtual machine. |
| after_nic_hotplug_fail | After hot plugging the NIC to the virtual machine fails. |
| after_nic_hotunplug_fail | After hot unplugging the NIC from the virtual machine fails. |
| before_disk_hotplug | Before the disk is hot plugged into the virtual machine. |
| after_disk_hotplug | After the disk is hot plugged into the virtual machine. |
| before_disk_hotunplug | Before the disk is hot unplugged from the virtual machine |
| after_disk_hotunplug | After the disk is hot unplugged from the virtual machine. |
| after_disk_hotplug_fail | After hot plugging the disk to the virtual machine fails. |
| after_disk_hotunplug_fail | After hot unplugging the disk from the virtual machine fails. |
| before_device_create | Before creating a device that supports custom properties. |
| after_device_create | After creating a device that supports custom properties. |
| before_update_device | Before updating a device that supports custom properties. |
| after_update_device | After updating a device that supports custom properties. |
| before_device_destroy | Before destroying a device that supports custom properties. |
| after_device_destroy | After destroying a device that supports custom properties. |
| before_device_migrate_destination | Before device migration, run on the destination hypervisor host to which the migration is occurring. |
| after_device_migrate_destination | After device migration, run on the destination hypervisor host to which the migration is occurring. |
| before_device_migrate_source | Before device migration, run on the source hypervisor host from which the migration is occurring. |
| after_device_migrate_source | After device migration, run on the source hypervisor host from which the migration is occurring. |
B.5. The VDSM Hook Environment
vdsm user and inherit the environment of the VDSM process. The exceptions are hook scripts triggered by the before_vdsm_start and after_vdsm_stop events. Hook scripts triggered by these events run as the root user and do not inherit the environment of the VDSM process.
B.6. The VDSM Hook Domain XML Object
_hook_domxml variable is appended to the environment. This variable contains the path of the libvirt domain XML representation of the relevant virtual machine. Several hooks are an exception to this rule, as outlined below.
_hook_domxml variable of the following hooks contains the XML representation of the NIC and not the virtual machine.
*_nic_hotplug_**_nic_hotunplug_**_update_device*_device_create*_device_migrate_*
Important
before_migration_destination and before_dehibernation hooks currently receive the XML of the domain from the source host. The XML of the domain at the destination will have various differences.
vmId.
B.7. Defining Custom Properties
engine-config command. Run this command as the root user on the host where Red Hat Enterprise Virtualization Manager is installed.
UserDefinedVMProperties and CustomDeviceProperties configuration keys are used to store the names of the custom properties supported. Regular expressions defining the valid values for each named custom property are also contained in these configuration keys.
ovirt-engine service must be restarted for the new values to take effect.
Example B.1. Virtual Machine Properties - Defining the smartcard Custom Property
- Check the existing custom properties defined by the
UserDefinedVMPropertiesconfiguration key using the following command:# engine-config -g UserDefinedVMProperties
As shown by the output below, the custom propertymemoryis already defined. The regular expression^[0-9]+$ensures that the custom property will only ever contain numeric characters.# engine-config -g UserDefinedVMProperties UserDefinedVMProperties: version: 3.0 UserDefinedVMProperties: version: 3.1 UserDefinedVMProperties: version: 3.2 UserDefinedVMProperties: version: 3.3 UserDefinedVMProperties : memory=^[0-9]+$ version: 3.2
- Because the
memorycustom property is already defined in theUserDefinedVMPropertiesconfiguration key, the new custom property must be appended to it. The additional custom property,smartcard, is added to the configuration key's value. The new custom property is able to hold a value oftrueorfalse.# engine-config -s UserDefinedVMProperties='memory=^[0-9]+$;smartcard=^(true|false)$' --cver=3.2
- Verify that the custom properties defined by the
UserDefinedVMPropertiesconfiguration key have been updated correctly.# engine-config -g UserDefinedVMProperties UserDefinedVMProperties: version: 3.0 UserDefinedVMProperties: version: 3.1 UserDefinedVMProperties: version: 3.2 UserDefinedVMProperties: version: 3.3 UserDefinedVMProperties : memory=^[0-9]+$;smartcard=^(true|false)$ version: 3.2
- Finally, the
ovirt-engineservice must be restarted for the configuration change to take effect.# service ovirt-engine restart
Example B.2. Device Properties - Defining the interface Custom Property
- Check the existing custom properties defined by the
CustomDevicePropertiesconfiguration key using the following command:# engine-config -g CustomDeviceProperties
As shown by the output below, no custom properties have yet been defined.# engine-config -g CustomDeviceProperties CustomDeviceProperties: version: 3.0 CustomDeviceProperties: version: 3.1 CustomDeviceProperties: version: 3.2 CustomDeviceProperties: version: 3.3
- The
interfacecustom property does not already exist, so it can be appended as is. In this example, the value of thespeedsub-property is set to a range of 0 to 99999, and the value of theduplexsub-property is set to a selection of eitherfullorhalf.# engine-config -s CustomDeviceProperties="{type=interface;prop={speed=^([0-9]{1,5})$;duplex=^(full|half)$}}" --cver=3.3 - Verify that the custom properties defined by the
CustomDevicePropertiesconfiguration key have been updated correctly.# engine-config -g CustomDeviceProperties UserDefinedVMProperties: version: 3.0 UserDefinedVMProperties: version: 3.1 UserDefinedVMProperties: version: 3.2 UserDefinedVMProperties : {type=interface;prop={speed=^([0-9]{1,5})$;duplex=^(full|half)$}} version: 3.3 - Finally, the
ovirt-engineservice must be restarted for the configuration change to take effect.# service ovirt-engine restart
B.8. Setting Virtual Machine Custom Properties
B.9. Evaluating Virtual Machine Custom Properties in a VDSM Hook
Example B.3. Evaluating Custom Properties
key1. If the custom property is set then the value is printed to standard error. If the custom property is not set then no action is taken.
#!/usr/bin/python
import os
import sys
if os.environ.has_key('key1'):
sys.stderr.write('key1 value was : %s\n' % os.environ['key1'])
else:
sys.exit(0)
B.10. Using the VDSM Hooking Module
xml.dom library (http://docs.python.org/release/2.6/library/xml.dom.html) to manipulate the object.
Table B.2. Hooking module functions
| Name | Argument | Description |
|---|---|---|
tobool | string | Converts a string "true" or "false" to a Boolean value |
read_domxml | - | Reads the virtual machine's libvirt XML into a DOM object |
write_domxml | DOM object | Writes the virtual machine's libvirt XML from a DOM object |
B.11. VDSM Hook Execution
before_vm_start scripts can edit the domain XML in order to change VDSM's definition of a virtual machine before it reaches libvirt. Caution must be exercised in doing so. Hook scripts have the potential to disrupt the operation of VDSM, and buggy scripts can result in outages to the Red Hat Enterprise Virtualization environment. In particular, ensure you never change the UUID of the domain, and do not attempt to remove a device from the domain without sufficient background knowledge.
before_vdsm_start and after_vdsm_stop hook scripts are run as the root user. Other hook scripts that require root access to the system must be written to use the sudo command for privilege escalation. To support this the /etc/sudoers must be updated to allow the vdsm user to use sudo without reentering a password. This is required as hook scripts are executed non-interactively.
Example B.4. Configuring sudo for VDSM Hooks
sudo command will be configured to allow the vdsm user to run the /bin/chown command as root.
- Log into the virtualization host as
root. - Open the
/etc/sudoersfile in a text editor. - Add this line to the file:
vdsm ALL=(ALL) NOPASSWD: /bin/chown
This specifies that thevdsmuser has the ability to run the/bin/chowncommand as therootuser. TheNOPASSWDparameter indicates that the user will not be prompted to enter their password when callingsudo.
sudo command to run /bin/chown as root. This Python code uses sudo to execute /bin/chown as root on the file /my_file.
retcode = subprocess.call( ["/usr/bin/sudo", "/bin/chown", "root", "/my_file"] )
B.12. VDSM Hook Return Codes
Table B.3. Hook Return Codes
| Code | Description |
|---|---|
| 0 | The hook script ended successfully |
| 1 | The hook script failed, other hooks should be processed |
| 2 | The hook script failed, no further hooks should be processed |
| >2 | Reserved |
B.13. VDSM Hook Examples
Example B.5. NUMA Node Tuning
numaset custom property. Where the custom property is not set no action is taken.
numaset=^(interleave|strict|preferred):[\^]?\d+(-\d+)?(,[\^]?\d+(-\d+)?)*$
numaset custom property for a given virtual machine to specify both the allocation mode (interleave, strict, preferred) and the node to use. The two values are separated by a colon (:). The regular expression allows specification of the nodeset as:
- that a specific node (
numaset=strict:1, specifies that only node 1 be used), or - that a range of nodes be used (
numaset=strict:1-4, specifies that nodes 1 through 4 be used), or - that a specific node not be used (
numaset=strict:^3, specifies that node 3 not be used), or - any comma-separated combination of the above (
numaset=strict:1-4,6, specifies that nodes 1 to 4, and 6 be used).
/usr/libexec/vdsm/hooks/before_vm_start/50_numa
#!/usr/bin/python
import os
import sys
import hooking
import traceback
'''
numa hook
=========
add numa support for domain xml:
<numatune>
<memory mode="strict" nodeset="1-4,^3" />
</numatune>
memory=interleave|strict|preferred
numaset="1" (use one NUMA node)
numaset="1-4" (use 1-4 NUMA nodes)
numaset="^3" (don't use NUMA node 3)
numaset="1-4,^3,6" (or combinations)
syntax:
numa=strict:1-4
'''
if os.environ.has_key('numa'):
try:
mode, nodeset = os.environ['numa'].split(':')
domxml = hooking.read_domxml()
domain = domxml.getElementsByTagName('domain')[0]
numas = domxml.getElementsByTagName('numatune')
if not len(numas) > 0:
numatune = domxml.createElement('numatune')
domain.appendChild(numatune)
memory = domxml.createElement('memory')
memory.setAttribute('mode', mode)
memory.setAttribute('nodeset', nodeset)
numatune.appendChild(memory)
hooking.write_domxml(domxml)
else:
sys.stderr.write('numa: numa already exists in domain xml')
sys.exit(2)
except:
sys.stderr.write('numa: [unexpected error]: %s\n' % traceback.format_exc())
sys.exit(2)
Appendix C. Explanation of Network Bridge Parameters
C.1. Explanation of bridge_opts Parameters
Table C.1. bridge_opts parameters
| Parameter | Description |
|---|---|
| forward_delay | Sets the time, in deciseconds, a bridge will spend in the listening and learning states. If no switching loop is discovered in this time, the bridge will enter forwarding state. This allows time to inspect the traffic and layout of the network before normal network operation. |
| gc_timer | Sets the garbage collection time, in deciseconds, after which the forwarding database is checked and cleared of timed-out entries. |
| group_addr | Set to zero when sending a general query. Set to the IP multicast address when sending a group-specific query, or group-and-source-specific query. |
| group_fwd_mask | Enables bridge to forward link local group addresses. Changing this value from the default will allow non-standard bridging behavior. |
| hash_elasticity | The maximum chain length permitted in the hash table. Does not take effect until the next new multicast group is added. If this cannot be satisfied after rehashing, a hash collision occurs and snooping is disabled. |
| hash_max | The maximum amount of buckets in the hash table. This takes effect immediately and cannot be set to a value less than the current number of multicast group entries. Value must be a power of two. |
| hello_time | Sets the time interval, in deciseconds, between sending 'hello' messages, announcing bridge position in the network topology. Applies only if this bridge is the Spanning Tree root bridge. |
| hello_timer | Time, in deciseconds, since last 'hello' message was sent. |
| max_age | Sets the maximum time, in deciseconds, to receive a 'hello' message from another root bridge before that bridge is considered dead and takeover begins. |
| multicast_last_member_count | Sets the number of 'last member' queries sent to the multicast group after receiving a 'leave group' message from a host. |
| multicast_last_member_interval | Sets the time, in deciseconds, between 'last member' queries. |
| multicast_membership_interval | Sets the time, in deciseconds, that a bridge will wait to hear from a member of a multicast group before it stops sending multicast traffic to the host. |
| multicast_querier | Sets whether the bridge actively runs a multicast querier or not. When a bridge receives a 'multicast host membership' query from another network host, that host is tracked based on the time that the query was received plus the multicast query interval time. If the bridge later attempts to forward traffic for that multicast membership, or is communicating with a querying multicast router, this timer confirms the validity of the querier. If valid, the multicast traffic is delivered via the bridge's existing multicast membership table; if no longer valid, the traffic is sent via all bridge ports. Broadcast domains with, or expecting, multicast memberships should run at least one multicast querier for improved performance. |
| multicast_querier_interval | Sets the maximum time, in deciseconds, between last 'multicast host membership' query received from a host to ensure it is still valid. |
| multicast_query_use_ifaddr | Boolean. Defaults to '0', in which case the querier uses 0.0.0.0 as source address for IPv4 messages. Changing this sets the bridge IP as the source address. |
| multicast_query_interval | Sets the time, in deciseconds, between query messages sent by the bridge to ensure validity of multicast memberships. At this time, or if the bridge is asked to send a multicast query for that membership, the bridge checks its own multicast querier state based on the time that a check was requested plus multicast_query_interval. If a multicast query for this membership has been sent within the last multicast_query_interval, it is not sent again. |
| multicast_query_response_interval | Length of time, in deciseconds, a host is allowed to respond to a query once it has been sent. Must be less than or equal to the value of the multicast_query_interval. |
| multicast_router | Allows you to enable or disable ports as having multicast routers attached. A port with one or more multicast routers will receive all multicast traffic. A value of 0 disables completely, a value of 1 enables the system to automatically detect the presence of routers based on queries, and a value of 2 enables ports to always receive all multicast traffic. |
| multicast_snooping | Toggles whether snooping is enabled or disabled. Snooping allows the bridge to listen to the network traffic between routers and hosts to maintain a map to filter multicast traffic to the appropriate links. This option allows the user to re-enable snooping if it was automatically disabled due to hash collisions, however snooping will not be re-enabled if the hash collision has not been resolved. |
| multicast_startup_query_count | Sets the number of queries sent out at startup to determine membership information. |
| multicast_startup_query_interval | Sets the time, in deciseconds, between queries sent out at startup to determine membership information. |
Appendix D. Red Hat Enterprise Virtualization User Interface Plugins
D.1. Red Hat Enterprise Virtualization User Interface Plug-ins
D.2. Red Hat Enterprise Virtualization User Interface Plugin Lifecycle
D.2.1. Red Hat Enterprise Virtualization User Interface Plug-in Life cycle
- Plug-in discovery.
- Plug-in loading.
- Plug-in bootstrapping.
D.2.2. Red Hat Enterprise Virtualization User Interface Plug-in Discovery
HTTP GET), User Interface plug-in infrastructure attempts to discover and load plug-in descriptors from your local file system. For each plug-in descriptor, the infrastructure also attempts to load corresponding plug-in user configurations used to override default plug-in-specific configurations (if any exist) and tweak plug-in runtime behavior. Plug-in user configuration is optional. After loading descriptors and corresponding user configuration files, oVirt Engine aggregates User Interface plug-in data and embeds it into the administration portal HTML page for runtime evaluation.
$ENGINE_USR/ui-plug-ins, with a default mapping of ENGINE_USR=/usr/share/ovirt-engine as defined by oVirt Engine local configuration. Plug-in descriptors are expected to comply with JSON format specifications, but plug-in descriptors allow Java/C++ style comments (of both /* and // varieties) in addition to the JSON format specifications.
$ENGINE_ETC/ui-plug-ins, with a default mapping of ENGINE_ETC=/etc/ovirt-engine as defined by oVirt Engine local configuration. Plug-in user configuration files are expected to comply with same content format rules as plug-in descriptors.
Note
<descriptorFileName>-config.json naming convention.
D.2.3. Red Hat Enterprise Virtualization User Interface Plug-in Loading
D.2.4. Red Hat Enterprise Virtualization User Interface Plug-in Bootstrapping
Procedure D.1. Plug-in Bootstrap Sequence
- Obtain pluginApi instance for the given plug-in
- Obtain runtime plug-in configuration object (optional)
- Register relevant event handler functions
- Notify UI plug-in infrastructure to proceed with plug-in initialization
// Access plug-in 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 plug-in
// host page are served from same origin. WebAdmin HTML page and plug-in host page will always be on same origin
// when using UI plug-in infrastructure support to serve plug-in resource files.
var api = parent.pluginApi('MyPlugin');
// Runtime configuration object associated with the plug-in (or an empty object).
var config = api.configObject();
// Register event handler function(s) for later invocation by UI plug-in infrastructure.
api.register({
// UiInit event handler function.
UiInit: function() {
// Handle UiInit event.
window.alert('Favorite music band is ' + config.band);
}
});
// Notify UI plug-in infrastructure to proceed with plug-in initialization.
api.ready();
D.3. User Interface Plugin-related Files and Their Locations
Table D.1. UI Plugin-related Files and their Locations
| File | Location | Remarks |
|---|---|---|
| Plug-in descriptor files (meta-data) | /usr/share/ovirt-engine/ui-plugins/my-plugin.json | |
| Plug-in user configuration files | /etc/ovirt-engine/ui-plugins/my-plugin-config.json | |
| Plug-in resource files | /usr/share/ovirt-enging/ui-plugins/<resourcePath>/PluginHostPage.html | <resourcePath> is defined by the corresponding attribute in the plug-in descriptor. |
D.4. Example User Interface Plug-in Deployment
Hello World! program when you sign in to the Red Hat Enterprise Virtualization Manager administration portal.
Procedure D.2. Deploying a Hello World! Plug-in
- Create a plug-in descriptor by creating the following file in the Manager at
/usr/share/ovirt-engine/ui-plugins/helloWorld.json:{ "name": "HelloWorld", "url": "/ovirt-engine/webadmin/plugin/HelloWorld/start.html", "resourcePath": "hello-files" } - Create the plug-in host page by creating the following file in the Manager at
/usr/share/ovirt-engine/ui-plugins/hello-files/start.html:<!DOCTYPE html><html><head> <script> var api = parent.pluginApi('HelloWorld'); api.register({ UiInit: function() { window.alert('Hello world'); } }); api.ready(); </script> </head><body></body></html>
Hello World! plug-in, you will see this screen when you sign in to the administration portal:
D.5. Installing the Red Hat Support Plug-in
Procedure D.3. Installing the Red Hat Support Plug-in
Note
- Use yum to install the redhat-support-plugin-rhev plug-in:
#yum install redhat-support-plugin-rhev
D.6. Using Red Hat Support Plug-in
Note
Red Hat Documentation tab to open the documentation relevant to the part of the Administration Portal currently on the screen.
Appendix E. Red Hat Enterprise Virtualization and SSL
E.1. Replacing the Red Hat Enterprise Virtualization Manager SSL Certificate
Warning
/etc/pki directory or any subdirectories. The permission for the /etc/pki and the /etc/pki/ovirt-engine directory must remain as the default 755.
Note
Procedure E.1. Replacing the Red Hat Enterprise Virtualization Manager Apache SSL Certificate
- The Manager has been configured to use
/etc/pki/ovirt-engine/apache-ca.pem, which is symbolically linked to/etc/pki/ovirt-engine/ca.pem. Remove the symbolic link.# rm /etc/pki/ovirt-engine/apache-ca.pem
- Save your commercially issued certificate as
/etc/pki/ovirt-engine/apache-ca.pem. The certificate chain must be complete up to the root certificate. The chain order is important and should be from the last intermediate certificate to the root certificate.mv YOUR-3RD-PARTY-CERT.pem /etc/pki/ovirt-engine/apache-ca.pem
- Move your P12 bundle to
/etc/pki/ovirt-engine/keys/apache.p12. - Extract the key from the bundle.
# openssl pkcs12 -in /etc/pki/ovirt-engine/keys/apache.p12 -nocerts -nodes > /etc/pki/ovirt-engine/keys/apache.key.nopass
- Extract the certificate from the bundle.
# openssl pkcs12 -in /etc/pki/ovirt-engine/keys/apache.p12 -nokeys > /etc/pki/ovirt-engine/certs/apache.cer
- Restart the Apache server.
# service httpd restart
E.2. Setting Up SSL or TLS Connections between the Manager and an LDAP Server
Note
X.509 CERTIFICATE TRUST STORE section of the README file at /usr/share/doc/ovirt-engine-extension-aaa-ldap-version.
/tmp directory, then use the following procedure to create a public keystore file on the Manager. Update the LDAP property configuration file with the public keystore file details.
Procedure E.2. Creating a Keystore File
- On the Red Hat Enterprise Virtualization Manager, import the certificate and create a public keystore file. The following command imports the root CA certificate at /tmp/myrootca.pem, and creates a public keystore file myrootca.jks under /etc/ovirt-engine/aaa/.
$ keytool -importcert -noprompt -trustcacerts -alias myrootca -file /tmp/myrootca.pem -keystore /etc/ovirt-engine/aaa/myrootca.jks -storepass changeit
- Update the
/etc/ovirt-engine/aaa/profile1.propertiesfile with the keystore file information.Note
${local:_basedir}is the directory where the LDAP property configuration file resides and points to the/etc/ovirt-engine/aaadirectory. If you created the public keystore file in a different directory, replace${local:_basedir}with the full path to the public keystore file.- To use startTLS (recommended):
# Create keystore, import certificate chain and uncomment pool.default.ssl.startTLS = true pool.default.ssl.truststore.file = ${local:_basedir}/myrootca.jks pool.default.ssl.truststore.password = changeit - To use SSL:
# Create keystore, import certificate chain and uncomment pool.default.serverset.single.port = 636 pool.default.ssl.enable = true pool.default.ssl.truststore.file = ${local:_basedir}/myrootca.jks pool.default.ssl.truststore.password = changeit
Appendix F. Using Search, Bookmarks, and Tags
F.1. Searches
- F.1.1. Performing Searches in Red Hat Enterprise Virtualization
- F.1.2. Search Syntax and Examples
- F.1.3. Search Auto-Completion
- F.1.4. Search Result Type Options
- F.1.5. Search Criteria
- F.1.6. Search: Multiple Criteria and Wildcards
- F.1.7. Search: Determining Search Order
- F.1.8. Searching for Data Centers
- F.1.9. Searching for Clusters
- F.1.10. Searching for Hosts
- F.1.11. Searching for Networks
- F.1.12. Searching for Storage
- F.1.13. Searching for Disks
- F.1.14. Searching for Volumes
- F.1.15. Searching for Virtual Machines
- F.1.16. Searching for Pools
- F.1.17. Searching for Templates
- F.1.18. Searching for Users
- F.1.19. Searching for Events
F.1.1. Performing Searches in Red Hat Enterprise Virtualization
Note
F.1.2. Search Syntax and Examples
result type: {criteria} [sortby sort_spec]
Table F.1. Example Search Queries
| Example | Result |
|---|---|
| Hosts: Vms.status = up | Displays a list of all hosts running virtual machines that are up. |
| Vms: domain = qa.company.com | Displays a list of all virtual machines running on the specified domain. |
| Vms: users.name = Mary | Displays a list of all virtual machines belonging to users with the user name Mary. |
| Events: severity > normal sortby time | Displays the list of all Events whose severity is higher than Normal, sorted by time. |
F.1.3. Search Auto-Completion
Hosts: Vms.status = down
Table F.2. Example Search Queries Using Auto-Completion
| Input | List Items Displayed | Action |
|---|---|---|
h | Hosts (1 option only) |
Select
Hosts or;
Type
Hosts
|
Hosts: |
All host properties
| Type v |
Hosts: v | host properties starting with a v | Select Vms or type Vms |
Hosts: Vms | All virtual machine properties | Type s |
Hosts: Vms.s | All virtual machine properties beginning with s | Select status or type status |
Hosts: Vms.status | =
=!
| Select or type = |
Hosts: Vms.status = | All status values | Select or type down |
F.1.4. Search Result Type Options
- Vms for a list of virtual machines
- Host for a list of hosts
- Pools for a list of pools
- Template for a list of templates
- Event for a list of events
- Users for a list of users
- Cluster for a list of clusters
- Datacenter for a list of data centers
- Storage for a list of storage domains
F.1.5. Search Criteria
{criteria} is as follows:
<prop><operator><value>
<obj-type><prop><operator><value>
Table F.3. Example Search Criteria
| Part | Description | Values | Example | Note |
|---|---|---|---|---|
| prop | The property of the searched-for resource. Can also be the property of a resource type (see obj-type), or tag (custom tag). | Limit your search to objects with a certain property. For example, search for objects with a status property. | Status | N/A |
| obj-type | A resource type that can be associated with the searched-for resource. | These are system objects, like data centers and virtual machines. | Users | N/A |
| operator | Comparison operators. |
=
!= (not equal)
>
<
>=
<=
| N/A | Value options depend on obj-type. |
| Value | What the expression is being compared to. |
String
Integer
Ranking
Date (formatted according to Regional Settings)
|
Jones
256
normal
|
|
F.1.6. Search: Multiple Criteria and Wildcards
<value> part of the syntax for strings. For example, to find all users beginning with m, enter m*.
AND and OR. For example:
Vms: users.name = m* AND status = Up
Vms: users.name = m* AND tag = "paris-loc"
AND or OR, AND is implied. AND precedes OR, and OR precedes implied AND.
F.1.7. Search: Determining Search Order
sortby. Sort direction (asc for ascending, desc for descending) can be included.
events: severity > normal sortby time desc
F.1.8. Searching for Data Centers
Table F.4. Searching for Data Centers
| Property (of resource or resource-type) | Type | Description (Reference) |
|---|---|---|
| Clusters.clusters-prop | Depends on property type | The property of the clusters associated with the data center. |
| name | String | The name of the data center. |
| description | String | A description of the data center. |
| type | String | The type of data center. |
| status | List | The availability of the data center. |
| sortby | List | Sorts the returned results by one of the resource properties. |
| page | Integer | The page number of results to display. |
Datacenter: type = nfs and status != up
- A storage type of NFS and status other than up
F.1.9. Searching for Clusters
Table F.5. Searching Clusters
| Property (of resource or resource-type) | Type | Description (Reference) |
|---|---|---|
| Datacenter.datacenter-prop | Depends on property type | The property of the data center associated with the cluster. |
| Datacenter | String | The data center to which the cluster belongs. |
| name | String | The unique name that identifies the clusters on the network. |
| description | String | The description of the cluster. |
| initialized | String | True or False indicating the status of the cluster. |
| sortby | List | Sorts the returned results by one of the resource properties. |
| page | Integer | The page number of results to display. |
Clusters: initialized = true or name = Default
- initialized; or
- named Default
F.1.10. Searching for Hosts
Table F.6. Searching for Hosts
| Property (of resource or resource-type) | Type | Description (Reference) |
|---|---|---|
| Vms.Vms-prop | Depends on property type | The property of the virtual machines associated with the host. |
| Templates.templates-prop | Depends on property type | The property of the templates associated with the host. |
| Events.events-prop | Depends on property type | The property of the events associated with the host. |
| Users.users-prop | Depends on property type | The property of the users associated with the host. |
| name | String | The name of the host. |
| status | List | The availability of the host. |
| cluster | String | The cluster to which the host belongs. |
| address | String | The unique name that identifies the host on the network. |
| cpu_usage | Integer | The percent of processing power used. |
| mem_usage | Integer | The percentage of memory used. |
| network_usage | Integer | The percentage of network usage. |
| load | Integer | Jobs waiting to be executed in the run-queue per processor, in a given time slice. |
| version | Integer | The version number of the operating system. |
| cpus | Integer | The number of CPUs on the host. |
| memory | Integer | The amount of memory available. |
| cpu_speed | Integer | The processing speed of the CPU. |
| cpu_model | String | The type of CPU. |
| active_vms | Integer | The number of VMs currently running. |
| migrating_vms | Integer | The number of VMs currently being migrated. |
| committed_mem | Integer | The percentage of committed memory. |
| tag | String | The tag assigned to the host. |
| type | String | The type of host. |
| datacenter | String | The data center to which the host belongs. |
| sortby | List | Sorts the returned results by one of the resource properties. |
| page | Integer | The page number of results to display. |
Hosts: cluster = Default and Vms.os = rhel6
- Are part of the Default cluster and host virtual machines running the Red Hat Enterprise Linux 6 operating system.
F.1.11. Searching for Networks
Table F.7. Searching for Networks
| Property (of resource or resource-type) | Type | Description (Reference) |
|---|---|---|
| Cluster_network.clusternetwork-prop | Depends on property type | The property of the cluster associated with the network. |
| Host_Network.hostnetwork-prop | Depends on property type | The property of the host associated with the network. |
| name | String | The human readable name that identifies the network. |
| description | String | Keywords or text describing the network, optionally used when creating the network. |
| vlanid | Integer | The VLAN ID of the network. |
| stp | String | Whether Spanning Tree Protocol (STP) is enabled or disabled for the network. |
| mtu | Integer | The maximum transmission unit for the logical network. |
| vmnetwork | String | Whether the network is only used for virtual machine traffic. |
| datacenter | String | The data center to which the network is attached. |
| sortby | List | Sorts the returned results by one of the resource properties. |
| page | Integer | The page number of results to display. |
Network: mtu > 1500 and vmnetwork = true
- with a maximum transmission unit greater than 1500 bytes
- which are set up for use by only virtual machines.
F.1.12. Searching for Storage
Table F.8. Searching for Storage
| Property (of resource or resource-type) | Type | Description (Reference) |
|---|---|---|
| Hosts.hosts-prop | Depends on property type | The property of the hosts associated with the storage. |
| Clusters.clusters-prop | Depends on property type | The property of the clusters associated with the storage. |
| name | String | The unique name that identifies the storage on the network. |
| status | String | The status of the storage domain. |
| datacenter | String | The data center to which the storage belongs. |
| type | String | The type of the storage. |
| size | Integer | The size of the storage. |
| used | Integer | The amount of the storage that is used. |
| committed | Integer | The amount of the storage that is committed. |
| sortby | List | Sorts the returned results by one of the resource properties. |
| page | Integer | The page number of results to display. |
Storage: size > 200 or used < 50
- total storage space greater than 200 GB; or
- used storage space less than 50 GB.
F.1.13. Searching for Disks
Table F.9. Searching for Disks
| Property (of resource or resource-type) | Type | Description (Reference) |
|---|---|---|
| Datacenters.datacenters-prop | Depends on property type | The property of the data centers associated with the disk. |
| Storages.storages-prop | Depends on property type | The property of the storage associated with the disk. |
| alias | String | The human readable name that identifies the storage on the network. |
| description | String | Keywords or text describing the disk, optionally used when creating the disk. |
| provisioned_size | Integer | The virtual size of the disk. |
| size | Integer | The size of the disk. |
| actual_size | Integer | The actual size allocated to the disk. |
| creation_date | Integer | The date the disk was created. |
| bootable | String | Whether the disk can or cannot be booted. Valid values are one of 0, 1, yes, or no |
| shareable | String | Whether the disk can or cannot be attached to more than one virtual machine at a time. Valid values are one of 0, 1, yes, or no |
| format | String | The format of the disk. Can be one of unused, unassigned, cow, or raw. |
| status | String | The status of the disk. Can be one of unassigned, ok, locked, invalid, or illegal. |
| disk_type | String | The type of the disk. Can be one of image or lun. |
| number_of_vms | Integer | The number of virtual machine(s) to which the disk is attached. |
| vm_names | String | The name(s) of the virtual machine(s) to which the disk is attached. |
| quota | String | The name of the quota enforced on the virtual disk. |
| sortby | List | Sorts the returned results by one of the resource properties. |
| page | Integer | The page number of results to display. |
Disks: format = cow and provisioned_size > 8
- Qcow, also known as thin provisioning, format; and
- an allocated disk size greater than 8 GB.
F.1.14. Searching for Volumes
Table F.10. Searching for Volumes
| Property (of resource or resource-type) | Type | Description (Reference) |
|---|---|---|
| Volume.cluster-prop | Depends on property type | The property of the clusters associated with the volume. |
| Cluster | String | The name of the cluster associated with the volume. |
| name | String | The human readable name that identifies the volume. |
| type | String | Can be one of distribute, replicate, distributed_replicate, stripe, or distributed_stripe. |
| transport_type | Integer | Can be one of TCP or RDMA. |
| replica_count | Integer | Number of replica. |
| stripe_count | Integer | Number of stripes. |
| status | String | The status of the volume. Can be one of Up or Down. |
| sortby | List | Sorts the returned results by one of the resource properties. |
| page | Integer | The page number of results to display. |
Volume: transport_type = rdma and stripe_count >= 2
- Transport type set to RDMA; and
- with 2 or more stripes.
F.1.15. Searching for Virtual Machines
Table F.11. Searching for Virtual Machines
| Property (of resource or resource-type) | Type | Description (Reference) |
|---|---|---|
| Hosts.hosts-prop | Depends on property type | The property of the hosts associated with the virtual machine. |
| Templates.templates-prop | Depends on property type | The property of the templates associated with the virtual machine. |
| Events.events-prop | Depends on property type | The property of the events associated with the virtual machine. |
| Users.users-prop | Depends on property type | The property of the users associated with the virtual machine. |
| Storage.storage-prop | Depends on the property type | The property of storage devices associated with the virtual machine. |
| Vnic.mac-prop | Depends on the property type | The property of the MAC address associated with the virtual machine. |
| name | String | The name of the virtual machine. |
| status | List | The availability of the virtual machine. |
| ip | Integer | The IP address of the virtual machine. |
| uptime | Integer | The number of minutes that the virtual machine has been running. |
| domain | String | The domain (usually Active Directory domain) that groups these machines. |
| os | String | The operating system selected when the virtual machine was created. |
| creationdate | Date | The date on which the virtual machine was created. |
| address | String | The unique name that identifies the virtual machine on the network. |
| cpu_usage | Integer | The percent of processing power used. |
| mem_usage | Integer | The percentage of memory used. |
| network_usage | Integer | The percentage of network used. |
| memory | Integer | The maximum memory defined. |
| apps | String | The applications currently installed on the virtual machine. |
| cluster | List | The cluster to which the virtual machine belongs. |
| pool | List | The virtual machine pool to which the virtual machine belongs. |
| loggedinuser | String | The name of the user currently logged in to the virtual machine. |
| tag | List | The tags to which the virtual machine belongs. |
| datacenter | String | The data center to which the virtual machine belongs. |
| type | List | The virtual machine type (server or desktop). |
| quota | String | The name of the quota associated with the virtual machine. |
| description | String | Keywords or text describing the virtual machine, optionally used when creating the virtual machine. |
| sortby | List | Sorts the returned results by one of the resource properties. |
| page | Integer | The page number of results to display. |
Vms: template.name = Win* and user.name = ""
- The template on which the virtual machine is based begins with Win and the virtual machine is assigned to any user.
Vms: cluster = Default and os = windowsxp
- The cluster to which the virtual machine belongs is named Default and the virtual machine is running the Windows XP operating system.
F.1.16. Searching for Pools
Table F.12. Searching for Pools
| Property (of resource or resource-type) | Type | Description (Reference) |
|---|---|---|
| name | String | The name of the pool. |
| description | String | The description of the pool. |
| type | List | The type of pool. |
| sortby | List | Sorts the returned results by one of the resource properties. |
| page | Integer | The page number of results to display. |
Pools: type = automatic
- Type of automatic
F.1.17. Searching for Templates
Table F.13. Searching for Templates
| Property (of resource or resource-type) | Type | Description (Reference) |
|---|---|---|
| Vms.Vms-prop | String | The property of the virtual machines associated with the template. |
| Hosts.hosts-prop | String | The property of the hosts associated with the template. |
| Events.events-prop | String | The property of the events associated with the template. |
| Users.users-prop | String | The property of the users associated with the template. |
| name | String | The name of the template. |
| domain | String | The domain of the template. |
| os | String | The type of operating system. |
| creationdate | Integer |
The date on which the template was created.
Date format is mm/dd/yy.
|
| childcount | Integer | The number of VMs created from the template. |
| mem | Integer | Defined memory. |
| description | String | The description of the template. |
| status | String | The status of the template. |
| cluster | String | The cluster associated with the template. |
| datacenter | String | The data center associated with the template. |
| quota | String | The quota associated with the template. |
| sortby | List | Sorts the returned results by one of the resource properties. |
| page | Integer | The page number of results to display. |
Template: Events.severity >= normal and Vms.uptime > 0
- Events of normal or greater severity have occurred on VMs derived from the template, and the VMs are still running.
F.1.18. Searching for Users
Table F.14. Searching for Users
| Property (of resource or resource-type) | Type | Description (Reference) |
|---|---|---|
| Vms.Vms-prop | Depends on property type | The property of the virtual machines associated with the user. |
| Hosts.hosts-prop | Depends on property type | The property of the hosts associated with the user. |
| Templates.templates-prop | Depends on property type | The property of the templates associated with the user. |
| Events.events-prop | Depends on property type | The property of the events associated with the user. |
| name | String | The name of the user. |
| lastname | String | The last name of the user. |
| usrname | String | The unique name of the user. |
| department | String | The department to which the user belongs. |
| group | String | The group to which the user belongs. |
| title | String | The title of the user. |
| status | String | The status of the user. |
| role | String | The role of the user. |
| tag | String | The tag to which the user belongs. |
| pool | String | The pool to which the user belongs. |
| sortby | List | Sorts the returned results by one of the resource properties. |
| page | Integer | The page number of results to display. |
Users: Events.severity > normal and Vms.status = up or Vms.status = pause
- Events of greater than normal severity have occurred on their virtual machines AND the virtual machines are still running; or
- The users' virtual machines are paused.
F.1.19. Searching for Events
Table F.15. Searching for Events
| Property (of resource or resource-type) | Type | Description (Reference) |
|---|---|---|
| Vms.Vms-prop | Depends on property type | The property of the virtual machines associated with the event. |
| Hosts.hosts-prop | Depends on property type | The property of the hosts associated with the event. |
| Templates.templates-prop | Depends on property type | The property of the templates associated with the event. |
| Users.users-prop | Depends on property type | The property of the users associated with the event. |
| Clusters.clusters-prop | Depends on property type | The property of the clusters associated with the event. |
| Volumes.Volumes-prop | Depends on property type | The property of the volumes associated with the event. |
| type | List | Type of the event. |
| severity | List | The severity of the event: Warning/Error/Normal. |
| message | String | Description of the event type. |
| time | List | Day the event occurred. |
| usrname | String | The user name associated with the event. |
| event_host | String | The host associated with the event. |
| event_vm | String | The virtual machine associated with the event. |
| event_template | String | The template associated with the event. |
| event_storage | String | The storage associated with the event. |
| event_datacenter | String | The data center associated with the event. |
| event_volume | String | The volume associated with the event. |
| correlation_id | Integer | The identification number of the event. |
| sortby | List | Sorts the returned results by one of the resource properties. |
| page | Integer | The page number of results to display. |
Events: Vms.name = testdesktop and Hosts.name = gonzo.example.com
- The event occurred on the virtual machine named
testdesktopwhile it was running on the hostgonzo.example.com.
F.2. Bookmarks
F.2.1. Saving a Query String as a Bookmark
Procedure F.1. Saving a Query String as a Bookmark
- Enter the desired search query in the search bar and perform the search.
- Click the star-shaped button to the right of the search bar to open the New Bookmark window.
- Enter the Name of the bookmark.
- Edit the Search string field (if applicable).
- Click to save the query as a bookmark and close the window.
- The search query is saved and displays in the Bookmarks pane.
F.2.2. Editing a Bookmark
Procedure F.2. Editing a Bookmark
- Click the Bookmarks tab on the far left side of the screen.
- Select the bookmark you wish to edit.
- Click the button to open the Edit Bookmark window.
- Change the Name and Search string fields as necessary.
- Click to save the edited bookmark.
F.2.3. Deleting a Bookmark
Procedure F.3. Deleting a Bookmark
- Click the Bookmarks tab on the far left side of the screen.
- Select the bookmark you wish to remove.
- Click the button to open the Remove Bookmark window.
- Click to remove the selected bookmark.
F.3. Tags
F.3.1. Using Tags to Customize Interactions with Red Hat Enterprise Virtualization
F.3.2. Creating a Tag
Procedure F.4. Creating a Tag
- Click the Tags tab on the left side of the screen.
- Select the node under which you wish to create the tag. For example, to create it at the highest level, click the root node.
- Click the New button to open the New Tag window.
- Enter the Name and Description of the new tag.
- Click to create the tag.
F.3.3. Modifying a Tag
Procedure F.5. Modifying a Tag
- Click the Tags tab on the left side of the screen.
- Select the tag you wish to modify.
- Click to open the Edit Tag window.
- Change the Name and Description fields as necessary.
- Click to save the edited tag.
F.3.4. Deleting a Tag
Procedure F.6. Deleting a Tag
- Click the Tags tab on the left side of the screen.
- Select the tag you wish to delete.
- Click to open the Remove Tag(s) window. The message warns you that removing the tag will also remove all descendants of the tag.
- Click to delete the selected tag.
F.3.5. Adding and Removing Tags to and from Objects
Procedure F.7. Adding and Removing Tags to and from Objects
- Use the resource tab, tree mode, or the search function to find and select the object(s) you wish to tag or untag.
- Click the Assign Tags button to open the Assign Tags window.
- Select the check box to assign a tag to the object, or clear the check box to detach the tag from the object.
- Click .
F.3.6. Searching for Objects Using Tags
- Enter a search query using
tagas the property and the desired value or set of values as criteria for the search.The objects tagged with the specified criteria are listed in the results list.
Appendix G. Branding
G.1. Branding
G.1.1. Re-Branding the Manager
/etc/ovirt-engine/branding/ directory on the system on which the Manager is installed. The files comprise a set of cascading style sheet files that are used to style various aspects of the graphical user interface and a set of properties files that contain messages and links that are incorporated into various components of the Manager.
G.1.2. Login Screen
- The border
- The header image on the left
- The header image on the right
- The header text
common.css.
G.1.3. Administration Portal Screen
- The logo
- The left background image
- The center background image
- The right background image
- The text to the right of the logo
web_admin.css.
G.1.4. User Portal Screen
- The logo
- The center background image
- The right background image
- The border around the main grid
- The text above the Logged in user label
user_portal.css.
G.1.5. Pop-Up Windows
- The border
- The header image on the left
- The header center image (repeated)
common.css.
G.1.6. Tabs
- Active
- Inactive
common.css and user_portal.css.
G.1.7. The Welcome Page
- The page title
- The header (left, center and right)
- The error message
- The link to forward and the associated message for that link
welcome_style.css.
welcome_page.template that does not contain HTML, HEAD or BODY tags. This file is inserted directly into the Welcome Page itself, and acts as a container for the content that is displayed in the Welcome Page. As such, you must edit this file to add new links or change the content itself. Another feature of the template file is that it contains placeholder text such as {user_portal} that is replaced by corresponding text in the messages.properties file when the Welcome Page is processed.
G.1.8. The Page Not Found Page
- The page title
- The header (left, center and right)
- The error message
- The link to forward and the associated message for that link
welcome_style.css.
Appendix H. Revision History
| Revision History | |||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Revision 3.5-95 | Wed 27 Jul 2016 | ||||||||||||
| |||||||||||||
| Revision 3.5-94 | Wed 29 Jun 2016 | ||||||||||||
| |||||||||||||
| Revision 3.5-93 | Tue 31 May 2016 | ||||||||||||
| |||||||||||||
| Revision 3.5-92 | Wed 25 May 2016 | ||||||||||||
| |||||||||||||
| Revision 3.5-91 | Mon 8 Feb 2016 | ||||||||||||
| |||||||||||||
| Revision 3.5-90 | Mon 25 Jan 2016 | ||||||||||||
| |||||||||||||
| Revision 3.5-89 | Thu 10 Dec 2015 | ||||||||||||
| |||||||||||||
| Revision 3.5-88 | Wed 09 Dec 2015 | ||||||||||||
| |||||||||||||
| Revision 3.5-87 | Wed 02 Dec 2015 | ||||||||||||
| |||||||||||||
| Revision 3.5-86 | Tue 01 Dec 2015 | ||||||||||||
| |||||||||||||
| Revision 3.5-85 | Mon 26 Oct 2015 | ||||||||||||
| |||||||||||||
| Revision 3.5-84 | Mon 07 Sep 2015 | ||||||||||||
| |||||||||||||
| Revision 3.5-83 | Fri 04 Sep 2015 | ||||||||||||
| |||||||||||||
| Revision 3.5-82 | Tue 01 Sep 2015 | ||||||||||||
| |||||||||||||
| Revision 3.5-81 | Fri 21 Aug 2015 | ||||||||||||
| |||||||||||||
| Revision 3.5-80 | Tue 04 Aug 2015 | ||||||||||||
| |||||||||||||
| Revision 3.5-79 | Tue 21 Jul 2015 | ||||||||||||
| |||||||||||||
| Revision 3.5-78 | Tue 02 Jun 2015 | ||||||||||||
| |||||||||||||
| Revision 3.5-77 | Tue 19 May 2015 | ||||||||||||
| |||||||||||||
| Revision 3.5-76 | Tue 28 Apr 2015 | ||||||||||||
| |||||||||||||
| Revision 3.5-75 | Tue 21 Apr 2015 | ||||||||||||
| |||||||||||||
| Revision 3.5-74 | Wed 18 Mar 2015 | ||||||||||||
| |||||||||||||
| Revision 3.5-73 | Wed 11 Mar 2015 | ||||||||||||
| |||||||||||||
| Revision 3.5-72 | Mon 09 Feb 2015 | ||||||||||||
| |||||||||||||
| Revision 3.5-71 | Mon 09 Feb 2015 | ||||||||||||
| |||||||||||||
| Revision 3.5-70 | Fri 06 Feb 2015 | ||||||||||||
| |||||||||||||
| Revision 3.5-69 | Mon 02 Feb 2015 | ||||||||||||
| |||||||||||||
| Revision 3.5-68 | Fri 30 Jan 2015 | ||||||||||||
| |||||||||||||
| Revision 3.5-67 | Thu 22 Jan 2015 | ||||||||||||
| |||||||||||||
| Revision 3.5-66 | Mon 19 Jan 2015 | ||||||||||||
| |||||||||||||
| Revision 3.5-65 | Sun 18 Jan 2015 | ||||||||||||
| |||||||||||||
| Revision 3.5-64 | Tue 13 Jan 2015 | ||||||||||||
| |||||||||||||
| Revision 3.5-63 | Mon 5 Jan 2015 | ||||||||||||
| |||||||||||||
| Revision 3.5-62 | Mon 5 Jan 2015 | ||||||||||||
| |||||||||||||
| Revision 3.5-61 | Sun 4 Jan 2015 | ||||||||||||
| |||||||||||||
| Revision 3.5-60 | Wed 31 Dec 2014 | ||||||||||||
| |||||||||||||
| Revision 3.5-59 | Mon 22 Dec 2014 | ||||||||||||
| |||||||||||||
| Revision 3.5-58 | Fri 19 Dec 2014 | ||||||||||||
| |||||||||||||
| Revision 3.5-57 | Fri 12 Dec 2014 | ||||||||||||
| |||||||||||||
| Revision 3.5-56 | Thu 11 Dec 2014 | ||||||||||||
| |||||||||||||
| Revision 3.5-55 | Thurs 11 Dec 2014 | ||||||||||||
| |||||||||||||
| Revision 3.5-54 | Thu 11 Dec 2014 | ||||||||||||
| |||||||||||||
| Revision 3.5-53 | Tue 9 Dec 2014 | ||||||||||||
| |||||||||||||
| Revision 3.5-52 | Mon 8 Dec 2014 | ||||||||||||
| |||||||||||||
| Revision 3.5-51 | Sun 7 Dec 2014 | ||||||||||||
| |||||||||||||
| Revision 3.5-50 | Mon 1 Dec 2014 | ||||||||||||
| |||||||||||||
| Revision 3.5-49 | Sun 30 Nov 2014 | ||||||||||||
| |||||||||||||
| Revision 3.5-48 | Tues 25 Nov 2014 | ||||||||||||
| |||||||||||||
| Revision 3.5-47 | Mon 24 Nov 2014 | ||||||||||||
| |||||||||||||
| Revision 3.5-46 | Thu 20 Nov 2014 | ||||||||||||
| |||||||||||||
| Revision 3.5-45 | Wed 19 Nov 2014 | ||||||||||||
| |||||||||||||
| Revision 3.5-44 | Tues 18 Nov 2014 | ||||||||||||
| |||||||||||||
| Revision 3.5-43 | Tues 18 Nov 2014 | ||||||||||||
| |||||||||||||
| Revision 3.5-42 | Sun 9 Nov 2014 | ||||||||||||
| |||||||||||||
| Revision 3.5-41 | Thu 6 Nov 2014 | ||||||||||||
| |||||||||||||
| Revision 3.5-40 | Wed 5 Nov 2014 | ||||||||||||
| |||||||||||||
| Revision 3.5-39 | Tue 04 Nov 2014 | ||||||||||||
| |||||||||||||
| Revision 3.5-38 | Tue 04 Nov 2014 | ||||||||||||
| |||||||||||||
| Revision 3.5-37 | Tue 04 Nov 2014 | ||||||||||||
| |||||||||||||
| Revision 3.5-36 | Thu 23 Oct 2014 | ||||||||||||
| |||||||||||||
| Revision 3.5-35 | Wed 22 Oct 2014 | ||||||||||||
| |||||||||||||
| Revision 3.5-34 | Wed 22 Oct 2014 | ||||||||||||
| |||||||||||||
| Revision 3.5-32 | Mon 20 Oct 2014 | ||||||||||||
| |||||||||||||
| Revision 3.5-31 | Mon 20 Oct 2014 | ||||||||||||
| |||||||||||||
| Revision 3.5-30 | Sun 19 Oct 2014 | ||||||||||||
| |||||||||||||
| Revision 3.5-29 | Fri 17 Oct 2014 | ||||||||||||
| |||||||||||||
| Revision 3.5-28 | Fri 10 Oct 2014 | ||||||||||||
| |||||||||||||
| Revision 3.5-27 | Thu 09 Oct 2014 | ||||||||||||
| |||||||||||||
| Revision 3.5-26 | Wed 08 Oct 2014 | ||||||||||||
| |||||||||||||
| Revision 3.5-25 | Tue 07 Oct 2014 | ||||||||||||
| |||||||||||||
| Revision 3.5-24 | Fri 03 Oct 2014 | ||||||||||||
| |||||||||||||
| Revision 3.5-23 | Thu 02 Oct 2014 | ||||||||||||
| |||||||||||||
| Revision 3.5-22 | Mon 29 Sep 2014 | ||||||||||||
| |||||||||||||
| Revision 3.5-21 | Mon 29 Sep 2014 | ||||||||||||
| |||||||||||||
| Revision 3.5-20 | Tue 23 Sep 2014 | ||||||||||||
| |||||||||||||
| Revision 3.5-19 | Fri 19 Sep 2014 | ||||||||||||
| |||||||||||||
| Revision 3.5-18 | Thu 18 Sep 2014 | ||||||||||||
| |||||||||||||
| Revision 3.5-17 | Thu 18 Sep 2014 | ||||||||||||
| |||||||||||||
| Revision 3.5-16 | Thu 11 Sep 2014 | ||||||||||||
| |||||||||||||
| Revision 3.5-15 | Tue 09 Sep 2014 | ||||||||||||
| |||||||||||||
| Revision 3.5-14 | Fri 29 Aug 2014 | ||||||||||||
| |||||||||||||
| Revision 3.5-13 | Fri 29 Aug 2014 | ||||||||||||
| |||||||||||||
| Revision 3.5-12 | Mon 25 Aug 2014 | ||||||||||||
| |||||||||||||
| Revision 3.5-11 | Mon 25 Aug 2014 | ||||||||||||
| |||||||||||||
| Revision 3.5-10 | Wed 20 Aug 2014 | ||||||||||||
| |||||||||||||
| Revision 3.5-9 | Wed 20 Aug 2014 | ||||||||||||
| |||||||||||||
| Revision 3.5-8 | Tue 19 Aug 2014 | ||||||||||||
| |||||||||||||
| Revision 3.5-7 | Mon 18 Aug 2014 | ||||||||||||
| |||||||||||||
| Revision 3.5-6 | Tue 05 Aug 2014 | ||||||||||||
| |||||||||||||
| Revision 3.5-5 | Tue 22 Jul 2014 | ||||||||||||
| |||||||||||||
| Revision 3.5-4 | Mon 30 Jun 2014 | ||||||||||||
| |||||||||||||
| Revision 3.5-3 | Thu 26 Jun 2014 | ||||||||||||
| |||||||||||||
| Revision 3.5-2 | Fri 6 Jun 2014 | ||||||||||||
| |||||||||||||
| Revision 3.5-1 | Thu 5 Jun 2014 | ||||||||||||
| |||||||||||||
































































































