rundeck-api-java-client/jruby.html
2014-11-25 11:08:35 -08:00

216 lines
12 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<!-- Generated by Apache Maven Doxia at Nov 25, 2014 -->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<title></title>
<link rel="stylesheet" href="./css/apache-maven-fluido.min.css" />
<link rel="stylesheet" href="./css/site.css" />
<link rel="stylesheet" href="./css/print.css" media="print" />
<style>body{padding-top: 20px;}</style>
<script type="text/javascript" src="./js/apache-maven-fluido.min.js"></script>
<meta name="Date-Revision-yyyymmdd" content="20141125" />
<meta http-equiv="Content-Language" content="en" />
<!-- Google Analytics -->
<script type="text/javascript">
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-23435653-1']);
_gaq.push(['_trackPageview']);
(function() {
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
})();
</script>
</head>
<body>
<div class="container-fluid">
<div id="breadcrumbs">
<ul class="breadcrumb">
<li class="">
<a href="http://rundeck.org" class="externalLink" title="Rundeck">Rundeck</a>
<li class="divider ">/</li>
</li>
<li class="">
<a href="./" title="Rundeck API - Java Client">Rundeck API - Java Client</a>
<li class="divider ">/</li>
</li>
<li class=""></li>
<li id="publishDate" class="pull-right">Last Published: 2014-11-25</li> <li class="divider pull-right">|</li>
<li id="projectVersion" class="pull-right">Version: 12.0</li>
</ul>
</div>
<div id="leftColumn" class="sidebar">
<div class="well">
<h5>RunDeck API - Java Client</h5>
<ul>
<li class="none">
<a href="index.html" title="Introduction">Introduction</a>
</li>
<li class="none">
<a href="status.html" title="Status">Status</a>
</li>
<li class="none">
<a href="faq.html" title="FAQ">FAQ</a>
</li>
<li class="none">
<a href="download.html" title="Download">Download</a>
</li>
<li class="none">
<a href="changes-report.html" title="Changelog">Changelog</a>
</li>
<li class="none">
<a href="apidocs/index.html" title="API Documentation">API Documentation</a>
</li>
</ul>
<h5>Scripting examples</h5>
<ul>
<li class="none">
<a href="scripting.html" title="Introduction">Introduction</a>
</li>
<li class="none">
<a href="groovy.html" title="Groovy">Groovy</a>
</li>
<li class="none">
<strong>JRuby</strong>
</li>
<li class="none">
<a href="jython.html" title="Jython">Jython</a>
</li>
</ul>
<h5>Project Documentation</h5>
<ul>
<li class="collapsed">
<a href="project-info.html" title="Project Information">Project Information</a>
</li>
<li class="collapsed">
<a href="project-reports.html" title="Project Reports">Project Reports</a>
</li>
</ul>
<div id="poweredBy">
<a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
<img class="poweredBy" alt="Built by Maven" src="./images/logos/maven-feather.png" />
</a>
</div>
</div>
</div>
<div id="bodyColumn" class="content">
<div id="contentBox">
<div class="section"><h2>Using the Rundeck API from JRuby scripts<a name="Using_the_Rundeck_API_from_JRuby_scripts"></a></h2></div><p>Here are some examples of what you can do with this lib and a few lines of <a class="externalLink" href="http://www.jruby.org/">Ruby</a> (for the rubyist that don't fear running on the JVM !)</p><p>You will have to <a href="./download.html">download</a> the lib (the .jar file) to use it...</p><div class="section"><h3>Basic usage<a name="Basic_usage"></a></h3></div><p>Save the following script in a file named &quot;<tt>rundeck.rb</tt>&quot;, and execute it with &quot;<tt>jruby rundeck.rb</tt>&quot;.</p><div class="source"><pre class="prettyprint">require 'java'
require '/path/to/rundeck-api-java-client-VERSION-jar-with-dependencies.jar'
import org.rundeck.api.RundeckClient
rundeck = RundeckClient.builder().url(&quot;http://localhost:4440&quot;).login(&quot;admin&quot;, &quot;admin&quot;).build()
puts &quot;Rundeck uptime : #{rundeck.systemInfo.uptime}&quot;
puts &quot;All Rundeck projects : #{rundeck.projects}&quot;
puts &quot;All Rundeck nodes : #{rundeck.nodes}&quot;
puts &quot;All Rundeck jobs : #{rundeck.jobs}&quot;
puts &quot;All Rundeck running executions : #{rundeck.runningExecutions}&quot;
</pre></div><p>You can also add the library to the classpath : save the following script in a file named &quot;<tt>rundeck.rb</tt>&quot;, and execute it with &quot;<tt>jruby -rjava -J-cp /path/to/rundeck-api-java-client-VERSION-jar-with-dependencies.jar rundeck.rb</tt>&quot;.</p><div class="source"><pre class="prettyprint">import org.rundeck.api.RundeckClient
rundeck = RundeckClient.builder().url(&quot;http://localhost:4440&quot;).login(&quot;admin&quot;, &quot;admin&quot;).build()
puts &quot;Rundeck uptime : #{rundeck.systemInfo.uptime}&quot;
puts &quot;All Rundeck projects : #{rundeck.projects}&quot;
puts &quot;All Rundeck nodes : #{rundeck.nodes}&quot;
puts &quot;All Rundeck jobs : #{rundeck.jobs}&quot;
puts &quot;All Rundeck running executions : #{rundeck.runningExecutions}&quot;
</pre></div><div class="section"><h3>Authentication<a name="Authentication"></a></h3></div><p>Starting with Rundeck API 2, there are 2 ways to authenticate :</p><ul><li>the <b>login-based authentication</b> : with your login and password</li><li>the <b>token-based authentication</b> : with a unique token that you can generate from the Rundeck webUI</li></ul><div class="source"><pre class="prettyprint">// using login-based authentication (admin/admin is the default login/password for a new Rundeck instance) :
rundeck = RundeckClient.builder().url(&quot;http://localhost:4440&quot;).login(&quot;admin&quot;, &quot;admin&quot;).build()
// using token-based authentication :
rundeck = RundeckClient.builder().url(&quot;http://localhost:4440&quot;).token(&quot;PDDNKo5VE29kpk4prOUDr2rsKdRkEvsD&quot;).build()
</pre></div><div class="section"><h3>Running a job<a name="Running_a_job"></a></h3></div><div class="source"><pre class="prettyprint">import org.rundeck.api.RundeckClient
import org.rundeck.api.OptionsBuilder
import org.rundeck.api.NodeFiltersBuilder
rundeck = RundeckClient.builder().url(&quot;http://localhost:4440&quot;).login(&quot;admin&quot;, &quot;admin&quot;).build()
// find a job from its name, group and project
job = rundeck.findJob(&quot;my-project&quot;, &quot;main-group/sub-group&quot;, &quot;job-name&quot;)
puts &quot;Found job with ID : #{job.id}&quot;
// trigger a simple job with no options
execution = rundeck.triggerJob(job.id)
puts &quot;Execution started, you can follow it at the URL : #{execution.url}&quot;
// or with options...
execution = rundeck.triggerJob(&quot;job-id&quot;, OptionsBuilder.new().addOption(&quot;option1&quot;, &quot;value one&quot;).addOption(&quot;option2&quot;, &quot;value two&quot;).toProperties())
// you can also override the nodes on which the job should execute
execution = rundeck.triggerJob(&quot;job-id&quot;, OptionsBuilder.new().addOption(&quot;opt&quot;, &quot;value&quot;).toProperties(), NodeFiltersBuilder.new().tags(&quot;prod+appserv&quot;).toProperties())
// last one : you can run a job and wait until its execution is finished :
execution = rundeck.runJob(&quot;job-id&quot;)
puts &quot;Execution finished ! Status : #{execution.status}, duration : #{execution.duration}&quot;
</pre></div><div class="section"><h3>Running an ad-hoc command<a name="Running_an_ad-hoc_command"></a></h3></div><div class="source"><pre class="prettyprint">import org.rundeck.api.RundeckClient
import org.rundeck.api.NodeFiltersBuilder
rundeck = RundeckClient.builder().url(&quot;http://localhost:4440&quot;).login(&quot;admin&quot;, &quot;admin&quot;).build()
// trigger the execution of the &quot;uptime&quot; command on the Rundeck server
execution = rundeck.triggerAdhocCommand(&quot;my-project&quot;, &quot;uptime&quot;)
// run the &quot;uptime&quot; command on all unix nodes
execution = rundeck.runAdhocCommand(&quot;my-project&quot;, &quot;uptime&quot;, NodeFiltersBuilder.new().osFamily(&quot;unix&quot;).toProperties())
</pre></div><div class="section"><h3>Running an ad-hoc script<a name="Running_an_ad-hoc_script"></a></h3></div><div class="source"><pre class="prettyprint">import org.rundeck.api.RundeckClient
import org.rundeck.api.OptionsBuilder
import org.rundeck.api.NodeFiltersBuilder
rundeck = RundeckClient.builder().url(&quot;http://localhost:4440&quot;).login(&quot;admin&quot;, &quot;admin&quot;).build()
// trigger the execution of a custom bash script on the Rundeck server
execution = rundeck.triggerAdhocScript(&quot;my-project&quot;, &quot;/tmp/my-script.sh&quot;)
// run a bash script (with options) on all unix nodes
execution = rundeck.runAdhocCommand(&quot;my-project&quot;, &quot;/tmp/my-script-with-options.sh&quot;, OptionsBuilder.new().addOption(&quot;option1&quot;, &quot;value one&quot;).toProperties(), NodeFiltersBuilder.new().osFamily(&quot;unix&quot;).toProperties())
</pre></div><div class="section"><h3>Exporting jobs<a name="Exporting_jobs"></a></h3></div><div class="source"><pre class="prettyprint">import org.rundeck.api.RundeckClient
rundeck = RundeckClient.builder().url(&quot;http://localhost:4440&quot;).login(&quot;admin&quot;, &quot;admin&quot;).build()
rundeck.exportJobsToFile(&quot;/tmp/jobs.xml&quot;, &quot;xml&quot;, &quot;my-project&quot;)
rundeck.exportJobToFile(&quot;/tmp/job.yaml&quot;, &quot;yaml&quot;, &quot;job-id&quot;)
</pre></div><div class="section"><h3>Importing jobs<a name="Importing_jobs"></a></h3></div><div class="source"><pre class="prettyprint">import org.rundeck.api.RundeckClient
rundeck = RundeckClient.builder().url(&quot;http://localhost:4440&quot;).login(&quot;admin&quot;, &quot;admin&quot;).build()
result = rundeck.importJobs(&quot;/tmp/jobs.xml&quot;, &quot;xml&quot;)
puts &quot;#{result.succeededJobs.size} jobs successfully imported, #{result.skippedJobs.size} jobs skipped, and #{result.failedJobs.size} jobs failed&quot;
</pre></div><div class="section"><h3>And more...<a name="And_more..."></a></h3></div><p>See the API documentation of the <a href="./apidocs/reference/org/rundeck/api/RundeckClient.html">RundeckClient</a> class for more interactions with your Rundeck instance...</p>
</div>
</div>
</div>
<footer class="footer">
<div class="container-fluid">
<div class="row span16">Copyright &copy; 2011-2014.
All Rights Reserved.
</div>
</div>
</footer>
</body>
</html>