<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>Class: Deltacloud::Drivers::VSphere::VSphereDriver</title>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<meta http-equiv="Content-Script-Type" content="text/javascript" />
<link rel="stylesheet" href="../../../.././rdoc-style.css" type="text/css" media="screen" />
<script type="text/javascript">
// <![CDATA[
function popupCode( url ) {
window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
}
function toggleCode( id ) {
if ( document.getElementById )
elem = document.getElementById( id );
else if ( document.all )
elem = eval( "document.all." + id );
else
return false;
elemStyle = elem.style;
if ( elemStyle.display != "block" ) {
elemStyle.display = "block"
} else {
elemStyle.display = "none"
}
return true;
}
// Make codeblocks hidden by default
document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
// ]]>
</script>
</head>
<body>
<div id="classHeader">
<table class="header-table">
<tr class="top-aligned-row">
<td><strong>Class</strong></td>
<td class="class-name-in-header">Deltacloud::Drivers::VSphere::VSphereDriver</td>
</tr>
<tr class="top-aligned-row">
<td><strong>In:</strong></td>
<td>
<a href="../../../../files/lib/deltacloud/drivers/vsphere/vsphere_driver_rb.html">
lib/deltacloud/drivers/vsphere/vsphere_driver.rb
</a>
<br />
</td>
</tr>
<tr class="top-aligned-row">
<td><strong>Parent:</strong></td>
<td>
<a href="../../BaseDriver.html">
Deltacloud::BaseDriver
</a>
</td>
</tr>
</table>
</div>
<!-- banner header -->
<div id="bodyContent">
<div id="contextContent">
</div>
<div id="method-list">
<h3 class="section-bar">Methods</h3>
<div class="name-list">
<a href="#M000400">create_image</a>
<a href="#M000403">create_instance</a>
<a href="#M000408">destroy_image</a>
<a href="#M000407">destroy_instance</a>
<a href="#M000398">hardware_profiles</a>
<a href="#M000399">images</a>
<a href="#M000402">instances</a>
<a href="#M000401">realms</a>
<a href="#M000404">reboot_instance</a>
<a href="#M000405">start_instance</a>
<a href="#M000406">stop_instance</a>
<a href="#M000409">valid_credentials?</a>
</div>
</div>
</div>
<!-- if includes -->
<div id="includes">
<h3 class="section-bar">Included Modules</h3>
<div id="includes-list">
<span class="include-name"><a href="Helper.html">Deltacloud::Drivers::VSphere::Helper</a></span>
<span class="include-name">Deltacloud::Drivers::VSphere::FileManager</span>
</div>
</div>
<div id="section">
<!-- if method_list -->
<div id="methods">
<h3 class="section-bar">Public Instance methods</h3>
<div id="method-M000400" class="method-detail">
<a name="M000400"></a>
<div class="method-heading">
<a href="VSphereDriver.src/M000400.html" target="Code" class="method-signature"
onclick="popupCode('VSphereDriver.src/M000400.html');return false;">
<span class="method-name">create_image</span><span class="method-args">(credentials, opts={})</span>
</a>
</div>
<div class="method-description">
</div>
</div>
<div id="method-M000403" class="method-detail">
<a name="M000403"></a>
<div class="method-heading">
<a href="VSphereDriver.src/M000403.html" target="Code" class="method-signature"
onclick="popupCode('VSphereDriver.src/M000403.html');return false;">
<span class="method-name">create_instance</span><span class="method-args">(credentials, image_id, opts)</span>
</a>
</div>
<div class="method-description">
</div>
</div>
<div id="method-M000408" class="method-detail">
<a name="M000408"></a>
<div class="method-heading">
<span class="method-name">destroy_image</span><span class="method-args">(credentials, instance_id)</span>
</div>
<div class="method-description">
<p>
Alias for <a href="VSphereDriver.html#M000407">destroy_instance</a>
</p>
</div>
</div>
<div id="method-M000407" class="method-detail">
<a name="M000407"></a>
<div class="method-heading">
<a href="VSphereDriver.src/M000407.html" target="Code" class="method-signature"
onclick="popupCode('VSphereDriver.src/M000407.html');return false;">
<span class="method-name">destroy_instance</span><span class="method-args">(credentials, instance_id)</span>
</a>
</div>
<div class="method-description">
<p>
Destroy an instance, given its id. Note that this will destroy all instance
data.
</p>
<p>
If there is user-data dile asocciated with instance, remove this file as
well.
</p>
</div>
</div>
<div id="method-M000398" class="method-detail">
<a name="M000398"></a>
<div class="method-heading">
<a href="VSphereDriver.src/M000398.html" target="Code" class="method-signature"
onclick="popupCode('VSphereDriver.src/M000398.html');return false;">
<span class="method-name">hardware_profiles</span><span class="method-args">(credentials, opts={})</span>
</a>
</div>
<div class="method-description">
<p>
There is just one hardware profile where memory is measured using maximum
memory available on ESX for virtual machines and CPU using maximum free CPU
cores in ESX.
</p>
</div>
</div>
<div id="method-M000399" class="method-detail">
<a name="M000399"></a>
<div class="method-heading">
<a href="VSphereDriver.src/M000399.html" target="Code" class="method-signature"
onclick="popupCode('VSphereDriver.src/M000399.html');return false;">
<span class="method-name">images</span><span class="method-args">(credentials, opts=nil)</span>
</a>
</div>
<div class="method-description">
<p>
Images are virtual machines with ‘template’ flag set to be
true. Thus we‘re getting them using find_vm and list_virtual_machines
</p>
</div>
</div>
<div id="method-M000402" class="method-detail">
<a name="M000402"></a>
<div class="method-heading">
<a href="VSphereDriver.src/M000402.html" target="Code" class="method-signature"
onclick="popupCode('VSphereDriver.src/M000402.html');return false;">
<span class="method-name">instances</span><span class="method-args">(credentials, opts=nil)</span>
</a>
</div>
<div class="method-description">
<p>
List all running <a href="VSphereDriver.html#M000402">instances</a>, across
all datacenters. DeltaCloud API does not yet support filtering <a
href="VSphereDriver.html#M000402">instances</a> by realm.
</p>
</div>
</div>
<div id="method-M000401" class="method-detail">
<a name="M000401"></a>
<div class="method-heading">
<a href="VSphereDriver.src/M000401.html" target="Code" class="method-signature"
onclick="popupCode('VSphereDriver.src/M000401.html');return false;">
<span class="method-name">realms</span><span class="method-args">(credentials, opts=nil)</span>
</a>
</div>
<div class="method-description">
<p>
List all datacenters managed by the vSphere or vCenter entrypoint.
</p>
</div>
</div>
<div id="method-M000404" class="method-detail">
<a name="M000404"></a>
<div class="method-heading">
<a href="VSphereDriver.src/M000404.html" target="Code" class="method-signature"
onclick="popupCode('VSphereDriver.src/M000404.html');return false;">
<span class="method-name">reboot_instance</span><span class="method-args">(credentials, id)</span>
</a>
</div>
<div class="method-description">
<p>
Reboot an instance, given its id.
</p>
</div>
</div>
<div id="method-M000405" class="method-detail">
<a name="M000405"></a>
<div class="method-heading">
<a href="VSphereDriver.src/M000405.html" target="Code" class="method-signature"
onclick="popupCode('VSphereDriver.src/M000405.html');return false;">
<span class="method-name">start_instance</span><span class="method-args">(credentials, id)</span>
</a>
</div>
<div class="method-description">
<p>
Start an instance, given its id.
</p>
</div>
</div>
<div id="method-M000406" class="method-detail">
<a name="M000406"></a>
<div class="method-heading">
<a href="VSphereDriver.src/M000406.html" target="Code" class="method-signature"
onclick="popupCode('VSphereDriver.src/M000406.html');return false;">
<span class="method-name">stop_instance</span><span class="method-args">(credentials, id)</span>
</a>
</div>
<div class="method-description">
<p>
Stop an instance, given its id.
</p>
</div>
</div>
<div id="method-M000409" class="method-detail">
<a name="M000409"></a>
<div class="method-heading">
<a href="VSphereDriver.src/M000409.html" target="Code" class="method-signature"
onclick="popupCode('VSphereDriver.src/M000409.html');return false;">
<span class="method-name">valid_credentials?</span><span class="method-args">(credentials)</span>
</a>
</div>
<div class="method-description">
</div>
</div>
</div>
</div>
<div id="validator-badges">
<p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
</div>
</body>
</html>
