mirror of
https://github.com/Fishwaldo/rundeck-api-java-client.git
synced 2025-07-18 19:08:21 +00:00
208 lines
12 KiB
HTML
208 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 Aug 3, 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="20110803" />
|
|
<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-08-03</span>
|
|
| <span id="projectVersion">Version: 2.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="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">
|
|
<a href="jruby.html" title="JRuby">JRuby</a>
|
|
</li>
|
|
<li class="none">
|
|
<strong>Jython</strong>
|
|
</li>
|
|
</ul>
|
|
<h5>Older versions</h5>
|
|
<ul>
|
|
<li class="none">
|
|
<a href="1.x/index.html" title="1.x (RunDeck 1.2)">1.x (RunDeck 1.2)</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 Jython scripts<a name="Using_the_RunDeck_API_from_Jython_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.jython.org/">Python</a> (for the pythonist 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 "<tt>rundeck.py</tt>", and execute it with "<tt>jython -J-cp /path/to/rundeck-api-java-client-VERSION-jar-with-dependencies.jar rundeck.py</tt>".</p><div class="source"><pre>from org.rundeck.api import RundeckClient
|
|
|
|
rundeck = RundeckClient("http://localhost:4440", "admin", "admin")
|
|
|
|
print("RunDeck uptime : %s" % rundeck.systemInfo.uptime)
|
|
print("All RunDeck projects : %s" % rundeck.projects)
|
|
print("All RunDeck nodes : %s" % rundeck.nodes)
|
|
print("All RunDeck jobs : %s" % rundeck.jobs)
|
|
print("All RunDeck running executions : %s" % rundeck.runningExecutions)
|
|
</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>// using login-based authentication (admin/admin is the default login/password for a new RunDeck instance) :
|
|
rundeck = RundeckClient("http://localhost:4440", "admin", "admin");
|
|
|
|
// using token-based authentication :
|
|
rundeck = RundeckClient("http://localhost:4440", "PDDNKo5VE29kpk4prOUDr2rsKdRkEvsD");
|
|
</pre></div><div class="section"><h3>Running a job<a name="Running_a_job"></a></h3></div><div class="source"><pre>from org.rundeck.api import RundeckClient
|
|
from org.rundeck.api import OptionsBuilder
|
|
from org.rundeck.api import NodeFiltersBuilder
|
|
|
|
rundeck = 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")
|
|
print("Found job with ID : %s" % job.id)
|
|
|
|
// trigger a simple job with no options
|
|
execution = rundeck.triggerJob(job.id)
|
|
print("Execution started, you can follow it at the URL : %s" % execution.url)
|
|
|
|
// or with options...
|
|
execution = rundeck.triggerJob("job-id", OptionsBuilder().addOption("option1", "value one").addOption("option2", "value two").toProperties())
|
|
|
|
// you can also override the nodes on which the job should execute
|
|
execution = rundeck.triggerJob("job-id", OptionsBuilder().addOption("opt", "value").toProperties(), NodeFiltersBuilder().tags("prod+appserv").toProperties())
|
|
|
|
// last one : you can run a job and wait until its execution is finished :
|
|
execution = rundeck.runJob("job-id")
|
|
print("Execution finished ! Status : %s, duration : %s" % (execution.status, 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>from org.rundeck.api import RundeckClient
|
|
from org.rundeck.api import NodeFiltersBuilder
|
|
|
|
rundeck = 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", NodeFiltersBuilder().osFamily("unix").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>from org.rundeck.api import RundeckClient
|
|
from org.rundeck.api import OptionsBuilder
|
|
from org.rundeck.api import NodeFiltersBuilder
|
|
|
|
rundeck = RundeckClient("http://localhost:4440", "admin", "admin")
|
|
|
|
// trigger the execution of a custom bash script on the RunDeck server
|
|
execution = rundeck.triggerAdhocScript("my-project", "/tmp/my-script.sh")
|
|
|
|
// run a bash script (with options) on all unix nodes
|
|
execution = rundeck.runAdhocCommand("my-project", "/tmp/my-script-with-options.sh", OptionsBuilder().addOption("option1", "value one").toProperties(), NodeFiltersBuilder().osFamily("unix").toProperties())
|
|
</pre></div><div class="section"><h3>Exporting jobs<a name="Exporting_jobs"></a></h3></div><div class="source"><pre>from org.rundeck.api import RundeckClient
|
|
rundeck = RundeckClient("http://localhost:4440", "admin", "admin")
|
|
|
|
rundeck.exportJobsToFile("/tmp/jobs.xml", "xml", "my-project")
|
|
rundeck.exportJobToFile("/tmp/job.yaml", "yaml", "job-id")
|
|
</pre></div><div class="section"><h3>Importing jobs<a name="Importing_jobs"></a></h3></div><div class="source"><pre>from org.rundeck.api import RundeckClient
|
|
rundeck = RundeckClient("http://localhost:4440", "admin", "admin")
|
|
|
|
result = rundeck.importJobs("/tmp/jobs.xml", "xml")
|
|
print("%s jobs successfully imported, %s jobs skipped, and %s jobs failed" % (result.succeededJobs.size, result.skippedJobs.size, result.failedJobs.size))
|
|
</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 class="clear">
|
|
<hr/>
|
|
</div>
|
|
<div id="footer">
|
|
<div class="xright">
|
|
Copyright © 2011.
|
|
All Rights Reserved.
|
|
|
|
</div>
|
|
<div class="clear">
|
|
<hr/>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|