Create a gist now

Instantly share code, notes, and snippets.

@rb2k /gist:8372402
Last active Jan 16, 2018

What would you like to do?
A jenkins script to clean up workspaces on slaves
// Check if a slave has < 10 GB of free space, wipe out workspaces if it does
import hudson.model.*;
import hudson.util.*;
import jenkins.model.*;
import hudson.FilePath.FileCallable;
import hudson.slaves.OfflineCause;
import hudson.node_monitors.*;
for (node in Jenkins.instance.nodes) {
computer = node.toComputer()
if (computer.getChannel() == null) continue
rootPath = node.getRootPath()
size = DiskSpaceMonitor.DESCRIPTOR.get(computer).size
roundedSize = size / (1024 * 1024 * 1024) as int
println("node: " + node.getDisplayName() + ", free space: " + roundedSize + "GB")
if (roundedSize < 10) {
computer.setTemporarilyOffline(true, new hudson.slaves.OfflineCause.ByCLI("disk cleanup"))
for (item in Jenkins.instance.items) {
jobName = item.getFullDisplayName()
if (item.isBuilding()) {
println(".. job " + jobName + " is currently running, skipped")
println(".. wiping out workspaces of job " + jobName)
workspacePath = node.getWorkspaceFor(item)
if (workspacePath == null) {
println(".... could not get workspace path")
println(".... workspace = " + workspacePath)
customWorkspace = item.getCustomWorkspace()
if (customWorkspace != null) {
workspacePath = node.getRootPath().child(customWorkspace)
println(".... custom workspace = " + workspacePath)
pathAsString = workspacePath.getRemote()
if (workspacePath.exists()) {
println(".... deleted from location " + pathAsString)
} else {
println(".... nothing to delete at " + pathAsString)
computer.setTemporarilyOffline(false, null)

As someone who manages a 40 VM cluster all running jenkins slaves, I thank you!

wilkko commented Jul 29, 2015

Great script! Line 14 is unused.

SankarB commented Jan 1, 2016

Hi Marc Seeger,

This script is great but not working on cloudbee jenkins enterprise edition which is our environment. Facing issue with item.isBuilding(). I didn't know groovy scripting but i am in need of this script.


groovy.lang.MissingMethodException: No signature of method: com.cloudbees.hudson.plugins.folder.Folder.isBuilding() is applicable for argument types: () values: []

akomakom commented Jan 4, 2016

@SankarB, I made a fix for your issue (I also had this problem), see my fork.


Here is the code to exclude Folders :

if (item instanceof com.cloudbees.hudson.plugins.folder.Folder)
// Folder



faizan80 commented Apr 8, 2016


Can anyone tell me, where can i execute this script ?

I would like to run this script as part of a cron job or something.
Any suggestions.


kmayfiel-ibm commented May 10, 2016

I believe you need the groovy plugin, and you need to run this on Master.
I haven't tried this script yet.

Hi Faizan80
Here is my post how to make Jenkins Groovy job and use the script above:

You should change the loop to getAllItems() so it can be used on instances with Folders:

for (item in Jenkins.instance.getAllItems(Job.class)) {

I would also put the code following "setTemporarilyOffline" in a try-statement, with the offline disabling in a finally statement.

indrgun commented Oct 4, 2016

How do you delete old workspace for job that is either already deleted or renamed on Jenkins. They are still on the node and they are not checked by the script.

prasathsivasubramaniyan commented Feb 17, 2017

How to cleanup tmp space of all slaves in the cloudbees jenkins using the groovy script less than 1days older files

dbmcgrew commented Aug 8, 2017

Thanks for the script. Thanks too to jskovjyskebankdk for suggesting Jenkins.instance.getAllItems(). That was one of the enhancements I added to get the script to work in our environment.

I am just getting started on Admin on Jenkins. I wanted to know what is lost when we do such a cleanup, what is not shown after the cleanup in the Jenkins UI.

vancona commented Oct 6, 2017

Hi guys,
with the latest upgrade of the Groovy plugin "setTemporarilyOffline" takes a RejectedAccessException due the new security fencing.
Does anyone have found a solution for that? Thanks.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment