mirror of
https://github.com/Fishwaldo/rundeck-api-java-client.git
synced 2025-07-12 16:09:05 +00:00
1644 lines
138 KiB
HTML
1644 lines
138 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
|
<!--NewPage-->
|
|
<HTML>
|
|
<HEAD>
|
|
<!-- Generated by javadoc (build 1.6.0_24) on Wed Jul 06 19:29:47 CEST 2011 -->
|
|
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
|
<TITLE>
|
|
RundeckClient (RunDeck API - Java Client 1.0-SNAPSHOT API)
|
|
</TITLE>
|
|
|
|
<META NAME="date" CONTENT="2011-07-06">
|
|
|
|
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
|
|
|
|
<SCRIPT type="text/javascript">
|
|
function windowTitle()
|
|
{
|
|
if (location.href.indexOf('is-external=true') == -1) {
|
|
parent.document.title="RundeckClient (RunDeck API - Java Client 1.0-SNAPSHOT API)";
|
|
}
|
|
}
|
|
</SCRIPT>
|
|
<NOSCRIPT>
|
|
</NOSCRIPT>
|
|
|
|
</HEAD>
|
|
|
|
<BODY BGCOLOR="white" onload="windowTitle();">
|
|
<HR>
|
|
|
|
|
|
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
<A NAME="navbar_top"><!-- --></A>
|
|
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
|
|
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
|
|
<TR>
|
|
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
|
<A NAME="navbar_top_firstrow"><!-- --></A>
|
|
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
|
|
<TR ALIGN="center" VALIGN="top">
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/RundeckClient.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
|
</TR>
|
|
</TABLE>
|
|
</TD>
|
|
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
|
</EM>
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR>
|
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
<A HREF="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html" title="class in org.rundeck.api"><B>PREV CLASS</B></A>
|
|
NEXT CLASS</FONT></TD>
|
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
<A HREF="../../../index.html?org/rundeck/api/RundeckClient.html" target="_top"><B>FRAMES</B></A>
|
|
<A HREF="RundeckClient.html" target="_top"><B>NO FRAMES</B></A>
|
|
<SCRIPT type="text/javascript">
|
|
<!--
|
|
if(window==top) {
|
|
document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
|
|
}
|
|
//-->
|
|
</SCRIPT>
|
|
<NOSCRIPT>
|
|
<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
|
|
</NOSCRIPT>
|
|
|
|
|
|
</FONT></TD>
|
|
</TR>
|
|
<TR>
|
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
|
</TR>
|
|
</TABLE>
|
|
<A NAME="skip-navbar_top"></A>
|
|
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
|
|
<HR>
|
|
<!-- ======== START OF CLASS DATA ======== -->
|
|
<H2>
|
|
<FONT SIZE="-1">
|
|
org.rundeck.api</FONT>
|
|
<BR>
|
|
Class RundeckClient</H2>
|
|
<PRE>
|
|
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A>
|
|
<IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>org.rundeck.api.RundeckClient</B>
|
|
</PRE>
|
|
<DL>
|
|
<DT><B>All Implemented Interfaces:</B> <DD><A HREF="http://download.oracle.com/javase/6/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</A></DD>
|
|
</DL>
|
|
<HR>
|
|
<DL>
|
|
<DT><PRE>public class <B>RundeckClient</B><DT>extends <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A><DT>implements <A HREF="http://download.oracle.com/javase/6/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</A></DL>
|
|
</PRE>
|
|
|
|
<P>
|
|
Main entry point to talk to a RunDeck instance.<br>
|
|
Usage : <br>
|
|
<code>
|
|
<pre>
|
|
RundeckClient rundeck = new RundeckClient("http://localhost:4440", "admin", "admin");
|
|
List<RundeckJob> jobs = rundeck.getJobs();
|
|
|
|
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");
|
|
</pre>
|
|
</code>
|
|
<P>
|
|
|
|
<P>
|
|
<DL>
|
|
<DT><B>Author:</B></DT>
|
|
<DD>Vincent Behar</DD>
|
|
<DT><B>See Also:</B><DD><A HREF="../../../serialized-form.html#org.rundeck.api.RundeckClient">Serialized Form</A></DL>
|
|
<HR>
|
|
|
|
<P>
|
|
<!-- =========== FIELD SUMMARY =========== -->
|
|
|
|
<A NAME="field_summary"><!-- --></A>
|
|
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
|
|
<B>Field Summary</B></FONT></TH>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE>static <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../org/rundeck/api/RundeckClient.html#API_ENDPOINT">API_ENDPOINT</A></B></CODE>
|
|
|
|
<BR>
|
|
</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE>static int</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../org/rundeck/api/RundeckClient.html#API_VERSION">API_VERSION</A></B></CODE>
|
|
|
|
<BR>
|
|
</TD>
|
|
</TR>
|
|
</TABLE>
|
|
|
|
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
|
|
|
<A NAME="constructor_summary"><!-- --></A>
|
|
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
|
|
<B>Constructor Summary</B></FONT></TH>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD><CODE><B><A HREF="../../../org/rundeck/api/RundeckClient.html#RundeckClient(java.lang.String, java.lang.String, java.lang.String)">RundeckClient</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> url,
|
|
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> login,
|
|
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> password)</CODE>
|
|
|
|
<BR>
|
|
Instantiate a new <A HREF="../../../org/rundeck/api/RundeckClient.html" title="class in org.rundeck.api"><CODE>RundeckClient</CODE></A> for the RunDeck instance at the given url</TD>
|
|
</TR>
|
|
</TABLE>
|
|
|
|
<!-- ========== METHOD SUMMARY =========== -->
|
|
|
|
<A NAME="method_summary"><!-- --></A>
|
|
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
|
|
<B>Method Summary</B></FONT></TH>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="../../../org/rundeck/api/domain/RundeckAbort.html" title="class in org.rundeck.api.domain">RundeckAbort</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../org/rundeck/api/RundeckClient.html#abortExecution(java.lang.Long)">abortExecution</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</A> executionId)</CODE>
|
|
|
|
<BR>
|
|
Abort an execution (identified by the given ID).</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> boolean</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../org/rundeck/api/RundeckClient.html#equals(java.lang.Object)">equals</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> obj)</CODE>
|
|
|
|
<BR>
|
|
</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="../../../org/rundeck/api/domain/RundeckJob.html" title="class in org.rundeck.api.domain">RundeckJob</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../org/rundeck/api/RundeckClient.html#findJob(java.lang.String, java.lang.String, java.lang.String)">findJob</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> project,
|
|
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> groupPath,
|
|
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name)</CODE>
|
|
|
|
<BR>
|
|
Find a job, identified by its project, group and name.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="../../../org/rundeck/api/domain/RundeckExecution.html" title="class in org.rundeck.api.domain">RundeckExecution</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../org/rundeck/api/RundeckClient.html#getExecution(java.lang.Long)">getExecution</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</A> executionId)</CODE>
|
|
|
|
<BR>
|
|
Get a single execution, identified by the given ID</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="../../../org/rundeck/api/domain/RundeckJob.html" title="class in org.rundeck.api.domain">RundeckJob</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../org/rundeck/api/RundeckClient.html#getJob(java.lang.String)">getJob</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> jobId)</CODE>
|
|
|
|
<BR>
|
|
Get the definition of a single job, identified by the given ID</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="../../../org/rundeck/api/domain/RundeckExecution.html" title="class in org.rundeck.api.domain">RundeckExecution</A>></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../org/rundeck/api/RundeckClient.html#getJobExecutions(java.lang.String)">getJobExecutions</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> jobId)</CODE>
|
|
|
|
<BR>
|
|
Get the executions of the given job</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="../../../org/rundeck/api/domain/RundeckExecution.html" title="class in org.rundeck.api.domain">RundeckExecution</A>></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../org/rundeck/api/RundeckClient.html#getJobExecutions(java.lang.String, org.rundeck.api.domain.RundeckExecution.ExecutionStatus)">getJobExecutions</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> jobId,
|
|
<A HREF="../../../org/rundeck/api/domain/RundeckExecution.ExecutionStatus.html" title="enum in org.rundeck.api.domain">RundeckExecution.ExecutionStatus</A> status)</CODE>
|
|
|
|
<BR>
|
|
Get the executions of the given job</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="../../../org/rundeck/api/domain/RundeckExecution.html" title="class in org.rundeck.api.domain">RundeckExecution</A>></CODE></FONT></TD>
|
|
<TD><CODE><B><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></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> jobId,
|
|
<A HREF="../../../org/rundeck/api/domain/RundeckExecution.ExecutionStatus.html" title="enum in org.rundeck.api.domain">RundeckExecution.ExecutionStatus</A> status,
|
|
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</A> max,
|
|
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</A> offset)</CODE>
|
|
|
|
<BR>
|
|
Get the executions of the given job</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="../../../org/rundeck/api/domain/RundeckJob.html" title="class in org.rundeck.api.domain">RundeckJob</A>></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../org/rundeck/api/RundeckClient.html#getJobs()">getJobs</A></B>()</CODE>
|
|
|
|
<BR>
|
|
List all jobs (for all projects)</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="../../../org/rundeck/api/domain/RundeckJob.html" title="class in org.rundeck.api.domain">RundeckJob</A>></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../org/rundeck/api/RundeckClient.html#getJobs(java.lang.String)">getJobs</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> project)</CODE>
|
|
|
|
<BR>
|
|
List all jobs that belongs to the given project</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="../../../org/rundeck/api/domain/RundeckJob.html" title="class in org.rundeck.api.domain">RundeckJob</A>></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../org/rundeck/api/RundeckClient.html#getJobs(java.lang.String, java.lang.String, java.lang.String, java.lang.String...)">getJobs</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> project,
|
|
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> jobFilter,
|
|
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> groupPath,
|
|
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>... jobIds)</CODE>
|
|
|
|
<BR>
|
|
List the jobs that belongs to the given project, and matches the given criteria (jobFilter, groupPath and jobIds)</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../org/rundeck/api/RundeckClient.html#getLogin()">getLogin</A></B>()</CODE>
|
|
|
|
<BR>
|
|
</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="../../../org/rundeck/api/domain/RundeckNode.html" title="class in org.rundeck.api.domain">RundeckNode</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../org/rundeck/api/RundeckClient.html#getNode(java.lang.String, java.lang.String)">getNode</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name,
|
|
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> project)</CODE>
|
|
|
|
<BR>
|
|
Get the definition of a single node</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="../../../org/rundeck/api/domain/RundeckNode.html" title="class in org.rundeck.api.domain">RundeckNode</A>></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../org/rundeck/api/RundeckClient.html#getNodes()">getNodes</A></B>()</CODE>
|
|
|
|
<BR>
|
|
List all nodes (for all projects)</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="../../../org/rundeck/api/domain/RundeckNode.html" title="class in org.rundeck.api.domain">RundeckNode</A>></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../org/rundeck/api/RundeckClient.html#getNodes(java.lang.String)">getNodes</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> project)</CODE>
|
|
|
|
<BR>
|
|
List all nodes that belongs to the given project</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="../../../org/rundeck/api/domain/RundeckNode.html" title="class in org.rundeck.api.domain">RundeckNode</A>></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../org/rundeck/api/RundeckClient.html#getNodes(java.lang.String, java.util.Properties)">getNodes</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> project,
|
|
<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</A> nodeFilters)</CODE>
|
|
|
|
<BR>
|
|
List nodes that belongs to the given project</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../org/rundeck/api/RundeckClient.html#getPassword()">getPassword</A></B>()</CODE>
|
|
|
|
<BR>
|
|
</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="../../../org/rundeck/api/domain/RundeckProject.html" title="class in org.rundeck.api.domain">RundeckProject</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../org/rundeck/api/RundeckClient.html#getProject(java.lang.String)">getProject</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> projectName)</CODE>
|
|
|
|
<BR>
|
|
Get the definition of a single project, identified by the given name</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="../../../org/rundeck/api/domain/RundeckProject.html" title="class in org.rundeck.api.domain">RundeckProject</A>></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../org/rundeck/api/RundeckClient.html#getProjects()">getProjects</A></B>()</CODE>
|
|
|
|
<BR>
|
|
List all projects</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="../../../org/rundeck/api/domain/RundeckExecution.html" title="class in org.rundeck.api.domain">RundeckExecution</A>></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../org/rundeck/api/RundeckClient.html#getRunningExecutions()">getRunningExecutions</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Get all running executions (for all projects)</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="../../../org/rundeck/api/domain/RundeckExecution.html" title="class in org.rundeck.api.domain">RundeckExecution</A>></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../org/rundeck/api/RundeckClient.html#getRunningExecutions(java.lang.String)">getRunningExecutions</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> project)</CODE>
|
|
|
|
<BR>
|
|
Get the running executions for the given project</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../org/rundeck/api/RundeckClient.html#getUrl()">getUrl</A></B>()</CODE>
|
|
|
|
<BR>
|
|
</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> int</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../org/rundeck/api/RundeckClient.html#hashCode()">hashCode</A></B>()</CODE>
|
|
|
|
<BR>
|
|
</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> void</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../org/rundeck/api/RundeckClient.html#ping()">ping</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Try to "ping" the RunDeck instance to see if it is alive</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="../../../org/rundeck/api/domain/RundeckExecution.html" title="class in org.rundeck.api.domain">RundeckExecution</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../org/rundeck/api/RundeckClient.html#runAdhocCommand(java.lang.String, java.lang.String)">runAdhocCommand</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> project,
|
|
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> command)</CODE>
|
|
|
|
<BR>
|
|
Run an ad-hoc command, and wait until its execution is finished (or aborted) to return.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="../../../org/rundeck/api/domain/RundeckExecution.html" title="class in org.rundeck.api.domain">RundeckExecution</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../org/rundeck/api/RundeckClient.html#runAdhocCommand(java.lang.String, java.lang.String, long, java.util.concurrent.TimeUnit)">runAdhocCommand</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> project,
|
|
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> command,
|
|
long poolingInterval,
|
|
<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent">TimeUnit</A> poolingUnit)</CODE>
|
|
|
|
<BR>
|
|
Run an ad-hoc command, and wait until its execution is finished (or aborted) to return.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="../../../org/rundeck/api/domain/RundeckExecution.html" title="class in org.rundeck.api.domain">RundeckExecution</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../org/rundeck/api/RundeckClient.html#runAdhocCommand(java.lang.String, java.lang.String, java.util.Properties)">runAdhocCommand</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> project,
|
|
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> command,
|
|
<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</A> nodeFilters)</CODE>
|
|
|
|
<BR>
|
|
Run an ad-hoc command, and wait until its execution is finished (or aborted) to return.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="../../../org/rundeck/api/domain/RundeckExecution.html" title="class in org.rundeck.api.domain">RundeckExecution</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../org/rundeck/api/RundeckClient.html#runAdhocCommand(java.lang.String, java.lang.String, java.util.Properties, long, java.util.concurrent.TimeUnit)">runAdhocCommand</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> project,
|
|
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> command,
|
|
<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</A> nodeFilters,
|
|
long poolingInterval,
|
|
<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent">TimeUnit</A> poolingUnit)</CODE>
|
|
|
|
<BR>
|
|
Run an ad-hoc command, and wait until its execution is finished (or aborted) to return.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="../../../org/rundeck/api/domain/RundeckExecution.html" title="class in org.rundeck.api.domain">RundeckExecution</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../org/rundeck/api/RundeckClient.html#runJob(java.lang.String)">runJob</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> jobId)</CODE>
|
|
|
|
<BR>
|
|
Run a RunDeck job (identified by the given ID), and wait until its execution is finished (or aborted) to return.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="../../../org/rundeck/api/domain/RundeckExecution.html" title="class in org.rundeck.api.domain">RundeckExecution</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../org/rundeck/api/RundeckClient.html#runJob(java.lang.String, java.util.Properties)">runJob</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> jobId,
|
|
<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</A> options)</CODE>
|
|
|
|
<BR>
|
|
Run a RunDeck job (identified by the given ID), and wait until its execution is finished (or aborted) to return.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="../../../org/rundeck/api/domain/RundeckExecution.html" title="class in org.rundeck.api.domain">RundeckExecution</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../org/rundeck/api/RundeckClient.html#runJob(java.lang.String, java.util.Properties, long, java.util.concurrent.TimeUnit)">runJob</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> jobId,
|
|
<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</A> options,
|
|
long poolingInterval,
|
|
<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent">TimeUnit</A> poolingUnit)</CODE>
|
|
|
|
<BR>
|
|
Run a RunDeck job (identified by the given ID), and wait until its execution is finished (or aborted) to return.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="../../../org/rundeck/api/domain/RundeckExecution.html" title="class in org.rundeck.api.domain">RundeckExecution</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../org/rundeck/api/RundeckClient.html#runJob(java.lang.String, java.util.Properties, java.util.Properties)">runJob</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> jobId,
|
|
<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</A> options,
|
|
<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</A> nodeFilters)</CODE>
|
|
|
|
<BR>
|
|
Run a RunDeck job (identified by the given ID), and wait until its execution is finished (or aborted) to return.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="../../../org/rundeck/api/domain/RundeckExecution.html" title="class in org.rundeck.api.domain">RundeckExecution</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../org/rundeck/api/RundeckClient.html#runJob(java.lang.String, java.util.Properties, java.util.Properties, long, java.util.concurrent.TimeUnit)">runJob</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> jobId,
|
|
<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</A> options,
|
|
<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</A> nodeFilters,
|
|
long poolingInterval,
|
|
<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent">TimeUnit</A> poolingUnit)</CODE>
|
|
|
|
<BR>
|
|
Run a RunDeck job (identified by the given ID), and wait until its execution is finished (or aborted) to return.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> void</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../org/rundeck/api/RundeckClient.html#testCredentials()">testCredentials</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Test your credentials (login/password) on the RunDeck instance</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../org/rundeck/api/RundeckClient.html#toString()">toString</A></B>()</CODE>
|
|
|
|
<BR>
|
|
</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="../../../org/rundeck/api/domain/RundeckExecution.html" title="class in org.rundeck.api.domain">RundeckExecution</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../org/rundeck/api/RundeckClient.html#triggerAdhocCommand(java.lang.String, java.lang.String)">triggerAdhocCommand</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> project,
|
|
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> command)</CODE>
|
|
|
|
<BR>
|
|
Trigger the execution of an ad-hoc command, and return immediately (without waiting the end of the execution).</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="../../../org/rundeck/api/domain/RundeckExecution.html" title="class in org.rundeck.api.domain">RundeckExecution</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../org/rundeck/api/RundeckClient.html#triggerAdhocCommand(java.lang.String, java.lang.String, java.util.Properties)">triggerAdhocCommand</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> project,
|
|
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> command,
|
|
<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</A> nodeFilters)</CODE>
|
|
|
|
<BR>
|
|
Trigger the execution of an ad-hoc command, and return immediately (without waiting the end of the execution).</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="../../../org/rundeck/api/domain/RundeckExecution.html" title="class in org.rundeck.api.domain">RundeckExecution</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../org/rundeck/api/RundeckClient.html#triggerJob(java.lang.String)">triggerJob</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> jobId)</CODE>
|
|
|
|
<BR>
|
|
Trigger the execution of a RunDeck job (identified by the given ID), and return immediately (without waiting the
|
|
end of the job execution)</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="../../../org/rundeck/api/domain/RundeckExecution.html" title="class in org.rundeck.api.domain">RundeckExecution</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../org/rundeck/api/RundeckClient.html#triggerJob(java.lang.String, java.util.Properties)">triggerJob</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> jobId,
|
|
<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</A> options)</CODE>
|
|
|
|
<BR>
|
|
Trigger the execution of a RunDeck job (identified by the given ID), and return immediately (without waiting the
|
|
end of the job execution)</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="../../../org/rundeck/api/domain/RundeckExecution.html" title="class in org.rundeck.api.domain">RundeckExecution</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../org/rundeck/api/RundeckClient.html#triggerJob(java.lang.String, java.util.Properties, java.util.Properties)">triggerJob</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> jobId,
|
|
<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</A> options,
|
|
<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</A> nodeFilters)</CODE>
|
|
|
|
<BR>
|
|
Trigger the execution of a RunDeck job (identified by the given ID), and return immediately (without waiting the
|
|
end of the job execution)</TD>
|
|
</TR>
|
|
</TABLE>
|
|
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
|
|
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
|
<TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD>
|
|
</TR>
|
|
</TABLE>
|
|
|
|
<P>
|
|
|
|
<!-- ============ FIELD DETAIL =========== -->
|
|
|
|
<A NAME="field_detail"><!-- --></A>
|
|
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
|
|
<B>Field Detail</B></FONT></TH>
|
|
</TR>
|
|
</TABLE>
|
|
|
|
<A NAME="API_VERSION"><!-- --></A><H3>
|
|
API_VERSION</H3>
|
|
<PRE>
|
|
public static final transient int <B>API_VERSION</B></PRE>
|
|
<DL>
|
|
<DL>
|
|
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.rundeck.api.RundeckClient.API_VERSION">Constant Field Values</A></DL>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="API_ENDPOINT"><!-- --></A><H3>
|
|
API_ENDPOINT</H3>
|
|
<PRE>
|
|
public static final transient <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>API_ENDPOINT</B></PRE>
|
|
<DL>
|
|
<DL>
|
|
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.rundeck.api.RundeckClient.API_ENDPOINT">Constant Field Values</A></DL>
|
|
</DL>
|
|
|
|
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
|
|
|
<A NAME="constructor_detail"><!-- --></A>
|
|
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
|
|
<B>Constructor Detail</B></FONT></TH>
|
|
</TR>
|
|
</TABLE>
|
|
|
|
<A NAME="RundeckClient(java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
|
|
RundeckClient</H3>
|
|
<PRE>
|
|
public <B>RundeckClient</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> url,
|
|
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> login,
|
|
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> password)
|
|
throws <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></PRE>
|
|
<DL>
|
|
<DD>Instantiate a new <A HREF="../../../org/rundeck/api/RundeckClient.html" title="class in org.rundeck.api"><CODE>RundeckClient</CODE></A> for the RunDeck instance at the given url
|
|
<P>
|
|
<DL>
|
|
<DT><B>Parameters:</B><DD><CODE>url</CODE> - of the RunDeck instance ("http://localhost:4440", "http://rundeck.your-compagny.com/", etc)<DD><CODE>login</CODE> - <DD><CODE>password</CODE> -
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if the url, login or password is blank (null, empty or whitespace)</DL>
|
|
</DL>
|
|
|
|
<!-- ============ METHOD DETAIL ========== -->
|
|
|
|
<A NAME="method_detail"><!-- --></A>
|
|
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
|
|
<B>Method Detail</B></FONT></TH>
|
|
</TR>
|
|
</TABLE>
|
|
|
|
<A NAME="ping()"><!-- --></A><H3>
|
|
ping</H3>
|
|
<PRE>
|
|
public void <B>ping</B>()
|
|
throws <A HREF="../../../org/rundeck/api/RundeckApiException.html" title="class in org.rundeck.api">RundeckApiException</A></PRE>
|
|
<DL>
|
|
<DD>Try to "ping" the RunDeck instance to see if it is alive
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE><A HREF="../../../org/rundeck/api/RundeckApiException.html" title="class in org.rundeck.api">RundeckApiException</A></CODE> - if the ping fails</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="testCredentials()"><!-- --></A><H3>
|
|
testCredentials</H3>
|
|
<PRE>
|
|
public void <B>testCredentials</B>()
|
|
throws <A HREF="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html" title="class in org.rundeck.api">RundeckApiException.RundeckApiLoginException</A></PRE>
|
|
<DL>
|
|
<DD>Test your credentials (login/password) on the RunDeck instance
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE><A HREF="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html" title="class in org.rundeck.api">RundeckApiException.RundeckApiLoginException</A></CODE> - if the login fails</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getProjects()"><!-- --></A><H3>
|
|
getProjects</H3>
|
|
<PRE>
|
|
public <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="../../../org/rundeck/api/domain/RundeckProject.html" title="class in org.rundeck.api.domain">RundeckProject</A>> <B>getProjects</B>()
|
|
throws <A HREF="../../../org/rundeck/api/RundeckApiException.html" title="class in org.rundeck.api">RundeckApiException</A>,
|
|
<A HREF="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html" title="class in org.rundeck.api">RundeckApiException.RundeckApiLoginException</A></PRE>
|
|
<DL>
|
|
<DD>List all projects
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>a <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util"><CODE>List</CODE></A> of <A HREF="../../../org/rundeck/api/domain/RundeckProject.html" title="class in org.rundeck.api.domain"><CODE>RundeckProject</CODE></A> : might be empty, but won't be null
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE><A HREF="../../../org/rundeck/api/RundeckApiException.html" title="class in org.rundeck.api">RundeckApiException</A></CODE> - in case of error when calling the API
|
|
<DD><CODE><A HREF="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html" title="class in org.rundeck.api">RundeckApiException.RundeckApiLoginException</A></CODE> - if the login failed</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getProject(java.lang.String)"><!-- --></A><H3>
|
|
getProject</H3>
|
|
<PRE>
|
|
public <A HREF="../../../org/rundeck/api/domain/RundeckProject.html" title="class in org.rundeck.api.domain">RundeckProject</A> <B>getProject</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> projectName)
|
|
throws <A HREF="../../../org/rundeck/api/RundeckApiException.html" title="class in org.rundeck.api">RundeckApiException</A>,
|
|
<A HREF="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html" title="class in org.rundeck.api">RundeckApiException.RundeckApiLoginException</A>,
|
|
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></PRE>
|
|
<DL>
|
|
<DD>Get the definition of a single project, identified by the given name
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>projectName</CODE> - name of the project - mandatory
|
|
<DT><B>Returns:</B><DD>a <A HREF="../../../org/rundeck/api/domain/RundeckProject.html" title="class in org.rundeck.api.domain"><CODE>RundeckProject</CODE></A> instance - won't be null
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE><A HREF="../../../org/rundeck/api/RundeckApiException.html" title="class in org.rundeck.api">RundeckApiException</A></CODE> - in case of error when calling the API (non-existent project with this name)
|
|
<DD><CODE><A HREF="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html" title="class in org.rundeck.api">RundeckApiException.RundeckApiLoginException</A></CODE> - if the login failed
|
|
<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if the projectName is blank (null, empty or whitespace)</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getJobs()"><!-- --></A><H3>
|
|
getJobs</H3>
|
|
<PRE>
|
|
public <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="../../../org/rundeck/api/domain/RundeckJob.html" title="class in org.rundeck.api.domain">RundeckJob</A>> <B>getJobs</B>()
|
|
throws <A HREF="../../../org/rundeck/api/RundeckApiException.html" title="class in org.rundeck.api">RundeckApiException</A>,
|
|
<A HREF="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html" title="class in org.rundeck.api">RundeckApiException.RundeckApiLoginException</A></PRE>
|
|
<DL>
|
|
<DD>List all jobs (for all projects)
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>a <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util"><CODE>List</CODE></A> of <A HREF="../../../org/rundeck/api/domain/RundeckJob.html" title="class in org.rundeck.api.domain"><CODE>RundeckJob</CODE></A> : might be empty, but won't be null
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE><A HREF="../../../org/rundeck/api/RundeckApiException.html" title="class in org.rundeck.api">RundeckApiException</A></CODE> - in case of error when calling the API
|
|
<DD><CODE><A HREF="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html" title="class in org.rundeck.api">RundeckApiException.RundeckApiLoginException</A></CODE> - if the login failed</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getJobs(java.lang.String)"><!-- --></A><H3>
|
|
getJobs</H3>
|
|
<PRE>
|
|
public <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="../../../org/rundeck/api/domain/RundeckJob.html" title="class in org.rundeck.api.domain">RundeckJob</A>> <B>getJobs</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> project)
|
|
throws <A HREF="../../../org/rundeck/api/RundeckApiException.html" title="class in org.rundeck.api">RundeckApiException</A>,
|
|
<A HREF="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html" title="class in org.rundeck.api">RundeckApiException.RundeckApiLoginException</A>,
|
|
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></PRE>
|
|
<DL>
|
|
<DD>List all jobs that belongs to the given project
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>project</CODE> - name of the project - mandatory
|
|
<DT><B>Returns:</B><DD>a <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util"><CODE>List</CODE></A> of <A HREF="../../../org/rundeck/api/domain/RundeckJob.html" title="class in org.rundeck.api.domain"><CODE>RundeckJob</CODE></A> : might be empty, but won't be null
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE><A HREF="../../../org/rundeck/api/RundeckApiException.html" title="class in org.rundeck.api">RundeckApiException</A></CODE> - in case of error when calling the API (non-existent project with this name)
|
|
<DD><CODE><A HREF="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html" title="class in org.rundeck.api">RundeckApiException.RundeckApiLoginException</A></CODE> - if the login failed
|
|
<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if the project is blank (null, empty or whitespace)<DT><B>See Also:</B><DD><A HREF="../../../org/rundeck/api/RundeckClient.html#getJobs(java.lang.String, java.lang.String, java.lang.String, java.lang.String...)"><CODE>getJobs(String, String, String, String...)</CODE></A></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getJobs(java.lang.String, java.lang.String, java.lang.String, java.lang.String...)"><!-- --></A><H3>
|
|
getJobs</H3>
|
|
<PRE>
|
|
public <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="../../../org/rundeck/api/domain/RundeckJob.html" title="class in org.rundeck.api.domain">RundeckJob</A>> <B>getJobs</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> project,
|
|
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> jobFilter,
|
|
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> groupPath,
|
|
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>... jobIds)
|
|
throws <A HREF="../../../org/rundeck/api/RundeckApiException.html" title="class in org.rundeck.api">RundeckApiException</A>,
|
|
<A HREF="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html" title="class in org.rundeck.api">RundeckApiException.RundeckApiLoginException</A>,
|
|
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></PRE>
|
|
<DL>
|
|
<DD>List the jobs that belongs to the given project, and matches the given criteria (jobFilter, groupPath and jobIds)
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>project</CODE> - name of the project - mandatory<DD><CODE>jobFilter</CODE> - a filter for the job Name - optional<DD><CODE>groupPath</CODE> - a group or partial group path to include all jobs within that group path - optional<DD><CODE>jobIds</CODE> - a list of Job IDs to include - optional
|
|
<DT><B>Returns:</B><DD>a <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util"><CODE>List</CODE></A> of <A HREF="../../../org/rundeck/api/domain/RundeckJob.html" title="class in org.rundeck.api.domain"><CODE>RundeckJob</CODE></A> : might be empty, but won't be null
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE><A HREF="../../../org/rundeck/api/RundeckApiException.html" title="class in org.rundeck.api">RundeckApiException</A></CODE> - in case of error when calling the API (non-existent project with this name)
|
|
<DD><CODE><A HREF="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html" title="class in org.rundeck.api">RundeckApiException.RundeckApiLoginException</A></CODE> - if the login failed
|
|
<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if the project is blank (null, empty or whitespace)<DT><B>See Also:</B><DD><A HREF="../../../org/rundeck/api/RundeckClient.html#getJobs(java.lang.String)"><CODE>getJobs(String)</CODE></A></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="findJob(java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
|
|
findJob</H3>
|
|
<PRE>
|
|
public <A HREF="../../../org/rundeck/api/domain/RundeckJob.html" title="class in org.rundeck.api.domain">RundeckJob</A> <B>findJob</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> project,
|
|
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> groupPath,
|
|
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name)
|
|
throws <A HREF="../../../org/rundeck/api/RundeckApiException.html" title="class in org.rundeck.api">RundeckApiException</A>,
|
|
<A HREF="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html" title="class in org.rundeck.api">RundeckApiException.RundeckApiLoginException</A>,
|
|
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></PRE>
|
|
<DL>
|
|
<DD>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>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>project</CODE> - name of the project - mandatory<DD><CODE>groupPath</CODE> - group to which the job belongs (if it belongs to a group) - optional<DD><CODE>name</CODE> - of the job to find - mandatory
|
|
<DT><B>Returns:</B><DD>a <A HREF="../../../org/rundeck/api/domain/RundeckJob.html" title="class in org.rundeck.api.domain"><CODE>RundeckJob</CODE></A> instance - null if not found
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE><A HREF="../../../org/rundeck/api/RundeckApiException.html" title="class in org.rundeck.api">RundeckApiException</A></CODE> - in case of error when calling the API (non-existent project with this name)
|
|
<DD><CODE><A HREF="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html" title="class in org.rundeck.api">RundeckApiException.RundeckApiLoginException</A></CODE> - if the login failed
|
|
<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if the project or the name is blank (null, empty or whitespace)</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getJob(java.lang.String)"><!-- --></A><H3>
|
|
getJob</H3>
|
|
<PRE>
|
|
public <A HREF="../../../org/rundeck/api/domain/RundeckJob.html" title="class in org.rundeck.api.domain">RundeckJob</A> <B>getJob</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> jobId)
|
|
throws <A HREF="../../../org/rundeck/api/RundeckApiException.html" title="class in org.rundeck.api">RundeckApiException</A>,
|
|
<A HREF="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html" title="class in org.rundeck.api">RundeckApiException.RundeckApiLoginException</A>,
|
|
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></PRE>
|
|
<DL>
|
|
<DD>Get the definition of a single job, identified by the given ID
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>jobId</CODE> - identifier of the job - mandatory
|
|
<DT><B>Returns:</B><DD>a <A HREF="../../../org/rundeck/api/domain/RundeckJob.html" title="class in org.rundeck.api.domain"><CODE>RundeckJob</CODE></A> instance - won't be null
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE><A HREF="../../../org/rundeck/api/RundeckApiException.html" title="class in org.rundeck.api">RundeckApiException</A></CODE> - in case of error when calling the API (non-existent job with this ID)
|
|
<DD><CODE><A HREF="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html" title="class in org.rundeck.api">RundeckApiException.RundeckApiLoginException</A></CODE> - if the login failed
|
|
<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if the jobId is blank (null, empty or whitespace)</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="triggerJob(java.lang.String)"><!-- --></A><H3>
|
|
triggerJob</H3>
|
|
<PRE>
|
|
public <A HREF="../../../org/rundeck/api/domain/RundeckExecution.html" title="class in org.rundeck.api.domain">RundeckExecution</A> <B>triggerJob</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> jobId)
|
|
throws <A HREF="../../../org/rundeck/api/RundeckApiException.html" title="class in org.rundeck.api">RundeckApiException</A>,
|
|
<A HREF="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html" title="class in org.rundeck.api">RundeckApiException.RundeckApiLoginException</A>,
|
|
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></PRE>
|
|
<DL>
|
|
<DD>Trigger the execution of a RunDeck job (identified by the given ID), and return immediately (without waiting the
|
|
end of the job execution)
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>jobId</CODE> - identifier of the job - mandatory
|
|
<DT><B>Returns:</B><DD>a <A HREF="../../../org/rundeck/api/domain/RundeckExecution.html" title="class in org.rundeck.api.domain"><CODE>RundeckExecution</CODE></A> instance for the newly created (and running) execution - won't be null
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE><A HREF="../../../org/rundeck/api/RundeckApiException.html" title="class in org.rundeck.api">RundeckApiException</A></CODE> - in case of error when calling the API (non-existent job with this ID)
|
|
<DD><CODE><A HREF="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html" title="class in org.rundeck.api">RundeckApiException.RundeckApiLoginException</A></CODE> - if the login failed
|
|
<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if the jobId is blank (null, empty or whitespace)<DT><B>See Also:</B><DD><A HREF="../../../org/rundeck/api/RundeckClient.html#triggerJob(java.lang.String, java.util.Properties, java.util.Properties)"><CODE>triggerJob(String, Properties, Properties)</CODE></A>,
|
|
<A HREF="../../../org/rundeck/api/RundeckClient.html#runJob(java.lang.String)"><CODE>runJob(String)</CODE></A></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="triggerJob(java.lang.String, java.util.Properties)"><!-- --></A><H3>
|
|
triggerJob</H3>
|
|
<PRE>
|
|
public <A HREF="../../../org/rundeck/api/domain/RundeckExecution.html" title="class in org.rundeck.api.domain">RundeckExecution</A> <B>triggerJob</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> jobId,
|
|
<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</A> options)
|
|
throws <A HREF="../../../org/rundeck/api/RundeckApiException.html" title="class in org.rundeck.api">RundeckApiException</A>,
|
|
<A HREF="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html" title="class in org.rundeck.api">RundeckApiException.RundeckApiLoginException</A>,
|
|
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></PRE>
|
|
<DL>
|
|
<DD>Trigger the execution of a RunDeck job (identified by the given ID), and return immediately (without waiting the
|
|
end of the job execution)
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>jobId</CODE> - identifier of the job - mandatory<DD><CODE>options</CODE> - of the job - optional. See <A HREF="../../../org/rundeck/api/OptionsBuilder.html" title="class in org.rundeck.api"><CODE>OptionsBuilder</CODE></A>.
|
|
<DT><B>Returns:</B><DD>a <A HREF="../../../org/rundeck/api/domain/RundeckExecution.html" title="class in org.rundeck.api.domain"><CODE>RundeckExecution</CODE></A> instance for the newly created (and running) execution - won't be null
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE><A HREF="../../../org/rundeck/api/RundeckApiException.html" title="class in org.rundeck.api">RundeckApiException</A></CODE> - in case of error when calling the API (non-existent job with this ID)
|
|
<DD><CODE><A HREF="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html" title="class in org.rundeck.api">RundeckApiException.RundeckApiLoginException</A></CODE> - if the login failed
|
|
<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if the jobId is blank (null, empty or whitespace)<DT><B>See Also:</B><DD><A HREF="../../../org/rundeck/api/RundeckClient.html#triggerJob(java.lang.String, java.util.Properties, java.util.Properties)"><CODE>triggerJob(String, Properties, Properties)</CODE></A>,
|
|
<A HREF="../../../org/rundeck/api/RundeckClient.html#runJob(java.lang.String, java.util.Properties)"><CODE>runJob(String, Properties)</CODE></A></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="triggerJob(java.lang.String, java.util.Properties, java.util.Properties)"><!-- --></A><H3>
|
|
triggerJob</H3>
|
|
<PRE>
|
|
public <A HREF="../../../org/rundeck/api/domain/RundeckExecution.html" title="class in org.rundeck.api.domain">RundeckExecution</A> <B>triggerJob</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> jobId,
|
|
<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</A> options,
|
|
<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</A> nodeFilters)
|
|
throws <A HREF="../../../org/rundeck/api/RundeckApiException.html" title="class in org.rundeck.api">RundeckApiException</A>,
|
|
<A HREF="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html" title="class in org.rundeck.api">RundeckApiException.RundeckApiLoginException</A>,
|
|
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></PRE>
|
|
<DL>
|
|
<DD>Trigger the execution of a RunDeck job (identified by the given ID), and return immediately (without waiting the
|
|
end of the job execution)
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>jobId</CODE> - identifier of the job - mandatory<DD><CODE>options</CODE> - of the job - optional. See <A HREF="../../../org/rundeck/api/OptionsBuilder.html" title="class in org.rundeck.api"><CODE>OptionsBuilder</CODE></A>.<DD><CODE>nodeFilters</CODE> - for overriding the nodes on which the job will be executed - optional. See
|
|
<A HREF="../../../org/rundeck/api/NodeFiltersBuilder.html" title="class in org.rundeck.api"><CODE>NodeFiltersBuilder</CODE></A>
|
|
<DT><B>Returns:</B><DD>a <A HREF="../../../org/rundeck/api/domain/RundeckExecution.html" title="class in org.rundeck.api.domain"><CODE>RundeckExecution</CODE></A> instance for the newly created (and running) execution - won't be null
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE><A HREF="../../../org/rundeck/api/RundeckApiException.html" title="class in org.rundeck.api">RundeckApiException</A></CODE> - in case of error when calling the API (non-existent job with this ID)
|
|
<DD><CODE><A HREF="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html" title="class in org.rundeck.api">RundeckApiException.RundeckApiLoginException</A></CODE> - if the login failed
|
|
<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if the jobId is blank (null, empty or whitespace)<DT><B>See Also:</B><DD><A HREF="../../../org/rundeck/api/RundeckClient.html#triggerJob(java.lang.String)"><CODE>triggerJob(String)</CODE></A>,
|
|
<A HREF="../../../org/rundeck/api/RundeckClient.html#runJob(java.lang.String, java.util.Properties, java.util.Properties)"><CODE>runJob(String, Properties, Properties)</CODE></A></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="runJob(java.lang.String)"><!-- --></A><H3>
|
|
runJob</H3>
|
|
<PRE>
|
|
public <A HREF="../../../org/rundeck/api/domain/RundeckExecution.html" title="class in org.rundeck.api.domain">RundeckExecution</A> <B>runJob</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> jobId)
|
|
throws <A HREF="../../../org/rundeck/api/RundeckApiException.html" title="class in org.rundeck.api">RundeckApiException</A>,
|
|
<A HREF="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html" title="class in org.rundeck.api">RundeckApiException.RundeckApiLoginException</A>,
|
|
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></PRE>
|
|
<DL>
|
|
<DD>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>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>jobId</CODE> - identifier of the job - mandatory
|
|
<DT><B>Returns:</B><DD>a <A HREF="../../../org/rundeck/api/domain/RundeckExecution.html" title="class in org.rundeck.api.domain"><CODE>RundeckExecution</CODE></A> instance for the (finished/aborted) execution - won't be null
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE><A HREF="../../../org/rundeck/api/RundeckApiException.html" title="class in org.rundeck.api">RundeckApiException</A></CODE> - in case of error when calling the API (non-existent job with this ID)
|
|
<DD><CODE><A HREF="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html" title="class in org.rundeck.api">RundeckApiException.RundeckApiLoginException</A></CODE> - if the login failed
|
|
<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if the jobId is blank (null, empty or whitespace)<DT><B>See Also:</B><DD><A HREF="../../../org/rundeck/api/RundeckClient.html#triggerJob(java.lang.String)"><CODE>triggerJob(String)</CODE></A>,
|
|
<A HREF="../../../org/rundeck/api/RundeckClient.html#runJob(java.lang.String, java.util.Properties, java.util.Properties, long, java.util.concurrent.TimeUnit)"><CODE>runJob(String, Properties, Properties, long, TimeUnit)</CODE></A></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="runJob(java.lang.String, java.util.Properties)"><!-- --></A><H3>
|
|
runJob</H3>
|
|
<PRE>
|
|
public <A HREF="../../../org/rundeck/api/domain/RundeckExecution.html" title="class in org.rundeck.api.domain">RundeckExecution</A> <B>runJob</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> jobId,
|
|
<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</A> options)
|
|
throws <A HREF="../../../org/rundeck/api/RundeckApiException.html" title="class in org.rundeck.api">RundeckApiException</A>,
|
|
<A HREF="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html" title="class in org.rundeck.api">RundeckApiException.RundeckApiLoginException</A>,
|
|
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></PRE>
|
|
<DL>
|
|
<DD>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>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>jobId</CODE> - identifier of the job - mandatory<DD><CODE>options</CODE> - of the job - optional. See <A HREF="../../../org/rundeck/api/OptionsBuilder.html" title="class in org.rundeck.api"><CODE>OptionsBuilder</CODE></A>.
|
|
<DT><B>Returns:</B><DD>a <A HREF="../../../org/rundeck/api/domain/RundeckExecution.html" title="class in org.rundeck.api.domain"><CODE>RundeckExecution</CODE></A> instance for the (finished/aborted) execution - won't be null
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE><A HREF="../../../org/rundeck/api/RundeckApiException.html" title="class in org.rundeck.api">RundeckApiException</A></CODE> - in case of error when calling the API (non-existent job with this ID)
|
|
<DD><CODE><A HREF="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html" title="class in org.rundeck.api">RundeckApiException.RundeckApiLoginException</A></CODE> - if the login failed
|
|
<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if the jobId is blank (null, empty or whitespace)<DT><B>See Also:</B><DD><A HREF="../../../org/rundeck/api/RundeckClient.html#triggerJob(java.lang.String, java.util.Properties)"><CODE>triggerJob(String, Properties)</CODE></A>,
|
|
<A HREF="../../../org/rundeck/api/RundeckClient.html#runJob(java.lang.String, java.util.Properties, java.util.Properties, long, java.util.concurrent.TimeUnit)"><CODE>runJob(String, Properties, Properties, long, TimeUnit)</CODE></A></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="runJob(java.lang.String, java.util.Properties, java.util.Properties)"><!-- --></A><H3>
|
|
runJob</H3>
|
|
<PRE>
|
|
public <A HREF="../../../org/rundeck/api/domain/RundeckExecution.html" title="class in org.rundeck.api.domain">RundeckExecution</A> <B>runJob</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> jobId,
|
|
<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</A> options,
|
|
<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</A> nodeFilters)
|
|
throws <A HREF="../../../org/rundeck/api/RundeckApiException.html" title="class in org.rundeck.api">RundeckApiException</A>,
|
|
<A HREF="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html" title="class in org.rundeck.api">RundeckApiException.RundeckApiLoginException</A>,
|
|
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></PRE>
|
|
<DL>
|
|
<DD>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>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>jobId</CODE> - identifier of the job - mandatory<DD><CODE>options</CODE> - of the job - optional. See <A HREF="../../../org/rundeck/api/OptionsBuilder.html" title="class in org.rundeck.api"><CODE>OptionsBuilder</CODE></A>.<DD><CODE>nodeFilters</CODE> - for overriding the nodes on which the job will be executed - optional. See
|
|
<A HREF="../../../org/rundeck/api/NodeFiltersBuilder.html" title="class in org.rundeck.api"><CODE>NodeFiltersBuilder</CODE></A>
|
|
<DT><B>Returns:</B><DD>a <A HREF="../../../org/rundeck/api/domain/RundeckExecution.html" title="class in org.rundeck.api.domain"><CODE>RundeckExecution</CODE></A> instance for the (finished/aborted) execution - won't be null
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE><A HREF="../../../org/rundeck/api/RundeckApiException.html" title="class in org.rundeck.api">RundeckApiException</A></CODE> - in case of error when calling the API (non-existent job with this ID)
|
|
<DD><CODE><A HREF="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html" title="class in org.rundeck.api">RundeckApiException.RundeckApiLoginException</A></CODE> - if the login failed
|
|
<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if the jobId is blank (null, empty or whitespace)<DT><B>See Also:</B><DD><A HREF="../../../org/rundeck/api/RundeckClient.html#triggerJob(java.lang.String, java.util.Properties, java.util.Properties)"><CODE>triggerJob(String, Properties, Properties)</CODE></A>,
|
|
<A HREF="../../../org/rundeck/api/RundeckClient.html#runJob(java.lang.String, java.util.Properties, java.util.Properties, long, java.util.concurrent.TimeUnit)"><CODE>runJob(String, Properties, Properties, long, TimeUnit)</CODE></A></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="runJob(java.lang.String, java.util.Properties, long, java.util.concurrent.TimeUnit)"><!-- --></A><H3>
|
|
runJob</H3>
|
|
<PRE>
|
|
public <A HREF="../../../org/rundeck/api/domain/RundeckExecution.html" title="class in org.rundeck.api.domain">RundeckExecution</A> <B>runJob</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> jobId,
|
|
<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</A> options,
|
|
long poolingInterval,
|
|
<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent">TimeUnit</A> poolingUnit)
|
|
throws <A HREF="../../../org/rundeck/api/RundeckApiException.html" title="class in org.rundeck.api">RundeckApiException</A>,
|
|
<A HREF="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html" title="class in org.rundeck.api">RundeckApiException.RundeckApiLoginException</A>,
|
|
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></PRE>
|
|
<DL>
|
|
<DD>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>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>jobId</CODE> - identifier of the job - mandatory<DD><CODE>options</CODE> - of the job - optional. See <A HREF="../../../org/rundeck/api/OptionsBuilder.html" title="class in org.rundeck.api"><CODE>OptionsBuilder</CODE></A>.<DD><CODE>poolingInterval</CODE> - for checking the status of the execution. Must be > 0.<DD><CODE>poolingUnit</CODE> - unit (seconds, milli-seconds, ...) of the interval. Default to seconds.
|
|
<DT><B>Returns:</B><DD>a <A HREF="../../../org/rundeck/api/domain/RundeckExecution.html" title="class in org.rundeck.api.domain"><CODE>RundeckExecution</CODE></A> instance for the (finished/aborted) execution - won't be null
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE><A HREF="../../../org/rundeck/api/RundeckApiException.html" title="class in org.rundeck.api">RundeckApiException</A></CODE> - in case of error when calling the API (non-existent job with this ID)
|
|
<DD><CODE><A HREF="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html" title="class in org.rundeck.api">RundeckApiException.RundeckApiLoginException</A></CODE> - if the login failed
|
|
<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if the jobId is blank (null, empty or whitespace)<DT><B>See Also:</B><DD><A HREF="../../../org/rundeck/api/RundeckClient.html#triggerJob(java.lang.String, java.util.Properties)"><CODE>triggerJob(String, Properties)</CODE></A>,
|
|
<A HREF="../../../org/rundeck/api/RundeckClient.html#runJob(java.lang.String, java.util.Properties, java.util.Properties, long, java.util.concurrent.TimeUnit)"><CODE>runJob(String, Properties, Properties, long, TimeUnit)</CODE></A></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="runJob(java.lang.String, java.util.Properties, java.util.Properties, long, java.util.concurrent.TimeUnit)"><!-- --></A><H3>
|
|
runJob</H3>
|
|
<PRE>
|
|
public <A HREF="../../../org/rundeck/api/domain/RundeckExecution.html" title="class in org.rundeck.api.domain">RundeckExecution</A> <B>runJob</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> jobId,
|
|
<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</A> options,
|
|
<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</A> nodeFilters,
|
|
long poolingInterval,
|
|
<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent">TimeUnit</A> poolingUnit)
|
|
throws <A HREF="../../../org/rundeck/api/RundeckApiException.html" title="class in org.rundeck.api">RundeckApiException</A>,
|
|
<A HREF="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html" title="class in org.rundeck.api">RundeckApiException.RundeckApiLoginException</A>,
|
|
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></PRE>
|
|
<DL>
|
|
<DD>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>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>jobId</CODE> - identifier of the job - mandatory<DD><CODE>options</CODE> - of the job - optional. See <A HREF="../../../org/rundeck/api/OptionsBuilder.html" title="class in org.rundeck.api"><CODE>OptionsBuilder</CODE></A>.<DD><CODE>nodeFilters</CODE> - for overriding the nodes on which the job will be executed - optional. See
|
|
<A HREF="../../../org/rundeck/api/NodeFiltersBuilder.html" title="class in org.rundeck.api"><CODE>NodeFiltersBuilder</CODE></A><DD><CODE>poolingInterval</CODE> - for checking the status of the execution. Must be > 0.<DD><CODE>poolingUnit</CODE> - unit (seconds, milli-seconds, ...) of the interval. Default to seconds.
|
|
<DT><B>Returns:</B><DD>a <A HREF="../../../org/rundeck/api/domain/RundeckExecution.html" title="class in org.rundeck.api.domain"><CODE>RundeckExecution</CODE></A> instance for the (finished/aborted) execution - won't be null
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE><A HREF="../../../org/rundeck/api/RundeckApiException.html" title="class in org.rundeck.api">RundeckApiException</A></CODE> - in case of error when calling the API (non-existent job with this ID)
|
|
<DD><CODE><A HREF="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html" title="class in org.rundeck.api">RundeckApiException.RundeckApiLoginException</A></CODE> - if the login failed
|
|
<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if the jobId is blank (null, empty or whitespace)<DT><B>See Also:</B><DD><A HREF="../../../org/rundeck/api/RundeckClient.html#triggerJob(java.lang.String, java.util.Properties)"><CODE>triggerJob(String, Properties)</CODE></A>,
|
|
<A HREF="../../../org/rundeck/api/RundeckClient.html#runJob(java.lang.String, java.util.Properties, java.util.Properties, long, java.util.concurrent.TimeUnit)"><CODE>runJob(String, Properties, Properties, long, TimeUnit)</CODE></A></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="triggerAdhocCommand(java.lang.String, java.lang.String)"><!-- --></A><H3>
|
|
triggerAdhocCommand</H3>
|
|
<PRE>
|
|
public <A HREF="../../../org/rundeck/api/domain/RundeckExecution.html" title="class in org.rundeck.api.domain">RundeckExecution</A> <B>triggerAdhocCommand</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> project,
|
|
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> command)
|
|
throws <A HREF="../../../org/rundeck/api/RundeckApiException.html" title="class in org.rundeck.api">RundeckApiException</A>,
|
|
<A HREF="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html" title="class in org.rundeck.api">RundeckApiException.RundeckApiLoginException</A>,
|
|
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></PRE>
|
|
<DL>
|
|
<DD>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>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>project</CODE> - name of the project - mandatory<DD><CODE>command</CODE> - to be executed - mandatory
|
|
<DT><B>Returns:</B><DD>a <A HREF="../../../org/rundeck/api/domain/RundeckExecution.html" title="class in org.rundeck.api.domain"><CODE>RundeckExecution</CODE></A> instance for the newly created (and running) execution - won't be null
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE><A HREF="../../../org/rundeck/api/RundeckApiException.html" title="class in org.rundeck.api">RundeckApiException</A></CODE> - in case of error when calling the API (non-existent project with this name)
|
|
<DD><CODE><A HREF="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html" title="class in org.rundeck.api">RundeckApiException.RundeckApiLoginException</A></CODE> - if the login failed
|
|
<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if the project or command is blank (null, empty or whitespace)<DT><B>See Also:</B><DD><A HREF="../../../org/rundeck/api/RundeckClient.html#triggerAdhocCommand(java.lang.String, java.lang.String, java.util.Properties)"><CODE>triggerAdhocCommand(String, String, Properties)</CODE></A>,
|
|
<A HREF="../../../org/rundeck/api/RundeckClient.html#runAdhocCommand(java.lang.String, java.lang.String)"><CODE>runAdhocCommand(String, String)</CODE></A></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="triggerAdhocCommand(java.lang.String, java.lang.String, java.util.Properties)"><!-- --></A><H3>
|
|
triggerAdhocCommand</H3>
|
|
<PRE>
|
|
public <A HREF="../../../org/rundeck/api/domain/RundeckExecution.html" title="class in org.rundeck.api.domain">RundeckExecution</A> <B>triggerAdhocCommand</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> project,
|
|
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> command,
|
|
<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</A> nodeFilters)
|
|
throws <A HREF="../../../org/rundeck/api/RundeckApiException.html" title="class in org.rundeck.api">RundeckApiException</A>,
|
|
<A HREF="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html" title="class in org.rundeck.api">RundeckApiException.RundeckApiLoginException</A>,
|
|
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></PRE>
|
|
<DL>
|
|
<DD>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>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>project</CODE> - name of the project - mandatory<DD><CODE>command</CODE> - to be executed - mandatory<DD><CODE>nodeFilters</CODE> - for selecting nodes on which the command will be executed. See <A HREF="../../../org/rundeck/api/NodeFiltersBuilder.html" title="class in org.rundeck.api"><CODE>NodeFiltersBuilder</CODE></A>
|
|
<DT><B>Returns:</B><DD>a <A HREF="../../../org/rundeck/api/domain/RundeckExecution.html" title="class in org.rundeck.api.domain"><CODE>RundeckExecution</CODE></A> instance for the newly created (and running) execution - won't be null
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE><A HREF="../../../org/rundeck/api/RundeckApiException.html" title="class in org.rundeck.api">RundeckApiException</A></CODE> - in case of error when calling the API (non-existent project with this name)
|
|
<DD><CODE><A HREF="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html" title="class in org.rundeck.api">RundeckApiException.RundeckApiLoginException</A></CODE> - if the login failed
|
|
<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if the project or command is blank (null, empty or whitespace)<DT><B>See Also:</B><DD><A HREF="../../../org/rundeck/api/RundeckClient.html#triggerAdhocCommand(java.lang.String, java.lang.String)"><CODE>triggerAdhocCommand(String, String)</CODE></A>,
|
|
<A HREF="../../../org/rundeck/api/RundeckClient.html#runAdhocCommand(java.lang.String, java.lang.String, java.util.Properties)"><CODE>runAdhocCommand(String, String, Properties)</CODE></A></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="runAdhocCommand(java.lang.String, java.lang.String)"><!-- --></A><H3>
|
|
runAdhocCommand</H3>
|
|
<PRE>
|
|
public <A HREF="../../../org/rundeck/api/domain/RundeckExecution.html" title="class in org.rundeck.api.domain">RundeckExecution</A> <B>runAdhocCommand</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> project,
|
|
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> command)
|
|
throws <A HREF="../../../org/rundeck/api/RundeckApiException.html" title="class in org.rundeck.api">RundeckApiException</A>,
|
|
<A HREF="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html" title="class in org.rundeck.api">RundeckApiException.RundeckApiLoginException</A>,
|
|
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></PRE>
|
|
<DL>
|
|
<DD>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>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>project</CODE> - name of the project - mandatory<DD><CODE>command</CODE> - to be executed - mandatory
|
|
<DT><B>Returns:</B><DD>a <A HREF="../../../org/rundeck/api/domain/RundeckExecution.html" title="class in org.rundeck.api.domain"><CODE>RundeckExecution</CODE></A> instance for the (finished/aborted) execution - won't be null
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE><A HREF="../../../org/rundeck/api/RundeckApiException.html" title="class in org.rundeck.api">RundeckApiException</A></CODE> - in case of error when calling the API (non-existent project with this name)
|
|
<DD><CODE><A HREF="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html" title="class in org.rundeck.api">RundeckApiException.RundeckApiLoginException</A></CODE> - if the login failed
|
|
<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if the project or command is blank (null, empty or whitespace)<DT><B>See Also:</B><DD><A HREF="../../../org/rundeck/api/RundeckClient.html#runAdhocCommand(java.lang.String, java.lang.String, java.util.Properties, long, java.util.concurrent.TimeUnit)"><CODE>runAdhocCommand(String, String, Properties, long, TimeUnit)</CODE></A>,
|
|
<A HREF="../../../org/rundeck/api/RundeckClient.html#triggerAdhocCommand(java.lang.String, java.lang.String)"><CODE>triggerAdhocCommand(String, String)</CODE></A></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="runAdhocCommand(java.lang.String, java.lang.String, long, java.util.concurrent.TimeUnit)"><!-- --></A><H3>
|
|
runAdhocCommand</H3>
|
|
<PRE>
|
|
public <A HREF="../../../org/rundeck/api/domain/RundeckExecution.html" title="class in org.rundeck.api.domain">RundeckExecution</A> <B>runAdhocCommand</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> project,
|
|
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> command,
|
|
long poolingInterval,
|
|
<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent">TimeUnit</A> poolingUnit)
|
|
throws <A HREF="../../../org/rundeck/api/RundeckApiException.html" title="class in org.rundeck.api">RundeckApiException</A>,
|
|
<A HREF="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html" title="class in org.rundeck.api">RundeckApiException.RundeckApiLoginException</A>,
|
|
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></PRE>
|
|
<DL>
|
|
<DD>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>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>project</CODE> - name of the project - mandatory<DD><CODE>command</CODE> - to be executed - mandatory<DD><CODE>poolingInterval</CODE> - for checking the status of the execution. Must be > 0.<DD><CODE>poolingUnit</CODE> - unit (seconds, milli-seconds, ...) of the interval. Default to seconds.
|
|
<DT><B>Returns:</B><DD>a <A HREF="../../../org/rundeck/api/domain/RundeckExecution.html" title="class in org.rundeck.api.domain"><CODE>RundeckExecution</CODE></A> instance for the (finished/aborted) execution - won't be null
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE><A HREF="../../../org/rundeck/api/RundeckApiException.html" title="class in org.rundeck.api">RundeckApiException</A></CODE> - in case of error when calling the API (non-existent project with this name)
|
|
<DD><CODE><A HREF="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html" title="class in org.rundeck.api">RundeckApiException.RundeckApiLoginException</A></CODE> - if the login failed
|
|
<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if the project or command is blank (null, empty or whitespace)<DT><B>See Also:</B><DD><A HREF="../../../org/rundeck/api/RundeckClient.html#runAdhocCommand(java.lang.String, java.lang.String, java.util.Properties, long, java.util.concurrent.TimeUnit)"><CODE>runAdhocCommand(String, String, Properties, long, TimeUnit)</CODE></A>,
|
|
<A HREF="../../../org/rundeck/api/RundeckClient.html#triggerAdhocCommand(java.lang.String, java.lang.String)"><CODE>triggerAdhocCommand(String, String)</CODE></A></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="runAdhocCommand(java.lang.String, java.lang.String, java.util.Properties)"><!-- --></A><H3>
|
|
runAdhocCommand</H3>
|
|
<PRE>
|
|
public <A HREF="../../../org/rundeck/api/domain/RundeckExecution.html" title="class in org.rundeck.api.domain">RundeckExecution</A> <B>runAdhocCommand</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> project,
|
|
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> command,
|
|
<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</A> nodeFilters)
|
|
throws <A HREF="../../../org/rundeck/api/RundeckApiException.html" title="class in org.rundeck.api">RundeckApiException</A>,
|
|
<A HREF="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html" title="class in org.rundeck.api">RundeckApiException.RundeckApiLoginException</A>,
|
|
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></PRE>
|
|
<DL>
|
|
<DD>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>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>project</CODE> - name of the project - mandatory<DD><CODE>command</CODE> - to be executed - mandatory<DD><CODE>nodeFilters</CODE> - for selecting nodes on which the command will be executed. See <A HREF="../../../org/rundeck/api/NodeFiltersBuilder.html" title="class in org.rundeck.api"><CODE>NodeFiltersBuilder</CODE></A>
|
|
<DT><B>Returns:</B><DD>a <A HREF="../../../org/rundeck/api/domain/RundeckExecution.html" title="class in org.rundeck.api.domain"><CODE>RundeckExecution</CODE></A> instance for the (finished/aborted) execution - won't be null
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE><A HREF="../../../org/rundeck/api/RundeckApiException.html" title="class in org.rundeck.api">RundeckApiException</A></CODE> - in case of error when calling the API (non-existent project with this name)
|
|
<DD><CODE><A HREF="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html" title="class in org.rundeck.api">RundeckApiException.RundeckApiLoginException</A></CODE> - if the login failed
|
|
<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if the project or command is blank (null, empty or whitespace)<DT><B>See Also:</B><DD><A HREF="../../../org/rundeck/api/RundeckClient.html#runAdhocCommand(java.lang.String, java.lang.String, java.util.Properties, long, java.util.concurrent.TimeUnit)"><CODE>runAdhocCommand(String, String, Properties, long, TimeUnit)</CODE></A>,
|
|
<A HREF="../../../org/rundeck/api/RundeckClient.html#triggerAdhocCommand(java.lang.String, java.lang.String, java.util.Properties)"><CODE>triggerAdhocCommand(String, String, Properties)</CODE></A></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="runAdhocCommand(java.lang.String, java.lang.String, java.util.Properties, long, java.util.concurrent.TimeUnit)"><!-- --></A><H3>
|
|
runAdhocCommand</H3>
|
|
<PRE>
|
|
public <A HREF="../../../org/rundeck/api/domain/RundeckExecution.html" title="class in org.rundeck.api.domain">RundeckExecution</A> <B>runAdhocCommand</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> project,
|
|
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> command,
|
|
<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</A> nodeFilters,
|
|
long poolingInterval,
|
|
<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent">TimeUnit</A> poolingUnit)
|
|
throws <A HREF="../../../org/rundeck/api/RundeckApiException.html" title="class in org.rundeck.api">RundeckApiException</A>,
|
|
<A HREF="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html" title="class in org.rundeck.api">RundeckApiException.RundeckApiLoginException</A>,
|
|
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></PRE>
|
|
<DL>
|
|
<DD>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>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>project</CODE> - name of the project - mandatory<DD><CODE>command</CODE> - to be executed - mandatory<DD><CODE>nodeFilters</CODE> - for selecting nodes on which the command will be executed. See <A HREF="../../../org/rundeck/api/NodeFiltersBuilder.html" title="class in org.rundeck.api"><CODE>NodeFiltersBuilder</CODE></A><DD><CODE>poolingInterval</CODE> - for checking the status of the execution. Must be > 0.<DD><CODE>poolingUnit</CODE> - unit (seconds, milli-seconds, ...) of the interval. Default to seconds.
|
|
<DT><B>Returns:</B><DD>a <A HREF="../../../org/rundeck/api/domain/RundeckExecution.html" title="class in org.rundeck.api.domain"><CODE>RundeckExecution</CODE></A> instance for the (finished/aborted) execution - won't be null
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE><A HREF="../../../org/rundeck/api/RundeckApiException.html" title="class in org.rundeck.api">RundeckApiException</A></CODE> - in case of error when calling the API (non-existent project with this name)
|
|
<DD><CODE><A HREF="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html" title="class in org.rundeck.api">RundeckApiException.RundeckApiLoginException</A></CODE> - if the login failed
|
|
<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if the project or command is blank (null, empty or whitespace)<DT><B>See Also:</B><DD><A HREF="../../../org/rundeck/api/RundeckClient.html#triggerAdhocCommand(java.lang.String, java.lang.String, java.util.Properties)"><CODE>triggerAdhocCommand(String, String, Properties)</CODE></A></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getRunningExecutions()"><!-- --></A><H3>
|
|
getRunningExecutions</H3>
|
|
<PRE>
|
|
public <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="../../../org/rundeck/api/domain/RundeckExecution.html" title="class in org.rundeck.api.domain">RundeckExecution</A>> <B>getRunningExecutions</B>()
|
|
throws <A HREF="../../../org/rundeck/api/RundeckApiException.html" title="class in org.rundeck.api">RundeckApiException</A>,
|
|
<A HREF="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html" title="class in org.rundeck.api">RundeckApiException.RundeckApiLoginException</A></PRE>
|
|
<DL>
|
|
<DD>Get all running executions (for all projects)
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>a <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util"><CODE>List</CODE></A> of <A HREF="../../../org/rundeck/api/domain/RundeckExecution.html" title="class in org.rundeck.api.domain"><CODE>RundeckExecution</CODE></A> : might be empty, but won't be null
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE><A HREF="../../../org/rundeck/api/RundeckApiException.html" title="class in org.rundeck.api">RundeckApiException</A></CODE> - in case of error when calling the API
|
|
<DD><CODE><A HREF="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html" title="class in org.rundeck.api">RundeckApiException.RundeckApiLoginException</A></CODE> - if the login failed</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getRunningExecutions(java.lang.String)"><!-- --></A><H3>
|
|
getRunningExecutions</H3>
|
|
<PRE>
|
|
public <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="../../../org/rundeck/api/domain/RundeckExecution.html" title="class in org.rundeck.api.domain">RundeckExecution</A>> <B>getRunningExecutions</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> project)
|
|
throws <A HREF="../../../org/rundeck/api/RundeckApiException.html" title="class in org.rundeck.api">RundeckApiException</A>,
|
|
<A HREF="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html" title="class in org.rundeck.api">RundeckApiException.RundeckApiLoginException</A>,
|
|
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></PRE>
|
|
<DL>
|
|
<DD>Get the running executions for the given project
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>project</CODE> - name of the project - mandatory
|
|
<DT><B>Returns:</B><DD>a <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util"><CODE>List</CODE></A> of <A HREF="../../../org/rundeck/api/domain/RundeckExecution.html" title="class in org.rundeck.api.domain"><CODE>RundeckExecution</CODE></A> : might be empty, but won't be null
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE><A HREF="../../../org/rundeck/api/RundeckApiException.html" title="class in org.rundeck.api">RundeckApiException</A></CODE> - in case of error when calling the API (non-existent project with this name)
|
|
<DD><CODE><A HREF="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html" title="class in org.rundeck.api">RundeckApiException.RundeckApiLoginException</A></CODE> - if the login failed
|
|
<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if the project is blank (null, empty or whitespace)</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getJobExecutions(java.lang.String)"><!-- --></A><H3>
|
|
getJobExecutions</H3>
|
|
<PRE>
|
|
public <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="../../../org/rundeck/api/domain/RundeckExecution.html" title="class in org.rundeck.api.domain">RundeckExecution</A>> <B>getJobExecutions</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> jobId)
|
|
throws <A HREF="../../../org/rundeck/api/RundeckApiException.html" title="class in org.rundeck.api">RundeckApiException</A>,
|
|
<A HREF="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html" title="class in org.rundeck.api">RundeckApiException.RundeckApiLoginException</A>,
|
|
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></PRE>
|
|
<DL>
|
|
<DD>Get the executions of the given job
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>jobId</CODE> - identifier of the job - mandatory
|
|
<DT><B>Returns:</B><DD>a <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util"><CODE>List</CODE></A> of <A HREF="../../../org/rundeck/api/domain/RundeckExecution.html" title="class in org.rundeck.api.domain"><CODE>RundeckExecution</CODE></A> : might be empty, but won't be null
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE><A HREF="../../../org/rundeck/api/RundeckApiException.html" title="class in org.rundeck.api">RundeckApiException</A></CODE> - in case of error when calling the API (non-existent job with this ID)
|
|
<DD><CODE><A HREF="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html" title="class in org.rundeck.api">RundeckApiException.RundeckApiLoginException</A></CODE> - if the login failed
|
|
<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if the jobId is blank (null, empty or whitespace)</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getJobExecutions(java.lang.String, org.rundeck.api.domain.RundeckExecution.ExecutionStatus)"><!-- --></A><H3>
|
|
getJobExecutions</H3>
|
|
<PRE>
|
|
public <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="../../../org/rundeck/api/domain/RundeckExecution.html" title="class in org.rundeck.api.domain">RundeckExecution</A>> <B>getJobExecutions</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> jobId,
|
|
<A HREF="../../../org/rundeck/api/domain/RundeckExecution.ExecutionStatus.html" title="enum in org.rundeck.api.domain">RundeckExecution.ExecutionStatus</A> status)
|
|
throws <A HREF="../../../org/rundeck/api/RundeckApiException.html" title="class in org.rundeck.api">RundeckApiException</A>,
|
|
<A HREF="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html" title="class in org.rundeck.api">RundeckApiException.RundeckApiLoginException</A>,
|
|
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></PRE>
|
|
<DL>
|
|
<DD>Get the executions of the given job
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>jobId</CODE> - identifier of the job - mandatory<DD><CODE>status</CODE> - of the executions - optional (null for all)
|
|
<DT><B>Returns:</B><DD>a <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util"><CODE>List</CODE></A> of <A HREF="../../../org/rundeck/api/domain/RundeckExecution.html" title="class in org.rundeck.api.domain"><CODE>RundeckExecution</CODE></A> : might be empty, but won't be null
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE><A HREF="../../../org/rundeck/api/RundeckApiException.html" title="class in org.rundeck.api">RundeckApiException</A></CODE> - in case of error when calling the API (non-existent job with this ID)
|
|
<DD><CODE><A HREF="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html" title="class in org.rundeck.api">RundeckApiException.RundeckApiLoginException</A></CODE> - if the login failed
|
|
<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if the jobId is blank (null, empty or whitespace)</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getJobExecutions(java.lang.String, org.rundeck.api.domain.RundeckExecution.ExecutionStatus, java.lang.Long, java.lang.Long)"><!-- --></A><H3>
|
|
getJobExecutions</H3>
|
|
<PRE>
|
|
public <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="../../../org/rundeck/api/domain/RundeckExecution.html" title="class in org.rundeck.api.domain">RundeckExecution</A>> <B>getJobExecutions</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> jobId,
|
|
<A HREF="../../../org/rundeck/api/domain/RundeckExecution.ExecutionStatus.html" title="enum in org.rundeck.api.domain">RundeckExecution.ExecutionStatus</A> status,
|
|
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</A> max,
|
|
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</A> offset)
|
|
throws <A HREF="../../../org/rundeck/api/RundeckApiException.html" title="class in org.rundeck.api">RundeckApiException</A>,
|
|
<A HREF="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html" title="class in org.rundeck.api">RundeckApiException.RundeckApiLoginException</A>,
|
|
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></PRE>
|
|
<DL>
|
|
<DD>Get the executions of the given job
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>jobId</CODE> - identifier of the job - mandatory<DD><CODE>status</CODE> - of the executions - optional (null for all)<DD><CODE>max</CODE> - number of results to return - optional (null for all)<DD><CODE>offset</CODE> - the 0-indexed offset for the first result to return - optional
|
|
<DT><B>Returns:</B><DD>a <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util"><CODE>List</CODE></A> of <A HREF="../../../org/rundeck/api/domain/RundeckExecution.html" title="class in org.rundeck.api.domain"><CODE>RundeckExecution</CODE></A> : might be empty, but won't be null
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE><A HREF="../../../org/rundeck/api/RundeckApiException.html" title="class in org.rundeck.api">RundeckApiException</A></CODE> - in case of error when calling the API (non-existent job with this ID)
|
|
<DD><CODE><A HREF="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html" title="class in org.rundeck.api">RundeckApiException.RundeckApiLoginException</A></CODE> - if the login failed
|
|
<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if the jobId is blank (null, empty or whitespace)</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getExecution(java.lang.Long)"><!-- --></A><H3>
|
|
getExecution</H3>
|
|
<PRE>
|
|
public <A HREF="../../../org/rundeck/api/domain/RundeckExecution.html" title="class in org.rundeck.api.domain">RundeckExecution</A> <B>getExecution</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</A> executionId)
|
|
throws <A HREF="../../../org/rundeck/api/RundeckApiException.html" title="class in org.rundeck.api">RundeckApiException</A>,
|
|
<A HREF="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html" title="class in org.rundeck.api">RundeckApiException.RundeckApiLoginException</A>,
|
|
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></PRE>
|
|
<DL>
|
|
<DD>Get a single execution, identified by the given ID
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>executionId</CODE> - identifier of the execution - mandatory
|
|
<DT><B>Returns:</B><DD>a <A HREF="../../../org/rundeck/api/domain/RundeckExecution.html" title="class in org.rundeck.api.domain"><CODE>RundeckExecution</CODE></A> instance - won't be null
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE><A HREF="../../../org/rundeck/api/RundeckApiException.html" title="class in org.rundeck.api">RundeckApiException</A></CODE> - in case of error when calling the API (non-existent execution with this ID)
|
|
<DD><CODE><A HREF="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html" title="class in org.rundeck.api">RundeckApiException.RundeckApiLoginException</A></CODE> - if the login failed
|
|
<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if the executionId is null</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="abortExecution(java.lang.Long)"><!-- --></A><H3>
|
|
abortExecution</H3>
|
|
<PRE>
|
|
public <A HREF="../../../org/rundeck/api/domain/RundeckAbort.html" title="class in org.rundeck.api.domain">RundeckAbort</A> <B>abortExecution</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</A> executionId)
|
|
throws <A HREF="../../../org/rundeck/api/RundeckApiException.html" title="class in org.rundeck.api">RundeckApiException</A>,
|
|
<A HREF="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html" title="class in org.rundeck.api">RundeckApiException.RundeckApiLoginException</A>,
|
|
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></PRE>
|
|
<DL>
|
|
<DD>Abort an execution (identified by the given ID). The execution should be running...
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>executionId</CODE> - identifier of the execution - mandatory
|
|
<DT><B>Returns:</B><DD>a <A HREF="../../../org/rundeck/api/domain/RundeckAbort.html" title="class in org.rundeck.api.domain"><CODE>RundeckAbort</CODE></A> instance - won't be null
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE><A HREF="../../../org/rundeck/api/RundeckApiException.html" title="class in org.rundeck.api">RundeckApiException</A></CODE> - in case of error when calling the API (non-existent execution with this ID)
|
|
<DD><CODE><A HREF="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html" title="class in org.rundeck.api">RundeckApiException.RundeckApiLoginException</A></CODE> - if the login failed
|
|
<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if the executionId is null</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getNodes()"><!-- --></A><H3>
|
|
getNodes</H3>
|
|
<PRE>
|
|
public <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="../../../org/rundeck/api/domain/RundeckNode.html" title="class in org.rundeck.api.domain">RundeckNode</A>> <B>getNodes</B>()
|
|
throws <A HREF="../../../org/rundeck/api/RundeckApiException.html" title="class in org.rundeck.api">RundeckApiException</A>,
|
|
<A HREF="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html" title="class in org.rundeck.api">RundeckApiException.RundeckApiLoginException</A></PRE>
|
|
<DL>
|
|
<DD>List all nodes (for all projects)
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>a <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util"><CODE>List</CODE></A> of <A HREF="../../../org/rundeck/api/domain/RundeckNode.html" title="class in org.rundeck.api.domain"><CODE>RundeckNode</CODE></A> : might be empty, but won't be null
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE><A HREF="../../../org/rundeck/api/RundeckApiException.html" title="class in org.rundeck.api">RundeckApiException</A></CODE> - in case of error when calling the API
|
|
<DD><CODE><A HREF="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html" title="class in org.rundeck.api">RundeckApiException.RundeckApiLoginException</A></CODE> - if the login failed</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getNodes(java.lang.String)"><!-- --></A><H3>
|
|
getNodes</H3>
|
|
<PRE>
|
|
public <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="../../../org/rundeck/api/domain/RundeckNode.html" title="class in org.rundeck.api.domain">RundeckNode</A>> <B>getNodes</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> project)
|
|
throws <A HREF="../../../org/rundeck/api/RundeckApiException.html" title="class in org.rundeck.api">RundeckApiException</A>,
|
|
<A HREF="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html" title="class in org.rundeck.api">RundeckApiException.RundeckApiLoginException</A>,
|
|
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></PRE>
|
|
<DL>
|
|
<DD>List all nodes that belongs to the given project
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>project</CODE> - name of the project - mandatory
|
|
<DT><B>Returns:</B><DD>a <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util"><CODE>List</CODE></A> of <A HREF="../../../org/rundeck/api/domain/RundeckNode.html" title="class in org.rundeck.api.domain"><CODE>RundeckNode</CODE></A> : might be empty, but won't be null
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE><A HREF="../../../org/rundeck/api/RundeckApiException.html" title="class in org.rundeck.api">RundeckApiException</A></CODE> - in case of error when calling the API (non-existent project with this name)
|
|
<DD><CODE><A HREF="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html" title="class in org.rundeck.api">RundeckApiException.RundeckApiLoginException</A></CODE> - if the login failed
|
|
<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if the project is blank (null, empty or whitespace)<DT><B>See Also:</B><DD><A HREF="../../../org/rundeck/api/RundeckClient.html#getNodes(java.lang.String, java.util.Properties)"><CODE>getNodes(String, Properties)</CODE></A></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getNodes(java.lang.String, java.util.Properties)"><!-- --></A><H3>
|
|
getNodes</H3>
|
|
<PRE>
|
|
public <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="../../../org/rundeck/api/domain/RundeckNode.html" title="class in org.rundeck.api.domain">RundeckNode</A>> <B>getNodes</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> project,
|
|
<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</A> nodeFilters)
|
|
throws <A HREF="../../../org/rundeck/api/RundeckApiException.html" title="class in org.rundeck.api">RundeckApiException</A>,
|
|
<A HREF="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html" title="class in org.rundeck.api">RundeckApiException.RundeckApiLoginException</A>,
|
|
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></PRE>
|
|
<DL>
|
|
<DD>List nodes that belongs to the given project
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>project</CODE> - name of the project - mandatory<DD><CODE>nodeFilters</CODE> - for filtering the nodes - optional. See <A HREF="../../../org/rundeck/api/NodeFiltersBuilder.html" title="class in org.rundeck.api"><CODE>NodeFiltersBuilder</CODE></A>
|
|
<DT><B>Returns:</B><DD>a <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util"><CODE>List</CODE></A> of <A HREF="../../../org/rundeck/api/domain/RundeckNode.html" title="class in org.rundeck.api.domain"><CODE>RundeckNode</CODE></A> : might be empty, but won't be null
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE><A HREF="../../../org/rundeck/api/RundeckApiException.html" title="class in org.rundeck.api">RundeckApiException</A></CODE> - in case of error when calling the API (non-existent project with this name)
|
|
<DD><CODE><A HREF="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html" title="class in org.rundeck.api">RundeckApiException.RundeckApiLoginException</A></CODE> - if the login failed
|
|
<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if the project is blank (null, empty or whitespace)</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getNode(java.lang.String, java.lang.String)"><!-- --></A><H3>
|
|
getNode</H3>
|
|
<PRE>
|
|
public <A HREF="../../../org/rundeck/api/domain/RundeckNode.html" title="class in org.rundeck.api.domain">RundeckNode</A> <B>getNode</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name,
|
|
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> project)
|
|
throws <A HREF="../../../org/rundeck/api/RundeckApiException.html" title="class in org.rundeck.api">RundeckApiException</A>,
|
|
<A HREF="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html" title="class in org.rundeck.api">RundeckApiException.RundeckApiLoginException</A>,
|
|
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></PRE>
|
|
<DL>
|
|
<DD>Get the definition of a single node
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>name</CODE> - of the node - mandatory<DD><CODE>project</CODE> - name of the project - mandatory
|
|
<DT><B>Returns:</B><DD>a <A HREF="../../../org/rundeck/api/domain/RundeckNode.html" title="class in org.rundeck.api.domain"><CODE>RundeckNode</CODE></A> instance - won't be null
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE><A HREF="../../../org/rundeck/api/RundeckApiException.html" title="class in org.rundeck.api">RundeckApiException</A></CODE> - in case of error when calling the API (non-existent name or project with this name)
|
|
<DD><CODE><A HREF="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html" title="class in org.rundeck.api">RundeckApiException.RundeckApiLoginException</A></CODE> - if the login failed
|
|
<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if the name or project is blank (null, empty or whitespace)</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getUrl()"><!-- --></A><H3>
|
|
getUrl</H3>
|
|
<PRE>
|
|
public <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getUrl</B>()</PRE>
|
|
<DL>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getLogin()"><!-- --></A><H3>
|
|
getLogin</H3>
|
|
<PRE>
|
|
public <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getLogin</B>()</PRE>
|
|
<DL>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getPassword()"><!-- --></A><H3>
|
|
getPassword</H3>
|
|
<PRE>
|
|
public <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getPassword</B>()</PRE>
|
|
<DL>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="toString()"><!-- --></A><H3>
|
|
toString</H3>
|
|
<PRE>
|
|
public <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>toString</B>()</PRE>
|
|
<DL>
|
|
<DD><DL>
|
|
<DT><B>Overrides:</B><DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</A></CODE> in class <CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></CODE></DL>
|
|
</DD>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="hashCode()"><!-- --></A><H3>
|
|
hashCode</H3>
|
|
<PRE>
|
|
public int <B>hashCode</B>()</PRE>
|
|
<DL>
|
|
<DD><DL>
|
|
<DT><B>Overrides:</B><DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A></CODE> in class <CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></CODE></DL>
|
|
</DD>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="equals(java.lang.Object)"><!-- --></A><H3>
|
|
equals</H3>
|
|
<PRE>
|
|
public boolean <B>equals</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> obj)</PRE>
|
|
<DL>
|
|
<DD><DL>
|
|
<DT><B>Overrides:</B><DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</A></CODE> in class <CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></CODE></DL>
|
|
</DD>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
</DL>
|
|
<!-- ========= END OF CLASS DATA ========= -->
|
|
<HR>
|
|
|
|
|
|
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
|
<A NAME="navbar_bottom"><!-- --></A>
|
|
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
|
|
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
|
|
<TR>
|
|
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
|
<A NAME="navbar_bottom_firstrow"><!-- --></A>
|
|
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
|
|
<TR ALIGN="center" VALIGN="top">
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/RundeckClient.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
|
</TR>
|
|
</TABLE>
|
|
</TD>
|
|
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
|
</EM>
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR>
|
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
<A HREF="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html" title="class in org.rundeck.api"><B>PREV CLASS</B></A>
|
|
NEXT CLASS</FONT></TD>
|
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
<A HREF="../../../index.html?org/rundeck/api/RundeckClient.html" target="_top"><B>FRAMES</B></A>
|
|
<A HREF="RundeckClient.html" target="_top"><B>NO FRAMES</B></A>
|
|
<SCRIPT type="text/javascript">
|
|
<!--
|
|
if(window==top) {
|
|
document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
|
|
}
|
|
//-->
|
|
</SCRIPT>
|
|
<NOSCRIPT>
|
|
<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
|
|
</NOSCRIPT>
|
|
|
|
|
|
</FONT></TD>
|
|
</TR>
|
|
<TR>
|
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
|
</TR>
|
|
</TABLE>
|
|
<A NAME="skip-navbar_bottom"></A>
|
|
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
|
|
|
<HR>
|
|
Copyright © 2011. All Rights Reserved.
|
|
</BODY>
|
|
</HTML>
|