blob: e4445d9290f04fc044421f6c961341438275f61c [file] [log] [blame]
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>CIMI Resource Collections - Machine Configuration</title>
<!-- Le HTML5 shim, for IE6-8 support of HTML elements -->
<!--[if lt IE 9]>
<script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<!-- Le JavaScript -->
<script src="/assets/js/jquery-1.7.1.min.js" type="text/javascript"></script>
<script src="/assets/js/bootstrap-dropdown.js" type="text/javascript"></script>
<script src="/assets/js/jquery.tweet.js" type="text/javascript"></script>
<script src="/assets/js/application.js" type="text/javascript"></script>
<script src="/assets/js/bootstrap-transition.js"></script>
<script src="/assets/js/bootstrap-alert.js"></script>
<script src="/assets/js/bootstrap-modal.js"></script>
<script src="/assets/js/bootstrap-scrollspy.js"></script>
<script src="/assets/js/bootstrap-tab.js"></script>
<script src="/assets/js/bootstrap-tooltip.js"></script>
<script src="/assets/js/bootstrap-popover.js"></script>
<script src="/assets/js/bootstrap-button.js"></script>
<script src="/assets/js/bootstrap-collapse.js"></script>
<script src="/assets/js/bootstrap-carousel.js"></script>
<script src="/assets/js/bootstrap-typeahead.js"></script>
<!-- Le styles -->
<link href="/assets/css/bootstrap.css" rel="stylesheet">
<link href="/assets/css/application.css" rel="stylesheet">
<link rel="shortcut icon" href="/assets/img/favicon.ico">
</head>
<body><div style="background: red"><h1>2015/07/20 - Apache Deltacloud has been retired. </h1><h2>For more information, please explore the <a href="http://attic.apache.org/">Attic</a>. </h2></div>
<div class="navbar navbar-fixed-top">
<div class="navbar-inner">
<div class="container">
<a class="brand" href="/"><img src="/assets/img/logo.png" width="152"
alt="Deltacloud API"/></a>
<ul class="nav top-nav">
<li><a href="/">Home</a></li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">About<b class="caret"></b></a>
<ul class="dropdown-menu">
<li><a href="/about.html">What is Deltacloud?</a></li>
<li><a href="/drivers.html#drivers">Supported Providers</a></li>
</ul>
</li>
<li><a href="/download.html">Download</a></li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Installation<b class="caret"></b></a>
<ul class="dropdown-menu">
<li><a href="/install-deltacloud.html">Install Deltacloud</a></li>
<li><a href="/run-deltacloud-server.html">Run the Deltacloud Server</a></li>
</ul>
</li>
<li class="dropdown">
<a href="/usage.html" class="dropdown-toggle" data-toggle="dropdown">Usage<b class="caret"></b></a>
<ul class="dropdown-menu">
<li><a href="/usage.html#usingapi">Using API</a></li>
<li><a href="/usage.html#clients">Client Libraries</a></li>
<li><a href="/command-tools.html">Command Line Tools</a></li>
</ul>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Contribute<b class="caret"></b></a>
<ul class="dropdown-menu">
<li><a href="/getting-sources.html">Getting Sources</a></li>
<li><a href="/how-to-contribute.html">How Can I Contribute?</a></li>
</ul>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">API<b class="caret"></b></a>
<ul class="dropdown-menu">
<li><a href="/rest-api.html">Deltacloud REST API</a></li>
<li><a href="/curl-examples.html">Deltacloud API cURL examples</a></li>
<li><a href="/drivers.html">Drivers API</a></li>
</ul>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">CIMI<b class="caret"></b></a>
<ul class="dropdown-menu">
<li><a href="/cimi-rest.html">CIMI REST API</a></li>
<li><a href="/cimi-curl.html">CIMI cURL Examples</a></li>
</ul>
</li>
<li><a href="/contact.html">Contact</a></li>
</ul>
</div>
</div>
</div>
<div class="container content">
<p><br></p>
<div class="row">
<div class="span9">
<h3 id="cimi-machine-config">Machine Configuration</h3>
<p>
<strong><em>
The Machine Configuration resource represents the set of configuration values that define the (virtual)
hardware resources of a to-be-realized Machine Instance. Machine Configurations are created by
Providers and may, at the Providers discretion, be created by Consumers.
A Machine Configuration Collection resource represents the collection of Machine Configuration
resources within a Provider
</em></strong>
</p>
</div>
<div class="span3">
<ul class="nav nav-list well">
<li class="nav-header">
CIMI REST API
</li>
<li><a href="../cimi-rest.html">Introduction</a></li>
<li><a href="cimi-rest-entry-point.html">Cloud Entry Point</a></li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">
CIMI Resources
<b class="caret"></b>
</a>
<ul class="dropdown-menu">
<li><a href="cimi-rest-resource-metadata.html">ResourceMetadata</a></li>
<li><a href="cimi-rest-collections.html">Machine</a></li>
<li><a href="cimi-rest-volumes.html">Volume</a></li>
</ul>
</li>
<hr>
<li class="nav-header">
Machine Resources
</li>
<ul class="nav nav-list">
<li><a href="cimi-rest-collections.html">Machine</a></li>
<li><a href="cimi-rest-machine-images.html">MachineImage</a></li>
<li class="active"><a href="cimi-rest-machine-configs.html">MachineConfiguration</a></li>
<li><a href="cimi-rest-machine-templates.html">MachineTemplate</a></li>
</ul>
</ul>
</div>
</div>
<ul class="nav nav-pills">
<li class="active"><a href="#config-collection" data-toggle="tab">Retrieve the Machine Configuration Collection</a></li>
<li><a href="#single-config" data-toggle="tab">Retrieve a single Machine Configuration</a></li>
</ul>
<hr>
<div class="tab-content">
<div class="tab-pane active" id="config-collection">
<h4>Retrieve the Machine Configuration Collection</h4>
<p>Example request:</p>
<pre>
GET /cimi/machine_configurations HTTP/1.1
Authorization: Basic bW9ja3VzZXI6bW9ja3Bhc3N3b3Jk
User-Agent: curl/7.24.0 (i686-redhat-linux-gnu)
Host: localhost:3001
Accept: application/xml
</pre>
<p>Server response:</p>
<pre>
HTTP/1.1 200 OK
Content-Type: application/xml
CIMI-Specification-Version: 1.0.1
Content-Length: 1504
ETag: 69348a8afa58a1c35b6cfad7c4066a9e
Cache-Control: max-age=0, private, must-revalidate
Date: Wed, 02 Jan 2013 14:12:23 GMT
Connection: keep-alive
Server: thin 1.5.0 codename Knife
&lt;Collection xmlns="http://schemas.dmtf.org/cimi/1"
resourceURI="http://schemas.dmtf.org/cimi/1/MachineConfigurationCollection"&gt;
&lt;id&gt;http://localhost:3001/cimi/machine_configurations&lt;/id&gt;
&lt;count&gt;3&lt;/count&gt;
&lt;MachineConfiguration&gt;
&lt;id&gt;http://localhost:3001/cimi/machine_configurations/m1-small&lt;/id&gt;
&lt;name&gt;m1-small&lt;/name&gt;
&lt;description&gt;Machine Configuration with 1782579 KiB of memory and 1 CPU&lt;/description&gt;
&lt;created&gt;2013-01-02T16:12:23+02:00&lt;/created&gt;
&lt;cpu&gt;1&lt;/cpu&gt;
&lt;memory&gt;1782579&lt;/memory&gt;
&lt;disk&gt;
&lt;capacity&gt;167772160&lt;/capacity&gt;
&lt;format&gt;unknown&lt;/format&gt;
&lt;/disk&gt;
&lt;/MachineConfiguration&gt;
&lt;MachineConfiguration&gt;
&lt;id&gt;http://localhost:3001/cimi/machine_configurations/m1-large&lt;/id&gt;
&lt;name&gt;m1-large&lt;/name&gt;
&lt;description&gt;Machine Configuration with 10485760 KiB of memory and 1 CPU&lt;/description&gt;
&lt;created&gt;2013-01-02T16:12:23+02:00&lt;/created&gt;
&lt;cpu&gt;1&lt;/cpu&gt;
&lt;memory&gt;10485760&lt;/memory&gt;
&lt;disk&gt;
&lt;capacity&gt;891289600&lt;/capacity&gt;
&lt;format&gt;unknown&lt;/format&gt;
&lt;/disk&gt;
&lt;/MachineConfiguration&gt;
&lt;MachineConfiguration&gt;
&lt;id&gt;http://localhost:3001/cimi/machine_configurations/m1-xlarge&lt;/id&gt;
&lt;name&gt;m1-xlarge&lt;/name&gt;
&lt;description&gt;Machine Configuration with 12582912 KiB of memory and 4 CPU&lt;/description&gt;
&lt;created&gt;2013-01-02T16:12:23+02:00&lt;/created&gt;
&lt;cpu&gt;4&lt;/cpu&gt;
&lt;memory&gt;12582912&lt;/memory&gt;
&lt;disk&gt;
&lt;capacity&gt;1073741824&lt;/capacity&gt;
&lt;format&gt;unknown&lt;/format&gt;
&lt;/disk&gt;
&lt;/MachineConfiguration&gt;
&lt;/Collection&gt;
</pre>
</div>
<div class="tab-pane" id="single-config">
<h4>Retrieve a single Machine Configuration</h4>
<p>Example request:</p>
<pre>
GET /cimi/machine_configurations/m1-large HTTP/1.1
Authorization: Basic bW9ja3VzZXI6bW9ja3Bhc3N3b3Jk
User-Agent: curl/7.24.0 (i686-redhat-linux-gnu)
Host: localhost:3001
Accept: application/xml
</pre>
<p>Server response:</p>
<pre>
HTTP/1.1 200 OK
Content-Type: application/xml
CIMI-Specification-Version: 1.0.1
Content-Length: 508
ETag: 33c094bbcec51437860280fd053f1023
Cache-Control: max-age=0, private, must-revalidate
Date: Wed, 02 Jan 2013 14:20:52 GMT
Connection: keep-alive
Server: thin 1.5.0 codename Knife
&lt;MachineConfiguration xmlns="http://schemas.dmtf.org/cimi/1"
resourceURI="http://schemas.dmtf.org/cimi/1/MachineConfiguration"&gt;
&lt;id&gt;http://localhost:3001/cimi/machine_configurations/m1-large&lt;/id&gt;
&lt;name&gt;m1-large&lt;/name&gt;
&lt;description&gt;Machine Configuration with 10485760 KiB of memory and 1 CPU&lt;/description&gt;
&lt;created&gt;2013-01-02T16:20:52+02:00&lt;/created&gt;
&lt;cpu&gt;1&lt;/cpu&gt;
&lt;memory&gt;10485760&lt;/memory&gt;
&lt;disk&gt;
&lt;capacity&gt;891289600&lt;/capacity&gt;
&lt;format&gt;unknown&lt;/format&gt;
&lt;/disk&gt;
&lt;/MachineConfiguration&gt;
</pre>
</div>
</div>
<footer class="footer">
<p class="pull-right"><span class='icon-circle-arrow-up'>&nbsp;</span><a href="#">Back to top</a></p>
<div class='row'>
<div class='span3'>
<img src="/assets/img/asf.png" alt="Apache Software Foundation"/>
</div>
<div class='span9'>
<strong>Apache Deltacloud</strong> is a top-level project at the <a
href="http://www.apache.org">Apache Software Foundation</a>,
having graduated from the ASF Incubator in October
2011. Through a collaborative and meritocratic development process, Apache
projects deliver enterprise-grade, freely available software products that
attract large communities of users.
</div>
</div>
</footer>
</div> <!-- /container -->
<!-- Piwik -->
<script type="text/javascript">
var pkBaseURL = (("https:" == document.location.protocol) ? "https://stats.salasaga.org/aeolus/piwik/" : "http://stats.salasaga.org/aeolus/piwik/");
document.write(unescape("%3Cscript src='" + pkBaseURL + "piwik.js' type='text/javascript'%3E%3C/script%3E"));
</script><script type="text/javascript">
try {
var piwikTracker = Piwik.getTracker(pkBaseURL + "piwik.php", 2);
piwikTracker.trackPageView();
piwikTracker.enableLinkTracking();
} catch( err ) {}
</script><noscript><p><img src="http://stats.salasaga.org/aeolus/piwik/piwik.php?idsite=2" style="border:0" alt="" /></p></noscript>
<!-- End Piwik Tracking Code -->
</body>
</html>