You are here

Download and Install the Oracle VM Manager Utilities

Applicable to all Oracle VM 3.x Releases. 
The Oracle VM utilities (My Oracle Support Patch 13602094) are an Oracle VM Manager add-on that provide a command line interface for Oracle VM Manager. The Oracle VM utilities allows Oracle VM Manager administrative tasks to be performed from the command line or executed using scripts, including virtual machine CPUs pinning using the ovm_vmcontrol utility.

The Oracle VM utilities consists of 2 seperate packages:

  • ovm_utils_1.0.2.zip for Oracle VM Release 3.0,3.1, and 3.2. The ovm_utils_1.0.2 package contains the base ovm_utils for Oracle VM 3.0,3.1, and 3.2.
  • ovm_utils_2.0.1.zip for Oracle VM Release 3.3 and up. The ovm_utils_2.0.1 package contains the Oracle VM Release 3.3 ovm_utils.
Tip: The Oracle VM utilities are a great command line alternative to Oracle VM Manager, as well as the Oracle VM Manager CLI, and offer exceptional performance over WAN connections when Oracle VM Manager is not an option.
 
The Oracle VM utilities are available as a patch download from My Oracle Support. The Oracle VM utilities should be installed on the Oracle VM Manager host. As of this writing the latest release is My Oracle Support patch 13602094 (p13602094_30_Linux-x86-64.zip). The p13602094_30_Linux-x86-64.zip file contains seven files:
  1. readme.txt
  2. ovmutils/
  3. ovmutils/ovm_utils_1.0.2.zip
  4. ovmutils/ovm_utils_2.0.1.zip
  5. ovmutils/readme
  6. ovmutils/readme-1.0.2
  7. ovmutils/readme-2.0.1
Tip: If a previous version of the Oracle VM utilities are already installed, Oracle recommends to delete the previous version before installing the new version., i.e.
# cd /u01/app/oracle/ovm-manager-3/
# rm -rf ./ovm_utils
 
Next, on the Oracle VM Manager host unzip the p13602094_30_Linux-x86-64.zip archive. The next examples shows how to unzip the p13602094_30_Linux-x86-64.zip archive as root. 

# unzip p13602094_30_Linux-x86-64.zip
Archive:  p13602094_30_Linux-x86-64.zip
  inflating: readme.txt              
   creating: ovmutils/
 extracting: ovmutils/ovm_utils_1.0.2.zip  
 extracting: ovmutils/ovm_utils_2.0.1.zip  
  inflating: ovmutils/readme         
  inflating: ovmutils/readme-1.0.2   
  inflating: ovmutils/readme-2.0.1 

Next, unzip the appoprate Oracle VM utilities package, ovmutils/ovm_utils_1.0.2.zip for Oracle VM Release 3.0,3.1 and 3.2, or ovmutils/ovm_utils_2.0.1.zip for Oracle VM Release 3.3 and up into the /u01/app/oracle/ovm-manager-3
directory. 
 
Oracle VM Release 3.3: Oracle VM Utilities Installation and Configuration
The next example shows how to extract the ovmutils/ovm_utils_2.0.1.zip file into the Oracle VM Manager home, /u01/app/oracle/ovm-manager-3.
 
As root, change into the directory where the p13602094_30_Linux-x86-64.zip archive was unzipped. Next, type the following command:
 
