Demo Script Console

Introduction

The Jenkins Script Console enables administrators to execute Groovy scripts directly on the controller or any connected agent. This powerful interface is ideal for debugging, configuration, and maintenance tasks.

Accessing the Script Console

You can open the Script Console in two ways:

1. From the Jenkins dashboard:

   • Go to Manage Jenkins → Script Console.
     

2. From Manage Nodes:

   • Select the Built-In Node and click Script Console.

Basic Groovy Scripts

Most common Jenkins classes are pre-imported, so you can start scripting immediately:

// List installed plugins
println Jenkins.instance.pluginManager.plugins

// Inspect environment & system info
println System.getenv("PATH")
println "uname -a".execute().text

Printing the Jenkins Version

Explicitly import the Jenkins class to fetch the current version:

import jenkins.model.Jenkins

def jenkinsVersion = Jenkins.instance.version
println "Jenkins Version: ${jenkinsVersion}"

Retrieving Job Details

This script iterates through all jobs and prints key attributes:

import jenkins.model.Jenkins

def jobs = Jenkins.instance.getAllItems()

jobs.each { job ->
    println "##########################################"
    println "Job Full Name: ${job.fullName}"
    println "Job Name: ${job.name}"
    println "Job URL: ${job.absoluteUrl}"
    println "Last Build #: ${job.lastBuild?.number}"
    println "Job Class: ${job.getClass().name}"
    println "##########################################"
}

Leveraging Community Scripts

jenkinsci/jenkins-scripts

The jenkinsci/jenkins-scripts repository provides numerous utilities. For example, count executors on each node:

import jenkins.model.Jenkins

println "All Nodes - executor count:"
Jenkins.instance.computers.eachWithIndex { node, idx ->
    println "[${idx+1}] ${node.displayName}: ${node.numExecutors}"
}
println "\nTotal nodes: ${Jenkins.instance.computers.size()}"
println "Total executors: ${Jenkins.instance.computers.sum { it.numExecutors }}"

Output example:

[1] Built-In Node: 2
[2] ubuntu-agent: 1

Total nodes: 2
Total executors: 3

samrocketman/jenkins-script-console-scripts

Another valuable collection is samrocketman/jenkins-script-console-scripts. The Jenkins stats script gathers metrics on jobs, users, builds, and more:

// Print Jenkins statistics (assumes variables are defined)
println "GitHub Orgs: ${organizations}"
println "GitHub Projects: ${projects}"
println "Jenkins Jobs: ${count}"
println "Jobs w/ Builds: ${jobs_with_builds}"
println "Users: ${total_users}"
println "Global Builds: ${global_total_builds}"
println "Pull Requests: ${total_pull_requests}"
println "Tag Releases: ${total_tag_releases}"
println "Projects by Type:"
count_by_type.each { type, num -> println "  ${type}: ${num}" }
null

Disabling the Jenkins CLI

To disable CLI access (both TCP and /cli URL), run the following Groovy script:

import hudson.remoting.AgentProtocol
import jenkins.model.Jenkins
import hudson.model.RootAction

def changed = false

// Remove CLI protocols over TCP
def protocols = AgentProtocol.all()
protocols.findAll { it.name.contains("CLI") }.each {
    protocols.remove(it)
    changed = true
}

// Remove CLI actions from /cli URL
def removeCliActions = { list ->
    list.findAll { it.class.name.contains("CLIAction") }.each {
        list.remove(it)
        changed = true
    }
}
removeCliActions(Jenkins.instance.getExtensionList(RootAction))

println changed ? "CLI access disabled." : "No CLI protocols found."
null

Conclusion

The Script Console is a powerful Jenkins feature for automation, diagnostics, and configuration. Always proceed with caution and restrict console access to trusted administrators.

Links and References

• Jenkins Official Documentation
• Groovy Language Documentation
• jenkinsci/jenkins-scripts
• samrocketman/jenkins-script-console-scripts