Jenkins Command Line大全[翻译]

by [e-mail]2016.03.09

通用格式

java -jar jenkins-cli.jar [-s JENKINS_URL] command [options...] [arguments...]

JENKINS_URL范例：http://192.168.14.56:8080/jenkins/

 

add-job-to-view

         将一个任务加入视图中

         java -jarjenkins-cli.jar -s http://192.168.14.56:8080/jenkins/ add-job-to-view VIEW JOB...

         VIEW:视图名称

         JOB:job名称

build

         启动build，可以选择是否等待一个工作的完成。除了通用的脚本使用之外，该命令可以被用于在一个job的构建中调用另一个job。使用–s 选项，该命令更改构建输出和中断命令并且会中断job的返回码（返回0表示成功）。使用–f 选项，该命令更改基于输出构建的返回码（返回0表示成功）。但是，跟-s选项不一样，中断命令行不会中断job。（返回码125表示该命令被中断）。使用–c 选项，命令仅在SCM(源代码管理系统)发生改变时执行build。

         java -jarjenkins-cli.jar -s http://192.168.14.56:8080/jenkins/ build JOB [-c] [-f] [-p][-r N] [-s] [-v] [-w]

         JOB:要构建的Job名称

         -c:在构建前检查SCM更改，如果代码没有改动则不执行构建。

         -f:跟随构建过程，与-s相似，中断不会传给构建。

         -p:指定构建参数以key=value形式传入

         -s:等待直到命令完成或中断。中断会传给构建。

         -v:打印控构建的制台输出。使用-s

         -w:等待直到命令开始。

cancel-quiet-down

         消除“quiet-down”命令的影响。

         java-jar jenkins-cli.jar -s http://192.168.14.56:8080/jenkins/ cancel-quiet-down

clear-queue

         清除构建队列

         java-jar jenkins-cli.jar -s http://192.168.14.56:8080/jenkins/ clear-queue

connect-node

         java-jar jenkins-cli.jar -s http://192.168.14.56:8080/jenkins/ connect-node NAME[-f]

         重新连接至一个节点（jenkins主从节点）

         NAME:从节点名称，空表示master节点

         -f:取消所有当前正在等待的连接操作，并重试。

console

         java-jar jenkins-cli.jar -s http://192.168.14.56:8080/jenkins/ console JOB [BUILD][-f] [-n N]

         处理指定构建的标准控制台输出，就好像在使用’cat build.log’命令一样。

         JOB:job的名称

         BUILD:构建号或者指向构建的固定连接。默认指向最后一个构建。

         -f:如果构建正在执行，停住并追加控制台输出，就好像在使用’tail -f’命令一样。

         -nN:显示最后N行。

copy-job

java -jar jenkins-cli.jar -shttp://192.168.14.56:8080/jenkins/ copy-job SRC DST

         复制job

         SRC:待拷贝的job

         DST:新的待创建的job

create-job

java -jar jenkins-cli.jar -shttp://192.168.14.56:8080/jenkins/ create-job NAME

         通过从标准输入中读取一个xml配置文件来创建job

         NAME:job的名称

create-node

java -jar jenkins-cli.jar -shttp://192.168.14.56:8080/jenkins/ create-node [NODE]

         通过从标准输入中读取一个xml配置文件来创建新节点。

         NODE:节点名

create-view

java -jar jenkins-cli.jar -shttp://192.168.14.56:8080/jenkins/ create-view [VAL]

         通过从标准输入中读取一个xml配置文件来创建新视图。

         VAL:要使用的视图称名而不是在XML中的视图名称。

delete-builds

java -jar jenkins-cli.jar -shttp://192.168.14.56:8080/jenkins/ delete-builds JOB RANGE

         删除指定job的构建记录，可以是批量的。

         JOB:job名称。

         RANGE:要删除的构建的范围。”N-M”,”N,M”或者”N”。

delete-job

java -jar jenkins-cli.jar -shttp://192.168.14.56:8080/jenkins/ delete-job VAL ...

删除job

         VAL:要删除的job(s)名称。

delete-node

java -jar jenkins-cli.jar -shttp://192.168.14.56:8080/jenkins/ delete-node VAL ...

         删除节点

         VAL:要删除的节点(s)

delete-view

java -jar jenkins-cli.jar -shttp://192.168.14.56:8080/jenkins/ delete-view VAL ...

         删除视图

         VAL:要删除的视图名称

disable-job

java -jar jenkins-cli.jar -shttp://192.168.14.56:8080/jenkins/ disable-job NAME

         禁用job

         NAME:job名称

disconnect-node

