<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>API reference — Python Jenkins 0.4.15 documentation</title>
<link rel="stylesheet" href="_static/classic.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/language_data.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Using Python-Jenkins" href="examples.html" />
<link rel="prev" title="Python Jenkins" href="index.html" />
</head><body>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="examples.html" title="Using Python-Jenkins"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="index.html" title="Python Jenkins"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">Python Jenkins 0.4.15 documentation</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="module-jenkins">
<span id="api-reference"></span><h1>API reference<a class="headerlink" href="#module-jenkins" title="Permalink to this headline">¶</a></h1>
<p>See examples at <a class="reference internal" href="examples.html"><span class="doc">Using Python-Jenkins</span></a></p>
<dl class="exception">
<dt id="jenkins.JenkinsException">
<em class="property">exception </em><code class="descclassname">jenkins.</code><code class="descname">JenkinsException</code><a class="headerlink" href="#jenkins.JenkinsException" title="Permalink to this definition">¶</a></dt>
<dd><p>General exception type for jenkins-API-related failures.</p>
</dd></dl>
<dl class="exception">
<dt id="jenkins.NotFoundException">
<em class="property">exception </em><code class="descclassname">jenkins.</code><code class="descname">NotFoundException</code><a class="headerlink" href="#jenkins.NotFoundException" title="Permalink to this definition">¶</a></dt>
<dd><p>A special exception to call out the case of receiving a 404.</p>
</dd></dl>
<dl class="exception">
<dt id="jenkins.EmptyResponseException">
<em class="property">exception </em><code class="descclassname">jenkins.</code><code class="descname">EmptyResponseException</code><a class="headerlink" href="#jenkins.EmptyResponseException" title="Permalink to this definition">¶</a></dt>
<dd><p>A special exception to call out the case receiving an empty response.</p>
</dd></dl>
<dl class="exception">
<dt id="jenkins.BadHTTPException">
<em class="property">exception </em><code class="descclassname">jenkins.</code><code class="descname">BadHTTPException</code><a class="headerlink" href="#jenkins.BadHTTPException" title="Permalink to this definition">¶</a></dt>
<dd><p>A special exception to call out the case of a broken HTTP response.</p>
</dd></dl>
<dl class="exception">
<dt id="jenkins.TimeoutException">
<em class="property">exception </em><code class="descclassname">jenkins.</code><code class="descname">TimeoutException</code><a class="headerlink" href="#jenkins.TimeoutException" title="Permalink to this definition">¶</a></dt>
<dd><p>A special exception to call out in the case of a socket timeout.</p>
</dd></dl>
<dl class="function">
<dt id="jenkins.auth_headers">
<code class="descclassname">jenkins.</code><code class="descname">auth_headers</code><span class="sig-paren">(</span><em>username</em>, <em>password</em><span class="sig-paren">)</span><a class="headerlink" href="#jenkins.auth_headers" title="Permalink to this definition">¶</a></dt>
<dd><p>Simple implementation of HTTP Basic Authentication.</p>
<p>Returns the ‘Authentication’ header value.</p>
</dd></dl>
<dl class="class">
<dt id="jenkins.Jenkins">
<em class="property">class </em><code class="descclassname">jenkins.</code><code class="descname">Jenkins</code><span class="sig-paren">(</span><em>url</em>, <em>username=None</em>, <em>password=None</em>, <em>timeout=<object object></em><span class="sig-paren">)</span><a class="headerlink" href="#jenkins.Jenkins" title="Permalink to this definition">¶</a></dt>
<dd><p>Create handle to Jenkins instance.</p>
<p>All methods will raise <a class="reference internal" href="#jenkins.JenkinsException" title="jenkins.JenkinsException"><code class="xref py py-class docutils literal notranslate"><span class="pre">JenkinsException</span></code></a> on failure.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>username</strong> – Server username, <code class="docutils literal notranslate"><span class="pre">str</span></code></li>
<li><strong>password</strong> – Server password, <code class="docutils literal notranslate"><span class="pre">str</span></code></li>
<li><strong>url</strong> – URL of Jenkins server, <code class="docutils literal notranslate"><span class="pre">str</span></code></li>
<li><strong>timeout</strong> – Server connection timeout in secs (default: not set), <code class="docutils literal notranslate"><span class="pre">int</span></code></li>
</ul>
</td>
</tr>
</tbody>
</table>
<dl class="method">
<dt id="jenkins.Jenkins.maybe_add_crumb">
<code class="descname">maybe_add_crumb</code><span class="sig-paren">(</span><em>req</em><span class="sig-paren">)</span><a class="headerlink" href="#jenkins.Jenkins.maybe_add_crumb" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="jenkins.Jenkins.get_job_info">
<code class="descname">get_job_info</code><span class="sig-paren">(</span><em>name</em>, <em>depth=0</em>, <em>fetch_all_builds=False</em><span class="sig-paren">)</span><a class="headerlink" href="#jenkins.Jenkins.get_job_info" title="Permalink to this definition">¶</a></dt>
<dd><p>Get job information dictionary.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>name</strong> – Job name, <code class="docutils literal notranslate"><span class="pre">str</span></code></li>
<li><strong>depth</strong> – JSON depth, <code class="docutils literal notranslate"><span class="pre">int</span></code></li>
<li><strong>fetch_all_builds</strong> – If true, all builds will be retrieved
from Jenkins. Otherwise, Jenkins will
only return the most recent 100
builds. This comes at the expense of
an additional API call which may
return significant amounts of
data. <code class="docutils literal notranslate"><span class="pre">bool</span></code></li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">dictionary of job information</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="jenkins.Jenkins.get_job_info_regex">
<code class="descname">get_job_info_regex</code><span class="sig-paren">(</span><em>pattern</em>, <em>depth=0</em>, <em>folder_depth=0</em><span class="sig-paren">)</span><a class="headerlink" href="#jenkins.Jenkins.get_job_info_regex" title="Permalink to this definition">¶</a></dt>
<dd><dl class="docutils">
<dt>Get a list of jobs information that contain names which match the</dt>
<dd>regex pattern.</dd>
</dl>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>pattern</strong> – regex pattern, <code class="docutils literal notranslate"><span class="pre">str</span></code></li>
<li><strong>depth</strong> – JSON depth, <code class="docutils literal notranslate"><span class="pre">int</span></code></li>
<li><strong>folder_depth</strong> – folder level depth to search <code class="docutils literal notranslate"><span class="pre">int</span></code></li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">List of jobs info, <code class="docutils literal notranslate"><span class="pre">list</span></code></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="jenkins.Jenkins.get_job_name">
<code class="descname">get_job_name</code><span class="sig-paren">(</span><em>name</em><span class="sig-paren">)</span><a class="headerlink" href="#jenkins.Jenkins.get_job_name" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the name of a job using the API.</p>
<p>That is roughly an identity method which can be used to quickly verify
a job exist or is accessible without causing too much stress on the
server side.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> – Job name, <code class="docutils literal notranslate"><span class="pre">str</span></code></td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Name of job or None</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="jenkins.Jenkins.debug_job_info">
<code class="descname">debug_job_info</code><span class="sig-paren">(</span><em>job_name</em><span class="sig-paren">)</span><a class="headerlink" href="#jenkins.Jenkins.debug_job_info" title="Permalink to this definition">¶</a></dt>
<dd><p>Print out job info in more readable format.</p>
</dd></dl>
<dl class="method">
<dt id="jenkins.Jenkins.jenkins_open">
<code class="descname">jenkins_open</code><span class="sig-paren">(</span><em>req</em>, <em>add_crumb=True</em><span class="sig-paren">)</span><a class="headerlink" href="#jenkins.Jenkins.jenkins_open" title="Permalink to this definition">¶</a></dt>
<dd><p>Utility routine for opening an HTTP request to a Jenkins server.</p>
<p>This should only be used to extends the <a class="reference internal" href="#jenkins.Jenkins" title="jenkins.Jenkins"><code class="xref py py-class docutils literal notranslate"><span class="pre">Jenkins</span></code></a> API.</p>
</dd></dl>
<dl class="method">
<dt id="jenkins.Jenkins.get_build_info">
<code class="descname">get_build_info</code><span class="sig-paren">(</span><em>name</em>, <em>number</em>, <em>depth=0</em><span class="sig-paren">)</span><a class="headerlink" href="#jenkins.Jenkins.get_build_info" title="Permalink to this definition">¶</a></dt>
<dd><p>Get build information dictionary.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>name</strong> – Job name, <code class="docutils literal notranslate"><span class="pre">str</span></code></li>
<li><strong>name</strong> – Build number, <code class="docutils literal notranslate"><span class="pre">int</span></code></li>
<li><strong>depth</strong> – JSON depth, <code class="docutils literal notranslate"><span class="pre">int</span></code></li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">dictionary of build information, <code class="docutils literal notranslate"><span class="pre">dict</span></code></p>
</td>
</tr>
</tbody>
</table>
<p>Example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">next_build_number</span> <span class="o">=</span> <span class="n">server</span><span class="o">.</span><span class="n">get_job_info</span><span class="p">(</span><span class="s1">'build_name'</span><span class="p">)[</span><span class="s1">'nextBuildNumber'</span><span class="p">]</span>
<span class="gp">>>> </span><span class="n">output</span> <span class="o">=</span> <span class="n">server</span><span class="o">.</span><span class="n">build_job</span><span class="p">(</span><span class="s1">'build_name'</span><span class="p">)</span>
<span class="gp">>>> </span><span class="kn">from</span> <span class="nn">time</span> <span class="k">import</span> <span class="n">sleep</span><span class="p">;</span> <span class="n">sleep</span><span class="p">(</span><span class="mi">10</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">build_info</span> <span class="o">=</span> <span class="n">server</span><span class="o">.</span><span class="n">get_build_info</span><span class="p">(</span><span class="s1">'build_name'</span><span class="p">,</span> <span class="n">next_build_number</span><span class="p">)</span>
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">build_info</span><span class="p">)</span>
<span class="go">{u'building': False, u'changeSet': {u'items': [{u'date': u'2011-12-19T18:01:52.540557Z', u'msg': u'test', u'revision': 66, u'user': u'unknown', u'paths': [{u'editType': u'edit', u'file': u'/branches/demo/index.html'}]}], u'kind': u'svn', u'revisions': [{u'module': u'http://eaas-svn01.i3.level3.com/eaas', u'revision': 66}]}, u'builtOn': u'', u'description': None, u'artifacts': [{u'relativePath': u'dist/eaas-87-2011-12-19_18-01-57.war', u'displayPath': u'eaas-87-2011-12-19_18-01-57.war', u'fileName': u'eaas-87-2011-12-19_18-01-57.war'}, {u'relativePath': u'dist/eaas-87-2011-12-19_18-01-57.war.zip', u'displayPath': u'eaas-87-2011-12-19_18-01-57.war.zip', u'fileName': u'eaas-87-2011-12-19_18-01-57.war.zip'}], u'timestamp': 1324317717000, u'number': 87, u'actions': [{u'parameters': [{u'name': u'SERVICE_NAME', u'value': u'eaas'}, {u'name': u'PROJECT_NAME', u'value': u'demo'}]}, {u'causes': [{u'userName': u'anonymous', u'shortDescription': u'Started by user anonymous'}]}, {}, {}, {}], u'id': u'2011-12-19_18-01-57', u'keepLog': False, u'url': u'http://eaas-jenkins01.i3.level3.com:9080/job/build_war/87/', u'culprits': [{u'absoluteUrl': u'http://eaas-jenkins01.i3.level3.com:9080/user/unknown', u'fullName': u'unknown'}], u'result': u'SUCCESS', u'duration': 8826, u'fullDisplayName': u'build_war #87'}</span>
</pre></div>
</div>
</dd></dl>
<dl class="method">
<dt id="jenkins.Jenkins.get_queue_info">
<code class="descname">get_queue_info</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#jenkins.Jenkins.get_queue_info" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">list of job dictionaries, <code class="docutils literal notranslate"><span class="pre">[dict]</span></code></td>
</tr>
</tbody>
</table>
<dl class="docutils">
<dt>Example::</dt>
<dd><div class="first last highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">queue_info</span> <span class="o">=</span> <span class="n">server</span><span class="o">.</span><span class="n">get_queue_info</span><span class="p">()</span>
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">queue_info</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span>
<span class="go">{u'task': {u'url': u'http://your_url/job/my_job/', u'color': u'aborted_anime', u'name': u'my_job'}, u'stuck': False, u'actions': [{u'causes': [{u'shortDescription': u'Started by timer'}]}], u'buildable': False, u'params': u'', u'buildableStartMilliseconds': 1315087293316, u'why': u'Build #2,532 is already in progress (ETA:10 min)', u'blocked': True}</span>
</pre></div>
</div>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="jenkins.Jenkins.cancel_queue">
<code class="descname">cancel_queue</code><span class="sig-paren">(</span><em>id</em><span class="sig-paren">)</span><a class="headerlink" href="#jenkins.Jenkins.cancel_queue" title="Permalink to this definition">¶</a></dt>
<dd><p>Cancel a queued build.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>id</strong> – Jenkins job id number for the build, <code class="docutils literal notranslate"><span class="pre">int</span></code></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="jenkins.Jenkins.get_info">
<code class="descname">get_info</code><span class="sig-paren">(</span><em>item=''</em>, <em>query=None</em><span class="sig-paren">)</span><a class="headerlink" href="#jenkins.Jenkins.get_info" title="Permalink to this definition">¶</a></dt>
<dd><p>Get information on this Master or item on Master.</p>
<p>This information includes job list and view information and can be
used to retreive information on items such as job folders.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>item</strong> – item to get information about on this Master</li>
<li><strong>query</strong> – xpath to extract information about on this Master</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">dictionary of information about Master or item, <code class="docutils literal notranslate"><span class="pre">dict</span></code></p>
</td>
</tr>
</tbody>
</table>
<p>Example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">info</span> <span class="o">=</span> <span class="n">server</span><span class="o">.</span><span class="n">get_info</span><span class="p">()</span>
<span class="gp">>>> </span><span class="n">jobs</span> <span class="o">=</span> <span class="n">info</span><span class="p">[</span><span class="s1">'jobs'</span><span class="p">]</span>
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">jobs</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span>
<span class="go">{u'url': u'http://your_url_here/job/my_job/', u'color': u'blue',</span>
<span class="go">u'name': u'my_job'}</span>
</pre></div>
</div>
</dd></dl>
<dl class="method">
<dt id="jenkins.Jenkins.get_whoami">
<code class="descname">get_whoami</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#jenkins.Jenkins.get_whoami" title="Permalink to this definition">¶</a></dt>
<dd><p>Get information about the user account that authenticated to
Jenkins. This is a simple way to verify that your credentials are
correct.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Information about the current user <code class="docutils literal notranslate"><span class="pre">dict</span></code></td>
</tr>
</tbody>
</table>
<p>Example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">me</span> <span class="o">=</span> <span class="n">server</span><span class="o">.</span><span class="n">get_whoami</span><span class="p">()</span>
<span class="gp">>>> </span><span class="nb">print</span> <span class="n">me</span><span class="p">[</span><span class="s1">'fullName'</span><span class="p">]</span>
<span class="gp">>>> </span><span class="s1">'John'</span>
</pre></div>
</div>
</dd></dl>
<dl class="method">
<dt id="jenkins.Jenkins.get_version">
<code class="descname">get_version</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#jenkins.Jenkins.get_version" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the version of this Master.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">This master’s version number <code class="docutils literal notranslate"><span class="pre">str</span></code></td>
</tr>
</tbody>
</table>
<p>Example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">info</span> <span class="o">=</span> <span class="n">server</span><span class="o">.</span><span class="n">get_version</span><span class="p">()</span>
<span class="gp">>>> </span><span class="nb">print</span> <span class="n">info</span>
<span class="gp">>>> </span><span class="mf">1.541</span>
</pre></div>
</div>
</dd></dl>
<dl class="method">
<dt id="jenkins.Jenkins.get_plugins_info">
<code class="descname">get_plugins_info</code><span class="sig-paren">(</span><em>depth=2</em><span class="sig-paren">)</span><a class="headerlink" href="#jenkins.Jenkins.get_plugins_info" title="Permalink to this definition">¶</a></dt>
<dd><p>Get all installed plugins information on this Master.</p>
<p>This method retrieves information about each plugin that is installed
on master returning the raw plugin data in a JSON format.</p>
<div class="deprecated">
<p><span class="versionmodified">Deprecated since version 0.4.9: </span>Use <a class="reference internal" href="#jenkins.Jenkins.get_plugins" title="jenkins.Jenkins.get_plugins"><code class="xref py py-func docutils literal notranslate"><span class="pre">get_plugins()</span></code></a> instead.</p>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>depth</strong> – JSON depth, <code class="docutils literal notranslate"><span class="pre">int</span></code></td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">info on all plugins <code class="docutils literal notranslate"><span class="pre">[dict]</span></code></td>
</tr>
</tbody>
</table>
<p>Example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">info</span> <span class="o">=</span> <span class="n">server</span><span class="o">.</span><span class="n">get_plugins_info</span><span class="p">()</span>
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">info</span><span class="p">)</span>
<span class="go">[{u'backupVersion': None, u'version': u'0.0.4', u'deleted': False,</span>
<span class="go">u'supportsDynamicLoad': u'MAYBE', u'hasUpdate': True,</span>
<span class="go">u'enabled': True, u'pinned': False, u'downgradable': False,</span>
<span class="go">u'dependencies': [], u'url':</span>
<span class="go">u'http://wiki.jenkins-ci.org/display/JENKINS/Gearman+Plugin',</span>
<span class="go">u'longName': u'Gearman Plugin', u'active': True, u'shortName':</span>
<span class="go">u'gearman-plugin', u'bundled': False}, ..]</span>
</pre></div>
</div>
</dd></dl>
<dl class="method">
<dt id="jenkins.Jenkins.get_plugin_info">
<code class="descname">get_plugin_info</code><span class="sig-paren">(</span><em>name</em>, <em>depth=2</em><span class="sig-paren">)</span><a class="headerlink" href="#jenkins.Jenkins.get_plugin_info" title="Permalink to this definition">¶</a></dt>
<dd><p>Get an installed plugin information on this Master.</p>
<p>This method retrieves information about a specific plugin and returns
the raw plugin data in a JSON format.
The passed in plugin name (short or long) must be an exact match.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">Calling this method will query Jenkins fresh for the
information for all plugins on each call. If you need to retrieve
information for multiple plugins it’s recommended to use
<a class="reference internal" href="#jenkins.Jenkins.get_plugins" title="jenkins.Jenkins.get_plugins"><code class="xref py py-func docutils literal notranslate"><span class="pre">get_plugins()</span></code></a> instead, which will return a multi key
dictionary that can be accessed via either the short or long name
of the plugin.</p>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>name</strong> – Name (short or long) of plugin, <code class="docutils literal notranslate"><span class="pre">str</span></code></li>
<li><strong>depth</strong> – JSON depth, <code class="docutils literal notranslate"><span class="pre">int</span></code></li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">a specific plugin <code class="docutils literal notranslate"><span class="pre">dict</span></code></p>
</td>
</tr>
</tbody>
</table>
<p>Example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">info</span> <span class="o">=</span> <span class="n">server</span><span class="o">.</span><span class="n">get_plugin_info</span><span class="p">(</span><span class="s2">"Gearman Plugin"</span><span class="p">)</span>
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">info</span><span class="p">)</span>
<span class="go">{u'backupVersion': None, u'version': u'0.0.4', u'deleted': False,</span>
<span class="go">u'supportsDynamicLoad': u'MAYBE', u'hasUpdate': True,</span>
<span class="go">u'enabled': True, u'pinned': False, u'downgradable': False,</span>
<span class="go">u'dependencies': [], u'url':</span>
<span class="go">u'http://wiki.jenkins-ci.org/display/JENKINS/Gearman+Plugin',</span>
<span class="go">u'longName': u'Gearman Plugin', u'active': True, u'shortName':</span>
<span class="go">u'gearman-plugin', u'bundled': False}</span>
</pre></div>
</div>
</dd></dl>
<dl class="method">
<dt id="jenkins.Jenkins.get_plugins">
<code class="descname">get_plugins</code><span class="sig-paren">(</span><em>depth=2</em><span class="sig-paren">)</span><a class="headerlink" href="#jenkins.Jenkins.get_plugins" title="Permalink to this definition">¶</a></dt>
<dd><p>Return plugins info using helper class for version comparison</p>
<p>This method retrieves information about all the installed plugins and
uses a Plugin helper class to simplify version comparison. Also uses
a multi key dict to allow retrieval via either short or long names.</p>
<p>When printing/dumping the data, the version will transparently return
a unicode string, which is exactly what was previously returned by the
API.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>depth</strong> – JSON depth, <code class="docutils literal notranslate"><span class="pre">int</span></code></td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">info on all plugins <code class="docutils literal notranslate"><span class="pre">[dict]</span></code></td>
</tr>
</tbody>
</table>
<p>Example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">j</span> <span class="o">=</span> <span class="n">Jenkins</span><span class="p">()</span>
<span class="gp">>>> </span><span class="n">info</span> <span class="o">=</span> <span class="n">j</span><span class="o">.</span><span class="n">get_plugins</span><span class="p">()</span>
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">info</span><span class="p">)</span>
<span class="go">{('gearman-plugin', 'Gearman Plugin'):</span>
<span class="go"> {u'backupVersion': None, u'version': u'0.0.4',</span>
<span class="go"> u'deleted': False, u'supportsDynamicLoad': u'MAYBE',</span>
<span class="go"> u'hasUpdate': True, u'enabled': True, u'pinned': False,</span>
<span class="go"> u'downgradable': False, u'dependencies': [], u'url':</span>
<span class="go"> u'http://wiki.jenkins-ci.org/display/JENKINS/Gearman+Plugin',</span>
<span class="go"> u'longName': u'Gearman Plugin', u'active': True, u'shortName':</span>
<span class="go"> u'gearman-plugin', u'bundled': False}, ...}</span>
</pre></div>
</div>
</dd></dl>
<dl class="method">
<dt id="jenkins.Jenkins.get_jobs">
<code class="descname">get_jobs</code><span class="sig-paren">(</span><em>folder_depth=0</em>, <em>view_name=None</em><span class="sig-paren">)</span><a class="headerlink" href="#jenkins.Jenkins.get_jobs" title="Permalink to this definition">¶</a></dt>
<dd><p>Get list of jobs.</p>
<p>Each job is a dictionary with ‘name’, ‘url’, ‘color’ and ‘fullname’
keys.</p>
<p>If the <code class="docutils literal notranslate"><span class="pre">view_name</span></code> parameter is present, the list of
jobs will be limited to only those configured in the
specified view. In this case, the job dictionary ‘fullname’ key
would be equal to the job name.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>folder_depth</strong> – Number of levels to search, <code class="docutils literal notranslate"><span class="pre">int</span></code>. By default
0, which will limit search to toplevel. None disables the limit.</li>
<li><strong>view_name</strong> – Name of a Jenkins view for which to
retrieve jobs, <code class="docutils literal notranslate"><span class="pre">str</span></code>. By default, the job list is
not limited to a specific view.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">list of jobs, <code class="docutils literal notranslate"><span class="pre">[{str:</span> <span class="pre">str,</span> <span class="pre">str:</span> <span class="pre">str,</span> <span class="pre">str:</span> <span class="pre">str,</span> <span class="pre">str:</span> <span class="pre">str}]</span></code></p>
</td>
</tr>
</tbody>
</table>
<p>Example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">jobs</span> <span class="o">=</span> <span class="n">server</span><span class="o">.</span><span class="n">get_jobs</span><span class="p">()</span>
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">jobs</span><span class="p">)</span>
<span class="go">[{</span>
<span class="go"> u'name': u'all_tests',</span>
<span class="go"> u'url': u'http://your_url.here/job/all_tests/',</span>
<span class="go"> u'color': u'blue',</span>
<span class="go"> u'fullname': u'all_tests'</span>
<span class="go">}]</span>
</pre></div>
</div>
</dd></dl>
<dl class="method">
<dt id="jenkins.Jenkins.get_all_jobs">
<code class="descname">get_all_jobs</code><span class="sig-paren">(</span><em>folder_depth=None</em><span class="sig-paren">)</span><a class="headerlink" href="#jenkins.Jenkins.get_all_jobs" title="Permalink to this definition">¶</a></dt>
<dd><p>Get list of all jobs recursively to the given folder depth.</p>
<p>Each job is a dictionary with ‘name’, ‘url’, ‘color’ and ‘fullname’
keys.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>folder_depth</strong> – Number of levels to search, <code class="docutils literal notranslate"><span class="pre">int</span></code>. By default
None, which will search all levels. 0 limits to toplevel.</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">list of jobs, <code class="docutils literal notranslate"><span class="pre">[</span> <span class="pre">{</span> <span class="pre">str:</span> <span class="pre">str}</span> <span class="pre">]</span></code></td>
</tr>
</tbody>
</table>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p>On instances with many folders it may be more efficient to use the
run_script method to retrieve all jobs instead.</p>
<p>Example:</p>
<div class="last highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">server</span><span class="o">.</span><span class="n">run_script</span><span class="p">(</span><span class="s2">"""</span>
<span class="s2"> import groovy.json.JsonBuilder;</span>
<span class="s2"> // get all projects excluding matrix configuration</span>
<span class="s2"> // as they are simply part of a matrix project.</span>
<span class="s2"> // there may be better ways to get just jobs</span>
<span class="s2"> items = Jenkins.instance.getAllItems(AbstractProject);</span>
<span class="s2"> items.removeAll {</span>
<span class="s2"> it instanceof hudson.matrix.MatrixConfiguration</span>
<span class="s2"> };</span>
<span class="s2"> def json = new JsonBuilder()</span>
<span class="s2"> def root = json {</span>
<span class="s2"> jobs items.collect {</span>
<span class="s2"> [</span>
<span class="s2"> name: it.name,</span>
<span class="s2"> url: Jenkins.instance.getRootUrl() + it.getUrl(),</span>
<span class="s2"> color: it.getIconColor().toString(),</span>
<span class="s2"> fullname: it.getFullName()</span>
<span class="s2"> ]</span>
<span class="s2"> }</span>
<span class="s2"> }</span>
<span class="s2"> // use json.toPrettyString() if viewing</span>
<span class="s2"> println json.toString()</span>
<span class="s2"> """</span><span class="p">)</span>
</pre></div>
</div>
</div>
</dd></dl>
<dl class="method">
<dt id="jenkins.Jenkins.copy_job">
<code class="descname">copy_job</code><span class="sig-paren">(</span><em>from_name</em>, <em>to_name</em><span class="sig-paren">)</span><a class="headerlink" href="#jenkins.Jenkins.copy_job" title="Permalink to this definition">¶</a></dt>
<dd><p>Copy a Jenkins job.</p>
<p>Will raise an exception whenever the source and destination folder
for this jobs won’t be the same.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>from_name</strong> – Name of Jenkins job to copy from, <code class="docutils literal notranslate"><span class="pre">str</span></code></li>
<li><strong>to_name</strong> – Name of Jenkins job to copy to, <code class="docutils literal notranslate"><span class="pre">str</span></code></li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Throws:</th><td class="field-body"><p class="first last"><a class="reference internal" href="#jenkins.JenkinsException" title="jenkins.JenkinsException"><code class="xref py py-class docutils literal notranslate"><span class="pre">JenkinsException</span></code></a> whenever the source and destination
folder are not the same</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="jenkins.Jenkins.rename_job">
<code class="descname">rename_job</code><span class="sig-paren">(</span><em>from_name</em>, <em>to_name</em><span class="sig-paren">)</span><a class="headerlink" href="#jenkins.Jenkins.rename_job" title="Permalink to this definition">¶</a></dt>
<dd><p>Rename an existing Jenkins job</p>
<p>Will raise an exception whenever the source and destination folder
for this jobs won’t be the same.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>from_name</strong> – Name of Jenkins job to rename, <code class="docutils literal notranslate"><span class="pre">str</span></code></li>
<li><strong>to_name</strong> – New Jenkins job name, <code class="docutils literal notranslate"><span class="pre">str</span></code></li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Throws:</th><td class="field-body"><p class="first last"><a class="reference internal" href="#jenkins.JenkinsException" title="jenkins.JenkinsException"><code class="xref py py-class docutils literal notranslate"><span class="pre">JenkinsException</span></code></a> whenever the source and destination
folder are not the same</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="jenkins.Jenkins.delete_job">
<code class="descname">delete_job</code><span class="sig-paren">(</span><em>name</em><span class="sig-paren">)</span><a class="headerlink" href="#jenkins.Jenkins.delete_job" title="Permalink to this definition">¶</a></dt>
<dd><p>Delete Jenkins job permanently.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> – Name of Jenkins job, <code class="docutils literal notranslate"><span class="pre">str</span></code></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="jenkins.Jenkins.enable_job">
<code class="descname">enable_job</code><span class="sig-paren">(</span><em>name</em><span class="sig-paren">)</span><a class="headerlink" href="#jenkins.Jenkins.enable_job" title="Permalink to this definition">¶</a></dt>
<dd><p>Enable Jenkins job.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> – Name of Jenkins job, <code class="docutils literal notranslate"><span class="pre">str</span></code></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="jenkins.Jenkins.disable_job">
<code class="descname">disable_job</code><span class="sig-paren">(</span><em>name</em><span class="sig-paren">)</span><a class="headerlink" href="#jenkins.Jenkins.disable_job" title="Permalink to this definition">¶</a></dt>
<dd><p>Disable Jenkins job.</p>
<p>To re-enable, call <a class="reference internal" href="#jenkins.Jenkins.enable_job" title="jenkins.Jenkins.enable_job"><code class="xref py py-meth docutils literal notranslate"><span class="pre">Jenkins.enable_job()</span></code></a>.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> – Name of Jenkins job, <code class="docutils literal notranslate"><span class="pre">str</span></code></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="jenkins.Jenkins.set_next_build_number">
<code class="descname">set_next_build_number</code><span class="sig-paren">(</span><em>name</em>, <em>number</em><span class="sig-paren">)</span><a class="headerlink" href="#jenkins.Jenkins.set_next_build_number" title="Permalink to this definition">¶</a></dt>
<dd><p>Set a job’s next build number.</p>
<p>The current next build number is contained within the job
information retrieved using <a class="reference internal" href="#jenkins.Jenkins.get_job_info" title="jenkins.Jenkins.get_job_info"><code class="xref py py-meth docutils literal notranslate"><span class="pre">Jenkins.get_job_info()</span></code></a>. If
the specified next build number is less than the last build
number, Jenkins will ignore the request.</p>
<p>Note that the <a class="reference external" href="https://wiki.jenkins-ci.org/display/JENKINS/Next+Build+Number+Plugin">Next Build Number Plugin</a>
must be installed to enable this functionality.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>name</strong> – Name of Jenkins job, <code class="docutils literal notranslate"><span class="pre">str</span></code></li>
<li><strong>number</strong> – Next build number to set, <code class="docutils literal notranslate"><span class="pre">int</span></code></li>
</ul>
</td>
</tr>
</tbody>
</table>
<p>Example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">next_bn</span> <span class="o">=</span> <span class="n">server</span><span class="o">.</span><span class="n">get_job_info</span><span class="p">(</span><span class="s1">'job_name'</span><span class="p">)[</span><span class="s1">'nextBuildNumber'</span><span class="p">]</span>
<span class="gp">>>> </span><span class="n">server</span><span class="o">.</span><span class="n">set_next_build_number</span><span class="p">(</span><span class="s1">'job_name'</span><span class="p">,</span> <span class="n">next_bn</span> <span class="o">+</span> <span class="mi">50</span><span class="p">)</span>
</pre></div>
</div>
</dd></dl>
<dl class="method">
<dt id="jenkins.Jenkins.job_exists">
<code class="descname">job_exists</code><span class="sig-paren">(</span><em>name</em><span class="sig-paren">)</span><a class="headerlink" href="#jenkins.Jenkins.job_exists" title="Permalink to this definition">¶</a></dt>
<dd><p>Check whether a job exists</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> – Name of Jenkins job, <code class="docutils literal notranslate"><span class="pre">str</span></code></td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><code class="docutils literal notranslate"><span class="pre">True</span></code> if Jenkins job exists</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="jenkins.Jenkins.jobs_count">
<code class="descname">jobs_count</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#jenkins.Jenkins.jobs_count" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the number of jobs on the Jenkins server</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Total number of jobs, <code class="docutils literal notranslate"><span class="pre">int</span></code></td>
</tr>
</tbody>
</table>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p>On instances with many folders it may be more efficient to use the
run_script method to retrieve the total number of jobs instead.</p>
<p>Example:</p>
<div class="last highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># get all projects excluding matrix configuration</span>
<span class="c1"># as they are simply part of a matrix project.</span>
<span class="n">server</span><span class="o">.</span><span class="n">run_script</span><span class="p">(</span>
<span class="s2">"print(Hudson.instance.getAllItems("</span>
<span class="s2">" hudson.model.AbstractProject).count{"</span>
<span class="s2">" !(it instanceof hudson.matrix.MatrixConfiguration)"</span>
<span class="s2">" })"</span><span class="p">)</span>
</pre></div>
</div>
</div>
</dd></dl>
<dl class="method">
<dt id="jenkins.Jenkins.assert_job_exists">
<code class="descname">assert_job_exists</code><span class="sig-paren">(</span><em>name</em>, <em>exception_message='job[%s] does not exist'</em><span class="sig-paren">)</span><a class="headerlink" href="#jenkins.Jenkins.assert_job_exists" title="Permalink to this definition">¶</a></dt>
<dd><p>Raise an exception if a job does not exist</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>name</strong> – Name of Jenkins job, <code class="docutils literal notranslate"><span class="pre">str</span></code></li>
<li><strong>exception_message</strong> – Message to use for the exception. Formatted
with <code class="docutils literal notranslate"><span class="pre">name</span></code></li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Throws:</th><td class="field-body"><p class="first last"><a class="reference internal" href="#jenkins.JenkinsException" title="jenkins.JenkinsException"><code class="xref py py-class docutils literal notranslate"><span class="pre">JenkinsException</span></code></a> whenever the job does not exist</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="jenkins.Jenkins.create_job">
<code class="descname">create_job</code><span class="sig-paren">(</span><em>name</em>, <em>config_xml</em><span class="sig-paren">)</span><a class="headerlink" href="#jenkins.Jenkins.create_job" title="Permalink to this definition">¶</a></dt>
<dd><p>Create a new Jenkins job</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>name</strong> – Name of Jenkins job, <code class="docutils literal notranslate"><span class="pre">str</span></code></li>
<li><strong>config_xml</strong> – config file text, <code class="docutils literal notranslate"><span class="pre">str</span></code></li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="jenkins.Jenkins.get_job_config">
<code class="descname">get_job_config</code><span class="sig-paren">(</span><em>name</em><span class="sig-paren">)</span><a class="headerlink" href="#jenkins.Jenkins.get_job_config" title="Permalink to this definition">¶</a></dt>
<dd><p>Get configuration of existing Jenkins job.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> – Name of Jenkins job, <code class="docutils literal notranslate"><span class="pre">str</span></code></td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">job configuration (XML format)</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="jenkins.Jenkins.reconfig_job">
<code class="descname">reconfig_job</code><span class="sig-paren">(</span><em>name</em>, <em>config_xml</em><span class="sig-paren">)</span><a class="headerlink" href="#jenkins.Jenkins.reconfig_job" title="Permalink to this definition">¶</a></dt>
<dd><p>Change configuration of existing Jenkins job.</p>
<p>To create a new job, see <a class="reference internal" href="#jenkins.Jenkins.create_job" title="jenkins.Jenkins.create_job"><code class="xref py py-meth docutils literal notranslate"><span class="pre">Jenkins.create_job()</span></code></a>.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>name</strong> – Name of Jenkins job, <code class="docutils literal notranslate"><span class="pre">str</span></code></li>
<li><strong>config_xml</strong> – New XML configuration, <code class="docutils literal notranslate"><span class="pre">str</span></code></li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="jenkins.Jenkins.build_job_url">
<code class="descname">build_job_url</code><span class="sig-paren">(</span><em>name</em>, <em>parameters=None</em>, <em>token=None</em><span class="sig-paren">)</span><a class="headerlink" href="#jenkins.Jenkins.build_job_url" title="Permalink to this definition">¶</a></dt>
<dd><p>Get URL to trigger build job.</p>
<p>Authenticated setups may require configuring a token on the server
side.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>parameters</strong> – parameters for job, or None., <code class="docutils literal notranslate"><span class="pre">dict</span></code></li>
<li><strong>token</strong> – (optional) token for building job, <code class="docutils literal notranslate"><span class="pre">str</span></code></li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">URL for building job</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="jenkins.Jenkins.build_job">
<code class="descname">build_job</code><span class="sig-paren">(</span><em>name</em>, <em>parameters=None</em>, <em>token=None</em><span class="sig-paren">)</span><a class="headerlink" href="#jenkins.Jenkins.build_job" title="Permalink to this definition">¶</a></dt>
<dd><p>Trigger build job.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>name</strong> – name of job</li>
<li><strong>parameters</strong> – parameters for job, or <code class="docutils literal notranslate"><span class="pre">None</span></code>, <code class="docutils literal notranslate"><span class="pre">dict</span></code></li>
<li><strong>token</strong> – Jenkins API token</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="jenkins.Jenkins.run_script">
<code class="descname">run_script</code><span class="sig-paren">(</span><em>script</em><span class="sig-paren">)</span><a class="headerlink" href="#jenkins.Jenkins.run_script" title="Permalink to this definition">¶</a></dt>
<dd><p>Execute a groovy script on the jenkins master.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>script</strong> – The groovy script, <code class="docutils literal notranslate"><span class="pre">string</span></code></td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The result of the script run.</td>
</tr>
</tbody>
</table>
<dl class="docutils">
<dt>Example::</dt>
<dd><div class="first last highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">info</span> <span class="o">=</span> <span class="n">server</span><span class="o">.</span><span class="n">run_script</span><span class="p">(</span><span class="s2">"println(Jenkins.instance.pluginManager.plugins)"</span><span class="p">)</span>
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">info</span><span class="p">)</span>
<span class="go">u'[Plugin:windows-slaves, Plugin:ssh-slaves, Plugin:translation,</span>
<span class="go">Plugin:cvs, Plugin:nodelabelparameter, Plugin:external-monitor-job,</span>
<span class="go">Plugin:mailer, Plugin:jquery, Plugin:antisamy-markup-formatter,</span>
<span class="go">Plugin:maven-plugin, Plugin:pam-auth]'</span>
</pre></div>
</div>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="jenkins.Jenkins.install_plugin">
<code class="descname">install_plugin</code><span class="sig-paren">(</span><em>name</em>, <em>include_dependencies=True</em><span class="sig-paren">)</span><a class="headerlink" href="#jenkins.Jenkins.install_plugin" title="Permalink to this definition">¶</a></dt>
<dd><p>Install a plugin and its dependencies from the Jenkins public
repository at <a class="reference external" href="http://repo.jenkins-ci.org/repo/org/jenkins-ci/plugins">http://repo.jenkins-ci.org/repo/org/jenkins-ci/plugins</a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>name</strong> – The plugin short name, <code class="docutils literal notranslate"><span class="pre">string</span></code></li>
<li><strong>include_dependencies</strong> – Install the plugin’s dependencies, <code class="docutils literal notranslate"><span class="pre">bool</span></code></li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">Whether a Jenkins restart is required, <code class="docutils literal notranslate"><span class="pre">bool</span></code></p>
</td>
</tr>
</tbody>
</table>
<dl class="docutils">
<dt>Example::</dt>
<dd><div class="first last highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">info</span> <span class="o">=</span> <span class="n">server</span><span class="o">.</span><span class="n">install_plugin</span><span class="p">(</span><span class="s2">"jabber"</span><span class="p">)</span>
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">info</span><span class="p">)</span>
<span class="go">True</span>
</pre></div>
</div>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="jenkins.Jenkins.stop_build">
<code class="descname">stop_build</code><span class="sig-paren">(</span><em>name</em>, <em>number</em><span class="sig-paren">)</span><a class="headerlink" href="#jenkins.Jenkins.stop_build" title="Permalink to this definition">¶</a></dt>
<dd><p>Stop a running Jenkins build.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>name</strong> – Name of Jenkins job, <code class="docutils literal notranslate"><span class="pre">str</span></code></li>
<li><strong>number</strong> – Jenkins build number for the job, <code class="docutils literal notranslate"><span class="pre">int</span></code></li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="jenkins.Jenkins.get_running_builds">
<code class="descname">get_running_builds</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#jenkins.Jenkins.get_running_builds" title="Permalink to this definition">¶</a></dt>
<dd><p>Return list of running builds.</p>
<p>Each build is a dict with keys ‘name’, ‘number’, ‘url’, ‘node’,
and ‘executor’.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">List of builds,
<code class="docutils literal notranslate"><span class="pre">[</span> <span class="pre">{</span> <span class="pre">str:</span> <span class="pre">str,</span> <span class="pre">str:</span> <span class="pre">int,</span> <span class="pre">str:str,</span> <span class="pre">str:</span> <span class="pre">str,</span> <span class="pre">str:</span> <span class="pre">int}</span> <span class="pre">]</span></code></td>
</tr>
</tbody>
</table>
<dl class="docutils">
<dt>Example::</dt>
<dd><div class="first last highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">builds</span> <span class="o">=</span> <span class="n">server</span><span class="o">.</span><span class="n">get_running_builds</span><span class="p">()</span>
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">builds</span><span class="p">)</span>
<span class="go">[{'node': 'foo-slave', 'url': 'https://localhost/job/test/15/',</span>
<span class="go"> 'executor': 0, 'name': 'test', 'number': 15}]</span>
</pre></div>
</div>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="jenkins.Jenkins.get_nodes">
<code class="descname">get_nodes</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#jenkins.Jenkins.get_nodes" title="Permalink to this definition">¶</a></dt>
<dd><p>Get a list of nodes connected to the Master</p>
<p>Each node is a dict with keys ‘name’ and ‘offline’</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">List of nodes, <code class="docutils literal notranslate"><span class="pre">[</span> <span class="pre">{</span> <span class="pre">str:</span> <span class="pre">str,</span> <span class="pre">str:</span> <span class="pre">bool}</span> <span class="pre">]</span></code></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="jenkins.Jenkins.get_node_info">
<code class="descname">get_node_info</code><span class="sig-paren">(</span><em>name</em>, <em>depth=0</em><span class="sig-paren">)</span><a class="headerlink" href="#jenkins.Jenkins.get_node_info" title="Permalink to this definition">¶</a></dt>
<dd><p>Get node information dictionary</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>name</strong> – Node name, <code class="docutils literal notranslate"><span class="pre">str</span></code></li>
<li><strong>depth</strong> – JSON depth, <code class="docutils literal notranslate"><span class="pre">int</span></code></li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">Dictionary of node info, <code class="docutils literal notranslate"><span class="pre">dict</span></code></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="jenkins.Jenkins.node_exists">
<code class="descname">node_exists</code><span class="sig-paren">(</span><em>name</em><span class="sig-paren">)</span><a class="headerlink" href="#jenkins.Jenkins.node_exists" title="Permalink to this definition">¶</a></dt>
<dd><p>Check whether a node exists</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> – Name of Jenkins node, <code class="docutils literal notranslate"><span class="pre">str</span></code></td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><code class="docutils literal notranslate"><span class="pre">True</span></code> if Jenkins node exists</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="jenkins.Jenkins.assert_node_exists">
<code class="descname">assert_node_exists</code><span class="sig-paren">(</span><em>name</em>, <em>exception_message='node[%s] does not exist'</em><span class="sig-paren">)</span><a class="headerlink" href="#jenkins.Jenkins.assert_node_exists" title="Permalink to this definition">¶</a></dt>
<dd><p>Raise an exception if a node does not exist</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>name</strong> – Name of Jenkins node, <code class="docutils literal notranslate"><span class="pre">str</span></code></li>
<li><strong>exception_message</strong> – Message to use for the exception. Formatted
with <code class="docutils literal notranslate"><span class="pre">name</span></code></li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Throws:</th><td class="field-body"><p class="first last"><a class="reference internal" href="#jenkins.JenkinsException" title="jenkins.JenkinsException"><code class="xref py py-class docutils literal notranslate"><span class="pre">JenkinsException</span></code></a> whenever the node does not exist</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="jenkins.Jenkins.delete_node">
<code class="descname">delete_node</code><span class="sig-paren">(</span><em>name</em><span class="sig-paren">)</span><a class="headerlink" href="#jenkins.Jenkins.delete_node" title="Permalink to this definition">¶</a></dt>
<dd><p>Delete Jenkins node permanently.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> – Name of Jenkins node, <code class="docutils literal notranslate"><span class="pre">str</span></code></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="jenkins.Jenkins.disable_node">
<code class="descname">disable_node</code><span class="sig-paren">(</span><em>name</em>, <em>msg=''</em><span class="sig-paren">)</span><a class="headerlink" href="#jenkins.Jenkins.disable_node" title="Permalink to this definition">¶</a></dt>
<dd><p>Disable a node</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>name</strong> – Jenkins node name, <code class="docutils literal notranslate"><span class="pre">str</span></code></li>
<li><strong>msg</strong> – Offline message, <code class="docutils literal notranslate"><span class="pre">str</span></code></li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="jenkins.Jenkins.enable_node">
<code class="descname">enable_node</code><span class="sig-paren">(</span><em>name</em><span class="sig-paren">)</span><a class="headerlink" href="#jenkins.Jenkins.enable_node" title="Permalink to this definition">¶</a></dt>
<dd><p>Enable a node</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> – Jenkins node name, <code class="docutils literal notranslate"><span class="pre">str</span></code></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="jenkins.Jenkins.create_node">
<code class="descname">create_node</code><span class="sig-paren">(</span><em>name</em>, <em>numExecutors=2</em>, <em>nodeDescription=None</em>, <em>remoteFS='/var/lib/jenkins'</em>, <em>labels=None</em>, <em>exclusive=False</em>, <em>launcher='hudson.slaves.CommandLauncher'</em>, <em>launcher_params={}</em><span class="sig-paren">)</span><a class="headerlink" href="#jenkins.Jenkins.create_node" title="Permalink to this definition">¶</a></dt>
<dd><p>Create a node</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>name</strong> – name of node to create, <code class="docutils literal notranslate"><span class="pre">str</span></code></li>
<li><strong>numExecutors</strong> – number of executors for node, <code class="docutils literal notranslate"><span class="pre">int</span></code></li>
<li><strong>nodeDescription</strong> – Description of node, <code class="docutils literal notranslate"><span class="pre">str</span></code></li>
<li><strong>remoteFS</strong> – Remote filesystem location to use, <code class="docutils literal notranslate"><span class="pre">str</span></code></li>
<li><strong>labels</strong> – Labels to associate with node, <code class="docutils literal notranslate"><span class="pre">str</span></code></li>
<li><strong>exclusive</strong> – Use this node for tied jobs only, <code class="docutils literal notranslate"><span class="pre">bool</span></code></li>
<li><strong>launcher</strong> – The launch method for the slave, <code class="docutils literal notranslate"><span class="pre">jenkins.LAUNCHER_COMMAND</span></code>, <code class="docutils literal notranslate"><span class="pre">jenkins.LAUNCHER_SSH</span></code>, <code class="docutils literal notranslate"><span class="pre">jenkins.LAUNCHER_JNLP</span></code>, <code class="docutils literal notranslate"><span class="pre">jenkins.LAUNCHER_WINDOWS_SERVICE</span></code></li>
<li><strong>launcher_params</strong> – Additional parameters for the launcher, <code class="docutils literal notranslate"><span class="pre">dict</span></code></li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="jenkins.Jenkins.get_node_config">
<code class="descname">get_node_config</code><span class="sig-paren">(</span><em>name</em><span class="sig-paren">)</span><a class="headerlink" href="#jenkins.Jenkins.get_node_config" title="Permalink to this definition">¶</a></dt>
<dd><p>Get the configuration for a node.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> – Jenkins node name, <code class="docutils literal notranslate"><span class="pre">str</span></code></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="jenkins.Jenkins.reconfig_node">
<code class="descname">reconfig_node</code><span class="sig-paren">(</span><em>name</em>, <em>config_xml</em><span class="sig-paren">)</span><a class="headerlink" href="#jenkins.Jenkins.reconfig_node" title="Permalink to this definition">¶</a></dt>
<dd><p>Change the configuration for an existing node.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>name</strong> – Jenkins node name, <code class="docutils literal notranslate"><span class="pre">str</span></code></li>
<li><strong>config_xml</strong> – New XML configuration, <code class="docutils literal notranslate"><span class="pre">str</span></code></li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="jenkins.Jenkins.get_build_console_output">
<code class="descname">get_build_console_output</code><span class="sig-paren">(</span><em>name</em>, <em>number</em><span class="sig-paren">)</span><a class="headerlink" href="#jenkins.Jenkins.get_build_console_output" title="Permalink to this definition">¶</a></dt>
<dd><p>Get build console text.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>name</strong> – Job name, <code class="docutils literal notranslate"><span class="pre">str</span></code></li>
<li><strong>name</strong> – Build number, <code class="docutils literal notranslate"><span class="pre">int</span></code></li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">Build console output, <code class="docutils literal notranslate"><span class="pre">str</span></code></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="jenkins.Jenkins.get_view_name">
<code class="descname">get_view_name</code><span class="sig-paren">(</span><em>name</em><span class="sig-paren">)</span><a class="headerlink" href="#jenkins.Jenkins.get_view_name" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the name of a view using the API.</p>
<p>That is roughly an identity method which can be used to quickly verify
a view exists or is accessible without causing too much stress on the
server side.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> – View name, <code class="docutils literal notranslate"><span class="pre">str</span></code></td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Name of view or None</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="jenkins.Jenkins.assert_view_exists">
<code class="descname">assert_view_exists</code><span class="sig-paren">(</span><em>name</em>, <em>exception_message='view[%s] does not exist'</em><span class="sig-paren">)</span><a class="headerlink" href="#jenkins.Jenkins.assert_view_exists" title="Permalink to this definition">¶</a></dt>
<dd><p>Raise an exception if a view does not exist</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>name</strong> – Name of Jenkins view, <code class="docutils literal notranslate"><span class="pre">str</span></code></li>
<li><strong>exception_message</strong> – Message to use for the exception. Formatted
with <code class="docutils literal notranslate"><span class="pre">name</span></code></li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Throws:</th><td class="field-body"><p class="first last"><a class="reference internal" href="#jenkins.JenkinsException" title="jenkins.JenkinsException"><code class="xref py py-class docutils literal notranslate"><span class="pre">JenkinsException</span></code></a> whenever the view does not exist</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="jenkins.Jenkins.view_exists">
<code class="descname">view_exists</code><span class="sig-paren">(</span><em>name</em><span class="sig-paren">)</span><a class="headerlink" href="#jenkins.Jenkins.view_exists" title="Permalink to this definition">¶</a></dt>
<dd><p>Check whether a view exists</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> – Name of Jenkins view, <code class="docutils literal notranslate"><span class="pre">str</span></code></td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><code class="docutils literal notranslate"><span class="pre">True</span></code> if Jenkins view exists</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="jenkins.Jenkins.get_views">
<code class="descname">get_views</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#jenkins.Jenkins.get_views" title="Permalink to this definition">¶</a></dt>
<dd><p>Get list of views running.</p>
<p>Each view is a dictionary with ‘name’ and ‘url’ keys.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">list of views, <code class="docutils literal notranslate"><span class="pre">[</span> <span class="pre">{</span> <span class="pre">str:</span> <span class="pre">str}</span> <span class="pre">]</span></code></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="jenkins.Jenkins.delete_view">
<code class="descname">delete_view</code><span class="sig-paren">(</span><em>name</em><span class="sig-paren">)</span><a class="headerlink" href="#jenkins.Jenkins.delete_view" title="Permalink to this definition">¶</a></dt>
<dd><p>Delete Jenkins view permanently.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> – Name of Jenkins view, <code class="docutils literal notranslate"><span class="pre">str</span></code></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="jenkins.Jenkins.create_view">
<code class="descname">create_view</code><span class="sig-paren">(</span><em>name</em>, <em>config_xml</em><span class="sig-paren">)</span><a class="headerlink" href="#jenkins.Jenkins.create_view" title="Permalink to this definition">¶</a></dt>
<dd><p>Create a new Jenkins view</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>name</strong> – Name of Jenkins view, <code class="docutils literal notranslate"><span class="pre">str</span></code></li>
<li><strong>config_xml</strong> – config file text, <code class="docutils literal notranslate"><span class="pre">str</span></code></li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="jenkins.Jenkins.reconfig_view">
<code class="descname">reconfig_view</code><span class="sig-paren">(</span><em>name</em>, <em>config_xml</em><span class="sig-paren">)</span><a class="headerlink" href="#jenkins.Jenkins.reconfig_view" title="Permalink to this definition">¶</a></dt>
<dd><p>Change configuration of existing Jenkins view.</p>
<p>To create a new view, see <a class="reference internal" href="#jenkins.Jenkins.create_view" title="jenkins.Jenkins.create_view"><code class="xref py py-meth docutils literal notranslate"><span class="pre">Jenkins.create_view()</span></code></a>.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>name</strong> – Name of Jenkins view, <code class="docutils literal notranslate"><span class="pre">str</span></code></li>
<li><strong>config_xml</strong> – New XML configuration, <code class="docutils literal notranslate"><span class="pre">str</span></code></li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="jenkins.Jenkins.get_view_config">
<code class="descname">get_view_config</code><span class="sig-paren">(</span><em>name</em><span class="sig-paren">)</span><a class="headerlink" href="#jenkins.Jenkins.get_view_config" title="Permalink to this definition">¶</a></dt>
<dd><p>Get configuration of existing Jenkins view.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> – Name of Jenkins view, <code class="docutils literal notranslate"><span class="pre">str</span></code></td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">view configuration (XML format)</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="jenkins.Jenkins.get_promotion_name">
<code class="descname">get_promotion_name</code><span class="sig-paren">(</span><em>name</em>, <em>job_name</em><span class="sig-paren">)</span><a class="headerlink" href="#jenkins.Jenkins.get_promotion_name" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the name of a promotion using the API.</p>
<p>That is roughly an identity method which can be used to
quickly verify a promotion exists for a job or is accessible
without causing too much stress on the server side.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>job_name</strong> – Job name, <code class="docutils literal notranslate"><span class="pre">str</span></code></li>
<li><strong>name</strong> – Promotion name, <code class="docutils literal notranslate"><span class="pre">str</span></code></li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">Name of promotion or None</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="jenkins.Jenkins.assert_promotion_exists">
<code class="descname">assert_promotion_exists</code><span class="sig-paren">(</span><em>name</em>, <em>job_name</em>, <em>exception_message='promotion[%s] does not exist for job[%s]'</em><span class="sig-paren">)</span><a class="headerlink" href="#jenkins.Jenkins.assert_promotion_exists" title="Permalink to this definition">¶</a></dt>
<dd><p>Raise an exception if a job lacks a promotion</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>job_name</strong> – Job name, <code class="docutils literal notranslate"><span class="pre">str</span></code></li>
<li><strong>name</strong> – Name of Jenkins promotion, <code class="docutils literal notranslate"><span class="pre">str</span></code></li>
<li><strong>exception_message</strong> – Message to use for the exception. Formatted
with <code class="docutils literal notranslate"><span class="pre">name</span></code> and <code class="docutils literal notranslate"><span class="pre">job_name</span></code></li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Throws:</th><td class="field-body"><p class="first last"><a class="reference internal" href="#jenkins.JenkinsException" title="jenkins.JenkinsException"><code class="xref py py-class docutils literal notranslate"><span class="pre">JenkinsException</span></code></a> whenever the promotion
does not exist on a job</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="jenkins.Jenkins.promotion_exists">
<code class="descname">promotion_exists</code><span class="sig-paren">(</span><em>name</em>, <em>job_name</em><span class="sig-paren">)</span><a class="headerlink" href="#jenkins.Jenkins.promotion_exists" title="Permalink to this definition">¶</a></dt>
<dd><p>Check whether a job has a certain promotion</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>job_name</strong> – Job name, <code class="docutils literal notranslate"><span class="pre">str</span></code></li>
<li><strong>name</strong> – Name of Jenkins promotion, <code class="docutils literal notranslate"><span class="pre">str</span></code></li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last"><code class="docutils literal notranslate"><span class="pre">True</span></code> if Jenkins promotion exists</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="jenkins.Jenkins.get_promotions_info">
<code class="descname">get_promotions_info</code><span class="sig-paren">(</span><em>job_name</em>, <em>depth=0</em><span class="sig-paren">)</span><a class="headerlink" href="#jenkins.Jenkins.get_promotions_info" title="Permalink to this definition">¶</a></dt>
<dd><p>Get promotion information dictionary of a job</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>name</strong> – job_name, <code class="docutils literal notranslate"><span class="pre">str</span></code></li>
<li><strong>depth</strong> – JSON depth, <code class="docutils literal notranslate"><span class="pre">int</span></code></li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">Dictionary of promotion info, <code class="docutils literal notranslate"><span class="pre">dict</span></code></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="jenkins.Jenkins.get_promotions">
<code class="descname">get_promotions</code><span class="sig-paren">(</span><em>job_name</em><span class="sig-paren">)</span><a class="headerlink" href="#jenkins.Jenkins.get_promotions" title="Permalink to this definition">¶</a></dt>
<dd><p>Get list of promotions running.</p>
<p>Each promotion is a dictionary with ‘name’ and ‘url’ keys.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>job_name</strong> – Job name, <code class="docutils literal notranslate"><span class="pre">str</span></code></td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">list of promotions, <code class="docutils literal notranslate"><span class="pre">[</span> <span class="pre">{</span> <span class="pre">str:</span> <span class="pre">str}</span> <span class="pre">]</span></code></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="jenkins.Jenkins.delete_promotion">
<code class="descname">delete_promotion</code><span class="sig-paren">(</span><em>name</em>, <em>job_name</em><span class="sig-paren">)</span><a class="headerlink" href="#jenkins.Jenkins.delete_promotion" title="Permalink to this definition">¶</a></dt>
<dd><p>Delete Jenkins promotion permanently.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>job_name</strong> – Job name, <code class="docutils literal notranslate"><span class="pre">str</span></code></li>
<li><strong>name</strong> – Name of Jenkins promotion, <code class="docutils literal notranslate"><span class="pre">str</span></code></li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="jenkins.Jenkins.create_promotion">
<code class="descname">create_promotion</code><span class="sig-paren">(</span><em>name</em>, <em>job_name</em>, <em>config_xml</em><span class="sig-paren">)</span><a class="headerlink" href="#jenkins.Jenkins.create_promotion" title="Permalink to this definition">¶</a></dt>
<dd><p>Create a new Jenkins promotion</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>name</strong> – Name of Jenkins promotion, <code class="docutils literal notranslate"><span class="pre">str</span></code></li>
<li><strong>job_name</strong> – Job name, <code class="docutils literal notranslate"><span class="pre">str</span></code></li>
<li><strong>config_xml</strong> – config file text, <code class="docutils literal notranslate"><span class="pre">str</span></code></li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="jenkins.Jenkins.reconfig_promotion">
<code class="descname">reconfig_promotion</code><span class="sig-paren">(</span><em>name</em>, <em>job_name</em>, <em>config_xml</em><span class="sig-paren">)</span><a class="headerlink" href="#jenkins.Jenkins.reconfig_promotion" title="Permalink to this definition">¶</a></dt>
<dd><p>Change configuration of existing Jenkins promotion.</p>
<p>To create a new promotion, see <a class="reference internal" href="#jenkins.Jenkins.create_promotion" title="jenkins.Jenkins.create_promotion"><code class="xref py py-meth docutils literal notranslate"><span class="pre">Jenkins.create_promotion()</span></code></a>.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>name</strong> – Name of Jenkins promotion, <code class="docutils literal notranslate"><span class="pre">str</span></code></li>
<li><strong>job_name</strong> – Job name, <code class="docutils literal notranslate"><span class="pre">str</span></code></li>
<li><strong>config_xml</strong> – New XML configuration, <code class="docutils literal notranslate"><span class="pre">str</span></code></li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="jenkins.Jenkins.get_promotion_config">
<code class="descname">get_promotion_config</code><span class="sig-paren">(</span><em>name</em>, <em>job_name</em><span class="sig-paren">)</span><a class="headerlink" href="#jenkins.Jenkins.get_promotion_config" title="Permalink to this definition">¶</a></dt>
<dd><p>Get configuration of existing Jenkins promotion.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>name</strong> – Name of Jenkins promotion, <code class="docutils literal notranslate"><span class="pre">str</span></code></li>
<li><strong>job_name</strong> – Job name, <code class="docutils literal notranslate"><span class="pre">str</span></code></li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">promotion configuration (XML format)</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="jenkins.Jenkins.quiet_down">
<code class="descname">quiet_down</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#jenkins.Jenkins.quiet_down" title="Permalink to this definition">¶</a></dt>
<dd><p>Prepare Jenkins for shutdown.</p>
<p>No new builds will be started allowing running builds to complete
prior to shutdown of the server.</p>
</dd></dl>
<dl class="method">
<dt id="jenkins.Jenkins.wait_for_normal_op">
<code class="descname">wait_for_normal_op</code><span class="sig-paren">(</span><em>timeout</em><span class="sig-paren">)</span><a class="headerlink" href="#jenkins.Jenkins.wait_for_normal_op" title="Permalink to this definition">¶</a></dt>
<dd><p>Wait for jenkins to enter normal operation mode.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>timeout</strong> – number of seconds to wait, <code class="docutils literal notranslate"><span class="pre">int</span></code>
Note this is not the same as the connection timeout set via
__init__ as that controls the socket timeout. Instead this is
how long to wait until the status returned.</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><code class="docutils literal notranslate"><span class="pre">True</span></code> if Jenkins became ready in time, <code class="docutils literal notranslate"><span class="pre">False</span></code>
otherwise.</td>
</tr>
</tbody>
</table>
<p>Setting timeout to be less than the configured connection timeout
may result in this waiting for at least the connection timeout
length of time before returning. It is recommended that the timeout
here should be at least as long as any set connection timeout.</p>
</dd></dl>
</dd></dl>
<span class="target" id="module-jenkins.plugins"></span><dl class="class">
<dt>
<em class="property">class </em><code class="descclassname">jenkins.plugins.</code><code class="descname">Plugin</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span></dt>
<dd><p>Dictionary object containing plugin metadata.</p>
<p>Populates dictionary using json object input.</p>
<p>accepts same arguments as python <cite>dict</cite> class.</p>
</dd></dl>
<dl class="class">
<dt>
<em class="property">class </em><code class="descclassname">jenkins.plugins.</code><code class="descname">PluginVersion</code><span class="sig-paren">(</span><em>version</em><span class="sig-paren">)</span></dt>
<dd><p>Class providing comparison capabilities for plugin versions.</p>
<p>Parse plugin version and store it for comparison.</p>
</dd></dl>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h4>Previous topic</h4>
<p class="topless"><a href="index.html"
title="previous chapter">Python Jenkins</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="examples.html"
title="next chapter">Using Python-Jenkins</a></p>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/api.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="examples.html" title="Using Python-Jenkins"
>next</a> |</li>
<li class="right" >
<a href="index.html" title="Python Jenkins"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">Python Jenkins 0.4.15 documentation</a> »</li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2010, Willow Garage.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.3.
</div>
</body>
</html>
distrib
>
Mageia
>
7
>
i586
>
media
>
core-release
>
by-pkgid
>
f4c39736165fb5de6c035ac134b76c07
>
files
>
59
