如何获取具有名称和版本对的已安装Jenkins插件的列表

如何获取已安装的Jenkins插件的列表？

我搜索了Jenkins远程访问API文档，但没有找到。我应该使用Jenkins的CLI吗？有文件或范例吗？

您可以使用Jenkins脚本控制台检索信息，可以通过访问进行访问http://<jenkins-url>/script。（鉴于您已登录并具有所需的权限）。

输入以下Groovy脚本以遍历已安装的插件并打印出相关信息：

Jenkins.instance.pluginManager.plugins.each{
  plugin -> 
    println ("${plugin.getDisplayName()} (${plugin.getShortName()}): ${plugin.getVersion()}")
}

它将打印出这样的结果列表（剪切）：

该解决方案与上面的答案之一相似，因为它使用了Groovy，但是这里我们改用脚本控制台。使用Jenkins时，脚本控制台非常有用。

更新资料

如果您喜欢排序列表，可以调用以下sort方法：

def pluginList = new ArrayList(Jenkins.instance.pluginManager.plugins)
pluginList.sort { it.getShortName() }.each{
  plugin -> 
    println ("${plugin.getDisplayName()} (${plugin.getShortName()}): ${plugin.getVersion()}")
}

根据您的喜好调整Closure（例如，此处按shortName排序，在示例中按DisplayName排序）

这些天，我使用与下面@Behe描述的答案相同的方法，而不是https://stackoverflow.com/a/35292719/1597808

您可以将API与depth，XPath和wrapper参数结合使用。

以下内容将查询pluginManager的API，以列出所有已安装的插件，但仅返回其shortName和version属性。您当然可以通过添加“ |”来检索其他字段 到XPath参数的末尾，并指定用于标识节点的模式。

wget http://<jenkins>/pluginManager/api/xml?depth=1&xpath=/*/*/shortName|/*/*/version&wrapper=plugins

在这种情况下，必须使用wrapper参数，因为它要返回一个以上的节点作为结果的一部分，这都是因为它要与XPath和多个插件节点匹配多个字段。

在浏览器中使用以下URL可能有用，以查看有关插件的哪些信息，然后确定要使用XPath限制的内容：

http://<jenkins>/pluginManager/api/xml?depth=1

詹金斯1.588（2 ^次 11月，2014）和1.647（4 ^个月的，2016）

• 詹金斯>管理詹金斯

  

• 系统信息

  

• 外挂程式

  

Jenkins CLI支持列出所有已安装的插件：

java -jar jenkins-cli.jar -s http://localhost:8080/ list-plugins

像这样使用Jenkins CLI：

java -jar jenkins-cli.jar -s http://[jenkins_server] groovy = < pluginEnumerator.groovy

=在通话中表示“从标准输入中读取”。pluginEnumerator.groovy包含以下Groovy代码：

println "Running plugin enumerator"
println ""
def plugins = jenkins.model.Jenkins.instance.getPluginManager().getPlugins()
plugins.each {println "${it.getShortName()} - ${it.getVersion()}"}
println ""
println "Total number of plugins: ${plugins.size()}"

如果您想使用这些代码，请参阅Jenkins Java API文档。

如果您在docker环境中工作，并且想要以plugins.txt格式输出插件列表，以便将该插件列表传递给install_scripts.sh，请在http://{jenkins}/script控制台中使用以下脚本：

1. 此版本对于获取特定的软件包版本很有用

Jenkins.instance.pluginManager.plugins.each{
  plugin -> 
    println ("${plugin.getShortName()}:${plugin.getVersion()}")
}

2. 如果您只想要具有最新版本的插件，则可以使用此插件（感谢@KymikoLoco作为提示）

Jenkins.instance.pluginManager.plugins.each{
  plugin -> 
    println ("${plugin.getShortName()}:latest")
}

这里的答案有些不完整。而且我不得不从其他来源收集信息以实际获取插件列表。

1.获取Jenkins CLI

Jenkins CLI将允许我们从命令行与Jenkins服务器进行交互。我们可以通过简单的curl调用获得它。

curl 'localhost:8080/jnlpJars/jenkins-cli.jar' > jenkins-cli.jar

