mirror of
https://github.com/Fishwaldo/rundeck-api-java-client.git
synced 2025-07-11 15:39:19 +00:00
10548 lines
452 KiB
HTML
10548 lines
452 KiB
HTML
<!DOCTYPE html>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<html>
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
<link rel="shortcut icon" type="image/x-icon" href="../../../favicon.ico" />
|
|
<title>
|
|
|
|
RundeckClient
|
|
|
|
|
|
| RunDeck API - Java Client
|
|
|
|
</title>
|
|
<link href="../../../../assets/android-developer-docs.css" rel="stylesheet" type="text/css" />
|
|
<link href="../../../../assets/customizations.css" rel="stylesheet" type="text/css" />
|
|
<script src="../../../../assets/search_autocomplete.js" type="text/javascript"></script>
|
|
<script src="../../../../assets/jquery-resizable.min.js" type="text/javascript"></script>
|
|
<script src="../../../../assets/android-developer-docs.js" type="text/javascript"></script>
|
|
<script src="../../../../assets/prettify.js" type="text/javascript"></script>
|
|
<script type="text/javascript">
|
|
setToRoot("../../../", "../../../../assets/");
|
|
</script>
|
|
<script src="../../../../assets/android-developer-reference.js" type="text/javascript"></script>
|
|
<script src="../../../../assets/navtree_data.js" type="text/javascript"></script>
|
|
<script src="../../../../assets/customizations.js" type="text/javascript"></script>
|
|
<noscript>
|
|
<style type="text/css">
|
|
html,body{overflow:auto;}
|
|
#body-content{position:relative; top:0;}
|
|
#doc-content{overflow:visible;border-left:3px solid #666;}
|
|
#side-nav{padding:0;}
|
|
#side-nav .toggle-list ul {display:block;}
|
|
#resize-packages-nav{border-bottom:3px solid #666;}
|
|
</style>
|
|
</noscript>
|
|
</head>
|
|
|
|
<body class="">
|
|
|
|
<div id="header">
|
|
<div id="headerLeft">
|
|
|
|
<span id="masthead-title">RunDeck API - Java Client</span>
|
|
|
|
</div>
|
|
<div id="headerRight">
|
|
|
|
<div id="search" >
|
|
<div id="searchForm">
|
|
<form accept-charset="utf-8" class="gsc-search-box"
|
|
onsubmit="return submit_search()">
|
|
<table class="gsc-search-box" cellpadding="0" cellspacing="0"><tbody>
|
|
<tr>
|
|
<td class="gsc-input">
|
|
<input id="search_autocomplete" class="gsc-input" type="text" size="33" autocomplete="off"
|
|
title="search developer docs" name="q"
|
|
value="search developer docs"
|
|
onFocus="search_focus_changed(this, true)"
|
|
onBlur="search_focus_changed(this, false)"
|
|
onkeydown="return search_changed(event, true, '../../../')"
|
|
onkeyup="return search_changed(event, false, '../../../')" />
|
|
<div id="search_filtered_div" class="no-display">
|
|
<table id="search_filtered" cellspacing=0>
|
|
</table>
|
|
</div>
|
|
</td>
|
|
<td class="gsc-search-button">
|
|
<input type="submit" value="Search" title="search" id="search-button" class="gsc-search-button" />
|
|
</td>
|
|
<td class="gsc-clear-button">
|
|
<div title="clear results" class="gsc-clear-button"> </div>
|
|
</td>
|
|
</tr></tbody>
|
|
</table>
|
|
</form>
|
|
</div><!-- searchForm -->
|
|
</div><!-- search -->
|
|
|
|
</div>
|
|
</div><!-- header -->
|
|
|
|
|
|
<div class="g-section g-tpl-240" id="body-content">
|
|
<div class="g-unit g-first side-nav-resizable" id="side-nav">
|
|
<div id="swapper">
|
|
<div id="nav-panels">
|
|
<div id="resize-packages-nav">
|
|
<div id="packages-nav">
|
|
<div id="index-links"><nobr>
|
|
<a href="../../../packages.html" >Package Index</a> |
|
|
<a href="../../../classes.html" >Class Index</a></nobr>
|
|
</div>
|
|
<ul>
|
|
|
|
<li class="selected api apilevel-">
|
|
<a href="../../../org/rundeck/api/package-summary.html">org.rundeck.api</a></li>
|
|
<li class="api apilevel-">
|
|
<a href="../../../org/rundeck/api/domain/package-summary.html">org.rundeck.api.domain</a></li>
|
|
<li class="api apilevel-">
|
|
<a href="../../../org/rundeck/api/parser/package-summary.html">org.rundeck.api.parser</a></li>
|
|
<li class="api apilevel-">
|
|
<a href="../../../org/rundeck/api/util/package-summary.html">org.rundeck.api.util</a></li>
|
|
</ul><br/>
|
|
</div> <!-- end packages -->
|
|
</div> <!-- end resize-packages -->
|
|
<div id="classes-nav">
|
|
<ul>
|
|
|
|
|
|
<li><h2>Classes</h2>
|
|
<ul>
|
|
<li class="api apilevel-"><a href="../../../org/rundeck/api/NodeFiltersBuilder.html">NodeFiltersBuilder</a></li>
|
|
<li class="api apilevel-"><a href="../../../org/rundeck/api/OptionsBuilder.html">OptionsBuilder</a></li>
|
|
<li class="selected api apilevel-"><a href="../../../org/rundeck/api/RundeckClient.html">RundeckClient</a></li>
|
|
</ul>
|
|
</li>
|
|
|
|
|
|
<li><h2>Enums</h2>
|
|
<ul>
|
|
<li class="api apilevel-"><a href="../../../org/rundeck/api/FileType.html">FileType</a></li>
|
|
</ul>
|
|
</li>
|
|
|
|
<li><h2>Exceptions</h2>
|
|
<ul>
|
|
<li class="api apilevel-"><a href="../../../org/rundeck/api/RundeckApiException.html">RundeckApiException</a></li>
|
|
<li class="api apilevel-"><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiAuthException.html">RundeckApiException.RundeckApiAuthException</a></li>
|
|
<li class="api apilevel-"><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html">RundeckApiException.RundeckApiLoginException</a></li>
|
|
<li class="api apilevel-"><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiTokenException.html">RundeckApiException.RundeckApiTokenException</a></li>
|
|
</ul>
|
|
</li>
|
|
|
|
</ul><br/>
|
|
</div><!-- end classes -->
|
|
</div><!-- end nav-panels -->
|
|
<div id="nav-tree" style="display:none">
|
|
<div id="index-links"><nobr>
|
|
<a href="../../../packages.html" >Package Index</a> |
|
|
<a href="../../../classes.html" >Class Index</a></nobr>
|
|
</div>
|
|
</div><!-- end nav-tree -->
|
|
</div><!-- end swapper -->
|
|
</div> <!-- end side-nav -->
|
|
<script>
|
|
if (!isMobile) {
|
|
$("<a href='#' id='nav-swap' onclick='swapNav();return false;' style='font-size:10px;line-height:9px;margin-left:1em;text-decoration:none;'><span id='tree-link'>Use Tree Navigation</span><span id='panel-link' style='display:none'>Use Panel Navigation</span></a>").appendTo("#side-nav");
|
|
chooseDefaultNav();
|
|
if ($("#nav-tree").is(':visible')) {
|
|
init_default_navtree("../../../");
|
|
} else {
|
|
addLoadEvent(function() {
|
|
scrollIntoView("packages-nav");
|
|
scrollIntoView("classes-nav");
|
|
});
|
|
}
|
|
$("#swapper").css({borderBottom:"2px solid #aaa"});
|
|
} else {
|
|
swapNav(); // tree view should be used on mobile
|
|
}
|
|
</script>
|
|
|
|
|
|
|
|
<div class="g-unit" id="doc-content">
|
|
|
|
<div id="api-info-block">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="sum-details-links">
|
|
|
|
Summary:
|
|
|
|
|
|
|
|
|
|
|
|
<a href="#constants">Constants</a>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| <a href="#pubctors">Ctors</a>
|
|
|
|
|
|
|
|
|
|
| <a href="#pubmethods">Methods</a>
|
|
|
|
|
|
|
|
|
|
| <a href="#inhmethods">Inherited Methods</a>
|
|
|
|
| <a href="#" onclick="return toggleAllClassInherited()" id="toggleAllClassInherited">[Expand All]</a>
|
|
|
|
</div><!-- end sum-details-links -->
|
|
<div class="api-level">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div><!-- end api-info-block -->
|
|
|
|
|
|
<!-- ======== START OF CLASS DATA ======== -->
|
|
|
|
<div id="jd-header">
|
|
public
|
|
|
|
|
|
|
|
class
|
|
<h1>RundeckClient</h1>
|
|
|
|
|
|
|
|
|
|
extends <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/Object.html">Object</a><br/>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
implements
|
|
|
|
<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/io/Serializable.html">Serializable</a>
|
|
|
|
|
|
|
|
|
|
|
|
</div><!-- end header -->
|
|
|
|
<div id="naMessage"></div>
|
|
|
|
<div id="jd-content" class="api apilevel-">
|
|
<table class="jd-inheritance-table">
|
|
|
|
|
|
<tr>
|
|
|
|
<td colspan="2" class="jd-inheritance-class-cell"><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/Object.html">java.lang.Object</a></td>
|
|
</tr>
|
|
|
|
|
|
<tr>
|
|
|
|
<td class="jd-inheritance-space"> ↳</td>
|
|
|
|
<td colspan="1" class="jd-inheritance-class-cell">org.rundeck.api.RundeckClient</td>
|
|
</tr>
|
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="jd-descr">
|
|
|
|
|
|
<h2>Class Overview</h2>
|
|
<p>Main entry point to talk to a RunDeck instance.<br>
|
|
You have 2 methods for authentication : login-based or token-based. If you want to use the first, you need to provide
|
|
both a "login" and a "password". Otherwise, just provide a "token" (also called "auth-token"). See the RunDeck
|
|
documentation for generating such a token.<br>
|
|
<br>
|
|
Usage : <br>
|
|
<code>
|
|
<pre class="prettyprint">
|
|
// using login-based authentication :
|
|
RundeckClient rundeck = new RundeckClient("http://localhost:4440", "admin", "admin");
|
|
// or for a token-based authentication :
|
|
RundeckClient rundeck = new RundeckClient("http://localhost:4440", "PDDNKo5VE29kpk4prOUDr2rsKdRkEvsD");
|
|
|
|
List<RundeckProject> projects = rundeck.getProjects();
|
|
|
|
RundeckJob job = rundeck.findJob("my-project", "main-group/sub-group", "job-name");
|
|
RundeckExecution execution = rundeck.triggerJob(job.getId(),
|
|
new OptionsBuilder().addOption("version", "1.2.0").toProperties());
|
|
|
|
List<RundeckExecution> runningExecutions = rundeck.getRunningExecutions("my-project");
|
|
|
|
rundeck.exportJobsToFile("/tmp/jobs.xml", FileType.XML, "my-project");
|
|
rundeck.importJobs("/tmp/jobs.xml", FileType.XML);
|
|
</pre>
|
|
</code></p>
|
|
|
|
|
|
|
|
|
|
|
|
</div><!-- jd-descr -->
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="jd-descr">
|
|
|
|
|
|
<h2>Summary</h2>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!-- =========== ENUM CONSTANT SUMMARY =========== -->
|
|
<table id="constants" class="jd-sumtable"><tr><th colspan="12">Constants</th></tr>
|
|
|
|
|
|
|
|
<tr class="alt-color api apilevel-" >
|
|
<td class="jd-typecol"><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a></td>
|
|
<td class="jd-linkcol"><a href="../../../org/rundeck/api/RundeckClient.html#API_ENDPOINT">API_ENDPOINT</a></td>
|
|
<td class="jd-descrcol" width="100%">End-point of the API </td>
|
|
</tr>
|
|
|
|
|
|
<tr class=" api apilevel-" >
|
|
<td class="jd-typecol">int</td>
|
|
<td class="jd-linkcol"><a href="../../../org/rundeck/api/RundeckClient.html#API_VERSION">API_VERSION</a></td>
|
|
<td class="jd-descrcol" width="100%">Version of the API supported </td>
|
|
</tr>
|
|
|
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
|
<table id="pubctors" class="jd-sumtable"><tr><th colspan="12">Public Constructors</th></tr>
|
|
|
|
|
|
|
|
|
|
<tr class="alt-color api apilevel-" >
|
|
<td class="jd-typecol"><nobr>
|
|
|
|
|
|
|
|
|
|
|
|
</nobr>
|
|
</td>
|
|
<td class="jd-linkcol" width="100%"><nobr>
|
|
<span class="sympad"><a href="../../../org/rundeck/api/RundeckClient.html#RundeckClient(java.lang.String, java.lang.String)">RundeckClient</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> url, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> token)</nobr>
|
|
|
|
<div class="jd-descrdiv">Instantiate a new <code><a href="../../../org/rundeck/api/RundeckClient.html">RundeckClient</a></code> for the RunDeck instance at the given url, using token-based
|
|
authentication.</div>
|
|
|
|
</td></tr>
|
|
|
|
|
|
|
|
<tr class=" api apilevel-" >
|
|
<td class="jd-typecol"><nobr>
|
|
|
|
|
|
|
|
|
|
|
|
</nobr>
|
|
</td>
|
|
<td class="jd-linkcol" width="100%"><nobr>
|
|
<span class="sympad"><a href="../../../org/rundeck/api/RundeckClient.html#RundeckClient(java.lang.String, java.lang.String, java.lang.String)">RundeckClient</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> url, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> login, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> password)</nobr>
|
|
|
|
<div class="jd-descrdiv">Instantiate a new <code><a href="../../../org/rundeck/api/RundeckClient.html">RundeckClient</a></code> for the RunDeck instance at the given url, using login-based
|
|
authentication.</div>
|
|
|
|
</td></tr>
|
|
|
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ========== METHOD SUMMARY =========== -->
|
|
<table id="pubmethods" class="jd-sumtable"><tr><th colspan="12">Public Methods</th></tr>
|
|
|
|
|
|
|
|
|
|
<tr class="alt-color api apilevel-" >
|
|
<td class="jd-typecol"><nobr>
|
|
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckAbort.html">RundeckAbort</a></nobr>
|
|
</td>
|
|
<td class="jd-linkcol" width="100%"><nobr>
|
|
<span class="sympad"><a href="../../../org/rundeck/api/RundeckClient.html#abortExecution(java.lang.Long)">abortExecution</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/Long.html">Long</a> executionId)</nobr>
|
|
|
|
<div class="jd-descrdiv">Abort an execution (identified by the given ID).</div>
|
|
|
|
</td></tr>
|
|
|
|
|
|
|
|
<tr class=" api apilevel-" >
|
|
<td class="jd-typecol"><nobr>
|
|
|
|
|
|
|
|
|
|
|
|
<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a></nobr>
|
|
</td>
|
|
<td class="jd-linkcol" width="100%"><nobr>
|
|
<span class="sympad"><a href="../../../org/rundeck/api/RundeckClient.html#deleteJob(java.lang.String)">deleteJob</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> jobId)</nobr>
|
|
|
|
<div class="jd-descrdiv">Delete a single job, identified by the given ID</div>
|
|
|
|
</td></tr>
|
|
|
|
|
|
|
|
<tr class="alt-color api apilevel-" >
|
|
<td class="jd-typecol"><nobr>
|
|
|
|
|
|
|
|
|
|
|
|
boolean</nobr>
|
|
</td>
|
|
<td class="jd-linkcol" width="100%"><nobr>
|
|
<span class="sympad"><a href="../../../org/rundeck/api/RundeckClient.html#equals(java.lang.Object)">equals</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/Object.html">Object</a> obj)</nobr>
|
|
|
|
</td></tr>
|
|
|
|
|
|
|
|
<tr class=" api apilevel-" >
|
|
<td class="jd-typecol"><nobr>
|
|
|
|
|
|
|
|
|
|
|
|
<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/io/InputStream.html">InputStream</a></nobr>
|
|
</td>
|
|
<td class="jd-linkcol" width="100%"><nobr>
|
|
<span class="sympad"><a href="../../../org/rundeck/api/RundeckClient.html#exportJob(java.lang.String, java.lang.String)">exportJob</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> format, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> jobId)</nobr>
|
|
|
|
<div class="jd-descrdiv">Export the definition of a single job, identified by the given ID</div>
|
|
|
|
</td></tr>
|
|
|
|
|
|
|
|
<tr class="alt-color api apilevel-" >
|
|
<td class="jd-typecol"><nobr>
|
|
|
|
|
|
|
|
|
|
|
|
<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/io/InputStream.html">InputStream</a></nobr>
|
|
</td>
|
|
<td class="jd-linkcol" width="100%"><nobr>
|
|
<span class="sympad"><a href="../../../org/rundeck/api/RundeckClient.html#exportJob(org.rundeck.api.FileType, java.lang.String)">exportJob</a></span>(<a href="../../../org/rundeck/api/FileType.html">FileType</a> format, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> jobId)</nobr>
|
|
|
|
<div class="jd-descrdiv">Export the definition of a single job, identified by the given ID</div>
|
|
|
|
</td></tr>
|
|
|
|
|
|
|
|
<tr class=" api apilevel-" >
|
|
<td class="jd-typecol"><nobr>
|
|
|
|
|
|
|
|
|
|
|
|
void</nobr>
|
|
</td>
|
|
<td class="jd-linkcol" width="100%"><nobr>
|
|
<span class="sympad"><a href="../../../org/rundeck/api/RundeckClient.html#exportJobToFile(java.lang.String, java.lang.String, java.lang.String)">exportJobToFile</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> filename, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> format, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> jobId)</nobr>
|
|
|
|
<div class="jd-descrdiv">Export the definition of a single job (identified by the given ID)</div>
|
|
|
|
</td></tr>
|
|
|
|
|
|
|
|
<tr class="alt-color api apilevel-" >
|
|
<td class="jd-typecol"><nobr>
|
|
|
|
|
|
|
|
|
|
|
|
void</nobr>
|
|
</td>
|
|
<td class="jd-linkcol" width="100%"><nobr>
|
|
<span class="sympad"><a href="../../../org/rundeck/api/RundeckClient.html#exportJobToFile(java.lang.String, org.rundeck.api.FileType, java.lang.String)">exportJobToFile</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> filename, <a href="../../../org/rundeck/api/FileType.html">FileType</a> format, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> jobId)</nobr>
|
|
|
|
<div class="jd-descrdiv">Export the definition of a single job (identified by the given ID)</div>
|
|
|
|
</td></tr>
|
|
|
|
|
|
|
|
<tr class=" api apilevel-" >
|
|
<td class="jd-typecol"><nobr>
|
|
|
|
|
|
|
|
|
|
|
|
<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/io/InputStream.html">InputStream</a></nobr>
|
|
</td>
|
|
<td class="jd-linkcol" width="100%"><nobr>
|
|
<span class="sympad"><a href="../../../org/rundeck/api/RundeckClient.html#exportJobs(java.lang.String, java.lang.String)">exportJobs</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> format, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> project)</nobr>
|
|
|
|
<div class="jd-descrdiv">Export the definitions of all jobs that belongs to the given project</div>
|
|
|
|
</td></tr>
|
|
|
|
|
|
|
|
<tr class="alt-color api apilevel-" >
|
|
<td class="jd-typecol"><nobr>
|
|
|
|
|
|
|
|
|
|
|
|
<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/io/InputStream.html">InputStream</a></nobr>
|
|
</td>
|
|
<td class="jd-linkcol" width="100%"><nobr>
|
|
<span class="sympad"><a href="../../../org/rundeck/api/RundeckClient.html#exportJobs(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String...)">exportJobs</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> format, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> project, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> jobFilter, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> groupPath, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String...</a> jobIds)</nobr>
|
|
|
|
<div class="jd-descrdiv">Export the definitions of the jobs that belongs to the given project, and matches the given criteria (jobFilter,
|
|
groupPath and jobIds)</div>
|
|
|
|
</td></tr>
|
|
|
|
|
|
|
|
<tr class=" api apilevel-" >
|
|
<td class="jd-typecol"><nobr>
|
|
|
|
|
|
|
|
|
|
|
|
<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/io/InputStream.html">InputStream</a></nobr>
|
|
</td>
|
|
<td class="jd-linkcol" width="100%"><nobr>
|
|
<span class="sympad"><a href="../../../org/rundeck/api/RundeckClient.html#exportJobs(org.rundeck.api.FileType, java.lang.String)">exportJobs</a></span>(<a href="../../../org/rundeck/api/FileType.html">FileType</a> format, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> project)</nobr>
|
|
|
|
<div class="jd-descrdiv">Export the definitions of all jobs that belongs to the given project</div>
|
|
|
|
</td></tr>
|
|
|
|
|
|
|
|
<tr class="alt-color api apilevel-" >
|
|
<td class="jd-typecol"><nobr>
|
|
|
|
|
|
|
|
|
|
|
|
<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/io/InputStream.html">InputStream</a></nobr>
|
|
</td>
|
|
<td class="jd-linkcol" width="100%"><nobr>
|
|
<span class="sympad"><a href="../../../org/rundeck/api/RundeckClient.html#exportJobs(org.rundeck.api.FileType, java.lang.String, java.lang.String, java.lang.String, java.lang.String...)">exportJobs</a></span>(<a href="../../../org/rundeck/api/FileType.html">FileType</a> format, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> project, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> jobFilter, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> groupPath, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String...</a> jobIds)</nobr>
|
|
|
|
<div class="jd-descrdiv">Export the definitions of the jobs that belongs to the given project, and matches the given criteria (jobFilter,
|
|
groupPath and jobIds)</div>
|
|
|
|
</td></tr>
|
|
|
|
|
|
|
|
<tr class=" api apilevel-" >
|
|
<td class="jd-typecol"><nobr>
|
|
|
|
|
|
|
|
|
|
|
|
void</nobr>
|
|
</td>
|
|
<td class="jd-linkcol" width="100%"><nobr>
|
|
<span class="sympad"><a href="../../../org/rundeck/api/RundeckClient.html#exportJobsToFile(java.lang.String, java.lang.String, java.lang.String)">exportJobsToFile</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> filename, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> format, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> project)</nobr>
|
|
|
|
<div class="jd-descrdiv">Export the definitions of all jobs that belongs to the given project</div>
|
|
|
|
</td></tr>
|
|
|
|
|
|
|
|
<tr class="alt-color api apilevel-" >
|
|
<td class="jd-typecol"><nobr>
|
|
|
|
|
|
|
|
|
|
|
|
void</nobr>
|
|
</td>
|
|
<td class="jd-linkcol" width="100%"><nobr>
|
|
<span class="sympad"><a href="../../../org/rundeck/api/RundeckClient.html#exportJobsToFile(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String...)">exportJobsToFile</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> filename, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> format, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> project, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> jobFilter, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> groupPath, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String...</a> jobIds)</nobr>
|
|
|
|
<div class="jd-descrdiv">Export the definitions of the jobs that belongs to the given project, and matches the given criteria (jobFilter,
|
|
groupPath and jobIds)</div>
|
|
|
|
</td></tr>
|
|
|
|
|
|
|
|
<tr class=" api apilevel-" >
|
|
<td class="jd-typecol"><nobr>
|
|
|
|
|
|
|
|
|
|
|
|
void</nobr>
|
|
</td>
|
|
<td class="jd-linkcol" width="100%"><nobr>
|
|
<span class="sympad"><a href="../../../org/rundeck/api/RundeckClient.html#exportJobsToFile(java.lang.String, org.rundeck.api.FileType, java.lang.String)">exportJobsToFile</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> filename, <a href="../../../org/rundeck/api/FileType.html">FileType</a> format, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> project)</nobr>
|
|
|
|
<div class="jd-descrdiv">Export the definitions of all jobs that belongs to the given project</div>
|
|
|
|
</td></tr>
|
|
|
|
|
|
|
|
<tr class="alt-color api apilevel-" >
|
|
<td class="jd-typecol"><nobr>
|
|
|
|
|
|
|
|
|
|
|
|
void</nobr>
|
|
</td>
|
|
<td class="jd-linkcol" width="100%"><nobr>
|
|
<span class="sympad"><a href="../../../org/rundeck/api/RundeckClient.html#exportJobsToFile(java.lang.String, org.rundeck.api.FileType, java.lang.String, java.lang.String, java.lang.String, java.lang.String...)">exportJobsToFile</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> filename, <a href="../../../org/rundeck/api/FileType.html">FileType</a> format, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> project, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> jobFilter, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> groupPath, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String...</a> jobIds)</nobr>
|
|
|
|
<div class="jd-descrdiv">Export the definitions of the jobs that belongs to the given project, and matches the given criteria (jobFilter,
|
|
groupPath and jobIds)</div>
|
|
|
|
</td></tr>
|
|
|
|
|
|
|
|
<tr class=" api apilevel-" >
|
|
<td class="jd-typecol"><nobr>
|
|
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckJob.html">RundeckJob</a></nobr>
|
|
</td>
|
|
<td class="jd-linkcol" width="100%"><nobr>
|
|
<span class="sympad"><a href="../../../org/rundeck/api/RundeckClient.html#findJob(java.lang.String, java.lang.String, java.lang.String)">findJob</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> project, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> groupPath, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> name)</nobr>
|
|
|
|
<div class="jd-descrdiv">Find a job, identified by its project, group and name.</div>
|
|
|
|
</td></tr>
|
|
|
|
|
|
|
|
<tr class="alt-color api apilevel-" >
|
|
<td class="jd-typecol"><nobr>
|
|
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a></nobr>
|
|
</td>
|
|
<td class="jd-linkcol" width="100%"><nobr>
|
|
<span class="sympad"><a href="../../../org/rundeck/api/RundeckClient.html#getExecution(java.lang.Long)">getExecution</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/Long.html">Long</a> executionId)</nobr>
|
|
|
|
<div class="jd-descrdiv">Get a single execution, identified by the given ID</div>
|
|
|
|
</td></tr>
|
|
|
|
|
|
|
|
<tr class=" api apilevel-" >
|
|
<td class="jd-typecol"><nobr>
|
|
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckHistory.html">RundeckHistory</a></nobr>
|
|
</td>
|
|
<td class="jd-linkcol" width="100%"><nobr>
|
|
<span class="sympad"><a href="../../../org/rundeck/api/RundeckClient.html#getHistory(java.lang.String)">getHistory</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> project)</nobr>
|
|
|
|
<div class="jd-descrdiv">Get the (events) history for the given project</div>
|
|
|
|
</td></tr>
|
|
|
|
|
|
|
|
<tr class="alt-color api apilevel-" >
|
|
<td class="jd-typecol"><nobr>
|
|
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckHistory.html">RundeckHistory</a></nobr>
|
|
</td>
|
|
<td class="jd-linkcol" width="100%"><nobr>
|
|
<span class="sympad"><a href="../../../org/rundeck/api/RundeckClient.html#getHistory(java.lang.String, java.lang.Long, java.lang.Long)">getHistory</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> project, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/Long.html">Long</a> max, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/Long.html">Long</a> offset)</nobr>
|
|
|
|
<div class="jd-descrdiv">Get the (events) history for the given project</div>
|
|
|
|
</td></tr>
|
|
|
|
|
|
|
|
<tr class=" api apilevel-" >
|
|
<td class="jd-typecol"><nobr>
|
|
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckHistory.html">RundeckHistory</a></nobr>
|
|
</td>
|
|
<td class="jd-linkcol" width="100%"><nobr>
|
|
<span class="sympad"><a href="../../../org/rundeck/api/RundeckClient.html#getHistory(java.lang.String, java.lang.String)">getHistory</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> project, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> recent)</nobr>
|
|
|
|
<div class="jd-descrdiv">Get the (events) history for the given project</div>
|
|
|
|
</td></tr>
|
|
|
|
|
|
|
|
<tr class="alt-color api apilevel-" >
|
|
<td class="jd-typecol"><nobr>
|
|
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckHistory.html">RundeckHistory</a></nobr>
|
|
</td>
|
|
<td class="jd-linkcol" width="100%"><nobr>
|
|
<span class="sympad"><a href="../../../org/rundeck/api/RundeckClient.html#getHistory(java.lang.String, java.lang.String, java.lang.Long, java.lang.Long)">getHistory</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> project, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> recent, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/Long.html">Long</a> max, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/Long.html">Long</a> offset)</nobr>
|
|
|
|
<div class="jd-descrdiv">Get the (events) history for the given project</div>
|
|
|
|
</td></tr>
|
|
|
|
|
|
|
|
<tr class=" api apilevel-" >
|
|
<td class="jd-typecol"><nobr>
|
|
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckHistory.html">RundeckHistory</a></nobr>
|
|
</td>
|
|
<td class="jd-linkcol" width="100%"><nobr>
|
|
<span class="sympad"><a href="../../../org/rundeck/api/RundeckClient.html#getHistory(java.lang.String, java.lang.String, java.lang.String, java.lang.String)">getHistory</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> project, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> jobId, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> reportId, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> user)</nobr>
|
|
|
|
<div class="jd-descrdiv">Get the (events) history for the given project</div>
|
|
|
|
</td></tr>
|
|
|
|
|
|
|
|
<tr class="alt-color api apilevel-" >
|
|
<td class="jd-typecol"><nobr>
|
|
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckHistory.html">RundeckHistory</a></nobr>
|
|
</td>
|
|
<td class="jd-linkcol" width="100%"><nobr>
|
|
<span class="sympad"><a href="../../../org/rundeck/api/RundeckClient.html#getHistory(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.Long, java.lang.Long)">getHistory</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> project, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> jobId, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> reportId, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> user, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/Long.html">Long</a> max, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/Long.html">Long</a> offset)</nobr>
|
|
|
|
<div class="jd-descrdiv">Get the (events) history for the given project</div>
|
|
|
|
</td></tr>
|
|
|
|
|
|
|
|
<tr class=" api apilevel-" >
|
|
<td class="jd-typecol"><nobr>
|
|
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckHistory.html">RundeckHistory</a></nobr>
|
|
</td>
|
|
<td class="jd-linkcol" width="100%"><nobr>
|
|
<span class="sympad"><a href="../../../org/rundeck/api/RundeckClient.html#getHistory(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.util.Date, java.util.Date, java.lang.Long, java.lang.Long)">getHistory</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> project, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> jobId, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> reportId, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> user, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> recent, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/Date.html">Date</a> begin, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/Date.html">Date</a> end, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/Long.html">Long</a> max, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/Long.html">Long</a> offset)</nobr>
|
|
|
|
<div class="jd-descrdiv">Get the (events) history for the given project</div>
|
|
|
|
</td></tr>
|
|
|
|
|
|
|
|
<tr class="alt-color api apilevel-" >
|
|
<td class="jd-typecol"><nobr>
|
|
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckHistory.html">RundeckHistory</a></nobr>
|
|
</td>
|
|
<td class="jd-linkcol" width="100%"><nobr>
|
|
<span class="sympad"><a href="../../../org/rundeck/api/RundeckClient.html#getHistory(java.lang.String, java.util.Date, java.util.Date)">getHistory</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> project, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/Date.html">Date</a> begin, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/Date.html">Date</a> end)</nobr>
|
|
|
|
<div class="jd-descrdiv">Get the (events) history for the given project</div>
|
|
|
|
</td></tr>
|
|
|
|
|
|
|
|
<tr class=" api apilevel-" >
|
|
<td class="jd-typecol"><nobr>
|
|
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckHistory.html">RundeckHistory</a></nobr>
|
|
</td>
|
|
<td class="jd-linkcol" width="100%"><nobr>
|
|
<span class="sympad"><a href="../../../org/rundeck/api/RundeckClient.html#getHistory(java.lang.String, java.util.Date, java.util.Date, java.lang.Long, java.lang.Long)">getHistory</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> project, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/Date.html">Date</a> begin, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/Date.html">Date</a> end, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/Long.html">Long</a> max, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/Long.html">Long</a> offset)</nobr>
|
|
|
|
<div class="jd-descrdiv">Get the (events) history for the given project</div>
|
|
|
|
</td></tr>
|
|
|
|
|
|
|
|
<tr class="alt-color api apilevel-" >
|
|
<td class="jd-typecol"><nobr>
|
|
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckJob.html">RundeckJob</a></nobr>
|
|
</td>
|
|
<td class="jd-linkcol" width="100%"><nobr>
|
|
<span class="sympad"><a href="../../../org/rundeck/api/RundeckClient.html#getJob(java.lang.String)">getJob</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> jobId)</nobr>
|
|
|
|
<div class="jd-descrdiv">Get the definition of a single job, identified by the given ID</div>
|
|
|
|
</td></tr>
|
|
|
|
|
|
|
|
<tr class=" api apilevel-" >
|
|
<td class="jd-typecol"><nobr>
|
|
|
|
|
|
|
|
|
|
|
|
<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/List.html">List</a><<a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a>></nobr>
|
|
</td>
|
|
<td class="jd-linkcol" width="100%"><nobr>
|
|
<span class="sympad"><a href="../../../org/rundeck/api/RundeckClient.html#getJobExecutions(java.lang.String)">getJobExecutions</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> jobId)</nobr>
|
|
|
|
<div class="jd-descrdiv">Get the executions of the given job</div>
|
|
|
|
</td></tr>
|
|
|
|
|
|
|
|
<tr class="alt-color api apilevel-" >
|
|
<td class="jd-typecol"><nobr>
|
|
|
|
|
|
|
|
|
|
|
|
<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/List.html">List</a><<a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a>></nobr>
|
|
</td>
|
|
<td class="jd-linkcol" width="100%"><nobr>
|
|
<span class="sympad"><a href="../../../org/rundeck/api/RundeckClient.html#getJobExecutions(java.lang.String, java.lang.String)">getJobExecutions</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> jobId, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> status)</nobr>
|
|
|
|
<div class="jd-descrdiv">Get the executions of the given job</div>
|
|
|
|
</td></tr>
|
|
|
|
|
|
|
|
<tr class=" api apilevel-" >
|
|
<td class="jd-typecol"><nobr>
|
|
|
|
|
|
|
|
|
|
|
|
<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/List.html">List</a><<a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a>></nobr>
|
|
</td>
|
|
<td class="jd-linkcol" width="100%"><nobr>
|
|
<span class="sympad"><a href="../../../org/rundeck/api/RundeckClient.html#getJobExecutions(java.lang.String, java.lang.String, java.lang.Long, java.lang.Long)">getJobExecutions</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> jobId, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> status, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/Long.html">Long</a> max, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/Long.html">Long</a> offset)</nobr>
|
|
|
|
<div class="jd-descrdiv">Get the executions of the given job</div>
|
|
|
|
</td></tr>
|
|
|
|
|
|
|
|
<tr class="alt-color api apilevel-" >
|
|
<td class="jd-typecol"><nobr>
|
|
|
|
|
|
|
|
|
|
|
|
<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/List.html">List</a><<a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a>></nobr>
|
|
</td>
|
|
<td class="jd-linkcol" width="100%"><nobr>
|
|
<span class="sympad"><a href="../../../org/rundeck/api/RundeckClient.html#getJobExecutions(java.lang.String, org.rundeck.api.domain.RundeckExecution.ExecutionStatus)">getJobExecutions</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> jobId, <a href="../../../org/rundeck/api/domain/RundeckExecution.ExecutionStatus.html">RundeckExecution.ExecutionStatus</a> status)</nobr>
|
|
|
|
<div class="jd-descrdiv">Get the executions of the given job</div>
|
|
|
|
</td></tr>
|
|
|
|
|
|
|
|
<tr class=" api apilevel-" >
|
|
<td class="jd-typecol"><nobr>
|
|
|
|
|
|
|
|
|
|
|
|
<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/List.html">List</a><<a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a>></nobr>
|
|
</td>
|
|
<td class="jd-linkcol" width="100%"><nobr>
|
|
<span class="sympad"><a href="../../../org/rundeck/api/RundeckClient.html#getJobExecutions(java.lang.String, org.rundeck.api.domain.RundeckExecution.ExecutionStatus, java.lang.Long, java.lang.Long)">getJobExecutions</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> jobId, <a href="../../../org/rundeck/api/domain/RundeckExecution.ExecutionStatus.html">RundeckExecution.ExecutionStatus</a> status, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/Long.html">Long</a> max, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/Long.html">Long</a> offset)</nobr>
|
|
|
|
<div class="jd-descrdiv">Get the executions of the given job</div>
|
|
|
|
</td></tr>
|
|
|
|
|
|
|
|
<tr class="alt-color api apilevel-" >
|
|
<td class="jd-typecol"><nobr>
|
|
|
|
|
|
|
|
|
|
|
|
<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/List.html">List</a><<a href="../../../org/rundeck/api/domain/RundeckJob.html">RundeckJob</a>></nobr>
|
|
</td>
|
|
<td class="jd-linkcol" width="100%"><nobr>
|
|
<span class="sympad"><a href="../../../org/rundeck/api/RundeckClient.html#getJobs()">getJobs</a></span>()</nobr>
|
|
|
|
<div class="jd-descrdiv">List all jobs (for all projects)</div>
|
|
|
|
</td></tr>
|
|
|
|
|
|
|
|
<tr class=" api apilevel-" >
|
|
<td class="jd-typecol"><nobr>
|
|
|
|
|
|
|
|
|
|
|
|
<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/List.html">List</a><<a href="../../../org/rundeck/api/domain/RundeckJob.html">RundeckJob</a>></nobr>
|
|
</td>
|
|
<td class="jd-linkcol" width="100%"><nobr>
|
|
<span class="sympad"><a href="../../../org/rundeck/api/RundeckClient.html#getJobs(java.lang.String)">getJobs</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> project)</nobr>
|
|
|
|
<div class="jd-descrdiv">List all jobs that belongs to the given project</div>
|
|
|
|
</td></tr>
|
|
|
|
|
|
|
|
<tr class="alt-color api apilevel-" >
|
|
<td class="jd-typecol"><nobr>
|
|
|
|
|
|
|
|
|
|
|
|
<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/List.html">List</a><<a href="../../../org/rundeck/api/domain/RundeckJob.html">RundeckJob</a>></nobr>
|
|
</td>
|
|
<td class="jd-linkcol" width="100%"><nobr>
|
|
<span class="sympad"><a href="../../../org/rundeck/api/RundeckClient.html#getJobs(java.lang.String, java.lang.String, java.lang.String, java.lang.String...)">getJobs</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> project, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> jobFilter, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> groupPath, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String...</a> jobIds)</nobr>
|
|
|
|
<div class="jd-descrdiv">List the jobs that belongs to the given project, and matches the given criteria (jobFilter, groupPath and jobIds)</div>
|
|
|
|
</td></tr>
|
|
|
|
|
|
|
|
<tr class=" api apilevel-" >
|
|
<td class="jd-typecol"><nobr>
|
|
|
|
|
|
|
|
|
|
|
|
<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a></nobr>
|
|
</td>
|
|
<td class="jd-linkcol" width="100%"><nobr>
|
|
<span class="sympad"><a href="../../../org/rundeck/api/RundeckClient.html#getLogin()">getLogin</a></span>()</nobr>
|
|
|
|
</td></tr>
|
|
|
|
|
|
|
|
<tr class="alt-color api apilevel-" >
|
|
<td class="jd-typecol"><nobr>
|
|
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckNode.html">RundeckNode</a></nobr>
|
|
</td>
|
|
<td class="jd-linkcol" width="100%"><nobr>
|
|
<span class="sympad"><a href="../../../org/rundeck/api/RundeckClient.html#getNode(java.lang.String, java.lang.String)">getNode</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> name, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> project)</nobr>
|
|
|
|
<div class="jd-descrdiv">Get the definition of a single node</div>
|
|
|
|
</td></tr>
|
|
|
|
|
|
|
|
<tr class=" api apilevel-" >
|
|
<td class="jd-typecol"><nobr>
|
|
|
|
|
|
|
|
|
|
|
|
<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/List.html">List</a><<a href="../../../org/rundeck/api/domain/RundeckNode.html">RundeckNode</a>></nobr>
|
|
</td>
|
|
<td class="jd-linkcol" width="100%"><nobr>
|
|
<span class="sympad"><a href="../../../org/rundeck/api/RundeckClient.html#getNodes()">getNodes</a></span>()</nobr>
|
|
|
|
<div class="jd-descrdiv">List all nodes (for all projects)</div>
|
|
|
|
</td></tr>
|
|
|
|
|
|
|
|
<tr class="alt-color api apilevel-" >
|
|
<td class="jd-typecol"><nobr>
|
|
|
|
|
|
|
|
|
|
|
|
<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/List.html">List</a><<a href="../../../org/rundeck/api/domain/RundeckNode.html">RundeckNode</a>></nobr>
|
|
</td>
|
|
<td class="jd-linkcol" width="100%"><nobr>
|
|
<span class="sympad"><a href="../../../org/rundeck/api/RundeckClient.html#getNodes(java.lang.String)">getNodes</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> project)</nobr>
|
|
|
|
<div class="jd-descrdiv">List all nodes that belongs to the given project</div>
|
|
|
|
</td></tr>
|
|
|
|
|
|
|
|
<tr class=" api apilevel-" >
|
|
<td class="jd-typecol"><nobr>
|
|
|
|
|
|
|
|
|
|
|
|
<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/List.html">List</a><<a href="../../../org/rundeck/api/domain/RundeckNode.html">RundeckNode</a>></nobr>
|
|
</td>
|
|
<td class="jd-linkcol" width="100%"><nobr>
|
|
<span class="sympad"><a href="../../../org/rundeck/api/RundeckClient.html#getNodes(java.lang.String, java.util.Properties)">getNodes</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> project, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/Properties.html">Properties</a> nodeFilters)</nobr>
|
|
|
|
<div class="jd-descrdiv">List nodes that belongs to the given project</div>
|
|
|
|
</td></tr>
|
|
|
|
|
|
|
|
<tr class="alt-color api apilevel-" >
|
|
<td class="jd-typecol"><nobr>
|
|
|
|
|
|
|
|
|
|
|
|
<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a></nobr>
|
|
</td>
|
|
<td class="jd-linkcol" width="100%"><nobr>
|
|
<span class="sympad"><a href="../../../org/rundeck/api/RundeckClient.html#getPassword()">getPassword</a></span>()</nobr>
|
|
|
|
</td></tr>
|
|
|
|
|
|
|
|
<tr class=" api apilevel-" >
|
|
<td class="jd-typecol"><nobr>
|
|
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckProject.html">RundeckProject</a></nobr>
|
|
</td>
|
|
<td class="jd-linkcol" width="100%"><nobr>
|
|
<span class="sympad"><a href="../../../org/rundeck/api/RundeckClient.html#getProject(java.lang.String)">getProject</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> projectName)</nobr>
|
|
|
|
<div class="jd-descrdiv">Get the definition of a single project, identified by the given name</div>
|
|
|
|
</td></tr>
|
|
|
|
|
|
|
|
<tr class="alt-color api apilevel-" >
|
|
<td class="jd-typecol"><nobr>
|
|
|
|
|
|
|
|
|
|
|
|
<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/List.html">List</a><<a href="../../../org/rundeck/api/domain/RundeckProject.html">RundeckProject</a>></nobr>
|
|
</td>
|
|
<td class="jd-linkcol" width="100%"><nobr>
|
|
<span class="sympad"><a href="../../../org/rundeck/api/RundeckClient.html#getProjects()">getProjects</a></span>()</nobr>
|
|
|
|
<div class="jd-descrdiv">List all projects</div>
|
|
|
|
</td></tr>
|
|
|
|
|
|
|
|
<tr class=" api apilevel-" >
|
|
<td class="jd-typecol"><nobr>
|
|
|
|
|
|
|
|
|
|
|
|
<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/List.html">List</a><<a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a>></nobr>
|
|
</td>
|
|
<td class="jd-linkcol" width="100%"><nobr>
|
|
<span class="sympad"><a href="../../../org/rundeck/api/RundeckClient.html#getRunningExecutions()">getRunningExecutions</a></span>()</nobr>
|
|
|
|
<div class="jd-descrdiv">Get all running executions (for all projects)</div>
|
|
|
|
</td></tr>
|
|
|
|
|
|
|
|
<tr class="alt-color api apilevel-" >
|
|
<td class="jd-typecol"><nobr>
|
|
|
|
|
|
|
|
|
|
|
|
<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/List.html">List</a><<a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a>></nobr>
|
|
</td>
|
|
<td class="jd-linkcol" width="100%"><nobr>
|
|
<span class="sympad"><a href="../../../org/rundeck/api/RundeckClient.html#getRunningExecutions(java.lang.String)">getRunningExecutions</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> project)</nobr>
|
|
|
|
<div class="jd-descrdiv">Get the running executions for the given project</div>
|
|
|
|
</td></tr>
|
|
|
|
|
|
|
|
<tr class=" api apilevel-" >
|
|
<td class="jd-typecol"><nobr>
|
|
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckSystemInfo.html">RundeckSystemInfo</a></nobr>
|
|
</td>
|
|
<td class="jd-linkcol" width="100%"><nobr>
|
|
<span class="sympad"><a href="../../../org/rundeck/api/RundeckClient.html#getSystemInfo()">getSystemInfo</a></span>()</nobr>
|
|
|
|
<div class="jd-descrdiv">Get system informations about the RunDeck server</div>
|
|
|
|
</td></tr>
|
|
|
|
|
|
|
|
<tr class="alt-color api apilevel-" >
|
|
<td class="jd-typecol"><nobr>
|
|
|
|
|
|
|
|
|
|
|
|
<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a></nobr>
|
|
</td>
|
|
<td class="jd-linkcol" width="100%"><nobr>
|
|
<span class="sympad"><a href="../../../org/rundeck/api/RundeckClient.html#getToken()">getToken</a></span>()</nobr>
|
|
|
|
</td></tr>
|
|
|
|
|
|
|
|
<tr class=" api apilevel-" >
|
|
<td class="jd-typecol"><nobr>
|
|
|
|
|
|
|
|
|
|
|
|
<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a></nobr>
|
|
</td>
|
|
<td class="jd-linkcol" width="100%"><nobr>
|
|
<span class="sympad"><a href="../../../org/rundeck/api/RundeckClient.html#getUrl()">getUrl</a></span>()</nobr>
|
|
|
|
</td></tr>
|
|
|
|
|
|
|
|
<tr class="alt-color api apilevel-" >
|
|
<td class="jd-typecol"><nobr>
|
|
|
|
|
|
|
|
|
|
|
|
int</nobr>
|
|
</td>
|
|
<td class="jd-linkcol" width="100%"><nobr>
|
|
<span class="sympad"><a href="../../../org/rundeck/api/RundeckClient.html#hashCode()">hashCode</a></span>()</nobr>
|
|
|
|
</td></tr>
|
|
|
|
|
|
|
|
<tr class=" api apilevel-" >
|
|
<td class="jd-typecol"><nobr>
|
|
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckJobsImportResult.html">RundeckJobsImportResult</a></nobr>
|
|
</td>
|
|
<td class="jd-linkcol" width="100%"><nobr>
|
|
<span class="sympad"><a href="../../../org/rundeck/api/RundeckClient.html#importJobs(java.io.InputStream, java.lang.String)">importJobs</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/io/InputStream.html">InputStream</a> stream, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> fileType)</nobr>
|
|
|
|
<div class="jd-descrdiv">Import the definitions of jobs, from the given input stream</div>
|
|
|
|
</td></tr>
|
|
|
|
|
|
|
|
<tr class="alt-color api apilevel-" >
|
|
<td class="jd-typecol"><nobr>
|
|
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckJobsImportResult.html">RundeckJobsImportResult</a></nobr>
|
|
</td>
|
|
<td class="jd-linkcol" width="100%"><nobr>
|
|
<span class="sympad"><a href="../../../org/rundeck/api/RundeckClient.html#importJobs(java.io.InputStream, java.lang.String, java.lang.String)">importJobs</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/io/InputStream.html">InputStream</a> stream, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> fileType, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> importBehavior)</nobr>
|
|
|
|
<div class="jd-descrdiv">Import the definitions of jobs, from the given input stream, using the given behavior</div>
|
|
|
|
</td></tr>
|
|
|
|
|
|
|
|
<tr class=" api apilevel-" >
|
|
<td class="jd-typecol"><nobr>
|
|
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckJobsImportResult.html">RundeckJobsImportResult</a></nobr>
|
|
</td>
|
|
<td class="jd-linkcol" width="100%"><nobr>
|
|
<span class="sympad"><a href="../../../org/rundeck/api/RundeckClient.html#importJobs(java.io.InputStream, org.rundeck.api.FileType)">importJobs</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/io/InputStream.html">InputStream</a> stream, <a href="../../../org/rundeck/api/FileType.html">FileType</a> fileType)</nobr>
|
|
|
|
<div class="jd-descrdiv">Import the definitions of jobs, from the given input stream</div>
|
|
|
|
</td></tr>
|
|
|
|
|
|
|
|
<tr class="alt-color api apilevel-" >
|
|
<td class="jd-typecol"><nobr>
|
|
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckJobsImportResult.html">RundeckJobsImportResult</a></nobr>
|
|
</td>
|
|
<td class="jd-linkcol" width="100%"><nobr>
|
|
<span class="sympad"><a href="../../../org/rundeck/api/RundeckClient.html#importJobs(java.io.InputStream, org.rundeck.api.FileType, org.rundeck.api.domain.RundeckJobsImportMethod)">importJobs</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/io/InputStream.html">InputStream</a> stream, <a href="../../../org/rundeck/api/FileType.html">FileType</a> fileType, <a href="../../../org/rundeck/api/domain/RundeckJobsImportMethod.html">RundeckJobsImportMethod</a> importBehavior)</nobr>
|
|
|
|
<div class="jd-descrdiv">Import the definitions of jobs, from the given input stream, using the given behavior</div>
|
|
|
|
</td></tr>
|
|
|
|
|
|
|
|
<tr class=" api apilevel-" >
|
|
<td class="jd-typecol"><nobr>
|
|
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckJobsImportResult.html">RundeckJobsImportResult</a></nobr>
|
|
</td>
|
|
<td class="jd-linkcol" width="100%"><nobr>
|
|
<span class="sympad"><a href="../../../org/rundeck/api/RundeckClient.html#importJobs(java.lang.String, java.lang.String)">importJobs</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> filename, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> fileType)</nobr>
|
|
|
|
<div class="jd-descrdiv">Import the definitions of jobs, from the given file</div>
|
|
|
|
</td></tr>
|
|
|
|
|
|
|
|
<tr class="alt-color api apilevel-" >
|
|
<td class="jd-typecol"><nobr>
|
|
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckJobsImportResult.html">RundeckJobsImportResult</a></nobr>
|
|
</td>
|
|
<td class="jd-linkcol" width="100%"><nobr>
|
|
<span class="sympad"><a href="../../../org/rundeck/api/RundeckClient.html#importJobs(java.lang.String, java.lang.String, java.lang.String)">importJobs</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> filename, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> fileType, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> importBehavior)</nobr>
|
|
|
|
<div class="jd-descrdiv">Import the definitions of jobs, from the given file, using the given behavior</div>
|
|
|
|
</td></tr>
|
|
|
|
|
|
|
|
<tr class=" api apilevel-" >
|
|
<td class="jd-typecol"><nobr>
|
|
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckJobsImportResult.html">RundeckJobsImportResult</a></nobr>
|
|
</td>
|
|
<td class="jd-linkcol" width="100%"><nobr>
|
|
<span class="sympad"><a href="../../../org/rundeck/api/RundeckClient.html#importJobs(java.lang.String, org.rundeck.api.FileType)">importJobs</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> filename, <a href="../../../org/rundeck/api/FileType.html">FileType</a> fileType)</nobr>
|
|
|
|
<div class="jd-descrdiv">Import the definitions of jobs, from the given file</div>
|
|
|
|
</td></tr>
|
|
|
|
|
|
|
|
<tr class="alt-color api apilevel-" >
|
|
<td class="jd-typecol"><nobr>
|
|
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckJobsImportResult.html">RundeckJobsImportResult</a></nobr>
|
|
</td>
|
|
<td class="jd-linkcol" width="100%"><nobr>
|
|
<span class="sympad"><a href="../../../org/rundeck/api/RundeckClient.html#importJobs(java.lang.String, org.rundeck.api.FileType, org.rundeck.api.domain.RundeckJobsImportMethod)">importJobs</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> filename, <a href="../../../org/rundeck/api/FileType.html">FileType</a> fileType, <a href="../../../org/rundeck/api/domain/RundeckJobsImportMethod.html">RundeckJobsImportMethod</a> importBehavior)</nobr>
|
|
|
|
<div class="jd-descrdiv">Import the definitions of jobs, from the given file, using the given behavior</div>
|
|
|
|
</td></tr>
|
|
|
|
|
|
|
|
<tr class=" api apilevel-" >
|
|
<td class="jd-typecol"><nobr>
|
|
|
|
|
|
|
|
|
|
|
|
void</nobr>
|
|
</td>
|
|
<td class="jd-linkcol" width="100%"><nobr>
|
|
<span class="sympad"><a href="../../../org/rundeck/api/RundeckClient.html#ping()">ping</a></span>()</nobr>
|
|
|
|
<div class="jd-descrdiv">Try to "ping" the RunDeck instance to see if it is alive</div>
|
|
|
|
</td></tr>
|
|
|
|
|
|
|
|
<tr class="alt-color api apilevel-" >
|
|
<td class="jd-typecol"><nobr>
|
|
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a></nobr>
|
|
</td>
|
|
<td class="jd-linkcol" width="100%"><nobr>
|
|
<span class="sympad"><a href="../../../org/rundeck/api/RundeckClient.html#runAdhocCommand(java.lang.String, java.lang.String)">runAdhocCommand</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> project, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> command)</nobr>
|
|
|
|
<div class="jd-descrdiv">Run an ad-hoc command, and wait until its execution is finished (or aborted) to return.</div>
|
|
|
|
</td></tr>
|
|
|
|
|
|
|
|
<tr class=" api apilevel-" >
|
|
<td class="jd-typecol"><nobr>
|
|
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a></nobr>
|
|
</td>
|
|
<td class="jd-linkcol" width="100%"><nobr>
|
|
<span class="sympad"><a href="../../../org/rundeck/api/RundeckClient.html#runAdhocCommand(java.lang.String, java.lang.String, java.util.Properties)">runAdhocCommand</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> project, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> command, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/Properties.html">Properties</a> nodeFilters)</nobr>
|
|
|
|
<div class="jd-descrdiv">Run an ad-hoc command, and wait until its execution is finished (or aborted) to return.</div>
|
|
|
|
</td></tr>
|
|
|
|
|
|
|
|
<tr class="alt-color api apilevel-" >
|
|
<td class="jd-typecol"><nobr>
|
|
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a></nobr>
|
|
</td>
|
|
<td class="jd-linkcol" width="100%"><nobr>
|
|
<span class="sympad"><a href="../../../org/rundeck/api/RundeckClient.html#runAdhocCommand(java.lang.String, java.lang.String, java.util.Properties, java.lang.Integer, java.lang.Boolean)">runAdhocCommand</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> project, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> command, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/Properties.html">Properties</a> nodeFilters, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/Integer.html">Integer</a> nodeThreadcount, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/Boolean.html">Boolean</a> nodeKeepgoing)</nobr>
|
|
|
|
<div class="jd-descrdiv">Run an ad-hoc command, and wait until its execution is finished (or aborted) to return.</div>
|
|
|
|
</td></tr>
|
|
|
|
|
|
|
|
<tr class=" api apilevel-" >
|
|
<td class="jd-typecol"><nobr>
|
|
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a></nobr>
|
|
</td>
|
|
<td class="jd-linkcol" width="100%"><nobr>
|
|
<span class="sympad"><a href="../../../org/rundeck/api/RundeckClient.html#runAdhocCommand(java.lang.String, java.lang.String, java.util.Properties, java.lang.Integer, java.lang.Boolean, long, java.util.concurrent.TimeUnit)">runAdhocCommand</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> project, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> command, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/Properties.html">Properties</a> nodeFilters, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/Integer.html">Integer</a> nodeThreadcount, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/Boolean.html">Boolean</a> nodeKeepgoing, long poolingInterval, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/concurrent/TimeUnit.html">TimeUnit</a> poolingUnit)</nobr>
|
|
|
|
<div class="jd-descrdiv">Run an ad-hoc command, and wait until its execution is finished (or aborted) to return.</div>
|
|
|
|
</td></tr>
|
|
|
|
|
|
|
|
<tr class="alt-color api apilevel-" >
|
|
<td class="jd-typecol"><nobr>
|
|
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a></nobr>
|
|
</td>
|
|
<td class="jd-linkcol" width="100%"><nobr>
|
|
<span class="sympad"><a href="../../../org/rundeck/api/RundeckClient.html#runAdhocCommand(java.lang.String, java.lang.String, java.util.Properties, long, java.util.concurrent.TimeUnit)">runAdhocCommand</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> project, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> command, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/Properties.html">Properties</a> nodeFilters, long poolingInterval, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/concurrent/TimeUnit.html">TimeUnit</a> poolingUnit)</nobr>
|
|
|
|
<div class="jd-descrdiv">Run an ad-hoc command, and wait until its execution is finished (or aborted) to return.</div>
|
|
|
|
</td></tr>
|
|
|
|
|
|
|
|
<tr class=" api apilevel-" >
|
|
<td class="jd-typecol"><nobr>
|
|
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a></nobr>
|
|
</td>
|
|
<td class="jd-linkcol" width="100%"><nobr>
|
|
<span class="sympad"><a href="../../../org/rundeck/api/RundeckClient.html#runAdhocCommand(java.lang.String, java.lang.String, long, java.util.concurrent.TimeUnit)">runAdhocCommand</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> project, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> command, long poolingInterval, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/concurrent/TimeUnit.html">TimeUnit</a> poolingUnit)</nobr>
|
|
|
|
<div class="jd-descrdiv">Run an ad-hoc command, and wait until its execution is finished (or aborted) to return.</div>
|
|
|
|
</td></tr>
|
|
|
|
|
|
|
|
<tr class="alt-color api apilevel-" >
|
|
<td class="jd-typecol"><nobr>
|
|
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a></nobr>
|
|
</td>
|
|
<td class="jd-linkcol" width="100%"><nobr>
|
|
<span class="sympad"><a href="../../../org/rundeck/api/RundeckClient.html#runAdhocScript(java.lang.String, java.io.InputStream)">runAdhocScript</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> project, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/io/InputStream.html">InputStream</a> script)</nobr>
|
|
|
|
<div class="jd-descrdiv">Run an ad-hoc script, and wait until its execution is finished (or aborted) to return.</div>
|
|
|
|
</td></tr>
|
|
|
|
|
|
|
|
<tr class=" api apilevel-" >
|
|
<td class="jd-typecol"><nobr>
|
|
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a></nobr>
|
|
</td>
|
|
<td class="jd-linkcol" width="100%"><nobr>
|
|
<span class="sympad"><a href="../../../org/rundeck/api/RundeckClient.html#runAdhocScript(java.lang.String, java.io.InputStream, java.util.Properties)">runAdhocScript</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> project, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/io/InputStream.html">InputStream</a> script, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/Properties.html">Properties</a> options)</nobr>
|
|
|
|
<div class="jd-descrdiv">Run an ad-hoc script, and wait until its execution is finished (or aborted) to return.</div>
|
|
|
|
</td></tr>
|
|
|
|
|
|
|
|
<tr class="alt-color api apilevel-" >
|
|
<td class="jd-typecol"><nobr>
|
|
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a></nobr>
|
|
</td>
|
|
<td class="jd-linkcol" width="100%"><nobr>
|
|
<span class="sympad"><a href="../../../org/rundeck/api/RundeckClient.html#runAdhocScript(java.lang.String, java.io.InputStream, java.util.Properties, java.util.Properties)">runAdhocScript</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> project, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/io/InputStream.html">InputStream</a> script, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/Properties.html">Properties</a> options, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/Properties.html">Properties</a> nodeFilters)</nobr>
|
|
|
|
<div class="jd-descrdiv">Run an ad-hoc script, and wait until its execution is finished (or aborted) to return.</div>
|
|
|
|
</td></tr>
|
|
|
|
|
|
|
|
<tr class=" api apilevel-" >
|
|
<td class="jd-typecol"><nobr>
|
|
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a></nobr>
|
|
</td>
|
|
<td class="jd-linkcol" width="100%"><nobr>
|
|
<span class="sympad"><a href="../../../org/rundeck/api/RundeckClient.html#runAdhocScript(java.lang.String, java.io.InputStream, java.util.Properties, java.util.Properties, java.lang.Integer, java.lang.Boolean)">runAdhocScript</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> project, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/io/InputStream.html">InputStream</a> script, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/Properties.html">Properties</a> options, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/Properties.html">Properties</a> nodeFilters, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/Integer.html">Integer</a> nodeThreadcount, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/Boolean.html">Boolean</a> nodeKeepgoing)</nobr>
|
|
|
|
<div class="jd-descrdiv">Run an ad-hoc script, and wait until its execution is finished (or aborted) to return.</div>
|
|
|
|
</td></tr>
|
|
|
|
|
|
|
|
<tr class="alt-color api apilevel-" >
|
|
<td class="jd-typecol"><nobr>
|
|
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a></nobr>
|
|
</td>
|
|
<td class="jd-linkcol" width="100%"><nobr>
|
|
<span class="sympad"><a href="../../../org/rundeck/api/RundeckClient.html#runAdhocScript(java.lang.String, java.io.InputStream, java.util.Properties, java.util.Properties, java.lang.Integer, java.lang.Boolean, long, java.util.concurrent.TimeUnit)">runAdhocScript</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> project, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/io/InputStream.html">InputStream</a> script, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/Properties.html">Properties</a> options, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/Properties.html">Properties</a> nodeFilters, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/Integer.html">Integer</a> nodeThreadcount, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/Boolean.html">Boolean</a> nodeKeepgoing, long poolingInterval, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/concurrent/TimeUnit.html">TimeUnit</a> poolingUnit)</nobr>
|
|
|
|
<div class="jd-descrdiv">Run an ad-hoc script, and wait until its execution is finished (or aborted) to return.</div>
|
|
|
|
</td></tr>
|
|
|
|
|
|
|
|
<tr class=" api apilevel-" >
|
|
<td class="jd-typecol"><nobr>
|
|
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a></nobr>
|
|
</td>
|
|
<td class="jd-linkcol" width="100%"><nobr>
|
|
<span class="sympad"><a href="../../../org/rundeck/api/RundeckClient.html#runAdhocScript(java.lang.String, java.io.InputStream, java.util.Properties, java.util.Properties, long, java.util.concurrent.TimeUnit)">runAdhocScript</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> project, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/io/InputStream.html">InputStream</a> script, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/Properties.html">Properties</a> options, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/Properties.html">Properties</a> nodeFilters, long poolingInterval, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/concurrent/TimeUnit.html">TimeUnit</a> poolingUnit)</nobr>
|
|
|
|
<div class="jd-descrdiv">Run an ad-hoc script, and wait until its execution is finished (or aborted) to return.</div>
|
|
|
|
</td></tr>
|
|
|
|
|
|
|
|
<tr class="alt-color api apilevel-" >
|
|
<td class="jd-typecol"><nobr>
|
|
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a></nobr>
|
|
</td>
|
|
<td class="jd-linkcol" width="100%"><nobr>
|
|
<span class="sympad"><a href="../../../org/rundeck/api/RundeckClient.html#runAdhocScript(java.lang.String, java.io.InputStream, java.util.Properties, long, java.util.concurrent.TimeUnit)">runAdhocScript</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> project, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/io/InputStream.html">InputStream</a> script, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/Properties.html">Properties</a> options, long poolingInterval, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/concurrent/TimeUnit.html">TimeUnit</a> poolingUnit)</nobr>
|
|
|
|
<div class="jd-descrdiv">Run an ad-hoc script, and wait until its execution is finished (or aborted) to return.</div>
|
|
|
|
</td></tr>
|
|
|
|
|
|
|
|
<tr class=" api apilevel-" >
|
|
<td class="jd-typecol"><nobr>
|
|
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a></nobr>
|
|
</td>
|
|
<td class="jd-linkcol" width="100%"><nobr>
|
|
<span class="sympad"><a href="../../../org/rundeck/api/RundeckClient.html#runAdhocScript(java.lang.String, java.io.InputStream, long, java.util.concurrent.TimeUnit)">runAdhocScript</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> project, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/io/InputStream.html">InputStream</a> script, long poolingInterval, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/concurrent/TimeUnit.html">TimeUnit</a> poolingUnit)</nobr>
|
|
|
|
<div class="jd-descrdiv">Run an ad-hoc script, and wait until its execution is finished (or aborted) to return.</div>
|
|
|
|
</td></tr>
|
|
|
|
|
|
|
|
<tr class="alt-color api apilevel-" >
|
|
<td class="jd-typecol"><nobr>
|
|
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a></nobr>
|
|
</td>
|
|
<td class="jd-linkcol" width="100%"><nobr>
|
|
<span class="sympad"><a href="../../../org/rundeck/api/RundeckClient.html#runAdhocScript(java.lang.String, java.lang.String)">runAdhocScript</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> project, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> scriptFilename)</nobr>
|
|
|
|
<div class="jd-descrdiv">Run an ad-hoc script, and wait until its execution is finished (or aborted) to return.</div>
|
|
|
|
</td></tr>
|
|
|
|
|
|
|
|
<tr class=" api apilevel-" >
|
|
<td class="jd-typecol"><nobr>
|
|
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a></nobr>
|
|
</td>
|
|
<td class="jd-linkcol" width="100%"><nobr>
|
|
<span class="sympad"><a href="../../../org/rundeck/api/RundeckClient.html#runAdhocScript(java.lang.String, java.lang.String, java.util.Properties)">runAdhocScript</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> project, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> scriptFilename, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/Properties.html">Properties</a> options)</nobr>
|
|
|
|
<div class="jd-descrdiv">Run an ad-hoc script, and wait until its execution is finished (or aborted) to return.</div>
|
|
|
|
</td></tr>
|
|
|
|
|
|
|
|
<tr class="alt-color api apilevel-" >
|
|
<td class="jd-typecol"><nobr>
|
|
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a></nobr>
|
|
</td>
|
|
<td class="jd-linkcol" width="100%"><nobr>
|
|
<span class="sympad"><a href="../../../org/rundeck/api/RundeckClient.html#runAdhocScript(java.lang.String, java.lang.String, java.util.Properties, java.util.Properties)">runAdhocScript</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> project, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> scriptFilename, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/Properties.html">Properties</a> options, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/Properties.html">Properties</a> nodeFilters)</nobr>
|
|
|
|
<div class="jd-descrdiv">Run an ad-hoc script, and wait until its execution is finished (or aborted) to return.</div>
|
|
|
|
</td></tr>
|
|
|
|
|
|
|
|
<tr class=" api apilevel-" >
|
|
<td class="jd-typecol"><nobr>
|
|
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a></nobr>
|
|
</td>
|
|
<td class="jd-linkcol" width="100%"><nobr>
|
|
<span class="sympad"><a href="../../../org/rundeck/api/RundeckClient.html#runAdhocScript(java.lang.String, java.lang.String, java.util.Properties, java.util.Properties, java.lang.Integer, java.lang.Boolean)">runAdhocScript</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> project, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> scriptFilename, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/Properties.html">Properties</a> options, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/Properties.html">Properties</a> nodeFilters, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/Integer.html">Integer</a> nodeThreadcount, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/Boolean.html">Boolean</a> nodeKeepgoing)</nobr>
|
|
|
|
<div class="jd-descrdiv">Run an ad-hoc script, and wait until its execution is finished (or aborted) to return.</div>
|
|
|
|
</td></tr>
|
|
|
|
|
|
|
|
<tr class="alt-color api apilevel-" >
|
|
<td class="jd-typecol"><nobr>
|
|
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a></nobr>
|
|
</td>
|
|
<td class="jd-linkcol" width="100%"><nobr>
|
|
<span class="sympad"><a href="../../../org/rundeck/api/RundeckClient.html#runAdhocScript(java.lang.String, java.lang.String, java.util.Properties, java.util.Properties, java.lang.Integer, java.lang.Boolean, long, java.util.concurrent.TimeUnit)">runAdhocScript</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> project, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> scriptFilename, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/Properties.html">Properties</a> options, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/Properties.html">Properties</a> nodeFilters, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/Integer.html">Integer</a> nodeThreadcount, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/Boolean.html">Boolean</a> nodeKeepgoing, long poolingInterval, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/concurrent/TimeUnit.html">TimeUnit</a> poolingUnit)</nobr>
|
|
|
|
<div class="jd-descrdiv">Run an ad-hoc script, and wait until its execution is finished (or aborted) to return.</div>
|
|
|
|
</td></tr>
|
|
|
|
|
|
|
|
<tr class=" api apilevel-" >
|
|
<td class="jd-typecol"><nobr>
|
|
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a></nobr>
|
|
</td>
|
|
<td class="jd-linkcol" width="100%"><nobr>
|
|
<span class="sympad"><a href="../../../org/rundeck/api/RundeckClient.html#runAdhocScript(java.lang.String, java.lang.String, java.util.Properties, java.util.Properties, long, java.util.concurrent.TimeUnit)">runAdhocScript</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> project, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> scriptFilename, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/Properties.html">Properties</a> options, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/Properties.html">Properties</a> nodeFilters, long poolingInterval, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/concurrent/TimeUnit.html">TimeUnit</a> poolingUnit)</nobr>
|
|
|
|
<div class="jd-descrdiv">Run an ad-hoc script, and wait until its execution is finished (or aborted) to return.</div>
|
|
|
|
</td></tr>
|
|
|
|
|
|
|
|
<tr class="alt-color api apilevel-" >
|
|
<td class="jd-typecol"><nobr>
|
|
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a></nobr>
|
|
</td>
|
|
<td class="jd-linkcol" width="100%"><nobr>
|
|
<span class="sympad"><a href="../../../org/rundeck/api/RundeckClient.html#runAdhocScript(java.lang.String, java.lang.String, java.util.Properties, long, java.util.concurrent.TimeUnit)">runAdhocScript</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> project, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> scriptFilename, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/Properties.html">Properties</a> options, long poolingInterval, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/concurrent/TimeUnit.html">TimeUnit</a> poolingUnit)</nobr>
|
|
|
|
<div class="jd-descrdiv">Run an ad-hoc script, and wait until its execution is finished (or aborted) to return.</div>
|
|
|
|
</td></tr>
|
|
|
|
|
|
|
|
<tr class=" api apilevel-" >
|
|
<td class="jd-typecol"><nobr>
|
|
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a></nobr>
|
|
</td>
|
|
<td class="jd-linkcol" width="100%"><nobr>
|
|
<span class="sympad"><a href="../../../org/rundeck/api/RundeckClient.html#runAdhocScript(java.lang.String, java.lang.String, long, java.util.concurrent.TimeUnit)">runAdhocScript</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> project, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> scriptFilename, long poolingInterval, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/concurrent/TimeUnit.html">TimeUnit</a> poolingUnit)</nobr>
|
|
|
|
<div class="jd-descrdiv">Run an ad-hoc script, and wait until its execution is finished (or aborted) to return.</div>
|
|
|
|
</td></tr>
|
|
|
|
|
|
|
|
<tr class="alt-color api apilevel-" >
|
|
<td class="jd-typecol"><nobr>
|
|
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a></nobr>
|
|
</td>
|
|
<td class="jd-linkcol" width="100%"><nobr>
|
|
<span class="sympad"><a href="../../../org/rundeck/api/RundeckClient.html#runJob(java.lang.String)">runJob</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> jobId)</nobr>
|
|
|
|
<div class="jd-descrdiv">Run a RunDeck job (identified by the given ID), and wait until its execution is finished (or aborted) to return.</div>
|
|
|
|
</td></tr>
|
|
|
|
|
|
|
|
<tr class=" api apilevel-" >
|
|
<td class="jd-typecol"><nobr>
|
|
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a></nobr>
|
|
</td>
|
|
<td class="jd-linkcol" width="100%"><nobr>
|
|
<span class="sympad"><a href="../../../org/rundeck/api/RundeckClient.html#runJob(java.lang.String, java.util.Properties)">runJob</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> jobId, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/Properties.html">Properties</a> options)</nobr>
|
|
|
|
<div class="jd-descrdiv">Run a RunDeck job (identified by the given ID), and wait until its execution is finished (or aborted) to return.</div>
|
|
|
|
</td></tr>
|
|
|
|
|
|
|
|
<tr class="alt-color api apilevel-" >
|
|
<td class="jd-typecol"><nobr>
|
|
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a></nobr>
|
|
</td>
|
|
<td class="jd-linkcol" width="100%"><nobr>
|
|
<span class="sympad"><a href="../../../org/rundeck/api/RundeckClient.html#runJob(java.lang.String, java.util.Properties, java.util.Properties)">runJob</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> jobId, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/Properties.html">Properties</a> options, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/Properties.html">Properties</a> nodeFilters)</nobr>
|
|
|
|
<div class="jd-descrdiv">Run a RunDeck job (identified by the given ID), and wait until its execution is finished (or aborted) to return.</div>
|
|
|
|
</td></tr>
|
|
|
|
|
|
|
|
<tr class=" api apilevel-" >
|
|
<td class="jd-typecol"><nobr>
|
|
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a></nobr>
|
|
</td>
|
|
<td class="jd-linkcol" width="100%"><nobr>
|
|
<span class="sympad"><a href="../../../org/rundeck/api/RundeckClient.html#runJob(java.lang.String, java.util.Properties, java.util.Properties, long, java.util.concurrent.TimeUnit)">runJob</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> jobId, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/Properties.html">Properties</a> options, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/Properties.html">Properties</a> nodeFilters, long poolingInterval, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/concurrent/TimeUnit.html">TimeUnit</a> poolingUnit)</nobr>
|
|
|
|
<div class="jd-descrdiv">Run a RunDeck job (identified by the given ID), and wait until its execution is finished (or aborted) to return.</div>
|
|
|
|
</td></tr>
|
|
|
|
|
|
|
|
<tr class="alt-color api apilevel-" >
|
|
<td class="jd-typecol"><nobr>
|
|
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a></nobr>
|
|
</td>
|
|
<td class="jd-linkcol" width="100%"><nobr>
|
|
<span class="sympad"><a href="../../../org/rundeck/api/RundeckClient.html#runJob(java.lang.String, java.util.Properties, long, java.util.concurrent.TimeUnit)">runJob</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> jobId, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/Properties.html">Properties</a> options, long poolingInterval, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/concurrent/TimeUnit.html">TimeUnit</a> poolingUnit)</nobr>
|
|
|
|
<div class="jd-descrdiv">Run a RunDeck job (identified by the given ID), and wait until its execution is finished (or aborted) to return.</div>
|
|
|
|
</td></tr>
|
|
|
|
|
|
|
|
<tr class=" api apilevel-" >
|
|
<td class="jd-typecol"><nobr>
|
|
|
|
|
|
|
|
|
|
|
|
void</nobr>
|
|
</td>
|
|
<td class="jd-linkcol" width="100%"><nobr>
|
|
<span class="sympad"><a href="../../../org/rundeck/api/RundeckClient.html#testAuth()">testAuth</a></span>()</nobr>
|
|
|
|
<div class="jd-descrdiv">Test the authentication on the RunDeck instance.</div>
|
|
|
|
</td></tr>
|
|
|
|
|
|
|
|
<tr class="alt-color api apilevel-" >
|
|
<td class="jd-typecol"><nobr>
|
|
|
|
|
|
|
|
|
|
|
|
void</nobr>
|
|
</td>
|
|
<td class="jd-linkcol" width="100%"><nobr>
|
|
<span class="sympad"><a href="../../../org/rundeck/api/RundeckClient.html#testCredentials()">testCredentials</a></span>()</nobr>
|
|
|
|
<div class="jd-descrdiv">
|
|
<em>
|
|
This method is deprecated.
|
|
Use <code><a href="../../../org/rundeck/api/RundeckClient.html#testAuth()">testAuth()</a></code></em></div>
|
|
|
|
</td></tr>
|
|
|
|
|
|
|
|
<tr class=" api apilevel-" >
|
|
<td class="jd-typecol"><nobr>
|
|
|
|
|
|
|
|
|
|
|
|
<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a></nobr>
|
|
</td>
|
|
<td class="jd-linkcol" width="100%"><nobr>
|
|
<span class="sympad"><a href="../../../org/rundeck/api/RundeckClient.html#toString()">toString</a></span>()</nobr>
|
|
|
|
</td></tr>
|
|
|
|
|
|
|
|
<tr class="alt-color api apilevel-" >
|
|
<td class="jd-typecol"><nobr>
|
|
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a></nobr>
|
|
</td>
|
|
<td class="jd-linkcol" width="100%"><nobr>
|
|
<span class="sympad"><a href="../../../org/rundeck/api/RundeckClient.html#triggerAdhocCommand(java.lang.String, java.lang.String)">triggerAdhocCommand</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> project, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> command)</nobr>
|
|
|
|
<div class="jd-descrdiv">Trigger the execution of an ad-hoc command, and return immediately (without waiting the end of the execution).</div>
|
|
|
|
</td></tr>
|
|
|
|
|
|
|
|
<tr class=" api apilevel-" >
|
|
<td class="jd-typecol"><nobr>
|
|
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a></nobr>
|
|
</td>
|
|
<td class="jd-linkcol" width="100%"><nobr>
|
|
<span class="sympad"><a href="../../../org/rundeck/api/RundeckClient.html#triggerAdhocCommand(java.lang.String, java.lang.String, java.util.Properties)">triggerAdhocCommand</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> project, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> command, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/Properties.html">Properties</a> nodeFilters)</nobr>
|
|
|
|
<div class="jd-descrdiv">Trigger the execution of an ad-hoc command, and return immediately (without waiting the end of the execution).</div>
|
|
|
|
</td></tr>
|
|
|
|
|
|
|
|
<tr class="alt-color api apilevel-" >
|
|
<td class="jd-typecol"><nobr>
|
|
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a></nobr>
|
|
</td>
|
|
<td class="jd-linkcol" width="100%"><nobr>
|
|
<span class="sympad"><a href="../../../org/rundeck/api/RundeckClient.html#triggerAdhocCommand(java.lang.String, java.lang.String, java.util.Properties, java.lang.Integer, java.lang.Boolean)">triggerAdhocCommand</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> project, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> command, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/Properties.html">Properties</a> nodeFilters, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/Integer.html">Integer</a> nodeThreadcount, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/Boolean.html">Boolean</a> nodeKeepgoing)</nobr>
|
|
|
|
<div class="jd-descrdiv">Trigger the execution of an ad-hoc command, and return immediately (without waiting the end of the execution).</div>
|
|
|
|
</td></tr>
|
|
|
|
|
|
|
|
<tr class=" api apilevel-" >
|
|
<td class="jd-typecol"><nobr>
|
|
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a></nobr>
|
|
</td>
|
|
<td class="jd-linkcol" width="100%"><nobr>
|
|
<span class="sympad"><a href="../../../org/rundeck/api/RundeckClient.html#triggerAdhocScript(java.lang.String, java.io.InputStream)">triggerAdhocScript</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> project, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/io/InputStream.html">InputStream</a> script)</nobr>
|
|
|
|
<div class="jd-descrdiv">Trigger the execution of an ad-hoc script, and return immediately (without waiting the end of the execution).</div>
|
|
|
|
</td></tr>
|
|
|
|
|
|
|
|
<tr class="alt-color api apilevel-" >
|
|
<td class="jd-typecol"><nobr>
|
|
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a></nobr>
|
|
</td>
|
|
<td class="jd-linkcol" width="100%"><nobr>
|
|
<span class="sympad"><a href="../../../org/rundeck/api/RundeckClient.html#triggerAdhocScript(java.lang.String, java.io.InputStream, java.util.Properties)">triggerAdhocScript</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> project, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/io/InputStream.html">InputStream</a> script, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/Properties.html">Properties</a> options)</nobr>
|
|
|
|
<div class="jd-descrdiv">Trigger the execution of an ad-hoc script, and return immediately (without waiting the end of the execution).</div>
|
|
|
|
</td></tr>
|
|
|
|
|
|
|
|
<tr class=" api apilevel-" >
|
|
<td class="jd-typecol"><nobr>
|
|
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a></nobr>
|
|
</td>
|
|
<td class="jd-linkcol" width="100%"><nobr>
|
|
<span class="sympad"><a href="../../../org/rundeck/api/RundeckClient.html#triggerAdhocScript(java.lang.String, java.io.InputStream, java.util.Properties, java.util.Properties)">triggerAdhocScript</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> project, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/io/InputStream.html">InputStream</a> script, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/Properties.html">Properties</a> options, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/Properties.html">Properties</a> nodeFilters)</nobr>
|
|
|
|
<div class="jd-descrdiv">Trigger the execution of an ad-hoc script, and return immediately (without waiting the end of the execution).</div>
|
|
|
|
</td></tr>
|
|
|
|
|
|
|
|
<tr class="alt-color api apilevel-" >
|
|
<td class="jd-typecol"><nobr>
|
|
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a></nobr>
|
|
</td>
|
|
<td class="jd-linkcol" width="100%"><nobr>
|
|
<span class="sympad"><a href="../../../org/rundeck/api/RundeckClient.html#triggerAdhocScript(java.lang.String, java.io.InputStream, java.util.Properties, java.util.Properties, java.lang.Integer, java.lang.Boolean)">triggerAdhocScript</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> project, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/io/InputStream.html">InputStream</a> script, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/Properties.html">Properties</a> options, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/Properties.html">Properties</a> nodeFilters, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/Integer.html">Integer</a> nodeThreadcount, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/Boolean.html">Boolean</a> nodeKeepgoing)</nobr>
|
|
|
|
<div class="jd-descrdiv">Trigger the execution of an ad-hoc script, and return immediately (without waiting the end of the execution).</div>
|
|
|
|
</td></tr>
|
|
|
|
|
|
|
|
<tr class=" api apilevel-" >
|
|
<td class="jd-typecol"><nobr>
|
|
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a></nobr>
|
|
</td>
|
|
<td class="jd-linkcol" width="100%"><nobr>
|
|
<span class="sympad"><a href="../../../org/rundeck/api/RundeckClient.html#triggerAdhocScript(java.lang.String, java.lang.String)">triggerAdhocScript</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> project, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> scriptFilename)</nobr>
|
|
|
|
<div class="jd-descrdiv">Trigger the execution of an ad-hoc script, and return immediately (without waiting the end of the execution).</div>
|
|
|
|
</td></tr>
|
|
|
|
|
|
|
|
<tr class="alt-color api apilevel-" >
|
|
<td class="jd-typecol"><nobr>
|
|
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a></nobr>
|
|
</td>
|
|
<td class="jd-linkcol" width="100%"><nobr>
|
|
<span class="sympad"><a href="../../../org/rundeck/api/RundeckClient.html#triggerAdhocScript(java.lang.String, java.lang.String, java.util.Properties)">triggerAdhocScript</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> project, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> scriptFilename, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/Properties.html">Properties</a> options)</nobr>
|
|
|
|
<div class="jd-descrdiv">Trigger the execution of an ad-hoc script, and return immediately (without waiting the end of the execution).</div>
|
|
|
|
</td></tr>
|
|
|
|
|
|
|
|
<tr class=" api apilevel-" >
|
|
<td class="jd-typecol"><nobr>
|
|
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a></nobr>
|
|
</td>
|
|
<td class="jd-linkcol" width="100%"><nobr>
|
|
<span class="sympad"><a href="../../../org/rundeck/api/RundeckClient.html#triggerAdhocScript(java.lang.String, java.lang.String, java.util.Properties, java.util.Properties)">triggerAdhocScript</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> project, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> scriptFilename, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/Properties.html">Properties</a> options, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/Properties.html">Properties</a> nodeFilters)</nobr>
|
|
|
|
<div class="jd-descrdiv">Trigger the execution of an ad-hoc script, and return immediately (without waiting the end of the execution).</div>
|
|
|
|
</td></tr>
|
|
|
|
|
|
|
|
<tr class="alt-color api apilevel-" >
|
|
<td class="jd-typecol"><nobr>
|
|
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a></nobr>
|
|
</td>
|
|
<td class="jd-linkcol" width="100%"><nobr>
|
|
<span class="sympad"><a href="../../../org/rundeck/api/RundeckClient.html#triggerAdhocScript(java.lang.String, java.lang.String, java.util.Properties, java.util.Properties, java.lang.Integer, java.lang.Boolean)">triggerAdhocScript</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> project, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> scriptFilename, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/Properties.html">Properties</a> options, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/Properties.html">Properties</a> nodeFilters, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/Integer.html">Integer</a> nodeThreadcount, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/Boolean.html">Boolean</a> nodeKeepgoing)</nobr>
|
|
|
|
<div class="jd-descrdiv">Trigger the execution of an ad-hoc script, and return immediately (without waiting the end of the execution).</div>
|
|
|
|
</td></tr>
|
|
|
|
|
|
|
|
<tr class=" api apilevel-" >
|
|
<td class="jd-typecol"><nobr>
|
|
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a></nobr>
|
|
</td>
|
|
<td class="jd-linkcol" width="100%"><nobr>
|
|
<span class="sympad"><a href="../../../org/rundeck/api/RundeckClient.html#triggerJob(java.lang.String)">triggerJob</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> jobId)</nobr>
|
|
|
|
<div class="jd-descrdiv">Trigger the execution of a RunDeck job (identified by the given ID), and return immediately (without waiting the
|
|
end of the job execution)</div>
|
|
|
|
</td></tr>
|
|
|
|
|
|
|
|
<tr class="alt-color api apilevel-" >
|
|
<td class="jd-typecol"><nobr>
|
|
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a></nobr>
|
|
</td>
|
|
<td class="jd-linkcol" width="100%"><nobr>
|
|
<span class="sympad"><a href="../../../org/rundeck/api/RundeckClient.html#triggerJob(java.lang.String, java.util.Properties)">triggerJob</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> jobId, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/Properties.html">Properties</a> options)</nobr>
|
|
|
|
<div class="jd-descrdiv">Trigger the execution of a RunDeck job (identified by the given ID), and return immediately (without waiting the
|
|
end of the job execution)</div>
|
|
|
|
</td></tr>
|
|
|
|
|
|
|
|
<tr class=" api apilevel-" >
|
|
<td class="jd-typecol"><nobr>
|
|
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a></nobr>
|
|
</td>
|
|
<td class="jd-linkcol" width="100%"><nobr>
|
|
<span class="sympad"><a href="../../../org/rundeck/api/RundeckClient.html#triggerJob(java.lang.String, java.util.Properties, java.util.Properties)">triggerJob</a></span>(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> jobId, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/Properties.html">Properties</a> options, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/Properties.html">Properties</a> nodeFilters)</nobr>
|
|
|
|
<div class="jd-descrdiv">Trigger the execution of a RunDeck job (identified by the given ID), and return immediately (without waiting the
|
|
end of the job execution)</div>
|
|
|
|
</td></tr>
|
|
|
|
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ========== METHOD SUMMARY =========== -->
|
|
<table id="inhmethods" class="jd-sumtable"><tr><th>
|
|
<a href="#" class="toggle-all" onclick="return toggleAllInherited(this, null)">[Expand]</a>
|
|
<div style="clear:left;">Inherited Methods</div></th></tr>
|
|
|
|
|
|
<tr class="api apilevel-" >
|
|
<td colspan="12">
|
|
<a href="#" onclick="return toggleInherited(this, null)" id="inherited-methods-java.lang.Object" class="jd-expando-trigger closed"
|
|
><img id="inherited-methods-java.lang.Object-trigger"
|
|
src="../../../../assets/images/triangle-closed.png"
|
|
class="jd-expando-trigger-img" /></a>
|
|
From class
|
|
|
|
<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/Object.html">java.lang.Object</a>
|
|
|
|
<div id="inherited-methods-java.lang.Object">
|
|
<div id="inherited-methods-java.lang.Object-list"
|
|
class="jd-inheritedlinks">
|
|
</div>
|
|
<div id="inherited-methods-java.lang.Object-summary" style="display: none;">
|
|
<table class="jd-sumtable-expando">
|
|
|
|
|
|
|
|
|
|
<tr class="alt-color api apilevel-" >
|
|
<td class="jd-typecol"><nobr>
|
|
|
|
|
|
|
|
|
|
|
|
<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/Object.html">Object</a></nobr>
|
|
</td>
|
|
<td class="jd-linkcol" width="100%"><nobr>
|
|
<span class="sympad">clone</span>()</nobr>
|
|
|
|
</td></tr>
|
|
|
|
|
|
|
|
<tr class=" api apilevel-" >
|
|
<td class="jd-typecol"><nobr>
|
|
|
|
|
|
|
|
|
|
|
|
boolean</nobr>
|
|
</td>
|
|
<td class="jd-linkcol" width="100%"><nobr>
|
|
<span class="sympad">equals</span>(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/Object.html">Object</a> arg0)</nobr>
|
|
|
|
</td></tr>
|
|
|
|
|
|
|
|
<tr class="alt-color api apilevel-" >
|
|
<td class="jd-typecol"><nobr>
|
|
|
|
|
|
|
|
|
|
|
|
void</nobr>
|
|
</td>
|
|
<td class="jd-linkcol" width="100%"><nobr>
|
|
<span class="sympad">finalize</span>()</nobr>
|
|
|
|
</td></tr>
|
|
|
|
|
|
|
|
<tr class=" api apilevel-" >
|
|
<td class="jd-typecol"><nobr>
|
|
|
|
|
|
final
|
|
|
|
|
|
<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/Class.html">Class</a><?></nobr>
|
|
</td>
|
|
<td class="jd-linkcol" width="100%"><nobr>
|
|
<span class="sympad">getClass</span>()</nobr>
|
|
|
|
</td></tr>
|
|
|
|
|
|
|
|
<tr class="alt-color api apilevel-" >
|
|
<td class="jd-typecol"><nobr>
|
|
|
|
|
|
|
|
|
|
|
|
int</nobr>
|
|
</td>
|
|
<td class="jd-linkcol" width="100%"><nobr>
|
|
<span class="sympad">hashCode</span>()</nobr>
|
|
|
|
</td></tr>
|
|
|
|
|
|
|
|
<tr class=" api apilevel-" >
|
|
<td class="jd-typecol"><nobr>
|
|
|
|
|
|
final
|
|
|
|
|
|
void</nobr>
|
|
</td>
|
|
<td class="jd-linkcol" width="100%"><nobr>
|
|
<span class="sympad">notify</span>()</nobr>
|
|
|
|
</td></tr>
|
|
|
|
|
|
|
|
<tr class="alt-color api apilevel-" >
|
|
<td class="jd-typecol"><nobr>
|
|
|
|
|
|
final
|
|
|
|
|
|
void</nobr>
|
|
</td>
|
|
<td class="jd-linkcol" width="100%"><nobr>
|
|
<span class="sympad">notifyAll</span>()</nobr>
|
|
|
|
</td></tr>
|
|
|
|
|
|
|
|
<tr class=" api apilevel-" >
|
|
<td class="jd-typecol"><nobr>
|
|
|
|
|
|
|
|
|
|
|
|
<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a></nobr>
|
|
</td>
|
|
<td class="jd-linkcol" width="100%"><nobr>
|
|
<span class="sympad">toString</span>()</nobr>
|
|
|
|
</td></tr>
|
|
|
|
|
|
|
|
<tr class="alt-color api apilevel-" >
|
|
<td class="jd-typecol"><nobr>
|
|
|
|
|
|
final
|
|
|
|
|
|
void</nobr>
|
|
</td>
|
|
<td class="jd-linkcol" width="100%"><nobr>
|
|
<span class="sympad">wait</span>()</nobr>
|
|
|
|
</td></tr>
|
|
|
|
|
|
|
|
<tr class=" api apilevel-" >
|
|
<td class="jd-typecol"><nobr>
|
|
|
|
|
|
final
|
|
|
|
|
|
void</nobr>
|
|
</td>
|
|
<td class="jd-linkcol" width="100%"><nobr>
|
|
<span class="sympad">wait</span>(long arg0)</nobr>
|
|
|
|
</td></tr>
|
|
|
|
|
|
|
|
<tr class="alt-color api apilevel-" >
|
|
<td class="jd-typecol"><nobr>
|
|
|
|
|
|
final
|
|
|
|
|
|
void</nobr>
|
|
</td>
|
|
<td class="jd-linkcol" width="100%"><nobr>
|
|
<span class="sympad">wait</span>(long arg0, int arg1)</nobr>
|
|
|
|
</td></tr>
|
|
|
|
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</td></tr>
|
|
|
|
|
|
|
|
|
|
</table>
|
|
|
|
|
|
</div><!-- jd-descr (summary) -->
|
|
|
|
<!-- Details -->
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!-- XML Attributes -->
|
|
|
|
|
|
<!-- Enum Values -->
|
|
|
|
|
|
<!-- Constants -->
|
|
|
|
|
|
<!-- ========= ENUM CONSTANTS DETAIL ======== -->
|
|
<h2>Constants</h2>
|
|
|
|
|
|
|
|
|
|
<A NAME="API_ENDPOINT"></A>
|
|
|
|
<div class="jd-details api apilevel-">
|
|
<h4 class="jd-details-title">
|
|
<span class="normal">
|
|
public
|
|
static
|
|
final
|
|
<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a>
|
|
</span>
|
|
API_ENDPOINT
|
|
</h4>
|
|
<div class="api-level">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<div class="jd-details-descr">
|
|
|
|
<div class="jd-tagdata jd-tagdescr"><p>End-point of the API </p></div>
|
|
|
|
|
|
<div class="jd-tagdata">
|
|
<span class="jd-tagtitle">Constant Value: </span>
|
|
<span>
|
|
|
|
"/api/2"
|
|
|
|
</span>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
<A NAME="API_VERSION"></A>
|
|
|
|
<div class="jd-details api apilevel-">
|
|
<h4 class="jd-details-title">
|
|
<span class="normal">
|
|
public
|
|
static
|
|
final
|
|
int
|
|
</span>
|
|
API_VERSION
|
|
</h4>
|
|
<div class="api-level">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<div class="jd-details-descr">
|
|
|
|
<div class="jd-tagdata jd-tagdescr"><p>Version of the API supported </p></div>
|
|
|
|
|
|
<div class="jd-tagdata">
|
|
<span class="jd-tagtitle">Constant Value: </span>
|
|
<span>
|
|
|
|
2
|
|
(0x00000002)
|
|
|
|
</span>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<!-- Fields -->
|
|
|
|
|
|
<!-- Public ctors -->
|
|
|
|
|
|
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
|
<h2>Public Constructors</h2>
|
|
|
|
|
|
|
|
<A NAME="RundeckClient(java.lang.String, java.lang.String)"></A>
|
|
|
|
<div class="jd-details api apilevel-">
|
|
<h4 class="jd-details-title">
|
|
<span class="normal">
|
|
public
|
|
|
|
|
|
|
|
|
|
|
|
</span>
|
|
<span class="sympad">RundeckClient</span>
|
|
<span class="normal">(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> url, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> token)</span>
|
|
</h4>
|
|
<div class="api-level">
|
|
<div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<div class="jd-details-descr">
|
|
|
|
<div class="jd-tagdata jd-tagdescr"><p>Instantiate a new <code><a href="../../../org/rundeck/api/RundeckClient.html">RundeckClient</a></code> for the RunDeck instance at the given url, using token-based
|
|
authentication.</p></div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Parameters</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th>url</td>
|
|
<td>of the RunDeck instance ("http://localhost:4440", "http://rundeck.your-compagny.com/", etc)</td>
|
|
</tr>
|
|
<tr>
|
|
<th>token</td>
|
|
<td>to use for authentication on the RunDeck instance</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Throws</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/IllegalArgumentException.html">IllegalArgumentException</a></td>
|
|
<td>if the url or token is blank (null, empty or whitespace)
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<A NAME="RundeckClient(java.lang.String, java.lang.String, java.lang.String)"></A>
|
|
|
|
<div class="jd-details api apilevel-">
|
|
<h4 class="jd-details-title">
|
|
<span class="normal">
|
|
public
|
|
|
|
|
|
|
|
|
|
|
|
</span>
|
|
<span class="sympad">RundeckClient</span>
|
|
<span class="normal">(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> url, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> login, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> password)</span>
|
|
</h4>
|
|
<div class="api-level">
|
|
<div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<div class="jd-details-descr">
|
|
|
|
<div class="jd-tagdata jd-tagdescr"><p>Instantiate a new <code><a href="../../../org/rundeck/api/RundeckClient.html">RundeckClient</a></code> for the RunDeck instance at the given url, using login-based
|
|
authentication.</p></div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Parameters</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th>url</td>
|
|
<td>of the RunDeck instance ("http://localhost:4440", "http://rundeck.your-compagny.com/", etc)</td>
|
|
</tr>
|
|
<tr>
|
|
<th>login</td>
|
|
<td>to use for authentication on the RunDeck instance</td>
|
|
</tr>
|
|
<tr>
|
|
<th>password</td>
|
|
<td>to use for authentication on the RunDeck instance</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Throws</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/IllegalArgumentException.html">IllegalArgumentException</a></td>
|
|
<td>if the url, login or password is blank (null, empty or whitespace)
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
|
<!-- Protected ctors -->
|
|
|
|
|
|
|
|
<!-- ========= METHOD DETAIL ======== -->
|
|
<!-- Public methdos -->
|
|
|
|
<h2>Public Methods</h2>
|
|
|
|
|
|
|
|
<A NAME="abortExecution(java.lang.Long)"></A>
|
|
|
|
<div class="jd-details api apilevel-">
|
|
<h4 class="jd-details-title">
|
|
<span class="normal">
|
|
public
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckAbort.html">RundeckAbort</a>
|
|
</span>
|
|
<span class="sympad">abortExecution</span>
|
|
<span class="normal">(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/Long.html">Long</a> executionId)</span>
|
|
</h4>
|
|
<div class="api-level">
|
|
<div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<div class="jd-details-descr">
|
|
|
|
<div class="jd-tagdata jd-tagdescr"><p>Abort an execution (identified by the given ID). The execution should be running...</p></div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Parameters</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th>executionId</td>
|
|
<td>identifier of the execution - mandatory</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Returns</h5>
|
|
<ul class="nolist"><li>a <code><a href="../../../org/rundeck/api/domain/RundeckAbort.html">RundeckAbort</a></code> instance - won't be null</li></ul>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Throws</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.html">RundeckApiException</a></td>
|
|
<td>in case of error when calling the API (non-existent execution with this ID)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html">RundeckApiException.RundeckApiLoginException</a></td>
|
|
<td>if the login fails (in case of login-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiTokenException.html">RundeckApiException.RundeckApiTokenException</a></td>
|
|
<td>if the token is invalid (in case of token-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/IllegalArgumentException.html">IllegalArgumentException</a></td>
|
|
<td>if the executionId is null
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<A NAME="deleteJob(java.lang.String)"></A>
|
|
|
|
<div class="jd-details api apilevel-">
|
|
<h4 class="jd-details-title">
|
|
<span class="normal">
|
|
public
|
|
|
|
|
|
|
|
|
|
<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a>
|
|
</span>
|
|
<span class="sympad">deleteJob</span>
|
|
<span class="normal">(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> jobId)</span>
|
|
</h4>
|
|
<div class="api-level">
|
|
<div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<div class="jd-details-descr">
|
|
|
|
<div class="jd-tagdata jd-tagdescr"><p>Delete a single job, identified by the given ID</p></div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Parameters</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th>jobId</td>
|
|
<td>identifier of the job - mandatory</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Returns</h5>
|
|
<ul class="nolist"><li>the success message (note that in case of error, you'll get an exception)</li></ul>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Throws</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.html">RundeckApiException</a></td>
|
|
<td>in case of error when calling the API (non-existent job with this ID)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html">RundeckApiException.RundeckApiLoginException</a></td>
|
|
<td>if the login fails (in case of login-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiTokenException.html">RundeckApiException.RundeckApiTokenException</a></td>
|
|
<td>if the token is invalid (in case of token-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/IllegalArgumentException.html">IllegalArgumentException</a></td>
|
|
<td>if the jobId is blank (null, empty or whitespace)
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<A NAME="equals(java.lang.Object)"></A>
|
|
|
|
<div class="jd-details api apilevel-">
|
|
<h4 class="jd-details-title">
|
|
<span class="normal">
|
|
public
|
|
|
|
|
|
|
|
|
|
boolean
|
|
</span>
|
|
<span class="sympad">equals</span>
|
|
<span class="normal">(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/Object.html">Object</a> obj)</span>
|
|
</h4>
|
|
<div class="api-level">
|
|
<div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<div class="jd-details-descr">
|
|
|
|
<div class="jd-tagdata jd-tagdescr"><p></p></div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<A NAME="exportJob(java.lang.String, java.lang.String)"></A>
|
|
|
|
<div class="jd-details api apilevel-">
|
|
<h4 class="jd-details-title">
|
|
<span class="normal">
|
|
public
|
|
|
|
|
|
|
|
|
|
<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/io/InputStream.html">InputStream</a>
|
|
</span>
|
|
<span class="sympad">exportJob</span>
|
|
<span class="normal">(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> format, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> jobId)</span>
|
|
</h4>
|
|
<div class="api-level">
|
|
<div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<div class="jd-details-descr">
|
|
|
|
<div class="jd-tagdata jd-tagdescr"><p>Export the definition of a single job, identified by the given ID</p></div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Parameters</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th>format</td>
|
|
<td>of the export. See <code><a href="../../../org/rundeck/api/FileType.html">FileType</a></code> - mandatory</td>
|
|
</tr>
|
|
<tr>
|
|
<th>jobId</td>
|
|
<td>identifier of the job - mandatory</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Returns</h5>
|
|
<ul class="nolist"><li>an InputStream instance, not linked to any network resources - won't be null</li></ul>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Throws</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.html">RundeckApiException</a></td>
|
|
<td>in case of error when calling the API (non-existent job with this ID)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html">RundeckApiException.RundeckApiLoginException</a></td>
|
|
<td>if the login fails (in case of login-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiTokenException.html">RundeckApiException.RundeckApiTokenException</a></td>
|
|
<td>if the token is invalid (in case of token-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/IllegalArgumentException.html">IllegalArgumentException</a></td>
|
|
<td>if the format or jobId is blank (null, empty or whitespace), or the format is
|
|
invalid</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">See Also</h5>
|
|
<ul class="nolist"><li><code><a href="../../../org/rundeck/api/RundeckClient.html#exportJobToFile(java.lang.String, java.lang.String, java.lang.String)">exportJobToFile(String, String, String)</a></code></li><li><code><a href="../../../org/rundeck/api/RundeckClient.html#getJob(java.lang.String)">getJob(String)</a></code></li>
|
|
</ul>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<A NAME="exportJob(org.rundeck.api.FileType, java.lang.String)"></A>
|
|
|
|
<div class="jd-details api apilevel-">
|
|
<h4 class="jd-details-title">
|
|
<span class="normal">
|
|
public
|
|
|
|
|
|
|
|
|
|
<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/io/InputStream.html">InputStream</a>
|
|
</span>
|
|
<span class="sympad">exportJob</span>
|
|
<span class="normal">(<a href="../../../org/rundeck/api/FileType.html">FileType</a> format, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> jobId)</span>
|
|
</h4>
|
|
<div class="api-level">
|
|
<div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<div class="jd-details-descr">
|
|
|
|
<div class="jd-tagdata jd-tagdescr"><p>Export the definition of a single job, identified by the given ID</p></div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Parameters</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th>format</td>
|
|
<td>of the export. See <code><a href="../../../org/rundeck/api/FileType.html">FileType</a></code> - mandatory</td>
|
|
</tr>
|
|
<tr>
|
|
<th>jobId</td>
|
|
<td>identifier of the job - mandatory</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Returns</h5>
|
|
<ul class="nolist"><li>an InputStream instance, not linked to any network resources - won't be null</li></ul>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Throws</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.html">RundeckApiException</a></td>
|
|
<td>in case of error when calling the API (non-existent job with this ID)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html">RundeckApiException.RundeckApiLoginException</a></td>
|
|
<td>if the login fails (in case of login-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiTokenException.html">RundeckApiException.RundeckApiTokenException</a></td>
|
|
<td>if the token is invalid (in case of token-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/IllegalArgumentException.html">IllegalArgumentException</a></td>
|
|
<td>if the jobId is blank (null, empty or whitespace), or the format is null</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">See Also</h5>
|
|
<ul class="nolist"><li><code><a href="../../../org/rundeck/api/RundeckClient.html#exportJobToFile(java.lang.String, org.rundeck.api.FileType, java.lang.String)">exportJobToFile(String, FileType, String)</a></code></li><li><code><a href="../../../org/rundeck/api/RundeckClient.html#getJob(java.lang.String)">getJob(String)</a></code></li>
|
|
</ul>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<A NAME="exportJobToFile(java.lang.String, java.lang.String, java.lang.String)"></A>
|
|
|
|
<div class="jd-details api apilevel-">
|
|
<h4 class="jd-details-title">
|
|
<span class="normal">
|
|
public
|
|
|
|
|
|
|
|
|
|
void
|
|
</span>
|
|
<span class="sympad">exportJobToFile</span>
|
|
<span class="normal">(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> filename, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> format, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> jobId)</span>
|
|
</h4>
|
|
<div class="api-level">
|
|
<div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<div class="jd-details-descr">
|
|
|
|
<div class="jd-tagdata jd-tagdescr"><p>Export the definition of a single job (identified by the given ID)</p></div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Parameters</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th>filename</td>
|
|
<td>path of the file where the content should be saved - mandatory</td>
|
|
</tr>
|
|
<tr>
|
|
<th>format</td>
|
|
<td>of the export. See <code><a href="../../../org/rundeck/api/FileType.html">FileType</a></code> - mandatory</td>
|
|
</tr>
|
|
<tr>
|
|
<th>jobId</td>
|
|
<td>identifier of the job - mandatory</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Throws</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.html">RundeckApiException</a></td>
|
|
<td>in case of error when calling the API (non-existent job with this ID)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html">RundeckApiException.RundeckApiLoginException</a></td>
|
|
<td>if the login fails (in case of login-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiTokenException.html">RundeckApiException.RundeckApiTokenException</a></td>
|
|
<td>if the token is invalid (in case of token-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/IllegalArgumentException.html">IllegalArgumentException</a></td>
|
|
<td>if the filename, format or jobId is blank (null, empty or whitespace), or the
|
|
format is invalid</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/io/IOException.html">IOException</a></td>
|
|
<td>if we failed to write to the file</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">See Also</h5>
|
|
<ul class="nolist"><li><code><a href="../../../org/rundeck/api/RundeckClient.html#exportJobToFile(java.lang.String, org.rundeck.api.FileType, java.lang.String)">exportJobToFile(String, FileType, String)</a></code></li><li><code><a href="../../../org/rundeck/api/RundeckClient.html#exportJob(java.lang.String, java.lang.String)">exportJob(String, String)</a></code></li><li><code><a href="../../../org/rundeck/api/RundeckClient.html#getJob(java.lang.String)">getJob(String)</a></code></li>
|
|
</ul>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<A NAME="exportJobToFile(java.lang.String, org.rundeck.api.FileType, java.lang.String)"></A>
|
|
|
|
<div class="jd-details api apilevel-">
|
|
<h4 class="jd-details-title">
|
|
<span class="normal">
|
|
public
|
|
|
|
|
|
|
|
|
|
void
|
|
</span>
|
|
<span class="sympad">exportJobToFile</span>
|
|
<span class="normal">(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> filename, <a href="../../../org/rundeck/api/FileType.html">FileType</a> format, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> jobId)</span>
|
|
</h4>
|
|
<div class="api-level">
|
|
<div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<div class="jd-details-descr">
|
|
|
|
<div class="jd-tagdata jd-tagdescr"><p>Export the definition of a single job (identified by the given ID)</p></div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Parameters</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th>filename</td>
|
|
<td>path of the file where the content should be saved - mandatory</td>
|
|
</tr>
|
|
<tr>
|
|
<th>format</td>
|
|
<td>of the export. See <code><a href="../../../org/rundeck/api/FileType.html">FileType</a></code> - mandatory</td>
|
|
</tr>
|
|
<tr>
|
|
<th>jobId</td>
|
|
<td>identifier of the job - mandatory</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Throws</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.html">RundeckApiException</a></td>
|
|
<td>in case of error when calling the API (non-existent job with this ID)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html">RundeckApiException.RundeckApiLoginException</a></td>
|
|
<td>if the login fails (in case of login-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiTokenException.html">RundeckApiException.RundeckApiTokenException</a></td>
|
|
<td>if the token is invalid (in case of token-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/IllegalArgumentException.html">IllegalArgumentException</a></td>
|
|
<td>if the filename or jobId is blank (null, empty or whitespace), or the format is
|
|
null</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/io/IOException.html">IOException</a></td>
|
|
<td>if we failed to write to the file</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">See Also</h5>
|
|
<ul class="nolist"><li><code><a href="../../../org/rundeck/api/RundeckClient.html#exportJob(org.rundeck.api.FileType, java.lang.String)">exportJob(FileType, String)</a></code></li><li><code><a href="../../../org/rundeck/api/RundeckClient.html#getJob(java.lang.String)">getJob(String)</a></code></li>
|
|
</ul>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<A NAME="exportJobs(java.lang.String, java.lang.String)"></A>
|
|
|
|
<div class="jd-details api apilevel-">
|
|
<h4 class="jd-details-title">
|
|
<span class="normal">
|
|
public
|
|
|
|
|
|
|
|
|
|
<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/io/InputStream.html">InputStream</a>
|
|
</span>
|
|
<span class="sympad">exportJobs</span>
|
|
<span class="normal">(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> format, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> project)</span>
|
|
</h4>
|
|
<div class="api-level">
|
|
<div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<div class="jd-details-descr">
|
|
|
|
<div class="jd-tagdata jd-tagdescr"><p>Export the definitions of all jobs that belongs to the given project</p></div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Parameters</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th>format</td>
|
|
<td>of the export. See <code><a href="../../../org/rundeck/api/FileType.html">FileType</a></code> - mandatory</td>
|
|
</tr>
|
|
<tr>
|
|
<th>project</td>
|
|
<td>name of the project - mandatory</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Returns</h5>
|
|
<ul class="nolist"><li>an InputStream instance, not linked to any network resources - won't be null</li></ul>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Throws</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.html">RundeckApiException</a></td>
|
|
<td>in case of error when calling the API (non-existent project with this name)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html">RundeckApiException.RundeckApiLoginException</a></td>
|
|
<td>if the login fails (in case of login-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiTokenException.html">RundeckApiException.RundeckApiTokenException</a></td>
|
|
<td>if the token is invalid (in case of token-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/IllegalArgumentException.html">IllegalArgumentException</a></td>
|
|
<td>if the format or project is blank (null, empty or whitespace), or the format is
|
|
invalid</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">See Also</h5>
|
|
<ul class="nolist"><li>#exportJobs(FileType, String, String, String, String...)</li><li><code><a href="../../../org/rundeck/api/RundeckClient.html#exportJobsToFile(java.lang.String, java.lang.String, java.lang.String)">exportJobsToFile(String, String, String)</a></code></li>
|
|
</ul>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<A NAME="exportJobs(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String...)"></A>
|
|
|
|
<div class="jd-details api apilevel-">
|
|
<h4 class="jd-details-title">
|
|
<span class="normal">
|
|
public
|
|
|
|
|
|
|
|
|
|
<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/io/InputStream.html">InputStream</a>
|
|
</span>
|
|
<span class="sympad">exportJobs</span>
|
|
<span class="normal">(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> format, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> project, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> jobFilter, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> groupPath, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String...</a> jobIds)</span>
|
|
</h4>
|
|
<div class="api-level">
|
|
<div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<div class="jd-details-descr">
|
|
|
|
<div class="jd-tagdata jd-tagdescr"><p>Export the definitions of the jobs that belongs to the given project, and matches the given criteria (jobFilter,
|
|
groupPath and jobIds)</p></div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Parameters</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th>format</td>
|
|
<td>of the export. See <code><a href="../../../org/rundeck/api/FileType.html">FileType</a></code> - mandatory</td>
|
|
</tr>
|
|
<tr>
|
|
<th>project</td>
|
|
<td>name of the project - mandatory</td>
|
|
</tr>
|
|
<tr>
|
|
<th>jobFilter</td>
|
|
<td>a filter for the job Name - optional</td>
|
|
</tr>
|
|
<tr>
|
|
<th>groupPath</td>
|
|
<td>a group or partial group path to include all jobs within that group path - optional</td>
|
|
</tr>
|
|
<tr>
|
|
<th>jobIds</td>
|
|
<td>a list of Job IDs to include - optional</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Returns</h5>
|
|
<ul class="nolist"><li>an InputStream instance, not linked to any network resources - won't be null</li></ul>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Throws</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.html">RundeckApiException</a></td>
|
|
<td>in case of error when calling the API (non-existent project with this name)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html">RundeckApiException.RundeckApiLoginException</a></td>
|
|
<td>if the login fails (in case of login-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiTokenException.html">RundeckApiException.RundeckApiTokenException</a></td>
|
|
<td>if the token is invalid (in case of token-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/IllegalArgumentException.html">IllegalArgumentException</a></td>
|
|
<td>if the format or project is blank (null, empty or whitespace), or the format is
|
|
invalid</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">See Also</h5>
|
|
<ul class="nolist"><li>#exportJobs(FileType, String, String, String, String...)</li><li>#exportJobsToFile(String, String, String, String, String, String...)</li>
|
|
</ul>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<A NAME="exportJobs(org.rundeck.api.FileType, java.lang.String)"></A>
|
|
|
|
<div class="jd-details api apilevel-">
|
|
<h4 class="jd-details-title">
|
|
<span class="normal">
|
|
public
|
|
|
|
|
|
|
|
|
|
<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/io/InputStream.html">InputStream</a>
|
|
</span>
|
|
<span class="sympad">exportJobs</span>
|
|
<span class="normal">(<a href="../../../org/rundeck/api/FileType.html">FileType</a> format, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> project)</span>
|
|
</h4>
|
|
<div class="api-level">
|
|
<div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<div class="jd-details-descr">
|
|
|
|
<div class="jd-tagdata jd-tagdescr"><p>Export the definitions of all jobs that belongs to the given project</p></div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Parameters</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th>format</td>
|
|
<td>of the export. See <code><a href="../../../org/rundeck/api/FileType.html">FileType</a></code> - mandatory</td>
|
|
</tr>
|
|
<tr>
|
|
<th>project</td>
|
|
<td>name of the project - mandatory</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Returns</h5>
|
|
<ul class="nolist"><li>an InputStream instance, not linked to any network resources - won't be null</li></ul>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Throws</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.html">RundeckApiException</a></td>
|
|
<td>in case of error when calling the API (non-existent project with this name)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html">RundeckApiException.RundeckApiLoginException</a></td>
|
|
<td>if the login fails (in case of login-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiTokenException.html">RundeckApiException.RundeckApiTokenException</a></td>
|
|
<td>if the token is invalid (in case of token-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/IllegalArgumentException.html">IllegalArgumentException</a></td>
|
|
<td>if the project is blank (null, empty or whitespace) or the format is null</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">See Also</h5>
|
|
<ul class="nolist"><li>#exportJobs(FileType, String, String, String, String...)</li><li><code><a href="../../../org/rundeck/api/RundeckClient.html#exportJobsToFile(java.lang.String, org.rundeck.api.FileType, java.lang.String)">exportJobsToFile(String, FileType, String)</a></code></li>
|
|
</ul>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<A NAME="exportJobs(org.rundeck.api.FileType, java.lang.String, java.lang.String, java.lang.String, java.lang.String...)"></A>
|
|
|
|
<div class="jd-details api apilevel-">
|
|
<h4 class="jd-details-title">
|
|
<span class="normal">
|
|
public
|
|
|
|
|
|
|
|
|
|
<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/io/InputStream.html">InputStream</a>
|
|
</span>
|
|
<span class="sympad">exportJobs</span>
|
|
<span class="normal">(<a href="../../../org/rundeck/api/FileType.html">FileType</a> format, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> project, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> jobFilter, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> groupPath, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String...</a> jobIds)</span>
|
|
</h4>
|
|
<div class="api-level">
|
|
<div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<div class="jd-details-descr">
|
|
|
|
<div class="jd-tagdata jd-tagdescr"><p>Export the definitions of the jobs that belongs to the given project, and matches the given criteria (jobFilter,
|
|
groupPath and jobIds)</p></div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Parameters</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th>format</td>
|
|
<td>of the export. See <code><a href="../../../org/rundeck/api/FileType.html">FileType</a></code> - mandatory</td>
|
|
</tr>
|
|
<tr>
|
|
<th>project</td>
|
|
<td>name of the project - mandatory</td>
|
|
</tr>
|
|
<tr>
|
|
<th>jobFilter</td>
|
|
<td>a filter for the job Name - optional</td>
|
|
</tr>
|
|
<tr>
|
|
<th>groupPath</td>
|
|
<td>a group or partial group path to include all jobs within that group path - optional</td>
|
|
</tr>
|
|
<tr>
|
|
<th>jobIds</td>
|
|
<td>a list of Job IDs to include - optional</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Returns</h5>
|
|
<ul class="nolist"><li>an InputStream instance, not linked to any network resources - won't be null</li></ul>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Throws</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.html">RundeckApiException</a></td>
|
|
<td>in case of error when calling the API (non-existent project with this name)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html">RundeckApiException.RundeckApiLoginException</a></td>
|
|
<td>if the login fails (in case of login-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiTokenException.html">RundeckApiException.RundeckApiTokenException</a></td>
|
|
<td>if the token is invalid (in case of token-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/IllegalArgumentException.html">IllegalArgumentException</a></td>
|
|
<td>if the project is blank (null, empty or whitespace) or the format is null</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">See Also</h5>
|
|
<ul class="nolist"><li>#exportJobsToFile(String, FileType, String, String, String, String...)</li>
|
|
</ul>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<A NAME="exportJobsToFile(java.lang.String, java.lang.String, java.lang.String)"></A>
|
|
|
|
<div class="jd-details api apilevel-">
|
|
<h4 class="jd-details-title">
|
|
<span class="normal">
|
|
public
|
|
|
|
|
|
|
|
|
|
void
|
|
</span>
|
|
<span class="sympad">exportJobsToFile</span>
|
|
<span class="normal">(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> filename, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> format, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> project)</span>
|
|
</h4>
|
|
<div class="api-level">
|
|
<div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<div class="jd-details-descr">
|
|
|
|
<div class="jd-tagdata jd-tagdescr"><p>Export the definitions of all jobs that belongs to the given project</p></div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Parameters</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th>filename</td>
|
|
<td>path of the file where the content should be saved - mandatory</td>
|
|
</tr>
|
|
<tr>
|
|
<th>format</td>
|
|
<td>of the export. See <code><a href="../../../org/rundeck/api/FileType.html">FileType</a></code> - mandatory</td>
|
|
</tr>
|
|
<tr>
|
|
<th>project</td>
|
|
<td>name of the project - mandatory</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Throws</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.html">RundeckApiException</a></td>
|
|
<td>in case of error when calling the API (non-existent project with this name)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html">RundeckApiException.RundeckApiLoginException</a></td>
|
|
<td>if the login fails (in case of login-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiTokenException.html">RundeckApiException.RundeckApiTokenException</a></td>
|
|
<td>if the token is invalid (in case of token-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/IllegalArgumentException.html">IllegalArgumentException</a></td>
|
|
<td>if the format or project is blank (null, empty or whitespace), or the format is
|
|
invalid</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/io/IOException.html">IOException</a></td>
|
|
<td>if we failed to write to the file</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">See Also</h5>
|
|
<ul class="nolist"><li>#exportJobsToFile(String, FileType, String, String, String, String...)</li><li><code><a href="../../../org/rundeck/api/RundeckClient.html#exportJobs(java.lang.String, java.lang.String)">exportJobs(String, String)</a></code></li>
|
|
</ul>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<A NAME="exportJobsToFile(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String...)"></A>
|
|
|
|
<div class="jd-details api apilevel-">
|
|
<h4 class="jd-details-title">
|
|
<span class="normal">
|
|
public
|
|
|
|
|
|
|
|
|
|
void
|
|
</span>
|
|
<span class="sympad">exportJobsToFile</span>
|
|
<span class="normal">(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> filename, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> format, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> project, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> jobFilter, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> groupPath, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String...</a> jobIds)</span>
|
|
</h4>
|
|
<div class="api-level">
|
|
<div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<div class="jd-details-descr">
|
|
|
|
<div class="jd-tagdata jd-tagdescr"><p>Export the definitions of the jobs that belongs to the given project, and matches the given criteria (jobFilter,
|
|
groupPath and jobIds)</p></div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Parameters</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th>filename</td>
|
|
<td>path of the file where the content should be saved - mandatory</td>
|
|
</tr>
|
|
<tr>
|
|
<th>format</td>
|
|
<td>of the export. See <code><a href="../../../org/rundeck/api/FileType.html">FileType</a></code> - mandatory</td>
|
|
</tr>
|
|
<tr>
|
|
<th>project</td>
|
|
<td>name of the project - mandatory</td>
|
|
</tr>
|
|
<tr>
|
|
<th>jobFilter</td>
|
|
<td>a filter for the job Name - optional</td>
|
|
</tr>
|
|
<tr>
|
|
<th>groupPath</td>
|
|
<td>a group or partial group path to include all jobs within that group path - optional</td>
|
|
</tr>
|
|
<tr>
|
|
<th>jobIds</td>
|
|
<td>a list of Job IDs to include - optional</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Throws</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.html">RundeckApiException</a></td>
|
|
<td>in case of error when calling the API (non-existent project with this name)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html">RundeckApiException.RundeckApiLoginException</a></td>
|
|
<td>if the login fails (in case of login-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiTokenException.html">RundeckApiException.RundeckApiTokenException</a></td>
|
|
<td>if the token is invalid (in case of token-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/IllegalArgumentException.html">IllegalArgumentException</a></td>
|
|
<td>if the filename, format or project is blank (null, empty or whitespace), or the
|
|
format is invalid</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/io/IOException.html">IOException</a></td>
|
|
<td>if we failed to write to the file</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">See Also</h5>
|
|
<ul class="nolist"><li>#exportJobsToFile(String, FileType, String, String, String, String...)</li><li>#exportJobs(FileType, String, String, String, String...)</li>
|
|
</ul>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<A NAME="exportJobsToFile(java.lang.String, org.rundeck.api.FileType, java.lang.String)"></A>
|
|
|
|
<div class="jd-details api apilevel-">
|
|
<h4 class="jd-details-title">
|
|
<span class="normal">
|
|
public
|
|
|
|
|
|
|
|
|
|
void
|
|
</span>
|
|
<span class="sympad">exportJobsToFile</span>
|
|
<span class="normal">(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> filename, <a href="../../../org/rundeck/api/FileType.html">FileType</a> format, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> project)</span>
|
|
</h4>
|
|
<div class="api-level">
|
|
<div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<div class="jd-details-descr">
|
|
|
|
<div class="jd-tagdata jd-tagdescr"><p>Export the definitions of all jobs that belongs to the given project</p></div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Parameters</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th>filename</td>
|
|
<td>path of the file where the content should be saved - mandatory</td>
|
|
</tr>
|
|
<tr>
|
|
<th>format</td>
|
|
<td>of the export. See <code><a href="../../../org/rundeck/api/FileType.html">FileType</a></code> - mandatory</td>
|
|
</tr>
|
|
<tr>
|
|
<th>project</td>
|
|
<td>name of the project - mandatory</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Throws</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.html">RundeckApiException</a></td>
|
|
<td>in case of error when calling the API (non-existent project with this name)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html">RundeckApiException.RundeckApiLoginException</a></td>
|
|
<td>if the login fails (in case of login-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiTokenException.html">RundeckApiException.RundeckApiTokenException</a></td>
|
|
<td>if the token is invalid (in case of token-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/IllegalArgumentException.html">IllegalArgumentException</a></td>
|
|
<td>if the project is blank (null, empty or whitespace) or the format is null</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/io/IOException.html">IOException</a></td>
|
|
<td>if we failed to write to the file</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">See Also</h5>
|
|
<ul class="nolist"><li>#exportJobsToFile(String, FileType, String, String, String, String...)</li><li><code><a href="../../../org/rundeck/api/RundeckClient.html#exportJobs(org.rundeck.api.FileType, java.lang.String)">exportJobs(FileType, String)</a></code></li>
|
|
</ul>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<A NAME="exportJobsToFile(java.lang.String, org.rundeck.api.FileType, java.lang.String, java.lang.String, java.lang.String, java.lang.String...)"></A>
|
|
|
|
<div class="jd-details api apilevel-">
|
|
<h4 class="jd-details-title">
|
|
<span class="normal">
|
|
public
|
|
|
|
|
|
|
|
|
|
void
|
|
</span>
|
|
<span class="sympad">exportJobsToFile</span>
|
|
<span class="normal">(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> filename, <a href="../../../org/rundeck/api/FileType.html">FileType</a> format, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> project, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> jobFilter, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> groupPath, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String...</a> jobIds)</span>
|
|
</h4>
|
|
<div class="api-level">
|
|
<div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<div class="jd-details-descr">
|
|
|
|
<div class="jd-tagdata jd-tagdescr"><p>Export the definitions of the jobs that belongs to the given project, and matches the given criteria (jobFilter,
|
|
groupPath and jobIds)</p></div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Parameters</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th>filename</td>
|
|
<td>path of the file where the content should be saved - mandatory</td>
|
|
</tr>
|
|
<tr>
|
|
<th>format</td>
|
|
<td>of the export. See <code><a href="../../../org/rundeck/api/FileType.html">FileType</a></code> - mandatory</td>
|
|
</tr>
|
|
<tr>
|
|
<th>project</td>
|
|
<td>name of the project - mandatory</td>
|
|
</tr>
|
|
<tr>
|
|
<th>jobFilter</td>
|
|
<td>a filter for the job Name - optional</td>
|
|
</tr>
|
|
<tr>
|
|
<th>groupPath</td>
|
|
<td>a group or partial group path to include all jobs within that group path - optional</td>
|
|
</tr>
|
|
<tr>
|
|
<th>jobIds</td>
|
|
<td>a list of Job IDs to include - optional</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Throws</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.html">RundeckApiException</a></td>
|
|
<td>in case of error when calling the API (non-existent project with this name)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html">RundeckApiException.RundeckApiLoginException</a></td>
|
|
<td>if the login fails (in case of login-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiTokenException.html">RundeckApiException.RundeckApiTokenException</a></td>
|
|
<td>if the token is invalid (in case of token-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/IllegalArgumentException.html">IllegalArgumentException</a></td>
|
|
<td>if the filename or project is blank (null, empty or whitespace), or the format
|
|
is null</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/io/IOException.html">IOException</a></td>
|
|
<td>if we failed to write to the file</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">See Also</h5>
|
|
<ul class="nolist"><li>#exportJobs(FileType, String, String, String, String...)</li>
|
|
</ul>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<A NAME="findJob(java.lang.String, java.lang.String, java.lang.String)"></A>
|
|
|
|
<div class="jd-details api apilevel-">
|
|
<h4 class="jd-details-title">
|
|
<span class="normal">
|
|
public
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckJob.html">RundeckJob</a>
|
|
</span>
|
|
<span class="sympad">findJob</span>
|
|
<span class="normal">(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> project, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> groupPath, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> name)</span>
|
|
</h4>
|
|
<div class="api-level">
|
|
<div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<div class="jd-details-descr">
|
|
|
|
<div class="jd-tagdata jd-tagdescr"><p>Find a job, identified by its project, group and name. Note that the groupPath is optional, as a job does not
|
|
need to belong to a group (either pass null, or an empty string).</p></div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Parameters</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th>project</td>
|
|
<td>name of the project - mandatory</td>
|
|
</tr>
|
|
<tr>
|
|
<th>groupPath</td>
|
|
<td>group to which the job belongs (if it belongs to a group) - optional</td>
|
|
</tr>
|
|
<tr>
|
|
<th>name</td>
|
|
<td>of the job to find - mandatory</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Returns</h5>
|
|
<ul class="nolist"><li>a <code><a href="../../../org/rundeck/api/domain/RundeckJob.html">RundeckJob</a></code> instance - null if not found</li></ul>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Throws</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.html">RundeckApiException</a></td>
|
|
<td>in case of error when calling the API (non-existent project with this name)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html">RundeckApiException.RundeckApiLoginException</a></td>
|
|
<td>if the login fails (in case of login-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiTokenException.html">RundeckApiException.RundeckApiTokenException</a></td>
|
|
<td>if the token is invalid (in case of token-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/IllegalArgumentException.html">IllegalArgumentException</a></td>
|
|
<td>if the project or the name is blank (null, empty or whitespace)</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">See Also</h5>
|
|
<ul class="nolist"><li><code><a href="../../../org/rundeck/api/RundeckClient.html#getJob(java.lang.String)">getJob(String)</a></code></li>
|
|
</ul>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<A NAME="getExecution(java.lang.Long)"></A>
|
|
|
|
<div class="jd-details api apilevel-">
|
|
<h4 class="jd-details-title">
|
|
<span class="normal">
|
|
public
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a>
|
|
</span>
|
|
<span class="sympad">getExecution</span>
|
|
<span class="normal">(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/Long.html">Long</a> executionId)</span>
|
|
</h4>
|
|
<div class="api-level">
|
|
<div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<div class="jd-details-descr">
|
|
|
|
<div class="jd-tagdata jd-tagdescr"><p>Get a single execution, identified by the given ID</p></div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Parameters</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th>executionId</td>
|
|
<td>identifier of the execution - mandatory</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Returns</h5>
|
|
<ul class="nolist"><li>a <code><a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a></code> instance - won't be null</li></ul>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Throws</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.html">RundeckApiException</a></td>
|
|
<td>in case of error when calling the API (non-existent execution with this ID)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html">RundeckApiException.RundeckApiLoginException</a></td>
|
|
<td>if the login fails (in case of login-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiTokenException.html">RundeckApiException.RundeckApiTokenException</a></td>
|
|
<td>if the token is invalid (in case of token-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/IllegalArgumentException.html">IllegalArgumentException</a></td>
|
|
<td>if the executionId is null
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<A NAME="getHistory(java.lang.String)"></A>
|
|
|
|
<div class="jd-details api apilevel-">
|
|
<h4 class="jd-details-title">
|
|
<span class="normal">
|
|
public
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckHistory.html">RundeckHistory</a>
|
|
</span>
|
|
<span class="sympad">getHistory</span>
|
|
<span class="normal">(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> project)</span>
|
|
</h4>
|
|
<div class="api-level">
|
|
<div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<div class="jd-details-descr">
|
|
|
|
<div class="jd-tagdata jd-tagdescr"><p>Get the (events) history for the given project</p></div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Parameters</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th>project</td>
|
|
<td>name of the project - mandatory</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Returns</h5>
|
|
<ul class="nolist"><li>a <code><a href="../../../org/rundeck/api/domain/RundeckHistory.html">RundeckHistory</a></code> instance - won't be null</li></ul>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Throws</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.html">RundeckApiException</a></td>
|
|
<td>in case of error when calling the API (non-existent project with this name)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html">RundeckApiException.RundeckApiLoginException</a></td>
|
|
<td>if the login fails (in case of login-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiTokenException.html">RundeckApiException.RundeckApiTokenException</a></td>
|
|
<td>if the token is invalid (in case of token-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/IllegalArgumentException.html">IllegalArgumentException</a></td>
|
|
<td>if the project is blank (null, empty or whitespace)</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">See Also</h5>
|
|
<ul class="nolist"><li><code><a href="../../../org/rundeck/api/RundeckClient.html#getHistory(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.util.Date, java.util.Date, java.lang.Long, java.lang.Long)">getHistory(String, String, String, String, String, Date, Date, Long, Long)</a></code></li>
|
|
</ul>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<A NAME="getHistory(java.lang.String, java.lang.Long, java.lang.Long)"></A>
|
|
|
|
<div class="jd-details api apilevel-">
|
|
<h4 class="jd-details-title">
|
|
<span class="normal">
|
|
public
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckHistory.html">RundeckHistory</a>
|
|
</span>
|
|
<span class="sympad">getHistory</span>
|
|
<span class="normal">(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> project, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/Long.html">Long</a> max, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/Long.html">Long</a> offset)</span>
|
|
</h4>
|
|
<div class="api-level">
|
|
<div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<div class="jd-details-descr">
|
|
|
|
<div class="jd-tagdata jd-tagdescr"><p>Get the (events) history for the given project</p></div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Parameters</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th>project</td>
|
|
<td>name of the project - mandatory</td>
|
|
</tr>
|
|
<tr>
|
|
<th>max</td>
|
|
<td>number of results to return - optional (default to 20)</td>
|
|
</tr>
|
|
<tr>
|
|
<th>offset</td>
|
|
<td>the 0-indexed offset for the first result to return - optional (default to O)</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Returns</h5>
|
|
<ul class="nolist"><li>a <code><a href="../../../org/rundeck/api/domain/RundeckHistory.html">RundeckHistory</a></code> instance - won't be null</li></ul>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Throws</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.html">RundeckApiException</a></td>
|
|
<td>in case of error when calling the API (non-existent project with this name)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html">RundeckApiException.RundeckApiLoginException</a></td>
|
|
<td>if the login fails (in case of login-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiTokenException.html">RundeckApiException.RundeckApiTokenException</a></td>
|
|
<td>if the token is invalid (in case of token-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/IllegalArgumentException.html">IllegalArgumentException</a></td>
|
|
<td>if the project is blank (null, empty or whitespace)</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">See Also</h5>
|
|
<ul class="nolist"><li><code><a href="../../../org/rundeck/api/RundeckClient.html#getHistory(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.util.Date, java.util.Date, java.lang.Long, java.lang.Long)">getHistory(String, String, String, String, String, Date, Date, Long, Long)</a></code></li>
|
|
</ul>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<A NAME="getHistory(java.lang.String, java.lang.String)"></A>
|
|
|
|
<div class="jd-details api apilevel-">
|
|
<h4 class="jd-details-title">
|
|
<span class="normal">
|
|
public
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckHistory.html">RundeckHistory</a>
|
|
</span>
|
|
<span class="sympad">getHistory</span>
|
|
<span class="normal">(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> project, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> recent)</span>
|
|
</h4>
|
|
<div class="api-level">
|
|
<div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<div class="jd-details-descr">
|
|
|
|
<div class="jd-tagdata jd-tagdescr"><p>Get the (events) history for the given project</p></div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Parameters</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th>project</td>
|
|
<td>name of the project - mandatory</td>
|
|
</tr>
|
|
<tr>
|
|
<th>recent</td>
|
|
<td>include only events matching the given period of time. Format : "XY", where X is an integer, and Y
|
|
is one of : "h" (hour), "d" (day), "w" (week), "m" (month), "y" (year). Example : "2w" (= last 2
|
|
weeks), "5d" (= last 5 days), etc. Optional.</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Returns</h5>
|
|
<ul class="nolist"><li>a <code><a href="../../../org/rundeck/api/domain/RundeckHistory.html">RundeckHistory</a></code> instance - won't be null</li></ul>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Throws</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.html">RundeckApiException</a></td>
|
|
<td>in case of error when calling the API (non-existent project with this name)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html">RundeckApiException.RundeckApiLoginException</a></td>
|
|
<td>if the login fails (in case of login-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiTokenException.html">RundeckApiException.RundeckApiTokenException</a></td>
|
|
<td>if the token is invalid (in case of token-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/IllegalArgumentException.html">IllegalArgumentException</a></td>
|
|
<td>if the project is blank (null, empty or whitespace)</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">See Also</h5>
|
|
<ul class="nolist"><li><code><a href="../../../org/rundeck/api/RundeckClient.html#getHistory(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.util.Date, java.util.Date, java.lang.Long, java.lang.Long)">getHistory(String, String, String, String, String, Date, Date, Long, Long)</a></code></li>
|
|
</ul>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<A NAME="getHistory(java.lang.String, java.lang.String, java.lang.Long, java.lang.Long)"></A>
|
|
|
|
<div class="jd-details api apilevel-">
|
|
<h4 class="jd-details-title">
|
|
<span class="normal">
|
|
public
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckHistory.html">RundeckHistory</a>
|
|
</span>
|
|
<span class="sympad">getHistory</span>
|
|
<span class="normal">(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> project, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> recent, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/Long.html">Long</a> max, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/Long.html">Long</a> offset)</span>
|
|
</h4>
|
|
<div class="api-level">
|
|
<div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<div class="jd-details-descr">
|
|
|
|
<div class="jd-tagdata jd-tagdescr"><p>Get the (events) history for the given project</p></div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Parameters</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th>project</td>
|
|
<td>name of the project - mandatory</td>
|
|
</tr>
|
|
<tr>
|
|
<th>recent</td>
|
|
<td>include only events matching the given period of time. Format : "XY", where X is an integer, and Y
|
|
is one of : "h" (hour), "d" (day), "w" (week), "m" (month), "y" (year). Example : "2w" (= last 2
|
|
weeks), "5d" (= last 5 days), etc. Optional.</td>
|
|
</tr>
|
|
<tr>
|
|
<th>max</td>
|
|
<td>number of results to return - optional (default to 20)</td>
|
|
</tr>
|
|
<tr>
|
|
<th>offset</td>
|
|
<td>the 0-indexed offset for the first result to return - optional (default to O)</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Returns</h5>
|
|
<ul class="nolist"><li>a <code><a href="../../../org/rundeck/api/domain/RundeckHistory.html">RundeckHistory</a></code> instance - won't be null</li></ul>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Throws</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.html">RundeckApiException</a></td>
|
|
<td>in case of error when calling the API (non-existent project with this name)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html">RundeckApiException.RundeckApiLoginException</a></td>
|
|
<td>if the login fails (in case of login-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiTokenException.html">RundeckApiException.RundeckApiTokenException</a></td>
|
|
<td>if the token is invalid (in case of token-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/IllegalArgumentException.html">IllegalArgumentException</a></td>
|
|
<td>if the project is blank (null, empty or whitespace)</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">See Also</h5>
|
|
<ul class="nolist"><li><code><a href="../../../org/rundeck/api/RundeckClient.html#getHistory(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.util.Date, java.util.Date, java.lang.Long, java.lang.Long)">getHistory(String, String, String, String, String, Date, Date, Long, Long)</a></code></li>
|
|
</ul>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<A NAME="getHistory(java.lang.String, java.lang.String, java.lang.String, java.lang.String)"></A>
|
|
|
|
<div class="jd-details api apilevel-">
|
|
<h4 class="jd-details-title">
|
|
<span class="normal">
|
|
public
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckHistory.html">RundeckHistory</a>
|
|
</span>
|
|
<span class="sympad">getHistory</span>
|
|
<span class="normal">(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> project, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> jobId, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> reportId, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> user)</span>
|
|
</h4>
|
|
<div class="api-level">
|
|
<div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<div class="jd-details-descr">
|
|
|
|
<div class="jd-tagdata jd-tagdescr"><p>Get the (events) history for the given project</p></div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Parameters</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th>project</td>
|
|
<td>name of the project - mandatory</td>
|
|
</tr>
|
|
<tr>
|
|
<th>jobId</td>
|
|
<td>include only events matching the given job ID - optional</td>
|
|
</tr>
|
|
<tr>
|
|
<th>reportId</td>
|
|
<td>include only events matching the given report ID - optional</td>
|
|
</tr>
|
|
<tr>
|
|
<th>user</td>
|
|
<td>include only events created by the given user - optional</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Returns</h5>
|
|
<ul class="nolist"><li>a <code><a href="../../../org/rundeck/api/domain/RundeckHistory.html">RundeckHistory</a></code> instance - won't be null</li></ul>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Throws</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.html">RundeckApiException</a></td>
|
|
<td>in case of error when calling the API (non-existent project with this name)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html">RundeckApiException.RundeckApiLoginException</a></td>
|
|
<td>if the login fails (in case of login-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiTokenException.html">RundeckApiException.RundeckApiTokenException</a></td>
|
|
<td>if the token is invalid (in case of token-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/IllegalArgumentException.html">IllegalArgumentException</a></td>
|
|
<td>if the project is blank (null, empty or whitespace)</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">See Also</h5>
|
|
<ul class="nolist"><li><code><a href="../../../org/rundeck/api/RundeckClient.html#getHistory(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.util.Date, java.util.Date, java.lang.Long, java.lang.Long)">getHistory(String, String, String, String, String, Date, Date, Long, Long)</a></code></li>
|
|
</ul>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<A NAME="getHistory(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.Long, java.lang.Long)"></A>
|
|
|
|
<div class="jd-details api apilevel-">
|
|
<h4 class="jd-details-title">
|
|
<span class="normal">
|
|
public
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckHistory.html">RundeckHistory</a>
|
|
</span>
|
|
<span class="sympad">getHistory</span>
|
|
<span class="normal">(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> project, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> jobId, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> reportId, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> user, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/Long.html">Long</a> max, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/Long.html">Long</a> offset)</span>
|
|
</h4>
|
|
<div class="api-level">
|
|
<div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<div class="jd-details-descr">
|
|
|
|
<div class="jd-tagdata jd-tagdescr"><p>Get the (events) history for the given project</p></div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Parameters</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th>project</td>
|
|
<td>name of the project - mandatory</td>
|
|
</tr>
|
|
<tr>
|
|
<th>jobId</td>
|
|
<td>include only events matching the given job ID - optional</td>
|
|
</tr>
|
|
<tr>
|
|
<th>reportId</td>
|
|
<td>include only events matching the given report ID - optional</td>
|
|
</tr>
|
|
<tr>
|
|
<th>user</td>
|
|
<td>include only events created by the given user - optional</td>
|
|
</tr>
|
|
<tr>
|
|
<th>max</td>
|
|
<td>number of results to return - optional (default to 20)</td>
|
|
</tr>
|
|
<tr>
|
|
<th>offset</td>
|
|
<td>the 0-indexed offset for the first result to return - optional (default to O)</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Returns</h5>
|
|
<ul class="nolist"><li>a <code><a href="../../../org/rundeck/api/domain/RundeckHistory.html">RundeckHistory</a></code> instance - won't be null</li></ul>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Throws</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.html">RundeckApiException</a></td>
|
|
<td>in case of error when calling the API (non-existent project with this name)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html">RundeckApiException.RundeckApiLoginException</a></td>
|
|
<td>if the login fails (in case of login-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiTokenException.html">RundeckApiException.RundeckApiTokenException</a></td>
|
|
<td>if the token is invalid (in case of token-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/IllegalArgumentException.html">IllegalArgumentException</a></td>
|
|
<td>if the project is blank (null, empty or whitespace)</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">See Also</h5>
|
|
<ul class="nolist"><li><code><a href="../../../org/rundeck/api/RundeckClient.html#getHistory(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.util.Date, java.util.Date, java.lang.Long, java.lang.Long)">getHistory(String, String, String, String, String, Date, Date, Long, Long)</a></code></li>
|
|
</ul>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<A NAME="getHistory(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.util.Date, java.util.Date, java.lang.Long, java.lang.Long)"></A>
|
|
|
|
<div class="jd-details api apilevel-">
|
|
<h4 class="jd-details-title">
|
|
<span class="normal">
|
|
public
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckHistory.html">RundeckHistory</a>
|
|
</span>
|
|
<span class="sympad">getHistory</span>
|
|
<span class="normal">(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> project, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> jobId, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> reportId, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> user, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> recent, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/Date.html">Date</a> begin, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/Date.html">Date</a> end, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/Long.html">Long</a> max, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/Long.html">Long</a> offset)</span>
|
|
</h4>
|
|
<div class="api-level">
|
|
<div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<div class="jd-details-descr">
|
|
|
|
<div class="jd-tagdata jd-tagdescr"><p>Get the (events) history for the given project</p></div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Parameters</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th>project</td>
|
|
<td>name of the project - mandatory</td>
|
|
</tr>
|
|
<tr>
|
|
<th>jobId</td>
|
|
<td>include only events matching the given job ID - optional</td>
|
|
</tr>
|
|
<tr>
|
|
<th>reportId</td>
|
|
<td>include only events matching the given report ID - optional</td>
|
|
</tr>
|
|
<tr>
|
|
<th>user</td>
|
|
<td>include only events created by the given user - optional</td>
|
|
</tr>
|
|
<tr>
|
|
<th>recent</td>
|
|
<td>include only events matching the given period of time. Format : "XY", where X is an integer, and Y
|
|
is one of : "h" (hour), "d" (day), "w" (week), "m" (month), "y" (year). Example : "2w" (= last 2
|
|
weeks), "5d" (= last 5 days), etc. Optional.</td>
|
|
</tr>
|
|
<tr>
|
|
<th>begin</td>
|
|
<td>date for the earlier events to retrieve - optional</td>
|
|
</tr>
|
|
<tr>
|
|
<th>end</td>
|
|
<td>date for the latest events to retrieve - optional</td>
|
|
</tr>
|
|
<tr>
|
|
<th>max</td>
|
|
<td>number of results to return - optional (default to 20)</td>
|
|
</tr>
|
|
<tr>
|
|
<th>offset</td>
|
|
<td>the 0-indexed offset for the first result to return - optional (default to O)</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Returns</h5>
|
|
<ul class="nolist"><li>a <code><a href="../../../org/rundeck/api/domain/RundeckHistory.html">RundeckHistory</a></code> instance - won't be null</li></ul>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Throws</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.html">RundeckApiException</a></td>
|
|
<td>in case of error when calling the API (non-existent project with this name)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html">RundeckApiException.RundeckApiLoginException</a></td>
|
|
<td>if the login fails (in case of login-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiTokenException.html">RundeckApiException.RundeckApiTokenException</a></td>
|
|
<td>if the token is invalid (in case of token-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/IllegalArgumentException.html">IllegalArgumentException</a></td>
|
|
<td>if the project is blank (null, empty or whitespace)
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<A NAME="getHistory(java.lang.String, java.util.Date, java.util.Date)"></A>
|
|
|
|
<div class="jd-details api apilevel-">
|
|
<h4 class="jd-details-title">
|
|
<span class="normal">
|
|
public
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckHistory.html">RundeckHistory</a>
|
|
</span>
|
|
<span class="sympad">getHistory</span>
|
|
<span class="normal">(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> project, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/Date.html">Date</a> begin, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/Date.html">Date</a> end)</span>
|
|
</h4>
|
|
<div class="api-level">
|
|
<div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<div class="jd-details-descr">
|
|
|
|
<div class="jd-tagdata jd-tagdescr"><p>Get the (events) history for the given project</p></div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Parameters</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th>project</td>
|
|
<td>name of the project - mandatory</td>
|
|
</tr>
|
|
<tr>
|
|
<th>begin</td>
|
|
<td>date for the earlier events to retrieve - optional</td>
|
|
</tr>
|
|
<tr>
|
|
<th>end</td>
|
|
<td>date for the latest events to retrieve - optional</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Returns</h5>
|
|
<ul class="nolist"><li>a <code><a href="../../../org/rundeck/api/domain/RundeckHistory.html">RundeckHistory</a></code> instance - won't be null</li></ul>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Throws</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.html">RundeckApiException</a></td>
|
|
<td>in case of error when calling the API (non-existent project with this name)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html">RundeckApiException.RundeckApiLoginException</a></td>
|
|
<td>if the login fails (in case of login-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiTokenException.html">RundeckApiException.RundeckApiTokenException</a></td>
|
|
<td>if the token is invalid (in case of token-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/IllegalArgumentException.html">IllegalArgumentException</a></td>
|
|
<td>if the project is blank (null, empty or whitespace)</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">See Also</h5>
|
|
<ul class="nolist"><li><code><a href="../../../org/rundeck/api/RundeckClient.html#getHistory(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.util.Date, java.util.Date, java.lang.Long, java.lang.Long)">getHistory(String, String, String, String, String, Date, Date, Long, Long)</a></code></li>
|
|
</ul>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<A NAME="getHistory(java.lang.String, java.util.Date, java.util.Date, java.lang.Long, java.lang.Long)"></A>
|
|
|
|
<div class="jd-details api apilevel-">
|
|
<h4 class="jd-details-title">
|
|
<span class="normal">
|
|
public
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckHistory.html">RundeckHistory</a>
|
|
</span>
|
|
<span class="sympad">getHistory</span>
|
|
<span class="normal">(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> project, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/Date.html">Date</a> begin, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/Date.html">Date</a> end, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/Long.html">Long</a> max, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/Long.html">Long</a> offset)</span>
|
|
</h4>
|
|
<div class="api-level">
|
|
<div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<div class="jd-details-descr">
|
|
|
|
<div class="jd-tagdata jd-tagdescr"><p>Get the (events) history for the given project</p></div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Parameters</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th>project</td>
|
|
<td>name of the project - mandatory</td>
|
|
</tr>
|
|
<tr>
|
|
<th>begin</td>
|
|
<td>date for the earlier events to retrieve - optional</td>
|
|
</tr>
|
|
<tr>
|
|
<th>end</td>
|
|
<td>date for the latest events to retrieve - optional</td>
|
|
</tr>
|
|
<tr>
|
|
<th>max</td>
|
|
<td>number of results to return - optional (default to 20)</td>
|
|
</tr>
|
|
<tr>
|
|
<th>offset</td>
|
|
<td>the 0-indexed offset for the first result to return - optional (default to O)</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Returns</h5>
|
|
<ul class="nolist"><li>a <code><a href="../../../org/rundeck/api/domain/RundeckHistory.html">RundeckHistory</a></code> instance - won't be null</li></ul>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Throws</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.html">RundeckApiException</a></td>
|
|
<td>in case of error when calling the API (non-existent project with this name)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html">RundeckApiException.RundeckApiLoginException</a></td>
|
|
<td>if the login fails (in case of login-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiTokenException.html">RundeckApiException.RundeckApiTokenException</a></td>
|
|
<td>if the token is invalid (in case of token-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/IllegalArgumentException.html">IllegalArgumentException</a></td>
|
|
<td>if the project is blank (null, empty or whitespace)</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">See Also</h5>
|
|
<ul class="nolist"><li><code><a href="../../../org/rundeck/api/RundeckClient.html#getHistory(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.util.Date, java.util.Date, java.lang.Long, java.lang.Long)">getHistory(String, String, String, String, String, Date, Date, Long, Long)</a></code></li>
|
|
</ul>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<A NAME="getJob(java.lang.String)"></A>
|
|
|
|
<div class="jd-details api apilevel-">
|
|
<h4 class="jd-details-title">
|
|
<span class="normal">
|
|
public
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckJob.html">RundeckJob</a>
|
|
</span>
|
|
<span class="sympad">getJob</span>
|
|
<span class="normal">(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> jobId)</span>
|
|
</h4>
|
|
<div class="api-level">
|
|
<div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<div class="jd-details-descr">
|
|
|
|
<div class="jd-tagdata jd-tagdescr"><p>Get the definition of a single job, identified by the given ID</p></div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Parameters</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th>jobId</td>
|
|
<td>identifier of the job - mandatory</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Returns</h5>
|
|
<ul class="nolist"><li>a <code><a href="../../../org/rundeck/api/domain/RundeckJob.html">RundeckJob</a></code> instance - won't be null</li></ul>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Throws</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.html">RundeckApiException</a></td>
|
|
<td>in case of error when calling the API (non-existent job with this ID)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html">RundeckApiException.RundeckApiLoginException</a></td>
|
|
<td>if the login fails (in case of login-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiTokenException.html">RundeckApiException.RundeckApiTokenException</a></td>
|
|
<td>if the token is invalid (in case of token-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/IllegalArgumentException.html">IllegalArgumentException</a></td>
|
|
<td>if the jobId is blank (null, empty or whitespace)</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">See Also</h5>
|
|
<ul class="nolist"><li><code><a href="../../../org/rundeck/api/RundeckClient.html#findJob(java.lang.String, java.lang.String, java.lang.String)">findJob(String, String, String)</a></code></li><li><code><a href="../../../org/rundeck/api/RundeckClient.html#exportJob(java.lang.String, java.lang.String)">exportJob(String, String)</a></code></li>
|
|
</ul>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<A NAME="getJobExecutions(java.lang.String)"></A>
|
|
|
|
<div class="jd-details api apilevel-">
|
|
<h4 class="jd-details-title">
|
|
<span class="normal">
|
|
public
|
|
|
|
|
|
|
|
|
|
<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/List.html">List</a><<a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a>>
|
|
</span>
|
|
<span class="sympad">getJobExecutions</span>
|
|
<span class="normal">(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> jobId)</span>
|
|
</h4>
|
|
<div class="api-level">
|
|
<div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<div class="jd-details-descr">
|
|
|
|
<div class="jd-tagdata jd-tagdescr"><p>Get the executions of the given job</p></div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Parameters</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th>jobId</td>
|
|
<td>identifier of the job - mandatory</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Returns</h5>
|
|
<ul class="nolist"><li>a List of <code><a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a></code> : might be empty, but won't be null</li></ul>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Throws</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.html">RundeckApiException</a></td>
|
|
<td>in case of error when calling the API (non-existent job with this ID)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html">RundeckApiException.RundeckApiLoginException</a></td>
|
|
<td>if the login fails (in case of login-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiTokenException.html">RundeckApiException.RundeckApiTokenException</a></td>
|
|
<td>if the token is invalid (in case of token-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/IllegalArgumentException.html">IllegalArgumentException</a></td>
|
|
<td>if the jobId is blank (null, empty or whitespace)</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">See Also</h5>
|
|
<ul class="nolist"><li><code><a href="../../../org/rundeck/api/RundeckClient.html#getJobExecutions(java.lang.String, org.rundeck.api.domain.RundeckExecution.ExecutionStatus, java.lang.Long, java.lang.Long)">getJobExecutions(String, RundeckExecution.ExecutionStatus, Long, Long)</a></code></li>
|
|
</ul>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<A NAME="getJobExecutions(java.lang.String, java.lang.String)"></A>
|
|
|
|
<div class="jd-details api apilevel-">
|
|
<h4 class="jd-details-title">
|
|
<span class="normal">
|
|
public
|
|
|
|
|
|
|
|
|
|
<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/List.html">List</a><<a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a>>
|
|
</span>
|
|
<span class="sympad">getJobExecutions</span>
|
|
<span class="normal">(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> jobId, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> status)</span>
|
|
</h4>
|
|
<div class="api-level">
|
|
<div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<div class="jd-details-descr">
|
|
|
|
<div class="jd-tagdata jd-tagdescr"><p>Get the executions of the given job</p></div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Parameters</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th>jobId</td>
|
|
<td>identifier of the job - mandatory</td>
|
|
</tr>
|
|
<tr>
|
|
<th>status</td>
|
|
<td>of the executions, see <code><a href="../../../org/rundeck/api/domain/RundeckExecution.ExecutionStatus.html">RundeckExecution.ExecutionStatus</a></code> - optional (null for all)</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Returns</h5>
|
|
<ul class="nolist"><li>a List of <code><a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a></code> : might be empty, but won't be null</li></ul>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Throws</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.html">RundeckApiException</a></td>
|
|
<td>in case of error when calling the API (non-existent job with this ID)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html">RundeckApiException.RundeckApiLoginException</a></td>
|
|
<td>if the login fails (in case of login-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiTokenException.html">RundeckApiException.RundeckApiTokenException</a></td>
|
|
<td>if the token is invalid (in case of token-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/IllegalArgumentException.html">IllegalArgumentException</a></td>
|
|
<td>if the jobId is blank (null, empty or whitespace), or the executionStatus is
|
|
invalid</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">See Also</h5>
|
|
<ul class="nolist"><li><code><a href="../../../org/rundeck/api/RundeckClient.html#getJobExecutions(java.lang.String, java.lang.String, java.lang.Long, java.lang.Long)">getJobExecutions(String, String, Long, Long)</a></code></li>
|
|
</ul>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<A NAME="getJobExecutions(java.lang.String, java.lang.String, java.lang.Long, java.lang.Long)"></A>
|
|
|
|
<div class="jd-details api apilevel-">
|
|
<h4 class="jd-details-title">
|
|
<span class="normal">
|
|
public
|
|
|
|
|
|
|
|
|
|
<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/List.html">List</a><<a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a>>
|
|
</span>
|
|
<span class="sympad">getJobExecutions</span>
|
|
<span class="normal">(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> jobId, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> status, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/Long.html">Long</a> max, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/Long.html">Long</a> offset)</span>
|
|
</h4>
|
|
<div class="api-level">
|
|
<div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<div class="jd-details-descr">
|
|
|
|
<div class="jd-tagdata jd-tagdescr"><p>Get the executions of the given job</p></div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Parameters</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th>jobId</td>
|
|
<td>identifier of the job - mandatory</td>
|
|
</tr>
|
|
<tr>
|
|
<th>status</td>
|
|
<td>of the executions, see <code><a href="../../../org/rundeck/api/domain/RundeckExecution.ExecutionStatus.html">RundeckExecution.ExecutionStatus</a></code> - optional (null for all)</td>
|
|
</tr>
|
|
<tr>
|
|
<th>max</td>
|
|
<td>number of results to return - optional (null for all)</td>
|
|
</tr>
|
|
<tr>
|
|
<th>offset</td>
|
|
<td>the 0-indexed offset for the first result to return - optional</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Returns</h5>
|
|
<ul class="nolist"><li>a List of <code><a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a></code> : might be empty, but won't be null</li></ul>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Throws</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.html">RundeckApiException</a></td>
|
|
<td>in case of error when calling the API (non-existent job with this ID)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html">RundeckApiException.RundeckApiLoginException</a></td>
|
|
<td>if the login fails (in case of login-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiTokenException.html">RundeckApiException.RundeckApiTokenException</a></td>
|
|
<td>if the token is invalid (in case of token-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/IllegalArgumentException.html">IllegalArgumentException</a></td>
|
|
<td>if the jobId is blank (null, empty or whitespace), or the executionStatus is
|
|
invalid</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">See Also</h5>
|
|
<ul class="nolist"><li><code><a href="../../../org/rundeck/api/RundeckClient.html#getJobExecutions(java.lang.String, org.rundeck.api.domain.RundeckExecution.ExecutionStatus, java.lang.Long, java.lang.Long)">getJobExecutions(String, RundeckExecution.ExecutionStatus, Long, Long)</a></code></li>
|
|
</ul>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<A NAME="getJobExecutions(java.lang.String, org.rundeck.api.domain.RundeckExecution.ExecutionStatus)"></A>
|
|
|
|
<div class="jd-details api apilevel-">
|
|
<h4 class="jd-details-title">
|
|
<span class="normal">
|
|
public
|
|
|
|
|
|
|
|
|
|
<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/List.html">List</a><<a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a>>
|
|
</span>
|
|
<span class="sympad">getJobExecutions</span>
|
|
<span class="normal">(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> jobId, <a href="../../../org/rundeck/api/domain/RundeckExecution.ExecutionStatus.html">RundeckExecution.ExecutionStatus</a> status)</span>
|
|
</h4>
|
|
<div class="api-level">
|
|
<div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<div class="jd-details-descr">
|
|
|
|
<div class="jd-tagdata jd-tagdescr"><p>Get the executions of the given job</p></div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Parameters</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th>jobId</td>
|
|
<td>identifier of the job - mandatory</td>
|
|
</tr>
|
|
<tr>
|
|
<th>status</td>
|
|
<td>of the executions, see <code><a href="../../../org/rundeck/api/domain/RundeckExecution.ExecutionStatus.html">RundeckExecution.ExecutionStatus</a></code> - optional (null for all)</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Returns</h5>
|
|
<ul class="nolist"><li>a List of <code><a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a></code> : might be empty, but won't be null</li></ul>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Throws</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.html">RundeckApiException</a></td>
|
|
<td>in case of error when calling the API (non-existent job with this ID)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html">RundeckApiException.RundeckApiLoginException</a></td>
|
|
<td>if the login fails (in case of login-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiTokenException.html">RundeckApiException.RundeckApiTokenException</a></td>
|
|
<td>if the token is invalid (in case of token-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/IllegalArgumentException.html">IllegalArgumentException</a></td>
|
|
<td>if the jobId is blank (null, empty or whitespace)</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">See Also</h5>
|
|
<ul class="nolist"><li><code><a href="../../../org/rundeck/api/RundeckClient.html#getJobExecutions(java.lang.String, org.rundeck.api.domain.RundeckExecution.ExecutionStatus, java.lang.Long, java.lang.Long)">getJobExecutions(String, RundeckExecution.ExecutionStatus, Long, Long)</a></code></li>
|
|
</ul>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<A NAME="getJobExecutions(java.lang.String, org.rundeck.api.domain.RundeckExecution.ExecutionStatus, java.lang.Long, java.lang.Long)"></A>
|
|
|
|
<div class="jd-details api apilevel-">
|
|
<h4 class="jd-details-title">
|
|
<span class="normal">
|
|
public
|
|
|
|
|
|
|
|
|
|
<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/List.html">List</a><<a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a>>
|
|
</span>
|
|
<span class="sympad">getJobExecutions</span>
|
|
<span class="normal">(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> jobId, <a href="../../../org/rundeck/api/domain/RundeckExecution.ExecutionStatus.html">RundeckExecution.ExecutionStatus</a> status, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/Long.html">Long</a> max, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/Long.html">Long</a> offset)</span>
|
|
</h4>
|
|
<div class="api-level">
|
|
<div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<div class="jd-details-descr">
|
|
|
|
<div class="jd-tagdata jd-tagdescr"><p>Get the executions of the given job</p></div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Parameters</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th>jobId</td>
|
|
<td>identifier of the job - mandatory</td>
|
|
</tr>
|
|
<tr>
|
|
<th>status</td>
|
|
<td>of the executions, see <code><a href="../../../org/rundeck/api/domain/RundeckExecution.ExecutionStatus.html">RundeckExecution.ExecutionStatus</a></code> - optional (null for all)</td>
|
|
</tr>
|
|
<tr>
|
|
<th>max</td>
|
|
<td>number of results to return - optional (null for all)</td>
|
|
</tr>
|
|
<tr>
|
|
<th>offset</td>
|
|
<td>the 0-indexed offset for the first result to return - optional</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Returns</h5>
|
|
<ul class="nolist"><li>a List of <code><a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a></code> : might be empty, but won't be null</li></ul>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Throws</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.html">RundeckApiException</a></td>
|
|
<td>in case of error when calling the API (non-existent job with this ID)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html">RundeckApiException.RundeckApiLoginException</a></td>
|
|
<td>if the login fails (in case of login-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiTokenException.html">RundeckApiException.RundeckApiTokenException</a></td>
|
|
<td>if the token is invalid (in case of token-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/IllegalArgumentException.html">IllegalArgumentException</a></td>
|
|
<td>if the jobId is blank (null, empty or whitespace)
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<A NAME="getJobs()"></A>
|
|
|
|
<div class="jd-details api apilevel-">
|
|
<h4 class="jd-details-title">
|
|
<span class="normal">
|
|
public
|
|
|
|
|
|
|
|
|
|
<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/List.html">List</a><<a href="../../../org/rundeck/api/domain/RundeckJob.html">RundeckJob</a>>
|
|
</span>
|
|
<span class="sympad">getJobs</span>
|
|
<span class="normal">()</span>
|
|
</h4>
|
|
<div class="api-level">
|
|
<div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<div class="jd-details-descr">
|
|
|
|
<div class="jd-tagdata jd-tagdescr"><p>List all jobs (for all projects)</p></div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Returns</h5>
|
|
<ul class="nolist"><li>a List of <code><a href="../../../org/rundeck/api/domain/RundeckJob.html">RundeckJob</a></code> : might be empty, but won't be null</li></ul>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Throws</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.html">RundeckApiException</a></td>
|
|
<td>in case of error when calling the API</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html">RundeckApiException.RundeckApiLoginException</a></td>
|
|
<td>if the login fails (in case of login-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiTokenException.html">RundeckApiException.RundeckApiTokenException</a></td>
|
|
<td>if the token is invalid (in case of token-based authentication)
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<A NAME="getJobs(java.lang.String)"></A>
|
|
|
|
<div class="jd-details api apilevel-">
|
|
<h4 class="jd-details-title">
|
|
<span class="normal">
|
|
public
|
|
|
|
|
|
|
|
|
|
<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/List.html">List</a><<a href="../../../org/rundeck/api/domain/RundeckJob.html">RundeckJob</a>>
|
|
</span>
|
|
<span class="sympad">getJobs</span>
|
|
<span class="normal">(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> project)</span>
|
|
</h4>
|
|
<div class="api-level">
|
|
<div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<div class="jd-details-descr">
|
|
|
|
<div class="jd-tagdata jd-tagdescr"><p>List all jobs that belongs to the given project</p></div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Parameters</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th>project</td>
|
|
<td>name of the project - mandatory</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Returns</h5>
|
|
<ul class="nolist"><li>a List of <code><a href="../../../org/rundeck/api/domain/RundeckJob.html">RundeckJob</a></code> : might be empty, but won't be null</li></ul>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Throws</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.html">RundeckApiException</a></td>
|
|
<td>in case of error when calling the API (non-existent project with this name)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html">RundeckApiException.RundeckApiLoginException</a></td>
|
|
<td>if the login fails (in case of login-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiTokenException.html">RundeckApiException.RundeckApiTokenException</a></td>
|
|
<td>if the token is invalid (in case of token-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/IllegalArgumentException.html">IllegalArgumentException</a></td>
|
|
<td>if the project is blank (null, empty or whitespace)</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">See Also</h5>
|
|
<ul class="nolist"><li>#getJobs(String, String, String, String...)</li>
|
|
</ul>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<A NAME="getJobs(java.lang.String, java.lang.String, java.lang.String, java.lang.String...)"></A>
|
|
|
|
<div class="jd-details api apilevel-">
|
|
<h4 class="jd-details-title">
|
|
<span class="normal">
|
|
public
|
|
|
|
|
|
|
|
|
|
<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/List.html">List</a><<a href="../../../org/rundeck/api/domain/RundeckJob.html">RundeckJob</a>>
|
|
</span>
|
|
<span class="sympad">getJobs</span>
|
|
<span class="normal">(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> project, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> jobFilter, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> groupPath, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String...</a> jobIds)</span>
|
|
</h4>
|
|
<div class="api-level">
|
|
<div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<div class="jd-details-descr">
|
|
|
|
<div class="jd-tagdata jd-tagdescr"><p>List the jobs that belongs to the given project, and matches the given criteria (jobFilter, groupPath and jobIds)</p></div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Parameters</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th>project</td>
|
|
<td>name of the project - mandatory</td>
|
|
</tr>
|
|
<tr>
|
|
<th>jobFilter</td>
|
|
<td>a filter for the job Name - optional</td>
|
|
</tr>
|
|
<tr>
|
|
<th>groupPath</td>
|
|
<td>a group or partial group path to include all jobs within that group path - optional</td>
|
|
</tr>
|
|
<tr>
|
|
<th>jobIds</td>
|
|
<td>a list of Job IDs to include - optional</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Returns</h5>
|
|
<ul class="nolist"><li>a List of <code><a href="../../../org/rundeck/api/domain/RundeckJob.html">RundeckJob</a></code> : might be empty, but won't be null</li></ul>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Throws</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.html">RundeckApiException</a></td>
|
|
<td>in case of error when calling the API (non-existent project with this name)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html">RundeckApiException.RundeckApiLoginException</a></td>
|
|
<td>if the login fails (in case of login-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiTokenException.html">RundeckApiException.RundeckApiTokenException</a></td>
|
|
<td>if the token is invalid (in case of token-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/IllegalArgumentException.html">IllegalArgumentException</a></td>
|
|
<td>if the project is blank (null, empty or whitespace)</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">See Also</h5>
|
|
<ul class="nolist"><li><code><a href="../../../org/rundeck/api/RundeckClient.html#getJobs(java.lang.String)">getJobs(String)</a></code></li>
|
|
</ul>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<A NAME="getLogin()"></A>
|
|
|
|
<div class="jd-details api apilevel-">
|
|
<h4 class="jd-details-title">
|
|
<span class="normal">
|
|
public
|
|
|
|
|
|
|
|
|
|
<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a>
|
|
</span>
|
|
<span class="sympad">getLogin</span>
|
|
<span class="normal">()</span>
|
|
</h4>
|
|
<div class="api-level">
|
|
<div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<div class="jd-details-descr">
|
|
|
|
<div class="jd-tagdata jd-tagdescr"><p></p></div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Returns</h5>
|
|
<ul class="nolist"><li>the login used for authentication on the RunDeck instance (null if using token-based auth)
|
|
</li></ul>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<A NAME="getNode(java.lang.String, java.lang.String)"></A>
|
|
|
|
<div class="jd-details api apilevel-">
|
|
<h4 class="jd-details-title">
|
|
<span class="normal">
|
|
public
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckNode.html">RundeckNode</a>
|
|
</span>
|
|
<span class="sympad">getNode</span>
|
|
<span class="normal">(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> name, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> project)</span>
|
|
</h4>
|
|
<div class="api-level">
|
|
<div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<div class="jd-details-descr">
|
|
|
|
<div class="jd-tagdata jd-tagdescr"><p>Get the definition of a single node</p></div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Parameters</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th>name</td>
|
|
<td>of the node - mandatory</td>
|
|
</tr>
|
|
<tr>
|
|
<th>project</td>
|
|
<td>name of the project - mandatory</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Returns</h5>
|
|
<ul class="nolist"><li>a <code><a href="../../../org/rundeck/api/domain/RundeckNode.html">RundeckNode</a></code> instance - won't be null</li></ul>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Throws</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.html">RundeckApiException</a></td>
|
|
<td>in case of error when calling the API (non-existent name or project with this name)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html">RundeckApiException.RundeckApiLoginException</a></td>
|
|
<td>if the login fails (in case of login-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiTokenException.html">RundeckApiException.RundeckApiTokenException</a></td>
|
|
<td>if the token is invalid (in case of token-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/IllegalArgumentException.html">IllegalArgumentException</a></td>
|
|
<td>if the name or project is blank (null, empty or whitespace)
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<A NAME="getNodes()"></A>
|
|
|
|
<div class="jd-details api apilevel-">
|
|
<h4 class="jd-details-title">
|
|
<span class="normal">
|
|
public
|
|
|
|
|
|
|
|
|
|
<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/List.html">List</a><<a href="../../../org/rundeck/api/domain/RundeckNode.html">RundeckNode</a>>
|
|
</span>
|
|
<span class="sympad">getNodes</span>
|
|
<span class="normal">()</span>
|
|
</h4>
|
|
<div class="api-level">
|
|
<div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<div class="jd-details-descr">
|
|
|
|
<div class="jd-tagdata jd-tagdescr"><p>List all nodes (for all projects)</p></div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Returns</h5>
|
|
<ul class="nolist"><li>a List of <code><a href="../../../org/rundeck/api/domain/RundeckNode.html">RundeckNode</a></code> : might be empty, but won't be null</li></ul>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Throws</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.html">RundeckApiException</a></td>
|
|
<td>in case of error when calling the API</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html">RundeckApiException.RundeckApiLoginException</a></td>
|
|
<td>if the login fails (in case of login-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiTokenException.html">RundeckApiException.RundeckApiTokenException</a></td>
|
|
<td>if the token is invalid (in case of token-based authentication)
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<A NAME="getNodes(java.lang.String)"></A>
|
|
|
|
<div class="jd-details api apilevel-">
|
|
<h4 class="jd-details-title">
|
|
<span class="normal">
|
|
public
|
|
|
|
|
|
|
|
|
|
<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/List.html">List</a><<a href="../../../org/rundeck/api/domain/RundeckNode.html">RundeckNode</a>>
|
|
</span>
|
|
<span class="sympad">getNodes</span>
|
|
<span class="normal">(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> project)</span>
|
|
</h4>
|
|
<div class="api-level">
|
|
<div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<div class="jd-details-descr">
|
|
|
|
<div class="jd-tagdata jd-tagdescr"><p>List all nodes that belongs to the given project</p></div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Parameters</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th>project</td>
|
|
<td>name of the project - mandatory</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Returns</h5>
|
|
<ul class="nolist"><li>a List of <code><a href="../../../org/rundeck/api/domain/RundeckNode.html">RundeckNode</a></code> : might be empty, but won't be null</li></ul>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Throws</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.html">RundeckApiException</a></td>
|
|
<td>in case of error when calling the API (non-existent project with this name)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html">RundeckApiException.RundeckApiLoginException</a></td>
|
|
<td>if the login fails (in case of login-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiTokenException.html">RundeckApiException.RundeckApiTokenException</a></td>
|
|
<td>if the token is invalid (in case of token-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/IllegalArgumentException.html">IllegalArgumentException</a></td>
|
|
<td>if the project is blank (null, empty or whitespace)</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">See Also</h5>
|
|
<ul class="nolist"><li><code><a href="../../../org/rundeck/api/RundeckClient.html#getNodes(java.lang.String, java.util.Properties)">getNodes(String, Properties)</a></code></li>
|
|
</ul>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<A NAME="getNodes(java.lang.String, java.util.Properties)"></A>
|
|
|
|
<div class="jd-details api apilevel-">
|
|
<h4 class="jd-details-title">
|
|
<span class="normal">
|
|
public
|
|
|
|
|
|
|
|
|
|
<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/List.html">List</a><<a href="../../../org/rundeck/api/domain/RundeckNode.html">RundeckNode</a>>
|
|
</span>
|
|
<span class="sympad">getNodes</span>
|
|
<span class="normal">(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> project, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/Properties.html">Properties</a> nodeFilters)</span>
|
|
</h4>
|
|
<div class="api-level">
|
|
<div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<div class="jd-details-descr">
|
|
|
|
<div class="jd-tagdata jd-tagdescr"><p>List nodes that belongs to the given project</p></div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Parameters</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th>project</td>
|
|
<td>name of the project - mandatory</td>
|
|
</tr>
|
|
<tr>
|
|
<th>nodeFilters</td>
|
|
<td>for filtering the nodes - optional. See <code><a href="../../../org/rundeck/api/NodeFiltersBuilder.html">NodeFiltersBuilder</a></code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Returns</h5>
|
|
<ul class="nolist"><li>a List of <code><a href="../../../org/rundeck/api/domain/RundeckNode.html">RundeckNode</a></code> : might be empty, but won't be null</li></ul>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Throws</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.html">RundeckApiException</a></td>
|
|
<td>in case of error when calling the API (non-existent project with this name)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html">RundeckApiException.RundeckApiLoginException</a></td>
|
|
<td>if the login fails (in case of login-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiTokenException.html">RundeckApiException.RundeckApiTokenException</a></td>
|
|
<td>if the token is invalid (in case of token-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/IllegalArgumentException.html">IllegalArgumentException</a></td>
|
|
<td>if the project is blank (null, empty or whitespace)
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<A NAME="getPassword()"></A>
|
|
|
|
<div class="jd-details api apilevel-">
|
|
<h4 class="jd-details-title">
|
|
<span class="normal">
|
|
public
|
|
|
|
|
|
|
|
|
|
<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a>
|
|
</span>
|
|
<span class="sympad">getPassword</span>
|
|
<span class="normal">()</span>
|
|
</h4>
|
|
<div class="api-level">
|
|
<div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<div class="jd-details-descr">
|
|
|
|
<div class="jd-tagdata jd-tagdescr"><p></p></div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Returns</h5>
|
|
<ul class="nolist"><li>the password used for authentication on the RunDeck instance (null if using token-based auth)
|
|
</li></ul>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<A NAME="getProject(java.lang.String)"></A>
|
|
|
|
<div class="jd-details api apilevel-">
|
|
<h4 class="jd-details-title">
|
|
<span class="normal">
|
|
public
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckProject.html">RundeckProject</a>
|
|
</span>
|
|
<span class="sympad">getProject</span>
|
|
<span class="normal">(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> projectName)</span>
|
|
</h4>
|
|
<div class="api-level">
|
|
<div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<div class="jd-details-descr">
|
|
|
|
<div class="jd-tagdata jd-tagdescr"><p>Get the definition of a single project, identified by the given name</p></div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Parameters</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th>projectName</td>
|
|
<td>name of the project - mandatory</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Returns</h5>
|
|
<ul class="nolist"><li>a <code><a href="../../../org/rundeck/api/domain/RundeckProject.html">RundeckProject</a></code> instance - won't be null</li></ul>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Throws</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.html">RundeckApiException</a></td>
|
|
<td>in case of error when calling the API (non-existent project with this name)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html">RundeckApiException.RundeckApiLoginException</a></td>
|
|
<td>if the login fails (in case of login-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiTokenException.html">RundeckApiException.RundeckApiTokenException</a></td>
|
|
<td>if the token is invalid (in case of token-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/IllegalArgumentException.html">IllegalArgumentException</a></td>
|
|
<td>if the projectName is blank (null, empty or whitespace)
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<A NAME="getProjects()"></A>
|
|
|
|
<div class="jd-details api apilevel-">
|
|
<h4 class="jd-details-title">
|
|
<span class="normal">
|
|
public
|
|
|
|
|
|
|
|
|
|
<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/List.html">List</a><<a href="../../../org/rundeck/api/domain/RundeckProject.html">RundeckProject</a>>
|
|
</span>
|
|
<span class="sympad">getProjects</span>
|
|
<span class="normal">()</span>
|
|
</h4>
|
|
<div class="api-level">
|
|
<div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<div class="jd-details-descr">
|
|
|
|
<div class="jd-tagdata jd-tagdescr"><p>List all projects</p></div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Returns</h5>
|
|
<ul class="nolist"><li>a List of <code><a href="../../../org/rundeck/api/domain/RundeckProject.html">RundeckProject</a></code> : might be empty, but won't be null</li></ul>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Throws</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.html">RundeckApiException</a></td>
|
|
<td>in case of error when calling the API</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html">RundeckApiException.RundeckApiLoginException</a></td>
|
|
<td>if the login fails (in case of login-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiTokenException.html">RundeckApiException.RundeckApiTokenException</a></td>
|
|
<td>if the token is invalid (in case of token-based authentication)
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<A NAME="getRunningExecutions()"></A>
|
|
|
|
<div class="jd-details api apilevel-">
|
|
<h4 class="jd-details-title">
|
|
<span class="normal">
|
|
public
|
|
|
|
|
|
|
|
|
|
<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/List.html">List</a><<a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a>>
|
|
</span>
|
|
<span class="sympad">getRunningExecutions</span>
|
|
<span class="normal">()</span>
|
|
</h4>
|
|
<div class="api-level">
|
|
<div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<div class="jd-details-descr">
|
|
|
|
<div class="jd-tagdata jd-tagdescr"><p>Get all running executions (for all projects)</p></div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Returns</h5>
|
|
<ul class="nolist"><li>a List of <code><a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a></code> : might be empty, but won't be null</li></ul>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Throws</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.html">RundeckApiException</a></td>
|
|
<td>in case of error when calling the API</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html">RundeckApiException.RundeckApiLoginException</a></td>
|
|
<td>if the login fails (in case of login-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiTokenException.html">RundeckApiException.RundeckApiTokenException</a></td>
|
|
<td>if the token is invalid (in case of token-based authentication)</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">See Also</h5>
|
|
<ul class="nolist"><li><code><a href="../../../org/rundeck/api/RundeckClient.html#getRunningExecutions(java.lang.String)">getRunningExecutions(String)</a></code></li>
|
|
</ul>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<A NAME="getRunningExecutions(java.lang.String)"></A>
|
|
|
|
<div class="jd-details api apilevel-">
|
|
<h4 class="jd-details-title">
|
|
<span class="normal">
|
|
public
|
|
|
|
|
|
|
|
|
|
<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/List.html">List</a><<a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a>>
|
|
</span>
|
|
<span class="sympad">getRunningExecutions</span>
|
|
<span class="normal">(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> project)</span>
|
|
</h4>
|
|
<div class="api-level">
|
|
<div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<div class="jd-details-descr">
|
|
|
|
<div class="jd-tagdata jd-tagdescr"><p>Get the running executions for the given project</p></div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Parameters</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th>project</td>
|
|
<td>name of the project - mandatory</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Returns</h5>
|
|
<ul class="nolist"><li>a List of <code><a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a></code> : might be empty, but won't be null</li></ul>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Throws</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.html">RundeckApiException</a></td>
|
|
<td>in case of error when calling the API (non-existent project with this name)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html">RundeckApiException.RundeckApiLoginException</a></td>
|
|
<td>if the login fails (in case of login-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiTokenException.html">RundeckApiException.RundeckApiTokenException</a></td>
|
|
<td>if the token is invalid (in case of token-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/IllegalArgumentException.html">IllegalArgumentException</a></td>
|
|
<td>if the project is blank (null, empty or whitespace)</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">See Also</h5>
|
|
<ul class="nolist"><li><code><a href="../../../org/rundeck/api/RundeckClient.html#getRunningExecutions()">getRunningExecutions()</a></code></li>
|
|
</ul>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<A NAME="getSystemInfo()"></A>
|
|
|
|
<div class="jd-details api apilevel-">
|
|
<h4 class="jd-details-title">
|
|
<span class="normal">
|
|
public
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckSystemInfo.html">RundeckSystemInfo</a>
|
|
</span>
|
|
<span class="sympad">getSystemInfo</span>
|
|
<span class="normal">()</span>
|
|
</h4>
|
|
<div class="api-level">
|
|
<div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<div class="jd-details-descr">
|
|
|
|
<div class="jd-tagdata jd-tagdescr"><p>Get system informations about the RunDeck server</p></div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Returns</h5>
|
|
<ul class="nolist"><li>a <code><a href="../../../org/rundeck/api/domain/RundeckSystemInfo.html">RundeckSystemInfo</a></code> instance - won't be null</li></ul>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Throws</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.html">RundeckApiException</a></td>
|
|
<td>in case of error when calling the API</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html">RundeckApiException.RundeckApiLoginException</a></td>
|
|
<td>if the login fails (in case of login-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiTokenException.html">RundeckApiException.RundeckApiTokenException</a></td>
|
|
<td>if the token is invalid (in case of token-based authentication)
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<A NAME="getToken()"></A>
|
|
|
|
<div class="jd-details api apilevel-">
|
|
<h4 class="jd-details-title">
|
|
<span class="normal">
|
|
public
|
|
|
|
|
|
|
|
|
|
<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a>
|
|
</span>
|
|
<span class="sympad">getToken</span>
|
|
<span class="normal">()</span>
|
|
</h4>
|
|
<div class="api-level">
|
|
<div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<div class="jd-details-descr">
|
|
|
|
<div class="jd-tagdata jd-tagdescr"><p></p></div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Returns</h5>
|
|
<ul class="nolist"><li>the auth-token used for authentication on the RunDeck instance (null if using login-based auth)
|
|
</li></ul>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<A NAME="getUrl()"></A>
|
|
|
|
<div class="jd-details api apilevel-">
|
|
<h4 class="jd-details-title">
|
|
<span class="normal">
|
|
public
|
|
|
|
|
|
|
|
|
|
<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a>
|
|
</span>
|
|
<span class="sympad">getUrl</span>
|
|
<span class="normal">()</span>
|
|
</h4>
|
|
<div class="api-level">
|
|
<div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<div class="jd-details-descr">
|
|
|
|
<div class="jd-tagdata jd-tagdescr"><p></p></div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Returns</h5>
|
|
<ul class="nolist"><li>the URL of the RunDeck instance ("http://localhost:4440", "http://rundeck.your-compagny.com/", etc)
|
|
</li></ul>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<A NAME="hashCode()"></A>
|
|
|
|
<div class="jd-details api apilevel-">
|
|
<h4 class="jd-details-title">
|
|
<span class="normal">
|
|
public
|
|
|
|
|
|
|
|
|
|
int
|
|
</span>
|
|
<span class="sympad">hashCode</span>
|
|
<span class="normal">()</span>
|
|
</h4>
|
|
<div class="api-level">
|
|
<div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<div class="jd-details-descr">
|
|
|
|
<div class="jd-tagdata jd-tagdescr"><p></p></div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<A NAME="importJobs(java.io.InputStream, java.lang.String)"></A>
|
|
|
|
<div class="jd-details api apilevel-">
|
|
<h4 class="jd-details-title">
|
|
<span class="normal">
|
|
public
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckJobsImportResult.html">RundeckJobsImportResult</a>
|
|
</span>
|
|
<span class="sympad">importJobs</span>
|
|
<span class="normal">(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/io/InputStream.html">InputStream</a> stream, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> fileType)</span>
|
|
</h4>
|
|
<div class="api-level">
|
|
<div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<div class="jd-details-descr">
|
|
|
|
<div class="jd-tagdata jd-tagdescr"><p>Import the definitions of jobs, from the given input stream</p></div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Parameters</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th>stream</td>
|
|
<td>inputStream for reading the definitions - mandatory</td>
|
|
</tr>
|
|
<tr>
|
|
<th>fileType</td>
|
|
<td>type of the file. See <code><a href="../../../org/rundeck/api/FileType.html">FileType</a></code> - mandatory</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Returns</h5>
|
|
<ul class="nolist"><li>a <code><a href="../../../org/rundeck/api/domain/RundeckJobsImportResult.html">RundeckJobsImportResult</a></code> instance - won't be null</li></ul>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Throws</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.html">RundeckApiException</a></td>
|
|
<td>in case of error when calling the API</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html">RundeckApiException.RundeckApiLoginException</a></td>
|
|
<td>if the login fails (in case of login-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiTokenException.html">RundeckApiException.RundeckApiTokenException</a></td>
|
|
<td>if the token is invalid (in case of token-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/IllegalArgumentException.html">IllegalArgumentException</a></td>
|
|
<td>if the stream is null, or the fileType is blank (null, empty or whitespace) or
|
|
invalid</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">See Also</h5>
|
|
<ul class="nolist"><li><code><a href="../../../org/rundeck/api/RundeckClient.html#importJobs(java.lang.String, java.lang.String)">importJobs(String, String)</a></code></li><li><code><a href="../../../org/rundeck/api/RundeckClient.html#importJobs(java.io.InputStream, org.rundeck.api.FileType, org.rundeck.api.domain.RundeckJobsImportMethod)">importJobs(InputStream, FileType, RundeckJobsImportMethod)</a></code></li>
|
|
</ul>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<A NAME="importJobs(java.io.InputStream, java.lang.String, java.lang.String)"></A>
|
|
|
|
<div class="jd-details api apilevel-">
|
|
<h4 class="jd-details-title">
|
|
<span class="normal">
|
|
public
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckJobsImportResult.html">RundeckJobsImportResult</a>
|
|
</span>
|
|
<span class="sympad">importJobs</span>
|
|
<span class="normal">(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/io/InputStream.html">InputStream</a> stream, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> fileType, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> importBehavior)</span>
|
|
</h4>
|
|
<div class="api-level">
|
|
<div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<div class="jd-details-descr">
|
|
|
|
<div class="jd-tagdata jd-tagdescr"><p>Import the definitions of jobs, from the given input stream, using the given behavior</p></div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Parameters</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th>stream</td>
|
|
<td>inputStream for reading the definitions - mandatory</td>
|
|
</tr>
|
|
<tr>
|
|
<th>fileType</td>
|
|
<td>type of the file. See <code><a href="../../../org/rundeck/api/FileType.html">FileType</a></code> - mandatory</td>
|
|
</tr>
|
|
<tr>
|
|
<th>importBehavior</td>
|
|
<td>see <code><a href="../../../org/rundeck/api/domain/RundeckJobsImportMethod.html">RundeckJobsImportMethod</a></code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Returns</h5>
|
|
<ul class="nolist"><li>a <code><a href="../../../org/rundeck/api/domain/RundeckJobsImportResult.html">RundeckJobsImportResult</a></code> instance - won't be null</li></ul>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Throws</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.html">RundeckApiException</a></td>
|
|
<td>in case of error when calling the API</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html">RundeckApiException.RundeckApiLoginException</a></td>
|
|
<td>if the login fails (in case of login-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiTokenException.html">RundeckApiException.RundeckApiTokenException</a></td>
|
|
<td>if the token is invalid (in case of token-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/IllegalArgumentException.html">IllegalArgumentException</a></td>
|
|
<td>if the stream is null, or the fileType is blank (null, empty or whitespace), or
|
|
the fileType or behavior is not valid</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">See Also</h5>
|
|
<ul class="nolist"><li><code><a href="../../../org/rundeck/api/RundeckClient.html#importJobs(java.lang.String, java.lang.String, java.lang.String)">importJobs(String, String, String)</a></code></li><li><code><a href="../../../org/rundeck/api/RundeckClient.html#importJobs(java.io.InputStream, org.rundeck.api.FileType, org.rundeck.api.domain.RundeckJobsImportMethod)">importJobs(InputStream, FileType, RundeckJobsImportMethod)</a></code></li>
|
|
</ul>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<A NAME="importJobs(java.io.InputStream, org.rundeck.api.FileType)"></A>
|
|
|
|
<div class="jd-details api apilevel-">
|
|
<h4 class="jd-details-title">
|
|
<span class="normal">
|
|
public
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckJobsImportResult.html">RundeckJobsImportResult</a>
|
|
</span>
|
|
<span class="sympad">importJobs</span>
|
|
<span class="normal">(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/io/InputStream.html">InputStream</a> stream, <a href="../../../org/rundeck/api/FileType.html">FileType</a> fileType)</span>
|
|
</h4>
|
|
<div class="api-level">
|
|
<div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<div class="jd-details-descr">
|
|
|
|
<div class="jd-tagdata jd-tagdescr"><p>Import the definitions of jobs, from the given input stream</p></div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Parameters</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th>stream</td>
|
|
<td>inputStream for reading the definitions - mandatory</td>
|
|
</tr>
|
|
<tr>
|
|
<th>fileType</td>
|
|
<td>type of the file. See <code><a href="../../../org/rundeck/api/FileType.html">FileType</a></code> - mandatory</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Returns</h5>
|
|
<ul class="nolist"><li>a <code><a href="../../../org/rundeck/api/domain/RundeckJobsImportResult.html">RundeckJobsImportResult</a></code> instance - won't be null</li></ul>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Throws</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.html">RundeckApiException</a></td>
|
|
<td>in case of error when calling the API</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html">RundeckApiException.RundeckApiLoginException</a></td>
|
|
<td>if the login fails (in case of login-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiTokenException.html">RundeckApiException.RundeckApiTokenException</a></td>
|
|
<td>if the token is invalid (in case of token-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/IllegalArgumentException.html">IllegalArgumentException</a></td>
|
|
<td>if the stream or fileType is null</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">See Also</h5>
|
|
<ul class="nolist"><li><code><a href="../../../org/rundeck/api/RundeckClient.html#importJobs(java.lang.String, org.rundeck.api.FileType)">importJobs(String, FileType)</a></code></li><li><code><a href="../../../org/rundeck/api/RundeckClient.html#importJobs(java.io.InputStream, org.rundeck.api.FileType, org.rundeck.api.domain.RundeckJobsImportMethod)">importJobs(InputStream, FileType, RundeckJobsImportMethod)</a></code></li>
|
|
</ul>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<A NAME="importJobs(java.io.InputStream, org.rundeck.api.FileType, org.rundeck.api.domain.RundeckJobsImportMethod)"></A>
|
|
|
|
<div class="jd-details api apilevel-">
|
|
<h4 class="jd-details-title">
|
|
<span class="normal">
|
|
public
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckJobsImportResult.html">RundeckJobsImportResult</a>
|
|
</span>
|
|
<span class="sympad">importJobs</span>
|
|
<span class="normal">(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/io/InputStream.html">InputStream</a> stream, <a href="../../../org/rundeck/api/FileType.html">FileType</a> fileType, <a href="../../../org/rundeck/api/domain/RundeckJobsImportMethod.html">RundeckJobsImportMethod</a> importBehavior)</span>
|
|
</h4>
|
|
<div class="api-level">
|
|
<div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<div class="jd-details-descr">
|
|
|
|
<div class="jd-tagdata jd-tagdescr"><p>Import the definitions of jobs, from the given input stream, using the given behavior</p></div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Parameters</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th>stream</td>
|
|
<td>inputStream for reading the definitions - mandatory</td>
|
|
</tr>
|
|
<tr>
|
|
<th>fileType</td>
|
|
<td>type of the file. See <code><a href="../../../org/rundeck/api/FileType.html">FileType</a></code> - mandatory</td>
|
|
</tr>
|
|
<tr>
|
|
<th>importBehavior</td>
|
|
<td>see <code><a href="../../../org/rundeck/api/domain/RundeckJobsImportMethod.html">RundeckJobsImportMethod</a></code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Returns</h5>
|
|
<ul class="nolist"><li>a <code><a href="../../../org/rundeck/api/domain/RundeckJobsImportResult.html">RundeckJobsImportResult</a></code> instance - won't be null</li></ul>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Throws</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.html">RundeckApiException</a></td>
|
|
<td>in case of error when calling the API</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html">RundeckApiException.RundeckApiLoginException</a></td>
|
|
<td>if the login fails (in case of login-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiTokenException.html">RundeckApiException.RundeckApiTokenException</a></td>
|
|
<td>if the token is invalid (in case of token-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/IllegalArgumentException.html">IllegalArgumentException</a></td>
|
|
<td>if the stream or fileType is null</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">See Also</h5>
|
|
<ul class="nolist"><li><code><a href="../../../org/rundeck/api/RundeckClient.html#importJobs(java.lang.String, org.rundeck.api.FileType, org.rundeck.api.domain.RundeckJobsImportMethod)">importJobs(String, FileType, RundeckJobsImportMethod)</a></code></li>
|
|
</ul>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<A NAME="importJobs(java.lang.String, java.lang.String)"></A>
|
|
|
|
<div class="jd-details api apilevel-">
|
|
<h4 class="jd-details-title">
|
|
<span class="normal">
|
|
public
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckJobsImportResult.html">RundeckJobsImportResult</a>
|
|
</span>
|
|
<span class="sympad">importJobs</span>
|
|
<span class="normal">(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> filename, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> fileType)</span>
|
|
</h4>
|
|
<div class="api-level">
|
|
<div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<div class="jd-details-descr">
|
|
|
|
<div class="jd-tagdata jd-tagdescr"><p>Import the definitions of jobs, from the given file</p></div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Parameters</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th>filename</td>
|
|
<td>of the file containing the jobs definitions - mandatory</td>
|
|
</tr>
|
|
<tr>
|
|
<th>fileType</td>
|
|
<td>type of the file. See <code><a href="../../../org/rundeck/api/FileType.html">FileType</a></code> - mandatory</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Returns</h5>
|
|
<ul class="nolist"><li>a <code><a href="../../../org/rundeck/api/domain/RundeckJobsImportResult.html">RundeckJobsImportResult</a></code> instance - won't be null</li></ul>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Throws</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.html">RundeckApiException</a></td>
|
|
<td>in case of error when calling the API</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html">RundeckApiException.RundeckApiLoginException</a></td>
|
|
<td>if the login fails (in case of login-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiTokenException.html">RundeckApiException.RundeckApiTokenException</a></td>
|
|
<td>if the token is invalid (in case of token-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/IllegalArgumentException.html">IllegalArgumentException</a></td>
|
|
<td>if the filename or fileType is blank (null, empty or whitespace), or the
|
|
fileType is invalid</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/io/IOException.html">IOException</a></td>
|
|
<td>if we failed to read the file</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">See Also</h5>
|
|
<ul class="nolist"><li><code><a href="../../../org/rundeck/api/RundeckClient.html#importJobs(java.io.InputStream, java.lang.String)">importJobs(InputStream, String)</a></code></li><li><code><a href="../../../org/rundeck/api/RundeckClient.html#importJobs(java.lang.String, org.rundeck.api.FileType, org.rundeck.api.domain.RundeckJobsImportMethod)">importJobs(String, FileType, RundeckJobsImportMethod)</a></code></li>
|
|
</ul>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<A NAME="importJobs(java.lang.String, java.lang.String, java.lang.String)"></A>
|
|
|
|
<div class="jd-details api apilevel-">
|
|
<h4 class="jd-details-title">
|
|
<span class="normal">
|
|
public
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckJobsImportResult.html">RundeckJobsImportResult</a>
|
|
</span>
|
|
<span class="sympad">importJobs</span>
|
|
<span class="normal">(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> filename, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> fileType, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> importBehavior)</span>
|
|
</h4>
|
|
<div class="api-level">
|
|
<div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<div class="jd-details-descr">
|
|
|
|
<div class="jd-tagdata jd-tagdescr"><p>Import the definitions of jobs, from the given file, using the given behavior</p></div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Parameters</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th>filename</td>
|
|
<td>of the file containing the jobs definitions - mandatory</td>
|
|
</tr>
|
|
<tr>
|
|
<th>fileType</td>
|
|
<td>type of the file. See <code><a href="../../../org/rundeck/api/FileType.html">FileType</a></code> - mandatory</td>
|
|
</tr>
|
|
<tr>
|
|
<th>importBehavior</td>
|
|
<td>see <code><a href="../../../org/rundeck/api/domain/RundeckJobsImportMethod.html">RundeckJobsImportMethod</a></code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Returns</h5>
|
|
<ul class="nolist"><li>a <code><a href="../../../org/rundeck/api/domain/RundeckJobsImportResult.html">RundeckJobsImportResult</a></code> instance - won't be null</li></ul>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Throws</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.html">RundeckApiException</a></td>
|
|
<td>in case of error when calling the API</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html">RundeckApiException.RundeckApiLoginException</a></td>
|
|
<td>if the login fails (in case of login-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiTokenException.html">RundeckApiException.RundeckApiTokenException</a></td>
|
|
<td>if the token is invalid (in case of token-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/IllegalArgumentException.html">IllegalArgumentException</a></td>
|
|
<td>if the filename or fileType is blank (null, empty or whitespace), or the
|
|
fileType or behavior is not valid</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/io/IOException.html">IOException</a></td>
|
|
<td>if we failed to read the file</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">See Also</h5>
|
|
<ul class="nolist"><li><code><a href="../../../org/rundeck/api/RundeckClient.html#importJobs(java.io.InputStream, java.lang.String, java.lang.String)">importJobs(InputStream, String, String)</a></code></li><li><code><a href="../../../org/rundeck/api/RundeckClient.html#importJobs(java.lang.String, org.rundeck.api.FileType, org.rundeck.api.domain.RundeckJobsImportMethod)">importJobs(String, FileType, RundeckJobsImportMethod)</a></code></li>
|
|
</ul>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<A NAME="importJobs(java.lang.String, org.rundeck.api.FileType)"></A>
|
|
|
|
<div class="jd-details api apilevel-">
|
|
<h4 class="jd-details-title">
|
|
<span class="normal">
|
|
public
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckJobsImportResult.html">RundeckJobsImportResult</a>
|
|
</span>
|
|
<span class="sympad">importJobs</span>
|
|
<span class="normal">(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> filename, <a href="../../../org/rundeck/api/FileType.html">FileType</a> fileType)</span>
|
|
</h4>
|
|
<div class="api-level">
|
|
<div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<div class="jd-details-descr">
|
|
|
|
<div class="jd-tagdata jd-tagdescr"><p>Import the definitions of jobs, from the given file</p></div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Parameters</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th>filename</td>
|
|
<td>of the file containing the jobs definitions - mandatory</td>
|
|
</tr>
|
|
<tr>
|
|
<th>fileType</td>
|
|
<td>type of the file. See <code><a href="../../../org/rundeck/api/FileType.html">FileType</a></code> - mandatory</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Returns</h5>
|
|
<ul class="nolist"><li>a <code><a href="../../../org/rundeck/api/domain/RundeckJobsImportResult.html">RundeckJobsImportResult</a></code> instance - won't be null</li></ul>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Throws</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.html">RundeckApiException</a></td>
|
|
<td>in case of error when calling the API</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html">RundeckApiException.RundeckApiLoginException</a></td>
|
|
<td>if the login fails (in case of login-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiTokenException.html">RundeckApiException.RundeckApiTokenException</a></td>
|
|
<td>if the token is invalid (in case of token-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/IllegalArgumentException.html">IllegalArgumentException</a></td>
|
|
<td>if the filename is blank (null, empty or whitespace), or the fileType is null</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/io/IOException.html">IOException</a></td>
|
|
<td>if we failed to read the file</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">See Also</h5>
|
|
<ul class="nolist"><li><code><a href="../../../org/rundeck/api/RundeckClient.html#importJobs(java.io.InputStream, org.rundeck.api.FileType)">importJobs(InputStream, FileType)</a></code></li><li><code><a href="../../../org/rundeck/api/RundeckClient.html#importJobs(java.lang.String, org.rundeck.api.FileType, org.rundeck.api.domain.RundeckJobsImportMethod)">importJobs(String, FileType, RundeckJobsImportMethod)</a></code></li>
|
|
</ul>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<A NAME="importJobs(java.lang.String, org.rundeck.api.FileType, org.rundeck.api.domain.RundeckJobsImportMethod)"></A>
|
|
|
|
<div class="jd-details api apilevel-">
|
|
<h4 class="jd-details-title">
|
|
<span class="normal">
|
|
public
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckJobsImportResult.html">RundeckJobsImportResult</a>
|
|
</span>
|
|
<span class="sympad">importJobs</span>
|
|
<span class="normal">(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> filename, <a href="../../../org/rundeck/api/FileType.html">FileType</a> fileType, <a href="../../../org/rundeck/api/domain/RundeckJobsImportMethod.html">RundeckJobsImportMethod</a> importBehavior)</span>
|
|
</h4>
|
|
<div class="api-level">
|
|
<div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<div class="jd-details-descr">
|
|
|
|
<div class="jd-tagdata jd-tagdescr"><p>Import the definitions of jobs, from the given file, using the given behavior</p></div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Parameters</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th>filename</td>
|
|
<td>of the file containing the jobs definitions - mandatory</td>
|
|
</tr>
|
|
<tr>
|
|
<th>fileType</td>
|
|
<td>type of the file. See <code><a href="../../../org/rundeck/api/FileType.html">FileType</a></code> - mandatory</td>
|
|
</tr>
|
|
<tr>
|
|
<th>importBehavior</td>
|
|
<td>see <code><a href="../../../org/rundeck/api/domain/RundeckJobsImportMethod.html">RundeckJobsImportMethod</a></code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Returns</h5>
|
|
<ul class="nolist"><li>a <code><a href="../../../org/rundeck/api/domain/RundeckJobsImportResult.html">RundeckJobsImportResult</a></code> instance - won't be null</li></ul>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Throws</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.html">RundeckApiException</a></td>
|
|
<td>in case of error when calling the API</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html">RundeckApiException.RundeckApiLoginException</a></td>
|
|
<td>if the login fails (in case of login-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiTokenException.html">RundeckApiException.RundeckApiTokenException</a></td>
|
|
<td>if the token is invalid (in case of token-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/IllegalArgumentException.html">IllegalArgumentException</a></td>
|
|
<td>if the filename is blank (null, empty or whitespace), or the fileType is null</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/io/IOException.html">IOException</a></td>
|
|
<td>if we failed to read the file</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">See Also</h5>
|
|
<ul class="nolist"><li><code><a href="../../../org/rundeck/api/RundeckClient.html#importJobs(java.io.InputStream, org.rundeck.api.FileType, org.rundeck.api.domain.RundeckJobsImportMethod)">importJobs(InputStream, FileType, RundeckJobsImportMethod)</a></code></li>
|
|
</ul>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<A NAME="ping()"></A>
|
|
|
|
<div class="jd-details api apilevel-">
|
|
<h4 class="jd-details-title">
|
|
<span class="normal">
|
|
public
|
|
|
|
|
|
|
|
|
|
void
|
|
</span>
|
|
<span class="sympad">ping</span>
|
|
<span class="normal">()</span>
|
|
</h4>
|
|
<div class="api-level">
|
|
<div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<div class="jd-details-descr">
|
|
|
|
<div class="jd-tagdata jd-tagdescr"><p>Try to "ping" the RunDeck instance to see if it is alive</p></div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Throws</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.html">RundeckApiException</a></td>
|
|
<td>if the ping fails
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<A NAME="runAdhocCommand(java.lang.String, java.lang.String)"></A>
|
|
|
|
<div class="jd-details api apilevel-">
|
|
<h4 class="jd-details-title">
|
|
<span class="normal">
|
|
public
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a>
|
|
</span>
|
|
<span class="sympad">runAdhocCommand</span>
|
|
<span class="normal">(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> project, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> command)</span>
|
|
</h4>
|
|
<div class="api-level">
|
|
<div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<div class="jd-details-descr">
|
|
|
|
<div class="jd-tagdata jd-tagdescr"><p>Run an ad-hoc command, and wait until its execution is finished (or aborted) to return. We will poll the RunDeck
|
|
server at regular interval (every 5 seconds) to know if the execution is finished (or aborted) or is still
|
|
running. The command will not be dispatched to nodes, but be executed on the RunDeck server.</p></div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Parameters</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th>project</td>
|
|
<td>name of the project - mandatory</td>
|
|
</tr>
|
|
<tr>
|
|
<th>command</td>
|
|
<td>to be executed - mandatory</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Returns</h5>
|
|
<ul class="nolist"><li>a <code><a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a></code> instance for the (finished/aborted) execution - won't be null</li></ul>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Throws</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.html">RundeckApiException</a></td>
|
|
<td>in case of error when calling the API (non-existent project with this name)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html">RundeckApiException.RundeckApiLoginException</a></td>
|
|
<td>if the login fails (in case of login-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiTokenException.html">RundeckApiException.RundeckApiTokenException</a></td>
|
|
<td>if the token is invalid (in case of token-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/IllegalArgumentException.html">IllegalArgumentException</a></td>
|
|
<td>if the project or command is blank (null, empty or whitespace)</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">See Also</h5>
|
|
<ul class="nolist"><li><code><a href="../../../org/rundeck/api/RundeckClient.html#runAdhocCommand(java.lang.String, java.lang.String, java.util.Properties, java.lang.Integer, java.lang.Boolean, long, java.util.concurrent.TimeUnit)">runAdhocCommand(String, String, Properties, Integer, Boolean, long, TimeUnit)</a></code></li><li><code><a href="../../../org/rundeck/api/RundeckClient.html#triggerAdhocCommand(java.lang.String, java.lang.String)">triggerAdhocCommand(String, String)</a></code></li>
|
|
</ul>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<A NAME="runAdhocCommand(java.lang.String, java.lang.String, java.util.Properties)"></A>
|
|
|
|
<div class="jd-details api apilevel-">
|
|
<h4 class="jd-details-title">
|
|
<span class="normal">
|
|
public
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a>
|
|
</span>
|
|
<span class="sympad">runAdhocCommand</span>
|
|
<span class="normal">(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> project, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> command, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/Properties.html">Properties</a> nodeFilters)</span>
|
|
</h4>
|
|
<div class="api-level">
|
|
<div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<div class="jd-details-descr">
|
|
|
|
<div class="jd-tagdata jd-tagdescr"><p>Run an ad-hoc command, and wait until its execution is finished (or aborted) to return. We will poll the RunDeck
|
|
server at regular interval (every 5 seconds) to know if the execution is finished (or aborted) or is still
|
|
running. The command will be dispatched to nodes, accordingly to the nodeFilters parameter.</p></div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Parameters</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th>project</td>
|
|
<td>name of the project - mandatory</td>
|
|
</tr>
|
|
<tr>
|
|
<th>command</td>
|
|
<td>to be executed - mandatory</td>
|
|
</tr>
|
|
<tr>
|
|
<th>nodeFilters</td>
|
|
<td>for selecting nodes on which the command will be executed. See <code><a href="../../../org/rundeck/api/NodeFiltersBuilder.html">NodeFiltersBuilder</a></code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Returns</h5>
|
|
<ul class="nolist"><li>a <code><a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a></code> instance for the (finished/aborted) execution - won't be null</li></ul>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Throws</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.html">RundeckApiException</a></td>
|
|
<td>in case of error when calling the API (non-existent project with this name)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html">RundeckApiException.RundeckApiLoginException</a></td>
|
|
<td>if the login fails (in case of login-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiTokenException.html">RundeckApiException.RundeckApiTokenException</a></td>
|
|
<td>if the token is invalid (in case of token-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/IllegalArgumentException.html">IllegalArgumentException</a></td>
|
|
<td>if the project or command is blank (null, empty or whitespace)</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">See Also</h5>
|
|
<ul class="nolist"><li><code><a href="../../../org/rundeck/api/RundeckClient.html#runAdhocCommand(java.lang.String, java.lang.String, java.util.Properties, java.lang.Integer, java.lang.Boolean, long, java.util.concurrent.TimeUnit)">runAdhocCommand(String, String, Properties, Integer, Boolean, long, TimeUnit)</a></code></li><li><code><a href="../../../org/rundeck/api/RundeckClient.html#triggerAdhocCommand(java.lang.String, java.lang.String, java.util.Properties)">triggerAdhocCommand(String, String, Properties)</a></code></li>
|
|
</ul>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<A NAME="runAdhocCommand(java.lang.String, java.lang.String, java.util.Properties, java.lang.Integer, java.lang.Boolean)"></A>
|
|
|
|
<div class="jd-details api apilevel-">
|
|
<h4 class="jd-details-title">
|
|
<span class="normal">
|
|
public
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a>
|
|
</span>
|
|
<span class="sympad">runAdhocCommand</span>
|
|
<span class="normal">(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> project, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> command, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/Properties.html">Properties</a> nodeFilters, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/Integer.html">Integer</a> nodeThreadcount, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/Boolean.html">Boolean</a> nodeKeepgoing)</span>
|
|
</h4>
|
|
<div class="api-level">
|
|
<div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<div class="jd-details-descr">
|
|
|
|
<div class="jd-tagdata jd-tagdescr"><p>Run an ad-hoc command, and wait until its execution is finished (or aborted) to return. We will poll the RunDeck
|
|
server at regular interval (every 5 seconds) to know if the execution is finished (or aborted) or is still
|
|
running. The command will be dispatched to nodes, accordingly to the nodeFilters parameter.</p></div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Parameters</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th>project</td>
|
|
<td>name of the project - mandatory</td>
|
|
</tr>
|
|
<tr>
|
|
<th>command</td>
|
|
<td>to be executed - mandatory</td>
|
|
</tr>
|
|
<tr>
|
|
<th>nodeFilters</td>
|
|
<td>for selecting nodes on which the command will be executed. See <code><a href="../../../org/rundeck/api/NodeFiltersBuilder.html">NodeFiltersBuilder</a></code></td>
|
|
</tr>
|
|
<tr>
|
|
<th>nodeThreadcount</td>
|
|
<td>thread count to use (for parallelizing when running on multiple nodes) - optional</td>
|
|
</tr>
|
|
<tr>
|
|
<th>nodeKeepgoing</td>
|
|
<td>if true, continue executing on other nodes even if some fail - optional</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Returns</h5>
|
|
<ul class="nolist"><li>a <code><a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a></code> instance for the (finished/aborted) execution - won't be null</li></ul>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Throws</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.html">RundeckApiException</a></td>
|
|
<td>in case of error when calling the API (non-existent project with this name)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html">RundeckApiException.RundeckApiLoginException</a></td>
|
|
<td>if the login fails (in case of login-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiTokenException.html">RundeckApiException.RundeckApiTokenException</a></td>
|
|
<td>if the token is invalid (in case of token-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/IllegalArgumentException.html">IllegalArgumentException</a></td>
|
|
<td>if the project or command is blank (null, empty or whitespace)</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">See Also</h5>
|
|
<ul class="nolist"><li><code><a href="../../../org/rundeck/api/RundeckClient.html#runAdhocCommand(java.lang.String, java.lang.String, java.util.Properties, java.lang.Integer, java.lang.Boolean, long, java.util.concurrent.TimeUnit)">runAdhocCommand(String, String, Properties, Integer, Boolean, long, TimeUnit)</a></code></li><li><code><a href="../../../org/rundeck/api/RundeckClient.html#triggerAdhocCommand(java.lang.String, java.lang.String, java.util.Properties, java.lang.Integer, java.lang.Boolean)">triggerAdhocCommand(String, String, Properties, Integer, Boolean)</a></code></li>
|
|
</ul>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<A NAME="runAdhocCommand(java.lang.String, java.lang.String, java.util.Properties, java.lang.Integer, java.lang.Boolean, long, java.util.concurrent.TimeUnit)"></A>
|
|
|
|
<div class="jd-details api apilevel-">
|
|
<h4 class="jd-details-title">
|
|
<span class="normal">
|
|
public
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a>
|
|
</span>
|
|
<span class="sympad">runAdhocCommand</span>
|
|
<span class="normal">(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> project, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> command, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/Properties.html">Properties</a> nodeFilters, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/Integer.html">Integer</a> nodeThreadcount, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/Boolean.html">Boolean</a> nodeKeepgoing, long poolingInterval, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/concurrent/TimeUnit.html">TimeUnit</a> poolingUnit)</span>
|
|
</h4>
|
|
<div class="api-level">
|
|
<div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<div class="jd-details-descr">
|
|
|
|
<div class="jd-tagdata jd-tagdescr"><p>Run an ad-hoc command, and wait until its execution is finished (or aborted) to return. We will poll the RunDeck
|
|
server at regular interval (configured by the poolingInterval/poolingUnit couple) to know if the execution is
|
|
finished (or aborted) or is still running. The command will be dispatched to nodes, accordingly to the
|
|
nodeFilters parameter.</p></div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Parameters</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th>project</td>
|
|
<td>name of the project - mandatory</td>
|
|
</tr>
|
|
<tr>
|
|
<th>command</td>
|
|
<td>to be executed - mandatory</td>
|
|
</tr>
|
|
<tr>
|
|
<th>nodeFilters</td>
|
|
<td>for selecting nodes on which the command will be executed. See <code><a href="../../../org/rundeck/api/NodeFiltersBuilder.html">NodeFiltersBuilder</a></code></td>
|
|
</tr>
|
|
<tr>
|
|
<th>nodeThreadcount</td>
|
|
<td>thread count to use (for parallelizing when running on multiple nodes) - optional</td>
|
|
</tr>
|
|
<tr>
|
|
<th>nodeKeepgoing</td>
|
|
<td>if true, continue executing on other nodes even if some fail - optional</td>
|
|
</tr>
|
|
<tr>
|
|
<th>poolingInterval</td>
|
|
<td>for checking the status of the execution. Must be > 0.</td>
|
|
</tr>
|
|
<tr>
|
|
<th>poolingUnit</td>
|
|
<td>unit (seconds, milli-seconds, ...) of the interval. Default to seconds.</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Returns</h5>
|
|
<ul class="nolist"><li>a <code><a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a></code> instance for the (finished/aborted) execution - won't be null</li></ul>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Throws</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.html">RundeckApiException</a></td>
|
|
<td>in case of error when calling the API (non-existent project with this name)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html">RundeckApiException.RundeckApiLoginException</a></td>
|
|
<td>if the login fails (in case of login-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiTokenException.html">RundeckApiException.RundeckApiTokenException</a></td>
|
|
<td>if the token is invalid (in case of token-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/IllegalArgumentException.html">IllegalArgumentException</a></td>
|
|
<td>if the project or command is blank (null, empty or whitespace)</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">See Also</h5>
|
|
<ul class="nolist"><li><code><a href="../../../org/rundeck/api/RundeckClient.html#triggerAdhocCommand(java.lang.String, java.lang.String, java.util.Properties, java.lang.Integer, java.lang.Boolean)">triggerAdhocCommand(String, String, Properties, Integer, Boolean)</a></code></li>
|
|
</ul>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<A NAME="runAdhocCommand(java.lang.String, java.lang.String, java.util.Properties, long, java.util.concurrent.TimeUnit)"></A>
|
|
|
|
<div class="jd-details api apilevel-">
|
|
<h4 class="jd-details-title">
|
|
<span class="normal">
|
|
public
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a>
|
|
</span>
|
|
<span class="sympad">runAdhocCommand</span>
|
|
<span class="normal">(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> project, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> command, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/Properties.html">Properties</a> nodeFilters, long poolingInterval, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/concurrent/TimeUnit.html">TimeUnit</a> poolingUnit)</span>
|
|
</h4>
|
|
<div class="api-level">
|
|
<div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<div class="jd-details-descr">
|
|
|
|
<div class="jd-tagdata jd-tagdescr"><p>Run an ad-hoc command, and wait until its execution is finished (or aborted) to return. We will poll the RunDeck
|
|
server at regular interval (configured by the poolingInterval/poolingUnit couple) to know if the execution is
|
|
finished (or aborted) or is still running. The command will be dispatched to nodes, accordingly to the
|
|
nodeFilters parameter.</p></div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Parameters</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th>project</td>
|
|
<td>name of the project - mandatory</td>
|
|
</tr>
|
|
<tr>
|
|
<th>command</td>
|
|
<td>to be executed - mandatory</td>
|
|
</tr>
|
|
<tr>
|
|
<th>nodeFilters</td>
|
|
<td>for selecting nodes on which the command will be executed. See <code><a href="../../../org/rundeck/api/NodeFiltersBuilder.html">NodeFiltersBuilder</a></code></td>
|
|
</tr>
|
|
<tr>
|
|
<th>poolingInterval</td>
|
|
<td>for checking the status of the execution. Must be > 0.</td>
|
|
</tr>
|
|
<tr>
|
|
<th>poolingUnit</td>
|
|
<td>unit (seconds, milli-seconds, ...) of the interval. Default to seconds.</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Returns</h5>
|
|
<ul class="nolist"><li>a <code><a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a></code> instance for the (finished/aborted) execution - won't be null</li></ul>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Throws</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.html">RundeckApiException</a></td>
|
|
<td>in case of error when calling the API (non-existent project with this name)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html">RundeckApiException.RundeckApiLoginException</a></td>
|
|
<td>if the login fails (in case of login-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiTokenException.html">RundeckApiException.RundeckApiTokenException</a></td>
|
|
<td>if the token is invalid (in case of token-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/IllegalArgumentException.html">IllegalArgumentException</a></td>
|
|
<td>if the project or command is blank (null, empty or whitespace)</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">See Also</h5>
|
|
<ul class="nolist"><li><code><a href="../../../org/rundeck/api/RundeckClient.html#runAdhocCommand(java.lang.String, java.lang.String, java.util.Properties, java.lang.Integer, java.lang.Boolean, long, java.util.concurrent.TimeUnit)">runAdhocCommand(String, String, Properties, Integer, Boolean, long, TimeUnit)</a></code></li><li><code><a href="../../../org/rundeck/api/RundeckClient.html#triggerAdhocCommand(java.lang.String, java.lang.String, java.util.Properties)">triggerAdhocCommand(String, String, Properties)</a></code></li>
|
|
</ul>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<A NAME="runAdhocCommand(java.lang.String, java.lang.String, long, java.util.concurrent.TimeUnit)"></A>
|
|
|
|
<div class="jd-details api apilevel-">
|
|
<h4 class="jd-details-title">
|
|
<span class="normal">
|
|
public
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a>
|
|
</span>
|
|
<span class="sympad">runAdhocCommand</span>
|
|
<span class="normal">(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> project, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> command, long poolingInterval, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/concurrent/TimeUnit.html">TimeUnit</a> poolingUnit)</span>
|
|
</h4>
|
|
<div class="api-level">
|
|
<div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<div class="jd-details-descr">
|
|
|
|
<div class="jd-tagdata jd-tagdescr"><p>Run an ad-hoc command, and wait until its execution is finished (or aborted) to return. We will poll the RunDeck
|
|
server at regular interval (configured by the poolingInterval/poolingUnit couple) to know if the execution is
|
|
finished (or aborted) or is still running. The command will not be dispatched to nodes, but be executed on the
|
|
RunDeck server.</p></div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Parameters</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th>project</td>
|
|
<td>name of the project - mandatory</td>
|
|
</tr>
|
|
<tr>
|
|
<th>command</td>
|
|
<td>to be executed - mandatory</td>
|
|
</tr>
|
|
<tr>
|
|
<th>poolingInterval</td>
|
|
<td>for checking the status of the execution. Must be > 0.</td>
|
|
</tr>
|
|
<tr>
|
|
<th>poolingUnit</td>
|
|
<td>unit (seconds, milli-seconds, ...) of the interval. Default to seconds.</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Returns</h5>
|
|
<ul class="nolist"><li>a <code><a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a></code> instance for the (finished/aborted) execution - won't be null</li></ul>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Throws</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.html">RundeckApiException</a></td>
|
|
<td>in case of error when calling the API (non-existent project with this name)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html">RundeckApiException.RundeckApiLoginException</a></td>
|
|
<td>if the login fails (in case of login-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiTokenException.html">RundeckApiException.RundeckApiTokenException</a></td>
|
|
<td>if the token is invalid (in case of token-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/IllegalArgumentException.html">IllegalArgumentException</a></td>
|
|
<td>if the project or command is blank (null, empty or whitespace)</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">See Also</h5>
|
|
<ul class="nolist"><li><code><a href="../../../org/rundeck/api/RundeckClient.html#runAdhocCommand(java.lang.String, java.lang.String, java.util.Properties, java.lang.Integer, java.lang.Boolean, long, java.util.concurrent.TimeUnit)">runAdhocCommand(String, String, Properties, Integer, Boolean, long, TimeUnit)</a></code></li><li><code><a href="../../../org/rundeck/api/RundeckClient.html#triggerAdhocCommand(java.lang.String, java.lang.String)">triggerAdhocCommand(String, String)</a></code></li>
|
|
</ul>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<A NAME="runAdhocScript(java.lang.String, java.io.InputStream)"></A>
|
|
|
|
<div class="jd-details api apilevel-">
|
|
<h4 class="jd-details-title">
|
|
<span class="normal">
|
|
public
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a>
|
|
</span>
|
|
<span class="sympad">runAdhocScript</span>
|
|
<span class="normal">(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> project, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/io/InputStream.html">InputStream</a> script)</span>
|
|
</h4>
|
|
<div class="api-level">
|
|
<div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<div class="jd-details-descr">
|
|
|
|
<div class="jd-tagdata jd-tagdescr"><p>Run an ad-hoc script, and wait until its execution is finished (or aborted) to return. We will poll the RunDeck
|
|
server at regular interval (every 5 seconds) to know if the execution is finished (or aborted) or is still
|
|
running. The script will not be dispatched to nodes, but be executed on the RunDeck server.</p></div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Parameters</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th>project</td>
|
|
<td>name of the project - mandatory</td>
|
|
</tr>
|
|
<tr>
|
|
<th>script</td>
|
|
<td>inputStream for reading the script to be executed - mandatory</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Returns</h5>
|
|
<ul class="nolist"><li>a <code><a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a></code> instance for the (finished/aborted) execution - won't be null</li></ul>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Throws</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.html">RundeckApiException</a></td>
|
|
<td>in case of error when calling the API (non-existent project with this name)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html">RundeckApiException.RundeckApiLoginException</a></td>
|
|
<td>if the login fails (in case of login-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiTokenException.html">RundeckApiException.RundeckApiTokenException</a></td>
|
|
<td>if the token is invalid (in case of token-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/IllegalArgumentException.html">IllegalArgumentException</a></td>
|
|
<td>if the project is blank (null, empty or whitespace) or the script is null</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/io/IOException.html">IOException</a></td>
|
|
<td>if we failed to read the file</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">See Also</h5>
|
|
<ul class="nolist"><li><code><a href="../../../org/rundeck/api/RundeckClient.html#runAdhocScript(java.lang.String, java.io.InputStream, java.util.Properties, java.util.Properties, java.lang.Integer, java.lang.Boolean, long, java.util.concurrent.TimeUnit)">runAdhocScript(String, InputStream, Properties, Properties, Integer, Boolean, long, TimeUnit)</a></code></li><li><code><a href="../../../org/rundeck/api/RundeckClient.html#triggerAdhocScript(java.lang.String, java.io.InputStream)">triggerAdhocScript(String, InputStream)</a></code></li>
|
|
</ul>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<A NAME="runAdhocScript(java.lang.String, java.io.InputStream, java.util.Properties)"></A>
|
|
|
|
<div class="jd-details api apilevel-">
|
|
<h4 class="jd-details-title">
|
|
<span class="normal">
|
|
public
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a>
|
|
</span>
|
|
<span class="sympad">runAdhocScript</span>
|
|
<span class="normal">(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> project, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/io/InputStream.html">InputStream</a> script, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/Properties.html">Properties</a> options)</span>
|
|
</h4>
|
|
<div class="api-level">
|
|
<div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<div class="jd-details-descr">
|
|
|
|
<div class="jd-tagdata jd-tagdescr"><p>Run an ad-hoc script, and wait until its execution is finished (or aborted) to return. We will poll the RunDeck
|
|
server at regular interval (every 5 seconds) to know if the execution is finished (or aborted) or is still
|
|
running. The script will not be dispatched to nodes, but be executed on the RunDeck server.</p></div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Parameters</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th>project</td>
|
|
<td>name of the project - mandatory</td>
|
|
</tr>
|
|
<tr>
|
|
<th>script</td>
|
|
<td>inputStream for reading the script to be executed - mandatory</td>
|
|
</tr>
|
|
<tr>
|
|
<th>options</td>
|
|
<td>of the script - optional. See <code><a href="../../../org/rundeck/api/OptionsBuilder.html">OptionsBuilder</a></code>.</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Returns</h5>
|
|
<ul class="nolist"><li>a <code><a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a></code> instance for the (finished/aborted) execution - won't be null</li></ul>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Throws</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.html">RundeckApiException</a></td>
|
|
<td>in case of error when calling the API (non-existent project with this name)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html">RundeckApiException.RundeckApiLoginException</a></td>
|
|
<td>if the login fails (in case of login-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiTokenException.html">RundeckApiException.RundeckApiTokenException</a></td>
|
|
<td>if the token is invalid (in case of token-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/IllegalArgumentException.html">IllegalArgumentException</a></td>
|
|
<td>if the project is blank (null, empty or whitespace) or the script is null</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/io/IOException.html">IOException</a></td>
|
|
<td>if we failed to read the file</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">See Also</h5>
|
|
<ul class="nolist"><li><code><a href="../../../org/rundeck/api/RundeckClient.html#runAdhocScript(java.lang.String, java.io.InputStream, java.util.Properties, java.util.Properties, java.lang.Integer, java.lang.Boolean, long, java.util.concurrent.TimeUnit)">runAdhocScript(String, InputStream, Properties, Properties, Integer, Boolean, long, TimeUnit)</a></code></li><li><code><a href="../../../org/rundeck/api/RundeckClient.html#triggerAdhocScript(java.lang.String, java.io.InputStream, java.util.Properties)">triggerAdhocScript(String, InputStream, Properties)</a></code></li>
|
|
</ul>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<A NAME="runAdhocScript(java.lang.String, java.io.InputStream, java.util.Properties, java.util.Properties)"></A>
|
|
|
|
<div class="jd-details api apilevel-">
|
|
<h4 class="jd-details-title">
|
|
<span class="normal">
|
|
public
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a>
|
|
</span>
|
|
<span class="sympad">runAdhocScript</span>
|
|
<span class="normal">(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> project, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/io/InputStream.html">InputStream</a> script, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/Properties.html">Properties</a> options, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/Properties.html">Properties</a> nodeFilters)</span>
|
|
</h4>
|
|
<div class="api-level">
|
|
<div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<div class="jd-details-descr">
|
|
|
|
<div class="jd-tagdata jd-tagdescr"><p>Run an ad-hoc script, and wait until its execution is finished (or aborted) to return. We will poll the RunDeck
|
|
server at regular interval (every 5 seconds) to know if the execution is finished (or aborted) or is still
|
|
running. The script will be dispatched to nodes, accordingly to the nodeFilters parameter.</p></div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Parameters</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th>project</td>
|
|
<td>name of the project - mandatory</td>
|
|
</tr>
|
|
<tr>
|
|
<th>script</td>
|
|
<td>inputStream for reading the script to be executed - mandatory</td>
|
|
</tr>
|
|
<tr>
|
|
<th>options</td>
|
|
<td>of the script - optional. See <code><a href="../../../org/rundeck/api/OptionsBuilder.html">OptionsBuilder</a></code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<th>nodeFilters</td>
|
|
<td>for selecting nodes on which the script will be executed. See <code><a href="../../../org/rundeck/api/NodeFiltersBuilder.html">NodeFiltersBuilder</a></code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Returns</h5>
|
|
<ul class="nolist"><li>a <code><a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a></code> instance for the (finished/aborted) execution - won't be null</li></ul>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Throws</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.html">RundeckApiException</a></td>
|
|
<td>in case of error when calling the API (non-existent project with this name)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html">RundeckApiException.RundeckApiLoginException</a></td>
|
|
<td>if the login fails (in case of login-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiTokenException.html">RundeckApiException.RundeckApiTokenException</a></td>
|
|
<td>if the token is invalid (in case of token-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/IllegalArgumentException.html">IllegalArgumentException</a></td>
|
|
<td>if the project is blank (null, empty or whitespace) or the script is null</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/io/IOException.html">IOException</a></td>
|
|
<td>if we failed to read the file</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">See Also</h5>
|
|
<ul class="nolist"><li><code><a href="../../../org/rundeck/api/RundeckClient.html#runAdhocScript(java.lang.String, java.io.InputStream, java.util.Properties, java.util.Properties, java.lang.Integer, java.lang.Boolean, long, java.util.concurrent.TimeUnit)">runAdhocScript(String, InputStream, Properties, Properties, Integer, Boolean, long, TimeUnit)</a></code></li><li><code><a href="../../../org/rundeck/api/RundeckClient.html#triggerAdhocScript(java.lang.String, java.io.InputStream, java.util.Properties, java.util.Properties)">triggerAdhocScript(String, InputStream, Properties, Properties)</a></code></li>
|
|
</ul>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<A NAME="runAdhocScript(java.lang.String, java.io.InputStream, java.util.Properties, java.util.Properties, java.lang.Integer, java.lang.Boolean)"></A>
|
|
|
|
<div class="jd-details api apilevel-">
|
|
<h4 class="jd-details-title">
|
|
<span class="normal">
|
|
public
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a>
|
|
</span>
|
|
<span class="sympad">runAdhocScript</span>
|
|
<span class="normal">(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> project, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/io/InputStream.html">InputStream</a> script, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/Properties.html">Properties</a> options, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/Properties.html">Properties</a> nodeFilters, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/Integer.html">Integer</a> nodeThreadcount, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/Boolean.html">Boolean</a> nodeKeepgoing)</span>
|
|
</h4>
|
|
<div class="api-level">
|
|
<div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<div class="jd-details-descr">
|
|
|
|
<div class="jd-tagdata jd-tagdescr"><p>Run an ad-hoc script, and wait until its execution is finished (or aborted) to return. We will poll the RunDeck
|
|
server at regular interval (every 5 seconds) to know if the execution is finished (or aborted) or is still
|
|
running. The script will be dispatched to nodes, accordingly to the nodeFilters parameter.</p></div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Parameters</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th>project</td>
|
|
<td>name of the project - mandatory</td>
|
|
</tr>
|
|
<tr>
|
|
<th>script</td>
|
|
<td>inputStream for reading the script to be executed - mandatory</td>
|
|
</tr>
|
|
<tr>
|
|
<th>options</td>
|
|
<td>of the script - optional. See <code><a href="../../../org/rundeck/api/OptionsBuilder.html">OptionsBuilder</a></code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<th>nodeFilters</td>
|
|
<td>for selecting nodes on which the script will be executed. See <code><a href="../../../org/rundeck/api/NodeFiltersBuilder.html">NodeFiltersBuilder</a></code></td>
|
|
</tr>
|
|
<tr>
|
|
<th>nodeThreadcount</td>
|
|
<td>thread count to use (for parallelizing when running on multiple nodes) - optional</td>
|
|
</tr>
|
|
<tr>
|
|
<th>nodeKeepgoing</td>
|
|
<td>if true, continue executing on other nodes even if some fail - optional</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Returns</h5>
|
|
<ul class="nolist"><li>a <code><a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a></code> instance for the (finished/aborted) execution - won't be null</li></ul>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Throws</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.html">RundeckApiException</a></td>
|
|
<td>in case of error when calling the API (non-existent project with this name)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html">RundeckApiException.RundeckApiLoginException</a></td>
|
|
<td>if the login fails (in case of login-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiTokenException.html">RundeckApiException.RundeckApiTokenException</a></td>
|
|
<td>if the token is invalid (in case of token-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/IllegalArgumentException.html">IllegalArgumentException</a></td>
|
|
<td>if the project is blank (null, empty or whitespace) or the script is null</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/io/IOException.html">IOException</a></td>
|
|
<td>if we failed to read the file</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">See Also</h5>
|
|
<ul class="nolist"><li><code><a href="../../../org/rundeck/api/RundeckClient.html#runAdhocScript(java.lang.String, java.io.InputStream, java.util.Properties, java.util.Properties, java.lang.Integer, java.lang.Boolean, long, java.util.concurrent.TimeUnit)">runAdhocScript(String, InputStream, Properties, Properties, Integer, Boolean, long, TimeUnit)</a></code></li><li><code><a href="../../../org/rundeck/api/RundeckClient.html#triggerAdhocScript(java.lang.String, java.io.InputStream, java.util.Properties, java.util.Properties, java.lang.Integer, java.lang.Boolean)">triggerAdhocScript(String, InputStream, Properties, Properties, Integer, Boolean)</a></code></li>
|
|
</ul>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<A NAME="runAdhocScript(java.lang.String, java.io.InputStream, java.util.Properties, java.util.Properties, java.lang.Integer, java.lang.Boolean, long, java.util.concurrent.TimeUnit)"></A>
|
|
|
|
<div class="jd-details api apilevel-">
|
|
<h4 class="jd-details-title">
|
|
<span class="normal">
|
|
public
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a>
|
|
</span>
|
|
<span class="sympad">runAdhocScript</span>
|
|
<span class="normal">(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> project, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/io/InputStream.html">InputStream</a> script, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/Properties.html">Properties</a> options, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/Properties.html">Properties</a> nodeFilters, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/Integer.html">Integer</a> nodeThreadcount, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/Boolean.html">Boolean</a> nodeKeepgoing, long poolingInterval, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/concurrent/TimeUnit.html">TimeUnit</a> poolingUnit)</span>
|
|
</h4>
|
|
<div class="api-level">
|
|
<div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<div class="jd-details-descr">
|
|
|
|
<div class="jd-tagdata jd-tagdescr"><p>Run an ad-hoc script, and wait until its execution is finished (or aborted) to return. We will poll the RunDeck
|
|
server at regular interval (configured by the poolingInterval/poolingUnit couple) to know if the execution is
|
|
finished (or aborted) or is still running. The script will be dispatched to nodes, accordingly to the nodeFilters
|
|
parameter.</p></div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Parameters</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th>project</td>
|
|
<td>name of the project - mandatory</td>
|
|
</tr>
|
|
<tr>
|
|
<th>script</td>
|
|
<td>inputStream for reading the script to be executed - mandatory</td>
|
|
</tr>
|
|
<tr>
|
|
<th>options</td>
|
|
<td>of the script - optional. See <code><a href="../../../org/rundeck/api/OptionsBuilder.html">OptionsBuilder</a></code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<th>nodeFilters</td>
|
|
<td>for selecting nodes on which the script will be executed. See <code><a href="../../../org/rundeck/api/NodeFiltersBuilder.html">NodeFiltersBuilder</a></code></td>
|
|
</tr>
|
|
<tr>
|
|
<th>nodeThreadcount</td>
|
|
<td>thread count to use (for parallelizing when running on multiple nodes) - optional</td>
|
|
</tr>
|
|
<tr>
|
|
<th>nodeKeepgoing</td>
|
|
<td>if true, continue executing on other nodes even if some fail - optional</td>
|
|
</tr>
|
|
<tr>
|
|
<th>poolingInterval</td>
|
|
<td>for checking the status of the execution. Must be > 0.</td>
|
|
</tr>
|
|
<tr>
|
|
<th>poolingUnit</td>
|
|
<td>unit (seconds, milli-seconds, ...) of the interval. Default to seconds.</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Returns</h5>
|
|
<ul class="nolist"><li>a <code><a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a></code> instance for the (finished/aborted) execution - won't be null</li></ul>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Throws</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.html">RundeckApiException</a></td>
|
|
<td>in case of error when calling the API (non-existent project with this name)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html">RundeckApiException.RundeckApiLoginException</a></td>
|
|
<td>if the login fails (in case of login-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiTokenException.html">RundeckApiException.RundeckApiTokenException</a></td>
|
|
<td>if the token is invalid (in case of token-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/IllegalArgumentException.html">IllegalArgumentException</a></td>
|
|
<td>if the project is blank (null, empty or whitespace) or the script is null</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/io/IOException.html">IOException</a></td>
|
|
<td>if we failed to read the file</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">See Also</h5>
|
|
<ul class="nolist"><li><code><a href="../../../org/rundeck/api/RundeckClient.html#runAdhocScript(java.lang.String, java.lang.String, java.util.Properties, java.util.Properties, java.lang.Integer, java.lang.Boolean, long, java.util.concurrent.TimeUnit)">runAdhocScript(String, String, Properties, Properties, Integer, Boolean, long, TimeUnit)</a></code></li><li><code><a href="../../../org/rundeck/api/RundeckClient.html#triggerAdhocScript(java.lang.String, java.io.InputStream, java.util.Properties, java.util.Properties, java.lang.Integer, java.lang.Boolean)">triggerAdhocScript(String, InputStream, Properties, Properties, Integer, Boolean)</a></code></li>
|
|
</ul>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<A NAME="runAdhocScript(java.lang.String, java.io.InputStream, java.util.Properties, java.util.Properties, long, java.util.concurrent.TimeUnit)"></A>
|
|
|
|
<div class="jd-details api apilevel-">
|
|
<h4 class="jd-details-title">
|
|
<span class="normal">
|
|
public
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a>
|
|
</span>
|
|
<span class="sympad">runAdhocScript</span>
|
|
<span class="normal">(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> project, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/io/InputStream.html">InputStream</a> script, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/Properties.html">Properties</a> options, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/Properties.html">Properties</a> nodeFilters, long poolingInterval, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/concurrent/TimeUnit.html">TimeUnit</a> poolingUnit)</span>
|
|
</h4>
|
|
<div class="api-level">
|
|
<div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<div class="jd-details-descr">
|
|
|
|
<div class="jd-tagdata jd-tagdescr"><p>Run an ad-hoc script, and wait until its execution is finished (or aborted) to return. We will poll the RunDeck
|
|
server at regular interval (configured by the poolingInterval/poolingUnit couple) to know if the execution is
|
|
finished (or aborted) or is still running. The script will be dispatched to nodes, accordingly to the nodeFilters
|
|
parameter.</p></div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Parameters</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th>project</td>
|
|
<td>name of the project - mandatory</td>
|
|
</tr>
|
|
<tr>
|
|
<th>script</td>
|
|
<td>inputStream for reading the script to be executed - mandatory</td>
|
|
</tr>
|
|
<tr>
|
|
<th>options</td>
|
|
<td>of the script - optional. See <code><a href="../../../org/rundeck/api/OptionsBuilder.html">OptionsBuilder</a></code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<th>nodeFilters</td>
|
|
<td>for selecting nodes on which the script will be executed. See <code><a href="../../../org/rundeck/api/NodeFiltersBuilder.html">NodeFiltersBuilder</a></code></td>
|
|
</tr>
|
|
<tr>
|
|
<th>poolingInterval</td>
|
|
<td>for checking the status of the execution. Must be > 0.</td>
|
|
</tr>
|
|
<tr>
|
|
<th>poolingUnit</td>
|
|
<td>unit (seconds, milli-seconds, ...) of the interval. Default to seconds.</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Returns</h5>
|
|
<ul class="nolist"><li>a <code><a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a></code> instance for the (finished/aborted) execution - won't be null</li></ul>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Throws</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.html">RundeckApiException</a></td>
|
|
<td>in case of error when calling the API (non-existent project with this name)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html">RundeckApiException.RundeckApiLoginException</a></td>
|
|
<td>if the login fails (in case of login-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiTokenException.html">RundeckApiException.RundeckApiTokenException</a></td>
|
|
<td>if the token is invalid (in case of token-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/IllegalArgumentException.html">IllegalArgumentException</a></td>
|
|
<td>if the project is blank (null, empty or whitespace) or the script is null</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/io/IOException.html">IOException</a></td>
|
|
<td>if we failed to read the file</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">See Also</h5>
|
|
<ul class="nolist"><li><code><a href="../../../org/rundeck/api/RundeckClient.html#runAdhocScript(java.lang.String, java.io.InputStream, java.util.Properties, java.util.Properties, java.lang.Integer, java.lang.Boolean, long, java.util.concurrent.TimeUnit)">runAdhocScript(String, InputStream, Properties, Properties, Integer, Boolean, long, TimeUnit)</a></code></li><li><code><a href="../../../org/rundeck/api/RundeckClient.html#triggerAdhocScript(java.lang.String, java.io.InputStream, java.util.Properties, java.util.Properties)">triggerAdhocScript(String, InputStream, Properties, Properties)</a></code></li>
|
|
</ul>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<A NAME="runAdhocScript(java.lang.String, java.io.InputStream, java.util.Properties, long, java.util.concurrent.TimeUnit)"></A>
|
|
|
|
<div class="jd-details api apilevel-">
|
|
<h4 class="jd-details-title">
|
|
<span class="normal">
|
|
public
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a>
|
|
</span>
|
|
<span class="sympad">runAdhocScript</span>
|
|
<span class="normal">(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> project, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/io/InputStream.html">InputStream</a> script, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/Properties.html">Properties</a> options, long poolingInterval, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/concurrent/TimeUnit.html">TimeUnit</a> poolingUnit)</span>
|
|
</h4>
|
|
<div class="api-level">
|
|
<div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<div class="jd-details-descr">
|
|
|
|
<div class="jd-tagdata jd-tagdescr"><p>Run an ad-hoc script, and wait until its execution is finished (or aborted) to return. We will poll the RunDeck
|
|
server at regular interval (configured by the poolingInterval/poolingUnit couple) to know if the execution is
|
|
finished (or aborted) or is still running. The script will not be dispatched to nodes, but be executed on the
|
|
RunDeck server.</p></div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Parameters</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th>project</td>
|
|
<td>name of the project - mandatory</td>
|
|
</tr>
|
|
<tr>
|
|
<th>script</td>
|
|
<td>inputStream for reading the script to be executed - mandatory</td>
|
|
</tr>
|
|
<tr>
|
|
<th>options</td>
|
|
<td>of the script - optional. See <code><a href="../../../org/rundeck/api/OptionsBuilder.html">OptionsBuilder</a></code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<th>poolingInterval</td>
|
|
<td>for checking the status of the execution. Must be > 0.</td>
|
|
</tr>
|
|
<tr>
|
|
<th>poolingUnit</td>
|
|
<td>unit (seconds, milli-seconds, ...) of the interval. Default to seconds.</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Returns</h5>
|
|
<ul class="nolist"><li>a <code><a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a></code> instance for the (finished/aborted) execution - won't be null</li></ul>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Throws</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.html">RundeckApiException</a></td>
|
|
<td>in case of error when calling the API (non-existent project with this name)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html">RundeckApiException.RundeckApiLoginException</a></td>
|
|
<td>if the login fails (in case of login-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiTokenException.html">RundeckApiException.RundeckApiTokenException</a></td>
|
|
<td>if the token is invalid (in case of token-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/IllegalArgumentException.html">IllegalArgumentException</a></td>
|
|
<td>if the project is blank (null, empty or whitespace) or the script is null</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/io/IOException.html">IOException</a></td>
|
|
<td>if we failed to read the file</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">See Also</h5>
|
|
<ul class="nolist"><li><code><a href="../../../org/rundeck/api/RundeckClient.html#runAdhocScript(java.lang.String, java.io.InputStream, java.util.Properties, java.util.Properties, java.lang.Integer, java.lang.Boolean, long, java.util.concurrent.TimeUnit)">runAdhocScript(String, InputStream, Properties, Properties, Integer, Boolean, long, TimeUnit)</a></code></li><li><code><a href="../../../org/rundeck/api/RundeckClient.html#triggerAdhocScript(java.lang.String, java.io.InputStream, java.util.Properties)">triggerAdhocScript(String, InputStream, Properties)</a></code></li>
|
|
</ul>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<A NAME="runAdhocScript(java.lang.String, java.io.InputStream, long, java.util.concurrent.TimeUnit)"></A>
|
|
|
|
<div class="jd-details api apilevel-">
|
|
<h4 class="jd-details-title">
|
|
<span class="normal">
|
|
public
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a>
|
|
</span>
|
|
<span class="sympad">runAdhocScript</span>
|
|
<span class="normal">(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> project, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/io/InputStream.html">InputStream</a> script, long poolingInterval, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/concurrent/TimeUnit.html">TimeUnit</a> poolingUnit)</span>
|
|
</h4>
|
|
<div class="api-level">
|
|
<div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<div class="jd-details-descr">
|
|
|
|
<div class="jd-tagdata jd-tagdescr"><p>Run an ad-hoc script, and wait until its execution is finished (or aborted) to return. We will poll the RunDeck
|
|
server at regular interval (configured by the poolingInterval/poolingUnit couple) to know if the execution is
|
|
finished (or aborted) or is still running. The script will not be dispatched to nodes, but be executed on the
|
|
RunDeck server.</p></div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Parameters</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th>project</td>
|
|
<td>name of the project - mandatory</td>
|
|
</tr>
|
|
<tr>
|
|
<th>script</td>
|
|
<td>inputStream for reading the script to be executed - mandatory</td>
|
|
</tr>
|
|
<tr>
|
|
<th>poolingInterval</td>
|
|
<td>for checking the status of the execution. Must be > 0.</td>
|
|
</tr>
|
|
<tr>
|
|
<th>poolingUnit</td>
|
|
<td>unit (seconds, milli-seconds, ...) of the interval. Default to seconds.</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Returns</h5>
|
|
<ul class="nolist"><li>a <code><a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a></code> instance for the (finished/aborted) execution - won't be null</li></ul>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Throws</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.html">RundeckApiException</a></td>
|
|
<td>in case of error when calling the API (non-existent project with this name)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html">RundeckApiException.RundeckApiLoginException</a></td>
|
|
<td>if the login fails (in case of login-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiTokenException.html">RundeckApiException.RundeckApiTokenException</a></td>
|
|
<td>if the token is invalid (in case of token-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/IllegalArgumentException.html">IllegalArgumentException</a></td>
|
|
<td>if the project is blank (null, empty or whitespace) or the script is null</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/io/IOException.html">IOException</a></td>
|
|
<td>if we failed to read the file</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">See Also</h5>
|
|
<ul class="nolist"><li><code><a href="../../../org/rundeck/api/RundeckClient.html#runAdhocScript(java.lang.String, java.io.InputStream, java.util.Properties, java.util.Properties, java.lang.Integer, java.lang.Boolean, long, java.util.concurrent.TimeUnit)">runAdhocScript(String, InputStream, Properties, Properties, Integer, Boolean, long, TimeUnit)</a></code></li><li><code><a href="../../../org/rundeck/api/RundeckClient.html#triggerAdhocScript(java.lang.String, java.io.InputStream)">triggerAdhocScript(String, InputStream)</a></code></li>
|
|
</ul>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<A NAME="runAdhocScript(java.lang.String, java.lang.String)"></A>
|
|
|
|
<div class="jd-details api apilevel-">
|
|
<h4 class="jd-details-title">
|
|
<span class="normal">
|
|
public
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a>
|
|
</span>
|
|
<span class="sympad">runAdhocScript</span>
|
|
<span class="normal">(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> project, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> scriptFilename)</span>
|
|
</h4>
|
|
<div class="api-level">
|
|
<div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<div class="jd-details-descr">
|
|
|
|
<div class="jd-tagdata jd-tagdescr"><p>Run an ad-hoc script, and wait until its execution is finished (or aborted) to return. We will poll the RunDeck
|
|
server at regular interval (every 5 seconds) to know if the execution is finished (or aborted) or is still
|
|
running. The script will not be dispatched to nodes, but be executed on the RunDeck server.</p></div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Parameters</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th>project</td>
|
|
<td>name of the project - mandatory</td>
|
|
</tr>
|
|
<tr>
|
|
<th>scriptFilename</td>
|
|
<td>filename of the script to be executed - mandatory</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Returns</h5>
|
|
<ul class="nolist"><li>a <code><a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a></code> instance for the (finished/aborted) execution - won't be null</li></ul>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Throws</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.html">RundeckApiException</a></td>
|
|
<td>in case of error when calling the API (non-existent project with this name)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html">RundeckApiException.RundeckApiLoginException</a></td>
|
|
<td>if the login fails (in case of login-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiTokenException.html">RundeckApiException.RundeckApiTokenException</a></td>
|
|
<td>if the token is invalid (in case of token-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/IllegalArgumentException.html">IllegalArgumentException</a></td>
|
|
<td>if the project or scriptFilename is blank (null, empty or whitespace)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/io/IOException.html">IOException</a></td>
|
|
<td>if we failed to read the file</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">See Also</h5>
|
|
<ul class="nolist"><li><code><a href="../../../org/rundeck/api/RundeckClient.html#runAdhocScript(java.lang.String, java.lang.String, java.util.Properties, java.util.Properties, java.lang.Integer, java.lang.Boolean, long, java.util.concurrent.TimeUnit)">runAdhocScript(String, String, Properties, Properties, Integer, Boolean, long, TimeUnit)</a></code></li><li><code><a href="../../../org/rundeck/api/RundeckClient.html#triggerAdhocScript(java.lang.String, java.lang.String)">triggerAdhocScript(String, String)</a></code></li>
|
|
</ul>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<A NAME="runAdhocScript(java.lang.String, java.lang.String, java.util.Properties)"></A>
|
|
|
|
<div class="jd-details api apilevel-">
|
|
<h4 class="jd-details-title">
|
|
<span class="normal">
|
|
public
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a>
|
|
</span>
|
|
<span class="sympad">runAdhocScript</span>
|
|
<span class="normal">(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> project, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> scriptFilename, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/Properties.html">Properties</a> options)</span>
|
|
</h4>
|
|
<div class="api-level">
|
|
<div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<div class="jd-details-descr">
|
|
|
|
<div class="jd-tagdata jd-tagdescr"><p>Run an ad-hoc script, and wait until its execution is finished (or aborted) to return. We will poll the RunDeck
|
|
server at regular interval (every 5 seconds) to know if the execution is finished (or aborted) or is still
|
|
running. The script will not be dispatched to nodes, but be executed on the RunDeck server.</p></div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Parameters</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th>project</td>
|
|
<td>name of the project - mandatory</td>
|
|
</tr>
|
|
<tr>
|
|
<th>scriptFilename</td>
|
|
<td>filename of the script to be executed - mandatory</td>
|
|
</tr>
|
|
<tr>
|
|
<th>options</td>
|
|
<td>of the script - optional. See <code><a href="../../../org/rundeck/api/OptionsBuilder.html">OptionsBuilder</a></code>.</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Returns</h5>
|
|
<ul class="nolist"><li>a <code><a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a></code> instance for the (finished/aborted) execution - won't be null</li></ul>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Throws</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.html">RundeckApiException</a></td>
|
|
<td>in case of error when calling the API (non-existent project with this name)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html">RundeckApiException.RundeckApiLoginException</a></td>
|
|
<td>if the login fails (in case of login-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiTokenException.html">RundeckApiException.RundeckApiTokenException</a></td>
|
|
<td>if the token is invalid (in case of token-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/IllegalArgumentException.html">IllegalArgumentException</a></td>
|
|
<td>if the project or scriptFilename is blank (null, empty or whitespace)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/io/IOException.html">IOException</a></td>
|
|
<td>if we failed to read the file</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">See Also</h5>
|
|
<ul class="nolist"><li><code><a href="../../../org/rundeck/api/RundeckClient.html#runAdhocScript(java.lang.String, java.lang.String, java.util.Properties, java.util.Properties, java.lang.Integer, java.lang.Boolean, long, java.util.concurrent.TimeUnit)">runAdhocScript(String, String, Properties, Properties, Integer, Boolean, long, TimeUnit)</a></code></li><li><code><a href="../../../org/rundeck/api/RundeckClient.html#triggerAdhocScript(java.lang.String, java.lang.String, java.util.Properties)">triggerAdhocScript(String, String, Properties)</a></code></li>
|
|
</ul>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<A NAME="runAdhocScript(java.lang.String, java.lang.String, java.util.Properties, java.util.Properties)"></A>
|
|
|
|
<div class="jd-details api apilevel-">
|
|
<h4 class="jd-details-title">
|
|
<span class="normal">
|
|
public
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a>
|
|
</span>
|
|
<span class="sympad">runAdhocScript</span>
|
|
<span class="normal">(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> project, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> scriptFilename, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/Properties.html">Properties</a> options, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/Properties.html">Properties</a> nodeFilters)</span>
|
|
</h4>
|
|
<div class="api-level">
|
|
<div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<div class="jd-details-descr">
|
|
|
|
<div class="jd-tagdata jd-tagdescr"><p>Run an ad-hoc script, and wait until its execution is finished (or aborted) to return. We will poll the RunDeck
|
|
server at regular interval (every 5 seconds) to know if the execution is finished (or aborted) or is still
|
|
running. The script will be dispatched to nodes, accordingly to the nodeFilters parameter.</p></div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Parameters</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th>project</td>
|
|
<td>name of the project - mandatory</td>
|
|
</tr>
|
|
<tr>
|
|
<th>scriptFilename</td>
|
|
<td>filename of the script to be executed - mandatory</td>
|
|
</tr>
|
|
<tr>
|
|
<th>options</td>
|
|
<td>of the script - optional. See <code><a href="../../../org/rundeck/api/OptionsBuilder.html">OptionsBuilder</a></code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<th>nodeFilters</td>
|
|
<td>for selecting nodes on which the script will be executed. See <code><a href="../../../org/rundeck/api/NodeFiltersBuilder.html">NodeFiltersBuilder</a></code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Returns</h5>
|
|
<ul class="nolist"><li>a <code><a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a></code> instance for the (finished/aborted) execution - won't be null</li></ul>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Throws</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.html">RundeckApiException</a></td>
|
|
<td>in case of error when calling the API (non-existent project with this name)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html">RundeckApiException.RundeckApiLoginException</a></td>
|
|
<td>if the login fails (in case of login-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiTokenException.html">RundeckApiException.RundeckApiTokenException</a></td>
|
|
<td>if the token is invalid (in case of token-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/IllegalArgumentException.html">IllegalArgumentException</a></td>
|
|
<td>if the project or scriptFilename is blank (null, empty or whitespace)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/io/IOException.html">IOException</a></td>
|
|
<td>if we failed to read the file</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">See Also</h5>
|
|
<ul class="nolist"><li><code><a href="../../../org/rundeck/api/RundeckClient.html#runAdhocScript(java.lang.String, java.lang.String, java.util.Properties, java.util.Properties, java.lang.Integer, java.lang.Boolean, long, java.util.concurrent.TimeUnit)">runAdhocScript(String, String, Properties, Properties, Integer, Boolean, long, TimeUnit)</a></code></li><li><code><a href="../../../org/rundeck/api/RundeckClient.html#triggerAdhocScript(java.lang.String, java.lang.String, java.util.Properties, java.util.Properties)">triggerAdhocScript(String, String, Properties, Properties)</a></code></li>
|
|
</ul>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<A NAME="runAdhocScript(java.lang.String, java.lang.String, java.util.Properties, java.util.Properties, java.lang.Integer, java.lang.Boolean)"></A>
|
|
|
|
<div class="jd-details api apilevel-">
|
|
<h4 class="jd-details-title">
|
|
<span class="normal">
|
|
public
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a>
|
|
</span>
|
|
<span class="sympad">runAdhocScript</span>
|
|
<span class="normal">(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> project, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> scriptFilename, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/Properties.html">Properties</a> options, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/Properties.html">Properties</a> nodeFilters, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/Integer.html">Integer</a> nodeThreadcount, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/Boolean.html">Boolean</a> nodeKeepgoing)</span>
|
|
</h4>
|
|
<div class="api-level">
|
|
<div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<div class="jd-details-descr">
|
|
|
|
<div class="jd-tagdata jd-tagdescr"><p>Run an ad-hoc script, and wait until its execution is finished (or aborted) to return. We will poll the RunDeck
|
|
server at regular interval (every 5 seconds) to know if the execution is finished (or aborted) or is still
|
|
running. The script will be dispatched to nodes, accordingly to the nodeFilters parameter.</p></div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Parameters</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th>project</td>
|
|
<td>name of the project - mandatory</td>
|
|
</tr>
|
|
<tr>
|
|
<th>scriptFilename</td>
|
|
<td>filename of the script to be executed - mandatory</td>
|
|
</tr>
|
|
<tr>
|
|
<th>options</td>
|
|
<td>of the script - optional. See <code><a href="../../../org/rundeck/api/OptionsBuilder.html">OptionsBuilder</a></code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<th>nodeFilters</td>
|
|
<td>for selecting nodes on which the script will be executed. See <code><a href="../../../org/rundeck/api/NodeFiltersBuilder.html">NodeFiltersBuilder</a></code></td>
|
|
</tr>
|
|
<tr>
|
|
<th>nodeThreadcount</td>
|
|
<td>thread count to use (for parallelizing when running on multiple nodes) - optional</td>
|
|
</tr>
|
|
<tr>
|
|
<th>nodeKeepgoing</td>
|
|
<td>if true, continue executing on other nodes even if some fail - optional</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Returns</h5>
|
|
<ul class="nolist"><li>a <code><a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a></code> instance for the (finished/aborted) execution - won't be null</li></ul>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Throws</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.html">RundeckApiException</a></td>
|
|
<td>in case of error when calling the API (non-existent project with this name)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html">RundeckApiException.RundeckApiLoginException</a></td>
|
|
<td>if the login fails (in case of login-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiTokenException.html">RundeckApiException.RundeckApiTokenException</a></td>
|
|
<td>if the token is invalid (in case of token-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/IllegalArgumentException.html">IllegalArgumentException</a></td>
|
|
<td>if the project or scriptFilename is blank (null, empty or whitespace)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/io/IOException.html">IOException</a></td>
|
|
<td>if we failed to read the file</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">See Also</h5>
|
|
<ul class="nolist"><li><code><a href="../../../org/rundeck/api/RundeckClient.html#runAdhocScript(java.lang.String, java.lang.String, java.util.Properties, java.util.Properties, java.lang.Integer, java.lang.Boolean, long, java.util.concurrent.TimeUnit)">runAdhocScript(String, String, Properties, Properties, Integer, Boolean, long, TimeUnit)</a></code></li><li><code><a href="../../../org/rundeck/api/RundeckClient.html#triggerAdhocScript(java.lang.String, java.lang.String, java.util.Properties, java.util.Properties, java.lang.Integer, java.lang.Boolean)">triggerAdhocScript(String, String, Properties, Properties, Integer, Boolean)</a></code></li>
|
|
</ul>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<A NAME="runAdhocScript(java.lang.String, java.lang.String, java.util.Properties, java.util.Properties, java.lang.Integer, java.lang.Boolean, long, java.util.concurrent.TimeUnit)"></A>
|
|
|
|
<div class="jd-details api apilevel-">
|
|
<h4 class="jd-details-title">
|
|
<span class="normal">
|
|
public
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a>
|
|
</span>
|
|
<span class="sympad">runAdhocScript</span>
|
|
<span class="normal">(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> project, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> scriptFilename, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/Properties.html">Properties</a> options, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/Properties.html">Properties</a> nodeFilters, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/Integer.html">Integer</a> nodeThreadcount, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/Boolean.html">Boolean</a> nodeKeepgoing, long poolingInterval, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/concurrent/TimeUnit.html">TimeUnit</a> poolingUnit)</span>
|
|
</h4>
|
|
<div class="api-level">
|
|
<div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<div class="jd-details-descr">
|
|
|
|
<div class="jd-tagdata jd-tagdescr"><p>Run an ad-hoc script, and wait until its execution is finished (or aborted) to return. We will poll the RunDeck
|
|
server at regular interval (configured by the poolingInterval/poolingUnit couple) to know if the execution is
|
|
finished (or aborted) or is still running. The script will be dispatched to nodes, accordingly to the nodeFilters
|
|
parameter.</p></div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Parameters</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th>project</td>
|
|
<td>name of the project - mandatory</td>
|
|
</tr>
|
|
<tr>
|
|
<th>scriptFilename</td>
|
|
<td>filename of the script to be executed - mandatory</td>
|
|
</tr>
|
|
<tr>
|
|
<th>options</td>
|
|
<td>of the script - optional. See <code><a href="../../../org/rundeck/api/OptionsBuilder.html">OptionsBuilder</a></code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<th>nodeFilters</td>
|
|
<td>for selecting nodes on which the script will be executed. See <code><a href="../../../org/rundeck/api/NodeFiltersBuilder.html">NodeFiltersBuilder</a></code></td>
|
|
</tr>
|
|
<tr>
|
|
<th>nodeThreadcount</td>
|
|
<td>thread count to use (for parallelizing when running on multiple nodes) - optional</td>
|
|
</tr>
|
|
<tr>
|
|
<th>nodeKeepgoing</td>
|
|
<td>if true, continue executing on other nodes even if some fail - optional</td>
|
|
</tr>
|
|
<tr>
|
|
<th>poolingInterval</td>
|
|
<td>for checking the status of the execution. Must be > 0.</td>
|
|
</tr>
|
|
<tr>
|
|
<th>poolingUnit</td>
|
|
<td>unit (seconds, milli-seconds, ...) of the interval. Default to seconds.</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Returns</h5>
|
|
<ul class="nolist"><li>a <code><a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a></code> instance for the (finished/aborted) execution - won't be null</li></ul>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Throws</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.html">RundeckApiException</a></td>
|
|
<td>in case of error when calling the API (non-existent project with this name)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html">RundeckApiException.RundeckApiLoginException</a></td>
|
|
<td>if the login fails (in case of login-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiTokenException.html">RundeckApiException.RundeckApiTokenException</a></td>
|
|
<td>if the token is invalid (in case of token-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/IllegalArgumentException.html">IllegalArgumentException</a></td>
|
|
<td>if the project or scriptFilename is blank (null, empty or whitespace)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/io/IOException.html">IOException</a></td>
|
|
<td>if we failed to read the file</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">See Also</h5>
|
|
<ul class="nolist"><li><code><a href="../../../org/rundeck/api/RundeckClient.html#runAdhocScript(java.lang.String, java.io.InputStream, java.util.Properties, java.util.Properties, java.lang.Integer, java.lang.Boolean, long, java.util.concurrent.TimeUnit)">runAdhocScript(String, InputStream, Properties, Properties, Integer, Boolean, long, TimeUnit)</a></code></li><li><code><a href="../../../org/rundeck/api/RundeckClient.html#triggerAdhocScript(java.lang.String, java.lang.String, java.util.Properties, java.util.Properties, java.lang.Integer, java.lang.Boolean)">triggerAdhocScript(String, String, Properties, Properties, Integer, Boolean)</a></code></li>
|
|
</ul>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<A NAME="runAdhocScript(java.lang.String, java.lang.String, java.util.Properties, java.util.Properties, long, java.util.concurrent.TimeUnit)"></A>
|
|
|
|
<div class="jd-details api apilevel-">
|
|
<h4 class="jd-details-title">
|
|
<span class="normal">
|
|
public
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a>
|
|
</span>
|
|
<span class="sympad">runAdhocScript</span>
|
|
<span class="normal">(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> project, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> scriptFilename, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/Properties.html">Properties</a> options, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/Properties.html">Properties</a> nodeFilters, long poolingInterval, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/concurrent/TimeUnit.html">TimeUnit</a> poolingUnit)</span>
|
|
</h4>
|
|
<div class="api-level">
|
|
<div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<div class="jd-details-descr">
|
|
|
|
<div class="jd-tagdata jd-tagdescr"><p>Run an ad-hoc script, and wait until its execution is finished (or aborted) to return. We will poll the RunDeck
|
|
server at regular interval (configured by the poolingInterval/poolingUnit couple) to know if the execution is
|
|
finished (or aborted) or is still running. The script will be dispatched to nodes, accordingly to the nodeFilters
|
|
parameter.</p></div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Parameters</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th>project</td>
|
|
<td>name of the project - mandatory</td>
|
|
</tr>
|
|
<tr>
|
|
<th>scriptFilename</td>
|
|
<td>filename of the script to be executed - mandatory</td>
|
|
</tr>
|
|
<tr>
|
|
<th>options</td>
|
|
<td>of the script - optional. See <code><a href="../../../org/rundeck/api/OptionsBuilder.html">OptionsBuilder</a></code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<th>nodeFilters</td>
|
|
<td>for selecting nodes on which the script will be executed. See <code><a href="../../../org/rundeck/api/NodeFiltersBuilder.html">NodeFiltersBuilder</a></code></td>
|
|
</tr>
|
|
<tr>
|
|
<th>poolingInterval</td>
|
|
<td>for checking the status of the execution. Must be > 0.</td>
|
|
</tr>
|
|
<tr>
|
|
<th>poolingUnit</td>
|
|
<td>unit (seconds, milli-seconds, ...) of the interval. Default to seconds.</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Returns</h5>
|
|
<ul class="nolist"><li>a <code><a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a></code> instance for the (finished/aborted) execution - won't be null</li></ul>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Throws</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.html">RundeckApiException</a></td>
|
|
<td>in case of error when calling the API (non-existent project with this name)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html">RundeckApiException.RundeckApiLoginException</a></td>
|
|
<td>if the login fails (in case of login-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiTokenException.html">RundeckApiException.RundeckApiTokenException</a></td>
|
|
<td>if the token is invalid (in case of token-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/IllegalArgumentException.html">IllegalArgumentException</a></td>
|
|
<td>if the project or scriptFilename is blank (null, empty or whitespace)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/io/IOException.html">IOException</a></td>
|
|
<td>if we failed to read the file</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">See Also</h5>
|
|
<ul class="nolist"><li><code><a href="../../../org/rundeck/api/RundeckClient.html#runAdhocScript(java.lang.String, java.lang.String, java.util.Properties, java.util.Properties, java.lang.Integer, java.lang.Boolean, long, java.util.concurrent.TimeUnit)">runAdhocScript(String, String, Properties, Properties, Integer, Boolean, long, TimeUnit)</a></code></li><li><code><a href="../../../org/rundeck/api/RundeckClient.html#triggerAdhocScript(java.lang.String, java.lang.String, java.util.Properties, java.util.Properties)">triggerAdhocScript(String, String, Properties, Properties)</a></code></li>
|
|
</ul>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<A NAME="runAdhocScript(java.lang.String, java.lang.String, java.util.Properties, long, java.util.concurrent.TimeUnit)"></A>
|
|
|
|
<div class="jd-details api apilevel-">
|
|
<h4 class="jd-details-title">
|
|
<span class="normal">
|
|
public
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a>
|
|
</span>
|
|
<span class="sympad">runAdhocScript</span>
|
|
<span class="normal">(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> project, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> scriptFilename, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/Properties.html">Properties</a> options, long poolingInterval, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/concurrent/TimeUnit.html">TimeUnit</a> poolingUnit)</span>
|
|
</h4>
|
|
<div class="api-level">
|
|
<div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<div class="jd-details-descr">
|
|
|
|
<div class="jd-tagdata jd-tagdescr"><p>Run an ad-hoc script, and wait until its execution is finished (or aborted) to return. We will poll the RunDeck
|
|
server at regular interval (configured by the poolingInterval/poolingUnit couple) to know if the execution is
|
|
finished (or aborted) or is still running. The script will not be dispatched to nodes, but be executed on the
|
|
RunDeck server.</p></div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Parameters</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th>project</td>
|
|
<td>name of the project - mandatory</td>
|
|
</tr>
|
|
<tr>
|
|
<th>scriptFilename</td>
|
|
<td>filename of the script to be executed - mandatory</td>
|
|
</tr>
|
|
<tr>
|
|
<th>options</td>
|
|
<td>of the script - optional. See <code><a href="../../../org/rundeck/api/OptionsBuilder.html">OptionsBuilder</a></code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<th>poolingInterval</td>
|
|
<td>for checking the status of the execution. Must be > 0.</td>
|
|
</tr>
|
|
<tr>
|
|
<th>poolingUnit</td>
|
|
<td>unit (seconds, milli-seconds, ...) of the interval. Default to seconds.</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Returns</h5>
|
|
<ul class="nolist"><li>a <code><a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a></code> instance for the (finished/aborted) execution - won't be null</li></ul>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Throws</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.html">RundeckApiException</a></td>
|
|
<td>in case of error when calling the API (non-existent project with this name)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html">RundeckApiException.RundeckApiLoginException</a></td>
|
|
<td>if the login fails (in case of login-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiTokenException.html">RundeckApiException.RundeckApiTokenException</a></td>
|
|
<td>if the token is invalid (in case of token-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/IllegalArgumentException.html">IllegalArgumentException</a></td>
|
|
<td>if the project or scriptFilename is blank (null, empty or whitespace)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/io/IOException.html">IOException</a></td>
|
|
<td>if we failed to read the file</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">See Also</h5>
|
|
<ul class="nolist"><li><code><a href="../../../org/rundeck/api/RundeckClient.html#runAdhocScript(java.lang.String, java.lang.String, java.util.Properties, java.util.Properties, java.lang.Integer, java.lang.Boolean, long, java.util.concurrent.TimeUnit)">runAdhocScript(String, String, Properties, Properties, Integer, Boolean, long, TimeUnit)</a></code></li><li><code><a href="../../../org/rundeck/api/RundeckClient.html#triggerAdhocScript(java.lang.String, java.lang.String, java.util.Properties)">triggerAdhocScript(String, String, Properties)</a></code></li>
|
|
</ul>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<A NAME="runAdhocScript(java.lang.String, java.lang.String, long, java.util.concurrent.TimeUnit)"></A>
|
|
|
|
<div class="jd-details api apilevel-">
|
|
<h4 class="jd-details-title">
|
|
<span class="normal">
|
|
public
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a>
|
|
</span>
|
|
<span class="sympad">runAdhocScript</span>
|
|
<span class="normal">(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> project, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> scriptFilename, long poolingInterval, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/concurrent/TimeUnit.html">TimeUnit</a> poolingUnit)</span>
|
|
</h4>
|
|
<div class="api-level">
|
|
<div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<div class="jd-details-descr">
|
|
|
|
<div class="jd-tagdata jd-tagdescr"><p>Run an ad-hoc script, and wait until its execution is finished (or aborted) to return. We will poll the RunDeck
|
|
server at regular interval (configured by the poolingInterval/poolingUnit couple) to know if the execution is
|
|
finished (or aborted) or is still running. The script will not be dispatched to nodes, but be executed on the
|
|
RunDeck server.</p></div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Parameters</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th>project</td>
|
|
<td>name of the project - mandatory</td>
|
|
</tr>
|
|
<tr>
|
|
<th>scriptFilename</td>
|
|
<td>filename of the script to be executed - mandatory</td>
|
|
</tr>
|
|
<tr>
|
|
<th>poolingInterval</td>
|
|
<td>for checking the status of the execution. Must be > 0.</td>
|
|
</tr>
|
|
<tr>
|
|
<th>poolingUnit</td>
|
|
<td>unit (seconds, milli-seconds, ...) of the interval. Default to seconds.</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Returns</h5>
|
|
<ul class="nolist"><li>a <code><a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a></code> instance for the (finished/aborted) execution - won't be null</li></ul>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Throws</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.html">RundeckApiException</a></td>
|
|
<td>in case of error when calling the API (non-existent project with this name)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html">RundeckApiException.RundeckApiLoginException</a></td>
|
|
<td>if the login fails (in case of login-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiTokenException.html">RundeckApiException.RundeckApiTokenException</a></td>
|
|
<td>if the token is invalid (in case of token-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/IllegalArgumentException.html">IllegalArgumentException</a></td>
|
|
<td>if the project or scriptFilename is blank (null, empty or whitespace)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/io/IOException.html">IOException</a></td>
|
|
<td>if we failed to read the file</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">See Also</h5>
|
|
<ul class="nolist"><li><code><a href="../../../org/rundeck/api/RundeckClient.html#runAdhocScript(java.lang.String, java.lang.String, java.util.Properties, java.util.Properties, java.lang.Integer, java.lang.Boolean, long, java.util.concurrent.TimeUnit)">runAdhocScript(String, String, Properties, Properties, Integer, Boolean, long, TimeUnit)</a></code></li><li><code><a href="../../../org/rundeck/api/RundeckClient.html#triggerAdhocScript(java.lang.String, java.lang.String)">triggerAdhocScript(String, String)</a></code></li>
|
|
</ul>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<A NAME="runJob(java.lang.String)"></A>
|
|
|
|
<div class="jd-details api apilevel-">
|
|
<h4 class="jd-details-title">
|
|
<span class="normal">
|
|
public
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a>
|
|
</span>
|
|
<span class="sympad">runJob</span>
|
|
<span class="normal">(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> jobId)</span>
|
|
</h4>
|
|
<div class="api-level">
|
|
<div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<div class="jd-details-descr">
|
|
|
|
<div class="jd-tagdata jd-tagdescr"><p>Run a RunDeck job (identified by the given ID), and wait until its execution is finished (or aborted) to return.
|
|
We will poll the RunDeck server at regular interval (every 5 seconds) to know if the execution is finished (or
|
|
aborted) or is still running.</p></div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Parameters</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th>jobId</td>
|
|
<td>identifier of the job - mandatory</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Returns</h5>
|
|
<ul class="nolist"><li>a <code><a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a></code> instance for the (finished/aborted) execution - won't be null</li></ul>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Throws</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.html">RundeckApiException</a></td>
|
|
<td>in case of error when calling the API (non-existent job with this ID)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html">RundeckApiException.RundeckApiLoginException</a></td>
|
|
<td>if the login fails (in case of login-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiTokenException.html">RundeckApiException.RundeckApiTokenException</a></td>
|
|
<td>if the token is invalid (in case of token-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/IllegalArgumentException.html">IllegalArgumentException</a></td>
|
|
<td>if the jobId is blank (null, empty or whitespace)</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">See Also</h5>
|
|
<ul class="nolist"><li><code><a href="../../../org/rundeck/api/RundeckClient.html#triggerJob(java.lang.String)">triggerJob(String)</a></code></li><li><code><a href="../../../org/rundeck/api/RundeckClient.html#runJob(java.lang.String, java.util.Properties, java.util.Properties, long, java.util.concurrent.TimeUnit)">runJob(String, Properties, Properties, long, TimeUnit)</a></code></li>
|
|
</ul>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<A NAME="runJob(java.lang.String, java.util.Properties)"></A>
|
|
|
|
<div class="jd-details api apilevel-">
|
|
<h4 class="jd-details-title">
|
|
<span class="normal">
|
|
public
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a>
|
|
</span>
|
|
<span class="sympad">runJob</span>
|
|
<span class="normal">(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> jobId, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/Properties.html">Properties</a> options)</span>
|
|
</h4>
|
|
<div class="api-level">
|
|
<div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<div class="jd-details-descr">
|
|
|
|
<div class="jd-tagdata jd-tagdescr"><p>Run a RunDeck job (identified by the given ID), and wait until its execution is finished (or aborted) to return.
|
|
We will poll the RunDeck server at regular interval (every 5 seconds) to know if the execution is finished (or
|
|
aborted) or is still running.</p></div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Parameters</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th>jobId</td>
|
|
<td>identifier of the job - mandatory</td>
|
|
</tr>
|
|
<tr>
|
|
<th>options</td>
|
|
<td>of the job - optional. See <code><a href="../../../org/rundeck/api/OptionsBuilder.html">OptionsBuilder</a></code>.</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Returns</h5>
|
|
<ul class="nolist"><li>a <code><a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a></code> instance for the (finished/aborted) execution - won't be null</li></ul>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Throws</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.html">RundeckApiException</a></td>
|
|
<td>in case of error when calling the API (non-existent job with this ID)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html">RundeckApiException.RundeckApiLoginException</a></td>
|
|
<td>if the login fails (in case of login-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiTokenException.html">RundeckApiException.RundeckApiTokenException</a></td>
|
|
<td>if the token is invalid (in case of token-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/IllegalArgumentException.html">IllegalArgumentException</a></td>
|
|
<td>if the jobId is blank (null, empty or whitespace)</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">See Also</h5>
|
|
<ul class="nolist"><li><code><a href="../../../org/rundeck/api/RundeckClient.html#triggerJob(java.lang.String, java.util.Properties)">triggerJob(String, Properties)</a></code></li><li><code><a href="../../../org/rundeck/api/RundeckClient.html#runJob(java.lang.String, java.util.Properties, java.util.Properties, long, java.util.concurrent.TimeUnit)">runJob(String, Properties, Properties, long, TimeUnit)</a></code></li>
|
|
</ul>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<A NAME="runJob(java.lang.String, java.util.Properties, java.util.Properties)"></A>
|
|
|
|
<div class="jd-details api apilevel-">
|
|
<h4 class="jd-details-title">
|
|
<span class="normal">
|
|
public
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a>
|
|
</span>
|
|
<span class="sympad">runJob</span>
|
|
<span class="normal">(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> jobId, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/Properties.html">Properties</a> options, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/Properties.html">Properties</a> nodeFilters)</span>
|
|
</h4>
|
|
<div class="api-level">
|
|
<div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<div class="jd-details-descr">
|
|
|
|
<div class="jd-tagdata jd-tagdescr"><p>Run a RunDeck job (identified by the given ID), and wait until its execution is finished (or aborted) to return.
|
|
We will poll the RunDeck server at regular interval (every 5 seconds) to know if the execution is finished (or
|
|
aborted) or is still running.</p></div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Parameters</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th>jobId</td>
|
|
<td>identifier of the job - mandatory</td>
|
|
</tr>
|
|
<tr>
|
|
<th>options</td>
|
|
<td>of the job - optional. See <code><a href="../../../org/rundeck/api/OptionsBuilder.html">OptionsBuilder</a></code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<th>nodeFilters</td>
|
|
<td>for overriding the nodes on which the job will be executed - optional. See
|
|
<code><a href="../../../org/rundeck/api/NodeFiltersBuilder.html">NodeFiltersBuilder</a></code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Returns</h5>
|
|
<ul class="nolist"><li>a <code><a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a></code> instance for the (finished/aborted) execution - won't be null</li></ul>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Throws</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.html">RundeckApiException</a></td>
|
|
<td>in case of error when calling the API (non-existent job with this ID)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html">RundeckApiException.RundeckApiLoginException</a></td>
|
|
<td>if the login fails (in case of login-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiTokenException.html">RundeckApiException.RundeckApiTokenException</a></td>
|
|
<td>if the token is invalid (in case of token-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/IllegalArgumentException.html">IllegalArgumentException</a></td>
|
|
<td>if the jobId is blank (null, empty or whitespace)</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">See Also</h5>
|
|
<ul class="nolist"><li><code><a href="../../../org/rundeck/api/RundeckClient.html#triggerJob(java.lang.String, java.util.Properties, java.util.Properties)">triggerJob(String, Properties, Properties)</a></code></li><li><code><a href="../../../org/rundeck/api/RundeckClient.html#runJob(java.lang.String, java.util.Properties, java.util.Properties, long, java.util.concurrent.TimeUnit)">runJob(String, Properties, Properties, long, TimeUnit)</a></code></li>
|
|
</ul>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<A NAME="runJob(java.lang.String, java.util.Properties, java.util.Properties, long, java.util.concurrent.TimeUnit)"></A>
|
|
|
|
<div class="jd-details api apilevel-">
|
|
<h4 class="jd-details-title">
|
|
<span class="normal">
|
|
public
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a>
|
|
</span>
|
|
<span class="sympad">runJob</span>
|
|
<span class="normal">(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> jobId, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/Properties.html">Properties</a> options, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/Properties.html">Properties</a> nodeFilters, long poolingInterval, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/concurrent/TimeUnit.html">TimeUnit</a> poolingUnit)</span>
|
|
</h4>
|
|
<div class="api-level">
|
|
<div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<div class="jd-details-descr">
|
|
|
|
<div class="jd-tagdata jd-tagdescr"><p>Run a RunDeck job (identified by the given ID), and wait until its execution is finished (or aborted) to return.
|
|
We will poll the RunDeck server at regular interval (configured by the poolingInterval/poolingUnit couple) to
|
|
know if the execution is finished (or aborted) or is still running.</p></div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Parameters</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th>jobId</td>
|
|
<td>identifier of the job - mandatory</td>
|
|
</tr>
|
|
<tr>
|
|
<th>options</td>
|
|
<td>of the job - optional. See <code><a href="../../../org/rundeck/api/OptionsBuilder.html">OptionsBuilder</a></code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<th>nodeFilters</td>
|
|
<td>for overriding the nodes on which the job will be executed - optional. See
|
|
<code><a href="../../../org/rundeck/api/NodeFiltersBuilder.html">NodeFiltersBuilder</a></code></td>
|
|
</tr>
|
|
<tr>
|
|
<th>poolingInterval</td>
|
|
<td>for checking the status of the execution. Must be > 0.</td>
|
|
</tr>
|
|
<tr>
|
|
<th>poolingUnit</td>
|
|
<td>unit (seconds, milli-seconds, ...) of the interval. Default to seconds.</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Returns</h5>
|
|
<ul class="nolist"><li>a <code><a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a></code> instance for the (finished/aborted) execution - won't be null</li></ul>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Throws</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.html">RundeckApiException</a></td>
|
|
<td>in case of error when calling the API (non-existent job with this ID)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html">RundeckApiException.RundeckApiLoginException</a></td>
|
|
<td>if the login fails (in case of login-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiTokenException.html">RundeckApiException.RundeckApiTokenException</a></td>
|
|
<td>if the token is invalid (in case of token-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/IllegalArgumentException.html">IllegalArgumentException</a></td>
|
|
<td>if the jobId is blank (null, empty or whitespace)</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">See Also</h5>
|
|
<ul class="nolist"><li><code><a href="../../../org/rundeck/api/RundeckClient.html#triggerJob(java.lang.String, java.util.Properties)">triggerJob(String, Properties)</a></code></li><li><code><a href="../../../org/rundeck/api/RundeckClient.html#runJob(java.lang.String, java.util.Properties, java.util.Properties, long, java.util.concurrent.TimeUnit)">runJob(String, Properties, Properties, long, TimeUnit)</a></code></li>
|
|
</ul>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<A NAME="runJob(java.lang.String, java.util.Properties, long, java.util.concurrent.TimeUnit)"></A>
|
|
|
|
<div class="jd-details api apilevel-">
|
|
<h4 class="jd-details-title">
|
|
<span class="normal">
|
|
public
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a>
|
|
</span>
|
|
<span class="sympad">runJob</span>
|
|
<span class="normal">(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> jobId, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/Properties.html">Properties</a> options, long poolingInterval, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/concurrent/TimeUnit.html">TimeUnit</a> poolingUnit)</span>
|
|
</h4>
|
|
<div class="api-level">
|
|
<div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<div class="jd-details-descr">
|
|
|
|
<div class="jd-tagdata jd-tagdescr"><p>Run a RunDeck job (identified by the given ID), and wait until its execution is finished (or aborted) to return.
|
|
We will poll the RunDeck server at regular interval (configured by the poolingInterval/poolingUnit couple) to
|
|
know if the execution is finished (or aborted) or is still running.</p></div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Parameters</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th>jobId</td>
|
|
<td>identifier of the job - mandatory</td>
|
|
</tr>
|
|
<tr>
|
|
<th>options</td>
|
|
<td>of the job - optional. See <code><a href="../../../org/rundeck/api/OptionsBuilder.html">OptionsBuilder</a></code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<th>poolingInterval</td>
|
|
<td>for checking the status of the execution. Must be > 0.</td>
|
|
</tr>
|
|
<tr>
|
|
<th>poolingUnit</td>
|
|
<td>unit (seconds, milli-seconds, ...) of the interval. Default to seconds.</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Returns</h5>
|
|
<ul class="nolist"><li>a <code><a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a></code> instance for the (finished/aborted) execution - won't be null</li></ul>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Throws</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.html">RundeckApiException</a></td>
|
|
<td>in case of error when calling the API (non-existent job with this ID)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html">RundeckApiException.RundeckApiLoginException</a></td>
|
|
<td>if the login fails (in case of login-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiTokenException.html">RundeckApiException.RundeckApiTokenException</a></td>
|
|
<td>if the token is invalid (in case of token-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/IllegalArgumentException.html">IllegalArgumentException</a></td>
|
|
<td>if the jobId is blank (null, empty or whitespace)</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">See Also</h5>
|
|
<ul class="nolist"><li><code><a href="../../../org/rundeck/api/RundeckClient.html#triggerJob(java.lang.String, java.util.Properties)">triggerJob(String, Properties)</a></code></li><li><code><a href="../../../org/rundeck/api/RundeckClient.html#runJob(java.lang.String, java.util.Properties, java.util.Properties, long, java.util.concurrent.TimeUnit)">runJob(String, Properties, Properties, long, TimeUnit)</a></code></li>
|
|
</ul>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<A NAME="testAuth()"></A>
|
|
|
|
<div class="jd-details api apilevel-">
|
|
<h4 class="jd-details-title">
|
|
<span class="normal">
|
|
public
|
|
|
|
|
|
|
|
|
|
void
|
|
</span>
|
|
<span class="sympad">testAuth</span>
|
|
<span class="normal">()</span>
|
|
</h4>
|
|
<div class="api-level">
|
|
<div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<div class="jd-details-descr">
|
|
|
|
<div class="jd-tagdata jd-tagdescr"><p>Test the authentication on the RunDeck instance.</p></div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Throws</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html">RundeckApiException.RundeckApiLoginException</a></td>
|
|
<td>if the login fails (in case of login-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiTokenException.html">RundeckApiException.RundeckApiTokenException</a></td>
|
|
<td>if the token is invalid (in case of token-based authentication)
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<A NAME="testCredentials()"></A>
|
|
|
|
<div class="jd-details api apilevel-">
|
|
<h4 class="jd-details-title">
|
|
<span class="normal">
|
|
public
|
|
|
|
|
|
|
|
|
|
void
|
|
</span>
|
|
<span class="sympad">testCredentials</span>
|
|
<span class="normal">()</span>
|
|
</h4>
|
|
<div class="api-level">
|
|
<div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<div class="jd-details-descr">
|
|
<p>
|
|
<p class="caution">
|
|
<strong>
|
|
This method is deprecated.</strong><br/> Use <code><a href="../../../org/rundeck/api/RundeckClient.html#testAuth()">testAuth()</a></code>
|
|
</p>
|
|
<div class="jd-tagdata jd-tagdescr"><p></p></div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Throws</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html">RundeckApiException.RundeckApiLoginException</a></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiTokenException.html">RundeckApiException.RundeckApiTokenException</a></td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">See Also</h5>
|
|
<ul class="nolist"><li><code><a href="../../../org/rundeck/api/RundeckClient.html#testAuth()">testAuth()</a></code></li>
|
|
</ul>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<A NAME="toString()"></A>
|
|
|
|
<div class="jd-details api apilevel-">
|
|
<h4 class="jd-details-title">
|
|
<span class="normal">
|
|
public
|
|
|
|
|
|
|
|
|
|
<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a>
|
|
</span>
|
|
<span class="sympad">toString</span>
|
|
<span class="normal">()</span>
|
|
</h4>
|
|
<div class="api-level">
|
|
<div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<div class="jd-details-descr">
|
|
|
|
<div class="jd-tagdata jd-tagdescr"><p></p></div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<A NAME="triggerAdhocCommand(java.lang.String, java.lang.String)"></A>
|
|
|
|
<div class="jd-details api apilevel-">
|
|
<h4 class="jd-details-title">
|
|
<span class="normal">
|
|
public
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a>
|
|
</span>
|
|
<span class="sympad">triggerAdhocCommand</span>
|
|
<span class="normal">(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> project, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> command)</span>
|
|
</h4>
|
|
<div class="api-level">
|
|
<div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<div class="jd-details-descr">
|
|
|
|
<div class="jd-tagdata jd-tagdescr"><p>Trigger the execution of an ad-hoc command, and return immediately (without waiting the end of the execution).
|
|
The command will not be dispatched to nodes, but be executed on the RunDeck server.</p></div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Parameters</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th>project</td>
|
|
<td>name of the project - mandatory</td>
|
|
</tr>
|
|
<tr>
|
|
<th>command</td>
|
|
<td>to be executed - mandatory</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Returns</h5>
|
|
<ul class="nolist"><li>a <code><a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a></code> instance for the newly created (and running) execution - won't be null</li></ul>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Throws</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.html">RundeckApiException</a></td>
|
|
<td>in case of error when calling the API (non-existent project with this name)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html">RundeckApiException.RundeckApiLoginException</a></td>
|
|
<td>if the login fails (in case of login-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiTokenException.html">RundeckApiException.RundeckApiTokenException</a></td>
|
|
<td>if the token is invalid (in case of token-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/IllegalArgumentException.html">IllegalArgumentException</a></td>
|
|
<td>if the project or command is blank (null, empty or whitespace)</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">See Also</h5>
|
|
<ul class="nolist"><li><code><a href="../../../org/rundeck/api/RundeckClient.html#triggerAdhocCommand(java.lang.String, java.lang.String, java.util.Properties, java.lang.Integer, java.lang.Boolean)">triggerAdhocCommand(String, String, Properties, Integer, Boolean)</a></code></li><li><code><a href="../../../org/rundeck/api/RundeckClient.html#runAdhocCommand(java.lang.String, java.lang.String)">runAdhocCommand(String, String)</a></code></li>
|
|
</ul>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<A NAME="triggerAdhocCommand(java.lang.String, java.lang.String, java.util.Properties)"></A>
|
|
|
|
<div class="jd-details api apilevel-">
|
|
<h4 class="jd-details-title">
|
|
<span class="normal">
|
|
public
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a>
|
|
</span>
|
|
<span class="sympad">triggerAdhocCommand</span>
|
|
<span class="normal">(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> project, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> command, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/Properties.html">Properties</a> nodeFilters)</span>
|
|
</h4>
|
|
<div class="api-level">
|
|
<div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<div class="jd-details-descr">
|
|
|
|
<div class="jd-tagdata jd-tagdescr"><p>Trigger the execution of an ad-hoc command, and return immediately (without waiting the end of the execution).
|
|
The command will be dispatched to nodes, accordingly to the nodeFilters parameter.</p></div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Parameters</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th>project</td>
|
|
<td>name of the project - mandatory</td>
|
|
</tr>
|
|
<tr>
|
|
<th>command</td>
|
|
<td>to be executed - mandatory</td>
|
|
</tr>
|
|
<tr>
|
|
<th>nodeFilters</td>
|
|
<td>for selecting nodes on which the command will be executed. See <code><a href="../../../org/rundeck/api/NodeFiltersBuilder.html">NodeFiltersBuilder</a></code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Returns</h5>
|
|
<ul class="nolist"><li>a <code><a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a></code> instance for the newly created (and running) execution - won't be null</li></ul>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Throws</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.html">RundeckApiException</a></td>
|
|
<td>in case of error when calling the API (non-existent project with this name)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html">RundeckApiException.RundeckApiLoginException</a></td>
|
|
<td>if the login fails (in case of login-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiTokenException.html">RundeckApiException.RundeckApiTokenException</a></td>
|
|
<td>if the token is invalid (in case of token-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/IllegalArgumentException.html">IllegalArgumentException</a></td>
|
|
<td>if the project or command is blank (null, empty or whitespace)</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">See Also</h5>
|
|
<ul class="nolist"><li><code><a href="../../../org/rundeck/api/RundeckClient.html#triggerAdhocCommand(java.lang.String, java.lang.String, java.util.Properties, java.lang.Integer, java.lang.Boolean)">triggerAdhocCommand(String, String, Properties, Integer, Boolean)</a></code></li><li><code><a href="../../../org/rundeck/api/RundeckClient.html#runAdhocCommand(java.lang.String, java.lang.String, java.util.Properties)">runAdhocCommand(String, String, Properties)</a></code></li>
|
|
</ul>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<A NAME="triggerAdhocCommand(java.lang.String, java.lang.String, java.util.Properties, java.lang.Integer, java.lang.Boolean)"></A>
|
|
|
|
<div class="jd-details api apilevel-">
|
|
<h4 class="jd-details-title">
|
|
<span class="normal">
|
|
public
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a>
|
|
</span>
|
|
<span class="sympad">triggerAdhocCommand</span>
|
|
<span class="normal">(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> project, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> command, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/Properties.html">Properties</a> nodeFilters, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/Integer.html">Integer</a> nodeThreadcount, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/Boolean.html">Boolean</a> nodeKeepgoing)</span>
|
|
</h4>
|
|
<div class="api-level">
|
|
<div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<div class="jd-details-descr">
|
|
|
|
<div class="jd-tagdata jd-tagdescr"><p>Trigger the execution of an ad-hoc command, and return immediately (without waiting the end of the execution).
|
|
The command will be dispatched to nodes, accordingly to the nodeFilters parameter.</p></div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Parameters</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th>project</td>
|
|
<td>name of the project - mandatory</td>
|
|
</tr>
|
|
<tr>
|
|
<th>command</td>
|
|
<td>to be executed - mandatory</td>
|
|
</tr>
|
|
<tr>
|
|
<th>nodeFilters</td>
|
|
<td>for selecting nodes on which the command will be executed. See <code><a href="../../../org/rundeck/api/NodeFiltersBuilder.html">NodeFiltersBuilder</a></code></td>
|
|
</tr>
|
|
<tr>
|
|
<th>nodeThreadcount</td>
|
|
<td>thread count to use (for parallelizing when running on multiple nodes) - optional</td>
|
|
</tr>
|
|
<tr>
|
|
<th>nodeKeepgoing</td>
|
|
<td>if true, continue executing on other nodes even if some fail - optional</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Returns</h5>
|
|
<ul class="nolist"><li>a <code><a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a></code> instance for the newly created (and running) execution - won't be null</li></ul>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Throws</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.html">RundeckApiException</a></td>
|
|
<td>in case of error when calling the API (non-existent project with this name)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html">RundeckApiException.RundeckApiLoginException</a></td>
|
|
<td>if the login fails (in case of login-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiTokenException.html">RundeckApiException.RundeckApiTokenException</a></td>
|
|
<td>if the token is invalid (in case of token-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/IllegalArgumentException.html">IllegalArgumentException</a></td>
|
|
<td>if the project or command is blank (null, empty or whitespace)</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">See Also</h5>
|
|
<ul class="nolist"><li><code><a href="../../../org/rundeck/api/RundeckClient.html#triggerAdhocCommand(java.lang.String, java.lang.String)">triggerAdhocCommand(String, String)</a></code></li><li><code><a href="../../../org/rundeck/api/RundeckClient.html#runAdhocCommand(java.lang.String, java.lang.String, java.util.Properties)">runAdhocCommand(String, String, Properties)</a></code></li>
|
|
</ul>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<A NAME="triggerAdhocScript(java.lang.String, java.io.InputStream)"></A>
|
|
|
|
<div class="jd-details api apilevel-">
|
|
<h4 class="jd-details-title">
|
|
<span class="normal">
|
|
public
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a>
|
|
</span>
|
|
<span class="sympad">triggerAdhocScript</span>
|
|
<span class="normal">(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> project, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/io/InputStream.html">InputStream</a> script)</span>
|
|
</h4>
|
|
<div class="api-level">
|
|
<div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<div class="jd-details-descr">
|
|
|
|
<div class="jd-tagdata jd-tagdescr"><p>Trigger the execution of an ad-hoc script, and return immediately (without waiting the end of the execution). The
|
|
script will not be dispatched to nodes, but be executed on the RunDeck server.</p></div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Parameters</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th>project</td>
|
|
<td>name of the project - mandatory</td>
|
|
</tr>
|
|
<tr>
|
|
<th>script</td>
|
|
<td>inputStream for reading the script to be executed - mandatory</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Returns</h5>
|
|
<ul class="nolist"><li>a <code><a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a></code> instance for the newly created (and running) execution - won't be null</li></ul>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Throws</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.html">RundeckApiException</a></td>
|
|
<td>in case of error when calling the API (non-existent project with this name)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html">RundeckApiException.RundeckApiLoginException</a></td>
|
|
<td>if the login fails (in case of login-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiTokenException.html">RundeckApiException.RundeckApiTokenException</a></td>
|
|
<td>if the token is invalid (in case of token-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/IllegalArgumentException.html">IllegalArgumentException</a></td>
|
|
<td>if the project is blank (null, empty or whitespace) or the script is null</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">See Also</h5>
|
|
<ul class="nolist"><li><code><a href="../../../org/rundeck/api/RundeckClient.html#triggerAdhocScript(java.lang.String, java.io.InputStream, java.util.Properties, java.util.Properties, java.lang.Integer, java.lang.Boolean)">triggerAdhocScript(String, InputStream, Properties, Properties, Integer, Boolean)</a></code></li><li><code><a href="../../../org/rundeck/api/RundeckClient.html#runAdhocScript(java.lang.String, java.io.InputStream)">runAdhocScript(String, InputStream)</a></code></li>
|
|
</ul>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<A NAME="triggerAdhocScript(java.lang.String, java.io.InputStream, java.util.Properties)"></A>
|
|
|
|
<div class="jd-details api apilevel-">
|
|
<h4 class="jd-details-title">
|
|
<span class="normal">
|
|
public
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a>
|
|
</span>
|
|
<span class="sympad">triggerAdhocScript</span>
|
|
<span class="normal">(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> project, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/io/InputStream.html">InputStream</a> script, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/Properties.html">Properties</a> options)</span>
|
|
</h4>
|
|
<div class="api-level">
|
|
<div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<div class="jd-details-descr">
|
|
|
|
<div class="jd-tagdata jd-tagdescr"><p>Trigger the execution of an ad-hoc script, and return immediately (without waiting the end of the execution). The
|
|
script will not be dispatched to nodes, but be executed on the RunDeck server.</p></div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Parameters</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th>project</td>
|
|
<td>name of the project - mandatory</td>
|
|
</tr>
|
|
<tr>
|
|
<th>script</td>
|
|
<td>inputStream for reading the script to be executed - mandatory</td>
|
|
</tr>
|
|
<tr>
|
|
<th>options</td>
|
|
<td>of the script - optional. See <code><a href="../../../org/rundeck/api/OptionsBuilder.html">OptionsBuilder</a></code>.</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Returns</h5>
|
|
<ul class="nolist"><li>a <code><a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a></code> instance for the newly created (and running) execution - won't be null</li></ul>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Throws</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.html">RundeckApiException</a></td>
|
|
<td>in case of error when calling the API (non-existent project with this name)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html">RundeckApiException.RundeckApiLoginException</a></td>
|
|
<td>if the login fails (in case of login-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiTokenException.html">RundeckApiException.RundeckApiTokenException</a></td>
|
|
<td>if the token is invalid (in case of token-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/IllegalArgumentException.html">IllegalArgumentException</a></td>
|
|
<td>if the project is blank (null, empty or whitespace) or the script is null</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">See Also</h5>
|
|
<ul class="nolist"><li><code><a href="../../../org/rundeck/api/RundeckClient.html#triggerAdhocScript(java.lang.String, java.io.InputStream, java.util.Properties, java.util.Properties, java.lang.Integer, java.lang.Boolean)">triggerAdhocScript(String, InputStream, Properties, Properties, Integer, Boolean)</a></code></li><li><code><a href="../../../org/rundeck/api/RundeckClient.html#runAdhocScript(java.lang.String, java.io.InputStream, java.util.Properties)">runAdhocScript(String, InputStream, Properties)</a></code></li>
|
|
</ul>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<A NAME="triggerAdhocScript(java.lang.String, java.io.InputStream, java.util.Properties, java.util.Properties)"></A>
|
|
|
|
<div class="jd-details api apilevel-">
|
|
<h4 class="jd-details-title">
|
|
<span class="normal">
|
|
public
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a>
|
|
</span>
|
|
<span class="sympad">triggerAdhocScript</span>
|
|
<span class="normal">(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> project, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/io/InputStream.html">InputStream</a> script, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/Properties.html">Properties</a> options, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/Properties.html">Properties</a> nodeFilters)</span>
|
|
</h4>
|
|
<div class="api-level">
|
|
<div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<div class="jd-details-descr">
|
|
|
|
<div class="jd-tagdata jd-tagdescr"><p>Trigger the execution of an ad-hoc script, and return immediately (without waiting the end of the execution). The
|
|
script will be dispatched to nodes, accordingly to the nodeFilters parameter.</p></div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Parameters</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th>project</td>
|
|
<td>name of the project - mandatory</td>
|
|
</tr>
|
|
<tr>
|
|
<th>script</td>
|
|
<td>inputStream for reading the script to be executed - mandatory</td>
|
|
</tr>
|
|
<tr>
|
|
<th>options</td>
|
|
<td>of the script - optional. See <code><a href="../../../org/rundeck/api/OptionsBuilder.html">OptionsBuilder</a></code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<th>nodeFilters</td>
|
|
<td>for selecting nodes on which the command will be executed. See <code><a href="../../../org/rundeck/api/NodeFiltersBuilder.html">NodeFiltersBuilder</a></code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Returns</h5>
|
|
<ul class="nolist"><li>a <code><a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a></code> instance for the newly created (and running) execution - won't be null</li></ul>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Throws</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.html">RundeckApiException</a></td>
|
|
<td>in case of error when calling the API (non-existent project with this name)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html">RundeckApiException.RundeckApiLoginException</a></td>
|
|
<td>if the login fails (in case of login-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiTokenException.html">RundeckApiException.RundeckApiTokenException</a></td>
|
|
<td>if the token is invalid (in case of token-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/IllegalArgumentException.html">IllegalArgumentException</a></td>
|
|
<td>if the project is blank (null, empty or whitespace) or the script is null</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">See Also</h5>
|
|
<ul class="nolist"><li><code><a href="../../../org/rundeck/api/RundeckClient.html#triggerAdhocScript(java.lang.String, java.io.InputStream, java.util.Properties, java.util.Properties, java.lang.Integer, java.lang.Boolean)">triggerAdhocScript(String, InputStream, Properties, Properties, Integer, Boolean)</a></code></li><li><code><a href="../../../org/rundeck/api/RundeckClient.html#runAdhocScript(java.lang.String, java.io.InputStream, java.util.Properties, java.util.Properties)">runAdhocScript(String, InputStream, Properties, Properties)</a></code></li>
|
|
</ul>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<A NAME="triggerAdhocScript(java.lang.String, java.io.InputStream, java.util.Properties, java.util.Properties, java.lang.Integer, java.lang.Boolean)"></A>
|
|
|
|
<div class="jd-details api apilevel-">
|
|
<h4 class="jd-details-title">
|
|
<span class="normal">
|
|
public
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a>
|
|
</span>
|
|
<span class="sympad">triggerAdhocScript</span>
|
|
<span class="normal">(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> project, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/io/InputStream.html">InputStream</a> script, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/Properties.html">Properties</a> options, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/Properties.html">Properties</a> nodeFilters, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/Integer.html">Integer</a> nodeThreadcount, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/Boolean.html">Boolean</a> nodeKeepgoing)</span>
|
|
</h4>
|
|
<div class="api-level">
|
|
<div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<div class="jd-details-descr">
|
|
|
|
<div class="jd-tagdata jd-tagdescr"><p>Trigger the execution of an ad-hoc script, and return immediately (without waiting the end of the execution). The
|
|
script will be dispatched to nodes, accordingly to the nodeFilters parameter.</p></div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Parameters</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th>project</td>
|
|
<td>name of the project - mandatory</td>
|
|
</tr>
|
|
<tr>
|
|
<th>script</td>
|
|
<td>inputStream for reading the script to be executed - mandatory</td>
|
|
</tr>
|
|
<tr>
|
|
<th>options</td>
|
|
<td>of the script - optional. See <code><a href="../../../org/rundeck/api/OptionsBuilder.html">OptionsBuilder</a></code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<th>nodeFilters</td>
|
|
<td>for selecting nodes on which the command will be executed. See <code><a href="../../../org/rundeck/api/NodeFiltersBuilder.html">NodeFiltersBuilder</a></code></td>
|
|
</tr>
|
|
<tr>
|
|
<th>nodeThreadcount</td>
|
|
<td>thread count to use (for parallelizing when running on multiple nodes) - optional</td>
|
|
</tr>
|
|
<tr>
|
|
<th>nodeKeepgoing</td>
|
|
<td>if true, continue executing on other nodes even if some fail - optional</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Returns</h5>
|
|
<ul class="nolist"><li>a <code><a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a></code> instance for the newly created (and running) execution - won't be null</li></ul>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Throws</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.html">RundeckApiException</a></td>
|
|
<td>in case of error when calling the API (non-existent project with this name)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html">RundeckApiException.RundeckApiLoginException</a></td>
|
|
<td>if the login fails (in case of login-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiTokenException.html">RundeckApiException.RundeckApiTokenException</a></td>
|
|
<td>if the token is invalid (in case of token-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/IllegalArgumentException.html">IllegalArgumentException</a></td>
|
|
<td>if the project is blank (null, empty or whitespace) or the script is null</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">See Also</h5>
|
|
<ul class="nolist"><li><code><a href="../../../org/rundeck/api/RundeckClient.html#triggerAdhocScript(java.lang.String, java.lang.String, java.util.Properties, java.util.Properties, java.lang.Integer, java.lang.Boolean)">triggerAdhocScript(String, String, Properties, Properties, Integer, Boolean)</a></code></li><li><code><a href="../../../org/rundeck/api/RundeckClient.html#runAdhocScript(java.lang.String, java.io.InputStream, java.util.Properties, java.util.Properties, java.lang.Integer, java.lang.Boolean, long, java.util.concurrent.TimeUnit)">runAdhocScript(String, InputStream, Properties, Properties, Integer, Boolean, long, TimeUnit)</a></code></li>
|
|
</ul>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<A NAME="triggerAdhocScript(java.lang.String, java.lang.String)"></A>
|
|
|
|
<div class="jd-details api apilevel-">
|
|
<h4 class="jd-details-title">
|
|
<span class="normal">
|
|
public
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a>
|
|
</span>
|
|
<span class="sympad">triggerAdhocScript</span>
|
|
<span class="normal">(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> project, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> scriptFilename)</span>
|
|
</h4>
|
|
<div class="api-level">
|
|
<div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<div class="jd-details-descr">
|
|
|
|
<div class="jd-tagdata jd-tagdescr"><p>Trigger the execution of an ad-hoc script, and return immediately (without waiting the end of the execution). The
|
|
script will not be dispatched to nodes, but be executed on the RunDeck server.</p></div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Parameters</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th>project</td>
|
|
<td>name of the project - mandatory</td>
|
|
</tr>
|
|
<tr>
|
|
<th>scriptFilename</td>
|
|
<td>filename of the script to be executed - mandatory</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Returns</h5>
|
|
<ul class="nolist"><li>a <code><a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a></code> instance for the newly created (and running) execution - won't be null</li></ul>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Throws</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.html">RundeckApiException</a></td>
|
|
<td>in case of error when calling the API (non-existent project with this name)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html">RundeckApiException.RundeckApiLoginException</a></td>
|
|
<td>if the login fails (in case of login-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiTokenException.html">RundeckApiException.RundeckApiTokenException</a></td>
|
|
<td>if the token is invalid (in case of token-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/IllegalArgumentException.html">IllegalArgumentException</a></td>
|
|
<td>if the project or scriptFilename is blank (null, empty or whitespace)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/io/IOException.html">IOException</a></td>
|
|
<td>if we failed to read the file</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">See Also</h5>
|
|
<ul class="nolist"><li><code><a href="../../../org/rundeck/api/RundeckClient.html#triggerAdhocScript(java.lang.String, java.lang.String, java.util.Properties, java.util.Properties, java.lang.Integer, java.lang.Boolean)">triggerAdhocScript(String, String, Properties, Properties, Integer, Boolean)</a></code></li><li><code><a href="../../../org/rundeck/api/RundeckClient.html#runAdhocScript(java.lang.String, java.lang.String)">runAdhocScript(String, String)</a></code></li>
|
|
</ul>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<A NAME="triggerAdhocScript(java.lang.String, java.lang.String, java.util.Properties)"></A>
|
|
|
|
<div class="jd-details api apilevel-">
|
|
<h4 class="jd-details-title">
|
|
<span class="normal">
|
|
public
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a>
|
|
</span>
|
|
<span class="sympad">triggerAdhocScript</span>
|
|
<span class="normal">(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> project, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> scriptFilename, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/Properties.html">Properties</a> options)</span>
|
|
</h4>
|
|
<div class="api-level">
|
|
<div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<div class="jd-details-descr">
|
|
|
|
<div class="jd-tagdata jd-tagdescr"><p>Trigger the execution of an ad-hoc script, and return immediately (without waiting the end of the execution). The
|
|
script will not be dispatched to nodes, but be executed on the RunDeck server.</p></div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Parameters</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th>project</td>
|
|
<td>name of the project - mandatory</td>
|
|
</tr>
|
|
<tr>
|
|
<th>scriptFilename</td>
|
|
<td>filename of the script to be executed - mandatory</td>
|
|
</tr>
|
|
<tr>
|
|
<th>options</td>
|
|
<td>of the script - optional. See <code><a href="../../../org/rundeck/api/OptionsBuilder.html">OptionsBuilder</a></code>.</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Returns</h5>
|
|
<ul class="nolist"><li>a <code><a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a></code> instance for the newly created (and running) execution - won't be null</li></ul>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Throws</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.html">RundeckApiException</a></td>
|
|
<td>in case of error when calling the API (non-existent project with this name)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html">RundeckApiException.RundeckApiLoginException</a></td>
|
|
<td>if the login fails (in case of login-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiTokenException.html">RundeckApiException.RundeckApiTokenException</a></td>
|
|
<td>if the token is invalid (in case of token-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/IllegalArgumentException.html">IllegalArgumentException</a></td>
|
|
<td>if the project or scriptFilename is blank (null, empty or whitespace)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/io/IOException.html">IOException</a></td>
|
|
<td>if we failed to read the file</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">See Also</h5>
|
|
<ul class="nolist"><li><code><a href="../../../org/rundeck/api/RundeckClient.html#triggerAdhocScript(java.lang.String, java.lang.String, java.util.Properties, java.util.Properties, java.lang.Integer, java.lang.Boolean)">triggerAdhocScript(String, String, Properties, Properties, Integer, Boolean)</a></code></li><li><code><a href="../../../org/rundeck/api/RundeckClient.html#runAdhocScript(java.lang.String, java.lang.String, java.util.Properties)">runAdhocScript(String, String, Properties)</a></code></li>
|
|
</ul>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<A NAME="triggerAdhocScript(java.lang.String, java.lang.String, java.util.Properties, java.util.Properties)"></A>
|
|
|
|
<div class="jd-details api apilevel-">
|
|
<h4 class="jd-details-title">
|
|
<span class="normal">
|
|
public
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a>
|
|
</span>
|
|
<span class="sympad">triggerAdhocScript</span>
|
|
<span class="normal">(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> project, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> scriptFilename, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/Properties.html">Properties</a> options, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/Properties.html">Properties</a> nodeFilters)</span>
|
|
</h4>
|
|
<div class="api-level">
|
|
<div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<div class="jd-details-descr">
|
|
|
|
<div class="jd-tagdata jd-tagdescr"><p>Trigger the execution of an ad-hoc script, and return immediately (without waiting the end of the execution). The
|
|
script will be dispatched to nodes, accordingly to the nodeFilters parameter.</p></div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Parameters</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th>project</td>
|
|
<td>name of the project - mandatory</td>
|
|
</tr>
|
|
<tr>
|
|
<th>scriptFilename</td>
|
|
<td>filename of the script to be executed - mandatory</td>
|
|
</tr>
|
|
<tr>
|
|
<th>options</td>
|
|
<td>of the script - optional. See <code><a href="../../../org/rundeck/api/OptionsBuilder.html">OptionsBuilder</a></code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<th>nodeFilters</td>
|
|
<td>for selecting nodes on which the command will be executed. See <code><a href="../../../org/rundeck/api/NodeFiltersBuilder.html">NodeFiltersBuilder</a></code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Returns</h5>
|
|
<ul class="nolist"><li>a <code><a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a></code> instance for the newly created (and running) execution - won't be null</li></ul>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Throws</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.html">RundeckApiException</a></td>
|
|
<td>in case of error when calling the API (non-existent project with this name)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html">RundeckApiException.RundeckApiLoginException</a></td>
|
|
<td>if the login fails (in case of login-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiTokenException.html">RundeckApiException.RundeckApiTokenException</a></td>
|
|
<td>if the token is invalid (in case of token-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/IllegalArgumentException.html">IllegalArgumentException</a></td>
|
|
<td>if the project or scriptFilename is blank (null, empty or whitespace)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/io/IOException.html">IOException</a></td>
|
|
<td>if we failed to read the file</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">See Also</h5>
|
|
<ul class="nolist"><li><code><a href="../../../org/rundeck/api/RundeckClient.html#triggerAdhocScript(java.lang.String, java.lang.String, java.util.Properties, java.util.Properties, java.lang.Integer, java.lang.Boolean)">triggerAdhocScript(String, String, Properties, Properties, Integer, Boolean)</a></code></li><li><code><a href="../../../org/rundeck/api/RundeckClient.html#runAdhocScript(java.lang.String, java.lang.String, java.util.Properties, java.util.Properties)">runAdhocScript(String, String, Properties, Properties)</a></code></li>
|
|
</ul>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<A NAME="triggerAdhocScript(java.lang.String, java.lang.String, java.util.Properties, java.util.Properties, java.lang.Integer, java.lang.Boolean)"></A>
|
|
|
|
<div class="jd-details api apilevel-">
|
|
<h4 class="jd-details-title">
|
|
<span class="normal">
|
|
public
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a>
|
|
</span>
|
|
<span class="sympad">triggerAdhocScript</span>
|
|
<span class="normal">(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> project, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> scriptFilename, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/Properties.html">Properties</a> options, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/Properties.html">Properties</a> nodeFilters, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/Integer.html">Integer</a> nodeThreadcount, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/Boolean.html">Boolean</a> nodeKeepgoing)</span>
|
|
</h4>
|
|
<div class="api-level">
|
|
<div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<div class="jd-details-descr">
|
|
|
|
<div class="jd-tagdata jd-tagdescr"><p>Trigger the execution of an ad-hoc script, and return immediately (without waiting the end of the execution). The
|
|
script will be dispatched to nodes, accordingly to the nodeFilters parameter.</p></div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Parameters</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th>project</td>
|
|
<td>name of the project - mandatory</td>
|
|
</tr>
|
|
<tr>
|
|
<th>scriptFilename</td>
|
|
<td>filename of the script to be executed - mandatory</td>
|
|
</tr>
|
|
<tr>
|
|
<th>options</td>
|
|
<td>of the script - optional. See <code><a href="../../../org/rundeck/api/OptionsBuilder.html">OptionsBuilder</a></code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<th>nodeFilters</td>
|
|
<td>for selecting nodes on which the command will be executed. See <code><a href="../../../org/rundeck/api/NodeFiltersBuilder.html">NodeFiltersBuilder</a></code></td>
|
|
</tr>
|
|
<tr>
|
|
<th>nodeThreadcount</td>
|
|
<td>thread count to use (for parallelizing when running on multiple nodes) - optional</td>
|
|
</tr>
|
|
<tr>
|
|
<th>nodeKeepgoing</td>
|
|
<td>if true, continue executing on other nodes even if some fail - optional</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Returns</h5>
|
|
<ul class="nolist"><li>a <code><a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a></code> instance for the newly created (and running) execution - won't be null</li></ul>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Throws</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.html">RundeckApiException</a></td>
|
|
<td>in case of error when calling the API (non-existent project with this name)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html">RundeckApiException.RundeckApiLoginException</a></td>
|
|
<td>if the login fails (in case of login-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiTokenException.html">RundeckApiException.RundeckApiTokenException</a></td>
|
|
<td>if the token is invalid (in case of token-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/IllegalArgumentException.html">IllegalArgumentException</a></td>
|
|
<td>if the project or scriptFilename is blank (null, empty or whitespace)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/io/IOException.html">IOException</a></td>
|
|
<td>if we failed to read the file</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">See Also</h5>
|
|
<ul class="nolist"><li><code><a href="../../../org/rundeck/api/RundeckClient.html#triggerAdhocScript(java.lang.String, java.io.InputStream, java.util.Properties, java.util.Properties, java.lang.Integer, java.lang.Boolean)">triggerAdhocScript(String, InputStream, Properties, Properties, Integer, Boolean)</a></code></li><li><code><a href="../../../org/rundeck/api/RundeckClient.html#runAdhocScript(java.lang.String, java.lang.String, java.util.Properties, java.util.Properties, java.lang.Integer, java.lang.Boolean, long, java.util.concurrent.TimeUnit)">runAdhocScript(String, String, Properties, Properties, Integer, Boolean, long, TimeUnit)</a></code></li>
|
|
</ul>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<A NAME="triggerJob(java.lang.String)"></A>
|
|
|
|
<div class="jd-details api apilevel-">
|
|
<h4 class="jd-details-title">
|
|
<span class="normal">
|
|
public
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a>
|
|
</span>
|
|
<span class="sympad">triggerJob</span>
|
|
<span class="normal">(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> jobId)</span>
|
|
</h4>
|
|
<div class="api-level">
|
|
<div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<div class="jd-details-descr">
|
|
|
|
<div class="jd-tagdata jd-tagdescr"><p>Trigger the execution of a RunDeck job (identified by the given ID), and return immediately (without waiting the
|
|
end of the job execution)</p></div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Parameters</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th>jobId</td>
|
|
<td>identifier of the job - mandatory</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Returns</h5>
|
|
<ul class="nolist"><li>a <code><a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a></code> instance for the newly created (and running) execution - won't be null</li></ul>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Throws</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.html">RundeckApiException</a></td>
|
|
<td>in case of error when calling the API (non-existent job with this ID)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html">RundeckApiException.RundeckApiLoginException</a></td>
|
|
<td>if the login fails (in case of login-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiTokenException.html">RundeckApiException.RundeckApiTokenException</a></td>
|
|
<td>if the token is invalid (in case of token-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/IllegalArgumentException.html">IllegalArgumentException</a></td>
|
|
<td>if the jobId is blank (null, empty or whitespace)</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">See Also</h5>
|
|
<ul class="nolist"><li><code><a href="../../../org/rundeck/api/RundeckClient.html#triggerJob(java.lang.String, java.util.Properties, java.util.Properties)">triggerJob(String, Properties, Properties)</a></code></li><li><code><a href="../../../org/rundeck/api/RundeckClient.html#runJob(java.lang.String)">runJob(String)</a></code></li>
|
|
</ul>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<A NAME="triggerJob(java.lang.String, java.util.Properties)"></A>
|
|
|
|
<div class="jd-details api apilevel-">
|
|
<h4 class="jd-details-title">
|
|
<span class="normal">
|
|
public
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a>
|
|
</span>
|
|
<span class="sympad">triggerJob</span>
|
|
<span class="normal">(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> jobId, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/Properties.html">Properties</a> options)</span>
|
|
</h4>
|
|
<div class="api-level">
|
|
<div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<div class="jd-details-descr">
|
|
|
|
<div class="jd-tagdata jd-tagdescr"><p>Trigger the execution of a RunDeck job (identified by the given ID), and return immediately (without waiting the
|
|
end of the job execution)</p></div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Parameters</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th>jobId</td>
|
|
<td>identifier of the job - mandatory</td>
|
|
</tr>
|
|
<tr>
|
|
<th>options</td>
|
|
<td>of the job - optional. See <code><a href="../../../org/rundeck/api/OptionsBuilder.html">OptionsBuilder</a></code>.</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Returns</h5>
|
|
<ul class="nolist"><li>a <code><a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a></code> instance for the newly created (and running) execution - won't be null</li></ul>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Throws</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.html">RundeckApiException</a></td>
|
|
<td>in case of error when calling the API (non-existent job with this ID)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html">RundeckApiException.RundeckApiLoginException</a></td>
|
|
<td>if the login fails (in case of login-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiTokenException.html">RundeckApiException.RundeckApiTokenException</a></td>
|
|
<td>if the token is invalid (in case of token-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/IllegalArgumentException.html">IllegalArgumentException</a></td>
|
|
<td>if the jobId is blank (null, empty or whitespace)</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">See Also</h5>
|
|
<ul class="nolist"><li><code><a href="../../../org/rundeck/api/RundeckClient.html#triggerJob(java.lang.String, java.util.Properties, java.util.Properties)">triggerJob(String, Properties, Properties)</a></code></li><li><code><a href="../../../org/rundeck/api/RundeckClient.html#runJob(java.lang.String, java.util.Properties)">runJob(String, Properties)</a></code></li>
|
|
</ul>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<A NAME="triggerJob(java.lang.String, java.util.Properties, java.util.Properties)"></A>
|
|
|
|
<div class="jd-details api apilevel-">
|
|
<h4 class="jd-details-title">
|
|
<span class="normal">
|
|
public
|
|
|
|
|
|
|
|
|
|
<a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a>
|
|
</span>
|
|
<span class="sympad">triggerJob</span>
|
|
<span class="normal">(<a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a> jobId, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/Properties.html">Properties</a> options, <a href="http://download.oracle.com/javase/6/docs/api/index.html?java/util/Properties.html">Properties</a> nodeFilters)</span>
|
|
</h4>
|
|
<div class="api-level">
|
|
<div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
<div class="jd-details-descr">
|
|
|
|
<div class="jd-tagdata jd-tagdescr"><p>Trigger the execution of a RunDeck job (identified by the given ID), and return immediately (without waiting the
|
|
end of the job execution)</p></div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Parameters</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th>jobId</td>
|
|
<td>identifier of the job - mandatory</td>
|
|
</tr>
|
|
<tr>
|
|
<th>options</td>
|
|
<td>of the job - optional. See <code><a href="../../../org/rundeck/api/OptionsBuilder.html">OptionsBuilder</a></code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<th>nodeFilters</td>
|
|
<td>for overriding the nodes on which the job will be executed - optional. See
|
|
<code><a href="../../../org/rundeck/api/NodeFiltersBuilder.html">NodeFiltersBuilder</a></code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Returns</h5>
|
|
<ul class="nolist"><li>a <code><a href="../../../org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a></code> instance for the newly created (and running) execution - won't be null</li></ul>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">Throws</h5>
|
|
<table class="jd-tagtable">
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.html">RundeckApiException</a></td>
|
|
<td>in case of error when calling the API (non-existent job with this ID)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html">RundeckApiException.RundeckApiLoginException</a></td>
|
|
<td>if the login fails (in case of login-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="../../../org/rundeck/api/RundeckApiException.RundeckApiTokenException.html">RundeckApiException.RundeckApiTokenException</a></td>
|
|
<td>if the token is invalid (in case of token-based authentication)</td>
|
|
</tr>
|
|
<tr>
|
|
<th><a href="http://download.oracle.com/javase/6/docs/api/index.html?java/lang/IllegalArgumentException.html">IllegalArgumentException</a></td>
|
|
<td>if the jobId is blank (null, empty or whitespace)</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="jd-tagdata">
|
|
<h5 class="jd-tagtitle">See Also</h5>
|
|
<ul class="nolist"><li><code><a href="../../../org/rundeck/api/RundeckClient.html#triggerJob(java.lang.String)">triggerJob(String)</a></code></li><li><code><a href="../../../org/rundeck/api/RundeckClient.html#runJob(java.lang.String, java.util.Properties, java.util.Properties)">runJob(String, Properties, Properties)</a></code></li>
|
|
</ul>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ========= METHOD DETAIL ======== -->
|
|
|
|
|
|
|
|
<!-- ========= END OF CLASS DATA ========= -->
|
|
<A NAME="navbar_top"></A>
|
|
|
|
<div id="footer">
|
|
Generated by <a href="http://code.google.com/p/doclava/">Doclava</a>.
|
|
</div> <!-- end footer -->
|
|
|
|
</div> <!-- jd-content -->
|
|
|
|
</div><!-- end doc-content -->
|
|
|
|
</div> <!-- end body-content -->
|
|
|
|
<script type="text/javascript">
|
|
init(); /* initialize android-developer-docs.js */
|
|
</script>
|
|
|
|
</body>
|
|
</html>
|