Jenkins Script Console
Jenkins features a nice Groovy script console which allows to run arbitrary scripts on the Jenkins server or on slave nodes. This feature can be accessed from the "manage Jenkins" link, typically at your http://server/jenkins/script.
Shortcut key on script console to submit
You can submit a script without mouse. Jenkins has a shortcut key which enables to submit with keyboard.
- Windows / Linux : Ctrl + Enter
- Mac : Command + Enter
Remote access
User can execute groovy scripts remotely sending post request to /script/ url or /scriptText/ to have response returned without the html wrapping.
$ curl -d "script=<your_script_here>" http:$ # or
$ curl -d "script=<your_script_here>" http:
Also, Jenkins CLI offers the possibility to execute groovy scripts remotely using groovy command or execute groovy interactivelly via groovysh.
Sample Groovy scripts
Browse all Scriptler Plugin Groovy Scripts: https://github.com/jenkinsci/jenkins-scripts/tree/master/scriptler
please share your scripts with the Scriptler Plugin
- Activate Chuck Norris Plugin — This script activate Chuck Norris plugin for all jobs in your Jenkins server
- Add a Maven Installation, Tool Installation, Modify System Config
- Add a new label to slaves meeting a condition — This script shows how to alter the slave nodes' label membership. In this case we create a new label if the existing label contains a string. It has been tested from the Jenkins command window.
- Add notification plugin to every job — This script will add the Notification Plugin to every job.
- Allow broken build claiming on every jobs — With the following simple script, you can activate the option on every jobs of your server in just one go.
- Batch-Update Mercurial branch that is checked out — Updates for multiple jobs which branch will be checked out from Hg
- Change JVM Options in all Maven tasks of Freestyle Jobs — This script find all Maven Tasks registered in freestyle jobs and replace JVM Options by a new value.
- Change publish over SSH configuration
- Change SCMTrigger for each project to disable during the night and the week-end — This script lets you easily change all jobs running every minutes so that it gets disabled between 21:00 and 07:00 and on Saturday and Sunday.
- Change Version-Number in SVN-path
- Clone all projects in a View — This script enumerates all projects belonging to a specific view and clones them.
- Convert standard mail notifications to use the Mail-Ext Publisher plugin — This script replace mail notifications in all projects by Mail-Ext publisher plugin and re-uses existing recipients.
- Delete .tmp files left in workspace-files — This scripts deletes all the tmp files left in workspace-files directory after the build. On windows servers, this seems pretty common so we run this script on daily basis.
- Disable all jobs — This script disables all jobs in your Jenkins server
- Display Information About Nodes — This scripts displays a bunch of information about all the slave nodes.
- Display job parameters — This scripts displays the parameters for all the jobs along with their default values (if applicable).
- Display jobs group by the build steps they use
- Display list of projects that were built more than 1 day ago. — This script to display list of projects that were built more than 1 day ago.
- Display mail notifications recipients — This script displays for all jobs the list of mail recipients used for notifications.
- Display monitors status — Jenkins uses monitors to validate various behaviors. If you dismiss one, Jenkins will never propose you to reactivate it. This script allows you to check the status of all monitors and to reactive them.
- Display timer triggers — This scripts displays the timer triggers for all the jobs in order to better arrange them.
- Display Tools Location on All Nodes — This script can help to get Jenkins tools localtion on all your slaves
- Enable Timestamper plugin on all jobs — With the following simple script, you can activate the option on every jobs of your server in just one go.
- Failed Jobs — This scripts displays a list of all failed jobs. Addon: restart them.
- Find builds currently running that has been executing for more than N seconds
- Grant Cancel Permission for user and group that have Build permission — This script will go through all groups and users in both Global security and per job security settings.
- Invalidate Jenkins HTTP sessions — This script can monitor and invalidate HTTP sessions if there are many open ones on your server.
- Monitor and Restart Offline Slaves — This script can monitor and restart offline nodes if they are not disconnected manually.
- Monitoring Scripts — Several scripts to display data about http sessions, threads, memory, JVM or MBeans, when using the Monitoring plugin.
- Parameterized System Groovy script — This script will demonstrate how to get parameters in a system groovy script.
- Preselect username in Maven Release Build
- Printing a list of credentials and their IDs
- Remove all disabled modules in Maven jobs — To remove all disabled modules in Maven jobs
- Remove Deployed Artifacts Actions — This script is used to remove the Deployed Artifacts list that is uselessly stored for each build by the Artifact Deployer Plugin.
- Remove Git Plugin BuildsByBranch BuildData — This script is used to remove the static list of BuildsByBranch that is uselessly stored for each build by the Git Plugin.
- Set GitBlitRepositoryBrowser with custum settings on all repos — This scripts allows to update the repo browser. Can be adapted to any other browser, not only gitblit.
- Update maven jobs to use the post build task to deploy artifacts — This script updates all maven jobs having a deploy goal by install and activate the post build step to deploy artifacts at the end of the build
- Update SVN Browser
- Wipe out workspaces of all jobs — This script wipes out the workspaces of all jobs on your Jenkins server
- Wipe workspaces for a set of jobs on all nodes — The script wipes workspaces of certain jobs on all nodes.
Some scripts at JBoss.org
More Scripts available at Scriptler Web
Write Groovy scripts for Jenkins with Code completion - The gist of this is to create a Maven project within your IDE and to depend on org.jenkins-ci.main:jenkins-core (and any other plugins that you expect present). You can then write a Groovy script with code completion of Jenkins API objects and methods.
Plugins enabling Groovy usage
Page:
Config File Provider Plugin
— Adds the ability to provide configuration files (i.e., settings.xml for maven, XML, groovy, custom files, etc.) loaded through the Jenkins UI which will be copied to the job's workspace.
|
Page:
Global Post Script Plugin
— Execute a global configured groovy/python script after each build of each job managed by the Jenkins.
|
Page:
Groovy plugin
— This plugin adds the ability to directly execute Groovy code.
|
Page:
Groovy Postbuild Plugin
— This plugin executes a groovy script in the Jenkins JVM. Typically, the script checks some conditions and changes accordingly the build result, puts badges next to the build in the build history and/or displays information on the build summary page.
|
Page:
Groovy Remote Control Plugin
— This plugin provides Groovy Remote Control's receiver, and allows to control external application from Jenkins.
|
Page:
Matrix Groovy Execution Strategy Plugin
— A plugin to decide the execution order and valid combinations of matrix projects.
|
Page:
Scriptler Plugin
— Scriptler allows you to store/edit groovy scripts and execute it on any of the slaves/nodes... no need to copy/paste groovy code anymore.
|
Gliffy Diagram
Edit in Word
Jenkins Script Console
Comments (5)
May 31, 2011
Mark Howard says:
Does anyone have any advice for writing these scripts? Is it just a case of blin...Does anyone have any advice for writing these scripts? Is it just a case of blindly trying to find relevant source code/javadocs and then hand coding and running, or is there a sensible way of testing them in advance?
Nov 21, 2011
Alex Gray says:
I would take a look at this web page: http://javadoc.jenkins-ci.org/hudson/model...I would take a look at this web page: http://javadoc.jenkins-ci.org/hudson/model/package-tree.html
It's a reference with all the things you can do. It's a little daunting at first, but once you check out the examples on this page and learn Groovy (which is similar like Java), you can figure out which methods you need to call.
Also, I found downloading the source code for various plugins very useful. I hope this helps, and good luck!
Jul 09, 2013
Timor Raiman says:
The built-in groovy engine (for running system scripts / script console) seems t...The built-in groovy engine (for running system scripts / script console) seems to be a bit outdated:
groovy.lang.GroovySystem.getVersion() returns 1.8.5 for me,
while an external script can be run with an installation of 2.1.5 or whatever external groovy is available.
I have a fairly recent version of Jenkins itself - 1.518
Is it possible to update Jenkins's internal groovy engine? Is it planned to be udpated in a future release of Jenkins?
Apr 02, 2014
Olivier MARION says:
Seems that Write Groovy scripts for Jenkins with Code completion( http://blog.do...Seems that Write Groovy scripts for Jenkins with Code completion( http://blog.doninger.net/2011/11/write-groovy-scripts-for-jenkins-with.html) has moved to http://www.mdoninger.de/2011/11/07/write-groovy-scripts-for-jenkins-with-code-completion.html
Aug 28, 2014
karim har. says:
Hello Id like to know how i can parse the console output of a build from anothe...Hello
Id like to know how i can parse the console output of a build from another job through groovy script please?
Not a postbuild one but build groovy script.
trying something like that
-------
Add Comment