Jenkins CLI工具[编辑 | 编辑源代码]

Jenkins CLI（Command Line Interface）工具是一个强大的命令行工具，允许用户通过终端与Jenkins服务器交互，执行任务、管理作业和配置系统，无需使用Web界面。它特别适合自动化脚本、批量操作或远程管理Jenkins实例。

介绍[编辑 | 编辑源代码]

Jenkins CLI工具是一个Java客户端，通过HTTP/HTTPS协议与Jenkins服务器通信。它支持多种操作，包括：

构建触发与管理
作业配置导出/导入
节点管理
插件安装/卸载
系统信息查询

CLI工具通常用于以下场景：

在CI/CD流水线中集成Jenkins操作
批量更新多个作业配置
无头（headless）服务器环境下的管理
自动化运维任务

安装与配置[编辑 | 编辑源代码]

Jenkins CLI工具（`jenkins-cli.jar`）通常从Jenkins服务器的`/cli`端点下载： ```bash wget http://your-jenkins-server:8080/jnlpJars/jenkins-cli.jar ```

验证连接： ```bash java -jar jenkins-cli.jar -s http://your-jenkins-server:8080/ help ```

基本命令[编辑 | 编辑源代码]

以下是一些常用命令示例：

触发构建[编辑 | 编辑源代码]

```bash java -jar jenkins-cli.jar -s http://localhost:8080/ build "MyJob" -p PARAM1=value1 ```

`-p` 用于传递参数（仅参数化作业需要）

获取作业信息[编辑 | 编辑源代码]

```bash java -jar jenkins-cli.jar -s http://localhost:8080/ get-job "MyJob" > MyJob.xml ``` 输出为XML格式的作业配置。

更新作业配置[编辑 | 编辑源代码]

```bash java -jar jenkins-cli.jar -s http://localhost:8080/ update-job "MyJob" < MyJob.xml ```

认证方式[编辑 | 编辑源代码]

CLI支持多种认证机制：

基本认证[编辑 | 编辑源代码]

```bash java -jar jenkins-cli.jar -s http://localhost:8080/ -auth username:apiToken list-jobs ```

SSH认证[编辑 | 编辑源代码]

1. 在Jenkins中配置用户的SSH公钥 2. 使用SSH端口连接： ```bash java -jar jenkins-cli.jar -s ssh://localhost:8022/ list-jobs ```

高级用法[编辑 | 编辑源代码]

Groovy脚本执行[编辑 | 编辑源代码]

```bash java -jar jenkins-cli.jar -s http://localhost:8080/ groovy = println Jenkins.instance.pluginManager.plugins.collect{ it.shortName } ``` 输出所有已安装插件列表。

管道交互[编辑 | 编辑源代码]

```bash echo 'println("Hello from CLI")' | java -jar jenkins-cli.jar -s http://localhost:8080/ groovy = ```

实际案例[编辑 | 编辑源代码]

案例1：批量禁用所有作业[编辑 | 编辑源代码]

```bash java -jar jenkins-cli.jar -s http://localhost:8080/ list-jobs | while read job; do

 java -jar jenkins-cli.jar -s http://localhost:8080/ disable-job "$job"

done ```

案例2：备份所有作业配置[编辑 | 编辑源代码]

```bash mkdir jenkins_backup java -jar jenkins-cli.jar -s http://localhost:8080/ list-jobs | while read job; do

 java -jar jenkins-cli.jar -s http://localhost:8080/ get-job "$job" > "jenkins_backup/${job}.xml"

done ```

安全注意事项[编辑 | 编辑源代码]

永远不要将认证信息硬编码在脚本中
使用最小权限原则分配CLI访问权限
考虑使用Jenkins凭据系统管理敏感信息
生产环境中建议使用HTTPS而非HTTP

故障排除[编辑 | 编辑源代码]

常见问题及解决方案：

错误	原因	解决方案
拒绝连接	防火墙阻止或Jenkins未运行	检查服务状态和端口
认证失败	无效凭据或权限不足	验证API令牌/SSH密钥
命令不存在	插件未安装	安装所需插件（如SSH插件）