2.创建一个Groovy脚本进行解析（感谢malenkiy_scot）

将以下内容另存为plugins.groovy。

def plugins = jenkins.model.Jenkins.instance.getPluginManager().getPlugins()
plugins.each {println "${it.getShortName()}: ${it.getVersion()}"}

3.调用Jenkins API以获得插件结果

localhost:8080引用Groovy脚本时，使用您的登录用户名和密码调用Jenkins服务器（在此处）：

java -jar jenkins-cli.jar -s http://localhost:8080 groovy --username "admin" --password "admin" = < plugins.groovy > plugins.txt

plugins.txt的输出如下所示：

ace-editor: 1.1
ant: 1.5
antisamy-markup-formatter: 1.5
authentication-tokens: 1.3
blueocean-autofavorite: 1.0.0
blueocean-commons: 1.1.4
blueocean-config: 1.1.4
blueocean-dashboard: 1.1.4
blueocean-display-url: 2.0
blueocean-events: 1.1.4
blueocean-git-pipeline: 1.1.4
blueocean-github-pipeline: 1.1.4
blueocean-i18n: 1.1.4
blueocean-jwt: 1.1.4
blueocean-personalization: 1.1.4
blueocean-pipeline-api-impl: 1.1.4
blueocean-pipeline-editor: 0.2.0
blueocean-pipeline-scm-api: 1.1.4
blueocean-rest-impl: 1.1.4

Behe对排序插件的回答在我的Jenkins机器上不起作用。java.lang.UnsupportedOperationException由于尝试对不可变的集合（即）进行排序，因此收到了错误消息Jenkins.instance.pluginManager.plugins。代码的简单修复：

List<String> jenkinsPlugins = new ArrayList<String>(Jenkins.instance.pluginManager.plugins);
jenkinsPlugins.sort { it.displayName }
              .each { plugin ->
                   println ("${plugin.shortName}:${plugin.version}")
              }

使用http://<jenkins-url>/scriptURL运行代码。

如果您是Jenkins管理员，则可以使用Jenkins系统信息页面：

http://<jenkinsurl>/systemInfo

与curl和jq：

curl -s <jenkins_url>/pluginManager/api/json?depth=1 \
  | jq -r '.plugins[] | "\(.shortName):\(.version)"' \
  | sort

此命令以特殊的Jenkins plugins.txt文件使用的格式提供输出，使您可以预安装依赖项（例如，在docker映像中）：

ace-editor:1.1
ant:1.8
apache-httpcomponents-client-4-api:4.5.5-3.0

一个示例plugins.txt：https : //github.com/hoto/jenkinsfile-examples/blob/master/source/jenkins/usr/share/jenkins/plugins.txt

在Jenkins主页上：

1. 单击管理詹金斯。
2. 单击管理插件。
3. 单击已安装选项卡。

要么

1. 直接转到Jenkins URL：{您的Jenkins基本URL} / pluginManager / installed

与凭据共享此处找到的另一个选项

JENKINS_HOST=username:password@myhost.com:port
curl -sSL "http://$JENKINS_HOST/pluginManager/api/xml?depth=1&xpath=/*/*/shortName|/*/*/version&wrapper=plugins" | perl -pe 's/.*?<shortName>([\w-]+).*?<version>([^<]+)()(<\/\w+>)+/\1 \2\n/g'|sed 's/ /:/'

我想要一个无需任何身份验证即可在master上运行的解决方案，并且在这里看不到它。我做了一个快速的bash脚本，它将从插件目录中提取所有版本。

if [ -f $JENKINS_HOME/plugin_versions.txt ]; then
  rm $JENKINS_HOME/plugin_versions.txt
fi

