mirror of
https://github.com/Fishwaldo/rundeck-api-java-client.git
synced 2025-07-23 21:38:32 +00:00
184 lines
9.9 KiB
HTML
184 lines
9.9 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 Jul 12, 2011 -->
|
|
<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>
|
|
<style type="text/css" media="all">
|
|
@import url("./css/maven-base.css");
|
|
@import url("./css/maven-theme.css");
|
|
@import url("./css/site.css");
|
|
</style>
|
|
<link rel="stylesheet" href="./css/print.css" type="text/css" media="print" />
|
|
<meta name="Date-Revision-yyyymmdd" content="20110712" />
|
|
<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 class="composite">
|
|
<div id="banner">
|
|
<div id="bannerLeft">
|
|
RunDeck API - Java Client
|
|
</div>
|
|
<div class="clear">
|
|
<hr/>
|
|
</div>
|
|
</div>
|
|
<div id="breadcrumbs">
|
|
|
|
|
|
<div class="xleft">
|
|
<a href="http://rundeck.org" class="externalLink" title="RunDeck">RunDeck</a>
|
|
>
|
|
<a href="./" title="RunDeck API - Java Client">RunDeck API - Java Client</a>
|
|
>
|
|
|
|
</div>
|
|
<div class="xright">
|
|
|
|
<span id="publishDate">Last Published: 2011-07-12</span>
|
|
| <span id="projectVersion">Version: 1.1-SNAPSHOT</span>
|
|
</div>
|
|
<div class="clear">
|
|
<hr/>
|
|
</div>
|
|
</div>
|
|
<div id="leftColumn">
|
|
<div id="navcolumn">
|
|
|
|
|
|
<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="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">
|
|
<strong>Groovy</strong>
|
|
</li>
|
|
<li class="none">
|
|
<a href="jruby.html" title="JRuby">JRuby</a>
|
|
</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>
|
|
<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 id="bodyColumn">
|
|
<div id="contentBox">
|
|
<div class="section"><h2>Using the RunDeck API from Groovy scripts<a name="Using_the_RunDeck_API_from_Groovy_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://groovy.codehaus.org/">Groovy</a>.</p><p>We can use <a class="externalLink" href="http://groovy.codehaus.org/Grape">Grape</a> to download the lib (and its dependencies) from the <a class="externalLink" href="http://search.maven.org/">Maven Central Repository</a>, so you don't have to install anything manually (except Groovy, of course).</p><div class="section"><h3>Basic usage<a name="Basic_usage"></a></h3></div><p>Save the following script in a file named "<tt>rundeck.groovy</tt>", and execute it with "<tt>groovy rundeck.groovy</tt>". Feeling Groovy ? ;-)</p><div class="source"><pre>// we use Grape (Ivy) to download the lib (and its dependencies) from Maven Central Repository
|
|
@Grab(group='org.rundeck', module='rundeck-api-java-client', version='1.0')
|
|
import org.rundeck.api.RundeckClient
|
|
|
|
rundeck = new RundeckClient("http://localhost:4440", "admin", "admin")
|
|
|
|
println "RunDeck uptime : ${rundeck.systemInfo.uptime}"
|
|
println "All RunDeck projects : ${rundeck.projects}"
|
|
println "All RunDeck nodes : ${rundeck.nodes}"
|
|
println "All RunDeck jobs : ${rundeck.jobs}"
|
|
println "All RunDeck running executions : ${rundeck.runningExecutions}"
|
|
</pre></div><p>You can also <a href="./download.html">download</a> the lib and all its dependencies in 1 big jar file, and add it to your classpath before running your script : save the following script in a file named "<tt>rundeck.groovy</tt>", and execute it with "<tt>groovy -cp /path/to/rundeck-api-java-client-VERSION-jar-with-dependencies.jar rundeck.groovy</tt>".</p><div class="source"><pre>import org.rundeck.api.RundeckClient
|
|
|
|
rundeck = new RundeckClient("http://localhost:4440", "admin", "admin")
|
|
|
|
println "RunDeck uptime : ${rundeck.systemInfo.uptime}"
|
|
println "All RunDeck projects : ${rundeck.projects}"
|
|
println "All RunDeck nodes : ${rundeck.nodes}"
|
|
println "All RunDeck jobs : ${rundeck.jobs}"
|
|
println "All RunDeck running executions : ${rundeck.runningExecutions}"
|
|
</pre></div><div class="section"><h3>Running a job<a name="Running_a_job"></a></h3></div><div class="source"><pre>import org.rundeck.api.RundeckClient
|
|
rundeck = new RundeckClient("http://localhost:4440", "admin", "admin")
|
|
|
|
// find a job from its name, group and project
|
|
job = rundeck.findJob("my-project", "main-group/sub-group", "job-name")
|
|
println "Found job with ID : ${job.id}"
|
|
|
|
// trigger a simple job with no options
|
|
execution = rundeck.triggerJob(job.id)
|
|
println "Execution started, you can follow it at the URL : ${execution.url}"
|
|
|
|
// or with options...
|
|
execution = rundeck.triggerJob("job-id", new Properties(option1: "value one", option2: "value two"))
|
|
|
|
// you can also override the nodes on which the job should execute
|
|
execution = rundeck.triggerJob("job-id", new Properties(opt: "value"), new Properties(tags: "prod+appserv"))
|
|
|
|
// last one : you can run a job and wait until its execution is finished :
|
|
execution = rundeck.runJob("job-id")
|
|
println "Execution finished ! Status : ${execution.status}, duration : ${execution.duration}"
|
|
</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>import org.rundeck.api.RundeckClient
|
|
rundeck = new RundeckClient("http://localhost:4440", "admin", "admin")
|
|
|
|
// trigger the execution of the "uptime" command on the RunDeck server
|
|
execution = rundeck.triggerAdhocCommand("my-project", "uptime")
|
|
|
|
// run the "uptime" command on all unix nodes
|
|
execution = rundeck.runAdhocCommand("my-project", "uptime", new Properties(os-family: "unix"))
|
|
</pre></div><div class="section"><h3>Exporting jobs<a name="Exporting_jobs"></a></h3></div><div class="source"><pre>import org.rundeck.api.RundeckClient
|
|
rundeck = new RundeckClient("http://localhost:4440", "admin", "admin")
|
|
|
|
rundeck.exportJobsToFile("/tmp/jobs.xml", "my-project")
|
|
rundeck.exportJobToFile("/tmp/job.xml", "job-id")
|
|
</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/org/rundeck/api/RundeckClient.html">RundeckClient</a> class for more interactions with your RunDeck instance...</p>
|
|
</div>
|
|
</div>
|
|
<div class="clear">
|
|
<hr/>
|
|
</div>
|
|
<div id="footer">
|
|
<div class="xright">
|
|
Copyright © 2011.
|
|
All Rights Reserved.
|
|
|
|
</div>
|
|
<div class="clear">
|
|
<hr/>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|