site/output/ruby.html - deltacloud - Git at Google

 <!DOCTYPE html>
 <html lang="en">
   <head>
     <meta charset="utf-8">
     <title>The Deltacloud Ruby Client</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>

     <!-- 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 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="/supported-providers.html">Supported Providers</a></li>
     </ul>
   </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">Clients</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="/how-to-contribute.html">How Can I Contribute?</a></li>
       <li><a href="/getting-sources.html">Getting the Sources</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">REST API</a></li>
       <li><a href="/drivers.html">Drivers API</a></li>
     </ul>
   </li>
   <li><a href="/contact.html">Contact</a></li>
 </ul>

         </div>
       </div>

     </div>

     <div class="container">

       <p><br></p>

 <p>Installing the Deltacloud client also gives you the <strong>deltacloudc</strong> command line tool. This executable makes use of the Deltacloud client library to speak to the Deltacloud server using the <a href="rest-api.html">REST API</a>. This allows you to to control your IAAS cloud infrastructure from the command line. If you are familiar with linux scripting, you can knock up a bash script in no time to automate your cloud infrastructure tasks.The general usage pattern for deltacloudc is:</p><p>

 </p><pre>$ deltacloudc collection operation [options]</pre>

 <dl class="dl-horizontal">
 <dt><h6>collection</h6></dt>
   <dd>
   refers to the Deltacloud object collections, such as Instances, Images, Buckets, Realms etc, as described in greater detail in the REST API
   </dd>
   <dt><h6>operation</h6></dt>
   <dd>nanoc
   is collection dependant. All collections respond to 'index' and 'show' operations (retrieve details on all objects in a given collection or on a specific object, respectively); some collections respond to 'create' and 'destroy' operations. The instances collection (realised virtual servers) responds to operations for managing the instance lifecycle, such as 'stop', 'reboot' etc.
   </dd>
   <dt><h6>options</h6></dt>
   <dd>
   are listed by invoking <strong>deltacloudc -h</strong> One important option is <strong>-u</strong>, with which you specify the API_URL, where the Deltacloud server is running. The API_URL takes the form <strong>http://[user]:[password]@[api_url]:[port]/[api]</strong> (examples follow). Alternatively, rather than having to supply the API_URL for every invocation of <strong>deltacloudc</strong> you have the choice of setting the API_URL environment variable (e.g., export API_URL=http://mockuser:mockpassword@localhost:3001/api). A listing of the credentials you need to provide for each back-end cloud provider is available here.
   </dd>
 </dl>

       <footer class="footer">
         <p class="footer-right">
           <img src="/assets/img/asf_logo_wide.png" alt="Apache Software
           Foundation"/>
         </p>
         <p>
         <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.
         </p>
       </footer>

     </div> <!-- /container -->

   </body>
 </html>
	<!DOCTYPE html>
	<html lang="en">
	<head>
	<meta charset="utf-8">
	<title>The Deltacloud Ruby Client</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>

	<!-- 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 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="/supported-providers.html">Supported Providers</a></li>
	</ul>
	</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">Clients</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="/how-to-contribute.html">How Can I Contribute?</a></li>
	<li><a href="/getting-sources.html">Getting the Sources</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">REST API</a></li>
	<li><a href="/drivers.html">Drivers API</a></li>
	</ul>
	</li>
	<li><a href="/contact.html">Contact</a></li>
	</ul>

	</div>
	</div>

	</div>

	<div class="container">

	<p><br></p>

	<p>Installing the Deltacloud client also gives you the <strong>deltacloudc</strong> command line tool. This executable makes use of the Deltacloud client library to speak to the Deltacloud server using the <a href="rest-api.html">REST API</a>. This allows you to to control your IAAS cloud infrastructure from the command line. If you are familiar with linux scripting, you can knock up a bash script in no time to automate your cloud infrastructure tasks.The general usage pattern for deltacloudc is:</p><p>

	</p><pre>$ deltacloudc collection operation [options]</pre>

	<dl class="dl-horizontal">
	<dt><h6>collection</h6></dt>
	<dd>
	refers to the Deltacloud object collections, such as Instances, Images, Buckets, Realms etc, as described in greater detail in the REST API
	</dd>
	<dt><h6>operation</h6></dt>
	<dd>nanoc
	is collection dependant. All collections respond to 'index' and 'show' operations (retrieve details on all objects in a given collection or on a specific object, respectively); some collections respond to 'create' and 'destroy' operations. The instances collection (realised virtual servers) responds to operations for managing the instance lifecycle, such as 'stop', 'reboot' etc.
	</dd>
	<dt><h6>options</h6></dt>
	<dd>
	are listed by invoking <strong>deltacloudc -h</strong> One important option is <strong>-u</strong>, with which you specify the API_URL, where the Deltacloud server is running. The API_URL takes the form <strong>http://[user]:[password]@[api_url]:[port]/[api]</strong> (examples follow). Alternatively, rather than having to supply the API_URL for every invocation of <strong>deltacloudc</strong> you have the choice of setting the API_URL environment variable (e.g., export API_URL=http://mockuser:mockpassword@localhost:3001/api). A listing of the credentials you need to provide for each back-end cloud provider is available here.
	</dd>
	</dl>

	<footer class="footer">
	<p class="footer-right">
	<img src="/assets/img/asf_logo_wide.png" alt="Apache Software
	Foundation"/>
	</p>
	<p>
	<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.
	</p>
	</footer>

	</div> <!-- /container -->

	</body>
	</html>