for dir in $JENKINS_HOME/plugins/*/; do
  dir=${dir%*/}
  dir=${dir##*/}
  version=$(grep Plugin-Version $JENKINS_HOME/plugins/$dir/META-INF/MANIFEST.MF | awk -F': ' '{print $2}')
  echo $dir $version >> $JENKINS_HOME/plugin_versions.txt
done

我认为这些答案还不够好……许多涉及一些额外的幕后步骤。这是我的方法。

sudo apt-get install jq

...因为调用API后需要使用JSON输出。

#!/bin/bash
server_addr = 'jenkins'
server_port = '8080'

curl -s -k "http://${server_addr}:${server_port}/pluginManager/api/json?depth=1" \
  | jq '.plugins[]|{shortName, version,longName,url}' -c | sort \
  > plugin-list

echo "dude, here's your list: "
cat plugin-list

Python用户的另一种选择：

from jenkinsapi.jenkins import Jenkins

#get the server instance
jenkins_url = 'http://<jenkins-hostname>:<jenkins-port>/jenkins'
server = Jenkins(jenkins_url, username = '<user>', password = '<password>')

#get the installed plugins as list and print the pairs
plugins_dictionary = server.get_plugins().get_plugins_dict()
for key, value in plugins_dictionary.iteritems():
    print "Plugin name: %s, version: %s" %(key, value.version)

# list of plugins in sorted order
# Copy this into your Jenkins script console
    def plugins = jenkins.model.Jenkins.instance.getPluginManager().getPlugins()

    List<String> list = new ArrayList<String>()

    i = 0
    plugins.each {
      ++i
      //println " ${i}  ${it.getShortName()}: ${it.getVersion()}"
      list.add("${it.getShortName()}: ${it.getVersion()}")
    }

    list.sort{it}
    i = 0
    for (String item : list) {
      i++
      println(" ${i} ${item}")
    }

有一个表列出了所有已安装的插件以及是否在http：// jenkins / systemInfo上启用了这些插件

如果Jenkins在Jenkins Docker容器中运行，则可以在Bash中使用以下命令行：

java -jar /var/jenkins_home/war/WEB-INF/jenkins-cli.jar -s http://localhost:8080/ list-plugins --username admin --password `/bin/cat /var/jenkins_home/secrets/initialAdminPassword`

对于Jenkins 2.125版，以下工作。

注意：用相应用户的有效UserName和APIKey替换说USERNAME和APIKEY的部分。可通过“ 管理用户” →“ 选择用户” →“ API密钥”选项获得用户的API密钥。

如果您的Jenkins安装开始时间较长，则可能需要延长睡眠时间。

yum update -y如果您还使用yum安装了Jenkins，则启动程序还将升级该版本。

#JENKINS AUTO UPDATE SCRIPT link this script into a cron
##############
!/bin/bash
sudo yum update -y
sleep 120
UPDATE_LIST=$( sudo /usr/bin/java -jar /var/cache/jenkins/war/WEB-INF/jenkins-cli.jar -auth [USERNAME:APIKEY] -s http://localhost:8080/ list-plugins | grep -e ')$' | awk '{ print $1 }' );
if [ ! -z "${UPDATE_LIST}" ]; then
    echo Updating Jenkins Plugins: ${UPDATE_LIST};
    sudo /usr/bin/java -jar /var/cache/jenkins/war/WEB-INF/jenkins-cli.jar -auth [USERNAME:APIKEY] -s http://localhost:8080/ install-plugin ${UPDATE_LIST};
    sudo /usr/bin/java -jar /var/cache/jenkins/war/WEB-INF/jenkins-cli.jar -auth [USERNAME:APIKEY] -s http://localhost:8080/ safe-restart;
fi
##############

有很多方法可以获取此信息，但是我正在编写以下两种方法：-

1.获取詹金斯cli。

jenkins CLI将允许我们从命令行与jenkins服务器进行交互。我们可以通过简单的curl调用获得它。

curl 'localhost:8080/jnlpJars/jenkins-cli.jar' > jenkins-cli.jar

2.创建一个Groovy脚本。或从jenkins脚本控制台

我们需要创建一个Groovy脚本来解析从jenkins API接收到的信息。这将输出每个插件及其版本。将以下内容另存为plugins.groovy。

def plugins = jenkins.model.Jenkins.instance.getPluginManager().getPlugins() plugins.each {println "${it.getShortName()}: ${it.getVersion()}"}

您也可能会对插件可用的更新感兴趣。为此，您必须将有关已安装插件的数据与有关更新的信息合并到此处https://updates.jenkins.io/current/update-center.json。

要将下载的文件解析为JSON，您必须在线阅读第二行（巨大）。