Jenkins

Module for jenkinsapi Jenkins object

class jenkinsapi.jenkins.Jenkins(baseurl: str, username: str = '', password: str = '', requester=None, lazy: bool = False, ssl_verify: bool = True, cert=None, timeout: int = 10, use_crumb: bool = True, max_retries=None)

Bases: JenkinsBase

Represents a jenkins environment.

base_server_url()

build_job(jobname: str, params=None) → None

Invoke a build by job name :param jobname: name of exist job, str :param params: the job params, dict :return: none

cancel_quiet_down()

Cancel the effect of the quiet-down command

copy_job(jobname: str, newjobname: str) → Job

create_job(jobname: str, xml) → Job

Create a job

alternatively you can create job using Jobs object: self.jobs[‘job_name’] = config :param jobname: name of new job, str :param config: configuration of new job, xml :return: new Job obj

create_multibranch_pipeline_job(jobname, xml, block=True, delay=60)

Returns:

list of new Job objects

create_node(name: str, num_executors: int = 2, node_description: str = '', remote_fs: str = '/var/lib/jenkins', labels=None, exclusive: bool = False) → Node

Create a new JNLP slave node by name.

To create SSH node, please see description in Node class

Parameters:

• name – fqdn of slave, str

• num_executors – number of executors, int

• node_description – a freetext field describing the node

• remote_fs – jenkins path, str

• labels – labels to associate with slave, str

• exclusive – tied to specific job, boolean

Returns:

node obj

create_node_with_config(name: str, config) → Node | None

Create a new slave node with specific configuration. Config should be resemble the output of node.get_node_attributes() :param str name: name of slave :param dict config: Node attributes for Jenkins API request

to create node (See function output Node.get_node_attributes())

Returns:

node obj

property credentials

property credentials_by_id

delete_job(jobname: str) → None

Delete a job by name :param jobname: name of a exist job, str :return: new jenkins_obj

delete_node(nodename: str) → None

Remove a node from the managed slave list Please note that you cannot remove the master node

Parameters:

nodename – string holding a hostname

Returns:

None

delete_plugin(plugin: str | Plugin, restart: bool = True, force_restart: bool = False, wait_for_reboot: bool = True, no_reboot_warning: bool = False) → None

Delete a plugin and optionally restart jenkins. Will not delete dependencies. @param plugin: Plugin (string or Plugin object) to be deleted @param restart: Boolean, restart Jenkins when required by plugin @param force_restart: Boolean, force Jenkins to restart,

ignoring plugin preferences

delete_plugins(plugin_list, restart: bool = True, force_restart: bool = False, wait_for_reboot: bool = True, no_reboot_warning: bool = False)

Delete a list of plugins and optionally restart jenkins. Will not delete dependencies. @param plugin_list: List of plugins (strings, Plugin objects or

a mix of the two) to be deleted

@param restart: Boolean, restart Jenkins when required by plugin @param force_restart: Boolean, force Jenkins to restart,

ignoring plugin preferences

delete_view_by_url(viewurl: str)

generate_new_api_token(new_token_name: str = 'Token By jenkinsapi python')

get_artifact_data(id_)

get_create_url() → str

get_credentials(cred_class=<class 'jenkinsapi.credentials.Credentials2x'>)

Return credentials

get_executors(nodename: str) → Executors

get_jenkins_obj()

get_jenkins_obj_from_url(url: str)

get_job(jobname: str) → Job

Get a job by name :param jobname: name of the job, str :return: Job obj

get_job_by_url(url: str, job_name: str) → Job

Get a job by url :param url: jobs’ url :param jobname: name of the job, str :return: Job obj

get_jobs()

Fetch all the build-names on this Jenkins server.

get_jobs_info()

Get the jobs information :return url, name

get_jobs_list()

get_label(label_name: str) → Label

get_master_data()

get_node(nodename: str) → Node

Get a node object for a specific node

get_node_url(nodename: str = '') → str

Return the url for nodes

get_nodes() → Nodes

get_nodes_url() → str

get_plugins(depth: int = 1) → Plugins

get_plugins_url(depth)

get_queue() → Queue

get_queue_url()

get_view_by_url(view_url: str)

has_job(jobname: str) → bool

Does a job by the name specified exist :param jobname: string :return: boolean

has_node(nodename: str) → bool

Does a node by the name specified exist :param nodename: string, hostname :return: boolean

has_plugin(plugin_name: str) → bool

install_plugin(plugin: str | Plugin, restart: bool = True, force_restart: bool = False, wait_for_reboot: bool = True, no_reboot_warning: bool = False)

Install a plugin and optionally restart jenkins. @param plugin: Plugin (string or Plugin object) to be installed @param restart: Boolean, restart Jenkins when required by plugin @param force_restart: Boolean, force Jenkins to restart,

ignoring plugin preferences

@param no_warning: Don’t show warning when restart is needed and restart parameters are set to False

install_plugins(plugin_list, restart: bool = True, force_restart: bool = False, wait_for_reboot: bool = True, no_reboot_warning: bool = False) → None

Install a list of plugins and optionally restart jenkins. @param plugin_list: List of plugins (strings, Plugin objects or

a mix of the two) to be installed

@param restart: Boolean, restart Jenkins when required by plugin @param force_restart: Boolean, force Jenkins to restart,

ignoring plugin preferences

property is_quieting_down: bool

items()

Parameters:

return – A list of pairs. Each pair will be (job name, Job object)

iteritems()

iterkeys()

property jobs

keys()

property nodes

property plugins

quiet_down()

Put Jenkins in a Quiet mode, preparation for restart. No new builds started

rename_job(jobname: str, newjobname: str) → Job

Rename a job :param jobname: name of a exist job, str :param newjobname: name of new job, str :return: new Job obj

run_groovy_script(script: str) → str

Runs the requested groovy script on the Jenkins server returning the result as text. Raises a JenkinsAPIException if the returned HTTP response code from the POST request is not 200 OK.

Example:

server = Jenkins(…) script = ‘println “Hello world!”’ result = server.run_groovy_script(script) print(result) # will print “Hello world!”

safe_exit(wait_for_exit: bool = True, max_wait: int = 360)

Restarts jenkins when no jobs are running, except for pipeline jobs

safe_restart(wait_for_reboot: bool = True)

restarts jenkins when no jobs are running

shutdown() → None

use_auth_cookie() → None

validate_fingerprint(id_)

validate_fingerprint_for_build(digest, filename, job, build)

property version: str

Return version number of Jenkins

property views