# unzip ovm_utils_2.0.1.zip -d /u01/app/oracle/ovm-manager-3/
Archive:  ovm_utils_2.0.1.zip
   creating: /u01/app/oracle/ovm-manager-3/ovm_utils/
   creating: /u01/app/oracle/ovm-manager-3/ovm_utils/man/
   creating: /u01/app/oracle/ovm-manager-3/ovm_utils/man/man8/
  inflating: /u01/app/oracle/ovm-manager-3/ovm_utils/man/man8/ovm_vmcontrol.8  
  inflating: /u01/app/oracle/ovm-manager-3/ovm_utils/man/man8/ovm_vmhostd.8  
  inflating: /u01/app/oracle/ovm-manager-3/ovm_utils/man/man8/ovm_vmdisks.8  
  inflating: /u01/app/oracle/ovm-manager-3/ovm_utils/man/man8/ovm_reporestore.8  
  inflating: /u01/app/oracle/ovm-manager-3/ovm_utils/man/man8/ovm_vmmessage.8  
  inflating: /u01/app/oracle/ovm-manager-3/ovm_utils/ovm_vmdisks  
   creating: /u01/app/oracle/ovm-manager-3/ovm_utils/class/
  inflating: /u01/app/oracle/ovm-manager-3/ovm_utils/class/OvmVmMessage.class  
  inflating: /u01/app/oracle/ovm-manager-3/ovm_utils/class/OvmRepoRestore.class  
  inflating: /u01/app/oracle/ovm-manager-3/ovm_utils/class/OvmVmHostd.class  
  inflating: /u01/app/oracle/ovm-manager-3/ovm_utils/class/OvmVmMessage$1.class  
  inflating: /u01/app/oracle/ovm-manager-3/ovm_utils/class/OvmVmHostd$1.class  
  inflating: /u01/app/oracle/ovm-manager-3/ovm_utils/class/OvmVmControl.class  
  inflating: /u01/app/oracle/ovm-manager-3/ovm_utils/class/OvmVmHostd$InsecureTrustManager.class  
  inflating: /u01/app/oracle/ovm-manager-3/ovm_utils/class/OvmVmDisks.class  
  inflating: /u01/app/oracle/ovm-manager-3/ovm_utils/class/OvmVmMessage$InsecureTrustManager.class  
  inflating: /u01/app/oracle/ovm-manager-3/ovm_utils/ovm_vmcontrol  
  inflating: /u01/app/oracle/ovm-manager-3/ovm_utils/ovm_vmhostd  
  inflating: /u01/app/oracle/ovm-manager-3/ovm_utils/vm-dump-metrics  
  inflating: /u01/app/oracle/ovm-manager-3/ovm_utils/ovm_reporestore  
   creating: /u01/app/oracle/ovm-manager-3/ovm_utils/lib/
  inflating: /u01/app/oracle/ovm-manager-3/ovm_utils/lib/jython.jar  
  inflating: /u01/app/oracle/ovm-manager-3/ovm_utils/lib/log4j.jar  
  inflating: /u01/app/oracle/ovm-manager-3/ovm_utils/lib/OvmClient.jar  
  inflating: /u01/app/oracle/ovm-manager-3/ovm_utils/lib/OvmWsClient.jar  
  inflating: /u01/app/oracle/ovm-manager-3/ovm_utils/lib/ovm_shell.jar  
  inflating: /u01/app/oracle/ovm-manager-3/ovm_utils/lib/commons-logging-1.1.3.jar  
  inflating: /u01/app/oracle/ovm-manager-3/ovm_utils/lib/jline.jar  
  inflating: /u01/app/oracle/ovm-manager-3/ovm_utils/lib/commons-logging.jar  
  inflating: /u01/app/oracle/ovm-manager-3/ovm_utils/ovm_vmmessage
 

The man pages for the Oracle VM utilities are in the ovm_utils/man/man8 directory. Since the Oracle VM utilities man pages are not in the default man path, it is necessary to type "man path_to_man_page to read each man page. 

Starting with Oracle VM Release 3.3, Oracle VM Manager must use TCP over SSH (TCPS) to run the Oracle VM utilities.   
 
The next example shows how to enable TCP over SSH on an Oracle VM Manager host. As root, type the following commands, when prompted enter the keystore password (save this password!), your first and last name, the name of your organizational unit, the name of your organization, the name of your State or Province, your two-letter country code and the keystore password.
 
Tip: Use the same password as the admin account for the keystore password.
 
# cd /u01/app/oracle/ovm-manager-3/bin
# ./secureOvmmTcpGenKeyStore.sh

Generate OVMM TCP over SSH key store by following steps:
Enter keystore password: password
Re-enter new password: password
What is your first and last name?
[Unknown]:  name     
What is the name of your organizational unit?
[Unknown]:  unit       
What is the name of your organization?
[Unknown]:  organization
What is the name of your City or Locality?
[Unknown]:  City
What is the name of your State or Province?
[Unknown]:  State
What is the two-letter country code for this unit?
[Unknown]:  country_code
Is CN=name, OU=unit, O=organization, L=City, ST=State, C=country_code correct?
[no]:  yes

Enter key password for <ovmm>
Re-enter new password: password
 
Next, enable the keystore using the secureOvmmTcp.sh script located in the same directory as the secureOvmmTcpGenKeyStore.sh script. As root, type the following command, when prompted enter the OVM manager user name (admin), the OVM manager user password, and the password for TCPS keystore (the keystore password that was entered 2x above):

# ./secureOvmmTcp.sh

Enabling OVMM TCP over SSH service
Please enter the OVM manager user name: username
Please enter the OVM manager user password: password
Please enter the password for TCPS key store : password
The job of enabling OVMM TCPS service is committed, please restart OVMM to take effect.
 
After successfully running the secureOvmmTcpGenKeyStore.sh and secureOvmmTcp.sh scripts, the Oracle VM Manager keystore file namedovmmCoreTcps.ks is created in the <OVM_MANAGER_HOME> directory, i.e. /u01/app/oracle/ovm-manager-3/ovmmCoreTcps.ks.
 
Before restarting Oracle VM Manager and enableding the TCP over SSH service, the Core API will be listening on 127.0.0.1/localhost tcp 54321. After restarting Oracle VM Manager, the Core API will be listening on tcps 54322 using the FQDN.
 
To verify the listening port, as root, type:
For tpc localhost:
# netstat -a | grep  54321
For tcps with FQDN:
# netstat -a | grep  54322
 
Next, restart Oracle VM Manager. As root, type:
# /sbin/service ovmm stop
# /sbin/service ovmm start
 
To verify the TCP over SSH service is running, as root type:
# netstat -a | grep  54322
tcp        0      0 *:54322                     *:*                         LISTEN
 
