How to check jenkins node connection status using jenkins-cli

Question

I'm trying to check specific Jenkins node is connected using Jenkins CLI . To get the node details I can use get-node command and it returns details as this xml

<?xml version="1.0" encoding="UTF-8"?>
<slave>
<name>20170602_jenkins_slave_002</name>
<description>10.49.82.46</description>
<remoteFS>c:\\jenkins_root</remoteFS>
<numExecutors>1</numExecutors>
<mode>EXCLUSIVE</mode>
<retentionStrategy class="hudson.slaves.RetentionStrategy$Always"/>
<launcher class="hudson.slaves.JNLPLauncher"/>
<label>20170602_jenkins_slave_002</label>
<nodeProperties/>
<userId>admin</userId>
</slave>

But it does not includes the node status. Anyone has idea how to check the node status by Jenkins cli

StephenKing · Accepted Answer · 2017-06-05T07:13:13.707

9

As I'm not aware of a method using jenkins-cli, my suggestion is to use the REST API:

http://jenkins.example.com/computer/:name/api/json

returns JSON data including an offline field.

You can get an overview over all agents (called computer here) on the following URL:

http://jenkins.example.com/computer/api/json?pretty=true

edited Jun 05 '17 at 07:13

answered Jun 05 '17 at 07:08

StephenKing

36,187
11
83
112

I never knew Jenkins has a Json API. I can get the list of nodes as well. Thank you very much & this is what I was exactly looking for – Nayana Adassuriya Jun 06 '17 at 03:22

score 0 · Answer 2 · answered Nov 24 '20 at 15:37

We can implement this using pipeline. I did using the groovy script for the windows VDI machines, Below is the script.

pipeline { agent none stages {

  stage('Agent Health check step') {
        options {
            timeout(time:5, unit: 'MINUTES')
        }
        agent {
            label "master"
        }
    steps { 
    
        script {
    
            def agStatusList = []
            
            def agentsMap = [VDI1:"XYZ@gmail.com", VDI2:"XYZ2@gmail.com", VDI3:"XYZ@gmail.com", VDI4:"himesh.patel@gmail.com"]
            
            String agEmlTo=''
            
            for (agSlave in hudson.model.Hudson.instance.slaves) {
                    def agName=agSlave.name
                    def agOwner=agentsMap.get(agName)
                    def agStatus=agSlave.getComputer().isOnline()
                    
                    
                    
                    if (agStatus != true ){
                        
                        echo "Node is offline"
                        echo " "    
                        agStatusList += agName + " node is offline" + " and owner is " + agOwner
                        
                        if(agStatus != true && agOwner != null){
                        
                            if (agEmlTo == null || agEmlTo.trim().isEmpty()){ 
                                agEmlTo = agOwner
                            } else{
                                agEmlTo += (','+agOwner) 
                            }
                        

                        
                        }
                        
                    }else{
                    
                        echo "Node is online"
                        echo " "
                        agStatusList += agName + " node is online" + " and owner is " + agOwner
                        
                    }
                            
            }
            
             println agStatusList
             
             println agEmlTo
             
            if (agEmlTo != null && !agEmlTo.trim().isEmpty()) {
                
                echo "Sending email to the owners of offline Nodes"
                
                string agEmlCc='123@gmail.com'
                string agEmlFrom='JenkinsServer@gmail.com'
                String agEmlHdr='[Notification] Your Windows VDI agent is offline'
                
                String agEmlBody='Hello, \n \nThe Windlows VDI agent assigned to you seems offline now. Please check the Windows VDI machine and get it connected ASAP.\n \n *This E-mail is from Automated process. Please do not respond directly to this e-mail as the originating e-mail account is not monitored*'
                    
                emailext body: "${agEmlBody}",
                to: "${agEmlTo}",
                subject: "${agEmlHdr}"
                from: "JenkinsServer@gmail.com"
            }
        }
    }
    }
}

}

How to check jenkins node connection status using jenkins-cli

2 Answers2