Plugins and Plugin

Plugins

jenkinsapi plugins

class jenkinsapi.plugins.Plugins(url: str, jenkins_obj: Jenkins)[source]

Bases: JenkinsBase

Plugins class for jenkinsapi

check_updates_server() → None[source]
disable_plugin(shortName: str) → None[source]

Disable an enabled plugin.

Parameters:

shortName – Plugin short name (ID)

downgrade_plugin(shortName: str) → None[source]

Downgrade a plugin to its previous version.

Parameters:

shortName – Plugin short name (ID)

enable_plugin(shortName: str) → None[source]

Enable a disabled plugin.

Parameters:

shortName – Plugin short name (ID)

get_jenkins_obj() → Jenkins[source]
get_plugins_dict() → dict[str, Plugin][source]
iteritems() → Generator[str, 'Plugin'][source]
keys() → list[str][source]
plugin_version_already_installed(plugin) → bool[source]

Check if plugin version is already installed

plugin_version_is_being_installed(plugin) → bool[source]

Return true if plugin is currently being installed.

property restart_required

Call after plugin installation to check if Jenkins requires a restart

unpin_plugin(shortName: str) → None[source]

Unpin a pinned plugin, allowing it to be updated or replaced.

Parameters:

shortName – Plugin short name (ID)

property update_center_dict
property update_center_install_status

Jenkins 2.x specific

values() → list[Plugin][source]

Plugin

Module for jenkinsapi Plugin

class jenkinsapi.plugin.Plugin(plugin_dict: dict | str)[source]

Bases: object

Plugin class

get_attributes() → str[source]

Used by Plugins object to install plugins in Jenkins

is_latest(update_center_dict: dict) → bool[source]

Used by Plugins object to determine if plugin can be installed through the update center (when plugin version is latest version), or must be installed by uploading the plugin hpi file.

to_plugin(plugin_string: str) → dict[source]