API documentation

class jenkins.Job(name, server)

Represents a Jenkins job.

baseurl

build(parameters=None, token=None)

Trigger a build.

buildnumbers

builds

classmethod copy(source, dest, server)

Copy a Jenkins job.

classmethod create(name, configxml, server)

Create a new Jenkins job.

delete()

Permanently remove job.

disable()

Disable job.

enable()

Enable job.

enabled

last_build

last_stable_build

last_successful_build

name

server

class jenkins.Jenkins(url, username=None, password=None, verify=True, cert=None)

build(name, number)

build_info(job, number)

build_isbuilding(job, number)

build_stop(job, number)

build_wait(job, number, interval=1, timeout=None)

Wait for build to complete.

computer

Get information about the Jenkins build executors.

crumb

Get crumb (or None if doesn’t exist) from the Jenkins.

crumb_header

info

Get information about this Jenkins instance.

job(name)

job_build(name, parameters=None, token=None)

Trigger a build.

job_builds(name)

job_config(name)

job_config_etree(name)

job_copy(source, dest)

Copy a Jenkins job.

job_create(name, config)

Create a new Jenkins job.

job_delete(name)

Permanently remove job.

job_disable(name)

Disable job.

job_enable(name)

Enable job.

job_enabled(name)

job_exists(name)

Check if object exists.

job_info(name)

job_last_build(name)

job_last_stable_build(name)

job_last_successful_build(name)

job_reconfigure(name, newconfig)

Update the config.xml of an existing item.

job_reconfigure_etree(name, newconfig)

jobnames

jobs

node(name)

node_config(name)

node_config_etree(name)

node_create(name, remotefs, *args, **kw)

Parameters:

• name – name of node to create, str
• remotefs – Remote root directory, str
• num_executors – number of executors for node, int
• node_description – Description of node, str
• labels – Labels to associate with node, str
• exclusive – Use this node for tied jobs only, bool
• launcher – Slave launch method, NodeLaunchMethod|str
• launcher_params – Additional launcher parameters, dict

node_delete(name)

Permanently remove node.

node_exists(name)

Check if object exists.

node_info(name)

nodenames

nodes

view(name)

view_add_job(name, job_name)

Add job to the view.

view_config(name)

view_config_etree(name)

view_create(name, config)

Create a new Jenkins view.

view_delete(name)

Permanently remove view.

view_exists(name)

Check if object exists.

view_has_job(name, job_name)

Check if view contains job.

view_jobnames(name)

view_jobs(name)

view_reconfigure(name, newconfig)

view_reconfigure_etree(name, newconfig)

view_remove_job(name, job_name)

Remove job from view.

viewnames

views

xjobs

class jenkins.Server(url, username=None, password=None, verify=True, cert=None)

get(url, throw=True, **kw)

json(url, errmsg=None, throw=True, **kw)

post(url, throw=True, **kw)

urljoin(*args)

exception jenkins.JenkinsError(msg)

Exception type for Jenkins-API related failures.

class jenkins.Build(job, number)

Represents a Jenkins build.

baseurl

building

job

number

server

stop()

wait(tick=1, timeout=None)

Wait for build to complete.

class jenkins.View(name, server)

Represents a Jenkins view.

add_job(job)

Add job to the view.

baseurl

classmethod create(name, configxml, server)

Create a new Jenkins view.

delete()

Permanently remove view.

has_job(job)

Check if view contains job.

jobnames

jobs

name

remove_job(job)

Remove job from view.

server

class jenkins.Node(name, server)

Represents a Jenkins node.

baseurl

classmethod create(name, remotefs, server, num_executors=2, node_description=None, labels=None, exclusive=False, launcher='hudson.slaves.CommandLauncher', launcher_params={})

Parameters:

• name – name of node to create, str
• remotefs – Remote root directory, str
• num_executors – number of executors for node, int
• node_description – Description of node, str
• labels – Labels to associate with node, str
• exclusive – Use this node for tied jobs only, bool
• launcher – Slave launch method, NodeLaunchMethod|str
• launcher_params – Additional launcher parameters, dict

delete()

Permanently remove node.

name

reconfigure(newconfig)

Update the config.xml of an existing item.

server