| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (1.8.0_262-internal) on Thu Jun 04 16:40:08 GMT 2020 --> |
| <title>HypervisorMXBean (OpenJ9 Monitoring and Management Interface Classes)</title> |
| <meta name="date" content="2020-06-04"> |
| <meta name="keywords" content="com.ibm.virtualization.management.HypervisorMXBean interface"> |
| <meta name="keywords" content="isEnvironmentVirtual()"> |
| <meta name="keywords" content="getVendor()"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="HypervisorMXBean (OpenJ9 Monitoring and Management Interface Classes)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/HypervisorMXBean.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| <div class="aboutLanguage"><strong>OpenJ9 Monitoring and Management Interface Classes</strong></div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../com/ibm/virtualization/management/HypervisorInfoRetrievalException.html" title="class in com.ibm.virtualization.management"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?com/ibm/virtualization/management/HypervisorMXBean.html" target="_top">Frames</a></li> |
| <li><a href="HypervisorMXBean.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">com.ibm.virtualization.management</div> |
| <h2 title="Interface HypervisorMXBean" class="title">Interface HypervisorMXBean</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/management/PlatformManagedObject.html?is-external=true" target="_blank" title="class or interface in java.lang.management">PlatformManagedObject</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">HypervisorMXBean</span> |
| extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/management/PlatformManagedObject.html?is-external=true" target="_blank" title="class or interface in java.lang.management">PlatformManagedObject</a></pre> |
| <div class="block">This interface provides information on whether the current Operating System is running directly on physical hardware |
| or running as a Guest (Virtual Machine (VM)/Logical Partition (LPAR)) on top of a Hypervisor. |
| If the Operating System is running as a Guest, the interface provides information about the Hypervisor. |
| <b>Where there are multiple levels of Hypervisor, only the top level Hypervisor information is returned.</b> |
| The supported Hypervisors and the platforms on which they are supported: |
| <ol> |
| <li>Linux and Windows on VMWare. |
| <li>Linux and Windows on KVM. |
| <li>Windows on Hyper-V. |
| <li>AIX and Linux on PowerVM. |
| <li>Linux and z/OS on z/VM. |
| <li>Linux and z/OS on PR/SM. |
| </ol> |
| <p>On some hardware, Hypervisor detection might fail, even if the Hypervisor and Operating System combination |
| is supported. In this case you can set an Environment variable - IBM_JAVA_HYPERVISOR_SETTINGS that forces the |
| JVM to recognize the Hypervisor. |
| <ul> |
| <li>For example: On Windows to set the Hypervisor as VMWare,<br> |
| set IBM_JAVA_HYPERVISOR_SETTINGS="DefaultName=VMWare" |
| <li>Other valid Hypervisor name strings (case insensitive): |
| <ul> |
| <li>VMWare, Hyper-V, KVM, PowerVM, PR/SM, z/VM. |
| </ul> |
| <li>If the actual Hypervisor and the one provided through the Environment variable differ, the results are |
| indeterminate. |
| </ul> |
| <br> |
| <table border="1"> |
| <caption><b>Usage example for the <a href="../../../../com/ibm/virtualization/management/HypervisorMXBean.html" title="interface in com.ibm.virtualization.management"><code>HypervisorMXBean</code></a></b></caption> |
| <tr> <td> <pre> |
| <code> |
| ... |
| try { |
| mxbeanName = new ObjectName("com.ibm.virtualization.management:type=Hypervisor"); |
| } catch (MalformedObjectNameException e) { |
| // Exception Handling |
| } |
| try { |
| MBeanServer mbeanServer = ManagementFactory.getPlatformMBeanServer(); |
| if (true != mbeanServer.isRegistered(mxbeanName)) { |
| // HypervisorMXBean not registered |
| } |
| HypervisorMXBean hypBean = JMX.newMXBeanProxy(mbeanServer, mxbeanName, HypervisorMXBean.class); |
| } catch (Exception e) { |
| // Exception Handling |
| } |
| </code> |
| </pre></td></tr></table></div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.7.1</dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" target="_blank" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/ibm/virtualization/management/HypervisorMXBean.html#getVendor--">getVendor</a></span>()</code> |
| <div class="block">Returns the vendor of the Hypervisor if running in a virtualized environment.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/ibm/virtualization/management/HypervisorMXBean.html#isEnvironmentVirtual--">isEnvironmentVirtual</a></span>()</code> |
| <div class="block">Indicates if the Operating System is running on a Hypervisor or not.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.management.PlatformManagedObject"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface java.lang.management.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/management/PlatformManagedObject.html?is-external=true" target="_blank" title="class or interface in java.lang.management">PlatformManagedObject</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/management/PlatformManagedObject.html?is-external=true#getObjectName--" title="class or interface in java.lang.management">getObjectName</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="isEnvironmentVirtual--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isEnvironmentVirtual</h4> |
| <pre>boolean isEnvironmentVirtual() |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" target="_blank" title="class or interface in java.lang">UnsupportedOperationException</a>, |
| <a href="../../../../com/ibm/virtualization/management/HypervisorInfoRetrievalException.html" title="class in com.ibm.virtualization.management">HypervisorInfoRetrievalException</a></pre> |
| <div class="block">Indicates if the Operating System is running on a Hypervisor or not.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if running on a Hypervisor, false otherwise.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" target="_blank" title="class or interface in java.lang">UnsupportedOperationException</a></code> - if the underlying Hypervisor is unsupported.</dd> |
| <dd><code><a href="../../../../com/ibm/virtualization/management/HypervisorInfoRetrievalException.html" title="class in com.ibm.virtualization.management">HypervisorInfoRetrievalException</a></code> - if there is an error during Hypervisor detection.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getVendor--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getVendor</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" target="_blank" title="class or interface in java.lang">String</a> getVendor()</pre> |
| <div class="block">Returns the vendor of the Hypervisor if running in a virtualized environment.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>string identifying the vendor of the Hypervisor if running under |
| Hypervisor, null otherwise.</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/HypervisorMXBean.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| <div class="aboutLanguage"><strong>OpenJ9 Monitoring and Management Interface Classes</strong></div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../com/ibm/virtualization/management/HypervisorInfoRetrievalException.html" title="class in com.ibm.virtualization.management"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?com/ibm/virtualization/management/HypervisorMXBean.html" target="_top">Frames</a></li> |
| <li><a href="HypervisorMXBean.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small><a href="https://www.eclipse.org/openj9/" target="_blank">Eclipse OpenJ9 website.</a><br> To raise a bug report or suggest an improvement create an <a href="https://github.com/eclipse/openj9/issues" target="_blank">Eclipse OpenJ9 issue.</a><br> Copyright © 2001, 2020, IBM Corp. and others.</small></p> |
| </body> |
| </html> |