java -jar jenkins-cli.jar -shttp://192.168.14.56:8080/jenkins/ disconnect-node NAME [-m VAL]

         断开节点的连接

         NAME:从节点名称，空字串表示master节点

         -mVAL:记录你为什么断开这个节点的笔记。

enable-job

java -jar jenkins-cli.jar -shttp://192.168.14.56:8080/jenkins/ enable-job NAME

         启用Job

         NAME:job名称

get-job

java -jar jenkins-cli.jar -shttp://192.168.14.56:8080/jenkins/ get-job JOB

         转储job的XML定义到标准输出。

         JOB:job的名称

get –node

java -jar jenkins-cli.jar -shttp://192.168.14.56:8080/jenkins/ get-job JOB

         转储节点的XML定义到标准输出。

         NODE:节点的名称。

get-view

java -jar jenkins-cli.jar -shttp://192.168.14.56:8080/jenkins/ get-view VIEW

         转储视图的XML定义到标准输出

         VIEW:要获取的视图名称

groovy

java -jar jenkins-cli.jar -shttp://192.168.14.56:8080/jenkins/ groovy [SCRIPT] [ARGUMENTS ...]

         执行指定的Groovy脚本

         SCRIPT:要执行的脚本文件，URL或者=代表标准输入。

         ARGUMENTS:传入脚本的命令行参数。

groovysh

java -jar jenkins-cli.jar -s http://192.168.14.56:8080/jenkins/groovysh [ARGS ...]

         执行交互的groovyshell

install-plugin

java -jar jenkins-cli.jar -shttp://192.168.14.56:8080/jenkins/ install-plugin SOURCE ... [-deploy] [-nameVAL] [-restart]

         从文件，URL或者updatecenter安装插件

         SOURCE:如果参数指向一个本地文件，该文件会被安装。如果是URL，jenkins下载该URL并安装插件。否则，这个名字会被认为是现有的update center中的插件的简写（例如:”findbugs”），这个插件会被从update center安装。

         -deploy:立刻部署该插件而不是推迟到重启jenkins.

         -nameVAL:如果指定该参数，插件会被以这么简写的名字安装。（然而通常插件的名字是从原文件名中自动推断出来的）。

         -restart插件安装成功之后重启jenkins

install-tool

java -jar jenkins-cli.jar -shttp://192.168.14.56:8080/jenkins/ install-tool [KIND] [NAME]

         执行自动化的工具安装，并且在标准输出中打印他的安装位置。只能在一个构建里面调用。

         KIND:要安装的工具类型，例如”Ant”

         NAME:要安装的工具名称，正如你已经进入了jenkins的系统配置页面。

keep-build

java -jar jenkins-cli.jar -shttp://192.168.14.56:8080/jenkins/ keep-build NAME BUILD#+

         标记这个构建以保证该构建永远运行。

         NAME:job名字

         BUILD#:构建序号

list-changes:

java -jar jenkins-cli.jar -shttp://192.168.14.56:8080/jenkins/ list-changes JOB RANGE [-format[XML| CSV | PLAIN]]

         转储指定构建的changelog

         JOB:要构建的job名字

         RANGE:要转储的构建范围，N-M,N,M或者N

         -format[XML |CSV | PLAIN] :控制如何输出该命令的结果。

list-jobs:

java -jar jenkins-cli.jar -shttp://192.168.14.56:8080/jenkins/ list-jobs [NAME]

         列出指定视图或者项目组的所有的jobs

         NAME:视图名字

list-plugins

java -jar jenkins-cli.jar -shttp://192.168.14.56:8080/jenkins/ list-plugins [NAME]

         列出已安装的插件

         NAME:指定插件名

login

java -jar jenkins-cli.jar -shttp://192.168.14.56:8080/jenkins/ login

         保存当前的凭据，以后的命令不再需要明确的登录凭据。

logout

java -jar jenkins-cli.jar -shttp://192.168.14.56:8080/jenkins/ logout

         删除登录命令中存储的凭据。

mail

java -jar jenkins-cli.jar -shttp://192.168.14.56:8080/jenkins/ mail

         从标准输出中读取并以e-mail的方式发送。

offline-node

java -jar jenkins-cli.jar -shttp://192.168.14.56:8080/jenkins/ offline-node NAME [-m VAL]

         临时停止节点，直至遇到下一个online-node命令

         NAME:从节点名字，空字串表示master

         -mVAL:记录为什么断开这个节点

online-node

java -jar jenkins-cli.jar -s http://192.168.14.56:8080/jenkins/online-node [NAME]

         恢复节点的使用。

         NAME:从节点名字，空字串表示master

quiet-down

