| <!DOCTYPE html> |
| <html lang="en"> |
| <head> |
| <meta charset="utf-8"> |
| <title>CIMI Resource Collections - Machine Template</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-template">Machine Template</h3> |
| <p> |
| <strong><em> |
| A Machine Template represents the set of metadata and instructions used in the creation of a Machine. |
| |
| A Machine Template Collection resource represents the collection of Machine Template resources within |
| a Provider. |
| </em></strong> |
| </p> |
| |
| <p> |
| The CIMI specification follows a distinctive pattern with respect to creation of new resources - the machine template is a good example of this: |
| </p> |
| |
| <pre> |
| machineConfiguration + machineImage = machineTemplate ===> machine |
| </pre> |
| |
| <p> |
| A CIMI client (a <strong>consumer</strong> in CIMI terminology) uses a Machine Template to <a href="cimi-rest-collections.html#create-machine"> create a new Machine</a>; a Machine Template consists of (amongst other attributes) a Machine Configuration and a Machine Image. Generally speaking - many CIMI resources require the use of a template for their creation and a template will typically consist of an image plus a configuration resource. |
| </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><a href="cimi-rest-machine-configs.html">MachineConfiguration</a></li> |
| <li class="active"><a href="cimi-rest-machine-templates.html">MachineTemplate</a></li> |
| </ul> |
| |
| </ul> |
| |
| </div> |
| |
| </div> |
| |
| <ul class="nav nav-pills"> |
| <li class="active"><a href="#template-collection" data-toggle="tab">Retrieve the Machine Template Collection</a></li> |
| <li><a href="#single-template" data-toggle="tab">Retrieve a single Machine Template</a></li> |
| <li><a href="#create-template" data-toggle="tab">Create a new Machine Template</a></li> |
| <li><a href="#delete-template" data-toggle="tab">Delete a Machine Template</a></li> |
| </ul> |
| |
| <hr> |
| |
| <div class="tab-content"> |
| <div class="tab-pane active" id="template-collection"> |
| |
| <h4>Retrieve the Machine Template Collection</h4> |
| <p>Example request:</p> |
| <pre> |
| GET /cimi/machine_templates 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: 1275 |
| ETag: fba471ae32eca2b58fa02644b81b73aa |
| Cache-Control: max-age=0, private, must-revalidate |
| Date: Thu, 03 Jan 2013 15:04:26 GMT |
| Connection: keep-alive |
| Server: thin 1.5.0 codename Knife |
| |
| <Collection xmlns="http://schemas.dmtf.org/cimi/1" |
| resourceURI="http://schemas.dmtf.org/cimi/1/MachineTemplateCollection"> |
| <id>http://localhost:3001/cimi/machine_templates</id> |
| <count>2</count> |
| <MachineTemplate> |
| <id>http://localhost:3001/cimi/machine_templates/1</id> |
| <name>myXmlTestMachineTemplate1</name> |
| <description>Description of my MachineTemplate</description> |
| <property key="test">value</property> |
| <machineConfig href="http://localhost:3001/cimi/machine_configurations/m1-xlarge" /> |
| <machineImage href="http://localhost:3001/cimi/machine_images/img3" /> |
| <operation rel="http://schemas.dmtf.org/cimi/1/action/delete" |
| href="http://localhost:3001/cimi/machine_templates/1" /> |
| </MachineTemplate> |
| <MachineTemplate> |
| <id>http://localhost:3001/cimi/machine_templates/2</id> |
| <name>my_template_2</name> |
| <description>Description of my MachineTemplate</description> |
| <property key="test">value</property> |
| <machineConfig href="http://localhost:3001/cimi/machine_configurations/m1-small" /> |
| <machineImage href="http://localhost:3001/cimi/machine_images/img1" /> |
| <operation rel="http://schemas.dmtf.org/cimi/1/action/delete" |
| href="http://localhost:3001/cimi/machine_templates/2" /> |
| </MachineTemplate> |
| </Collection> |
| </pre> |
| </div> |
| |
| <div class="tab-pane" id="single-template"> |
| |
| <h4>Retrieve a single Machine Template</h4> |
| <p>Example request:</p> |
| <pre> |
| GET /cimi/machine_templates/2 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: 607 |
| ETag: 8f720ffacb6439a6920a5f5b0ec7bbfc |
| Cache-Control: max-age=0, private, must-revalidate |
| Date: Thu, 03 Jan 2013 15:06:14 GMT |
| Connection: keep-alive |
| Server: thin 1.5.0 codename Knife |
| |
| <MachineTemplate xmlns="http://schemas.dmtf.org/cimi/1" |
| resourceURI="http://schemas.dmtf.org/cimi/1/MachineTemplate"> |
| <id>http://localhost:3001/cimi/machine_templates/2</id> |
| <name>my_template_2</name> |
| <description>Description of my MachineTemplate</description> |
| <property key="test">value</property> |
| <machineConfig href="http://localhost:3001/cimi/machine_configurations/m1-small" /> |
| <machineImage href="http://localhost:3001/cimi/machine_images/img1" /> |
| <operation rel="http://schemas.dmtf.org/cimi/1/action/delete" |
| href="http://localhost:3001/cimi/machine_templates/2" /> |
| </MachineTemplate> |
| </pre> |
| </div> |
| |
| <div class="tab-pane" id="create-template"> |
| |
| <h4>Create a new Machine Template</h4> |
| <p>Example request:</p> |
| <pre> |
| POST /cimi/machine_templates HTTP/1.1 |
| Authorization: Basic bW9ja3VzZXI6bW9ja3Bhc3N3b3Jk |
| User-Agent: curl/7.24.0 (i686-redhat-linux-gnu) |
| Host: localhost:3001 |
| Content-Type: application/xml |
| Accept: application/xml |
| Content-Length: 334 |
| |
| <MachineTemplateCreate> |
| <name>myXmlTestMachineTemplate1</name> |
| <description>Description of my MachineTemplate</description> |
| <property key="test">value</property> |
| <machineConfig href="http://localhost:3001/cimi/machine_configurations/m1-xlarge"/> |
| <machineImage href="http://localhost:3001/cimi/machine_images/img3"/> |
| </MachineTemplateCreate> |
| </pre> |
| |
| <p>Server response:</p> |
| <pre> |
| HTTP/1.1 201 Created |
| Content-Type: application/xml |
| Location: http://localhost:3001/cimi/machine_templates/1 |
| CIMI-Specification-Version: 1.0.1 |
| Content-Length: 620 |
| ETag: e848e33fa0886e6c3d2df3cb674485d7 |
| Cache-Control: max-age=0, private, must-revalidate |
| Date: Thu, 03 Jan 2013 14:48:03 GMT |
| Connection: keep-alive |
| Server: thin 1.5.0 codename Knife |
| |
| <MachineTemplate xmlns="http://schemas.dmtf.org/cimi/1" resourceURI="http://schemas.dmtf.org/cimi/1/MachineTemplate"> |
| <id>http://localhost:3001/cimi/machine_templates/1</id> |
| <name>myXmlTestMachineTemplate1</name> |
| <description>Description of my MachineTemplate</description> |
| <property key="test">value</property> |
| <machineConfig href="http://localhost:3001/cimi/machine_configurations/m1-xlarge" /> |
| <machineImage href="http://localhost:3001/cimi/machine_images/img3" /> |
| <operation rel="http://schemas.dmtf.org/cimi/1/action/delete" href="http://localhost:3001/cimi/machine_templates/1" /> |
| </MachineTemplate> |
| |
| </pre> |
| </div> |
| |
| <div class="tab-pane" id="delete-template"> |
| |
| <h4>Delete a Machine Template</h4> |
| <p>Example request:</p> |
| <pre> |
| DELETE /cimi/machine_templates/2 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 |
| X-Frame-Options: SAMEORIGIN |
| X-XSS-Protection: 1; mode=block |
| X-Content-Type-Options: nosniff |
| Content-Type: text/html;charset=utf-8 |
| CIMI-Specification-Version: 1.0.1 |
| Content-Length: 0 |
| Date: Thu, 03 Jan 2013 15:06:38 GMT |
| Connection: keep-alive |
| Server: thin 1.5.0 codename Knife |
| </pre> |
| </div> |
| </div> |
| |
| |
| <footer class="footer"> |
| <p class="pull-right"><span class='icon-circle-arrow-up'> </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> |
