Complete guide to use Jenkins CLI / Command line | Jenkins Tutorials

scmgalaxy K — Sun, 08 Jan 2017 08:37:19 +0000

Complete guide to use Jenkins CLI / Command line?

Run Jenkins build from command is very simple in Linux system. If you are using using windows, gitbash is a recommended which has bash shell in built. You can use windows command line as well. Jenkins has support to command line client that allows you to access Jenkins from command line.

To Trigger Jenkins build from command line some prerequisite are there

Jenkins service is running.

Enable security option under “Configure Global Security”

Go to jenkins dashboard in Home page ( e.g http://localhost:8080/ ) -> Manage Jenkins

-> Configure Global Security -> Click on “Enable security” checkbox

You can also configure “Access Control” and “Authorization” option in Global Security page.

Download Jenkins-cli.jar

Download Jenkins-cli.jar from http:///jnlpJars/jenkins-cli.jar. (Here is your respective Jenkins server URL (development or staging))

Go to http:///cli and build your command by following the instructions there.

How to login to Jenkins using commands

If your Jenkins requires authentication, use –username and –password or –password-file options to specify the credentials. To avoid doing this for every command, you can also use the login CLI command once (with the same credentials parameters), and after that you may use other commands without specifying credentials.

Whenever the CLI tries to to connect to the Jenkins server, it offers the before mentioned SSH keys. When the user has those keys but don’t want use them to authenticate, preventing being prompted by the key’s password, it’s possible to use the -noKeyAuth argument. This way the CLI will never try to use the SSH keys available. failure to authenticate by itself does not constitute a fatal error. It will instead try to execute the command anyway, as the anonymous user.

Login Jenkins using username and Password

Jenkins allow us to trigger Jenkins build with any specific user, For that we have to pass username and password in command line.

$ java -jar “/tmp/kitchen/cache/jenkins-cli.jar” -s http://localhost:8080 who-am-i –username jenkins –password foobar

$ java -jar jenkins-cli.jar -s http://myjenkins help –username me –password mypassword

Login Jenkins using public keys

Starting 1.419 (which will be out July 4th), Jenkins CLI supports authentication based on the SSH key pair. Just like CloudBees DEV@cloud (or GitHub, or other similar sites), you interactively login from the web UI, then associate your public keys with your user account. Then CLI will silently authenticates itself using your ~/.ssh/id_rsa, ~/.ssh/id_dsa, or ~/.ssh/identity.

https://help.github.com/articles/generating-an-ssh-key/

Login Jenkins using private keys

You can also pass the priate key as follows

To use the -i option the syntax is as follows:

$ java -jar jenkins-cli.jar -s http://myjenkins help -i ~/.ssh/id_rsa

$ java -jar jenkins-cli.jar [-s JENKINS_URL] [-i PRIVATE_KEY] command [options…] [arguments…]

For compatibility reasons, unless you use the -i option,

Login Jenkins using initialAdminPassword

try user “admin” and password from “Jenkins\secrets\initialAdminPassword”

java -jar jenkins-cli.jar -s http://localhost:8080 who-am-i –username admin –password fe3f1e1624ea4be8873b7a35e28b24be

Login Jenkins using passphrase

Go to http://jenkins-serer:8085/user/admin/configure and set the passphrase in “SSH Public Keys” and use the same passphrase with jenkins commands.

E.g 1 – Getting help

The list of the available commands depends on the server you are talking to. Visit https://jenkins.example.com/cli or use ‘help’ command to list them all:

> java -jar jenkins-cli.jar -s https://jenkins.example.com help [command]

E.g 2 – Run Jenkins Build From Command Line

> java -jar jenkins-cli.jar -s http:/// build build-name [-c] [-f] [-p] [-r N] [-s] [-v] [-w]

build-name : Name of the job to build

-c : Check for SCM changes before starting the build, and if there’s no change, exit without doing a build

-f : Follow the build progress. Like -s only interrupts are not passed through to the build.

-p : Specify the build parameters in the key=value format.

-s : Wait until the completion/abortion of the command. Interrupts are passed through to the build.

-v : Prints out the console output of the build. Use with -s

-w : Wait until the start of the command

Example – java -jar jenkins-cli.jar -s http://localhost:8080/ build ‘my-project-build’ –username roop –password roop

E.g 3 – List all jobs under the view: tools

$ java -jar jenkins-cli.jar -s http://jenkins/ list-jobs tools

E.g 4 – Get the configuration of the job: template

$ java -jar jenkins-cli.jar -s http://jenkins/ get-job template > template.xml

E.g 5 – Create a new job based on the configuration

$ java -jar jenkins-cli.jar -s http://jenkins/ create-job new_job_name < new_job_name.xml

E.g 6 – Run groovy script

$ java -jar jenkins-cli.jar -s http://jenkins/ groovy scripts/add_job_to_view.groovy

If there are any parameters in the script, just as:

import jenkins.model.*

if (args.length != 2 ) {

println “Error on arguments!”

}

def jobName = args[0] ?: ‘a_job’

def viewName = args[1] ?: ‘a_view’

println jobName + ‘ ‘ + viewName

def v = Jenkins.instance.getView(viewName)

def i = Jenkins.instance.getItemByFullName(jobName)

if (v && i) {

v.add(i)

}

pass the parameters as:

$ java -jar jenkins-cli.jar -s http://jenkins/ groovy scripts/add_job_to_view.groovy JOB_NAME VIEM_NAME

E.g 7 – Build a job

$ java -jar jenkins-cli.jar -s http://jenkins/ build new_job_name

E.g 8 – Diable a job

$ java -jar jenkins-cli.jar -s http://jenkins/ disable-job new_job_name

E.g 8 – Passing parameters when triggering a job build

Job parameters are a very handy concept. Perhaps you’ve only ever used Jenkins or another CI system to automatically run builds when a remote SCM/git repo changes. You can also trigger builds manually from within Jenkins. And whilst you’re doing that, your job can prompt for parameters to the build.

For example, we have a job named similar to “Deploy XYZ App”. It has the git repo hardcoded in the job like a normal build, but when you press “Build”, it shows a list of options: string fields, drop-down lists, etc.

When the job runs, you can use these values anywhere within your job’s configuration. Its very cool.

But how to pass those same parameters via the CLI? You use the -p key=value flag for each parameter you want to pass.

So our finished product might look like:

$ java -jar jenkins-cli.jar -s http://myjenkins build ‘Deploy XYZ App’ -i ~/.ssh/id_rsa -s -v -p target_env=api.cloudfoundry.com -p branch=master

Commons problems

Operation timed out

$ java -jar jenkins-cli.jar -s YOUR_SERVER_URL help

Exception in thread “main” java.net.ConnectException: Operation timed out

at java.net.PlainSocketImpl.socketConnect(Native Method)

at java.net.PlainSocketImpl.doConnect(PlainSocketImpl.java:351)

at java.net.PlainSocketImpl.connectToAddress(PlainSocketImpl.java:213)

at java.net.PlainSocketImpl.connect(PlainSocketImpl.java:200)

at java.net.SocksSocketImpl.connect(SocksSocketImpl.java:432)

at java.net.Socket.connect(Socket.java:529)

at java.net.Socket.connect(Socket.java:478)

at java.net.Socket.(Socket.java:375)

at java.net.Socket.(Socket.java:189)

at hudson.cli.CLI.(CLI.java:97)

at hudson.cli.CLI.(CLI.java:82)

at hudson.cli.CLI._main(CLI.java:250)

at hudson.cli.CLI.main(CLI.java:199)

Check that the JNLP port is opened if you are using a firewall on your server. You can configure its value in Jenkins configuration. By default it is set to use a random port.

java.io.IOException: No X-Jenkins-CLI2-Port

java.io.IOException: No X-Jenkins-CLI2-Port among [X-Jenkins, null, Server, X-Content-Type-Options, Connection, X-You-Are-In-Group, X-Hudson, X-Permission-Implied-By, Date, X-Jenkins-Session, X-You-Are-Authenticated-As, X-Required-Permission, Set-Cookie, Expires, Content-Length, Content-Type]

at hudson.cli.CLI.getCliTcpPort(CLI.java:284)

at hudson.cli.CLI.(CLI.java:128)

at hudson.cli.CLIConnectionFactory.connect(CLIConnectionFactory.java:72)

at hudson.cli.CLI._main(CLI.java:473)

at hudson.cli.CLI.main(CLI.java:384)

Suppressed: java.io.IOException: Server returned HTTP response code: 403 for URL: http://citest.gce.px/cli

at sun.net.www.protocol.http.HttpURLConnection.getInputStream0(HttpURLConnection.java:1840)

at sun.net.www.protocol.http.HttpURLConnection.getInputStream(HttpURLConnection.java:1441)

at hudson.cli.FullDuplexHttpStream.(FullDuplexHttpStream.java:78)

at hudson.cli.CLI.connectViaHttp(CLI.java:152)

at hudson.cli.CLI.(CLI.java:132)

… 3 more

Solution: Go to Manage Jenkins -> Configure Global Security -> “TCP port for JNLP agents”: choose fixed or random

Reference

https://wiki.jenkins-ci.org/display/JENKINS/Jenkins+CLI

http://lifuzu.com/blog/2014/04/24/playing-with-jenkins-create-job/

The post Complete guide to use Jenkins CLI / Command line | Jenkins Tutorials appeared first on scmGalaxy.

Jenkins Command line Reference for login and trigger a job

scmgalaxy K — Thu, 05 Feb 2015 00:00:00 +0000

Grep will return 0 while the build is running:

$ curl http://myjenkins/job/myjob/lastBuild/api/json | grep –color result\”:null

$ echo $?

Trigger a Jenkins Job from command line

$ wget http://yourserver/job/MyJobname/build?delay=0sec

$ wget -O – $HUDSON_URL/job/JOBNAME/build

Trigger a Jenkins Job without authentication

$ curl http://jenkins:8080/job/my%20job/build

Trigger a Jenkins Job with authentication

$ curl –user dbacher:$MY_API_TOKEN http://jenkins:8080/job/my%20job/build

$ curl –user : http:///job//build

Running commands against a secure Jenkins (basic auth or ssh keys)

$ java -jar jenkins-cli.jar -s http://myjenkins help –username me –password mypassword

$ java -jar jenkins-cli.jar -s http://myjenkins help -i ~/.ssh/id_rsa

Triggering a job build against a secure Jenkins (avoiding a 1.5 year old open bug!)

$ java -jar jenkins-cli.jar -s http://myjenkins build ‘My Awesome Jenkins Job’ -i ~/.ssh/id_rsa

$ java -jar jenkins-cli.jar -s http://myjenkins build ‘My Awesome Jenkins Job’ -i ~/.ssh/id_rsa -s -v

Passing parameters when triggering a job build

$ java -jar jenkins-cli.jar -s http://myjenkins build ‘Deploy XYZ App’ -i ~/.ssh/id_rsa -s -v -p target_env=api.cloudfoundry.com -p branch=master

Reference

http://starkandwayne.com/articles/2013/04/12/jenkins-builds-from-cli/

http://www.scmgalaxy.com/index.php?option=com_k2&view=item&id=890:ways-to-login-jenkins-using-command-line&Itemid=120

Appendix

1. How to get your_jenkins_API_key?

Login to your Jenkins.
Click on the username in the top right.
Click on Configure.
Click on ‘Show API Token’ button.
You got it.

The post Jenkins Command line Reference for login and trigger a job appeared first on scmGalaxy.

Jenkins Command line Guide Archives - scmGalaxy

Complete guide to use Jenkins CLI / Command line | Jenkins Tutorials

Jenkins Command line Reference for login and trigger a job