Jenkins cli command details

The author 《 adopt CLI management Jenkins Server》 How to pass the SSH Or client command line management Jenkins Server, Limited to space , The main purpose of the previous article is to introduce the connection Jenkins Server The way . This paper mainly introduces Jenkins Server Common commands provided .

This article mainly demonstrates that SSH The way to perform common Jenkins CLI command , About passing SSH Connect Jenkins Server The content of , Please refer to the above . explain ： The demo environment for this article is Ubuntu 16.04.

from who-am-i Start

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

Copy

obtain Jenkins Server Version of

$ ssh -l jack -p 8090 192.168.21.145 version

Copy

add to agent

create-node The command needs to specify a xml File as parameter , This xml New... Is saved in the file node Configuration information . For convenience, we can use get-node Command to get an existing node Configuration file for , Then modify the configuration , And ultimately used to create new node. For example, we currently have a project named testagent Of node：

Use the following command to get its configuration information ：

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

Copy

Next, make a copy testagent.xml file , establish myagent.xml file , And modify it myagent.xml Related configuration in file . For example agent Change the name to myagent,host Change to new agent Of IP Address ,credentialsId Change to new with appropriate permissions ID. Finally, use the new myagent.xml File creation node：

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

Copy

So new node And we're done . Of course , We can also use delete-node Command to delete a node.

install plugin

Jenkins Actions provided by default plugin Of CLI Only   list-plugins and install-plugin.list-plugins Used to list all installed plugins：

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

Copy

If list-plugins Specify the parameters ( The name of the plug-in ), Then only the information of the plug-in is displayed , If the plug-in does not exist, an error will be reported ：

install-plugin The command is used to install plug-ins ： install-plugin SOURCE ... [-deploy] [-name VAL] [-restart] According to the designation source Options , Respectively from URL、 Local files and update center Installing a plug-in . The default from the update center Installing a plug-in , Only specify the short name of the plug-in (ID) That's all right. ：

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

Copy

-deploy It means to deploy the plug-in immediately without waiting for the next restart Jenkins.

If the specified plug-in already exists and needs to be upgraded to a new version , Do the same install-plugin Just order ：

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

Copy

-restart Option means restart after installation Jenkins.

etc. Jenkins After restart , It is found that the plug-in has been updated to the latest version ：

Be careful ：update center When installing the plug-in , It will automatically install the plug-ins that the current plug-in depends on .

Install plug-ins through local files download greenballs Plug in to the current directory , And then execute the command ：

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

Copy

Be careful , You need to pass -name Option specifies the name of the plug-in .

job operation

Jenkins CLI Provides a wealth of commands to operate job： list-jobs： List all by default job get-job： Get assigned job Configuration file for copy-job： With existing job Create a new... For the template job create-job： Create a new job, Take the content in the standard input as the configuration information update-job： Update with the content in the configuration file job delete-job： Delete job enable-job：enable job disable-job：disable job although job There are many commands involved in the operation , But they are relatively simple , I'm not going to show you one by one .

Trigger job

build The command is used to trigger a job Mission , We can go through help Order to check build Help documentation for commands ：

$ ssh -l jack -p 8090 192.168.21.145 help build

Copy

According to the above documents , Can pass -f and -v Execution of option synchronization job And get console output ：

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

Copy

summary

Jenkins CLI There are many commands supported by default , Here are just a few of them , The main purpose is to help understand Jenkins CLI Basic usage of commands . For more detailed usage of commands, please refer to the official documents .

Reference resources ： Jenkins CLI