The above example shows that the TCP over SSH service is indeed running and listening on port 54322.
 
Oracle VM Release 3.0,3.1 and 3.2Oracle VM Utilities Installation and Configuration
The next example shows how to extract the ovmutils/ovm_utils_1.0.2.zip file into the Oracle VM Manager home, /u01/app/oracle/ovm-manager-3.
 
As root, change into the directory where the p13602094_30_Linux-x86-64.zip archive was unzipped. Next, type the following command:
# unzip ovmutils/ovm_utils_1.0.2.zip -d /u01/app/oracle/ovm-manager-3

Archive:  ovmutils/ovm_utils_1.0.2.zip
replace /u01/app/oracle/ovm-manager-3/ovm_utils/man/man8/ovm_vmcontrol.8? [y]es, [n]o, [A]ll, [N]one, [r]ename: y
  inflating: /u01/app/oracle/ovm-manager-3/ovm_utils/man/man8/ovm_vmcontrol.8  
replace /u01/app/oracle/ovm-manager-3/ovm_utils/man/man8/ovm_vmhostd.8? [y]es, [n]o, [A]ll, [N]one, [r]ename: A
  inflating: /u01/app/oracle/ovm-manager-3/ovm_utils/man/man8/ovm_vmhostd.8  
  inflating: /u01/app/oracle/ovm-manager-3/ovm_utils/man/man8/ovm_logger.8  
  inflating: /u01/app/oracle/ovm-manager-3/ovm_utils/man/man8/ovm_vmdisks.8  
  inflating: /u01/app/oracle/ovm-manager-3/ovm_utils/man/man8/ovm_reporestore.8  
  inflating: /u01/app/oracle/ovm-manager-3/ovm_utils/man/man8/ovm_poolcontrol.8  
  inflating: /u01/app/oracle/ovm-manager-3/ovm_utils/man/man8/ovm_managercontrol.8  
  inflating: /u01/app/oracle/ovm-manager-3/ovm_utils/man/man8/ovm_vmmessage.8  
  inflating: /u01/app/oracle/ovm-manager-3/ovm_utils/man/man8/ovm_servercontrol.8  
  inflating: /u01/app/oracle/ovm-manager-3/ovm_utils/man/man8/ovm_repocontrol.8  
  inflating: /u01/app/oracle/ovm-manager-3/ovm_utils/ovm_logger  
  inflating: /u01/app/oracle/ovm-manager-3/ovm_utils/ovm_repocontrol  
  inflating: /u01/app/oracle/ovm-manager-3/ovm_utils/ovm_vmdisks  
  inflating: /u01/app/oracle/ovm-manager-3/ovm_utils/class/OvmVmMessage.class  
  inflating: /u01/app/oracle/ovm-manager-3/ovm_utils/class/OvmLogger.class  
  inflating: /u01/app/oracle/ovm-manager-3/ovm_utils/class/OvmRepoRestore.class  
  inflating: /u01/app/oracle/ovm-manager-3/ovm_utils/class/OvmVmHostd.class  
  inflating: /u01/app/oracle/ovm-manager-3/ovm_utils/class/OvmRepoControl.class  
  inflating: /u01/app/oracle/ovm-manager-3/ovm_utils/class/OvmVmControl.class  
  inflating: /u01/app/oracle/ovm-manager-3/ovm_utils/class/OvmVmDisks.class  
  inflating: /u01/app/oracle/ovm-manager-3/ovm_utils/class/OvmServerControl.class  
  inflating: /u01/app/oracle/ovm-manager-3/ovm_utils/class/OvmCoreControl.class  
  inflating: /u01/app/oracle/ovm-manager-3/ovm_utils/class/OvmPoolControl.class  
  inflating: /u01/app/oracle/ovm-manager-3/ovm_utils/ovm_vmcontrol  
  inflating: /u01/app/oracle/ovm-manager-3/ovm_utils/ovm_managercontrol  
  inflating: /u01/app/oracle/ovm-manager-3/ovm_utils/ovm_vmhostd  
  inflating: /u01/app/oracle/ovm-manager-3/ovm_utils/vm-dump-metrics  
  inflating: /u01/app/oracle/ovm-manager-3/ovm_utils/ovm_reporestore  
  inflating: /u01/app/oracle/ovm-manager-3/ovm_utils/lib/log4j.jar  
  inflating: /u01/app/oracle/ovm-manager-3/ovm_utils/lib/OvmClient.jar  
  inflating: /u01/app/oracle/ovm-manager-3/ovm_utils/lib/commons-logging.jar  
  inflating: /u01/app/oracle/ovm-manager-3/ovm_utils/ovm_servercontrol  
  inflating: /u01/app/oracle/ovm-manager-3/ovm_utils/ovm_poolcontrol  
  inflating: /u01/app/oracle/ovm-manager-3/ovm_utils/ovm_vmmessage

 
The man pages for the Oracle VM utilities are in the ovm_utils/man/man8 directory. Since the Oracle VM utilities man pages are not in the default man path, it is necessary to type "man path_to_man_page to read each man page. 

Download PDF Now!