Jenkins CLI 命令詳解

筆者在前文《經過 CLI 管理 Jenkins Server》中介紹瞭如何經過 SSH 或客戶端命令行的方式管理 Jenkins Server，限於篇幅，前文主要的目的是介紹鏈接 Jenkins Server 的方式。本文主要介紹 Jenkins Server 提供的經常使用命令。
本文主要演示以 SSH 的方式執行常見的 Jenkins CLI 命令，關於經過 SSH 鏈接 Jenkins Server 的內容，請參考前文。說明：本文的演示環境爲 ubuntu 16.04。

從 who-am-i 開始

$ ssh -l jack -p 8090 192.168.21.145 who-am-i

獲取 Jenkins Server 的版本

$ ssh -l jack -p 8090 192.168.21.145 version

添加 agent

create-node 命令須要指定一個 xml 文件做爲參數，這個 xml 文件中保存着新建 node 的配置信息。方便起見咱們能夠先使用 get-node 命令得到一個現有 node 的配置文件，而後修改其中的配置，並最終用來建立新的 node。好比咱們當前有一個名爲 testagent 的 node：

用下面的命令得到其配置信息：

$ ssh -l jack -p 8090 192.168.21.145 get-node testagent > testagent.xml

接下來複制一份 testagent.xml 文件，建立 myagent.xml 文件，並修改 myagent.xml 文件中的相關配置。好比把 agent 名稱改成 myagent，host 修改成新 agent 的 IP 地址，credentialsId 改成具備適當權限的新 ID。最後用新的 myagent.xml 文件建立 node：

$ ssh -l jack -p 8090 192.168.21.145 create-node < myagent.xml

這樣新的 node 就建立好了。固然，咱們也可使用 delete-node 命令刪除一個 node。

安裝 plugin

Jenkins 默認提供的操做 plugin 的 CLI 只有  list-plugins 和 install-plugin。list-plugins 用來羅列全部已安裝的 plugins：

$ ssh -l jack -p 8090 192.168.21.145 list-plugins

若是爲 list-plugins 指定參數(插件的名稱)，則只顯示該插件的信息，該插件不存在就報錯：

install-plugin 命令用來安裝插件：
install-plugin SOURCE ... [-deploy] [-name VAL] [-restart]
根據指定的 source 選項，分別能夠從 URL、本地文件和 update center 安裝插件。默認從 update center 安裝插件，只用指定插件的短名稱(ID)就能夠了：

$ ssh -l jack -p 8090 192.168.21.145 install-plugin greenballs -deploy

-deploy 表示當即部署插件而沒必要等到下次重啓 Jenkins。

若是指定的插件已經存在而且須要升級到新的版本，一樣執行 install-plugin 命令就能夠了：

$ ssh -l jack -p 8090 192.168.21.145 install-plugin pipeline-graph-analysis -restart

-restart 選項表示安裝完成後重啓 Jenkins。

等 Jenkins 重啓完成後，發現插件已經被更新到了最新的版本：

注意：update center 安裝插件時，會自動安裝當前插件所依賴的插件。

經過本地的文件安裝插件
下載 greenballs 插件到當前的目錄中，而後執行命令：

$ ssh -l jack -p 8090 192.168.21.145 install-plugin = -deploy < greenballs.hpi -name greenballs

注意，此時須要經過 -name 選項指定插件的名稱。

job 操做

Jenkins CLI 提供了豐富的命令來操做 job：
list-jobs：默認列出全部的 job
get-job：得到指定 job 的配置文件
copy-job：以現存的 job 爲模板建立一個新的 job
create-job：建立一個新的 job，以標準輸入中的內容做爲配置信息
update-job：以配置文件中的內容更新 job
delete-job：刪除 job
enable-job：enable job
disable-job：disable job
雖然 job 操做涉及的命令比較多，可是都相對的簡單，這裏再也不一一演示。

觸發 job

build 命令用來觸發一個 job 任務，咱們能夠經過 help 命令來查看一下 build 命令的幫助文檔：

$ ssh -l jack -p 8090 192.168.21.145 help build

由上面的文檔可知，能夠經過 -f 和 -v 選項同步的執行 job 並得到控制檯輸出：

$ ssh -l jack -p 8090 192.168.21.145 build test -f -v

總結

Jenkins CLI 默認支持的命令不少，這裏只是簡單介紹了其中的幾個，主要目的是幫助理解 Jenkins CLI 命令的基本用法。更多命令的詳細用法請參考官方文檔。

參考：
Jenkins CLI