java -jar jenkins-cli.jar -s http://192.168.14.56:8080/jenkins/quiet-down [-block] [-timeout N]

         使jenkins进入平息状态，为重启做准备。千万不要在此期间构建任何项目。

         -block:阻塞（该命令）直至系统真的平息下来而且没有项目在构建。

         -timeoutN: 如果非0，只阻塞指定的毫秒数。

reload-configuration

java -jar jenkins-cli.jar -s http://192.168.14.56:8080/jenkins/reload-configuration

         丢弃所有内存中已加载的数据并从文件系统中重新加载。在你修改了磁盘配置文件时这条命令会有用。

reload-job

java -jar jenkins-cli.jar -shttp://192.168.14.56:8080/jenkins/ reload-job VAL ...

         重新加载job(s)

         VAL:要重新加载的job名称

remove-job-from-view

java -jar jenkins-cli.jar -shttp://192.168.14.56:8080/jenkins/ remove-job-from-view VIEW JOB ...

         从指定视图中删除job

         VIEW:视图的名称

         JOB:job名

restart

java -jar jenkins-cli.jar -shttp://192.168.14.56:8080/jenkins/ restart

         重启jenkins

safe-restart

java -jar jenkins-cli.jar -shttp://192.168.14.56:8080/jenkins/ safe-restart

         安全重启jenkins

safe-shutdown

java -jar jenkins-cli.jar -shttp://192.168.14.56:8080/jenkins/ safe-shutdown

         将jenkins置为安静模式，等待现执行的构建完成。然后停止jenkins.

session-id

java -jar jenkins-cli.jar -shttp://192.168.14.56:8080/jenkins/ session-id

         输出session ID,每次jekins重启之后的sessionID都不同。

set-build-description

java -jar jenkins-cli.jar -shttp://192.168.14.56:8080/jenkins/ set-build-description JOB BUILD# DESCRIPTION

         设置一个构建的描述

         JOB:BUILD

         DESCRIPTION:要设置的描述，=从标准输入加载

set-build-display-name

java -jar jenkins-cli.jar -shttp://192.168.14.56:8080/jenkins/ set-build-display-name JOB BUILD#DISPLAYNAME

         设置构建的展示名称。

         JOB,BUILD#,

         DISPLAYNAME:要设置的展示名。-从标准输入加载

set-build-parameter

java -jar jenkins-cli.jar -shttp://192.168.14.56:8080/jenkins/ set-build-parameter NAME VALUE

         更改、设置当前正在处理的构建的构建参数。

         NAME:构建变量名

         VALUE:构建变量值

set -build-result+

java -jar jenkins-cli.jar -s http://192.168.14.56:8080/jenkins/set-build-result RESULT

         设置当前构建的结果。只能在一个构建之内调用。

set-external-build-result

java -jar jenkins-cli.jar -shttp://192.168.14.56:8080/jenkins/ set-external-build-result [--display (-n) DISPLAY][--dump-build-number (-b)] [--duration (-d) DURATION] --job (-j) JOB --log (-l)-|LOG [--result (-r) RESULT]

         设置额外的管理job结果

         --display(-n) DISPLAY   : Display name of thebuild

 --dump-build-number (-b) :Log the produced build number to the standard output

 --duration (-d) DURATION :Number of milli-seconds it took to run this build

 --job (-j) JOB           : Name of the external monitor job

 --log (-l) -|LOG         : Log to be set. '-' to read fromstdin (gzipped).

 --result (-r) RESULT     : 0: success, 1: fail

shutdown

java -jar jenkins-cli.jar -shttp://192.168.14.56:8080/jenkins/ shutdown

         立即关闭jekins服务器。

update-job

java -jar jenkins-cli.jar -shttp://192.168.14.56:8080/jenkins/ update-job JOB

         从标准输入中更新job的定义。与get-job相反

         JOB:job的名称

update-node

java -jar jenkins-cli.jar -shttp://192.168.14.56:8080/jenkins/ update-node NODE

update-view

java -jar jenkins-cli.jar -shttp://192.168.14.56:8080/jenkins/ update-view VIEW

version

java -jar jenkins-cli.jar -shttp://192.168.14.56:8080/jenkins/ version

         输出当前jenkins版本

wait-node-offline

java -jar jenkins-cli.jar -shttp://192.168.14.56:8080/jenkins/ wait-node-offline NAME

         等待直至一个节点下线。

         NAME:节点名字，空串表示master节点

wait-node-online

java -jar jenkins-cli.jar -shttp://192.168.14.56:8080/jenkins/ wait-node-online NAME

         等待一个节点上线。

         NAME:节点名字，空串表示master节点

who-am-i

java -jar jenkins-cli.jar -shttp://192.168.14.56:8080/jenkins/ who-am-i

         报告当前的凭证和权限。